Changeset 134 for branches/samba-3.0/docs/manpages
- Timestamp:
- May 23, 2008, 6:56:41 AM (17 years ago)
- Location:
- branches/samba-3.0/docs/manpages
- Files:
-
- 56 edited
Legend:
- Unmodified
- Added
- Removed
-
branches/samba-3.0/docs/manpages/eventlogadm.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "EVENTLOGADM" 8 "" "" "" 1 .\" Title: eventlogadm 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "EVENTLOGADM" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 eventlogadm - push records into the Samba event log store 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 eventlogadm [\fB -d\fR] [\fB-h\fR] \fB-o\fR addsource \fIEVENTLOG\fR \fISOURCENAME\fR\fIMSGFILE\fR17 eventlogadm [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ addsource\ \fIEVENTLOG\fR\ \fISOURCENAME\fR\ \fIMSGFILE\fR 26 18 .HP 1 27 eventlogadm [\fB -d\fR] [\fB-h\fR] \fB-o\fR write\fIEVENTLOG\fR19 eventlogadm [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ write\ \fIEVENTLOG\fR 28 20 .SH "DESCRIPTION" 29 21 .PP 30 22 This tool is part of the 31 23 \fBsamba\fR(1) 32 suite .24 suite\. 33 25 .PP 34 26 eventlogadm 35 is a filter that accepts formatted event log records on standard input and writes them to the Samba event log store . Windows client can then manipulate these record using the usual administration tools.27 is a filter that accepts formatted event log records on standard input and writes them to the Samba event log store\. Windows client can then manipulate these record using the usual administration tools\. 36 28 .SH "OPTIONS" 37 29 .PP 38 \fB -d\fR39 .RS 3n30 \fB\-d\fR 31 .RS 4 40 32 The 41 -d33 \-d 42 34 option causes 43 35 eventlogadm 44 to emit debugging information .45 .RE 46 .PP 47 \fB -o\fR addsource \fIEVENTLOG\fR \fISOURCENAME\fR \fIMSGFILE\fR48 .RS 3n36 to emit debugging information\. 37 .RE 38 .PP 39 \fB\-o\fR addsource \fIEVENTLOG\fR \fISOURCENAME\fR \fIMSGFILE\fR 40 .RS 4 49 41 The 50 -o addsource51 option creates a new event log source .52 .RE 53 .PP 54 \fB -o\fR write \fIEVENTLOG\fR55 .RS 3n42 \-o addsource 43 option creates a new event log source\. 44 .RE 45 .PP 46 \fB\-o\fR write \fIEVENTLOG\fR 47 .RS 4 56 48 The 57 -o write58 reads event log records from standard input and writes them to theSamba event log store named by EVENTLOG .59 .RE 60 .PP 61 \fB -h\fR62 .RS 3n63 Print usage information .49 \-o write 50 reads event log records from standard input and writes them to theSamba event log store named by EVENTLOG\. 51 .RE 52 .PP 53 \fB\-h\fR 54 .RS 4 55 Print usage information\. 64 56 .RE 65 57 .SH "EVENTLOG RECORD FORMAT" … … 67 59 For the write operation, 68 60 eventlogadm 69 expects to be able to read structured records from standard input . These records are a sequence of lines, with the record key and data separated by a colon character. Records are separated by at least one or more blank line.61 expects to be able to read structured records from standard input\. These records are a sequence of lines, with the record key and data separated by a colon character\. Records are separated by at least one or more blank line\. 70 62 .PP 71 63 The event log record field are: 72 .TP 3n 73 \(bu 64 .sp 65 .RS 4 66 .ie n \{\ 67 \h'-04'\(bu\h'+03'\c 68 .\} 69 .el \{\ 70 .sp -1 71 .IP \(bu 2.3 72 .\} 74 73 75 74 LEN 76 - This field should be 0, since75 \- This field should be 0, since 77 76 eventlogadm 78 will calculate this value. 79 .TP 3n 80 \(bu 77 will calculate this value\. 78 .RE 79 .sp 80 .RS 4 81 .ie n \{\ 82 \h'-04'\(bu\h'+03'\c 83 .\} 84 .el \{\ 85 .sp -1 86 .IP \(bu 2.3 87 .\} 81 88 82 89 RS1 83 - This must be the value 1699505740. 84 .TP 3n 85 \(bu 90 \- This must be the value 1699505740\. 91 .RE 92 .sp 93 .RS 4 94 .ie n \{\ 95 \h'-04'\(bu\h'+03'\c 96 .\} 97 .el \{\ 98 .sp -1 99 .IP \(bu 2.3 100 .\} 86 101 87 102 RCN 88 - This field should be 0. 89 .TP 3n 90 \(bu 103 \- This field should be 0\. 104 .RE 105 .sp 106 .RS 4 107 .ie n \{\ 108 \h'-04'\(bu\h'+03'\c 109 .\} 110 .el \{\ 111 .sp -1 112 .IP \(bu 2.3 113 .\} 91 114 92 115 TMG 93 - The time the eventlog record was generated; format is the number of seconds since 00:00:00 January 1, 1970, UTC. 94 .TP 3n 95 \(bu 116 \- The time the eventlog record was generated; format is the number of seconds since 00:00:00 January 1, 1970, UTC\. 117 .RE 118 .sp 119 .RS 4 120 .ie n \{\ 121 \h'-04'\(bu\h'+03'\c 122 .\} 123 .el \{\ 124 .sp -1 125 .IP \(bu 2.3 126 .\} 96 127 97 128 TMW 98 - The time the eventlog record was written; format is the number of seconds since 00:00:00 January 1, 1970, UTC. 99 .TP 3n 100 \(bu 129 \- The time the eventlog record was written; format is the number of seconds since 00:00:00 January 1, 1970, UTC\. 130 .RE 131 .sp 132 .RS 4 133 .ie n \{\ 134 \h'-04'\(bu\h'+03'\c 135 .\} 136 .el \{\ 137 .sp -1 138 .IP \(bu 2.3 139 .\} 101 140 102 141 EID 103 - The eventlog ID. 104 .TP 3n 105 \(bu 142 \- The eventlog ID\. 143 .RE 144 .sp 145 .RS 4 146 .ie n \{\ 147 \h'-04'\(bu\h'+03'\c 148 .\} 149 .el \{\ 150 .sp -1 151 .IP \(bu 2.3 152 .\} 106 153 107 154 ETP 108 - The event type -- one of "INFO", "ERROR", "WARNING", "AUDIT SUCCESS" or "AUDIT FAILURE". 109 .TP 3n 110 \(bu 155 \- The event type \-\- one of "INFO", "ERROR", "WARNING", "AUDIT SUCCESS" or "AUDIT FAILURE"\. 156 .RE 157 .sp 158 .RS 4 159 .ie n \{\ 160 \h'-04'\(bu\h'+03'\c 161 .\} 162 .el \{\ 163 .sp -1 164 .IP \(bu 2.3 165 .\} 111 166 112 167 ECT 113 - The event category; this depends on the message file. It is primarily used as a means of filtering in the eventlog viewer. 114 .TP 3n 115 \(bu 168 \- The event category; this depends on the message file\. It is primarily used as a means of filtering in the eventlog viewer\. 169 .RE 170 .sp 171 .RS 4 172 .ie n \{\ 173 \h'-04'\(bu\h'+03'\c 174 .\} 175 .el \{\ 176 .sp -1 177 .IP \(bu 2.3 178 .\} 116 179 117 180 RS2 118 - This field should be 0. 119 .TP 3n 120 \(bu 181 \- This field should be 0\. 182 .RE 183 .sp 184 .RS 4 185 .ie n \{\ 186 \h'-04'\(bu\h'+03'\c 187 .\} 188 .el \{\ 189 .sp -1 190 .IP \(bu 2.3 191 .\} 121 192 122 193 CRN 123 - This field should be 0. 124 .TP 3n 125 \(bu 194 \- This field should be 0\. 195 .RE 196 .sp 197 .RS 4 198 .ie n \{\ 199 \h'-04'\(bu\h'+03'\c 200 .\} 201 .el \{\ 202 .sp -1 203 .IP \(bu 2.3 204 .\} 126 205 127 206 USL 128 - This field should be 0. 129 .TP 3n 130 \(bu 207 \- This field should be 0\. 208 .RE 209 .sp 210 .RS 4 211 .ie n \{\ 212 \h'-04'\(bu\h'+03'\c 213 .\} 214 .el \{\ 215 .sp -1 216 .IP \(bu 2.3 217 .\} 131 218 132 219 SRC 133 - This field contains the source name associated with the event log. If a message file is used with an event log, there will be a registry entry for associating this source name with a message file DLL. 134 .TP 3n 135 \(bu 220 \- This field contains the source name associated with the event log\. If a message file is used with an event log, there will be a registry entry for associating this source name with a message file DLL\. 221 .RE 222 .sp 223 .RS 4 224 .ie n \{\ 225 \h'-04'\(bu\h'+03'\c 226 .\} 227 .el \{\ 228 .sp -1 229 .IP \(bu 2.3 230 .\} 136 231 137 232 SRN 138 - he name of the machine on which the eventlog was generated. This is typically the host name. 139 .TP 3n 140 \(bu 233 \- he name of the machine on which the eventlog was generated\. This is typically the host name\. 234 .RE 235 .sp 236 .RS 4 237 .ie n \{\ 238 \h'-04'\(bu\h'+03'\c 239 .\} 240 .el \{\ 241 .sp -1 242 .IP \(bu 2.3 243 .\} 141 244 142 245 STR 143 - The text associated with the eventlog. There may be more than one string in a record. 144 .TP 3n 145 \(bu 246 \- The text associated with the eventlog\. There may be more than one string in a record\. 247 .RE 248 .sp 249 .RS 4 250 .ie n \{\ 251 \h'-04'\(bu\h'+03'\c 252 .\} 253 .el \{\ 254 .sp -1 255 .IP \(bu 2.3 256 .\} 146 257 147 258 DAT 148 - This field should be left unset.259 \- This field should be left unset\. 149 260 .SH "EXAMPLES" 150 261 .PP 151 262 An example of the record format accepted by 152 263 eventlogadm: 153 264 .sp 265 .RS 4 154 266 .nf 155 156 267 LEN: 0 157 268 RS1: 1699505740 … … 159 270 TMG: 1128631322 160 271 TMW: 1128631322 161 EID: 1000 272 EID: 1000 162 273 ETP: INFO 163 ECT: 0 274 ECT: 0 164 275 RS2: 0 165 276 CRN: 0 … … 167 278 SRC: cron 168 279 SRN: dmlinux 169 STR: (root) CMD ( rm -f /var/spool/cron/lastrun/cron.hourly)170 DAT: 280 STR: (root) CMD ( rm \-f /var/spool/cron/lastrun/cron\.hourly) 281 DAT: 171 282 172 283 .fi 284 .RE 173 285 .PP 174 286 Set up an eventlog source, specifying a message file DLL: 175 287 .sp 288 .RS 4 176 289 .nf 177 178 eventlogadm -o addsource Application MyApplication | \\ 179 %SystemRoot%/system32/MyApplication.dll 290 eventlogadm \-o addsource Application MyApplication | \e\e 291 %SystemRoot%/system32/MyApplication\.dll 180 292 181 293 .fi 294 .RE 182 295 .PP 183 296 Filter messages from the system log into an event log: 184 297 .sp 298 .RS 4 185 299 .nf 186 187 tail -f /var/log/messages | \\ 188 my_program_to_parse_into_eventlog_records | \\ 300 tail \-f /var/log/messages | \e\e 301 my_program_to_parse_into_eventlog_records | \e\e 189 302 eventlogadm SystemLogEvents 190 303 191 304 .fi 305 .RE 192 306 .SH "VERSION" 193 307 .PP 194 This man page is correct for version 3 .0.25 of the Samba suite.308 This man page is correct for version 3\.0\.25 of the Samba suite\. 195 309 .SH "AUTHOR" 196 310 .PP 197 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 198 311 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. -
branches/samba-3.0/docs/manpages/findsmb.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "FINDSMB" 1 "" "" "" 1 .\" Title: findsmb 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "FINDSMB" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 findsmb - list info about machines that respond to SMB name queries on a subnet 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 findsmb [subnet broadcastaddress]17 findsmb [subnet\ broadcast\ address] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This perl script is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 findsmb 33 is a perl script that prints out several pieces of information about machines on a subnet that respond to SMB name query requests . It uses25 is a perl script that prints out several pieces of information about machines on a subnet that respond to SMB name query requests\. It uses 34 26 \fBnmblookup\fR(1) 35 27 and 36 28 \fBsmbclient\fR(1) 37 to obtain this information .29 to obtain this information\. 38 30 .SH "OPTIONS" 39 31 .PP 40 -r41 .RS 3n32 \-r 33 .RS 4 42 34 Controls whether 43 35 findsmb 44 takes bugs in Windows95 into account when trying to find a Netbios name registered of the remote machine . This option is disabled by default because it is specific to Windows 95 and Windows 95 machines only. If set,36 takes bugs in Windows95 into account when trying to find a Netbios name registered of the remote machine\. This option is disabled by default because it is specific to Windows 95 and Windows 95 machines only\. If set, 45 37 \fBnmblookup\fR(1) 46 38 will be called with 47 \fB -B\fR48 option .39 \fB\-B\fR 40 option\. 49 41 .RE 50 42 .PP 51 43 subnet broadcast address 52 .RS 3n44 .RS 4 53 45 Without this option, 54 46 findsmb 55 47 will probe the subnet of the machine where 56 48 \fBfindsmb\fR(1) 57 is run . This value is passed to49 is run\. This value is passed to 58 50 \fBnmblookup\fR(1) 59 51 as part of the 60 \fB -B\fR61 option .52 \fB\-B\fR 53 option\. 62 54 .RE 63 55 .SH "EXAMPLES" … … 67 59 lists the following information for all machines that respond to the initial 68 60 nmblookup 69 for any name: IP address, NetBIOS name, Workgroup name, operating system, and SMB server version .61 for any name: IP address, NetBIOS name, Workgroup name, operating system, and SMB server version\. 70 62 .PP 71 There will be a '+' in front of the workgroup name for machines that are local master browsers for that workgroup. There will be an '*' in front of the workgroup name for machines that are the domain master browser for that workgroup. Machines that are running Windows for Workgroups, Windows 95 or Windows 98 will not show any information about the operating system or server version.63 There will be a \'+\' in front of the workgroup name for machines that are local master browsers for that workgroup\. There will be an \'*\' in front of the workgroup name for machines that are the domain master browser for that workgroup\. Machines that are running Windows for Workgroups, Windows 95 or Windows 98 will not show any information about the operating system or server version\. 72 64 .PP 73 65 The command with 74 \fB -r\fR66 \fB\-r\fR 75 67 option must be run on a system without 76 68 \fBnmbd\fR(8) 77 running . If69 running\. If 78 70 nmbd 79 is running on the system, you will only get the IP address and the DNS name of the machine . To get proper responses from Windows 95 and Windows 98 machines, the command must be run as root and with80 \fB -r\fR71 is running on the system, you will only get the IP address and the DNS name of the machine\. To get proper responses from Windows 95 and Windows 98 machines, the command must be run as root and with 72 \fB\-r\fR 81 73 option on a machine without 82 74 nmbd 83 running .75 running\. 84 76 .PP 85 77 For example, running 86 78 findsmb 87 79 without 88 \fB -r\fR80 \fB\-r\fR 89 81 option set would yield output similar to the following 90 82 .sp 83 .RS 4 91 84 .nf 92 93 85 IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION 94 --------------------------------------------------------------------- 95 192.168.35.10 MINESET-TEST1 [DMVENGR] 96 192.168.35.55 LINUXBOX *[MYGROUP] [Unix] [Samba 2.0.6] 97 192.168.35.56 HERBNT2 [HERB-NT] 98 192.168.35.63 GANDALF [MVENGR] [Unix] [Samba 2.0.5a for IRIX] 99 192.168.35.65 SAUNA [WORKGROUP] [Unix] [Samba 1.9.18p10] 100 192.168.35.71 FROGSTAR [ENGR] [Unix] [Samba 2.0.0 for IRIX] 101 192.168.35.78 HERBDHCP1 +[HERB] 102 192.168.35.88 SCNT2 +[MVENGR] [Windows NT 4.0] [NT LAN Manager 4.0] 103 192.168.35.93 FROGSTAR-PC [MVENGR] [Windows 5.0] [Windows 2000 LAN Manager] 104 192.168.35.97 HERBNT1 *[HERB-NT] [Windows NT 4.0] [NT LAN Manager 4.0] 105 86 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 87 192\.168\.35\.10 MINESET\-TEST1 [DMVENGR] 88 192\.168\.35\.55 LINUXBOX *[MYGROUP] [Unix] [Samba 2\.0\.6] 89 192\.168\.35\.56 HERBNT2 [HERB\-NT] 90 192\.168\.35\.63 GANDALF [MVENGR] [Unix] [Samba 2\.0\.5a for IRIX] 91 192\.168\.35\.65 SAUNA [WORKGROUP] [Unix] [Samba 1\.9\.18p10] 92 192\.168\.35\.71 FROGSTAR [ENGR] [Unix] [Samba 2\.0\.0 for IRIX] 93 192\.168\.35\.78 HERBDHCP1 +[HERB] 94 192\.168\.35\.88 SCNT2 +[MVENGR] [Windows NT 4\.0] [NT LAN Manager 4\.0] 95 192\.168\.35\.93 FROGSTAR\-PC [MVENGR] [Windows 5\.0] [Windows 2000 LAN Manager] 96 192\.168\.35\.97 HERBNT1 *[HERB\-NT] [Windows NT 4\.0] [NT LAN Manager 4\.0] 106 97 .fi 98 .RE 107 99 .SH "VERSION" 108 100 .PP 109 This man page is correct for version 3 .0 of the Samba suite.101 This man page is correct for version 3\.0 of the Samba suite\. 110 102 .SH "SEE ALSO" 111 103 .PP … … 115 107 .SH "AUTHOR" 116 108 .PP 117 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.109 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 118 110 .PP 119 The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 120 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 121 111 The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 112 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/libsmbclient.7
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "LIBSMBCLIENT" 7 "" "" "" 1 .\" Title: libsmbclient 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: 7 6 .\" Source: Samba 3.0 7 .\" 8 .TH "LIBSMBCLIENT" "7" "05/21/2008" "Samba 3\.0" "7" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 libsmbclient - An extension library for browsers and that can be used as a generic browsing API. … … 25 17 Browser URL:.PP 26 18 smb://[[[domain:]user[:password@]]server[/share[/path[/file]]]] [?options] 27 28 19 .SH "DESCRIPTION" 29 20 .PP 30 21 This tool is part of the 31 22 \fBsamba\fR(7) 32 suite .23 suite\. 33 24 .PP 34 25 35 26 libsmbclient 36 is a library toolset that permits applications to manipulate CIFS/SMB network resources using many of the standards POSIX functions available for manipulating local UNIX/Linux files . It permits much more than just browsing, files can be opened and read or written, permissions changed, file times modified, attributes and ACL's can be manipulated, and so on. Of course, its functionality includes all the capabilities commonly called browsing.27 is a library toolset that permits applications to manipulate CIFS/SMB network resources using many of the standards POSIX functions available for manipulating local UNIX/Linux files\. It permits much more than just browsing, files can be opened and read or written, permissions changed, file times modified, attributes and ACL\'s can be manipulated, and so on\. Of course, its functionality includes all the capabilities commonly called browsing\. 37 28 .PP 38 29 39 30 libsmbclient 40 can not be used directly from the command line, instead it provides an extension of the capabilities of tools such as file managers and browsers . This man page describes the configuration options for this tool so that the user may obtain greatest utility of use.31 can not be used directly from the command line, instead it provides an extension of the capabilities of tools such as file managers and browsers\. This man page describes the configuration options for this tool so that the user may obtain greatest utility of use\. 41 32 .SH "OPTIONS" 42 33 .PP … … 44 35 .PP 45 36 smb:// 46 .RS 3n47 Shows all workgroups or domains that are visible in the network . The behavior matches that of the Microsoft Windows Explorer.37 .RS 4 38 Shows all workgroups or domains that are visible in the network\. The behavior matches that of the Microsoft Windows Explorer\. 48 39 .sp 49 40 The method of locating the list of workgroups (domains also) varies depending on the setting of the context variable 50 (context ->options.browse_max_lmb_count). It is the responsibility of the application that calls this library to set this to a sensible value. This is a compile-time option. This value determines the maximum number of local master browsers to query for the list of workgroups. In order to ensure that the list is complete for those present on the network, all master browsers must be querried. If there are a large number of workgroups on the network, the time spent querying will be significant. For small networks (just a few workgroups), it is suggested to set this value to 0, instructing libsmbclient to query all local master browsers. In an environment that has many workgroups a more reasonable setting may be around 3.41 (context\->options\.browse_max_lmb_count)\. It is the responsibility of the application that calls this library to set this to a sensible value\. This is a compile\-time option\. This value determines the maximum number of local master browsers to query for the list of workgroups\. In order to ensure that the list is complete for those present on the network, all master browsers must be querried\. If there are a large number of workgroups on the network, the time spent querying will be significant\. For small networks (just a few workgroups), it is suggested to set this value to 0, instructing libsmbclient to query all local master browsers\. In an environment that has many workgroups a more reasonable setting may be around 3\. 51 42 .RE 52 43 .PP 53 44 smb://name/ 54 .RS 3n55 This command causes libsmbclient to perform a name look -up. If the NAME<1D> or NAME<1B> exists (workgroup name), libsmbclient will list all servers in the workgroup (or domain). Otherwise, a name look-up for the NAME<20> (machine name) will be performed, and the list of shared resources on the server will be displayed.45 .RS 4 46 This command causes libsmbclient to perform a name look\-up\. If the NAME<1D> or NAME<1B> exists (workgroup name), libsmbclient will list all servers in the workgroup (or domain)\. Otherwise, a name look\-up for the NAME<20> (machine name) will be performed, and the list of shared resources on the server will be displayed\. 56 47 .RE 57 48 .PP 58 49 When libsmbclient is invoked by an application it searches for a directory called 59 \fI .smb\fR60 in the $HOME directory that is specified in the users shell environment . It then searches for a file called61 \fIsmb .conf\fR62 which, if present, will fully over -ride the system63 \fI/etc/samba/smb .conf\fR64 file . If instead libsmbclient finds a file called65 \fI~/ .smb/smb.conf.append\fR, it will read the system66 \fI/etc/samba/smb .conf\fR50 \fI\.smb\fR 51 in the $HOME directory that is specified in the users shell environment\. It then searches for a file called 52 \fIsmb\.conf\fR 53 which, if present, will fully over\-ride the system 54 \fI/etc/samba/smb\.conf\fR 55 file\. If instead libsmbclient finds a file called 56 \fI~/\.smb/smb\.conf\.append\fR, it will read the system 57 \fI/etc/samba/smb\.conf\fR 67 58 and then append the contents of the 68 \fI~/ .smb/smb.conf.append\fR69 to it .59 \fI~/\.smb/smb\.conf\.append\fR 60 to it\. 70 61 .PP 71 62 … … 75 66 parameter and will use its value when if the 76 67 user 77 parameter was not included in the URL .68 parameter was not included in the URL\. 78 69 .SH "PROGRAMMERS GUIDE" 79 70 .PP 80 Watch this space for future updates .71 Watch this space for future updates\. 81 72 .SH "VERSION" 82 73 .PP 83 This man page is correct for version 3 .0 of the Samba suite.74 This man page is correct for version 3\.0 of the Samba suite\. 84 75 .SH "AUTHOR" 85 76 .PP 86 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.77 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 87 78 .PP 88 The libsmbclient manpage page was written by John H Terpstra. 89 79 The libsmbclient manpage page was written by John H Terpstra\. -
branches/samba-3.0/docs/manpages/lmhosts.5
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "LMHOSTS" 5 "" "" "" 1 .\" Title: lmhosts 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: File Formats and Conventions 6 .\" Source: Samba 3.0 7 .\" 8 .TH "LMHOSTS" "5" "05/21/2008" "Samba 3\.0" "File Formats and Conventions" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 lmhosts - The Samba NetBIOS hosts file … … 26 18 is the 27 19 \fBsamba\fR(7) 28 NetBIOS name to IP address mapping file .20 NetBIOS name to IP address mapping file\. 29 21 .SH "DESCRIPTION" 30 22 .PP 31 23 This file is part of the 32 24 \fBsamba\fR(7) 33 suite .25 suite\. 34 26 .PP 35 27 \fIlmhosts\fR 36 28 is the 37 \f BSamba \fR38 NetBIOS name to IP address mapping file . It is very similar to the29 \fISamba \fR 30 NetBIOS name to IP address mapping file\. It is very similar to the 39 31 \fI/etc/hosts\fR 40 file format, except that the hostname component must correspond to the NetBIOS naming format .32 file format, except that the hostname component must correspond to the NetBIOS naming format\. 41 33 .SH "FILE FORMAT" 42 34 .PP 43 It is an ASCII file containing one line for NetBIOS name. The two fields on each line are separated from each other by white space. Any entry beginning with '#' is ignored. Each line in the lmhosts file contains the following information: 44 .TP 3n 45 \(bu 46 IP Address - in dotted decimal format. 47 .TP 3n 48 \(bu 49 NetBIOS Name - This name format is a maximum fifteen character host name, with an optional trailing '#' character followed by the NetBIOS name type as two hexadecimal digits. 35 It is an ASCII file containing one line for NetBIOS name\. The two fields on each line are separated from each other by white space\. Any entry beginning with \'#\' is ignored\. Each line in the lmhosts file contains the following information: 50 36 .sp 51 If the trailing '#' is omitted then the given IP address will be returned for all names that match the given name, whatever the NetBIOS name type in the lookup. 37 .RS 4 38 .ie n \{\ 39 \h'-04'\(bu\h'+03'\c 40 .\} 41 .el \{\ 42 .sp -1 43 .IP \(bu 2.3 44 .\} 45 IP Address \- in dotted decimal format\. 46 .RE 47 .sp 48 .RS 4 49 .ie n \{\ 50 \h'-04'\(bu\h'+03'\c 51 .\} 52 .el \{\ 53 .sp -1 54 .IP \(bu 2.3 55 .\} 56 NetBIOS Name \- This name format is a maximum fifteen character host name, with an optional trailing \'#\' character followed by the NetBIOS name type as two hexadecimal digits\. 57 .sp 58 If the trailing \'#\' is omitted then the given IP address will be returned for all names that match the given name, whatever the NetBIOS name type in the lookup\. 59 .sp 60 .RE 52 61 .PP 53 62 An example follows: 54 55 63 .sp 56 64 .RS 4 57 65 .nf 58 59 66 # 60 # Sample Samba lmhosts file .67 # Sample Samba lmhosts file\. 61 68 # 62 192.9.200.1 TESTPC 63 192.9.200.20 NTSERVER#20 64 192.9.200.21 SAMBASERVER 65 69 192\.9\.200\.1 TESTPC 70 192\.9\.200\.20 NTSERVER#20 71 192\.9\.200\.21 SAMBASERVER 66 72 .fi 67 73 .RE 68 74 .PP 69 Contains three IP to NetBIOS name mappings . The first and third will be returned for any queries for the names "TESTPC" and "SAMBASERVER" respectively, whatever the type component of the NetBIOS name requested.75 Contains three IP to NetBIOS name mappings\. The first and third will be returned for any queries for the names "TESTPC" and "SAMBASERVER" respectively, whatever the type component of the NetBIOS name requested\. 70 76 .PP 71 The second mapping will be returned only when the "0x20" name type for a name "NTSERVER" is queried . Any other name type will not be resolved.77 The second mapping will be returned only when the "0x20" name type for a name "NTSERVER" is queried\. Any other name type will not be resolved\. 72 78 .PP 73 79 The default location of the … … 75 81 file is in the same directory as the 76 82 \fBsmb.conf\fR(5) 77 file .83 file\. 78 84 .SH "FILES" 79 85 .PP 80 lmhosts is loaded from the configuration directory . This is usually86 lmhosts is loaded from the configuration directory\. This is usually 81 87 \fI/etc/samba\fR 82 88 or 83 \fI/usr/local/samba/lib\fR .89 \fI/usr/local/samba/lib\fR\. 84 90 .SH "VERSION" 85 91 .PP 86 This man page is correct for version 3 .0 of the Samba suite.92 This man page is correct for version 3\.0 of the Samba suite\. 87 93 .SH "SEE ALSO" 88 94 .PP … … 92 98 .SH "AUTHOR" 93 99 .PP 94 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.100 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 95 101 .PP 96 The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 97 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 was done by Alexander Bokovoy. 98 102 The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 103 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/log2pcap.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "LOG2PCAP" 1 "" "" "" 1 .\" Title: log2pcap 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "LOG2PCAP" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 log2pcap - Extract network traces from Samba log files 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 log2pcap [ -h] [-q] [logfile] [pcap_file]17 log2pcap [\-h] [\-q] [logfile] [pcap_file] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 log2pcap 33 reads in a samba log file and generates a pcap file (readable by most sniffers, such as ethereal or tcpdump) based on the packet dumps in the log file .25 reads in a samba log file and generates a pcap file (readable by most sniffers, such as ethereal or tcpdump) based on the packet dumps in the log file\. 34 26 .PP 35 27 The log file must have a … … 41 33 to get the first 512 data bytes of the packet and 42 34 \fB50\fR 43 to get the whole packet .35 to get the whole packet\. 44 36 .SH "OPTIONS" 45 37 .PP 46 -h47 .RS 3n38 \-h 39 .RS 4 48 40 If this parameter is specified the output file will be a hex dump, in a format that is readable by the 49 41 text2pcap 50 utility .42 utility\. 51 43 .RE 52 44 .PP 53 -q54 .RS 3n55 Be quiet . No warning messages about missing or incomplete data will be given.45 \-q 46 .RS 4 47 Be quiet\. No warning messages about missing or incomplete data will be given\. 56 48 .RE 57 49 .PP 58 50 logfile 59 .RS 3n60 Samba log file . log2pcap will try to read the log from stdin if the log file is not specified.51 .RS 4 52 Samba log file\. log2pcap will try to read the log from stdin if the log file is not specified\. 61 53 .RE 62 54 .PP 63 55 pcap_file 64 .RS 3n65 Name of the output file to write the pcap (or hexdump) data to . If this argument is not specified, output data will be written to stdout.56 .RS 4 57 Name of the output file to write the pcap (or hexdump) data to\. If this argument is not specified, output data will be written to stdout\. 66 58 .RE 67 59 .PP 68 -h|--help69 .RS 3n70 Print a summary of command line options .60 \-h|\-\-help 61 .RS 4 62 Print a summary of command line options\. 71 63 .RE 72 64 .SH "EXAMPLES" … … 74 66 Extract all network traffic from all samba log files: 75 67 .PP 76 77 .sp 78 68 .RS 4 79 69 .nf 80 81 $ log2pcap < /var/log/* > trace.pcap 70 $ log2pcap < /var/log/* > trace\.pcap 82 71 83 72 .fi 84 73 .RE 85 74 .PP 86 75 Convert to pcap using text2pcap: 87 76 .PP 88 89 .sp 90 77 .RS 4 91 78 .nf 92 93 $ log2pcap -h samba.log | text2pcap -T 139,139 - trace.pcap 79 $ log2pcap \-h samba\.log | text2pcap \-T 139,139 \- trace\.pcap 94 80 95 81 .fi 96 82 .RE 97 83 .SH "VERSION" 98 84 .PP 99 This man page is correct for version 3 .0 of the Samba suite.85 This man page is correct for version 3\.0 of the Samba suite\. 100 86 .SH "BUGS" 101 87 .PP 102 Only SMB data is extracted from the samba logs, no LDAP, NetBIOS lookup or other data .88 Only SMB data is extracted from the samba logs, no LDAP, NetBIOS lookup or other data\. 103 89 .PP 104 The generated TCP and IP headers don 't contain a valid checksum.90 The generated TCP and IP headers don\'t contain a valid checksum\. 105 91 .SH "SEE ALSO" 106 92 .PP … … 109 95 .SH "AUTHOR" 110 96 .PP 111 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.97 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 112 98 .PP 113 This manpage was written by Jelmer Vernooij. 114 99 This manpage was written by Jelmer Vernooij\. -
branches/samba-3.0/docs/manpages/mount.cifs.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "MOUNT.CIFS" 8 "" "" "" 1 .\" Title: mount.cifs 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "MOUNT\.CIFS" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 mount.cifs - mount using the Common Internet File System (CIFS) 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 mount .cifs {service} {mount-point} [-ooptions]17 mount\.cifs {service} {mount\-point} [\-o\ options] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .31 .PP 32 mount .cifs mounts a Linux CIFS filesystem. It is usually invoked indirectly by the22 suite\. 23 .PP 24 mount\.cifs mounts a Linux CIFS filesystem\. It is usually invoked indirectly by the 33 25 \fBmount\fR(8) 34 command when using the " -t cifs" option. This command only works in Linux, and the kernel must support the cifs filesystem. The CIFS protocol is the successor to the SMB protocol and is supported by most Windows servers and many other commercial servers and Network Attached Storage appliances as well as by the popular Open Source server Samba.35 .PP 36 The mount .cifs utility attaches the UNC name (exported network resource) to the local directory37 \f Bmount-point\fR. It is possible to set the mode for mount.cifs to setuid root to allow non-root users to mount shares to directories for which they have write permission.26 command when using the "\-t cifs" option\. This command only works in Linux, and the kernel must support the cifs filesystem\. The CIFS protocol is the successor to the SMB protocol and is supported by most Windows servers and many other commercial servers and Network Attached Storage appliances as well as by the popular Open Source server Samba\. 27 .PP 28 The mount\.cifs utility attaches the UNC name (exported network resource) to the local directory 29 \fImount\-point\fR\. It is possible to set the mode for mount\.cifs to setuid root to allow non\-root users to mount shares to directories for which they have write permission\. 38 30 .PP 39 31 Options to 40 \f Bmount.cifs\fR41 are specified as a comma -separated list of key=value pairs. It is possible to send options other than those listed here, assuming that the cifs filesystem kernel module (cifs.ko) supports them. Unrecognized cifs mount options passed to the cifs vfs kernel code will be logged to the kernel log.42 .PP 43 \f Bmount.cifs\fR44 causes the cifs vfs to launch a thread named cifsd . After mounting it keeps running until the mounted resource is unmounted (usually via the umount utility).32 \fImount\.cifs\fR 33 are specified as a comma\-separated list of key=value pairs\. It is possible to send options other than those listed here, assuming that the cifs filesystem kernel module (cifs\.ko) supports them\. Unrecognized cifs mount options passed to the cifs vfs kernel code will be logged to the kernel log\. 34 .PP 35 \fImount\.cifs\fR 36 causes the cifs vfs to launch a thread named cifsd\. After mounting it keeps running until the mounted resource is unmounted (usually via the umount utility)\. 45 37 .SH "OPTIONS" 46 38 .PP 47 39 user=\fIarg\fR 48 .RS 3n49 specifies the username to connect as . If this is not given, then the environment variable50 \f BUSER\fR51 is used . This option can also take the form "user%password" or "workgroup/user" or "workgroup/user%password" to allow the password and workgroup to be specified as part of the username.40 .RS 4 41 specifies the username to connect as\. If this is not given, then the environment variable 42 \fIUSER\fR 43 is used\. This option can also take the form "user%password" or "workgroup/user" or "workgroup/user%password" to allow the password and workgroup to be specified as part of the username\. 52 44 .sp 53 45 .it 1 an-trap … … 55 47 .nr an-break-flag 1 56 48 .br 57 \fBNote\fR 49 Note 58 50 The cifs vfs accepts the parameter 59 51 \fIuser=\fR, or for users familiar with smbfs it accepts the longer form of the parameter 60 \fIusername=\fR . Similarly the longer smbfs style parameter names may be accepted as synonyms for the shorter cifs parameters52 \fIusername=\fR\. Similarly the longer smbfs style parameter names may be accepted as synonyms for the shorter cifs parameters 61 53 \fIpass=\fR,\fIdom=\fR 62 54 and 63 \fIcred=\fR .55 \fIcred=\fR\. 64 56 .RE 65 57 .PP 66 58 password=\fIarg\fR 67 .RS 3n68 specifies the CIFS password . If this option is not given then the environment variable69 \f BPASSWD\fR70 is used . If the password is not specified directly or indirectly via an argument to mount71 \f Bmount.cifs\fR72 will prompt for a password, unless the guest option is specified .73 .sp 74 Note that a password which contains the delimiter character (i .e. a comma ',') will fail to be parsed correctly on the command line. However, the same password defined in the PASSWD environment variable or via a credentials file (see below) or entered at the password prompt will be read correctly.59 .RS 4 60 specifies the CIFS password\. If this option is not given then the environment variable 61 \fIPASSWD\fR 62 is used\. If the password is not specified directly or indirectly via an argument to mount, 63 \fImount\.cifs\fR 64 will prompt for a password, unless the guest option is specified\. 65 .sp 66 Note that a password which contains the delimiter character (i\.e\. a comma \',\') will fail to be parsed correctly on the command line\. However, the same password defined in the PASSWD environment variable or via a credentials file (see below) or entered at the password prompt will be read correctly\. 75 67 .RE 76 68 .PP 77 69 credentials=\fIfilename\fR 78 .RS 3n 79 specifies a file that contains a username and/or password. The format of the file is: 80 70 .RS 4 71 specifies a file that contains a username and/or password\. The format of the file is: 72 .sp 73 .RS 4 81 74 .nf 82 83 75 username=\fIvalue\fR 84 76 password=\fIvalue\fR 85 86 77 .fi 78 .RE 87 79 This is preferred over having passwords in plaintext in a shared file, such as 88 \fI/etc/fstab\fR . Be sure to protect any credentials file properly.80 \fI/etc/fstab\fR\. Be sure to protect any credentials file properly\. 89 81 .RE 90 82 .PP 91 83 uid=\fIarg\fR 92 .RS 3n93 sets the uid that will own all files on the mounted filesystem . It may be specified as either a username or a numeric uid. This parameter is ignored when the target server supports the CIFS Unix extensions.84 .RS 4 85 sets the uid that will own all files on the mounted filesystem\. It may be specified as either a username or a numeric uid\. For mounts to servers which do support the CIFS Unix extensions, such as a properly configured Samba server, the server provides the uid, gid and mode so this parameter should not be specified unless the server and client uid and gid numbering differ\. If the server and client are in the same domain (e\.g\. running winbind or nss_ldap) and the server supports the Unix Extensions then the uid and gid can be retrieved from the server (and uid and gid would not have to be specifed on the mount\. For servers which do not support the CIFS Unix extensions, the default uid (and gid) returned on lookup of existing files will be the uid (gid) of the person who executed the mount (root, except when mount\.cifs is configured setuid for user mounts) unless the "uid=" (gid) mount option is specified\. For the uid (gid) of newly created files and directories, ie files created since the last mount of the server share, the expected uid (gid) is cached as long as the inode remains in memory on the client\. Also note that permission checks (authorization checks) on accesses to a file occur at the server, but there are cases in which an administrator may want to restrict at the client as well\. For those servers which do not report a uid/gid owner (such as Windows), permissions can also be checked at the client, and a crude form of client side permission checking can be enabled by specifying file_mode and dir_mode on the client\. Note that the mount\.cifs helper must be at version 1\.10 or higher to support specifying the uid (or gid) in non\-numeric form\. 94 86 .RE 95 87 .PP 96 88 gid=\fIarg\fR 97 .RS 3n98 sets the gid that will own all files on the mounted filesystem . It may be specified as either a groupname or a numeric gid. This parameter is ignored when the target server supports the CIFS Unix extensions.89 .RS 4 90 sets the gid that will own all files on the mounted filesystem\. It may be specified as either a groupname or a numeric gid\. For other considerations see the description of uid above\. 99 91 .RE 100 92 .PP 101 93 port=\fIarg\fR 102 .RS 3n 103 sets the port number on the server to attempt to contact to negotiate CIFS support. If the CIFS server is not listening on this port or if it is not specified, the default ports will be tried i.e. port 445 is tried and if no response then port 139 is tried. 94 .RS 4 95 sets the port number on the server to attempt to contact to negotiate CIFS support\. If the CIFS server is not listening on this port or if it is not specified, the default ports will be tried i\.e\. port 445 is tried and if no response then port 139 is tried\. 96 .RE 97 .PP 98 servern=\fIarg\fR 99 .RS 4 100 Specify the server netbios name (RFC1001 name) to use when attempting to setup a session to the server\. Although rarely needed for mounting to newer servers, this option is needed for mounting to some older servers (such as OS/2 or Windows 98 and Windows ME) since when connecting over port 139 they, unlike most newer servers, do not support a default server name\. A server name can be up to 15 characters long and is usually uppercased\. 104 101 .RE 105 102 .PP 106 103 netbiosname=\fIarg\fR 107 .RS 3n108 When mounting to servers via port 139, specifies the RFC1001 source name to use to represent the client netbios machine name when doing the RFC1001 netbios session initialize .104 .RS 4 105 When mounting to servers via port 139, specifies the RFC1001 source name to use to represent the client netbios machine name when doing the RFC1001 netbios session initialize\. 109 106 .RE 110 107 .PP 111 108 file_mode=\fIarg\fR 112 .RS 3n113 If the server does not support the CIFS Unix extensions this overrides the default file mode .109 .RS 4 110 If the server does not support the CIFS Unix extensions this overrides the default file mode\. 114 111 .RE 115 112 .PP 116 113 dir_mode=\fIarg\fR 117 .RS 3n118 If the server does not support the CIFS Unix extensions this overrides the default mode for directories .114 .RS 4 115 If the server does not support the CIFS Unix extensions this overrides the default mode for directories\. 119 116 .RE 120 117 .PP 121 118 ip=\fIarg\fR 122 .RS 3n123 sets the destination host or IP address.119 .RS 4 120 sets the destination IP address\. This option is set automatically if the server name portion of the requested UNC name can be resolved so rarely needs to be specified by the user\. 124 121 .RE 125 122 .PP 126 123 domain=\fIarg\fR 127 .RS 3n124 .RS 4 128 125 sets the domain (workgroup) of the user 129 126 .RE 130 127 .PP 131 128 guest 132 .RS 3n133 don 't prompt for a password129 .RS 4 130 don\'t prompt for a password 134 131 .RE 135 132 .PP 136 133 iocharset 137 .RS 3n138 Charset used to convert local path names to and from Unicode . Unicode is used by default for network path names if the server supports it. If iocharset is not specified then the nls_default specified during the local client kernel build will be used. If server does not support Unicode, this parameter is unused.134 .RS 4 135 Charset used to convert local path names to and from Unicode\. Unicode is used by default for network path names if the server supports it\. If iocharset is not specified then the nls_default specified during the local client kernel build will be used\. If server does not support Unicode, this parameter is unused\. 139 136 .RE 140 137 .PP 141 138 ro 142 .RS 3n143 mount read -only139 .RS 4 140 mount read\-only 144 141 .RE 145 142 .PP 146 143 rw 147 .RS 3n148 mount read -write144 .RS 4 145 mount read\-write 149 146 .RE 150 147 .PP 151 148 setuids 152 .RS 3n153 If the CIFS Unix extensions are negotiated with the server the client will attempt to set the effective uid and gid of the local process on newly created files, directories, and devices (create, mkdir, mknod) . If the CIFS Unix Extensions are not negotiated, for newly created files and directories instead of using the default uid and gid specified on the the mount, cache the new file's uid and gid locally which means that the uid for the file can change when the inode is reloaded (or the user remounts the share).149 .RS 4 150 If the CIFS Unix extensions are negotiated with the server the client will attempt to set the effective uid and gid of the local process on newly created files, directories, and devices (create, mkdir, mknod)\. If the CIFS Unix Extensions are not negotiated, for newly created files and directories instead of using the default uid and gid specified on the the mount, cache the new file\'s uid and gid locally which means that the uid for the file can change when the inode is reloaded (or the user remounts the share)\. 154 151 .RE 155 152 .PP 156 153 nosetuids 157 .RS 3n158 The client will not attempt to set the uid and gid on on newly created files, directories, and devices (create, mkdir, mknod) which will result in the server setting the uid and gid to the default (usually the server uid of the user who mounted the share) . Letting the server (rather than the client) set the uid and gid is the default.If the CIFS Unix Extensions are not negotiated then the uid and gid for new files will appear to be the uid (gid) of the mounter or the uid (gid) parameter specified on the mount.154 .RS 4 155 The client will not attempt to set the uid and gid on on newly created files, directories, and devices (create, mkdir, mknod) which will result in the server setting the uid and gid to the default (usually the server uid of the user who mounted the share)\. Letting the server (rather than the client) set the uid and gid is the default\.If the CIFS Unix Extensions are not negotiated then the uid and gid for new files will appear to be the uid (gid) of the mounter or the uid (gid) parameter specified on the mount\. 159 156 .RE 160 157 .PP 161 158 perm 162 .RS 3n163 Client does permission checks (vfs_permission check of uid and gid of the file against the mode and desired operation), Note that this is in addition to the normal ACL check on the target machine done by the server software . Client permission checking is enabled by default.159 .RS 4 160 Client does permission checks (vfs_permission check of uid and gid of the file against the mode and desired operation), Note that this is in addition to the normal ACL check on the target machine done by the server software\. Client permission checking is enabled by default\. 164 161 .RE 165 162 .PP 166 163 noperm 167 .RS 3n168 Client does not do permission checks . This can expose files on this mount to access by other users on the local client system. It is typically only needed when the server supports the CIFS Unix Extensions but the UIDs/GIDs on the client and server system do not match closely enough to allow access by the user doing the mount. Note that this does not affect the normal ACL check on the target machine done by the server software (of the server ACL against the user name provided at mount time).164 .RS 4 165 Client does not do permission checks\. This can expose files on this mount to access by other users on the local client system\. It is typically only needed when the server supports the CIFS Unix Extensions but the UIDs/GIDs on the client and server system do not match closely enough to allow access by the user doing the mount\. Note that this does not affect the normal ACL check on the target machine done by the server software (of the server ACL against the user name provided at mount time)\. 169 166 .RE 170 167 .PP 171 168 directio 172 .RS 3n173 Do not do inode data caching on files opened on this mount . This precludes mmaping files on this mount. In some cases with fast networks and little or no caching benefits on the client (e.g. when the application is doing large sequential reads bigger than page size without rereading the same data) this can provide better performance than the default behavior which caches reads (readahead) and writes (writebehind) through the local Linux client pagecache if oplock (caching token) is granted and held. Note that direct allows write operations larger than page size to be sent to the server. On some kernels this requires the cifs.ko module to be built with the CIFS_EXPERIMENTAL configure option.169 .RS 4 170 Do not do inode data caching on files opened on this mount\. This precludes mmaping files on this mount\. In some cases with fast networks and little or no caching benefits on the client (e\.g\. when the application is doing large sequential reads bigger than page size without rereading the same data) this can provide better performance than the default behavior which caches reads (readahead) and writes (writebehind) through the local Linux client pagecache if oplock (caching token) is granted and held\. Note that direct allows write operations larger than page size to be sent to the server\. On some kernels this requires the cifs\.ko module to be built with the CIFS_EXPERIMENTAL configure option\. 174 171 .RE 175 172 .PP 176 173 mapchars 177 .RS 3n178 Translate six of the seven reserved characters (not backslash, but including the colon, question mark, pipe, asterik, greater than and less than characters) to the remap range (above 0xF000), which also allows the CIFS client to recognize files created with such characters by Windows 's POSIX emulation. This can also be useful when mounting to most versions of Samba (which also forbids creating and opening files whose names contain any of these seven characters). This has no effect if the server does not support Unicode on the wire.174 .RS 4 175 Translate six of the seven reserved characters (not backslash, but including the colon, question mark, pipe, asterik, greater than and less than characters) to the remap range (above 0xF000), which also allows the CIFS client to recognize files created with such characters by Windows\'s POSIX emulation\. This can also be useful when mounting to most versions of Samba (which also forbids creating and opening files whose names contain any of these seven characters)\. This has no effect if the server does not support Unicode on the wire\. 179 176 .RE 180 177 .PP 181 178 nomapchars 182 .RS 3n179 .RS 4 183 180 Do not translate any of these seven characters (default) 184 181 .RE 185 182 .PP 186 183 intr 187 .RS 3n184 .RS 4 188 185 currently unimplemented 189 186 .RE 190 187 .PP 191 188 nointr 192 .RS 3n189 .RS 4 193 190 (default) currently unimplemented 194 191 .RE 195 192 .PP 196 193 hard 197 .RS 3n198 The program accessing a file on the cifs mounted file system will hang when the server crashes .194 .RS 4 195 The program accessing a file on the cifs mounted file system will hang when the server crashes\. 199 196 .RE 200 197 .PP 201 198 soft 202 .RS 3n203 (default) The program accessing a file on the cifs mounted file system will not hang when the server crashes and will return errors to the user application .199 .RS 4 200 (default) The program accessing a file on the cifs mounted file system will not hang when the server crashes and will return errors to the user application\. 204 201 .RE 205 202 .PP 206 203 noacl 207 .RS 3n208 Do not allow POSIX ACL operations even if server would support them .209 .sp 210 The CIFS client can get and set POSIX ACLs (getfacl, setfacl) to Samba servers version 3 .10 and later. Setting POSIX ACLs requires enabling both XATTR and then POSIX support in the CIFS configuration options when building the cifs module. POSIX ACL support can be disabled on a per mount basic by specifying "noacl" on mount.204 .RS 4 205 Do not allow POSIX ACL operations even if server would support them\. 206 .sp 207 The CIFS client can get and set POSIX ACLs (getfacl, setfacl) to Samba servers version 3\.10 and later\. Setting POSIX ACLs requires enabling both XATTR and then POSIX support in the CIFS configuration options when building the cifs module\. POSIX ACL support can be disabled on a per mount basic by specifying "noacl" on mount\. 211 208 .RE 212 209 .PP 213 210 nocase 214 .RS 3n215 Request case insensitive path name matching (case sensitive is the default if the server suports it) .211 .RS 4 212 Request case insensitive path name matching (case sensitive is the default if the server suports it)\. 216 213 .RE 217 214 .PP 218 215 sec= 219 .RS 3n 220 Security mode. Allowed values are: 221 .RS 3n 222 .TP 3n 223 \(bu 216 .RS 4 217 Security mode\. Allowed values are: 218 .sp 219 .RS 4 220 .ie n \{\ 221 \h'-04'\(bu\h'+03'\c 222 .\} 223 .el \{\ 224 .sp -1 225 .IP \(bu 2.3 226 .\} 224 227 none attempt to connection as a null user (no name) 225 .TP 3n 226 \(bu 228 .RE 229 .sp 230 .RS 4 231 .ie n \{\ 232 \h'-04'\(bu\h'+03'\c 233 .\} 234 .el \{\ 235 .sp -1 236 .IP \(bu 2.3 237 .\} 227 238 krb5 Use Kerberos version 5 authentication 228 .TP 3n 229 \(bu 239 .RE 240 .sp 241 .RS 4 242 .ie n \{\ 243 \h'-04'\(bu\h'+03'\c 244 .\} 245 .el \{\ 246 .sp -1 247 .IP \(bu 2.3 248 .\} 230 249 krb5i Use Kerberos authentication and packet signing 231 .TP 3n 232 \(bu 250 .RE 251 .sp 252 .RS 4 253 .ie n \{\ 254 \h'-04'\(bu\h'+03'\c 255 .\} 256 .el \{\ 257 .sp -1 258 .IP \(bu 2.3 259 .\} 233 260 ntlm Use NTLM password hashing (default) 234 .TP 3n 235 \(bu 261 .RE 262 .sp 263 .RS 4 264 .ie n \{\ 265 \h'-04'\(bu\h'+03'\c 266 .\} 267 .el \{\ 268 .sp -1 269 .IP \(bu 2.3 270 .\} 236 271 ntlmi Use NTLM password hashing with signing (if /proc/fs/cifs/PacketSigningEnabled on or if server requires signing also can be the default) 237 .TP 3n 238 \(bu 272 .RE 273 .sp 274 .RS 4 275 .ie n \{\ 276 \h'-04'\(bu\h'+03'\c 277 .\} 278 .el \{\ 279 .sp -1 280 .IP \(bu 2.3 281 .\} 239 282 ntlmv2 Use NTLMv2 password hashing 240 .TP 3n 241 \(bu 283 .RE 284 .sp 285 .RS 4 286 .ie n \{\ 287 \h'-04'\(bu\h'+03'\c 288 .\} 289 .el \{\ 290 .sp -1 291 .IP \(bu 2.3 292 .\} 242 293 ntlmv2i Use NTLMv2 password hashing with packet signing 243 . RE244 . IP "" 3n245 [NB This [sec parameter] is under development and expected to be available in cifs kernel module 1 .40 and later]294 .sp 295 .RE 296 [NB This [sec parameter] is under development and expected to be available in cifs kernel module 1\.40 and later] 246 297 .RE 247 298 .PP 248 299 nobrl 249 .RS 3n250 Do not send byte range lock requests to the server . This is necessary for certain applications that break with cifs style mandatory byte range locks (and most cifs servers do not yet support requesting advisory byte range locks).300 .RS 4 301 Do not send byte range lock requests to the server\. This is necessary for certain applications that break with cifs style mandatory byte range locks (and most cifs servers do not yet support requesting advisory byte range locks)\. 251 302 .RE 252 303 .PP 253 304 sfu 254 .RS 3n255 When the CIFS Unix Extensions are not negotiated, attempt to create device files and fifos in a format compatible with Services for Unix (SFU) . In addition retrieve bits 10-12 of the mode via the SETFILEBITS extended attribute (as SFU does). In the future the bottom 9 bits of the mode mode also will be emulated using queries of the security descriptor (ACL). [NB: requires version 1.39 or later of the CIFS VFS. To recognize symlinks and be able to create symlinks in an SFU interoperable form requires version 1.40 or later of the CIFS VFS kernel module.305 .RS 4 306 When the CIFS Unix Extensions are not negotiated, attempt to create device files and fifos in a format compatible with Services for Unix (SFU)\. In addition retrieve bits 10\-12 of the mode via the SETFILEBITS extended attribute (as SFU does)\. In the future the bottom 9 bits of the mode mode also will be emulated using queries of the security descriptor (ACL)\. [NB: requires version 1\.39 or later of the CIFS VFS\. To recognize symlinks and be able to create symlinks in an SFU interoperable form requires version 1\.40 or later of the CIFS VFS kernel module\. 256 307 .RE 257 308 .PP 258 309 serverino 259 .RS 3n260 Use inode numbers (unique persistent file identifiers) returned by the server instead of automatically generating temporary inode numbers on the client . Although server inode numbers make it easier to spot hardlinked files (as they will have the same inode numbers) and inode numbers may be persistent (which is userful for some sofware), the server does not guarantee that the inode numbers are unique if multiple server side mounts are exported under a single share (since inode numbers on the servers might not be unique if multiple filesystems are mounted under the same shared higher level directory). Note that not all servers support returning server inode numbers, although those that support the CIFS Unix Extensions, and Windows 2000 and later servers typically do support this (although not necessarily on every local server filesystem). Parameter has no effect if the server lacks support for returning inode numbers or equivalent.310 .RS 4 311 Use inode numbers (unique persistent file identifiers) returned by the server instead of automatically generating temporary inode numbers on the client\. Although server inode numbers make it easier to spot hardlinked files (as they will have the same inode numbers) and inode numbers may be persistent (which is userful for some sofware), the server does not guarantee that the inode numbers are unique if multiple server side mounts are exported under a single share (since inode numbers on the servers might not be unique if multiple filesystems are mounted under the same shared higher level directory)\. Note that not all servers support returning server inode numbers, although those that support the CIFS Unix Extensions, and Windows 2000 and later servers typically do support this (although not necessarily on every local server filesystem)\. Parameter has no effect if the server lacks support for returning inode numbers or equivalent\. 261 312 .RE 262 313 .PP 263 314 noserverino 264 .RS 3n265 client generates inode numbers (rather than using the actual one from the server) by default .315 .RS 4 316 client generates inode numbers (rather than using the actual one from the server) by default\. 266 317 .RE 267 318 .PP 268 319 nouser_xattr 269 .RS 3n270 (default) Do not allow getfattr/setfattr to get/set xattrs, even if server would support it otherwise .320 .RS 4 321 (default) Do not allow getfattr/setfattr to get/set xattrs, even if server would support it otherwise\. 271 322 .RE 272 323 .PP 273 324 rsize=\fIarg\fR 274 .RS 3n275 default network read size 325 .RS 4 326 default network read size (usually 16K)\. The client currently can not use rsize larger than CIFSMaxBufSize\. CIFSMaxBufSize defaults to 16K and may be changed (from 8K to the maximum kmalloc size allowed by your kernel) at module install time for cifs\.ko\. Setting CIFSMaxBufSize to a very large value will cause cifs to use more memory and may reduce performance in some cases\. To use rsize greater than 127K (the original cifs protocol maximum) also requires that the server support a new Unix Capability flag (for very large read) which some newer servers (e\.g\. Samba 3\.0\.26 or later) do\. rsize can be set from a minimum of 2048 to a maximum of 130048 (127K or CIFSMaxBufSize, whichever is smaller) 276 327 .RE 277 328 .PP 278 329 wsize=\fIarg\fR 279 .RS 3n 280 default network write size 281 .RE 282 .PP 283 --verbose 284 .RS 3n 285 Print additional debugging information for the mount. Note that this parameter must be specified before the -o. For example: 286 .sp 287 mount -t cifs //server/share /mnt --verbose -o user=username 288 .RE 330 .RS 4 331 default network write size (default 57344) maximum wsize currently allowed by CIFS is 57344 (fourteen 4096 byte pages) 332 .RE 333 .PP 334 \-\-verbose 335 .RS 4 336 Print additional debugging information for the mount\. Note that this parameter must be specified before the \-o\. For example: 337 .sp 338 mount \-t cifs //server/share /mnt \-\-verbose \-o user=username 339 .RE 340 .SH "SERVICE FORMATTING AND DELIMITERS" 341 .PP 342 It\'s generally preferred to use forward slashes (/) as a delimiter in service names\. They are considered to be the "universal delimiter" since they are generally not allowed to be embedded within path components on Windows machines and the client can convert them to blackslashes (\e) unconditionally\. Conversely, backslash characters are allowed by POSIX to be part of a path component, and can\'t be automatically converted in the same way\. 343 .PP 344 mount\.cifs will attempt to convert backslashes to forward slashes where it\'s able to do so, but it cannot do so in any path component following the sharename\. 289 345 .SH "ENVIRONMENT VARIABLES" 290 346 .PP 291 347 The variable 292 \f BUSER\fR293 may contain the username of the person to be used to authenticate to the server . The variable can be used to set both username and password by using the format username%password.348 \fIUSER\fR 349 may contain the username of the person to be used to authenticate to the server\. The variable can be used to set both username and password by using the format username%password\. 294 350 .PP 295 351 The variable 296 \f BPASSWD\fR297 may contain the password of the person using the client .352 \fIPASSWD\fR 353 may contain the password of the person using the client\. 298 354 .PP 299 355 The variable 300 \f BPASSWD_FILE\fR301 may contain the pathname of a file to read the password from . A single line of input is read and used as the password.356 \fIPASSWD_FILE\fR 357 may contain the pathname of a file to read the password from\. A single line of input is read and used as the password\. 302 358 .SH "NOTES" 303 359 .PP 304 This command may be used only by root, unless installed setuid, in which case the noeexec and nosuid mount flags are enabled .360 This command may be used only by root, unless installed setuid, in which case the noeexec and nosuid mount flags are enabled\. 305 361 .SH "CONFIGURATION" 306 362 .PP 307 The primary mechanism for making configuration changes and for reading debug information for the cifs vfs is via the Linux /proc filesystem . In the directory363 The primary mechanism for making configuration changes and for reading debug information for the cifs vfs is via the Linux /proc filesystem\. In the directory 308 364 \fI/proc/fs/cifs\fR 309 are various configuration files and pseudo files which can display debug information . There are additional startup options such as maximum buffer size and number of buffers which only may be set when the kernel cifs vfs (cifs.ko module) is loaded. These can be seen by running the modinfo utility against the file cifs.ko which will list the options that may be passed to cifs during module installation (device driver load). For more information see the kernel file310 \fIfs/cifs/README\fR .365 are various configuration files and pseudo files which can display debug information\. There are additional startup options such as maximum buffer size and number of buffers which only may be set when the kernel cifs vfs (cifs\.ko module) is loaded\. These can be seen by running the modinfo utility against the file cifs\.ko which will list the options that may be passed to cifs during module installation (device driver load)\. For more information see the kernel file 366 \fIfs/cifs/README\fR\. 311 367 .SH "BUGS" 312 368 .PP 313 Mounting using the CIFS URL specification is currently not supported .314 .PP 315 The credentials file does not handle usernames or passwords with leading space .316 .PP 317 Note that the typical response to a bug report is a suggestion to try the latest version first . So please try doing that first, and always include which versions you use of relevant software when reporting bugs (minimum: mount.cifs (try mount.cifs -V), kernel (see /proc/version) and server type you are trying to contact.369 Mounting using the CIFS URL specification is currently not supported\. 370 .PP 371 The credentials file does not handle usernames or passwords with leading space\. 372 .PP 373 Note that the typical response to a bug report is a suggestion to try the latest version first\. So please try doing that first, and always include which versions you use of relevant software when reporting bugs (minimum: mount\.cifs (try mount\.cifs \-V), kernel (see /proc/version) and server type you are trying to contact\. 318 374 .SH "VERSION" 319 375 .PP 320 This man page is correct for version 1 .39 of the cifs vfs filesystem (roughly Linux kernel 2.6.15).376 This man page is correct for version 1\.52 of the cifs vfs filesystem (roughly Linux kernel 2\.6\.24)\. 321 377 .SH "SEE ALSO" 322 378 .PP 323 Documentation/filesystems/cifs .txt and fs/cifs/README in the linux kernel source tree may contain additional options and information.379 Documentation/filesystems/cifs\.txt and fs/cifs/README in the linux kernel source tree may contain additional options and information\. 324 380 .PP 325 381 \fBumount.cifs\fR(8) … … 328 384 Steve French 329 385 .PP 330 The syntax and manpage were loosely based on that of smbmount . It was converted to Docbook/XML by Jelmer Vernooij.386 The syntax and manpage were loosely based on that of smbmount\. It was converted to Docbook/XML by Jelmer Vernooij\. 331 387 .PP 332 388 The maintainer of the Linux cifs vfs and the userspace tool 333 \f Bmount.cifs\fR389 \fImount\.cifs\fR 334 390 is 335 Steve French . The391 Steve French\. The 336 392 Linux CIFS Mailing list 337 is the preferred place to ask questions regarding these programs. 338 393 is the preferred place to ask questions regarding these programs\. -
branches/samba-3.0/docs/manpages/net.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "NET" 8 "" "" "" 1 .\" Title: net 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "NET" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 net - Tool for administration of Samba and remote CIFS servers. 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 net {<ads|rap|rpc>} [ -h] [-w workgroup] [-W myworkgroup] [-U user] [-I ip-address] [-p port] [-n myname] [-s conffile] [-S server] [-l] [-P] [-d debuglevel] [-V]17 net {<ads|rap|rpc>} [\-h] [\-w\ workgroup] [\-W\ myworkgroup] [\-U\ user] [\-I\ ip\-address] [\-p\ port] [\-n\ myname] [\-s\ conffile] [\-S\ server] [\-l] [\-P] [\-d\ debuglevel] [\-V] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .31 .PP 32 The samba net utility is meant to work just like the net utility available for windows and DOS. The first argument should be used to specify the protocol to use when executing a certain command. ADS is used for ActiveDirectory, RAP is using for old (Win9x/NT3) clients and RPC can be used for NT4 and Windows 2000. If this argument is omitted, net will try to determine it automatically. Not all commands are available on all protocols.22 suite\. 23 .PP 24 The Samba net utility is meant to work just like the net utility available for windows and DOS\. The first argument should be used to specify the protocol to use when executing a certain command\. ADS is used for ActiveDirectory, RAP is using for old (Win9x/NT3) clients and RPC can be used for NT4 and Windows 2000\. If this argument is omitted, net will try to determine it automatically\. Not all commands are available on all protocols\. 33 25 .SH "OPTIONS" 34 26 .PP 35 -h|--help36 .RS 3n37 Print a summary of command line options .38 .RE 39 .PP 40 -w target-workgroup41 .RS 3n42 Sets target workgroup or domain . You have to specify either this option or the IP address or the name of a server.43 .RE 44 .PP 45 -W workgroup46 .RS 3n27 \-h|\-\-help 28 .RS 4 29 Print a summary of command line options\. 30 .RE 31 .PP 32 \-w target\-workgroup 33 .RS 4 34 Sets target workgroup or domain\. You have to specify either this option or the IP address or the name of a server\. 35 .RE 36 .PP 37 \-W workgroup 38 .RS 4 47 39 Sets client workgroup or domain 48 40 .RE 49 41 .PP 50 -U user51 .RS 3n42 \-U user 43 .RS 4 52 44 User name to use 53 45 .RE 54 46 .PP 55 -I ip-address56 .RS 3n57 IP address of target server to use . You have to specify either this option or a target workgroup or a target server.58 .RE 59 .PP 60 -p port61 .RS 3n62 Port on the target server to connect to (usually 139 or 445) . Defaults to trying 445 first, then 139.63 .RE 64 .PP 65 -n <primary NetBIOS name>66 .RS 3n67 This option allows you to override the NetBIOS name that Samba uses for itself . This is identical to setting the68 47 \-I ip\-address 48 .RS 4 49 IP address of target server to use\. You have to specify either this option or a target workgroup or a target server\. 50 .RE 51 .PP 52 \-p port 53 .RS 4 54 Port on the target server to connect to (usually 139 or 445)\. Defaults to trying 445 first, then 139\. 55 .RE 56 .PP 57 \-n <primary NetBIOS name> 58 .RS 4 59 This option allows you to override the NetBIOS name that Samba uses for itself\. This is identical to setting the 60 \fInetbios name\fR 69 61 parameter in the 70 \fIsmb .conf\fR71 file . However, a command line setting will take precedence over settings in72 \fIsmb .conf\fR.73 .RE 74 .PP 75 -s <configuration file>76 .RS 3n77 The file specified contains the configuration details required by the server . The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See78 \fIsmb .conf\fR79 for more information . The default configuration file name is determined at compile time.80 .RE 81 .PP 82 -S server83 .RS 3n84 Name of target server . You should specify either this option or a target workgroup or a target IP address.85 .RE 86 .PP 87 -l88 .RS 3n89 When listing data, give more information on each item .90 .RE 91 .PP 92 -P93 .RS 3n94 Make queries to the external server using the machine account of the local server .95 .RE 96 .PP 97 -d|--debuglevel=level98 .RS 3n62 \fIsmb\.conf\fR 63 file\. However, a command line setting will take precedence over settings in 64 \fIsmb\.conf\fR\. 65 .RE 66 .PP 67 \-s <configuration file> 68 .RS 4 69 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 70 \fIsmb\.conf\fR 71 for more information\. The default configuration file name is determined at compile time\. 72 .RE 73 .PP 74 \-S server 75 .RS 4 76 Name of target server\. You should specify either this option or a target workgroup or a target IP address\. 77 .RE 78 .PP 79 \-l 80 .RS 4 81 When listing data, give more information on each item\. 82 .RE 83 .PP 84 \-P 85 .RS 4 86 Make queries to the external server using the machine account of the local server\. 87 .RE 88 .PP 89 \-d|\-\-debuglevel=level 90 .RS 4 99 91 \fIlevel\fR 100 is an integer from 0 to 10 . The default value if this parameter is not specified is zero.101 .sp 102 The higher this value, the more detail will be logged to the log files about the activities of the server . At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out.103 .sp 104 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem . Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic.92 is an integer from 0 to 10\. The default value if this parameter is not specified is 0\. 93 .sp 94 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 95 .sp 96 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 105 97 .sp 106 98 Note that specifying this parameter here will override the 107 99 \fIlog level\fR 108 100 parameter in the 109 \fIsmb .conf\fR110 file .101 \fIsmb\.conf\fR 102 file\. 111 103 .RE 112 104 .SH "COMMANDS" 113 105 .SS "CHANGESECRETPW" 114 106 .PP 115 This command allows the Samba machine account password to be set from an external application to a machine account password that has already been stored in Active Directory . DO NOT USE this command unless you know exactly what you are doing. The use of this command requires that the force flag (-f) be used also. There will be NO command prompt. Whatever information is piped into stdin, either by typing at the command line or otherwise, will be stored as the literal machine password. Do NOT use this without care and attention as it will overwrite a legitimate machine password without warning. YOU HAVE BEEN WARNED.107 This command allows the Samba machine account password to be set from an external application to a machine account password that has already been stored in Active Directory\. DO NOT USE this command unless you know exactly what you are doing\. The use of this command requires that the force flag (\-f) be used also\. There will be NO command prompt\. Whatever information is piped into stdin, either by typing at the command line or otherwise, will be stored as the literal machine password\. Do NOT use this without care and attention as it will overwrite a legitimate machine password without warning\. YOU HAVE BEEN WARNED\. 116 108 .SS "TIME" 117 109 .PP 118 110 The 119 111 NET TIME 120 command allows you to view the time on a remote server or synchronise the time on the local server with the time on the remote server. 121 112 command allows you to view the time on a remote server or synchronise the time on the local server with the time on the remote server\. 122 113 .SS "TIME" 123 114 .PP 124 115 Without any options, the 125 116 NET TIME 126 command displays the time on the remote server. 127 117 command displays the time on the remote server\. 128 118 .SS "TIME SYSTEM" 129 119 .PP 130 120 Displays the time on the remote server in a format ready for 131 /bin/date 132 121 /bin/date\. 133 122 .SS "TIME SET" 134 123 .PP 135 124 Tries to set the date and time of the local server to that on the remote server using 136 /bin/date. 137 125 /bin/date\. 138 126 .SS "TIME ZONE" 139 127 .PP 140 Displays the timezone in hours from GMT on the remote computer .141 .SS "[RPC|ADS] JOIN [TYPE] [ -U username[%password]] [createupn=UPN] [createcomputer=OU] [options]"142 .PP 143 Join a domain . If the account already exists on the server, and [TYPE] is MEMBER, the machine will attempt to join automatically. (Assuming that the machine has been created in server manager) Otherwise, a password will be prompted for, and a new account may be created.144 .PP 145 [TYPE] may be PDC, BDC or MEMBER to specify the type of server joining the domain .146 .PP 147 [UPN] (ADS only) set the principalname attribute during the join . The default format is host/netbiosname@REALM.148 .PP 149 [OU] (ADS only) Precreate the computer account in a specific OU . The OU string reads from top to bottom without RDNs, and is delimited by a '/'. Please note that '\' is used for escape by both the shell and ldap, so it may need to be doubled or quadrupled to pass through, and it is not used as a delimiter.128 Displays the timezone in hours from GMT on the remote computer\. 129 .SS "[RPC|ADS] JOIN [TYPE] [\-U username[%password]] [createupn=UPN] [createcomputer=OU] [options]" 130 .PP 131 Join a domain\. If the account already exists on the server, and [TYPE] is MEMBER, the machine will attempt to join automatically\. (Assuming that the machine has been created in server manager) Otherwise, a password will be prompted for, and a new account may be created\. 132 .PP 133 [TYPE] may be PDC, BDC or MEMBER to specify the type of server joining the domain\. 134 .PP 135 [UPN] (ADS only) set the principalname attribute during the join\. The default format is host/netbiosname@REALM\. 136 .PP 137 [OU] (ADS only) Precreate the computer account in a specific OU\. The OU string reads from top to bottom without RDNs, and is delimited by a \'/\'\. Please note that \'\e\' is used for escape by both the shell and ldap, so it may need to be doubled or quadrupled to pass through, and it is not used as a delimiter\. 150 138 .SS "[RPC] OLDJOIN [options]" 151 139 .PP 152 Join a domain . Use the OLDJOIN option to join the domain using the old style of domain joining - you need to create a trust account in server manager first.140 Join a domain\. Use the OLDJOIN option to join the domain using the old style of domain joining \- you need to create a trust account in server manager first\. 153 141 .SS "[RPC|ADS] USER" 154 155 142 .SS "[RPC|ADS] USER" 156 143 .PP 157 144 List all users 158 159 145 .SS "[RPC|ADS] USER DELETE target" 160 146 .PP 161 147 Delete specified user 162 163 148 .SS "[RPC|ADS] USER INFO target" 164 149 .PP 165 List the domain groups of a the specified user. 166 150 List the domain groups of the specified user\. 167 151 .SS "[RPC|ADS] USER RENAME oldname newname" 168 152 .PP 169 Rename specified user. 170 153 Rename specified user\. 171 154 .SS "[RPC|ADS] USER ADD name [password] [-F user flags] [-C comment]" 172 155 .PP 173 Add specified user .156 Add specified user\. 174 157 .SS "[RPC|ADS] GROUP" 175 176 158 .SS "[RPC|ADS] GROUP [misc options] [targets]" 177 159 .PP 178 List user groups. 179 160 List user groups\. 180 161 .SS "[RPC|ADS] GROUP DELETE name [misc. options]" 181 162 .PP 182 Delete specified group. 183 163 Delete specified group\. 184 164 .SS "[RPC|ADS] GROUP ADD name [-C comment]" 185 165 .PP 186 Create specified group .166 Create specified group\. 187 167 .SS "[RAP|RPC] SHARE" 188 189 168 .SS "[RAP|RPC] SHARE [misc. options] [targets]" 190 169 .PP 191 Enumerates all exported resources (network shares) on target server. 192 170 Enumerates all exported resources (network shares) on target server\. 193 171 .SS "[RAP|RPC] SHARE ADD name=serverpath [-C comment] [-M maxusers] [targets]" 194 172 .PP 195 Adds a share from a server (makes the export active). Maxusers specifies the number of users that can be connected to the share simultaneously. 196 197 .SS "SHARE DELETE sharenam" 198 .PP 199 Delete specified share. 173 Adds a share from a server (makes the export active)\. Maxusers specifies the number of users that can be connected to the share simultaneously\. 174 .SS "SHARE DELETE sharename" 175 .PP 176 Delete specified share\. 200 177 .SS "[RPC|RAP] FILE" 201 202 178 .SS "[RPC|RAP] FILE" 203 179 .PP 204 List all open files on remote server. 205 180 List all open files on remote server\. 206 181 .SS "[RPC|RAP] FILE CLOSE fileid" 207 182 .PP 208 183 Close file with specified 209 184 \fIfileid\fR 210 on remote server. 211 185 on remote server\. 212 186 .SS "[RPC|RAP] FILE INFO fileid" 213 187 .PP 214 188 Print information on specified 215 \fIfileid\fR. Currently listed are: file-id, username, locks, path, permissions. 216 217 .SS "[RAP|RPC] FILE USER" 189 \fIfileid\fR\. Currently listed are: file\-id, username, locks, path, permissions\. 190 .SS "[RAP|RPC] FILE USER user" 191 .PP 192 List files opened by specified 193 \fIuser\fR\. Please note that 194 net rap file user 195 does not work against Samba servers\. 196 .SS "SESSION" 197 .SS "RAP SESSION" 198 .PP 199 Without any other options, SESSION enumerates all active SMB/CIFS sessions on the target server\. 200 .SS "RAP SESSION DELETE|CLOSE CLIENT_NAME" 201 .PP 202 Close the specified sessions\. 203 .SS "RAP SESSION INFO CLIENT_NAME" 204 .PP 205 Give a list with all the open files in specified session\. 206 .SS "RAP SERVER \fIDOMAIN\fR" 207 .PP 208 List all servers in specified domain or workgroup\. Defaults to local domain\. 209 .SS "RAP DOMAIN" 210 .PP 211 Lists all domains and workgroups visible on the current network\. 212 .SS "RAP PRINTQ" 213 .SS "RAP PRINTQ LIST QUEUE_NAME" 214 .PP 215 Lists the specified print queue and print jobs on the server\. If the 216 \fIQUEUE_NAME\fR 217 is omitted, all queues are listed\. 218 .SS "RAP PRINTQ DELETE JOBID" 219 .PP 220 Delete job with specified id\. 221 .SS "RAP VALIDATE \fIuser\fR [\fIpassword\fR]" 222 .PP 223 Validate whether the specified user can log in to the remote server\. If the password is not specified on the commandline, it will be prompted\. 218 224 .sp 219 225 .it 1 an-trap … … 221 227 .nr an-break-flag 1 222 228 .br 223 \fBNote\fR 224 .PP 225 Currently NOT implemented. 226 .SS "SESSION" 227 228 .SS "RAP SESSION" 229 .PP 230 Without any other options, SESSION enumerates all active SMB/CIFS sessions on the target server. 231 232 .SS "RAP SESSION DELETE|CLOSE CLIENT_NAME" 233 .PP 234 Close the specified sessions. 235 236 .SS "RAP SESSION INFO CLIENT_NAME" 237 .PP 238 Give a list with all the open files in specified session. 239 .SS "RAP SERVER \fIDOMAIN\fR" 240 .PP 241 List all servers in specified domain or workgroup. Defaults to local domain. 242 .SS "RAP DOMAIN" 243 .PP 244 Lists all domains and workgroups visible on the current network. 245 .SS "RAP PRINTQ" 246 247 .SS "RAP PRINTQ LIST QUEUE_NAME" 248 .PP 249 Lists the specified print queue and print jobs on the server. If the 250 \fIQUEUE_NAME\fR 251 is omitted, all queues are listed. 252 253 .SS "RAP PRINTQ DELETE JOBID" 254 .PP 255 Delete job with specified id. 256 .SS "RAP VALIDATE \fIuser\fR [\fIpassword\fR]" 257 .PP 258 Validate whether the specified user can log in to the remote server. If the password is not specified on the commandline, it will be prompted. 229 Note 230 .PP 231 Currently NOT implemented\. 232 .SS "RAP GROUPMEMBER" 233 .SS "RAP GROUPMEMBER LIST GROUP" 234 .PP 235 List all members of the specified group\. 236 .SS "RAP GROUPMEMBER DELETE GROUP USER" 237 .PP 238 Delete member from group\. 239 .SS "RAP GROUPMEMBER ADD GROUP USER" 240 .PP 241 Add member to group\. 242 .SS "RAP ADMIN \fIcommand\fR" 243 .PP 244 Execute the specified 245 \fIcommand\fR 246 on the remote server\. Only works with OS/2 servers\. 259 247 .sp 260 248 .it 1 an-trap … … 262 250 .nr an-break-flag 1 263 251 .br 264 \fBNote\fR 265 .PP 266 Currently NOT implemented. 267 .SS "RAP GROUPMEMBER" 268 269 .SS "RAP GROUPMEMBER LIST GROUP" 270 .PP 271 List all members of the specified group. 272 273 .SS "RAP GROUPMEMBER DELETE GROUP USER" 274 .PP 275 Delete member from group. 276 277 .SS "RAP GROUPMEMBER ADD GROUP USER" 278 .PP 279 Add member to group. 280 .SS "RAP ADMIN \fIcommand\fR" 281 .PP 282 Execute the specified 283 \fIcommand\fR 284 on the remote server. Only works with OS/2 servers. 252 Note 253 .PP 254 Currently NOT implemented\. 255 .SS "RAP SERVICE" 256 .SS "RAP SERVICE START NAME [arguments...]" 257 .PP 258 Start the specified service on the remote server\. Not implemented yet\. 285 259 .sp 286 260 .it 1 an-trap … … 288 262 .nr an-break-flag 1 289 263 .br 290 \fBNote\fR 291 .PP 292 Currently NOT implemented. 293 .SS "RAP SERVICE" 264 Note 265 .PP 266 Currently NOT implemented\. 294 267 295 .SS "RAP SERVICE ST ART NAME [arguments...]"296 .PP 297 St art the specified service on the remote server. Not implemented yet.268 .SS "RAP SERVICE STOP" 269 .PP 270 Stop the specified service on the remote server\. 298 271 .sp 299 272 .it 1 an-trap … … 301 274 .nr an-break-flag 1 302 275 .br 303 \fBNote\fR 304 .PP 305 Currently NOT implemented. 306 307 .SS "RAP SERVICE STOP" 308 .PP 309 Stop the specified service on the remote server. 310 .sp 311 .it 1 an-trap 312 .nr an-no-space-flag 1 313 .nr an-break-flag 1 314 .br 315 \fBNote\fR 316 .PP 317 Currently NOT implemented. 276 Note 277 .PP 278 Currently NOT implemented\. 318 279 .SS "RAP PASSWORD \fIUSER\fR \fIOLDPASS\fR \fINEWPASS\fR" 319 280 .PP … … 323 284 \fIOLDPASS\fR 324 285 to 325 \fINEWPASS\fR .286 \fINEWPASS\fR\. 326 287 .SS "LOOKUP" 327 328 288 .SS "LOOKUP HOST HOSTNAME [TYPE]" 329 289 .PP 330 Lookup the IP address of the given host with the specified type (netbios suffix). The type defaults to 0x20 (workstation). 331 332 .SS "LOOKUP LDAP [DOMAIN" 290 Lookup the IP address of the given host with the specified type (netbios suffix)\. The type defaults to 0x20 (workstation)\. 291 .SS "LOOKUP LDAP [DOMAIN]" 333 292 .PP 334 293 Give IP address of LDAP server of specified 335 \fIDOMAIN\fR. Defaults to local domain. 336 294 \fIDOMAIN\fR\. Defaults to local domain\. 337 295 .SS "LOOKUP KDC [REALM]" 338 296 .PP 339 297 Give IP address of KDC for the specified 340 \fIREALM\fR. Defaults to local realm. 341 298 \fIREALM\fR\. Defaults to local realm\. 342 299 .SS "LOOKUP DC [DOMAIN]" 343 300 .PP 344 Give IP's of Domain Controllers for specified 345 \fI DOMAIN\fR. Defaults to local domain. 346 301 Give IP\'s of Domain Controllers for specified 302 \fI DOMAIN\fR\. Defaults to local domain\. 347 303 .SS "LOOKUP MASTER DOMAIN" 348 304 .PP 349 305 Give IP of master browser for specified 350 306 \fIDOMAIN\fR 351 or workgroup . Defaults to local domain.307 or workgroup\. Defaults to local domain\. 352 308 .SS "CACHE" 353 309 .PP 354 Samba uses a general caching interface called 'gencache'. It can be controlled using 'NET CACHE'.310 Samba uses a general caching interface called \'gencache\'\. It can be controlled using \'NET CACHE\'\. 355 311 .PP 356 312 All the timeout parameters support the suffixes: 357 .IP "" 3n 358 s - Seconds 359 .IP "" 3n 360 m - Minutes 361 .IP "" 3n 362 h - Hours 363 .IP "" 3n 364 d - Days 365 .IP "" 3n 366 w - Weeks 367 313 .IP "" 4 314 s \- Seconds 315 .IP "" 4 316 m \- Minutes 317 .IP "" 4 318 h \- Hours 319 .IP "" 4 320 d \- Days 321 .IP "" 4 322 w \- Weeks 368 323 369 324 .SS "CACHE ADD key data time-out" 370 325 .PP 371 Add specified key+data to the cache with the given timeout. 372 326 Add specified key+data to the cache with the given timeout\. 373 327 .SS "CACHE DEL key" 374 328 .PP 375 Delete key from the cache. 376 329 Delete key from the cache\. 377 330 .SS "CACHE SET key data time-out" 378 331 .PP 379 Update data of existing cache entry. 380 332 Update data of existing cache entry\. 381 333 .SS "CACHE SEARCH PATTERN" 382 334 .PP 383 Search for the specified pattern in the cache data. 384 335 Search for the specified pattern in the cache data\. 385 336 .SS "CACHE LIST" 386 337 .PP 387 List all current items in the cache. 388 338 List all current items in the cache\. 389 339 .SS "CACHE FLUSH" 390 340 .PP 391 Remove all the current items from the cache .341 Remove all the current items from the cache\. 392 342 .SS "GETLOCALSID [DOMAIN]" 393 343 .PP 394 Print the SID of the specified domain, or if the parameter is omitted, the SID of the domain the local server is in. 395 .SS "SETLOCALSID S-1-5-21-x-y-z" 396 .PP 397 Sets domain sid for the local server to the specified SID. 344 Prints the SID of the specified domain, or if the parameter is omitted, the SID of the local server\. 345 .SS "SETLOCALSID S\-1\-5\-21\-x\-y\-z" 346 .PP 347 Sets SID for the local server to the specified SID\. 348 .SS "GETDOMAINSID" 349 .PP 350 Prints the local machine SID and the SID of the current domain\. 351 .SS "SETDOMAINSID" 352 .PP 353 Sets the SID of the current domain\. 398 354 .SS "GROUPMAP" 399 355 .PP 400 Manage the mappings between Windows group SIDs and UNIX groups. Parameters take the for "parameter=value". Common options include: 401 .TP 3n 402 \(bu 403 unixgroup - Name of the UNIX group 404 .TP 3n 405 \(bu 406 ntgroup - Name of the Windows NT group (must be resolvable to a SID 407 .TP 3n 408 \(bu 409 rid - Unsigned 32-bit integer 410 .TP 3n 411 \(bu 412 sid - Full SID in the form of "S-1-..." 413 .TP 3n 414 \(bu 415 type - Type of the group; either 'domain', 'local', or 'builtin' 416 .TP 3n 417 \(bu 418 comment - Freeform text description of the group 419 356 Manage the mappings between Windows group SIDs and UNIX groups\. Common options include: 357 .sp 358 .RS 4 359 .ie n \{\ 360 \h'-04'\(bu\h'+03'\c 361 .\} 362 .el \{\ 363 .sp -1 364 .IP \(bu 2.3 365 .\} 366 unixgroup \- Name of the UNIX group 367 .RE 368 .sp 369 .RS 4 370 .ie n \{\ 371 \h'-04'\(bu\h'+03'\c 372 .\} 373 .el \{\ 374 .sp -1 375 .IP \(bu 2.3 376 .\} 377 ntgroup \- Name of the Windows NT group (must be resolvable to a SID 378 .RE 379 .sp 380 .RS 4 381 .ie n \{\ 382 \h'-04'\(bu\h'+03'\c 383 .\} 384 .el \{\ 385 .sp -1 386 .IP \(bu 2.3 387 .\} 388 rid \- Unsigned 32\-bit integer 389 .RE 390 .sp 391 .RS 4 392 .ie n \{\ 393 \h'-04'\(bu\h'+03'\c 394 .\} 395 .el \{\ 396 .sp -1 397 .IP \(bu 2.3 398 .\} 399 sid \- Full SID in the form of "S\-1\-\.\.\." 400 .RE 401 .sp 402 .RS 4 403 .ie n \{\ 404 \h'-04'\(bu\h'+03'\c 405 .\} 406 .el \{\ 407 .sp -1 408 .IP \(bu 2.3 409 .\} 410 type \- Type of the group; either \'domain\', \'local\', or \'builtin\' 411 .RE 412 .sp 413 .RS 4 414 .ie n \{\ 415 \h'-04'\(bu\h'+03'\c 416 .\} 417 .el \{\ 418 .sp -1 419 .IP \(bu 2.3 420 .\} 421 comment \- Freeform text description of the group 422 .sp 423 .RE 420 424 .SS "GROUPMAP ADD" 421 425 .PP 422 426 Add a new group mapping entry: 423 424 .sp 425 427 .sp 428 .RS 4 426 429 .nf 427 428 net groupmap add {rid=int|sid=string} unixgroup=string \ 429 [type={domain|local}] [ntgroup=string] [comment=string] 430 430 net groupmap add {rid=int|sid=string} unixgroup=string \e 431 [type={domain|local}] [ntgroup=string] [comment=string] 431 432 .fi 432 433 .RE 434 .sp 433 435 434 436 .SS "GROUPMAP DELETE" 435 437 .PP 436 Delete a group mapping entry . If more then one group name matches, the first entry found is deleted.438 Delete a group mapping entry\. If more than one group name matches, the first entry found is deleted\. 437 439 .PP 438 440 net groupmap delete {ntgroup=string|sid=SID} 441 .SS "GROUPMAP MODIFY" 442 .PP 443 Update en existing group entry\. 444 .PP 439 445 440 .SS "GROUPMAP MODIFY" 441 .PP 442 Update en existing group entry 443 .PP 444 445 446 .sp 447 446 .sp 447 .RS 4 448 448 .nf 449 450 net groupmap modify {ntgroup=string|sid=SID} [unixgroup=string] \ 449 net groupmap modify {ntgroup=string|sid=SID} [unixgroup=string] \e 451 450 [comment=string] [type={domain|local}] 452 453 451 .fi 454 452 .RE 453 .sp 455 454 456 455 .SS "GROUPMAP LIST" 457 456 .PP 458 List existing group mapping entries 457 List existing group mapping entries\. 459 458 .PP 460 459 net groupmap list [verbose] [ntgroup=string] [sid=SID] 461 460 .SS "MAXRID" 462 461 .PP 463 Prints out the highest RID currently in use on the local server (by the active 'passdb backend').462 Prints out the highest RID currently in use on the local server (by the active \'passdb backend\')\. 464 463 .SS "RPC INFO" 465 464 .PP 466 Print information about the domain of the remote server, such as domain name, domain sid and number of users and groups .465 Print information about the domain of the remote server, such as domain name, domain sid and number of users and groups\. 467 466 .SS "[RPC|ADS] TESTJOIN" 468 467 .PP 469 Check whether participation in a domain is still valid .468 Check whether participation in a domain is still valid\. 470 469 .SS "[RPC|ADS] CHANGETRUSTPW" 471 470 .PP 472 Force change of domain trust password .471 Force change of domain trust password\. 473 472 .SS "RPC TRUSTDOM" 474 475 473 .SS "RPC TRUSTDOM ADD DOMAIN" 476 474 .PP 477 475 Add a interdomain trust account for 478 \fIDOMAIN\fR 479 to the remote server. 480 481 .SS "RPC TRUSTDOM DEL DOMAIM" 476 \fIDOMAIN\fR\. This is in fact a Samba account named 477 \fIDOMAIN$\fR 478 with the account flag 479 \fB\'I\'\fR 480 (interdomain trust account)\. If the command is used against localhost it has the same effect as 481 smbpasswd \-a \-i DOMAIN\. Please note that both commands expect a appropriate UNIX account\. 482 .SS "RPC TRUSTDOM DEL DOMAIN" 482 483 .PP 483 484 Remove interdomain trust account for 484 \fIDOMAIN\fR 485 from the remote server. 486 .sp 487 .it 1 an-trap 488 .nr an-no-space-flag 1 489 .nr an-break-flag 1 490 .br 491 \fBNote\fR 492 .PP 493 Currently NOT implemented. 494 485 \fIDOMAIN\fR\. If it is used against localhost it has the same effect as 486 smbpasswd \-x DOMAIN$\. 495 487 .SS "RPC TRUSTDOM ESTABLISH DOMAIN" 496 488 .PP 497 Establish a trust relationship to a trusting domain. Interdomain account must already be created on the remote PDC. 498 489 Establish a trust relationship to a trusting domain\. Interdomain account must already be created on the remote PDC\. 499 490 .SS "RPC TRUSTDOM REVOKE DOMAIN" 500 491 .PP 501 492 Abandon relationship to trusted domain 502 503 493 .SS "RPC TRUSTDOM LIST" 504 494 .PP 505 List all current interdomain trust relationships. 506 495 List all current interdomain trust relationships\. 507 496 .SS "RPC RIGHTS" 508 497 .PP 509 This subcommand is used to view and manage Samba 's rights assignments (also referred to as privileges). There are three options currentavailable:498 This subcommand is used to view and manage Samba\'s rights assignments (also referred to as privileges)\. There are three options currently available: 510 499 \fIlist\fR, 511 500 \fIgrant\fR, and 512 \fIrevoke\fR . More details on Samba's privilege model and its use can be found in the Samba-HOWTO-Collection.501 \fIrevoke\fR\. More details on Samba\'s privilege model and its use can be found in the Samba\-HOWTO\-Collection\. 513 502 .SS "RPC ABORTSHUTDOWN" 514 503 .PP 515 Abort the shutdown of a remote server. 516 .SS "RPC SHUTDOWN [-t timeout] [-r] [-f] [-C message]" 517 .PP 518 Shut down the remote server. 519 .PP 520 -r 521 .RS 3n 522 Reboot after shutdown. 523 .RE 524 .PP 525 -f 526 .RS 3n 527 Force shutting down all applications. 528 .RE 529 .PP 530 -t timeout 531 .RS 3n 532 Timeout before system will be shut down. An interactive user of the system can use this time to cancel the shutdown. 533 .RE 534 '> 535 536 .PP 537 -C message 538 .RS 3n 539 Display the specified message on the screen to announce the shutdown. 504 Abort the shutdown of a remote server\. 505 .SS "RPC SHUTDOWN [\-t timeout] [\-r] [\-f] [\-C message]" 506 .PP 507 Shut down the remote server\. 508 .PP 509 \-r 510 .RS 4 511 Reboot after shutdown\. 512 .RE 513 .PP 514 \-f 515 .RS 4 516 Force shutting down all applications\. 517 .RE 518 .PP 519 \-t timeout 520 .RS 4 521 Timeout before system will be shut down\. An interactive user of the system can use this time to cancel the shutdown\. 522 .RE 523 \'> 524 .PP 525 \-C message 526 .RS 4 527 Display the specified message on the screen to announce the shutdown\. 540 528 .RE 541 529 .SS "RPC SAMDUMP" 542 530 .PP 543 Print out sam database of remote server . You need to run this against the PDC, from a Samba machine joined as a BDC.531 Print out sam database of remote server\. You need to run this against the PDC, from a Samba machine joined as a BDC\. 544 532 .SS "RPC VAMPIRE" 545 533 .PP 546 Export users, aliases and groups from remote server to local server . You need to run this against the PDC, from a Samba machine joined as a BDC.534 Export users, aliases and groups from remote server to local server\. You need to run this against the PDC, from a Samba machine joined as a BDC\. 547 535 .SS "RPC GETSID" 548 536 .PP 549 537 Fetch domain SID and store it in the local 550 \fIsecrets .tdb\fR.538 \fIsecrets\.tdb\fR\. 551 539 .SS "ADS LEAVE" 552 540 .PP 553 Make the remote host leave the domain it is part of .541 Make the remote host leave the domain it is part of\. 554 542 .SS "ADS STATUS" 555 543 .PP 556 Print out status of machine account of the local machine in ADS . Prints out quite some debug info. Aimed at developers, regular users should use557 NET ADS TESTJOIN .544 Print out status of machine account of the local machine in ADS\. Prints out quite some debug info\. Aimed at developers, regular users should use 545 NET ADS TESTJOIN\. 558 546 .SS "ADS PRINTER" 559 560 547 .SS "ADS PRINTER INFO [PRINTER] [SERVER]" 561 548 .PP … … 563 550 \fIPRINTER\fR 564 551 on 565 \fISERVER\fR. The printer name defaults to "*", the server name defaults to the local host. 566 552 \fISERVER\fR\. The printer name defaults to "*", the server name defaults to the local host\. 567 553 .SS "ADS PRINTER PUBLISH PRINTER" 568 554 .PP 569 Publish specified printer using ADS. 570 555 Publish specified printer using ADS\. 571 556 .SS "ADS PRINTER REMOVE PRINTER" 572 557 .PP 573 Remove specified printer from ADS directory .574 .SS "ADS SEARCH \fIEXPRESSION\fR \fIATTRIBUTES ...\fR"575 .PP 576 Perform a raw LDAP search on a ADS server and dump the results . The expression is a standard LDAP search expression, and the attributes are a list of LDAP fields to show in the results.558 Remove specified printer from ADS directory\. 559 .SS "ADS SEARCH \fIEXPRESSION\fR \fIATTRIBUTES\.\.\.\fR" 560 .PP 561 Perform a raw LDAP search on a ADS server and dump the results\. The expression is a standard LDAP search expression, and the attributes are a list of LDAP fields to show in the results\. 577 562 .PP 578 563 Example: 579 \fBnet ads search '(objectCategory=group)' sAMAccountName\fR564 \fBnet ads search \'(objectCategory=group)\' sAMAccountName\fR 580 565 .SS "ADS DN \fIDN\fR \fI(attributes)\fR" 581 566 .PP 582 Perform a raw LDAP search on a ADS server and dump the results . The DN standard LDAP DN, and the attributes are a list of LDAP fields to show in the result.567 Perform a raw LDAP search on a ADS server and dump the results\. The DN standard LDAP DN, and the attributes are a list of LDAP fields to show in the result\. 583 568 .PP 584 569 Example: 585 \fBnet ads dn 'CN=administrator,CN=Users,DC=my,DC=domain' SAMAccountName\fR570 \fBnet ads dn \'CN=administrator,CN=Users,DC=my,DC=domain\' SAMAccountName\fR 586 571 .SS "ADS WORKGROUP" 587 572 .PP 588 Print out workgroup name for specified kerberos realm .573 Print out workgroup name for specified kerberos realm\. 589 574 .SS "SAM CREATEBUILTINGROUP <NAME>" 590 575 .PP 591 (Re)Create a BUILTIN group . Only a wellknown set of BUILTIN groups can be created with this command. This is the list of currently recognized group names: Administrators, Users, Guests, Power Users, Account Operators, Server Operators, Print Operators, Backup Operators, Replicator, RAS Servers, Pre-Windows 2000 ompatible Access. This command requires a running Winbindd with idmap allocation properly configured. The group gid will be allocated out of the winbindd range.576 (Re)Create a BUILTIN group\. Only a wellknown set of BUILTIN groups can be created with this command\. This is the list of currently recognized group names: Administrators, Users, Guests, Power Users, Account Operators, Server Operators, Print Operators, Backup Operators, Replicator, RAS Servers, Pre\-Windows 2000 compatible Access\. This command requires a running Winbindd with idmap allocation properly configured\. The group gid will be allocated out of the winbindd range\. 592 577 .SS "SAM CREATELOCALGROUP <NAME>" 593 578 .PP 594 Create a LOCAL group (also known as Alias) . This command requires a running Winbindd with idmap allocation properly configured. The group gid will be allocated out of the winbindd range.579 Create a LOCAL group (also known as Alias)\. This command requires a running Winbindd with idmap allocation properly configured\. The group gid will be allocated out of the winbindd range\. 595 580 .SS "SAM DELETELOCALGROUP <NAME>" 596 581 .PP 597 Delete an existing LOCAL group (also known as Alias) .582 Delete an existing LOCAL group (also known as Alias)\. 598 583 .SS "SAM MAPUNIXGROUP <NAME>" 599 584 .PP 600 Map an existing Unix group and make it a Domain Group, the domain group will have the same name .585 Map an existing Unix group and make it a Domain Group, the domain group will have the same name\. 601 586 .SS "SAM UNMAPUNIXGROUP <NAME>" 602 587 .PP 603 Remove an existing group mapping entry .588 Remove an existing group mapping entry\. 604 589 .SS "SAM ADDMEM <GROUP> <MEMBER>" 605 590 .PP 606 Add a member to a Local group . The group can be specified only by name, the member can be specified by name or SID.591 Add a member to a Local group\. The group can be specified only by name, the member can be specified by name or SID\. 607 592 .SS "SAM DELMEM <GROUP> <MEMBER>" 608 593 .PP 609 Remove a member from a Local group . The group and the member must be specified by name.594 Remove a member from a Local group\. The group and the member must be specified by name\. 610 595 .SS "SAM LISTMEM <GROUP>" 611 596 .PP 612 List Local group members . The group must be specified by name.597 List Local group members\. The group must be specified by name\. 613 598 .SS "SAM LIST <users|groups|localgroups|builtin|workstations> [verbose]" 614 599 .PP 615 List the specified set of accounts by name . If verbose is specified, the rid and description is also provided for each account.600 List the specified set of accounts by name\. If verbose is specified, the rid and description is also provided for each account\. 616 601 .SS "SAM SHOW <NAME>" 617 602 .PP 618 Show the full DOMAIN\ \NAME the SID and the type for the corrisponding account.603 Show the full DOMAIN\e\eNAME the SID and the type for the corresponding account\. 619 604 .SS "SAM SET HOMEDIR <NAME> <DIRECTORY>" 620 605 .PP 621 Set the home directory for a user account .606 Set the home directory for a user account\. 622 607 .SS "SAM SET PROFILEPATH <NAME> <PATH>" 623 608 .PP 624 Set the profile path for a user account .609 Set the profile path for a user account\. 625 610 .SS "SAM SET COMMENT <NAME> <COMMENT>" 626 611 .PP 627 Set the comment for a user or group account .612 Set the comment for a user or group account\. 628 613 .SS "SAM SET FULLNAME <NAME> <FULL NAME>" 629 614 .PP 630 Set the full name for a user account .615 Set the full name for a user account\. 631 616 .SS "SAM SET LOGONSCRIPT <NAME> <SCRIPT>" 632 617 .PP 633 Set the logon script for a user account .618 Set the logon script for a user account\. 634 619 .SS "SAM SET HOMEDRIVE <NAME> <DRIVE>" 635 620 .PP 636 Set the home drive for a user account .621 Set the home drive for a user account\. 637 622 .SS "SAM SET WORKSTATIONS <NAME> <WORKSTATIONS>" 638 623 .PP 639 Set the workstations a user account is allowed to log in from .624 Set the workstations a user account is allowed to log in from\. 640 625 .SS "SAM SET DISABLE <NAME>" 641 626 .PP 642 Set the "disabled" flag for a user account .627 Set the "disabled" flag for a user account\. 643 628 .SS "SAM SET PWNOTREQ <NAME>" 644 629 .PP 645 Set the "password not required" flag for a user account .630 Set the "password not required" flag for a user account\. 646 631 .SS "SAM SET AUTOLOCK <NAME>" 647 632 .PP 648 Set the "autolock" flag for a user account .633 Set the "autolock" flag for a user account\. 649 634 .SS "SAM SET PWNOEXP <NAME>" 650 635 .PP 651 Set the "password do not expire" flag for a user account .652 .SS "SAM SET PW MUSTCHANGENOW <NAME> [yes|no]"653 .PP 654 Set or unset the "password must change" flag f ro a user account.636 Set the "password do not expire" flag for a user account\. 637 .SS "SAM SET PWDMUSTCHANGENOW <NAME> [yes|no]" 638 .PP 639 Set or unset the "password must change" flag for a user account\. 655 640 .SS "SAM POLICY LIST" 656 641 .PP 657 List the av ilable account policies.642 List the available account policies\. 658 643 .SS "SAM POLICY SHOW <account policy>" 659 644 .PP 660 Show the account policy value .645 Show the account policy value\. 661 646 .SS "SAM POLICY SET <account policy> <value>" 662 647 .PP 663 Set a value for the account policy . Valid values can be: "forever", "never", "off", or a number.648 Set a value for the account policy\. Valid values can be: "forever", "never", "off", or a number\. 664 649 .SS "SAM PROVISION" 665 650 .PP 666 Only available if ldapsam:editposix is set and winbindd is running . Properly populates the ldap tree with the basic accounts (Administrator) and groups (Domain Users, Domain Admins, Domain Guests) on the ldap tree.667 .SS "IDMAP DUMP < output file>"668 .PP 669 Dumps the mappings in the specified output file.651 Only available if ldapsam:editposix is set and winbindd is running\. Properly populates the ldap tree with the basic accounts (Administrator) and groups (Domain Users, Domain Admins, Domain Guests) on the ldap tree\. 652 .SS "IDMAP DUMP <local tdb file name>" 653 .PP 654 Dumps the mappings contained in the local tdb file specified\. This command is useful to dump only the mappings produced by the idmap_tdb backend\. 670 655 .SS "IDMAP RESTORE [input file]" 671 656 .PP 672 Restore the mappings from the specified file or stdin .657 Restore the mappings from the specified file or stdin\. 673 658 .SS "IDMAP SECRET <DOMAIN>|ALLOC <secret>" 674 659 .PP 675 Store a secret for the s epcified domain, used primarily for domains that use idmap_ldap as a backend. In this case the secret is used as the password for the user DN used to bind to the ldap server.660 Store a secret for the specified domain, used primarily for domains that use idmap_ldap as a backend\. In this case the secret is used as the password for the user DN used to bind to the ldap server\. 676 661 .SS "USERSHARE" 677 662 .PP 678 Starting with version 3 .0.23, a Samba server now supports the ability for non-root users to add user define shares to be exported using the "net usershare" commands.679 .PP 680 To set this up, first set up your smb .conf by adding to the [global] section : usershare path = /usr/local/samba/lib/usershares Next create the directory /usr/local/samba/lib/usershares, change the owner to root and set the group owner to the UNIX group who should have the ability to create usershares, for example a group called "serverops". Set the permissions on /usr/local/samba/lib/usershares to 01770. (Owner and group all access, no access for others, plus the sticky bit, which means that a file in that directory can be renamed or deleted only by the owner of the file). Finally, tell smbd how many usershares you will allow by adding to the [global] section of smb.conf a line such as : usershare max shares = 100. To allow 100 usershare definitions. Now, members of the UNIX group "serverops" can create user defined shares on demand using the commands below.663 Starting with version 3\.0\.23, a Samba server now supports the ability for non\-root users to add user defined shares to be exported using the "net usershare" commands\. 664 .PP 665 To set this up, first set up your smb\.conf by adding to the [global] section: usershare path = /usr/local/samba/lib/usershares Next create the directory /usr/local/samba/lib/usershares, change the owner to root and set the group owner to the UNIX group who should have the ability to create usershares, for example a group called "serverops"\. Set the permissions on /usr/local/samba/lib/usershares to 01770\. (Owner and group all access, no access for others, plus the sticky bit, which means that a file in that directory can be renamed or deleted only by the owner of the file)\. Finally, tell smbd how many usershares you will allow by adding to the [global] section of smb\.conf a line such as : usershare max shares = 100\. To allow 100 usershare definitions\. Now, members of the UNIX group "serverops" can create user defined shares on demand using the commands below\. 681 666 .PP 682 667 The usershare commands are: 683 .IP "" 3n 684 net usershare add sharename path [comment] [acl] [guest_ok=[y|n]] - to add or change a user defined share. 685 .IP "" 3n 686 net usershare delete sharename - to delete a user defined share. 687 .IP "" 3n 688 net usershare info [-l|--long] [wildcard sharename] - to print info about a user defined share. 689 .IP "" 3n 690 net usershare list [-l|--long] [wildcard sharename] - to list user defined shares. 691 668 .IP "" 4 669 net usershare add sharename path [comment] [acl] [guest_ok=[y|n]] \- to add or change a user defined share\. 670 .IP "" 4 671 net usershare delete sharename \- to delete a user defined share\. 672 .IP "" 4 673 net usershare info [\-l|\-\-long] [wildcard sharename] \- to print info about a user defined share\. 674 .IP "" 4 675 net usershare list [\-l|\-\-long] [wildcard sharename] \- to list user defined shares\. 692 676 693 677 .SS "USERSHARE ADD sharename path [comment] [acl] [guest_ok=[y|n]]" 694 678 .PP 695 Add or replace a new user defined share, with name "sharename" .696 .PP 697 "path" specifies the absolute pathname on the system to be exported . Restrictions may be put on this, see the global smb.conf parameters : "usershare owner only", "usershare prefix allow list", and "usershare prefix deny list".698 .PP 699 The optional "comment" parameter is the comment that will appear on the share when browsed to by a client .700 .PP 701 The optional "acl" field specifies which users have read and write access to the entire share . Note that guest connections are not allowed unless the smb.conf parameter "usershare allow guests" has been set. The definition of a user defined share acl is : "user:permission", where user is a valid username on the system and permission can be "F", "R", or "D". "F" stands for "full permissions", ie. read and write permissions. "D" stands for "deny" for a user, ie. prevent this user from accessing this share. "R" stands for "read only", ie. only allow read access to this share (no creation of new files or directories or writing to files).702 .PP 703 The default if no "acl" is given is "Everyone:R", which means any authenticated user has read -only access.704 .PP 705 The optional "guest_ok" has the same effect as the parameter of the same name in smb .conf, in that it allows guest access to this user defined share. This parameter is only allowed if the global parameter "usershare allow guests" has been set to true in the smb.conf.679 Add or replace a new user defined share, with name "sharename"\. 680 .PP 681 "path" specifies the absolute pathname on the system to be exported\. Restrictions may be put on this, see the global smb\.conf parameters: "usershare owner only", "usershare prefix allow list", and "usershare prefix deny list"\. 682 .PP 683 The optional "comment" parameter is the comment that will appear on the share when browsed to by a client\. 684 .PP 685 The optional "acl" field specifies which users have read and write access to the entire share\. Note that guest connections are not allowed unless the smb\.conf parameter "usershare allow guests" has been set\. The definition of a user defined share acl is: "user:permission", where user is a valid username on the system and permission can be "F", "R", or "D"\. "F" stands for "full permissions", ie\. read and write permissions\. "D" stands for "deny" for a user, ie\. prevent this user from accessing this share\. "R" stands for "read only", ie\. only allow read access to this share (no creation of new files or directories or writing to files)\. 686 .PP 687 The default if no "acl" is given is "Everyone:R", which means any authenticated user has read\-only access\. 688 .PP 689 The optional "guest_ok" has the same effect as the parameter of the same name in smb\.conf, in that it allows guest access to this user defined share\. This parameter is only allowed if the global parameter "usershare allow guests" has been set to true in the smb\.conf\. 706 690 707 691 … … 709 693 just use the "net usershare add [sharename]" command using the same 710 694 sharename as the one you wish to modify and specify the new options 711 you wish . The Samba smbd daemon notices user defined share modifications695 you wish\. The Samba smbd daemon notices user defined share modifications 712 696 at connect time so will see the change immediately, there is no need 713 to restart smbd on adding, deleting or changing a user defined share. 714 697 to restart smbd on adding, deleting or changing a user defined share\. 715 698 .SS "USERSHARE DELETE sharename" 716 699 .PP 717 Deletes the user defined share by name. The Samba smbd daemon immediately notices this change, although it will not disconnect any users currently connected to the deleted share. 718 700 Deletes the user defined share by name\. The Samba smbd daemon immediately notices this change, although it will not disconnect any users currently connected to the deleted share\. 719 701 .SS "USERSHARE INFO [-l|--long] [wildcard sharename]" 720 702 .PP 721 Get info on user defined shares owned by the current user matching the given pattern, or all users. 722 .PP 723 net usershare info on its own dumps out info on the user defined shares that were created by the current user, or restricts them to share names that match the given wildcard pattern ('*' matches one or more characters, '?' matches only one character). If the '-l' or '--long' option is also given, it prints out info on user defined shares created by other users. 724 .PP 725 The information given about a share looks like : [foobar] path=/home/jeremy comment=testme usershare_acl=Everyone:F guest_ok=n And is a list of the current settings of the user defined share that can be modified by the "net usershare add" command. 726 703 Get info on user defined shares owned by the current user matching the given pattern, or all users\. 704 .PP 705 net usershare info on its own dumps out info on the user defined shares that were created by the current user, or restricts them to share names that match the given wildcard pattern (\'*\' matches one or more characters, \'?\' matches only one character)\. If the \'\-l\' or \'\-\-long\' option is also given, it prints out info on user defined shares created by other users\. 706 .PP 707 The information given about a share looks like: [foobar] path=/home/jeremy comment=testme usershare_acl=Everyone:F guest_ok=n And is a list of the current settings of the user defined share that can be modified by the "net usershare add" command\. 727 708 .SS "USERSHARE LIST [-l|--long] wildcard sharename" 728 709 .PP 729 List all the user defined shares owned by the current user matching the given pattern, or all users .730 .PP 731 net usershare list on its own list out the names of the user defined shares that were created by the current user, or restricts the list to share names that match the given wildcard pattern ( '*' matches one or more characters, '?' matches only one character). If the '-l' or '--long' option is also given, it includes the names of user defined shares created by other users.710 List all the user defined shares owned by the current user matching the given pattern, or all users\. 711 .PP 712 net usershare list on its own list out the names of the user defined shares that were created by the current user, or restricts the list to share names that match the given wildcard pattern (\'*\' matches one or more characters, \'?\' matches only one character)\. If the \'\-l\' or \'\-\-long\' option is also given, it includes the names of user defined shares created by other users\. 732 713 .SS "HELP [COMMAND]" 733 714 .PP 734 Gives usage information for the specified command .715 Gives usage information for the specified command\. 735 716 .SH "VERSION" 736 717 .PP 737 This man page is complete for version 3 .0 of the Samba suite.718 This man page is complete for version 3\.0 of the Samba suite\. 738 719 .SH "AUTHOR" 739 720 .PP 740 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 741 .PP 742 The net manpage was written by Jelmer Vernooij. 743 721 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 722 .PP 723 The net manpage was written by Jelmer Vernooij\. -
branches/samba-3.0/docs/manpages/nmbd.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "NMBD" 8 "" "" "" 1 .\" Title: nmbd 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "NMBD" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 nmbd - NetBIOS name server to provide NetBIOS over IP naming services to clients 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 nmbd [ -D] [-F] [-S] [-a] [-i] [-o] [-h] [-V] [-d <debug level>] [-H <lmhosts file>] [-l <log directory>] [-p <port number>] [-s <configurationfile>]17 nmbd [\-D] [\-F] [\-S] [\-a] [\-i] [\-o] [\-h] [\-V] [\-d\ <debug\ level>] [\-H\ <lmhosts\ file>] [\-l\ <log\ directory>] [\-p\ <port\ number>] [\-s\ <configuration\ file>] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This program is part of the 29 21 \fBsamba\fR(7) 30 suite .31 .PP 32 nmbd 33 is a server that understands and can reply to NetBIOS over IP name service requests, like those produced by SMB/CIFS clients such as Windows 95/98/ME, Windows NT, Windows 2000, Windows XP and LanManager clients . It also participates in the browsing protocols which make up the Windows "Network Neighborhood" view.34 .PP 35 SMB/CIFS clients, when they start up, may wish to locate an SMB/CIFS server . That is, they wish to know what IP number a specified host is using.22 suite\. 23 .PP 24 nmbd 25 is a server that understands and can reply to NetBIOS over IP name service requests, like those produced by SMB/CIFS clients such as Windows 95/98/ME, Windows NT, Windows 2000, Windows XP and LanManager clients\. It also participates in the browsing protocols which make up the Windows "Network Neighborhood" view\. 26 .PP 27 SMB/CIFS clients, when they start up, may wish to locate an SMB/CIFS server\. That is, they wish to know what IP number a specified host is using\. 36 28 .PP 37 29 Amongst other services, 38 30 nmbd 39 will listen for such requests, and if its own NetBIOS name is specified it will respond with the IP number of the host it is running on. Its "own NetBIOS name" is by default the primary DNS name of the host it is running on, but this can be overridden by the 40 netbios name in 41 \fIsmb.conf\fR. Thus 42 nmbd 43 will reply to broadcast queries for its own name(s). Additional names for 31 will listen for such requests, and if its own NetBIOS name is specified it will respond with the IP number of the host it is running on\. Its "own NetBIOS name" is by default the primary DNS name of the host it is running on, but this can be overridden by the 32 \fInetbios name\fR 33 in 34 \fIsmb\.conf\fR\. Thus 35 nmbd 36 will reply to broadcast queries for its own name(s)\. Additional names for 44 37 nmbd 45 38 to respond on can be set via parameters in the 46 39 \fBsmb.conf\fR(5) 47 configuration file .48 .PP 49 nmbd 50 can also be used as a WINS (Windows Internet Name Server) server . What this basically means is that it will act as a WINS database server, creating a database from name registration requests that it receives and replying to queries from clients for these names.40 configuration file\. 41 .PP 42 nmbd 43 can also be used as a WINS (Windows Internet Name Server) server\. What this basically means is that it will act as a WINS database server, creating a database from name registration requests that it receives and replying to queries from clients for these names\. 51 44 .PP 52 45 In addition, 53 46 nmbd 54 can act as a WINS proxy, relaying broadcast queries from clients that do not understand how to talk the WINS protocol to a WINS server .47 can act as a WINS proxy, relaying broadcast queries from clients that do not understand how to talk the WINS protocol to a WINS server\. 55 48 .SH "OPTIONS" 56 49 .PP 57 -D58 .RS 3n50 \-D 51 .RS 4 59 52 If specified, this parameter causes 60 53 nmbd 61 to operate as a daemon . That is, it detaches itself and runs in the background, fielding requests on the appropriate port. By default,62 nmbd 63 will operate as a daemon if launched from a command shell . nmbd can also be operated from the54 to operate as a daemon\. That is, it detaches itself and runs in the background, fielding requests on the appropriate port\. By default, 55 nmbd 56 will operate as a daemon if launched from a command shell\. nmbd can also be operated from the 64 57 inetd 65 meta -daemon, although this is not recommended.66 .RE 67 .PP 68 -F69 .RS 3n58 meta\-daemon, although this is not recommended\. 59 .RE 60 .PP 61 \-F 62 .RS 4 70 63 If specified, this parameter causes the main 71 64 nmbd 72 process to not daemonize, i .e. double-fork and disassociate with the terminal. Child processes are still created as normal to service each connection request, but the main process does not exit. This operation mode is suitable for running65 process to not daemonize, i\.e\. double\-fork and disassociate with the terminal\. Child processes are still created as normal to service each connection request, but the main process does not exit\. This operation mode is suitable for running 73 66 nmbd 74 67 under process supervisors such as … … 76 69 and 77 70 svscan 78 from Daniel J . Bernstein's71 from Daniel J\. Bernstein\'s 79 72 daemontools 80 package, or the AIX process monitor .81 .RE 82 .PP 83 -S84 .RS 3n73 package, or the AIX process monitor\. 74 .RE 75 .PP 76 \-S 77 .RS 4 85 78 If specified, this parameter causes 86 79 nmbd 87 to log to standard output rather than a file .88 .RE 89 .PP 90 -i91 .RS 3n92 If this parameter is specified it causes the server to run "interactively", not as a daemon, even if the server is executed on the command line of a shell . Setting this parameter negates the implicit daemon mode when run from the command line.80 to log to standard output rather than a file\. 81 .RE 82 .PP 83 \-i 84 .RS 4 85 If this parameter is specified it causes the server to run "interactively", not as a daemon, even if the server is executed on the command line of a shell\. Setting this parameter negates the implicit daemon mode when run from the command line\. 93 86 nmbd 94 87 also logs to standard output, as if the 95 \fB-S\fR 96 parameter had been given. 97 .RE 98 .PP 99 -h|--help 100 .RS 3n 101 Print a summary of command line options. 102 .RE 103 .PP 104 -H <filename> 105 .RS 3n 106 NetBIOS lmhosts file. The lmhosts file is a list of NetBIOS names to IP addresses that is loaded by the nmbd server and used via the name resolution mechanism 107 name resolve order described in 108 \fBsmb.conf\fR(5) 109 to resolve any NetBIOS name queries needed by the server. Note that the contents of this file are 110 \fBNOT\fR 88 \fB\-S\fR 89 parameter had been given\. 90 .RE 91 .PP 92 \-h|\-\-help 93 .RS 4 94 Print a summary of command line options\. 95 .RE 96 .PP 97 \-H <filename> 98 .RS 4 99 NetBIOS lmhosts file\. The lmhosts file is a list of NetBIOS names to IP addresses that is loaded by the nmbd server and used via the name resolution mechanism 100 \fIname resolve order\fR 101 described in 102 \fBsmb.conf\fR(5) 103 to resolve any NetBIOS name queries needed by the server\. Note that the contents of this file are 104 \fINOT\fR 111 105 used by 112 106 nmbd 113 to answer any name queries . Adding a line to this file affects name NetBIOS resolution from this host114 \f BONLY\fR.115 .sp 116 The default path to this file is compiled into Samba as part of the build process . Common defaults are107 to answer any name queries\. Adding a line to this file affects name NetBIOS resolution from this host 108 \fIONLY\fR\. 109 .sp 110 The default path to this file is compiled into Samba as part of the build process\. Common defaults are 117 111 \fI/usr/local/samba/lib/lmhosts\fR, 118 112 \fI/usr/samba/lib/lmhosts\fR 119 113 or 120 \fI/etc/samba/lmhosts\fR . See the114 \fI/etc/samba/lmhosts\fR\. See the 121 115 \fBlmhosts\fR(5) 122 man page for details on the contents of this file. 123 .RE 124 .PP 125 -V 126 .RS 3n 127 Prints the program version number. 128 .RE 129 .PP 130 -s <configuration file> 131 .RS 3n 132 The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See 133 \fIsmb.conf\fR 134 for more information. The default configuration file name is determined at compile time. 135 .RE 136 .PP 137 -d|--debuglevel=level 138 .RS 3n 116 man page for details on the contents of this file\. 117 .RE 118 .PP 119 \-d|\-\-debuglevel=level 120 .RS 4 139 121 \fIlevel\fR 140 is an integer from 0 to 10 . The default value if this parameter is not specified is zero.141 .sp 142 The higher this value, the more detail will be logged to the log files about the activities of the server . At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out.143 .sp 144 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem . Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic.122 is an integer from 0 to 10\. The default value if this parameter is not specified is 0\. 123 .sp 124 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 125 .sp 126 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 145 127 .sp 146 128 Note that specifying this parameter here will override the 147 129 \fIlog level\fR 148 130 parameter in the 149 \fIsmb.conf\fR 150 file. 151 .RE 152 .PP 153 -l|--logfile=logdirectory 154 .RS 3n 155 Base directory name for log/debug files. The extension 156 \fB".progname"\fR 157 will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client. 158 .RE 159 .PP 160 -p <UDP port number> 161 .RS 3n 162 UDP port number is a positive integer value. This option changes the default UDP port number (normally 137) that 163 nmbd 164 responds to name queries on. Don't use this option unless you are an expert, in which case you won't need help! 131 \fIsmb\.conf\fR 132 file\. 133 .RE 134 .PP 135 \-V 136 .RS 4 137 Prints the program version number\. 138 .RE 139 .PP 140 \-s <configuration file> 141 .RS 4 142 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 143 \fIsmb\.conf\fR 144 for more information\. The default configuration file name is determined at compile time\. 145 .RE 146 .PP 147 \-l|\-\-log\-basename=logdirectory 148 .RS 4 149 Base directory name for log/debug files\. The extension 150 \fB"\.progname"\fR 151 will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\. 152 .RE 153 .PP 154 \-p <UDP port number> 155 .RS 4 156 UDP port number is a positive integer value\. This option changes the default UDP port number (normally 137) that 157 nmbd 158 responds to name queries on\. Don\'t use this option unless you are an expert, in which case you won\'t need help! 165 159 .RE 166 160 .SH "FILES" 167 161 .PP 168 \fI/etc/inetd .conf\fR169 .RS 3n162 \fI/etc/inetd\.conf\fR 163 .RS 4 170 164 If the server is to be run by the 171 165 inetd 172 meta -daemon, this file must contain suitable startup information for the meta-daemon.166 meta\-daemon, this file must contain suitable startup information for the meta\-daemon\. 173 167 .RE 174 168 .PP 175 169 \fI/etc/rc\fR 176 .RS 3n177 or whatever initialization script your system uses) .178 .sp 179 If running the server as a daemon at startup, this file will need to contain an appropriate startup sequence for the server .170 .RS 4 171 or whatever initialization script your system uses)\. 172 .sp 173 If running the server as a daemon at startup, this file will need to contain an appropriate startup sequence for the server\. 180 174 .RE 181 175 .PP 182 176 \fI/etc/services\fR 183 .RS 3n184 If running the server via the meta -daemon185 inetd, this file must contain a mapping of service name (e .g., netbios-ssn) to service port (e.g., 139) and protocol type (e.g., tcp).186 .RE 187 .PP 188 \fI/usr/local/samba/lib/smb .conf\fR189 .RS 3n177 .RS 4 178 If running the server via the meta\-daemon 179 inetd, this file must contain a mapping of service name (e\.g\., netbios\-ssn) to service port (e\.g\., 139) and protocol type (e\.g\., tcp)\. 180 .RE 181 .PP 182 \fI/usr/local/samba/lib/smb\.conf\fR 183 .RS 4 190 184 This is the default location of the 191 185 \fBsmb.conf\fR(5) 192 server configuration file . Other common places that systems install this file are193 \fI/usr/samba/lib/smb .conf\fR186 server configuration file\. Other common places that systems install this file are 187 \fI/usr/samba/lib/smb\.conf\fR 194 188 and 195 \fI/etc/samba/smb .conf\fR.189 \fI/etc/samba/smb\.conf\fR\. 196 190 .sp 197 191 When run as a WINS server (see the 198 wins support parameter in the 192 \fIwins support\fR 193 parameter in the 199 194 \fBsmb.conf\fR(5) 200 195 man page), 201 196 nmbd 202 197 will store the WINS database in the file 203 \fIwins .dat\fR198 \fIwins\.dat\fR 204 199 in the 205 200 \fIvar/locks\fR 206 directory configured under wherever Samba was configured to install itself .201 directory configured under wherever Samba was configured to install itself\. 207 202 .sp 208 203 If 209 204 nmbd 210 205 is acting as a 211 \f Bbrowse master\fR206 \fI browse master\fR 212 207 (see the 213 local master parameter in the 208 \fIlocal master\fR 209 parameter in the 214 210 \fBsmb.conf\fR(5) 215 211 man page, 216 212 nmbd 217 213 will store the browsing database in the file 218 \fIbrowse .dat \fR214 \fIbrowse\.dat \fR 219 215 in the 220 216 \fIvar/locks\fR 221 directory configured under wherever Samba was configured to install itself .217 directory configured under wherever Samba was configured to install itself\. 222 218 .RE 223 219 .SH "SIGNALS" … … 225 221 To shut down an 226 222 nmbd 227 process it is recommended that SIGKILL ( -9)228 \f BNOT\fR229 be used, except as a last resort, as this may leave the name database in an inconsistent state . The correct way to terminate230 nmbd 231 is to send it a SIGTERM ( -15) signal and wait for it to die on its own.223 process it is recommended that SIGKILL (\-9) 224 \fINOT\fR 225 be used, except as a last resort, as this may leave the name database in an inconsistent state\. The correct way to terminate 226 nmbd 227 is to send it a SIGTERM (\-15) signal and wait for it to die on its own\. 232 228 .PP 233 229 nmbd 234 230 will accept SIGHUP, which will cause it to dump out its namelists into the file 235 \fInamelist .debug \fR231 \fInamelist\.debug \fR 236 232 in the 237 233 \fI/usr/local/samba/var/locks\fR 238 234 directory (or the 239 235 \fIvar/locks\fR 240 directory configured under wherever Samba was configured to install itself) . This will also cause236 directory configured under wherever Samba was configured to install itself)\. This will also cause 241 237 nmbd 242 238 to dump out its server database in the 243 \fIlog .nmb\fR244 file .239 \fIlog\.nmb\fR 240 file\. 245 241 .PP 246 242 The debug log level of nmbd may be raised or lowered using 247 243 \fBsmbcontrol\fR(1) 248 (SIGUSR[1|2] signals are no longer used since Samba 2 .2). This is to allow transient problems to be diagnosed, whilst still running at a normally low log level.244 (SIGUSR[1|2] signals are no longer used since Samba 2\.2)\. This is to allow transient problems to be diagnosed, whilst still running at a normally low log level\. 249 245 .SH "VERSION" 250 246 .PP 251 This man page is correct for version 3 .0 of the Samba suite.247 This man page is correct for version 3\.0 of the Samba suite\. 252 248 .SH "SEE ALSO" 253 249 .PP … … 258 254 \fBsmbclient\fR(1), 259 255 \fBtestparm\fR(1), 260 \fBtestprns\fR(1), and the Internet RFC 's261 \fIrfc1001 .txt\fR,262 \fIrfc1002 .txt\fR. In addition the CIFS (formerly SMB) specification is available as a link from the Web page263 http://samba .org/cifs/.256 \fBtestprns\fR(1), and the Internet RFC\'s 257 \fIrfc1001\.txt\fR, 258 \fIrfc1002\.txt\fR\. In addition the CIFS (formerly SMB) specification is available as a link from the Web page 259 http://samba\.org/cifs/\. 264 260 .SH "AUTHOR" 265 261 .PP 266 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 267 .PP 268 The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 269 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 270 262 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 263 .PP 264 The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 265 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/nmblookup.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "NMBLOOKUP" 1 "" "" "" 1 .\" Title: nmblookup 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "NMBLOOKUP" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 nmblookup - NetBIOS over TCP/IP client used to lookup NetBIOS names 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 nmblookup [ -M] [-R] [-S] [-r] [-A] [-h] [-B <broadcast address>] [-U <unicast address>] [-d <debug level>] [-s <smb config file>] [-i <NetBIOS scope>] [-T] [-f] {name}17 nmblookup [\-M] [\-R] [\-S] [\-r] [\-A] [\-h] [\-B\ <broadcast\ address>] [\-U\ <unicast\ address>] [\-d\ <debug\ level>] [\-s\ <smb\ config\ file>] [\-i\ <NetBIOS\ scope>] [\-T] [\-f] {name} 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 nmblookup 33 is used to query NetBIOS names and map them to IP addresses in a network using NetBIOS over TCP/IP queries . The options allow the name queries to be directed at a particular IP broadcast area or to a particular machine. All queries are done over UDP.25 is used to query NetBIOS names and map them to IP addresses in a network using NetBIOS over TCP/IP queries\. The options allow the name queries to be directed at a particular IP broadcast area or to a particular machine\. All queries are done over UDP\. 34 26 .SH "OPTIONS" 35 27 .PP 36 -M37 .RS 3n28 \-M 29 .RS 4 38 30 Searches for a master browser by looking up the NetBIOS name 39 31 \fIname\fR 40 32 with a type of 41 \fB0x1d\fR . If33 \fB0x1d\fR\. If 42 34 \fI name\fR 43 is " -" then it does a lookup on the special name44 \fB__MSBROWSE__\fR . Please note that in order to use the name "-", you need to make sure "-" isn't parsed as an argument, e.g. use :45 \fBnmblookup -M -- -\fR.35 is "\-" then it does a lookup on the special name 36 \fB__MSBROWSE__\fR\. Please note that in order to use the name "\-", you need to make sure "\-" isn\'t parsed as an argument, e\.g\. use : 37 \fBnmblookup \-M \-\- \-\fR\. 46 38 .RE 47 39 .PP 48 -R49 .RS 3n50 Set the recursion desired bit in the packet to do a recursive lookup . This is used when sending a name query to a machine running a WINS server and the user wishes to query the names in the WINS server. If this bit is unset the normal (broadcast responding) NetBIOS processing code on a machine is used instead. See RFC1001, RFC1002 for details.40 \-R 41 .RS 4 42 Set the recursion desired bit in the packet to do a recursive lookup\. This is used when sending a name query to a machine running a WINS server and the user wishes to query the names in the WINS server\. If this bit is unset the normal (broadcast responding) NetBIOS processing code on a machine is used instead\. See RFC1001, RFC1002 for details\. 51 43 .RE 52 44 .PP 53 -S54 .RS 3n55 Once the name query has returned an IP address then do a node status query as well . A node status query returns the NetBIOS names registered by a host.45 \-S 46 .RS 4 47 Once the name query has returned an IP address then do a node status query as well\. A node status query returns the NetBIOS names registered by a host\. 56 48 .RE 57 49 .PP 58 -r59 .RS 3n60 Try and bind to UDP port 137 to send and receive UDP datagrams . The reason for this option is a bug in Windows 95 where it ignores the source port of the requesting packet and only replies to UDP port 137. Unfortunately, on most UNIX systems root privilege is needed to bind to this port, and in addition, if the50 \-r 51 .RS 4 52 Try and bind to UDP port 137 to send and receive UDP datagrams\. The reason for this option is a bug in Windows 95 where it ignores the source port of the requesting packet and only replies to UDP port 137\. Unfortunately, on most UNIX systems root privilege is needed to bind to this port, and in addition, if the 61 53 \fBnmbd\fR(8) 62 daemon is running on this machine it also binds to this port .54 daemon is running on this machine it also binds to this port\. 63 55 .RE 64 56 .PP 65 -A66 .RS 3n57 \-A 58 .RS 4 67 59 Interpret 68 60 \fIname\fR 69 as an IP Address and do a node status query on this address .61 as an IP Address and do a node status query on this address\. 70 62 .RE 71 63 .PP 72 -n <primary NetBIOS name>73 .RS 3n74 This option allows you to override the NetBIOS name that Samba uses for itself . This is identical to setting the75 64 \-n <primary NetBIOS name> 65 .RS 4 66 This option allows you to override the NetBIOS name that Samba uses for itself\. This is identical to setting the 67 \fInetbios name\fR 76 68 parameter in the 77 \fIsmb .conf\fR78 file . However, a command line setting will take precedence over settings in79 \fIsmb .conf\fR.69 \fIsmb\.conf\fR 70 file\. However, a command line setting will take precedence over settings in 71 \fIsmb\.conf\fR\. 80 72 .RE 81 73 .PP 82 -i <scope>83 .RS 3n74 \-i <scope> 75 .RS 4 84 76 This specifies a NetBIOS scope that 85 77 nmblookup 86 will use to communicate with when generating NetBIOS names . For details on the use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are87 \f Bvery\fR88 rarely used, only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with .78 will use to communicate with when generating NetBIOS names\. For details on the use of NetBIOS scopes, see rfc1001\.txt and rfc1002\.txt\. NetBIOS scopes are 79 \fIvery\fR 80 rarely used, only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with\. 89 81 .RE 90 82 .PP 91 -W|--workgroup=domain92 .RS 3n93 Set the SMB domain of the username . This overrides the default domain which is the domain defined in smb.conf. If the domain specified is the same as the servers NetBIOS name, it causes the client to log on using the servers local SAM (as opposed to the Domain SAM).83 \-W|\-\-workgroup=domain 84 .RS 4 85 Set the SMB domain of the username\. This overrides the default domain which is the domain defined in smb\.conf\. If the domain specified is the same as the servers NetBIOS name, it causes the client to log on using the servers local SAM (as opposed to the Domain SAM)\. 94 86 .RE 95 87 .PP 96 -O socket options97 .RS 3n98 TCP socket options to set on the client socket . See the socket options parameter in the99 \fIsmb .conf\fR100 manual page for the list of valid options .88 \-O socket options 89 .RS 4 90 TCP socket options to set on the client socket\. See the socket options parameter in the 91 \fIsmb\.conf\fR 92 manual page for the list of valid options\. 101 93 .RE 102 94 .PP 103 -h|--help104 .RS 3n105 Print a summary of command line options .95 \-h|\-\-help 96 .RS 4 97 Print a summary of command line options\. 106 98 .RE 107 99 .PP 108 -B <broadcast address>109 .RS 3n110 Send the query to the given broadcast address . Without this option the default behavior of nmblookup is to send the query to the broadcast address of the network interfaces as either auto-detected or defined in the100 \-B <broadcast address> 101 .RS 4 102 Send the query to the given broadcast address\. Without this option the default behavior of nmblookup is to send the query to the broadcast address of the network interfaces as either auto\-detected or defined in the 111 103 \fIinterfaces\fR 112 104 parameter of the 113 105 \fBsmb.conf\fR(5) 114 file .106 file\. 115 107 .RE 116 108 .PP 117 -U <unicast address>118 .RS 3n109 \-U <unicast address> 110 .RS 4 119 111 Do a unicast query to the specified address or host 120 \fIunicast address\fR . This option (along with the121 \fI -R\fR122 option) is needed to query a WINS server .112 \fIunicast address\fR\. This option (along with the 113 \fI\-R\fR 114 option) is needed to query a WINS server\. 123 115 .RE 124 116 .PP 125 -V 126 .RS 3n 127 Prints the program version number. 117 \-d|\-\-debuglevel=level 118 .RS 4 119 \fIlevel\fR 120 is an integer from 0 to 10\. The default value if this parameter is not specified is 0\. 121 .sp 122 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 123 .sp 124 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 125 .sp 126 Note that specifying this parameter here will override the 127 \fIlog level\fR 128 parameter in the 129 \fIsmb\.conf\fR 130 file\. 128 131 .RE 129 132 .PP 130 -s <configuration file> 131 .RS 3n 132 The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See 133 \fIsmb.conf\fR 134 for more information. The default configuration file name is determined at compile time. 133 \-V 134 .RS 4 135 Prints the program version number\. 135 136 .RE 136 137 .PP 137 -d|--debuglevel=level 138 .RS 3n 139 \fIlevel\fR 140 is an integer from 0 to 10. The default value if this parameter is not specified is zero. 141 .sp 142 The higher this value, the more detail will be logged to the log files about the activities of the server. At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out. 143 .sp 144 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic. 145 .sp 146 Note that specifying this parameter here will override the 147 148 parameter in the 149 \fIsmb.conf\fR 150 file. 138 \-s <configuration file> 139 .RS 4 140 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 141 \fIsmb\.conf\fR 142 for more information\. The default configuration file name is determined at compile time\. 151 143 .RE 152 144 .PP 153 -l|--logfile=logdirectory154 .RS 3n155 Base directory name for log/debug files . The extension156 \fB" .progname"\fR157 will be appended (e .g. log.smbclient, log.smbd, etc...). The log file is never removed by the client.145 \-l|\-\-log\-basename=logdirectory 146 .RS 4 147 Base directory name for log/debug files\. The extension 148 \fB"\.progname"\fR 149 will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\. 158 150 .RE 159 151 .PP 160 -T161 .RS 3n152 \-T 153 .RS 4 162 154 This causes any IP addresses found in the lookup to be looked up via a reverse DNS lookup into a DNS name, and printed out before each 163 155 .sp 164 \f BIP address .... NetBIOS name\fR156 \fIIP address \.\.\.\. NetBIOS name\fR 165 157 .sp 166 pair that is the normal output .158 pair that is the normal output\. 167 159 .RE 168 160 .PP 169 -f170 .RS 3n171 Show which flags apply to the name that has been looked up . Possible answers are zero or more of: Response, Authoritative, Truncated, Recursion_Desired, Recursion_Available, Broadcast.161 \-f 162 .RS 4 163 Show which flags apply to the name that has been looked up\. Possible answers are zero or more of: Response, Authoritative, Truncated, Recursion_Desired, Recursion_Available, Broadcast\. 172 164 .RE 173 165 .PP 174 166 name 175 .RS 3n176 This is the NetBIOS name being queried . Depending upon the previous options this may be a NetBIOS name or IP address. If a NetBIOS name then the different name types may be specified by appending '#<type>' to the name. This name may also be '*', which will return all registered names within a broadcast area.167 .RS 4 168 This is the NetBIOS name being queried\. Depending upon the previous options this may be a NetBIOS name or IP address\. If a NetBIOS name then the different name types may be specified by appending \'#<type>\' to the name\. This name may also be \'*\', which will return all registered names within a broadcast area\. 177 169 .RE 178 170 .SH "EXAMPLES" … … 181 173 can be used to query a WINS server (in the same way 182 174 nslookup 183 is used to query DNS servers) . To query a WINS server,175 is used to query DNS servers)\. To query a WINS server, 184 176 nmblookup 185 177 must be called like this: 186 178 .PP 187 nmblookup -U server -R 'name'179 nmblookup \-U server \-R \'name\' 188 180 .PP 189 181 For example, running : 190 182 .PP 191 nmblookup -U samba.org -R 'IRIX#1B'183 nmblookup \-U samba\.org \-R \'IRIX#1B\' 192 184 .PP 193 would query the WINS server samba .org for the domain master browser (1B name type) for the IRIX workgroup.185 would query the WINS server samba\.org for the domain master browser (1B name type) for the IRIX workgroup\. 194 186 .SH "VERSION" 195 187 .PP 196 This man page is correct for version 3 .0 of the Samba suite.188 This man page is correct for version 3\.0 of the Samba suite\. 197 189 .SH "SEE ALSO" 198 190 .PP 199 191 \fBnmbd\fR(8), 200 192 \fBsamba\fR(7), and 201 \fBsmb.conf\fR(5) .193 \fBsmb.conf\fR(5)\. 202 194 .SH "AUTHOR" 203 195 .PP 204 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.196 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 205 197 .PP 206 The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 207 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 208 198 The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 199 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/ntlm_auth.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "NTLM_AUTH" 1 "" "" "" 1 .\" Title: ntlm_auth 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "NTLM_AUTH" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 ntlm_auth - tool to allow external access to Winbind's NTLM authentication function 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 ntlm_auth [ -d debuglevel] [-l logdir] [-s <smb configfile>]17 ntlm_auth [\-d\ debuglevel] [\-l\ logdir] [\-s\ <smb\ config\ file>] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 ntlm_auth 33 is a helper utility that authenticates users using NT/LM authentication . It returns 0 if the users is authenticated successfully and 1 if access was denied. ntlm_auth uses winbind to access the user and authentication data for a domain. This utility is only indended to be used by other programs (currently25 is a helper utility that authenticates users using NT/LM authentication\. It returns 0 if the users is authenticated successfully and 1 if access was denied\. ntlm_auth uses winbind to access the user and authentication data for a domain\. This utility is only indended to be used by other programs (currently 34 26 Squid 35 27 and … … 39 31 The 40 32 \fBwinbindd\fR(8) 41 daemon must be operational for many of these commands to function .33 daemon must be operational for many of these commands to function\. 42 34 .PP 43 35 Some of these commands also require access to the directory 44 36 \fIwinbindd_privileged\fR 45 37 in 46 \fI$LOCKDIR\fR . This should be done either by running this command as root or providing group access to the47 \fIwinbindd_privileged\fR 48 directory . For security reasons, this directory should not be world-accessable.38 \fI$LOCKDIR\fR\. This should be done either by running this command as root or providing group access to the 39 \fIwinbindd_privileged\fR 40 directory\. For security reasons, this directory should not be world\-accessable\. 49 41 .SH "OPTIONS" 50 42 .PP 51 --helper-protocol=PROTO 52 .RS 3n 53 Operate as a stdio-based helper. Valid helper protocols are: 54 55 .RS 3n 56 .PP 57 squid-2.4-basic 58 .RS 3n 59 Server-side helper for use with Squid 2.4's basic (plaintext) authentication. 60 .RE 61 .PP 62 squid-2.5-basic 63 .RS 3n 64 Server-side helper for use with Squid 2.5's basic (plaintext) authentication. 65 .RE 66 .PP 67 squid-2.5-ntlmssp 68 .RS 3n 69 Server-side helper for use with Squid 2.5's NTLMSSP authentication. 43 \-\-helper\-protocol=PROTO 44 .RS 4 45 Operate as a stdio\-based helper\. Valid helper protocols are: 46 .PP 47 squid\-2\.4\-basic 48 .RS 4 49 Server\-side helper for use with Squid 2\.4\'s basic (plaintext) authentication\. 50 .RE 51 .PP 52 squid\-2\.5\-basic 53 .RS 4 54 Server\-side helper for use with Squid 2\.5\'s basic (plaintext) authentication\. 55 .RE 56 .PP 57 squid\-2\.5\-ntlmssp 58 .RS 4 59 Server\-side helper for use with Squid 2\.5\'s NTLMSSP authentication\. 70 60 .sp 71 61 Requires access to the directory 72 62 \fIwinbindd_privileged\fR 73 63 in 74 \fI$LOCKDIR\fR . The protocol used is described here:75 http://devel .squid-cache.org/ntlm/squid_helper_protocol.html. This protocol has been extended to allow the NTLMSSP Negotiate packet to be included as an argument to the64 \fI$LOCKDIR\fR\. The protocol used is described here: 65 http://devel\.squid\-cache\.org/ntlm/squid_helper_protocol\.html\. This protocol has been extended to allow the NTLMSSP Negotiate packet to be included as an argument to the 76 66 YR 77 command . (Thus avoiding loss of information in the protocol exchange).78 .RE 79 .PP 80 ntlmssp -client-181 .RS 3n82 Client -side helper for use with arbitary external programs that may wish to use Samba's NTLMSSP authentication knowlege.83 .sp 84 This helper is a client, and as such may be run by any user . The protocol used is effectivly the reverse of the previous protocol. A67 command\. (Thus avoiding loss of information in the protocol exchange)\. 68 .RE 69 .PP 70 ntlmssp\-client\-1 71 .RS 4 72 Client\-side helper for use with arbitrary external programs that may wish to use Samba\'s NTLMSSP authentication knowledge\. 73 .sp 74 This helper is a client, and as such may be run by any user\. The protocol used is effectively the reverse of the previous protocol\. A 85 75 YR 86 command (without any arguments) starts the authentication exchange .87 .RE 88 .PP 89 gss -spnego90 .RS 3n91 Server -side helper that implements GSS-SPNEGO. This uses a protocol that is almost the same as92 squid -2.5-ntlmssp, but has some subtle differences that are undocumented outside the source at this stage.76 command (without any arguments) starts the authentication exchange\. 77 .RE 78 .PP 79 gss\-spnego 80 .RS 4 81 Server\-side helper that implements GSS\-SPNEGO\. This uses a protocol that is almost the same as 82 squid\-2\.5\-ntlmssp, but has some subtle differences that are undocumented outside the source at this stage\. 93 83 .sp 94 84 Requires access to the directory 95 85 \fIwinbindd_privileged\fR 96 86 in 97 \fI$LOCKDIR\fR .98 .RE 99 .PP 100 gss -spnego-client101 .RS 3n102 Client -side helper that implements GSS-SPNEGO. This also uses a protocol similar to the above helpers, but is currently undocumented.103 .RE 104 .PP 105 ntlm -server-1106 .RS 3n107 Server -side helper protocol, intended for use by a RADIUS server or the 'winbind' plugin for pppd, for the provision of MSCHAP and MSCHAPv2 authentication.108 .sp 109 This protocol consists of lines in forform:87 \fI$LOCKDIR\fR\. 88 .RE 89 .PP 90 gss\-spnego\-client 91 .RS 4 92 Client\-side helper that implements GSS\-SPNEGO\. This also uses a protocol similar to the above helpers, but is currently undocumented\. 93 .RE 94 .PP 95 ntlm\-server\-1 96 .RS 4 97 Server\-side helper protocol, intended for use by a RADIUS server or the \'winbind\' plugin for pppd, for the provision of MSCHAP and MSCHAPv2 authentication\. 98 .sp 99 This protocol consists of lines in the form: 110 100 Parameter: value 111 101 and 112 Param ter:: Base64-encode value. The presence of a single period113 .114 indicates that one side has finished supplying data to the other . (Which in turn could cause the helper to authenticate the user).102 Parameter:: Base64\-encode value\. The presence of a single period 103 \. 104 indicates that one side has finished supplying data to the other\. (Which in turn could cause the helper to authenticate the user)\. 115 105 .sp 116 106 Curently implemented parameters from the external program to the helper are: 117 118 .RS 3n119 107 .PP 120 108 Username 121 .RS 3n 122 The username, expected to be in Samba's 123 unix charset. 124 .sp 125 \fBExample 1. \fRUsername: bob 126 .sp 127 \fBExample 2. \fRUsername:: Ym9i 109 .RS 4 110 The username, expected to be in Samba\'s 111 \fIunix charset\fR\. 112 .PP \fBExample\ 1.\ \fR Username: bob 113 .PP \fBExample\ 2.\ \fR Username:: Ym9i 128 114 .RE 129 115 .PP 130 116 Username 131 .RS 3n 132 The user's domain, expected to be in Samba's 133 unix charset. 134 .sp 135 \fBExample 3. \fRDomain: WORKGROUP 136 .sp 137 \fBExample 4. \fRDomain:: V09SS0dST1VQ 138 .RE 139 .PP 140 Full-Username 141 .RS 3n 142 The fully qualified username, expected to be in Samba's 143 117 .RS 4 118 The user\'s domain, expected to be in Samba\'s 119 \fIunix charset\fR\. 120 .PP \fBExample\ 3.\ \fR Domain: WORKGROUP 121 .PP \fBExample\ 4.\ \fR Domain:: V09SS0dST1VQ 122 .RE 123 .PP 124 Full\-Username 125 .RS 4 126 The fully qualified username, expected to be in Samba\'s 127 \fIunix charset\fR 144 128 and qualified with the 145 winbind separator. 146 .sp 147 \fBExample 5. \fRFull-Username: WORKGROUP\bob 148 .sp 149 \fBExample 6. \fRFull-Username:: V09SS0dST1VQYm9i 150 .RE 151 .PP 152 LANMAN-Challenge 153 .RS 3n 129 \fIwinbind separator\fR\. 130 .PP \fBExample\ 5.\ \fR Full\-Username: WORKGROUP\ebob 131 .PP \fBExample\ 6.\ \fR Full\-Username:: V09SS0dST1VQYm9i 132 .RE 133 .PP 134 LANMAN\-Challenge 135 .RS 4 154 136 The 8 byte 155 137 LANMAN Challenge 156 value, generated randomly by the server, or (in cases such as MSCHAPv2) generated in some way by both the server and the client. 157 .sp 158 \fBExample 7. \fRLANMAN-Challege: 0102030405060708 159 .RE 160 .PP 161 LANMAN-Response 162 .RS 3n 138 value, generated randomly by the server, or (in cases such as MSCHAPv2) generated in some way by both the server and the client\. 139 .PP \fBExample\ 7.\ \fR LANMAN\-Challege: 0102030405060708 140 .RE 141 .PP 142 LANMAN\-Response 143 .RS 4 163 144 The 24 byte 164 145 LANMAN Response 165 value, calculated from the user's password and the supplied 166 LANMAN Challenge. Typically, this is provided over the network by a client wishing to authenticate. 167 .sp 168 \fBExample 8. \fRLANMAN-Response: 0102030405060708090A0B0C0D0E0F101112131415161718 169 .RE 170 .PP 171 NT-Response 172 .RS 3n 146 value, calculated from the user\'s password and the supplied 147 LANMAN Challenge\. Typically, this is provided over the network by a client wishing to authenticate\. 148 .PP \fBExample\ 8.\ \fR LANMAN\-Response: 0102030405060708090A0B0C0D0E0F101112131415161718 149 .RE 150 .PP 151 NT\-Response 152 .RS 4 173 153 The >= 24 byte 174 154 NT Response 175 calculated from the user's password and the supplied 176 LANMAN Challenge. Typically, this is provided over the network by a client wishing to authenticate. 177 .sp 178 \fBExample 9. \fRNT-Response: 0102030405060708090A0B0C0D0E0F101112131415161718 155 calculated from the user\'s password and the supplied 156 LANMAN Challenge\. Typically, this is provided over the network by a client wishing to authenticate\. 157 .PP \fBExample\ 9.\ \fR NT\-Response: 0102030405060708090A0B0C0D0E0F101112131415161718 179 158 .RE 180 159 .PP 181 160 Password 182 .RS 3n 183 The user's password. This would be provided by a network client, if the helper is being used in a legacy situation that exposes plaintext passwords in this way. 184 .sp 185 \fBExample 10. \fRPassword: samba2 186 .sp 187 \fBExample 11. \fRPassword:: c2FtYmEy 188 .RE 189 .PP 190 Request-User-Session-Key 191 .RS 3n 192 Apon sucessful authenticaiton, return the user session key associated with the login. 193 .sp 194 \fBExample 12. \fRRequest-User-Session-Key: Yes 195 .RE 196 .PP 197 Request-LanMan-Session-Key 198 .RS 3n 199 Apon sucessful authenticaiton, return the LANMAN session key associated with the login. 200 .sp 201 \fBExample 13. \fRRequest-LanMan-Session-Key: Yes 161 .RS 4 162 The user\'s password\. This would be provided by a network client, if the helper is being used in a legacy situation that exposes plaintext passwords in this way\. 163 .PP \fBExample\ 10.\ \fR Password: samba2 164 .PP \fBExample\ 11.\ \fR Password:: c2FtYmEy 165 .RE 166 .PP 167 Request\-User\-Session\-Key 168 .RS 4 169 Apon sucessful authenticaiton, return the user session key associated with the login\. 170 .PP \fBExample\ 12.\ \fR Request\-User\-Session\-Key: Yes 171 .RE 172 .PP 173 Request\-LanMan\-Session\-Key 174 .RS 4 175 Apon sucessful authenticaiton, return the LANMAN session key associated with the login\. 176 .PP \fBExample\ 13.\ \fR Request\-LanMan\-Session\-Key: Yes 202 177 .RE 203 178 .sp … … 206 181 .nr an-break-flag 1 207 182 .br 208 \fBWarning\fR 183 Warning 209 184 Implementors should take care to base64 encode 210 185 any data (such as usernames/passwords) that may contain malicous user data, such as 211 a newline. They may also need to decode strings from 212 the helper, which likewise may have been base64 encoded. 213 .RE 214 .RE 215 .RE 216 .RE 217 .PP 218 --username=USERNAME 219 .RS 3n 186 a newline\. They may also need to decode strings from 187 the helper, which likewise may have been base64 encoded\. 188 .RE 189 .RE 190 .PP 191 \-\-username=USERNAME 192 .RS 4 220 193 Specify username of user to authenticate 221 194 .RE 222 195 .PP 223 --domain=DOMAIN224 .RS 3n196 \-\-domain=DOMAIN 197 .RS 4 225 198 Specify domain of user to authenticate 226 199 .RE 227 200 .PP 228 --workstation=WORKSTATION229 .RS 3n201 \-\-workstation=WORKSTATION 202 .RS 4 230 203 Specify the workstation the user authenticated from 231 204 .RE 232 205 .PP 233 --challenge=STRING234 .RS 3n206 \-\-challenge=STRING 207 .RS 4 235 208 NTLM challenge (in HEXADECIMAL) 236 209 .RE 237 210 .PP 238 --lm-response=RESPONSE239 .RS 3n211 \-\-lm\-response=RESPONSE 212 .RS 4 240 213 LM Response to the challenge (in HEXADECIMAL) 241 214 .RE 242 215 .PP 243 --nt-response=RESPONSE244 .RS 3n216 \-\-nt\-response=RESPONSE 217 .RS 4 245 218 NT or NTLMv2 Response to the challenge (in HEXADECIMAL) 246 219 .RE 247 220 .PP 248 --password=PASSWORD249 .RS 3n250 User 's plaintext password251 .sp 252 If not specified on the command line, this is prompted for when required .253 .sp 254 For the NTLMSSP based server roles, this param ter specifies the expected password, allowing testing without winbindd operational.255 .RE 256 .PP 257 --request-lm-key258 .RS 3n221 \-\-password=PASSWORD 222 .RS 4 223 User\'s plaintext password 224 .sp 225 If not specified on the command line, this is prompted for when required\. 226 .sp 227 For the NTLMSSP based server roles, this parameter specifies the expected password, allowing testing without winbindd operational\. 228 .RE 229 .PP 230 \-\-request\-lm\-key 231 .RS 4 259 232 Retreive LM session key 260 233 .RE 261 234 .PP 262 --request-nt-key263 .RS 3n235 \-\-request\-nt\-key 236 .RS 4 264 237 Request NT key 265 238 .RE 266 239 .PP 267 --diagnostics 268 .RS 3n 269 Perform Diagnostics on the authentication chain. Uses the password from 270 --password 271 or prompts for one. 272 .RE 273 .PP 274 --require-membership-of={SID|Name} 275 .RS 3n 276 Require that a user be a member of specified group (either name or SID) for authentication to succeed. 277 .RE 278 .PP 279 -V 280 .RS 3n 281 Prints the program version number. 282 .RE 283 .PP 284 -s <configuration file> 285 .RS 3n 286 The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See 287 \fIsmb.conf\fR 288 for more information. The default configuration file name is determined at compile time. 289 .RE 290 .PP 291 -d|--debuglevel=level 292 .RS 3n 240 \-\-diagnostics 241 .RS 4 242 Perform Diagnostics on the authentication chain\. Uses the password from 243 \-\-password 244 or prompts for one\. 245 .RE 246 .PP 247 \-\-require\-membership\-of={SID|Name} 248 .RS 4 249 Require that a user be a member of specified group (either name or SID) for authentication to succeed\. 250 .RE 251 .PP 252 \-d|\-\-debuglevel=level 253 .RS 4 293 254 \fIlevel\fR 294 is an integer from 0 to 10 . The default value if this parameter is not specified is zero.295 .sp 296 The higher this value, the more detail will be logged to the log files about the activities of the server . At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out.297 .sp 298 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem . Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic.255 is an integer from 0 to 10\. The default value if this parameter is not specified is 0\. 256 .sp 257 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 258 .sp 259 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 299 260 .sp 300 261 Note that specifying this parameter here will override the 301 262 \fIlog level\fR 302 263 parameter in the 303 \fIsmb.conf\fR 304 file. 305 .RE 306 .PP 307 -l|--logfile=logdirectory 308 .RS 3n 309 Base directory name for log/debug files. The extension 310 \fB".progname"\fR 311 will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client. 312 .RE 313 .PP 314 -h|--help 315 .RS 3n 316 Print a summary of command line options. 264 \fIsmb\.conf\fR 265 file\. 266 .RE 267 .PP 268 \-V 269 .RS 4 270 Prints the program version number\. 271 .RE 272 .PP 273 \-s <configuration file> 274 .RS 4 275 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 276 \fIsmb\.conf\fR 277 for more information\. The default configuration file name is determined at compile time\. 278 .RE 279 .PP 280 \-l|\-\-log\-basename=logdirectory 281 .RS 4 282 Base directory name for log/debug files\. The extension 283 \fB"\.progname"\fR 284 will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\. 285 .RE 286 .PP 287 \-h|\-\-help 288 .RS 4 289 Print a summary of command line options\. 317 290 .RE 318 291 .SH "EXAMPLE SETUP" 319 292 .PP 320 To setup ntlm_auth for use by squid 2.5, with both basic and NTLMSSP authentication, the following should be placed in the 321 \fIsquid.conf\fR 322 file. 323 324 .sp 325 293 To setup ntlm_auth for use by squid 2\.5, with both basic and NTLMSSP authentication, the following should be placed in the 294 \fIsquid\.conf\fR 295 file\. 296 .sp 297 .RS 4 326 298 .nf 327 328 auth_param ntlm program ntlm_auth --helper-protocol=squid-2.5-ntlmssp 329 auth_param basic program ntlm_auth --helper-protocol=squid-2.5-basic 299 auth_param ntlm program ntlm_auth \-\-helper\-protocol=squid\-2\.5\-ntlmssp 300 auth_param basic program ntlm_auth \-\-helper\-protocol=squid\-2\.5\-basic 330 301 auth_param basic children 5 331 auth_param basic realm Squid proxy -caching web server302 auth_param basic realm Squid proxy\-caching web server 332 303 auth_param basic credentialsttl 2 hours 333 334 304 .fi 335 305 .RE 336 306 .sp 337 307 .it 1 an-trap … … 339 309 .nr an-break-flag 1 340 310 .br 341 \fBNote\fR 311 Note 342 312 .PP 343 313 This example assumes that ntlm_auth has been installed into your path, and that the group permissions on 344 314 \fIwinbindd_privileged\fR 345 are as described above. 346 .PP 347 To setup ntlm_auth for use by squid 2.5 with group limitation in addition to the above example, the following should be added to the 348 \fIsquid.conf\fR 349 file. 350 351 .sp 352 315 are as described above\. 316 .PP 317 To setup ntlm_auth for use by squid 2\.5 with group limitation in addition to the above example, the following should be added to the 318 \fIsquid\.conf\fR 319 file\. 320 .sp 321 .RS 4 353 322 .nf 354 355 auth_param ntlm program ntlm_auth --helper-protocol=squid-2.5-ntlmssp --require-membership-of='WORKGROUP\Domain Users' 356 auth_param basic program ntlm_auth --helper-protocol=squid-2.5-basic --require-membership-of='WORKGROUP\Domain Users' 357 323 auth_param ntlm program ntlm_auth \-\-helper\-protocol=squid\-2\.5\-ntlmssp \-\-require\-membership\-of=\'WORKGROUP\eDomain Users\' 324 auth_param basic program ntlm_auth \-\-helper\-protocol=squid\-2\.5\-basic \-\-require\-membership\-of=\'WORKGROUP\eDomain Users\' 358 325 .fi 359 326 .RE 360 327 .SH "TROUBLESHOOTING" 361 328 .PP 362 If you 're experiencing problems with authenticating Internet Explorer running under MS Windows 9X or Millenium Edition against ntlm_auth's NTLMSSP authentication helper (--helper-protocol=squid-2.5-ntlmssp), then please read363 the Microsoft Knowledge Base article #239869 and follow instructions described there .329 If you\'re experiencing problems with authenticating Internet Explorer running under MS Windows 9X or Millenium Edition against ntlm_auth\'s NTLMSSP authentication helper (\-\-helper\-protocol=squid\-2\.5\-ntlmssp), then please read 330 the Microsoft Knowledge Base article #239869 and follow instructions described there\. 364 331 .SH "VERSION" 365 332 .PP 366 This man page is correct for version 3 .0 of the Samba suite.333 This man page is correct for version 3\.0 of the Samba suite\. 367 334 .SH "AUTHOR" 368 335 .PP 369 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 370 .PP 371 The ntlm_auth manpage was written by Jelmer Vernooij and Andrew Bartlett. 372 336 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 337 .PP 338 The ntlm_auth manpage was written by Jelmer Vernooij and Andrew Bartlett\. -
branches/samba-3.0/docs/manpages/pam_winbind.7
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "PAM_WINBIND" 7 "" "" "" 1 .\" Title: pam_winbind 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: 7 6 .\" Source: Samba 3.0 7 .\" 8 .TH "PAM_WINBIND" "7" "05/21/2008" "Samba 3\.0" "7" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 pam_winbind - PAM module for Winbind … … 25 17 This tool is part of the 26 18 \fBsamba\fR(7) 27 suite .19 suite\. 28 20 .PP 29 pam_winbind is a PAM module that can authenticate users against the local domain by talking to the Winbind daemon .21 pam_winbind is a PAM module that can authenticate users against the local domain by talking to the Winbind daemon\. 30 22 .SH "OPTIONS" 31 23 .PP 32 24 pam_winbind supports several options which can either be set in the PAM configuration files or in the pam_winbind configuration file situated at 33 \fI/etc/security/pam_winbind .conf\fR. Options from the PAM configuration file take precedence to those from the configuration file.25 \fI/etc/security/pam_winbind\.conf\fR\. Options from the PAM configuration file take precedence to those from the configuration file\. 34 26 .PP 35 27 debug 36 .RS 3n37 Gives debugging output to syslog .28 .RS 4 29 Gives debugging output to syslog\. 38 30 .RE 39 31 .PP 40 32 debug_state 41 .RS 3n42 Gives detailed PAM state debugging output to syslog .33 .RS 4 34 Gives detailed PAM state debugging output to syslog\. 43 35 .RE 44 36 .PP 45 37 require_membership_of=[SID or NAME] 46 .RS 3n47 If this option is set, pam_winbind will only succeed if the user is a member of the given SID or NAME . A SID can be either a group-SID, a alias-SID or even a user-SID. It is also possible to give a NAME instead of the SID. That name must have the form:48 \fIMYDOMAIN\ \mygroup\fR38 .RS 4 39 If this option is set, pam_winbind will only succeed if the user is a member of the given SID or NAME\. A SID can be either a group\-SID, an alias\-SID or even an user\-SID\. It is also possible to give a NAME instead of the SID\. That name must have the form: 40 \fIMYDOMAIN\e\emygroup\fR 49 41 or 50 \fIMYDOMAIN\ \myuser\fR. pam_winbind will, in that case, lookup the SID internally. Note that NAME may not contain any spaces. It is thus recommended to only use SIDs. You can verify the list of SIDs a user is a member of with51 wbinfo --user-sids=SID.42 \fIMYDOMAIN\e\emyuser\fR\. pam_winbind will, in that case, lookup the SID internally\. Note that NAME may not contain any spaces\. It is thus recommended to only use SIDs\. You can verify the list of SIDs a user is a member of with 43 wbinfo \-\-user\-sids=SID\. 52 44 .RE 53 45 .PP 54 46 try_first_pass 55 .RS 3n 56 47 .RS 4 57 48 .RE 58 49 .PP 59 50 use_first_pass 60 .RS 3n61 By default, pam_winbind tries to get the authentication token from a previous module . If no token is available it asks the user for the old password. With this option, pam_winbind aborts with an error if no authentication token from a previous module is available.51 .RS 4 52 By default, pam_winbind tries to get the authentication token from a previous module\. If no token is available it asks the user for the old password\. With this option, pam_winbind aborts with an error if no authentication token from a previous module is available\. 62 53 .RE 63 54 .PP 64 55 use_authtok 65 .RS 3n66 Set the new password to the one provided by the previously stacked password module . If this option is not set pam_winbind will ask the user for the new password.56 .RS 4 57 Set the new password to the one provided by the previously stacked password module\. If this option is not set pam_winbind will ask the user for the new password\. 67 58 .RE 68 59 .PP 69 60 krb5_auth 70 .RS 3n71 pam_winbind can authenticate using Kerberos when winbindd is talking to an Active Directory domain controller . Kerberos authentication must be enabled with this parameter. When Kerberos authentication can not succeed (e.g. due to clock skew), winbindd will fallback to samlogon authentication over MSRPC. When this parameter is used in conjunction with72 \fIwinbind refresh tickets\fR, winbind will keep your Ticket Granting Ticket (TGT) uptodate by refreshing it whenever necessary .61 .RS 4 62 pam_winbind can authenticate using Kerberos when winbindd is talking to an Active Directory domain controller\. Kerberos authentication must be enabled with this parameter\. When Kerberos authentication can not succeed (e\.g\. due to clock skew), winbindd will fallback to samlogon authentication over MSRPC\. When this parameter is used in conjunction with 63 \fIwinbind refresh tickets\fR, winbind will keep your Ticket Granting Ticket (TGT) uptodate by refreshing it whenever necessary\. 73 64 .RE 74 65 .PP 75 66 krb5_ccache_type=[type] 76 .RS 3n67 .RS 4 77 68 When pam_winbind is configured to try kerberos authentication by enabling the 78 69 \fIkrb5_auth\fR 79 option, it can store the retrieved Ticket Granting Ticket (TGT) in a credential cache . The type of credential cache can be set with this option. Currently the only supported value is:80 \fIFILE\fR . In that case a credential cache in the form of /tmp/krb5cc_UID will be created, where UID is replaced with the numeric user id. Leave empty to just do kerberos authentication without having a ticket cache after the logon has succeeded.70 option, it can store the retrieved Ticket Granting Ticket (TGT) in a credential cache\. The type of credential cache can be set with this option\. Currently the only supported value is: 71 \fIFILE\fR\. In that case a credential cache in the form of /tmp/krb5cc_UID will be created, where UID is replaced with the numeric user id\. Leave empty to just do kerberos authentication without having a ticket cache after the logon has succeeded\. 81 72 .RE 82 73 .PP 83 74 cached_login 84 .RS 3n75 .RS 4 85 76 Winbind allows to logon using cached credentials when 86 77 \fIwinbind offline logon\fR 87 is enabled . To use this feature from the PAM module this option must be set.78 is enabled\. To use this feature from the PAM module this option must be set\. 88 79 .RE 89 80 .PP 90 81 silent 91 .RS 3n92 Do not emit any messages .82 .RS 4 83 Do not emit any messages\. 93 84 .RE 94 95 85 .SH "SEE ALSO" 96 86 .PP … … 100 90 .SH "VERSION" 101 91 .PP 102 This man page is correct for version 3 .0 of Samba.92 This man page is correct for version 3\.0 of Samba\. 103 93 .SH "AUTHOR" 104 94 .PP 105 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.95 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 106 96 .PP 107 This manpage was written by Jelmer Vernooij and Guenther Deschner. 108 97 This manpage was written by Jelmer Vernooij and Guenther Deschner\. -
branches/samba-3.0/docs/manpages/pdbedit.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "PDBEDIT" 8 "" "" "" 1 .\" Title: pdbedit 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "PDBEDIT" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 pdbedit - manage the SAM database (Database of Samba Users) 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 pdbedit [ -L] [-v] [-w] [-u username] [-f fullname] [-h homedir] [-D drive] [-S script] [-p profile] [-a] [-t, --password-from-stdin] [-m] [-r] [-x] [-i passdb-backend] [-e passdb-backend] [-b passdb-backend] [-g] [-d debuglevel] [-s configfile] [-P account-policy] [-C value] [-c account-control] [-y]17 pdbedit [\-L] [\-v] [\-w] [\-u\ username] [\-f\ fullname] [\-h\ homedir] [\-D\ drive] [\-S\ script] [\-p\ profile] [\-a] [\-t,\ \-\-password\-from\-stdin] [\-m] [\-r] [\-x] [\-i\ passdb\-backend] [\-e\ passdb\-backend] [\-b\ passdb\-backend] [\-g] [\-d\ debuglevel] [\-s\ configfile] [\-P\ account\-policy] [\-C\ value] [\-c\ account\-control] [\-y] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .31 .PP 32 The pdbedit program is used to manage the users accounts stored in the sam database and can only be run by root .33 .PP 34 The pdbedit tool uses the passdb modular interface and is independent from the kind of users database used (currently there are smbpasswd, ldap, nis+ and tdb based and more can be added without changing the tool) .35 .PP 36 There are five main ways to use pdbedit: adding a user account, removing a user account, modifing a user account, listing user accounts, importing users accounts .22 suite\. 23 .PP 24 The pdbedit program is used to manage the users accounts stored in the sam database and can only be run by root\. 25 .PP 26 The pdbedit tool uses the passdb modular interface and is independent from the kind of users database used (currently there are smbpasswd, ldap, nis+ and tdb based and more can be added without changing the tool)\. 27 .PP 28 There are five main ways to use pdbedit: adding a user account, removing a user account, modifing a user account, listing user accounts, importing users accounts\. 37 29 .SH "OPTIONS" 38 30 .PP 39 -L 40 .RS 3n 41 This option lists all the user accounts present in the users database. This option prints a list of user/uid pairs separated by the ':' character. 42 .sp 43 Example: 44 pdbedit -L 45 .sp 46 47 .sp 48 49 .nf 50 31 \-L 32 .RS 4 33 This option lists all the user accounts present in the users database\. This option prints a list of user/uid pairs separated by the \':\' character\. 34 .sp 35 Example: 36 pdbedit \-L 37 .sp 38 .sp 39 .RS 4 40 .nf 51 41 sorce:500:Simo Sorce 52 42 samba:45:Test User 53 54 .fi 55 56 .RE 57 .PP 58 -v 59 .RS 3n 60 This option enables the verbose listing format. It causes pdbedit to list the users in the database, printing out the account fields in a descriptive format. 61 .sp 62 Example: 63 pdbedit -L -v 64 .sp 65 66 .sp 67 68 .nf 69 70 --------------- 43 .fi 44 .RE 45 .RE 46 .PP 47 \-v 48 .RS 4 49 This option enables the verbose listing format\. It causes pdbedit to list the users in the database, printing out the account fields in a descriptive format\. 50 .sp 51 Example: 52 pdbedit \-L \-v 53 .sp 54 .sp 55 .RS 4 56 .nf 57 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 71 58 username: sorce 72 59 user ID/Group: 500/500 73 60 user RID/GRID: 2000/2001 74 61 Full Name: Simo Sorce 75 Home Directory: \ \BERSERKER\sorce62 Home Directory: \e\eBERSERKER\esorce 76 63 HomeDir Drive: H: 77 Logon Script: \ \BERSERKER\netlogon\sorce.bat78 Profile Path: \ \BERSERKER\profile79 ---------------64 Logon Script: \e\eBERSERKER\enetlogon\esorce\.bat 65 Profile Path: \e\eBERSERKER\eprofile 66 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 80 67 username: samba 81 68 user ID/Group: 45/45 82 69 user RID/GRID: 1090/1091 83 70 Full Name: Test User 84 Home Directory: \ \BERSERKER\samba71 Home Directory: \e\eBERSERKER\esamba 85 72 HomeDir Drive: 86 73 Logon Script: 87 Profile Path: \\BERSERKER\profile 88 89 .fi 90 91 .RE 92 .PP 93 -w 94 .RS 3n 95 This option sets the "smbpasswd" listing format. It will make pdbedit list the users in the database, printing out the account fields in a format compatible with the 74 Profile Path: \e\eBERSERKER\eprofile 75 .fi 76 .RE 77 .RE 78 .PP 79 \-w 80 .RS 4 81 This option sets the "smbpasswd" listing format\. It will make pdbedit list the users in the database, printing out the account fields in a format compatible with the 96 82 \fIsmbpasswd\fR 97 file format . (see the83 file format\. (see the 98 84 \fBsmbpasswd\fR(5) 99 85 for details) 100 86 .sp 101 87 Example: 102 pdbedit -L-w103 104 . nf105 88 pdbedit \-L \-w 89 .sp 90 .RS 4 91 .nf 106 92 sorce:500:508818B733CE64BEAAD3B435B51404EE: 107 93 D2A2418EFC466A8A0F6B1DBB5C3DB80C: 108 [UX ]:LCT -00000000:94 [UX ]:LCT\-00000000: 109 95 samba:45:0F2B255F7B67A7A9AAD3B435B51404EE: 110 96 BC281CE3F53B6A5146629CD4751D3490: 111 [UX ]:LCT-3BFA1E8D: 97 [UX ]:LCT\-3BFA1E8D: 98 .fi 99 .RE 100 .RE 101 .PP 102 \-u username 103 .RS 4 104 This option specifies the username to be used for the operation requested (listing, adding, removing)\. It is 105 \fIrequired\fR 106 in add, remove and modify operations and 107 \fIoptional\fR 108 in list operations\. 109 .RE 110 .PP 111 \-f fullname 112 .RS 4 113 This option can be used while adding or modifing a user account\. It will specify the user\'s full name\. 114 .sp 115 Example: 116 \-f "Simo Sorce" 117 .RE 118 .PP 119 \-h homedir 120 .RS 4 121 This option can be used while adding or modifing a user account\. It will specify the user\'s home directory network path\. 122 .sp 123 Example: 124 \-h "\e\e\e\eBERSERKER\e\esorce" 125 .RE 126 .PP 127 \-D drive 128 .RS 4 129 This option can be used while adding or modifing a user account\. It will specify the windows drive letter to be used to map the home directory\. 130 .sp 131 Example: 132 \-D "H:" 133 .RE 134 .PP 135 \-S script 136 .RS 4 137 This option can be used while adding or modifing a user account\. It will specify the user\'s logon script path\. 138 .sp 139 Example: 140 \-S "\e\e\e\eBERSERKER\e\enetlogon\e\esorce\.bat" 141 .RE 142 .PP 143 \-p profile 144 .RS 4 145 This option can be used while adding or modifing a user account\. It will specify the user\'s profile directory\. 146 .sp 147 Example: 148 \-p "\e\e\e\eBERSERKER\e\enetlogon" 149 .RE 150 .PP 151 \-G SID|rid 152 .RS 4 153 This option can be used while adding or modifying a user account\. It will specify the users\' new primary group SID (Security Identifier) or rid\. 154 .sp 155 Example: 156 \-G S\-1\-5\-21\-2447931902\-1787058256\-3961074038\-1201 157 .RE 158 .PP 159 \-U SID|rid 160 .RS 4 161 This option can be used while adding or modifying a user account\. It will specify the users\' new SID (Security Identifier) or rid\. 162 .sp 163 Example: 164 \-U S\-1\-5\-21\-2447931902\-1787058256\-3961074038\-5004 165 .RE 166 .PP 167 \-c account\-control 168 .RS 4 169 This option can be used while adding or modifying a user account\. It will specify the users\' account control property\. Possible flags are listed below\. 170 .sp 112 171 113 .fi 114 .RE 115 .PP 116 -u username 117 .RS 3n 118 This option specifies the username to be used for the operation requested (listing, adding, removing). It is 119 \fBrequired\fR 120 in add, remove and modify operations and 121 \fBoptional\fR 122 in list operations. 123 .RE 124 .PP 125 -f fullname 126 .RS 3n 127 This option can be used while adding or modifing a user account. It will specify the user's full name. 128 .sp 129 Example: 130 -f "Simo Sorce" 131 .RE 132 .PP 133 -h homedir 134 .RS 3n 135 This option can be used while adding or modifing a user account. It will specify the user's home directory network path. 136 .sp 137 Example: 138 -h "\\\\\\\\BERSERKER\\\\sorce" 139 .RE 140 .PP 141 -D drive 142 .RS 3n 143 This option can be used while adding or modifing a user account. It will specify the windows drive letter to be used to map the home directory. 144 .sp 145 Example: 146 -D "H:" 147 .RE 148 .PP 149 -S script 150 .RS 3n 151 This option can be used while adding or modifing a user account. It will specify the user's logon script path. 152 .sp 153 Example: 154 -S "\\\\\\\\BERSERKER\\\\netlogon\\\\sorce.bat" 155 .RE 156 .PP 157 -p profile 158 .RS 3n 159 This option can be used while adding or modifing a user account. It will specify the user's profile directory. 160 .sp 161 Example: 162 -p "\\\\\\\\BERSERKER\\\\netlogon" 163 .RE 164 .PP 165 -G SID|rid 166 .RS 3n 167 This option can be used while adding or modifying a user account. It will specify the users' new primary group SID (Security Identifier) or rid. 168 .sp 169 Example: 170 -G S-1-5-21-2447931902-1787058256-3961074038-1201 171 .RE 172 .PP 173 -U SID|rid 174 .RS 3n 175 This option can be used while adding or modifying a user account. It will specify the users' new SID (Security Identifier) or rid. 176 .sp 177 Example: 178 -U S-1-5-21-2447931902-1787058256-3961074038-5004 179 .RE 180 .PP 181 -c account-control 182 .RS 3n 183 This option can be used while adding or modifying a user account. It will specify the users' account control property. Possible flags are listed below. 184 .sp 185 186 .RS 3n 187 .TP 3n 188 \(bu 172 .sp 173 .RS 4 174 .ie n \{\ 175 \h'-04'\(bu\h'+03'\c 176 .\} 177 .el \{\ 178 .sp -1 179 .IP \(bu 2.3 180 .\} 189 181 N: No password required 190 .TP 3n 191 \(bu 182 .RE 183 .sp 184 .RS 4 185 .ie n \{\ 186 \h'-04'\(bu\h'+03'\c 187 .\} 188 .el \{\ 189 .sp -1 190 .IP \(bu 2.3 191 .\} 192 192 D: Account disabled 193 .TP 3n 194 \(bu 193 .RE 194 .sp 195 .RS 4 196 .ie n \{\ 197 \h'-04'\(bu\h'+03'\c 198 .\} 199 .el \{\ 200 .sp -1 201 .IP \(bu 2.3 202 .\} 195 203 H: Home directory required 196 .TP 3n 197 \(bu 204 .RE 205 .sp 206 .RS 4 207 .ie n \{\ 208 \h'-04'\(bu\h'+03'\c 209 .\} 210 .el \{\ 211 .sp -1 212 .IP \(bu 2.3 213 .\} 198 214 T: Temporary duplicate of other account 199 .TP 3n 200 \(bu 215 .RE 216 .sp 217 .RS 4 218 .ie n \{\ 219 \h'-04'\(bu\h'+03'\c 220 .\} 221 .el \{\ 222 .sp -1 223 .IP \(bu 2.3 224 .\} 201 225 U: Regular user account 202 .TP 3n 203 \(bu 226 .RE 227 .sp 228 .RS 4 229 .ie n \{\ 230 \h'-04'\(bu\h'+03'\c 231 .\} 232 .el \{\ 233 .sp -1 234 .IP \(bu 2.3 235 .\} 204 236 M: MNS logon user account 205 .TP 3n 206 \(bu 237 .RE 238 .sp 239 .RS 4 240 .ie n \{\ 241 \h'-04'\(bu\h'+03'\c 242 .\} 243 .el \{\ 244 .sp -1 245 .IP \(bu 2.3 246 .\} 207 247 W: Workstation Trust Account 208 .TP 3n 209 \(bu 248 .RE 249 .sp 250 .RS 4 251 .ie n \{\ 252 \h'-04'\(bu\h'+03'\c 253 .\} 254 .el \{\ 255 .sp -1 256 .IP \(bu 2.3 257 .\} 210 258 S: Server Trust Account 211 .TP 3n 212 \(bu 259 .RE 260 .sp 261 .RS 4 262 .ie n \{\ 263 \h'-04'\(bu\h'+03'\c 264 .\} 265 .el \{\ 266 .sp -1 267 .IP \(bu 2.3 268 .\} 213 269 L: Automatic Locking 214 .TP 3n 215 \(bu 270 .RE 271 .sp 272 .RS 4 273 .ie n \{\ 274 \h'-04'\(bu\h'+03'\c 275 .\} 276 .el \{\ 277 .sp -1 278 .IP \(bu 2.3 279 .\} 216 280 X: Password does not expire 217 .TP 3n 218 \(bu 281 .RE 282 .sp 283 .RS 4 284 .ie n \{\ 285 \h'-04'\(bu\h'+03'\c 286 .\} 287 .el \{\ 288 .sp -1 289 .IP \(bu 2.3 290 .\} 219 291 I: Domain Trust Account 220 .RE 221 .IP "" 3n 222 223 .sp 224 Example: 225 -c "[X ]" 226 .RE 227 .PP 228 -a 229 .RS 3n 230 This option is used to add a user into the database. This command needs a user name specified with the -u switch. When adding a new user, pdbedit will also ask for the password to be used. 231 .sp 232 Example: 233 pdbedit -a -u sorce 234 235 .sp 236 292 .sp 293 .RE 294 .sp 295 Example: 296 \-c "[X ]" 297 .RE 298 .PP 299 \-a 300 .RS 4 301 This option is used to add a user into the database\. This command needs a user name specified with the \-u switch\. When adding a new user, pdbedit will also ask for the password to be used\. 302 .sp 303 Example: 304 pdbedit \-a \-u sorce 305 .sp 306 .RS 4 237 307 .nf 238 308 new password: 239 309 retype new password 240 241 . fi242 310 .fi 311 .RE 312 .sp 243 313 .sp 244 314 .it 1 an-trap … … 246 316 .nr an-break-flag 1 247 317 .br 248 \fBNote\fR 318 Note 249 319 pdbedit does not call the unix password syncronisation script if 250 unix password sync has been set. It only updates the data in the Samba user database. 320 \fIunix password sync\fR 321 has been set\. It only updates the data in the Samba user database\. 251 322 .sp 252 323 If you wish to add a user and synchronise the password that immediately, use 253 smbpasswd 's254 \fB -a\fR255 option .256 .RE 257 .PP 258 -t, --password-from-stdin259 .RS 3n324 smbpasswd\'s 325 \fB\-a\fR 326 option\. 327 .RE 328 .PP 329 \-t, \-\-password\-from\-stdin 330 .RS 4 260 331 This option causes pdbedit to read the password from standard input, rather than from /dev/tty (like the 261 332 passwd(1) 262 program does) . The password has to be submitted twice and terminated by a newline each.263 .RE 264 .PP 265 -r266 .RS 3n267 This option is used to modify an existing user in the database . This command needs a user name specified with the -u switch. Other options can be specified to modify the properties of the specified user. This flag is kept for backwards compatibility, but it is no longer necessary to specify it.268 .RE 269 .PP 270 -m271 .RS 3n333 program does)\. The password has to be submitted twice and terminated by a newline each\. 334 .RE 335 .PP 336 \-r 337 .RS 4 338 This option is used to modify an existing user in the database\. This command needs a user name specified with the \-u switch\. Other options can be specified to modify the properties of the specified user\. This flag is kept for backwards compatibility, but it is no longer necessary to specify it\. 339 .RE 340 .PP 341 \-m 342 .RS 4 272 343 This option may only be used in conjunction with the 273 \fI -a\fR274 option . It will make pdbedit to add a machine trust account instead of a user account (-u username will provide the machine name).275 .sp 276 Example: 277 pdbedit -a -m -u w2k-wks278 .RE 279 .PP 280 -x281 .RS 3n282 This option causes pdbedit to delete an account from the database . It needs a username specified with the -u switch.283 .sp 284 Example: 285 pdbedit -x-u bob286 .RE 287 .PP 288 -i passdb-backend289 .RS 3n290 Use a different passdb backend to retrieve users than the one specified in smb .conf. Can be used to import data into your local user database.291 .sp 292 This option will ease migration from one passdb backend to another .293 .sp 294 Example: 295 pdbedit -i smbpasswd:/etc/smbpasswd.old296 .RE 297 .PP 298 -e passdb-backend299 .RS 3n300 Exports all currently available users to the specified password database backend .301 .sp 302 This option will ease migration from one passdb backend to another and will ease backing up .303 .sp 304 Example: 305 pdbedit -e smbpasswd:/root/samba-users.backup306 .RE 307 .PP 308 -g309 .RS 3n344 \fI\-a\fR 345 option\. It will make pdbedit to add a machine trust account instead of a user account (\-u username will provide the machine name)\. 346 .sp 347 Example: 348 pdbedit \-a \-m \-u w2k\-wks 349 .RE 350 .PP 351 \-x 352 .RS 4 353 This option causes pdbedit to delete an account from the database\. It needs a username specified with the \-u switch\. 354 .sp 355 Example: 356 pdbedit \-x \-u bob 357 .RE 358 .PP 359 \-i passdb\-backend 360 .RS 4 361 Use a different passdb backend to retrieve users than the one specified in smb\.conf\. Can be used to import data into your local user database\. 362 .sp 363 This option will ease migration from one passdb backend to another\. 364 .sp 365 Example: 366 pdbedit \-i smbpasswd:/etc/smbpasswd\.old 367 .RE 368 .PP 369 \-e passdb\-backend 370 .RS 4 371 Exports all currently available users to the specified password database backend\. 372 .sp 373 This option will ease migration from one passdb backend to another and will ease backing up\. 374 .sp 375 Example: 376 pdbedit \-e smbpasswd:/root/samba\-users\.backup 377 .RE 378 .PP 379 \-g 380 .RS 4 310 381 If you specify 311 \fI -g\fR, then312 \fI -i in-backend -e out-backend\fR313 applies to the group mapping instead of the user database .314 .sp 315 This option will ease migration from one passdb backend to another and will ease backing up .316 .RE 317 .PP 318 -b passdb-backend319 .RS 3n320 Use a different default passdb backend .321 .sp 322 Example: 323 pdbedit -b xml:/root/pdb-backup.xml-l324 .RE 325 .PP 326 -P account-policy327 .RS 3n382 \fI\-g\fR, then 383 \fI\-i in\-backend \-e out\-backend\fR 384 applies to the group mapping instead of the user database\. 385 .sp 386 This option will ease migration from one passdb backend to another and will ease backing up\. 387 .RE 388 .PP 389 \-b passdb\-backend 390 .RS 4 391 Use a different default passdb backend\. 392 .sp 393 Example: 394 pdbedit \-b xml:/root/pdb\-backup\.xml \-l 395 .RE 396 .PP 397 \-P account\-policy 398 .RS 4 328 399 Display an account policy 329 400 .sp 330 Valid policies are: minimum password age, reset count minutes, disconnect time, user must logon to change password, password history, lockout duration, min password length, maximum password age and bad lockout attempt. 331 .sp 332 Example: 333 pdbedit -P "bad lockout attempt" 334 .sp 335 336 .sp 337 338 .nf 339 401 Valid policies are: minimum password age, reset count minutes, disconnect time, user must logon to change password, password history, lockout duration, min password length, maximum password age and bad lockout attempt\. 402 .sp 403 Example: 404 pdbedit \-P "bad lockout attempt" 405 .sp 406 .sp 407 .RS 4 408 .nf 340 409 account policy value for bad lockout attempt is 0 341 342 .fi 343 344 .RE 345 .PP 346 -C account-policy-value 347 .RS 3n 348 Sets an account policy to a specified value. This option may only be used in conjunction with the 349 \fI-P\fR 350 option. 351 .sp 352 Example: 353 pdbedit -P "bad lockout attempt" -C 3 354 .sp 355 356 .sp 357 358 .nf 359 410 .fi 411 .RE 412 .RE 413 .PP 414 \-C account\-policy\-value 415 .RS 4 416 Sets an account policy to a specified value\. This option may only be used in conjunction with the 417 \fI\-P\fR 418 option\. 419 .sp 420 Example: 421 pdbedit \-P "bad lockout attempt" \-C 3 422 .sp 423 .sp 424 .RS 4 425 .nf 360 426 account policy value for bad lockout attempt was 0 361 427 account policy value for bad lockout attempt is now 3 362 363 .fi 364 365 .RE 366 .PP 367 -y 368 .RS 3n 428 .fi 429 .RE 430 .RE 431 .PP 432 \-y 433 .RS 4 369 434 If you specify 370 \fI-y\fR, then 371 \fI-i in-backend -e out-backend\fR 372 applies to the account policies instead of the user database. 373 .sp 374 This option will allow to migrate account policies from their default tdb-store into a passdb backend, e.g. an LDAP directory server. 375 .sp 376 Example: 377 pdbedit -y -i tdbsam: -e ldapsam:ldap://my.ldap.host 378 .RE 379 .PP 380 -h|--help 381 .RS 3n 382 Print a summary of command line options. 383 .RE 384 .PP 385 -V 386 .RS 3n 387 Prints the program version number. 388 .RE 389 .PP 390 -s <configuration file> 391 .RS 3n 392 The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See 393 \fIsmb.conf\fR 394 for more information. The default configuration file name is determined at compile time. 395 .RE 396 .PP 397 -d|--debuglevel=level 398 .RS 3n 435 \fI\-y\fR, then 436 \fI\-i in\-backend \-e out\-backend\fR 437 applies to the account policies instead of the user database\. 438 .sp 439 This option will allow to migrate account policies from their default tdb\-store into a passdb backend, e\.g\. an LDAP directory server\. 440 .sp 441 Example: 442 pdbedit \-y \-i tdbsam: \-e ldapsam:ldap://my\.ldap\.host 443 .RE 444 .PP 445 \-h|\-\-help 446 .RS 4 447 Print a summary of command line options\. 448 .RE 449 .PP 450 \-d|\-\-debuglevel=level 451 .RS 4 399 452 \fIlevel\fR 400 is an integer from 0 to 10 . The default value if this parameter is not specified is zero.401 .sp 402 The higher this value, the more detail will be logged to the log files about the activities of the server . At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out.403 .sp 404 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem . Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic.453 is an integer from 0 to 10\. The default value if this parameter is not specified is 0\. 454 .sp 455 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 456 .sp 457 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 405 458 .sp 406 459 Note that specifying this parameter here will override the 407 460 \fIlog level\fR 408 461 parameter in the 409 \fIsmb.conf\fR 410 file. 411 .RE 412 .PP 413 -l|--logfile=logdirectory 414 .RS 3n 415 Base directory name for log/debug files. The extension 416 \fB".progname"\fR 417 will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client. 462 \fIsmb\.conf\fR 463 file\. 464 .RE 465 .PP 466 \-V 467 .RS 4 468 Prints the program version number\. 469 .RE 470 .PP 471 \-s <configuration file> 472 .RS 4 473 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 474 \fIsmb\.conf\fR 475 for more information\. The default configuration file name is determined at compile time\. 476 .RE 477 .PP 478 \-l|\-\-log\-basename=logdirectory 479 .RS 4 480 Base directory name for log/debug files\. The extension 481 \fB"\.progname"\fR 482 will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\. 418 483 .RE 419 484 .SH "NOTES" 420 485 .PP 421 This command may be used only by root .486 This command may be used only by root\. 422 487 .SH "VERSION" 423 488 .PP 424 This man page is correct for version 3 .0 of the Samba suite.489 This man page is correct for version 3\.0 of the Samba suite\. 425 490 .SH "SEE ALSO" 426 491 .PP … … 429 494 .SH "AUTHOR" 430 495 .PP 431 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 432 .PP 433 The pdbedit manpage was written by Simo Sorce and Jelmer Vernooij. 434 496 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 497 .PP 498 The pdbedit manpage was written by Simo Sorce and Jelmer Vernooij\. -
branches/samba-3.0/docs/manpages/profiles.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "PROFILES" 1 "" "" "" 1 .\" Title: profiles 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "PROFILES" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 profiles - A utility to report and change SIDs in registry files 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 profiles [ -v] [-c SID] [-nSID] {file}17 profiles [\-v] [\-c\ SID] [\-n\ SID] {file} 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 profiles 33 is a utility that reports and changes SIDs in windows registry files . It currently only supports NT.25 is a utility that reports and changes SIDs in windows registry files\. It currently only supports NT\. 34 26 .SH "OPTIONS" 35 27 .PP 36 28 file 37 .RS 3n38 Registry file to view or edit .29 .RS 4 30 Registry file to view or edit\. 39 31 .RE 40 32 .PP 41 -v,--verbose42 .RS 3n43 Increases verbosity of messages .33 \-v,\-\-verbose 34 .RS 4 35 Increases verbosity of messages\. 44 36 .RE 45 37 .PP 46 -c SID1-n SID247 .RS 3n38 \-c SID1 \-n SID2 39 .RS 4 48 40 Change all occurences of SID1 in 49 41 \fIfile\fR 50 by SID2 .42 by SID2\. 51 43 .RE 52 44 .PP 53 -h|--help54 .RS 3n55 Print a summary of command line options .45 \-h|\-\-help 46 .RS 4 47 Print a summary of command line options\. 56 48 .RE 57 49 .SH "VERSION" 58 50 .PP 59 This man page is correct for version 3 .0 of the Samba suite.51 This man page is correct for version 3\.0 of the Samba suite\. 60 52 .SH "AUTHOR" 61 53 .PP 62 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.54 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 63 55 .PP 64 The profiles man page was written by Jelmer Vernooij. 65 56 The profiles man page was written by Jelmer Vernooij\. -
branches/samba-3.0/docs/manpages/rpcclient.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "RPCCLIENT" 1 "" "" "" 1 .\" Title: rpcclient 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "RPCCLIENT" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 rpcclient - tool for executing client side MS-RPC functions 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 rpcclient [ -A authfile] [-c <command string>] [-d debuglevel] [-h] [-l logdir] [-N] [-s <smb config file>] [-U username[%password]] [-W workgroup] [-N] [-IdestinationIP] {server}17 rpcclient [\-A\ authfile] [\-c\ <command\ string>] [\-d\ debuglevel] [\-h] [\-l\ logdir] [\-N] [\-s\ <smb\ config\ file>] [\-U\ username[%password]] [\-W\ workgroup] [\-N] [\-I\ destinationIP] {server} 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 rpcclient 33 is a utility initially developed to test MS -RPC functionality in Samba itself. It has undergone several stages of development and stability. Many system administrators have now written scripts around it to manage Windows NT clients from their UNIX workstation.25 is a utility initially developed to test MS\-RPC functionality in Samba itself\. It has undergone several stages of development and stability\. Many system administrators have now written scripts around it to manage Windows NT clients from their UNIX workstation\. 34 26 .SH "OPTIONS" 35 27 .PP 36 28 server 37 .RS 3n 38 NetBIOS name of Server to which to connect. The server can be any SMB/CIFS server. The name is resolved using the 39 name resolve order line from 40 \fBsmb.conf\fR(5). 41 .RE 42 .PP 43 -c|--command='command string' 44 .RS 3n 29 .RS 4 30 NetBIOS name of Server to which to connect\. The server can be any SMB/CIFS server\. The name is resolved using the 31 \fIname resolve order\fR 32 line from 33 \fBsmb.conf\fR(5)\. 34 .RE 35 .PP 36 \-c|\-\-command=\'command string\' 37 .RS 4 45 38 execute semicolon separated commands (listed below)) 46 39 .RE 47 40 .PP 48 -I IP-address49 .RS 3n41 \-I IP\-address 42 .RS 4 50 43 \fIIP address\fR 51 is the address of the server to connect to . It should be specified in standard "a.b.c.d" notation.44 is the address of the server to connect to\. It should be specified in standard "a\.b\.c\.d" notation\. 52 45 .sp 53 46 Normally the client would attempt to locate a named SMB/CIFS server by looking it up via the NetBIOS name resolution mechanism described above in the 54 47 \fIname resolve order\fR 55 parameter above. Using this parameter will force the client to assume that the server is on the machine with the specified IP address and the NetBIOS name component of the resource being connected to will be ignored. 56 .sp 57 There is no default for this parameter. If not supplied, it will be determined automatically by the client as described above. 58 .RE 59 .PP 60 -V 61 .RS 3n 62 Prints the program version number. 63 .RE 64 .PP 65 -s <configuration file> 66 .RS 3n 67 The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See 68 \fIsmb.conf\fR 69 for more information. The default configuration file name is determined at compile time. 70 .RE 71 .PP 72 -d|--debuglevel=level 73 .RS 3n 48 parameter above\. Using this parameter will force the client to assume that the server is on the machine with the specified IP address and the NetBIOS name component of the resource being connected to will be ignored\. 49 .sp 50 There is no default for this parameter\. If not supplied, it will be determined automatically by the client as described above\. 51 .RE 52 .PP 53 \-d|\-\-debuglevel=level 54 .RS 4 74 55 \fIlevel\fR 75 is an integer from 0 to 10 . The default value if this parameter is not specified is zero.76 .sp 77 The higher this value, the more detail will be logged to the log files about the activities of the server . At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out.78 .sp 79 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem . Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic.56 is an integer from 0 to 10\. The default value if this parameter is not specified is 0\. 57 .sp 58 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 59 .sp 60 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 80 61 .sp 81 62 Note that specifying this parameter here will override the 82 63 \fIlog level\fR 83 64 parameter in the 84 \fIsmb.conf\fR 85 file. 86 .RE 87 .PP 88 -l|--logfile=logdirectory 89 .RS 3n 90 Base directory name for log/debug files. The extension 91 \fB".progname"\fR 92 will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client. 93 .RE 94 .PP 95 -N 96 .RS 3n 97 If specified, this parameter suppresses the normal password prompt from the client to the user. This is useful when accessing a service that does not require a password. 98 .sp 99 Unless a password is specified on the command line or this parameter is specified, the client will request a password. 100 .sp 101 If a password is specified on the command line and this option is also defined the password on the command line will be silently ingnored and no password will be used. 102 .RE 103 .PP 104 -k 105 .RS 3n 106 Try to authenticate with kerberos. Only useful in an Active Directory environment. 107 .RE 108 .PP 109 -A|--authentication-file=filename 110 .RS 3n 111 This option allows you to specify a file from which to read the username and password used in the connection. The format of the file is 112 .sp 113 114 .sp 115 65 \fIsmb\.conf\fR 66 file\. 67 .RE 68 .PP 69 \-V 70 .RS 4 71 Prints the program version number\. 72 .RE 73 .PP 74 \-s <configuration file> 75 .RS 4 76 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 77 \fIsmb\.conf\fR 78 for more information\. The default configuration file name is determined at compile time\. 79 .RE 80 .PP 81 \-l|\-\-log\-basename=logdirectory 82 .RS 4 83 Base directory name for log/debug files\. The extension 84 \fB"\.progname"\fR 85 will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\. 86 .RE 87 .PP 88 \-N 89 .RS 4 90 If specified, this parameter suppresses the normal password prompt from the client to the user\. This is useful when accessing a service that does not require a password\. 91 .sp 92 Unless a password is specified on the command line or this parameter is specified, the client will request a password\. 93 .sp 94 If a password is specified on the command line and this option is also defined the password on the command line will be silently ingnored and no password will be used\. 95 .RE 96 .PP 97 \-k 98 .RS 4 99 Try to authenticate with kerberos\. Only useful in an Active Directory environment\. 100 .RE 101 .PP 102 \-A|\-\-authentication\-file=filename 103 .RS 4 104 This option allows you to specify a file from which to read the username and password used in the connection\. The format of the file is 105 .sp 106 .sp 107 .RS 4 116 108 .nf 117 118 109 username = <value> 119 110 password = <value> 120 111 domain = <value> 121 122 112 .fi 123 124 .sp 125 Make certain that the permissions on the file restrict access from unwanted users .126 .RE 127 .PP 128 -U|--user=username[%password]129 .RS 3n130 Sets the SMB username or username and password .131 .sp 132 If %password is not specified, the user will be prompted . The client will first check the113 .RE 114 .sp 115 Make certain that the permissions on the file restrict access from unwanted users\. 116 .RE 117 .PP 118 \-U|\-\-user=username[%password] 119 .RS 4 120 Sets the SMB username or username and password\. 121 .sp 122 If %password is not specified, the user will be prompted\. The client will first check the 133 123 \fBUSER\fR 134 124 environment variable, then the 135 125 \fBLOGNAME\fR 136 variable and if either exists, the string is uppercased . If these environmental variables are not found, the username126 variable and if either exists, the string is uppercased\. If these environmental variables are not found, the username 137 127 \fBGUEST\fR 138 is used .139 .sp 140 A third option is to use a credentials file which contains the plaintext of the username and password . This option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables. If this method is used, make certain that the permissions on the file restrict access from unwanted users. See the141 \fI -A\fR142 for more details .143 .sp 144 Be cautious about including passwords in scripts . Also, on many systems the command line of a running process may be seen via the128 is used\. 129 .sp 130 A third option is to use a credentials file which contains the plaintext of the username and password\. This option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables\. If this method is used, make certain that the permissions on the file restrict access from unwanted users\. See the 131 \fI\-A\fR 132 for more details\. 133 .sp 134 Be cautious about including passwords in scripts\. Also, on many systems the command line of a running process may be seen via the 145 135 ps 146 command . To be safe always allow136 command\. To be safe always allow 147 137 rpcclient 148 to prompt for a password and type it in directly .149 .RE 150 .PP 151 -n <primary NetBIOS name>152 .RS 3n153 This option allows you to override the NetBIOS name that Samba uses for itself . This is identical to setting the154 138 to prompt for a password and type it in directly\. 139 .RE 140 .PP 141 \-n <primary NetBIOS name> 142 .RS 4 143 This option allows you to override the NetBIOS name that Samba uses for itself\. This is identical to setting the 144 \fInetbios name\fR 155 145 parameter in the 156 \fIsmb .conf\fR157 file . However, a command line setting will take precedence over settings in158 \fIsmb .conf\fR.159 .RE 160 .PP 161 -i <scope>162 .RS 3n146 \fIsmb\.conf\fR 147 file\. However, a command line setting will take precedence over settings in 148 \fIsmb\.conf\fR\. 149 .RE 150 .PP 151 \-i <scope> 152 .RS 4 163 153 This specifies a NetBIOS scope that 164 154 nmblookup 165 will use to communicate with when generating NetBIOS names . For details on the use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are166 \f Bvery\fR167 rarely used, only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with .168 .RE 169 .PP 170 -W|--workgroup=domain171 .RS 3n172 Set the SMB domain of the username . This overrides the default domain which is the domain defined in smb.conf. If the domain specified is the same as the servers NetBIOS name, it causes the client to log on using the servers local SAM (as opposed to the Domain SAM).173 .RE 174 .PP 175 -O socket options176 .RS 3n177 TCP socket options to set on the client socket . See the socket options parameter in the178 \fIsmb .conf\fR179 manual page for the list of valid options .180 .RE 181 .PP 182 -h|--help183 .RS 3n184 Print a summary of command line options .155 will use to communicate with when generating NetBIOS names\. For details on the use of NetBIOS scopes, see rfc1001\.txt and rfc1002\.txt\. NetBIOS scopes are 156 \fIvery\fR 157 rarely used, only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with\. 158 .RE 159 .PP 160 \-W|\-\-workgroup=domain 161 .RS 4 162 Set the SMB domain of the username\. This overrides the default domain which is the domain defined in smb\.conf\. If the domain specified is the same as the servers NetBIOS name, it causes the client to log on using the servers local SAM (as opposed to the Domain SAM)\. 163 .RE 164 .PP 165 \-O socket options 166 .RS 4 167 TCP socket options to set on the client socket\. See the socket options parameter in the 168 \fIsmb\.conf\fR 169 manual page for the list of valid options\. 170 .RE 171 .PP 172 \-h|\-\-help 173 .RS 4 174 Print a summary of command line options\. 185 175 .RE 186 176 .SH "COMMANDS" … … 188 178 .PP 189 179 lsaquery 190 .RS 3n180 .RS 4 191 181 Query info policy 192 182 .RE 193 183 .PP 194 184 lookupsids 195 .RS 3n196 Resolve a list of SIDs to usernames .185 .RS 4 186 Resolve a list of SIDs to usernames\. 197 187 .RE 198 188 .PP 199 189 lookupnames 200 .RS 3n201 Resolve a list of usernames to SIDs .190 .RS 4 191 Resolve a list of usernames to SIDs\. 202 192 .RE 203 193 .PP 204 194 enumtrusts 205 .RS 3n195 .RS 4 206 196 Enumerate trusted domains 207 197 .RE 208 198 .PP 209 199 enumprivs 210 .RS 3n200 .RS 4 211 201 Enumerate privileges 212 202 .RE 213 203 .PP 214 204 getdispname 215 .RS 3n205 .RS 4 216 206 Get the privilege name 217 207 .RE 218 208 .PP 219 209 lsaenumsid 220 .RS 3n210 .RS 4 221 211 Enumerate the LSA SIDS 222 212 .RE 223 213 .PP 224 214 lsaenumprivsaccount 225 .RS 3n215 .RS 4 226 216 Enumerate the privileges of an SID 227 217 .RE 228 218 .PP 229 219 lsaenumacctrights 230 .RS 3n220 .RS 4 231 221 Enumerate the rights of an SID 232 222 .RE 233 223 .PP 234 224 lsaenumacctwithright 235 .RS 3n225 .RS 4 236 226 Enumerate accounts with a right 237 227 .RE 238 228 .PP 239 229 lsaaddacctrights 240 .RS 3n230 .RS 4 241 231 Add rights to an account 242 232 .RE 243 233 .PP 244 234 lsaremoveacctrights 245 .RS 3n235 .RS 4 246 236 Remove rights from an account 247 237 .RE 248 238 .PP 249 239 lsalookupprivvalue 250 .RS 3n240 .RS 4 251 241 Get a privilege value given its name 252 242 .RE 253 243 .PP 254 244 lsaquerysecobj 255 .RS 3n245 .RS 4 256 246 Query LSA security object 257 247 .RE 258 .SS "LSARPC -DS"248 .SS "LSARPC\-DS" 259 249 .PP 260 250 dsroledominfo 261 .RS 3n251 .RS 4 262 252 Get Primary Domain Information 263 253 .RE 264 254 .PP 265 266 .PP 267 \fBDFS\fR 255 .PP 256 \fIDFS\fR 268 257 .PP 269 258 dfsexist 270 .RS 3n259 .RS 4 271 260 Query DFS support 272 261 .RE 273 262 .PP 274 263 dfsadd 275 .RS 3n264 .RS 4 276 265 Add a DFS share 277 266 .RE 278 267 .PP 279 268 dfsremove 280 .RS 3n269 .RS 4 281 270 Remove a DFS share 282 271 .RE 283 272 .PP 284 273 dfsgetinfo 285 .RS 3n274 .RS 4 286 275 Query DFS share info 287 276 .RE 288 277 .PP 289 278 dfsenum 290 .RS 3n279 .RS 4 291 280 Enumerate dfs shares 292 281 .RE … … 294 283 .PP 295 284 shutdown 296 .RS 3n285 .RS 4 297 286 Remote Shutdown 298 287 .RE 299 288 .PP 300 289 abortshutdown 301 .RS 3n290 .RS 4 302 291 Abort Shutdown 303 292 .RE … … 305 294 .PP 306 295 srvinfo 307 .RS 3n296 .RS 4 308 297 Server query info 309 298 .RE 310 299 .PP 311 300 netshareenum 312 .RS 3n301 .RS 4 313 302 Enumerate shares 314 303 .RE 315 304 .PP 316 305 netfileenum 317 .RS 3n306 .RS 4 318 307 Enumerate open files 319 308 .RE 320 309 .PP 321 310 netremotetod 322 .RS 3n311 .RS 4 323 312 Fetch remote time of day 324 313 .RE … … 326 315 .PP 327 316 queryuser 328 .RS 3n317 .RS 4 329 318 Query user info 330 319 .RE 331 320 .PP 332 321 querygroup 333 .RS 3n322 .RS 4 334 323 Query group info 335 324 .RE 336 325 .PP 337 326 queryusergroups 338 .RS 3n327 .RS 4 339 328 Query user groups 340 329 .RE 341 330 .PP 342 331 querygroupmem 343 .RS 3n332 .RS 4 344 333 Query group membership 345 334 .RE 346 335 .PP 347 336 queryaliasmem 348 .RS 3n337 .RS 4 349 338 Query alias membership 350 339 .RE 351 340 .PP 352 341 querydispinfo 353 .RS 3n342 .RS 4 354 343 Query display info 355 344 .RE 356 345 .PP 357 346 querydominfo 358 .RS 3n347 .RS 4 359 348 Query domain info 360 349 .RE 361 350 .PP 362 351 enumdomusers 363 .RS 3n352 .RS 4 364 353 Enumerate domain users 365 354 .RE 366 355 .PP 367 356 enumdomgroups 368 .RS 3n357 .RS 4 369 358 Enumerate domain groups 370 359 .RE 371 360 .PP 372 361 enumalsgroups 373 .RS 3n362 .RS 4 374 363 Enumerate alias groups 375 364 .RE 376 365 .PP 377 366 createdomuser 378 .RS 3n367 .RS 4 379 368 Create domain user 380 369 .RE 381 370 .PP 382 371 samlookupnames 383 .RS 3n372 .RS 4 384 373 Look up names 385 374 .RE 386 375 .PP 387 376 samlookuprids 388 .RS 3n377 .RS 4 389 378 Look up names 390 379 .RE 391 380 .PP 392 381 deletedomuser 393 .RS 3n382 .RS 4 394 383 Delete domain user 395 384 .RE 396 385 .PP 397 386 samquerysecobj 398 .RS 3n387 .RS 4 399 388 Query SAMR security object 400 389 .RE 401 390 .PP 402 391 getdompwinfo 403 .RS 3n392 .RS 4 404 393 Retrieve domain password info 405 394 .RE 406 395 .PP 407 396 lookupdomain 408 .RS 3n397 .RS 4 409 398 Look up domain 410 399 .RE … … 412 401 .PP 413 402 adddriver <arch> <config> [<version>] 414 .RS 3n415 Execute an AddPrinterDriver() RPC to install the printer driver information on the server . Note that the driver files should already exist in the directory returned by416 getdriverdir . Possible values for403 .RS 4 404 Execute an AddPrinterDriver() RPC to install the printer driver information on the server\. Note that the driver files should already exist in the directory returned by 405 getdriverdir\. Possible values for 417 406 \fIarch\fR 418 407 are the same as those for the 419 408 getdriverdir 420 command . The409 command\. The 421 410 \fIconfig\fR 422 411 parameter is defined as follows: 423 412 .sp 424 425 .sp 426 413 .sp 414 .RS 4 427 415 .nf 428 429 Long Printer Name:\ 430 Driver File Name:\ 431 Data File Name:\ 432 Config File Name:\ 433 Help File Name:\ 434 Language Monitor Name:\ 435 Default Data Type:\ 416 Long Printer Name:\e 417 Driver File Name:\e 418 Data File Name:\e 419 Config File Name:\e 420 Help File Name:\e 421 Language Monitor Name:\e 422 Default Data Type:\e 436 423 Comma Separated list of Files 437 438 424 .fi 439 440 .sp 441 Any empty fields should be enter as the string "NULL" .442 .sp 443 Samba does not need to support the concept of Print Monitors since these only apply to local printers whose driver can make use of a bi -directional link for communication. This field should be "NULL". On a remote NT print server, the Print Monitor for a driver must already be installed prior to adding the driver or else the RPC will fail.425 .RE 426 .sp 427 Any empty fields should be enter as the string "NULL"\. 428 .sp 429 Samba does not need to support the concept of Print Monitors since these only apply to local printers whose driver can make use of a bi\-directional link for communication\. This field should be "NULL"\. On a remote NT print server, the Print Monitor for a driver must already be installed prior to adding the driver or else the RPC will fail\. 444 430 .sp 445 431 The 446 432 \fIversion\fR 447 parameter lets you specify the printer driver version number . If omitted, the default driver version for the specified architecture will be used. This option can be used to upload Windows 2000 (version 3) printer drivers.433 parameter lets you specify the printer driver version number\. If omitted, the default driver version for the specified architecture will be used\. This option can be used to upload Windows 2000 (version 3) printer drivers\. 448 434 .RE 449 435 .PP 450 436 addprinter <printername> <sharename> <drivername> <port> 451 .RS 3n452 Add a printer on the remote server . This printer will be automatically shared. Be aware that the printer driver must already be installed on the server (see437 .RS 4 438 Add a printer on the remote server\. This printer will be automatically shared\. Be aware that the printer driver must already be installed on the server (see 453 439 adddriver) and the 454 440 \fIport\fRmust be a valid port name (see 455 enumports .441 enumports\. 456 442 .RE 457 443 .PP 458 444 deldriver 459 .RS 3n460 Delete the specified printer driver for all architectures . This does not delete the actual driver files from the server, only the entry from the server's list of drivers.445 .RS 4 446 Delete the specified printer driver for all architectures\. This does not delete the actual driver files from the server, only the entry from the server\'s list of drivers\. 461 447 .RE 462 448 .PP 463 449 deldriverex <driver> [architecture] [version] 464 .RS 3n465 Delete the specified printer driver including driver files . You can limit this action to a specific architecture and a specific version. If no architecure is given, all driver files of that driver will be deleted.450 .RS 4 451 Delete the specified printer driver including driver files\. You can limit this action to a specific architecture and a specific version\. If no architecure is given, all driver files of that driver will be deleted\. 466 452 .RE 467 453 .PP 468 454 enumdata 469 .RS 3n470 Enumerate all printer setting data stored on the server . On Windows NT clients, these values are stored in the registry, while Samba servers store them in the printers TDB. This command corresponds to the MS Platform SDK GetPrinterData() function (* This command is currently unimplemented).455 .RS 4 456 Enumerate all printer setting data stored on the server\. On Windows NT clients, these values are stored in the registry, while Samba servers store them in the printers TDB\. This command corresponds to the MS Platform SDK GetPrinterData() function (* This command is currently unimplemented)\. 471 457 .RE 472 458 .PP 473 459 enumdataex 474 .RS 3n460 .RS 4 475 461 Enumerate printer data for a key 476 462 .RE 477 463 .PP 478 464 enumjobs <printer> 479 .RS 3n480 List the jobs and status of a given printer . This command corresponds to the MS Platform SDK EnumJobs() function465 .RS 4 466 List the jobs and status of a given printer\. This command corresponds to the MS Platform SDK EnumJobs() function 481 467 .RE 482 468 .PP 483 469 enumkey 484 .RS 3n470 .RS 4 485 471 Enumerate printer keys 486 472 .RE 487 473 .PP 488 474 enumports [level] 489 .RS 3n490 Executes an EnumPorts() call using the specified info level . Currently only info levels 1 and 2 are supported.475 .RS 4 476 Executes an EnumPorts() call using the specified info level\. Currently only info levels 1 and 2 are supported\. 491 477 .RE 492 478 .PP 493 479 enumdrivers [level] 494 .RS 3n495 Execute an EnumPrinterDrivers() call . This lists the various installed printer drivers for all architectures. Refer to the MS Platform SDK documentation for more details of the various flags and calling options. Currently supported info levels are 1, 2, and 3.480 .RS 4 481 Execute an EnumPrinterDrivers() call\. This lists the various installed printer drivers for all architectures\. Refer to the MS Platform SDK documentation for more details of the various flags and calling options\. Currently supported info levels are 1, 2, and 3\. 496 482 .RE 497 483 .PP 498 484 enumprinters [level] 499 .RS 3n500 Execute an EnumPrinters() call . This lists the various installed and share printers. Refer to the MS Platform SDK documentation for more details of the various flags and calling options. Currently supported info levels are 1, 2 and 5.485 .RS 4 486 Execute an EnumPrinters() call\. This lists the various installed and share printers\. Refer to the MS Platform SDK documentation for more details of the various flags and calling options\. Currently supported info levels are 1, 2 and 5\. 501 487 .RE 502 488 .PP 503 489 getdata <printername> <valuename;> 504 .RS 3n505 Retrieve the data for a given printer setting . See the490 .RS 4 491 Retrieve the data for a given printer setting\. See the 506 492 enumdata 507 command for more information . This command corresponds to the GetPrinterData() MS Platform SDK function.493 command for more information\. This command corresponds to the GetPrinterData() MS Platform SDK function\. 508 494 .RE 509 495 .PP 510 496 getdataex 511 .RS 3n497 .RS 4 512 498 Get printer driver data with keyname 513 499 .RE 514 500 .PP 515 501 getdriver <printername> 516 .RS 3n517 Retrieve the printer driver information (such as driver file, config file, dependent files, etc ...) for the given printer. This command corresponds to the GetPrinterDriver() MS Platform SDK function. Currently info level 1, 2, and 3 are supported.502 .RS 4 503 Retrieve the printer driver information (such as driver file, config file, dependent files, etc\.\.\.) for the given printer\. This command corresponds to the GetPrinterDriver() MS Platform SDK function\. Currently info level 1, 2, and 3 are supported\. 518 504 .RE 519 505 .PP 520 506 getdriverdir <arch> 521 .RS 3n522 Execute a GetPrinterDriverDirectory() RPC to retrieve the SMB share name and subdirectory for storing printer driver files for a given architecture . Possible values for507 .RS 4 508 Execute a GetPrinterDriverDirectory() RPC to retrieve the SMB share name and subdirectory for storing printer driver files for a given architecture\. Possible values for 523 509 \fIarch\fR 524 are "Windows 4 .0" (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows Alpha_AXP", and "Windows NT R4000".510 are "Windows 4\.0" (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows Alpha_AXP", and "Windows NT R4000"\. 525 511 .RE 526 512 .PP 527 513 getprinter <printername> 528 .RS 3n529 Retrieve the current printer information . This command corresponds to the GetPrinter() MS Platform SDK function.514 .RS 4 515 Retrieve the current printer information\. This command corresponds to the GetPrinter() MS Platform SDK function\. 530 516 .RE 531 517 .PP 532 518 getprintprocdir 533 .RS 3n519 .RS 4 534 520 Get print processor directory 535 521 .RE 536 522 .PP 537 523 openprinter <printername> 538 .RS 3n539 Execute an OpenPrinterEx() and ClosePrinter() RPC against a given printer .524 .RS 4 525 Execute an OpenPrinterEx() and ClosePrinter() RPC against a given printer\. 540 526 .RE 541 527 .PP 542 528 setdriver <printername> <drivername> 543 .RS 3n544 Execute a SetPrinter() command to update the printer driver associated with an installed printer . The printer driver must already be correctly installed on the print server.529 .RS 4 530 Execute a SetPrinter() command to update the printer driver associated with an installed printer\. The printer driver must already be correctly installed on the print server\. 545 531 .sp 546 532 See also the … … 548 534 and 549 535 enumdrivers 550 commands for obtaining a list of of installed printers and drivers .536 commands for obtaining a list of of installed printers and drivers\. 551 537 .RE 552 538 .PP 553 539 addform 554 .RS 3n540 .RS 4 555 541 Add form 556 542 .RE 557 543 .PP 558 544 setform 559 .RS 3n545 .RS 4 560 546 Set form 561 547 .RE 562 548 .PP 563 549 getform 564 .RS 3n550 .RS 4 565 551 Get form 566 552 .RE 567 553 .PP 568 554 deleteform 569 .RS 3n555 .RS 4 570 556 Delete form 571 557 .RE 572 558 .PP 573 559 enumforms 574 .RS 3n560 .RS 4 575 561 Enumerate form 576 562 .RE 577 563 .PP 578 564 setprinter 579 .RS 3n565 .RS 4 580 566 Set printer comment 581 567 .RE 582 568 .PP 583 569 setprinterdata 584 .RS 3n570 .RS 4 585 571 Set REG_SZ printer data 586 572 .RE 587 573 .PP 588 574 setprintername <printername> <newprintername> 589 .RS 3n575 .RS 4 590 576 Set printer name 591 577 .RE 592 578 .PP 593 579 rffpcnex 594 .RS 3n580 .RS 4 595 581 Rffpcnex test 596 582 .RE … … 598 584 .PP 599 585 logonctrl2 600 .RS 3n586 .RS 4 601 587 Logon Control 2 602 588 .RE 603 589 .PP 604 590 logonctrl 605 .RS 3n591 .RS 4 606 592 Logon Control 607 593 .RE 608 594 .PP 609 595 samsync 610 .RS 3n596 .RS 4 611 597 Sam Synchronisation 612 598 .RE 613 599 .PP 614 600 samdeltas 615 .RS 3n601 .RS 4 616 602 Query Sam Deltas 617 603 .RE 618 604 .PP 619 605 samlogon 620 .RS 3n606 .RS 4 621 607 Sam Logon 622 608 .RE … … 624 610 .PP 625 611 debuglevel 626 .RS 3n627 Set the current debug level used to log information .612 .RS 4 613 Set the current debug level used to log information\. 628 614 .RE 629 615 .PP 630 616 help (?) 631 .RS 3n632 Print a listing of all known commands or extended help on a particular command .617 .RS 4 618 Print a listing of all known commands or extended help on a particular command\. 633 619 .RE 634 620 .PP 635 621 quit (exit) 636 .RS 3n622 .RS 4 637 623 Exit 638 rpcclient .624 rpcclient\. 639 625 .RE 640 626 .SH "BUGS" 641 627 .PP 642 628 rpcclient 643 is designed as a developer testing tool and may not be robust in certain areas (such as command line parsing) . It has been known to generate a core dump upon failures when invalid parameters where passed to the interpreter.644 .PP 645 From Luke Leighton 's original rpcclient man page:646 .PP 647 \f BWARNING!\fR648 The MSRPC over SMB code has been developed from examining Network traces . No documentation is available from the original creators (Microsoft) on how MSRPC over SMB works, or how the individual MSRPC services work. Microsoft's implementation of these services has been demonstrated (and reported) to be... a bit flaky in places.649 .PP 650 The development of Samba 's implementation is also a bit rough, and as more of the services are understood, it can even result in versions of629 is designed as a developer testing tool and may not be robust in certain areas (such as command line parsing)\. It has been known to generate a core dump upon failures when invalid parameters where passed to the interpreter\. 630 .PP 631 From Luke Leighton\'s original rpcclient man page: 632 .PP 633 \fIWARNING!\fR 634 The MSRPC over SMB code has been developed from examining Network traces\. No documentation is available from the original creators (Microsoft) on how MSRPC over SMB works, or how the individual MSRPC services work\. Microsoft\'s implementation of these services has been demonstrated (and reported) to be\.\.\. a bit flaky in places\. 635 .PP 636 The development of Samba\'s implementation is also a bit rough, and as more of the services are understood, it can even result in versions of 651 637 \fBsmbd\fR(8) 652 638 and 653 639 \fBrpcclient\fR(1) 654 that are incompatible for some commands or services . Additionally, the developers are sending reports to Microsoft, and problems found or reported to Microsoft are fixed in Service Packs, which may result in incompatibilities.640 that are incompatible for some commands or services\. Additionally, the developers are sending reports to Microsoft, and problems found or reported to Microsoft are fixed in Service Packs, which may result in incompatibilities\. 655 641 .SH "VERSION" 656 642 .PP 657 This man page is correct for version 3 .0 of the Samba suite.643 This man page is correct for version 3\.0 of the Samba suite\. 658 644 .SH "AUTHOR" 659 645 .PP 660 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 661 .PP 662 The original rpcclient man page was written by Matthew Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 663 646 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 647 .PP 648 The original rpcclient man page was written by Matthew Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/samba.7
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SAMBA" 7 "" "" "" 1 .\" Title: samba 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: Miscellanea 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SAMBA" "7" "05/21/2008" "Samba 3\.0" "Miscellanea" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 samba - A Windows SMB/CIFS fileserver for UNIX … … 26 18 .SH "DESCRIPTION" 27 19 .PP 28 The Samba software suite is a collection of programs that implements the Server Message Block (commonly abbreviated as SMB) protocol for UNIX systems . This protocol is sometimes also referred to as the Common Internet File System (CIFS). For a more thorough description, see29 http://www .ubiqx.org/cifs/. Samba also implements the NetBIOS protocol in nmbd.20 The Samba software suite is a collection of programs that implements the Server Message Block (commonly abbreviated as SMB) protocol for UNIX systems\. This protocol is sometimes also referred to as the Common Internet File System (CIFS)\. For a more thorough description, see 21 http://www\.ubiqx\.org/cifs/\. Samba also implements the NetBIOS protocol in nmbd\. 30 22 .PP 31 23 \fBsmbd\fR(8) 32 .RS 3n24 .RS 4 33 25 The 34 26 smbd 35 daemon provides the file and print services to SMB clients, such as Windows 95/98, Windows NT, Windows for Workgroups or LanManager . The configuration file for this daemon is described in27 daemon provides the file and print services to SMB clients, such as Windows 95/98, Windows NT, Windows for Workgroups or LanManager\. The configuration file for this daemon is described in 36 28 \fBsmb.conf\fR(5) 37 29 .RE 38 30 .PP 39 31 \fBnmbd\fR(8) 40 .RS 3n32 .RS 4 41 33 The 42 34 nmbd 43 daemon provides NetBIOS nameservice and browsing support . The configuration file for this daemon is described in35 daemon provides NetBIOS nameservice and browsing support\. The configuration file for this daemon is described in 44 36 \fBsmb.conf\fR(5) 45 37 .RE 46 38 .PP 47 39 \fBsmbclient\fR(1) 48 .RS 3n40 .RS 4 49 41 The 50 42 smbclient 51 program implements a simple ftp -like client. This is useful for accessing SMB shares on other compatible servers (such as Windows NT), and can also be used to allow a UNIX box to print to a printer attached to any SMB server (such as a PC running Windows NT).43 program implements a simple ftp\-like client\. This is useful for accessing SMB shares on other compatible servers (such as Windows NT), and can also be used to allow a UNIX box to print to a printer attached to any SMB server (such as a PC running Windows NT)\. 52 44 .RE 53 45 .PP 54 46 \fBtestparm\fR(1) 55 .RS 3n47 .RS 4 56 48 The 57 49 testparm 58 utility is a simple syntax checker for Samba 's50 utility is a simple syntax checker for Samba\'s 59 51 \fBsmb.conf\fR(5) 60 configuration file .52 configuration file\. 61 53 .RE 62 54 .PP 63 55 \fBtestprns\fR(1) 64 .RS 3n56 .RS 4 65 57 The 66 58 testprns 67 59 utility supports testing printer names defined in your 68 60 \fIprintcap\fR 69 file used by Samba .61 file used by Samba\. 70 62 .RE 71 63 .PP 72 64 \fBsmbstatus\fR(1) 73 .RS 3n65 .RS 4 74 66 The 75 67 smbstatus 76 68 tool provides access to information about the current connections to 77 smbd .69 smbd\. 78 70 .RE 79 71 .PP 80 72 \fBnmblookup\fR(1) 81 .RS 3n73 .RS 4 82 74 The 83 75 nmblookup 84 tools allows NetBIOS name queries to be made from a UNIX host .76 tools allows NetBIOS name queries to be made from a UNIX host\. 85 77 .RE 86 78 .PP 87 79 \fBsmbpasswd\fR(8) 88 .RS 3n80 .RS 4 89 81 The 90 82 smbpasswd 91 command is a tool for changing LanMan and Windows NT password hashes on Samba and Windows NT servers .83 command is a tool for changing LanMan and Windows NT password hashes on Samba and Windows NT servers\. 92 84 .RE 93 85 .PP 94 86 \fBsmbcacls\fR(1) 95 .RS 3n87 .RS 4 96 88 The 97 89 smbcacls 98 command is a tool to set ACL 's on remote CIFS servers.90 command is a tool to set ACL\'s on remote CIFS servers\. 99 91 .RE 100 92 .PP 101 93 \fBsmbsh\fR(1) 102 .RS 3n94 .RS 4 103 95 The 104 96 smbsh 105 command is a program that allows you to run a unix shell with with an overloaded VFS .97 command is a program that allows you to run a unix shell with with an overloaded VFS\. 106 98 .RE 107 99 .PP 108 100 \fBsmbtree\fR(1) 109 .RS 3n101 .RS 4 110 102 The 111 103 smbtree 112 command is a text -based network neighborhood tool.104 command is a text\-based network neighborhood tool\. 113 105 .RE 114 106 .PP 115 107 \fBsmbtar\fR(1) 116 .RS 3n108 .RS 4 117 109 The 118 110 smbtar 119 can make backups of data on CIFS/SMB servers .111 can make backups of data on CIFS/SMB servers\. 120 112 .RE 121 113 .PP 122 114 \fBsmbspool\fR(8) 123 .RS 3n115 .RS 4 124 116 smbspool 125 is a helper utility for printing on printers connected to CIFS servers .117 is a helper utility for printing on printers connected to CIFS servers\. 126 118 .RE 127 119 .PP 128 120 \fBsmbcontrol\fR(1) 129 .RS 3n121 .RS 4 130 122 smbcontrol 131 is a utility that can change the behaviour of running samba daemons .123 is a utility that can change the behaviour of running samba daemons\. 132 124 .RE 133 125 .PP 134 126 \fBrpcclient\fR(1) 135 .RS 3n127 .RS 4 136 128 rpcclient 137 is a utility that can be used to execute RPC commands on remote CIFS servers .129 is a utility that can be used to execute RPC commands on remote CIFS servers\. 138 130 .RE 139 131 .PP 140 132 \fBpdbedit\fR(8) 141 .RS 3n133 .RS 4 142 134 The 143 135 pdbedit 144 command can be used to maintain the local user database on a samba server .136 command can be used to maintain the local user database on a samba server\. 145 137 .RE 146 138 .PP 147 139 \fBfindsmb\fR(1) 148 .RS 3n140 .RS 4 149 141 The 150 142 findsmb 151 command can be used to find SMB servers on the local network .143 command can be used to find SMB servers on the local network\. 152 144 .RE 153 145 .PP 154 146 \fBnet\fR(8) 155 .RS 3n147 .RS 4 156 148 The 157 149 net 158 command is supposed to work similar to the DOS/Windows NET .EXE command.150 command is supposed to work similar to the DOS/Windows NET\.EXE command\. 159 151 .RE 160 152 .PP 161 153 \fBswat\fR(8) 162 .RS 3n154 .RS 4 163 155 swat 164 is a web -based interface to configuring165 \fIsmb .conf\fR.156 is a web\-based interface to configuring 157 \fIsmb\.conf\fR\. 166 158 .RE 167 159 .PP 168 160 \fBwinbindd\fR(8) 169 .RS 3n161 .RS 4 170 162 winbindd 171 is a daemon that is used for integrating authentication and the user database into unix .163 is a daemon that is used for integrating authentication and the user database into unix\. 172 164 .RE 173 165 .PP 174 166 \fBwbinfo\fR(1) 175 .RS 3n167 .RS 4 176 168 wbinfo 177 is a utility that retrieves and stores information related to winbind .169 is a utility that retrieves and stores information related to winbind\. 178 170 .RE 179 171 .PP 180 172 \fBprofiles\fR(1) 181 .RS 3n173 .RS 4 182 174 profiles 183 is a command -line utility that can be used to replace all occurences of a certain SID with another SID.175 is a command\-line utility that can be used to replace all occurences of a certain SID with another SID\. 184 176 .RE 185 177 .PP 186 178 \fBlog2pcap\fR(1) 187 .RS 3n179 .RS 4 188 180 log2pcap 189 is a utility for generating pcap trace files from Samba log files .181 is a utility for generating pcap trace files from Samba log files\. 190 182 .RE 191 183 .PP 192 184 \fBvfstest\fR(1) 193 .RS 3n185 .RS 4 194 186 vfstest 195 is a utility that can be used to test vfs modules .187 is a utility that can be used to test vfs modules\. 196 188 .RE 197 189 .PP 198 190 \fBntlm_auth\fR(1) 199 .RS 3n191 .RS 4 200 192 ntlm_auth 201 is a helper -utility for external programs wanting to do NTLM-authentication.193 is a helper\-utility for external programs wanting to do NTLM\-authentication\. 202 194 .RE 203 195 .PP 204 196 \fBsmbmount\fR(8), \fBsmbumount\fR(8), \fBsmbmnt\fR(8) 205 .RS 3n197 .RS 4 206 198 smbmount,smbumount 207 199 and 208 200 smbmnt 209 are commands that can be used to mount CIFS/SMB shares on Linux .201 are commands that can be used to mount CIFS/SMB shares on Linux\. 210 202 .RE 211 203 .PP 212 204 \fBsmbcquotas\fR(1) 213 .RS 3n205 .RS 4 214 206 smbcquotas 215 is a tool that can set remote QUOTA 's on server with NTFS 5.207 is a tool that can set remote QUOTA\'s on server with NTFS 5\. 216 208 .RE 217 209 .SH "COMPONENTS" 218 210 .PP 219 The Samba suite is made up of several components . Each component is described in a separate manual page. It is strongly recommended that you read the documentation that comes with Samba and the manual pages of those components that you use. If the manual pages and documents aren't clear enough then please visit220 http://devel .samba.org221 for information on how to file a bug report or submit a patch .211 The Samba suite is made up of several components\. Each component is described in a separate manual page\. It is strongly recommended that you read the documentation that comes with Samba and the manual pages of those components that you use\. If the manual pages and documents aren\'t clear enough then please visit 212 http://devel\.samba\.org 213 for information on how to file a bug report or submit a patch\. 222 214 .PP 223 215 If you require help, visit the Samba webpage at 224 http://www .samba.org/225 and explore the many option available to you .216 http://www\.samba\.org/ 217 and explore the many option available to you\. 226 218 .SH "AVAILABILITY" 227 219 .PP 228 The Samba software suite is licensed under the GNU Public License(GPL) . A copy of that license should have come with the package in the file COPYING. You are encouraged to distribute copies of the Samba suite, but please obey the terms of this license.229 .PP 230 The latest version of the Samba suite can be obtained via anonymous ftp from samba .org in the directory pub/samba/. It is also available on several mirror sites worldwide.220 The Samba software suite is licensed under the GNU Public License(GPL)\. A copy of that license should have come with the package in the file COPYING\. You are encouraged to distribute copies of the Samba suite, but please obey the terms of this license\. 221 .PP 222 The latest version of the Samba suite can be obtained via anonymous ftp from samba\.org in the directory pub/samba/\. It is also available on several mirror sites worldwide\. 231 223 .PP 232 224 You may also find useful information about Samba on the newsgroup 233 comp .protocol.smb234 and the Samba mailing list . Details on how to join the mailing list are given in the README file that comes with Samba.225 comp\.protocol\.smb 226 and the Samba mailing list\. Details on how to join the mailing list are given in the README file that comes with Samba\. 235 227 .PP 236 228 If you have access to a WWW viewer (such as Mozilla or Konqueror) then you will also find lots of useful information, including back issues of the Samba mailing list, at 237 http://lists .samba.org.229 http://lists\.samba\.org\. 238 230 .SH "VERSION" 239 231 .PP 240 This man page is correct for version 3 .0 of the Samba suite.232 This man page is correct for version 3\.0 of the Samba suite\. 241 233 .SH "CONTRIBUTIONS" 242 234 .PP 243 235 If you wish to contribute to the Samba project, then I suggest you join the Samba mailing list at 244 http://lists .samba.org.236 http://lists\.samba\.org\. 245 237 .PP 246 238 If you have patches to submit, visit 247 http://devel .samba.org/248 for information on how to do it properly . We prefer patches in249 diff -u250 format .239 http://devel\.samba\.org/ 240 for information on how to do it properly\. We prefer patches in 241 diff \-u 242 format\. 251 243 .SH "CONTRIBUTORS" 252 244 .PP 253 Contributors to the project are now too numerous to mention here but all deserve the thanks of all Samba users . To see a full list, look at the254 \fIchange -log\fR255 in the source package for the pre -CVS changes and at256 http://cvs .samba.org/257 for the contributors to Samba post -CVS. CVS is the Open Source source code control system used by the Samba Team to develop Samba. The project would have been unmanageable without it.245 Contributors to the project are now too numerous to mention here but all deserve the thanks of all Samba users\. To see a full list, look at the 246 \fIchange\-log\fR 247 in the source package for the pre\-CVS changes and at 248 http://cvs\.samba\.org/ 249 for the contributors to Samba post\-CVS\. CVS is the Open Source source code control system used by the Samba Team to develop Samba\. The project would have been unmanageable without it\. 258 250 .SH "AUTHOR" 259 251 .PP 260 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 261 .PP 262 The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 263 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 264 252 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 253 .PP 254 The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 255 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/smb.conf.5
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMB.CONF" 5 "" "" "" 1 .\" Title: smb.conf 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: File Formats and Conventions 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMB\.CONF" "5" "05/21/2008" "Samba 3\.0" "File Formats and Conventions" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smb.conf - The configuration file for the Samba suite … … 24 16 .PP 25 17 The 26 \fIsmb .conf\fR27 file is a configuration file for the Samba suite .28 \fIsmb .conf\fR29 contains runtime configuration information for the Samba programs . The30 \fIsmb .conf\fR18 \fIsmb\.conf\fR 19 file is a configuration file for the Samba suite\. 20 \fIsmb\.conf\fR 21 contains runtime configuration information for the Samba programs\. The 22 \fIsmb\.conf\fR 31 23 file is designed to be configured and administered by the 32 24 \fBswat\fR(8) 33 program . The complete description of the file format and possible parameters held within are here for reference purposes.25 program\. The complete description of the file format and possible parameters held within are here for reference purposes\. 34 26 .SH "FILE FORMAT" 35 27 .PP 36 The file consists of sections and parameters. A section begins with the name of the section in square brackets and continues until the next section begins. Sections contain parameters of the form: 37 38 .sp 39 28 The file consists of sections and parameters\. A section begins with the name of the section in square brackets and continues until the next section begins\. Sections contain parameters of the form: 29 .sp 30 .RS 4 40 31 .nf 41 42 32 \fIname\fR = \fIvalue \fR 43 44 33 .fi 45 46 .PP 47 The file is line -based - that is, each newline-terminated line represents either a comment, a section name or a parameter.48 .PP 49 Section and parameter names are not case sensitive .50 .PP 51 Only the first equals sign in a parameter is significant . Whitespace before or after the first equals sign is discarded. Leading, trailing and internal whitespace in section and parameter names is irrelevant. Leading and trailing whitespace in a parameter value is discarded. Internal whitespace within a parameter value is retained verbatim.52 .PP 53 Any line beginning with a semicolon (\ fB;\fR) or a hash (\fB#\fR) character is ignored, as are lines containing only whitespace.34 .RE 35 .PP 36 The file is line\-based \- that is, each newline\-terminated line represents either a comment, a section name or a parameter\. 37 .PP 38 Section and parameter names are not case sensitive\. 39 .PP 40 Only the first equals sign in a parameter is significant\. Whitespace before or after the first equals sign is discarded\. Leading, trailing and internal whitespace in section and parameter names is irrelevant\. Leading and trailing whitespace in a parameter value is discarded\. Internal whitespace within a parameter value is retained verbatim\. 41 .PP 42 Any line beginning with a semicolon (\(lq;\(rq) or a hash (\(lq#\(rq) character is ignored, as are lines containing only whitespace\. 54 43 .PP 55 44 Any line ending in a 56 \ fB\\\fR57 is continued on the next line in the customary UNIX fashion .58 .PP 59 The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, which may be given as yes/no, 0/1 or true/false . Case is not significant in boolean values, but is preserved in string values. Some items such as create masks are numeric.45 \(lq\e\(rq 46 is continued on the next line in the customary UNIX fashion\. 47 .PP 48 The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, which may be given as yes/no, 0/1 or true/false\. Case is not significant in boolean values, but is preserved in string values\. Some items such as create masks are numeric\. 60 49 .SH "SECTION DESCRIPTIONS" 61 50 .PP 62 51 Each section in the configuration file (except for the [global] section) describes a shared resource (known as a 63 \ fBshare\fR). The section name is the name of the shared resource and the parameters within the section define the shares attributes.52 \(lqshare\(rq)\. The section name is the name of the shared resource and the parameters within the section define the shares attributes\. 64 53 .PP 65 54 There are three special sections, [global], [homes] and [printers], which are described under 66 \f Bspecial sections\fR. The following notes apply to ordinary section descriptions.67 .PP 68 A share consists of a directory to which access is being given plus a description of the access rights which are granted to the user of the service . Some housekeeping options are also specifiable.69 .PP 70 Sections are either file share services (used by the client as an extension of their native file systems) or printable services (used by the client to access print services on the host running the server) .55 \fIspecial sections\fR\. The following notes apply to ordinary section descriptions\. 56 .PP 57 A share consists of a directory to which access is being given plus a description of the access rights which are granted to the user of the service\. Some housekeeping options are also specifiable\. 58 .PP 59 Sections are either file share services (used by the client as an extension of their native file systems) or printable services (used by the client to access print services on the host running the server)\. 71 60 .PP 72 61 Sections may be designated 73 \f Bguest\fR74 services, in which case no password is required to access them . A specified UNIX75 \f Bguest account\fR76 is used to define access privileges in this case .77 .PP 78 Sections other than guest services will require a password to access them . The client provides the username. As older clients only provide passwords and not usernames, you may specify a list of usernames to check against the password using the62 \fIguest\fR 63 services, in which case no password is required to access them\. A specified UNIX 64 \fIguest account\fR 65 is used to define access privileges in this case\. 66 .PP 67 Sections other than guest services will require a password to access them\. The client provides the username\. As older clients only provide passwords and not usernames, you may specify a list of usernames to check against the password using the 79 68 user = 80 option in the share definition . For modern clients such as Windows 95/98/ME/NT/2000, this should not be necessary.81 .PP 82 The access rights granted by the server are masked by the access rights granted to the specified or guest UNIX user by the host system . The server does not grant more access than the host system grants.83 .PP 84 The following sample section defines a file space share . The user has write access to the path85 \fI/home/bar\fR . The share is accessed via the share name69 option in the share definition\. For modern clients such as Windows 95/98/ME/NT/2000, this should not be necessary\. 70 .PP 71 The access rights granted by the server are masked by the access rights granted to the specified or guest UNIX user by the host system\. The server does not grant more access than the host system grants\. 72 .PP 73 The following sample section defines a file space share\. The user has write access to the path 74 \fI/home/bar\fR\. The share is accessed via the share name 86 75 foo: 87 88 .sp 89 76 .sp 77 .RS 4 90 78 .nf 91 92 79 \fI[foo]\fR 93 path = /home/bar 94 read only = no 95 80 \fIpath = /home/bar\fR 81 \fIread only = no\fR 96 82 .fi 97 98 .PP 99 The following sample section defines a printable share . The share is read-only, but printable. That is, the only write access permitted is via calls to open, write to and close a spool file. The100 \f Bguest ok\fR83 .RE 84 .PP 85 The following sample section defines a printable share\. The share is read\-only, but printable\. That is, the only write access permitted is via calls to open, write to and close a spool file\. The 86 \fIguest ok\fR 101 87 parameter means access will be permitted as the default guest user (specified elsewhere): 102 103 .sp 104 88 .sp 89 .RS 4 105 90 .nf 106 107 91 \fI[aprinter]\fR 108 path = /usr/spool/public 109 read only = yes 110 printable = yes 111 guest ok = yes 112 92 \fIpath = /usr/spool/public\fR 93 \fIread only = yes\fR 94 \fIprintable = yes\fR 95 \fIguest ok = yes\fR 113 96 .fi 114 97 .RE 98 .sp 115 99 .SH "SPECIAL SECTIONS" 116 100 .SS "The [global] section" 117 101 .PP 118 Parameters in this section apply to the server as a whole, or are defaults for sections that do not specifically define certain items . See the notes under PARAMETERS for more information.102 Parameters in this section apply to the server as a whole, or are defaults for sections that do not specifically define certain items\. See the notes under PARAMETERS for more information\. 119 103 .SS "The [homes] section" 120 104 .PP 121 If a section called [homes] is included in the configuration file, services connecting clients to their home directories can be created on the fly by the server .122 .PP 123 When the connection request is made, the existing sections are scanned . If a match is found, it is used. If no match is found, the requested section name is treated as a username and looked up in the local password file. If the name exists and the correct password has been given, a share is created by cloning the [homes] section.105 If a section called [homes] is included in the configuration file, services connecting clients to their home directories can be created on the fly by the server\. 106 .PP 107 When the connection request is made, the existing sections are scanned\. If a match is found, it is used\. If no match is found, the requested section name is treated as a username and looked up in the local password file\. If the name exists and the correct password has been given, a share is created by cloning the [homes] section\. 124 108 .PP 125 109 Some modifications are then made to the newly created share: 126 .TP 3n 127 \(bu 128 The share name is changed from homes to the located username. 129 .TP 3n 130 \(bu 131 If no path was given, the path is set to the user's home directory. 110 .sp 111 .RS 4 112 .ie n \{\ 113 \h'-04'\(bu\h'+03'\c 114 .\} 115 .el \{\ 116 .sp -1 117 .IP \(bu 2.3 118 .\} 119 The share name is changed from homes to the located username\. 120 .RE 121 .sp 122 .RS 4 123 .ie n \{\ 124 \h'-04'\(bu\h'+03'\c 125 .\} 126 .el \{\ 127 .sp -1 128 .IP \(bu 2.3 129 .\} 130 If no path was given, the path is set to the user\'s home directory\. 131 .sp 132 .RE 132 133 .PP 133 134 If you decide to use a 134 \fBpath =\fR 135 line in your [homes] section, it may be useful to use the %S macro. For example: 136 137 .sp 138 135 \fIpath =\fR 136 line in your [homes] section, it may be useful to use the %S macro\. For example: 137 .sp 138 .RS 4 139 139 .nf 140 141 140 \fBpath = /data/pchome/%S\fR 142 143 141 .fi 144 is useful if you have different home directories for your PCs than for UNIX access. 145 .PP 146 This is a fast and simple way to give a large number of clients access to their home directories with a minimum of fuss. 142 .RE 143 .sp 144 is useful if you have different home directories for your PCs than for UNIX access\. 145 .PP 146 This is a fast and simple way to give a large number of clients access to their home directories with a minimum of fuss\. 147 147 .PP 148 148 A similar process occurs if the requested section name is 149 \fBhomes\fR, except that the share name is not changed to that of the requesting user. This method of using the [homes] section works well if different users share a client PC. 150 .PP 151 The [homes] section can specify all the parameters a normal service section can specify, though some make more sense than others. The following is a typical and suitable [homes] section: 152 153 .sp 154 149 \(lqhomes\(rq, except that the share name is not changed to that of the requesting user\. This method of using the [homes] section works well if different users share a client PC\. 150 .PP 151 The [homes] section can specify all the parameters a normal service section can specify, though some make more sense than others\. The following is a typical and suitable [homes] section: 152 .sp 153 .RS 4 155 154 .nf 156 157 155 \fI[homes]\fR 158 read only = no 159 156 \fIread only = no\fR 160 157 .fi 161 158 .RE 162 159 .PP 163 160 An important point is that if guest access is specified in the [homes] section, all home directories will be visible to all clients 164 \f Bwithout a password\fR. In the very unlikely event that this is actually desirable, it is wise to also specify165 \f Bread only access\fR.161 \fIwithout a password\fR\. In the very unlikely event that this is actually desirable, it is wise to also specify 162 \fIread only access\fR\. 166 163 .PP 167 164 The 168 \f Bbrowseable\fR169 flag for auto home directories will be inherited from the global browseable flag, not the [homes] browseable flag . This is useful as it means setting170 \f Bbrowseable = no\fR171 in the [homes] section will hide the [homes] share but make any auto home directories visible .165 \fIbrowseable\fR 166 flag for auto home directories will be inherited from the global browseable flag, not the [homes] browseable flag\. This is useful as it means setting 167 \fIbrowseable = no\fR 168 in the [homes] section will hide the [homes] share but make any auto home directories visible\. 172 169 .SS "The [printers] section" 173 170 .PP 174 This section works like [homes], but for printers .175 .PP 176 If a [printers] section occurs in the configuration file, users are able to connect to any printer specified in the local host 's printcap file.177 .PP 178 When a connection request is made, the existing sections are scanned . If a match is found, it is used. If no match is found, but a [homes] section exists, it is used as described above. Otherwise, the requested section name is treated as a printer name and the appropriate printcap file is scanned to see if the requested section name is a valid printer share name. If a match is found, a new printer share is created by cloning the [printers] section.171 This section works like [homes], but for printers\. 172 .PP 173 If a [printers] section occurs in the configuration file, users are able to connect to any printer specified in the local host\'s printcap file\. 174 .PP 175 When a connection request is made, the existing sections are scanned\. If a match is found, it is used\. If no match is found, but a [homes] section exists, it is used as described above\. Otherwise, the requested section name is treated as a printer name and the appropriate printcap file is scanned to see if the requested section name is a valid printer share name\. If a match is found, a new printer share is created by cloning the [printers] section\. 179 176 .PP 180 177 A few modifications are then made to the newly created share: 181 .TP 3n 182 \(bu 178 .sp 179 .RS 4 180 .ie n \{\ 181 \h'-04'\(bu\h'+03'\c 182 .\} 183 .el \{\ 184 .sp -1 185 .IP \(bu 2.3 186 .\} 183 187 The share name is set to the located printer name 184 .TP 3n 185 \(bu 188 .RE 189 .sp 190 .RS 4 191 .ie n \{\ 192 \h'-04'\(bu\h'+03'\c 193 .\} 194 .el \{\ 195 .sp -1 196 .IP \(bu 2.3 197 .\} 186 198 If no printer name was given, the printer name is set to the located printer name 187 .TP 3n 188 \(bu 189 If the share does not permit guest access and no username was given, the username is set to the located printer name. 190 .PP 191 The [printers] service MUST be printable - if you specify otherwise, the server will refuse to load the configuration file. 192 .PP 193 Typically the path specified is that of a world-writeable spool directory with the sticky bit set on it. A typical [printers] entry looks like this: 194 195 .sp 196 199 .RE 200 .sp 201 .RS 4 202 .ie n \{\ 203 \h'-04'\(bu\h'+03'\c 204 .\} 205 .el \{\ 206 .sp -1 207 .IP \(bu 2.3 208 .\} 209 If the share does not permit guest access and no username was given, the username is set to the located printer name\. 210 .sp 211 .RE 212 .PP 213 The [printers] service MUST be printable \- if you specify otherwise, the server will refuse to load the configuration file\. 214 .PP 215 Typically the path specified is that of a world\-writeable spool directory with the sticky bit set on it\. A typical [printers] entry looks like this: 216 .sp 217 .RS 4 197 218 .nf 198 199 219 \fI[printers]\fR 200 path = /usr/spool/public 201 guest ok = yes 202 printable = yes 203 220 \fIpath = /usr/spool/public\fR 221 \fIguest ok = yes\fR 222 \fIprintable = yes\fR 204 223 .fi 205 206 .PP 207 All aliases given for a printer in the printcap file are legitimate printer names as far as the server is concerned. If your printing subsystem doesn't work like that, you will have to set up a pseudo-printcap. This is a file consisting of one or more lines like this: 208 209 .sp 210 224 .RE 225 .PP 226 All aliases given for a printer in the printcap file are legitimate printer names as far as the server is concerned\. If your printing subsystem doesn\'t work like that, you will have to set up a pseudo\-printcap\. This is a file consisting of one or more lines like this: 227 .sp 228 .RS 4 211 229 .nf 212 213 alias|alias|alias|alias... 214 230 alias|alias|alias|alias\.\.\. 215 231 .fi 216 217 .PP 218 Each alias should be an acceptable printer name for your printing subsystem . In the [global] section, specify the new file as your printcap. The server will only recognize names found in your pseudo-printcap, which of course can contain whatever aliases you like. The same technique could be used simply to limit access to a subset of your local printers.219 .PP 220 An alias, by the way, is defined as any component of the first entry of a printcap record . Records are separated by newlines, components (if there are more than one) are separated by vertical bar symbols (|).232 .RE 233 .PP 234 Each alias should be an acceptable printer name for your printing subsystem\. In the [global] section, specify the new file as your printcap\. The server will only recognize names found in your pseudo\-printcap, which of course can contain whatever aliases you like\. The same technique could be used simply to limit access to a subset of your local printers\. 235 .PP 236 An alias, by the way, is defined as any component of the first entry of a printcap record\. Records are separated by newlines, components (if there are more than one) are separated by vertical bar symbols (|)\. 221 237 .sp 222 238 .it 1 an-trap … … 224 240 .nr an-break-flag 1 225 241 .br 226 \fBNote\fR 242 Note 227 243 .PP 228 244 On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use 229 245 printcap name = lpstat 230 to automatically obtain a list of printers . See the246 to automatically obtain a list of printers\. See the 231 247 printcap name 232 option for more details .248 option for more details\. 233 249 .SH "USERSHARES" 234 250 .PP 235 Starting with Samba version 3 .0.23 the capability for non-root users to add, modify, and delete their own share definitions has been added. This capability is called236 \f Busershares\fR237 and is controlled by a set of parameters in the [global] section of the smb .conf. The relevant parameters are :251 Starting with Samba version 3\.0\.23 the capability for non\-root users to add, modify, and delete their own share definitions has been added\. This capability is called 252 \fIusershares\fR 253 and is controlled by a set of parameters in the [global] section of the smb\.conf\. The relevant parameters are : 238 254 .PP 239 255 usershare allow guests 240 .RS 3n241 Controls if usershares can permit guest access .256 .RS 4 257 Controls if usershares can permit guest access\. 242 258 .RE 243 259 .PP 244 260 usershare max shares 245 .RS 3n246 Maximum number of user defined shares allowed .261 .RS 4 262 Maximum number of user defined shares allowed\. 247 263 .RE 248 264 .PP 249 265 usershare owner only 250 .RS 3n251 If set only directories owned by the sharing user can be shared .266 .RS 4 267 If set only directories owned by the sharing user can be shared\. 252 268 .RE 253 269 .PP 254 270 usershare path 255 .RS 3n256 Points to the directory containing the user defined share definitions . The filesystem permissions on this directory control who can create user defined shares.271 .RS 4 272 Points to the directory containing the user defined share definitions\. The filesystem permissions on this directory control who can create user defined shares\. 257 273 .RE 258 274 .PP 259 275 usershare prefix allow list 260 .RS 3n261 Comma -separated list of absolute pathnames restricting what directories can be shared. Only directories below the pathnames in this list are permitted.276 .RS 4 277 Comma\-separated list of absolute pathnames restricting what directories can be shared\. Only directories below the pathnames in this list are permitted\. 262 278 .RE 263 279 .PP 264 280 usershare prefix deny list 265 .RS 3n266 Comma -separated list of absolute pathnames restricting what directories can be shared. Directories below the pathnames in this list are prohibited.281 .RS 4 282 Comma\-separated list of absolute pathnames restricting what directories can be shared\. Directories below the pathnames in this list are prohibited\. 267 283 .RE 268 284 .PP 269 285 usershare template share 270 .RS 3n271 Names a pre -existing share used as a template for creating new usershares. All other share parameters not specified in the user defined share definition are copied from this named share.286 .RS 4 287 Names a pre\-existing share used as a template for creating new usershares\. All other share parameters not specified in the user defined share definition are copied from this named share\. 272 288 .RE 273 289 .PP … … 277 293 .PP 278 294 Become root: 279 295 .sp 296 .RS 4 280 297 .nf 281 282 298 mkdir /usr/local/samba/lib/usershares 283 299 chgrp foo /usr/local/samba/lib/usershares 284 300 chmod 1770 /usr/local/samba/lib/usershares 285 286 301 .fi 302 .RE 287 303 .PP 288 304 Then add the parameters 289 290 .sp 291 305 .sp 306 .RS 4 292 307 .nf 293 294 usershare path = /usr/local/samba/lib/usershares 295 usershare max shares = 10 # (or the desired number of shares) 296 308 \fIusershare path = /usr/local/samba/lib/usershares\fR 309 \fIusershare max shares = 10\fR # (or the desired number of shares) 297 310 .fi 311 .RE 312 .sp 298 313 to the global section of your 299 \fIsmb .conf\fR. Members of the group foo may then manipulate the user defined shares using the following commands.314 \fIsmb\.conf\fR\. Members of the group foo may then manipulate the user defined shares using the following commands\. 300 315 .PP 301 316 net usershare add sharename path [comment] [acl] [guest_ok=[y|n]] 302 .RS 3n303 To create or modify (overwrite) a user defined share .317 .RS 4 318 To create or modify (overwrite) a user defined share\. 304 319 .RE 305 320 .PP 306 321 net usershare delete sharename 307 .RS 3n308 To delete a user defined share .309 .RE 310 .PP 311 net usershare list wildcard -sharename312 .RS 3n313 To list user defined shares .314 .RE 315 .PP 316 net usershare info wildcard -sharename317 .RS 3n318 To print information about user defined shares .322 .RS 4 323 To delete a user defined share\. 324 .RE 325 .PP 326 net usershare list wildcard\-sharename 327 .RS 4 328 To list user defined shares\. 329 .RE 330 .PP 331 net usershare info wildcard\-sharename 332 .RS 4 333 To print information about user defined shares\. 319 334 .RE 320 335 .SH "PARAMETERS" 321 336 .PP 322 Parameters define the specific attributes of sections .323 .PP 324 Some parameters are specific to the [global] section (e .g.,325 \f Bsecurity\fR). Some parameters are usable in all sections (e.g.,326 \f Bcreate mask\fR). All others are permissible only in normal sections. For the purposes of the following descriptions the [homes] and [printers] sections will be considered normal. The letter327 \f BG\fR328 in parentheses indicates that a parameter is specific to the [global] section . The letter329 \f BS\fR330 indicates that a parameter can be specified in a service specific section . All331 \f BS\fR332 parameters can also be specified in the [global] section - in which case they will define the default behavior for all services.333 .PP 334 Parameters are arranged here in alphabetical order - this may not create best bedfellows, but at least you can find them! Where there are synonyms, the preferred synonym is described, others refer to the preferred synonym.337 Parameters define the specific attributes of sections\. 338 .PP 339 Some parameters are specific to the [global] section (e\.g\., 340 \fIsecurity\fR)\. Some parameters are usable in all sections (e\.g\., 341 \fIcreate mask\fR)\. All others are permissible only in normal sections\. For the purposes of the following descriptions the [homes] and [printers] sections will be considered normal\. The letter 342 \fIG\fR 343 in parentheses indicates that a parameter is specific to the [global] section\. The letter 344 \fIS\fR 345 indicates that a parameter can be specified in a service specific section\. All 346 \fIS\fR 347 parameters can also be specified in the [global] section \- in which case they will define the default behavior for all services\. 348 .PP 349 Parameters are arranged here in alphabetical order \- this may not create best bedfellows, but at least you can find them! Where there are synonyms, the preferred synonym is described, others refer to the preferred synonym\. 335 350 .SH "VARIABLE SUBSTITUTIONS" 336 351 .PP 337 Many of the strings that are settable in the config file can take substitutions . For example the option338 \ fBpath = /tmp/%u\fR352 Many of the strings that are settable in the config file can take substitutions\. For example the option 353 \(lqpath = /tmp/%u\(rq 339 354 is interpreted as 340 \ fBpath = /tmp/john\fR341 if the user connected with the username john .342 .PP 343 These substitutions are mostly noted in the descriptions below, but there are some general substitutions which apply whenever they might be relevant . These are:355 \(lqpath = /tmp/john\(rq 356 if the user connected with the username john\. 357 .PP 358 These substitutions are mostly noted in the descriptions below, but there are some general substitutions which apply whenever they might be relevant\. These are: 344 359 .PP 345 360 %U 346 .RS 3n347 session username (the username that the client wanted, not necessarily the same as the one they got) .361 .RS 4 362 session username (the username that the client wanted, not necessarily the same as the one they got)\. 348 363 .RE 349 364 .PP 350 365 %G 351 .RS 3n352 primary group name of %U .366 .RS 4 367 primary group name of %U\. 353 368 .RE 354 369 .PP 355 370 %h 356 .RS 3n357 the Internet hostname that Samba is running on .371 .RS 4 372 the Internet hostname that Samba is running on\. 358 373 .RE 359 374 .PP 360 375 %m 361 .RS 3n362 the NetBIOS name of the client machine (very useful) .363 .sp 364 This parameter is not available when Samba listens on port 445, as clients no longer send this information . If you use this macro in an include statement on a domain that has a Samba domain controller be sure to set in the [global] section365 \fIsmb ports = 139\fR . This will cause Samba to not listen on port 445 and will permit include functionality to function as it did with Samba 2.x.376 .RS 4 377 the NetBIOS name of the client machine (very useful)\. 378 .sp 379 This parameter is not available when Samba listens on port 445, as clients no longer send this information\. If you use this macro in an include statement on a domain that has a Samba domain controller be sure to set in the [global] section 380 \fIsmb ports = 139\fR\. This will cause Samba to not listen on port 445 and will permit include functionality to function as it did with Samba 2\.x\. 366 381 .RE 367 382 .PP 368 383 %L 369 .RS 3n370 the NetBIOS name of the server . This allows you to change your config based on what the client calls you. Your server can have a371 \ fBdual personality\fR.384 .RS 4 385 the NetBIOS name of the server\. This allows you to change your config based on what the client calls you\. Your server can have a 386 \(lqdual personality\(rq\. 372 387 .RE 373 388 .PP 374 389 %M 375 .RS 3n376 the Internet name of the client machine .390 .RS 4 391 the Internet name of the client machine\. 377 392 .RE 378 393 .PP 379 394 %R 380 .RS 3n381 the selected protocol level after protocol negotiation . It can be one of CORE, COREPLUS, LANMAN1, LANMAN2 or NT1.395 .RS 4 396 the selected protocol level after protocol negotiation\. It can be one of CORE, COREPLUS, LANMAN1, LANMAN2 or NT1\. 382 397 .RE 383 398 .PP 384 399 %d 385 .RS 3n386 the process id of the current server process .400 .RS 4 401 the process id of the current server process\. 387 402 .RE 388 403 .PP 389 404 %a 390 .RS 3n391 the architecture of the remote machine. It currently recognizes Samba (\fBSamba\fR), the Linux CIFS file system (\fBCIFSFS\fR), OS/2, (\fBOS2\fR), Windows for Workgroups (\fBWfWg\fR), Windows 9x/ME (\fBWin95\fR), Windows NT (\fBWinNT\fR), Windows 2000 (\fBWin2K\fR), Windows XP (\fBWinXP\fR), and Windows 2003 (\fBWin2K3\fR). Anything else will be known as392 \fBUNKNOWN\fR .405 .RS 4 406 The architecture of the remote machine\. It currently recognizes Samba (\fBSamba\fR), the Linux CIFS file system (\fBCIFSFS\fR), OS/2, (\fBOS2\fR), Windows for Workgroups (\fBWfWg\fR), Windows 9x/ME (\fBWin95\fR), Windows NT (\fBWinNT\fR), Windows 2000 (\fBWin2K\fR), Windows XP (\fBWinXP\fR), Windows XP 64\-bit(\fBWinXP64\fR), Windows 2003 including 2003R2 (\fBWin2K3\fR), and Windows Vista (\fBVista\fR)\. Anything else will be known as 407 \fBUNKNOWN\fR\. 393 408 .RE 394 409 .PP 395 410 %I 396 .RS 3n397 the IP address of the client machine .411 .RS 4 412 the IP address of the client machine\. 398 413 .RE 399 414 .PP 400 415 %i 401 .RS 3n402 the local IP address to which a client connected .416 .RS 4 417 the local IP address to which a client connected\. 403 418 .RE 404 419 .PP 405 420 %T 406 .RS 3n407 the current date and time .421 .RS 4 422 the current date and time\. 408 423 .RE 409 424 .PP 410 425 %D 411 .RS 3n412 name of the domain or workgroup of the current user .426 .RS 4 427 name of the domain or workgroup of the current user\. 413 428 .RE 414 429 .PP 415 430 %w 416 .RS 3n417 the winbind separator .431 .RS 4 432 the winbind separator\. 418 433 .RE 419 434 .PP 420 435 %$(\fIenvvar\fR) 421 .RS 3n436 .RS 4 422 437 the value of the environment variable 423 \fIenvar\fR .438 \fIenvar\fR\. 424 439 .RE 425 440 .PP … … 427 442 .PP 428 443 %S 429 .RS 3n430 the name of the current service, if any .444 .RS 4 445 the name of the current service, if any\. 431 446 .RE 432 447 .PP 433 448 %P 434 .RS 3n435 the root directory of the current service, if any .449 .RS 4 450 the root directory of the current service, if any\. 436 451 .RE 437 452 .PP 438 453 %u 439 .RS 3n440 username of the current service, if any .454 .RS 4 455 username of the current service, if any\. 441 456 .RE 442 457 .PP 443 458 %g 444 .RS 3n445 primary group name of %u .459 .RS 4 460 primary group name of %u\. 446 461 .RE 447 462 .PP 448 463 %H 449 .RS 3n450 the home directory of the user given by %u .464 .RS 4 465 the home directory of the user given by %u\. 451 466 .RE 452 467 .PP 453 468 %N 454 .RS 3n455 the name of your NIS home directory server . This is obtained from your NIS auto.map entry. If you have not compiled Samba with the456 \f B--with-automount\fR457 option, this value will be the same as %L .469 .RS 4 470 the name of your NIS home directory server\. This is obtained from your NIS auto\.map entry\. If you have not compiled Samba with the 471 \fI\-\-with\-automount\fR 472 option, this value will be the same as %L\. 458 473 .RE 459 474 .PP 460 475 %p 461 .RS 3n462 the path of the service 's home directory, obtained from your NIS auto.map entry. The NIS auto.map entry is split up as463 %N:%p .476 .RS 4 477 the path of the service\'s home directory, obtained from your NIS auto\.map entry\. The NIS auto\.map entry is split up as 478 %N:%p\. 464 479 .RE 465 480 .PP 466 481 There are some quite creative things that can be done with these substitutions and other 467 \fIsmb .conf\fR468 options .482 \fIsmb\.conf\fR 483 options\. 469 484 .SH "NAME MANGLING" 470 485 .PP 471 486 Samba supports 472 487 name mangling 473 so that DOS and Windows clients can use files that don 't conform to the 8.3 format. It can also be set to adjust the case of 8.3 format filenames.474 .PP 475 There are several options that control the way mangling is performed, and they are grouped here rather than listed separately . For the defaults look at the output of the testparm program.476 .PP 477 These options can be set separately for each service .488 so that DOS and Windows clients can use files that don\'t conform to the 8\.3 format\. It can also be set to adjust the case of 8\.3 format filenames\. 489 .PP 490 There are several options that control the way mangling is performed, and they are grouped here rather than listed separately\. For the defaults look at the output of the testparm program\. 491 .PP 492 These options can be set separately for each service\. 478 493 .PP 479 494 The options are: 480 495 .PP 481 496 case sensitive = yes/no/auto 482 .RS 3n483 controls whether filenames are case sensitive . If they aren't, Samba must do a filename search and match on passed names. The default setting of auto allows clients that support case sensitive filenames (Linux CIFSVFS and smbclient 3.0.5 and above currently) to tell the Samba server on a per-packet basis that they wish to access the file system in a case-sensitive manner (to support UNIX case sensitive semantics). No Windows or DOS system supports case-sensitive filename so setting this option to auto is that same as setting it to no for them. Default484 \f Bauto\fR.497 .RS 4 498 controls whether filenames are case sensitive\. If they aren\'t, Samba must do a filename search and match on passed names\. The default setting of auto allows clients that support case sensitive filenames (Linux CIFSVFS and smbclient 3\.0\.5 and above currently) to tell the Samba server on a per\-packet basis that they wish to access the file system in a case\-sensitive manner (to support UNIX case sensitive semantics)\. No Windows or DOS system supports case\-sensitive filename so setting this option to auto is that same as setting it to no for them\. Default 499 \fIauto\fR\. 485 500 .RE 486 501 .PP 487 502 default case = upper/lower 488 .RS 3n489 controls what the default case is for new filenames (ie . files that don't currently exist in the filesystem). Default490 \f Blower\fR. IMPORTANT NOTE: This option will be used to modify the case of491 \f Ball\fR503 .RS 4 504 controls what the default case is for new filenames (ie\. files that don\'t currently exist in the filesystem)\. Default 505 \fIlower\fR\. IMPORTANT NOTE: This option will be used to modify the case of 506 \fIall\fR 492 507 incoming client filenames, not just new filenames if the options 493 case sensitive = yes, 494 preserve case = No, 495 short preserve case = No are set. This change is needed as part of the optimisations for directories containing large numbers of files. 508 \fIcase sensitive = yes\fR, 509 \fIpreserve case = No\fR, 510 \fIshort preserve case = No\fR 511 are set\. This change is needed as part of the optimisations for directories containing large numbers of files\. 496 512 .RE 497 513 .PP 498 514 preserve case = yes/no 499 .RS 3n500 controls whether new files (ie . files that don't currently exist in the filesystem) are created with the case that the client passes, or if they are forced to be the515 .RS 4 516 controls whether new files (ie\. files that don\'t currently exist in the filesystem) are created with the case that the client passes, or if they are forced to be the 501 517 default 502 case . Default503 \f Byes\fR.518 case\. Default 519 \fIyes\fR\. 504 520 .RE 505 521 .PP 506 522 short preserve case = yes/no 507 .RS 3n508 controls if new files (ie . files that don't currently exist in the filesystem) which conform to 8.3 syntax, that is all in upper case and of suitable length, are created upper case, or if they are forced to be the523 .RS 4 524 controls if new files (ie\. files that don\'t currently exist in the filesystem) which conform to 8\.3 syntax, that is all in upper case and of suitable length, are created upper case, or if they are forced to be the 509 525 default 510 case . This option can be used with526 case\. This option can be used with 511 527 preserve case = yes 512 to permit long filenames to retain their case, while short names are lowercased . Default513 \f Byes\fR.514 .RE 515 .PP 516 By default, Samba 3 .0 has the same semantics as a Windows NT server, in that it is case insensitive but case preserving. As a special case for directories with large numbers of files, if the case options are set as follows, "case sensitive = yes", "case preserve = no", "short preserve case = no" then the "default case" option will be applied and will modify all filenames sent from the client when accessing this share.528 to permit long filenames to retain their case, while short names are lowercased\. Default 529 \fIyes\fR\. 530 .RE 531 .PP 532 By default, Samba 3\.0 has the same semantics as a Windows NT server, in that it is case insensitive but case preserving\. As a special case for directories with large numbers of files, if the case options are set as follows, "case sensitive = yes", "case preserve = no", "short preserve case = no" then the "default case" option will be applied and will modify all filenames sent from the client when accessing this share\. 517 533 .SH "NOTE ABOUT USERNAME/PASSWORD VALIDATION" 518 534 .PP 519 There are a number of ways in which a user can connect to a service . The server uses the following steps in determining if it will allow a connection to a specified service. If all the steps fail, the connection request is rejected. However, if one of the steps succeeds, the following steps are not checked.535 There are a number of ways in which a user can connect to a service\. The server uses the following steps in determining if it will allow a connection to a specified service\. If all the steps fail, the connection request is rejected\. However, if one of the steps succeeds, the following steps are not checked\. 520 536 .PP 521 537 If the service is marked 522 \fBguest only = yes\fR 523 and the server is running with share-level security (\fBsecurity = share\fR, steps 1 to 5 are skipped. 524 .TP 3n 525 1. 526 If the client has passed a username/password pair and that username/password pair is validated by the UNIX system's password programs, the connection is made as that username. This includes the 527 \\\\server\\service%\fIusername\fR 528 method of passing a username. 529 .TP 3n 530 2. 531 If the client has previously registered a username with the system and now supplies a correct password for that username, the connection is allowed. 532 .TP 3n 533 3. 534 The client's NetBIOS name and any previously used usernames are checked against the supplied password. If they match, the connection is allowed as the corresponding user. 535 .TP 3n 536 4. 537 If the client has previously validated a username/password pair with the server and the client has passed the validation token, that username is used. 538 .TP 3n 539 5. 540 If a 538 \(lqguest only = yes\(rq 539 and the server is running with share\-level security (\(lqsecurity = share\(rq, steps 1 to 5 are skipped\. 540 .sp 541 .RS 4 542 \h'-04' 1.\h'+02'If the client has passed a username/password pair and that username/password pair is validated by the UNIX system\'s password programs, the connection is made as that username\. This includes the 543 \e\eserver\eservice%\fIusername\fR 544 method of passing a username\. 545 .RE 546 .sp 547 .RS 4 548 \h'-04' 2.\h'+02'If the client has previously registered a username with the system and now supplies a correct password for that username, the connection is allowed\. 549 .RE 550 .sp 551 .RS 4 552 \h'-04' 3.\h'+02'The client\'s NetBIOS name and any previously used usernames are checked against the supplied password\. If they match, the connection is allowed as the corresponding user\. 553 .RE 554 .sp 555 .RS 4 556 \h'-04' 4.\h'+02'If the client has previously validated a username/password pair with the server and the client has passed the validation token, that username is used\. 557 .RE 558 .sp 559 .RS 4 560 \h'-04' 5.\h'+02'If a 541 561 user = 542 562 field is given in the 543 \fIsmb .conf\fR544 file for the service and the client has supplied a password, and that password matches (according to the UNIX system 's password checking) with one of the usernames from the563 \fIsmb\.conf\fR 564 file for the service and the client has supplied a password, and that password matches (according to the UNIX system\'s password checking) with one of the usernames from the 545 565 user = 546 566 field, the connection is made as the username in the 547 567 user = 548 line . If one of the usernames in the568 line\. If one of the usernames in the 549 569 user = 550 570 list begins with a 551 @, that name expands to a list of names in the group of the same name. 552 .TP 3n 553 6. 554 If the service is a guest service, a connection is made as the username given in the 571 @, that name expands to a list of names in the group of the same name\. 572 .RE 573 .sp 574 .RS 4 575 \h'-04' 6.\h'+02'If the service is a guest service, a connection is made as the username given in the 555 576 guest account = 556 for the service, irrespective of the supplied password. 577 for the service, irrespective of the supplied password\. 578 .RE 557 579 .SH "EXPLANATION OF EACH PARAMETER" 558 .PP 580 581 559 582 abort shutdown script (G) 560 .RS 3n 583 .PP 584 .RS 4 561 585 This a full path name to a script called by 562 586 \fBsmbd\fR(8) 563 587 that should stop a shutdown procedure issued by the 564 shutdown script.588 \fIshutdown script\fR\. 565 589 .sp 566 590 If the connected user posseses the 567 \fBSeRemoteShutdownPrivilege\fR, right, this command will be run as user .568 .sp 569 Default: 570 \f B\fIabort shutdown script\fR = ""\fR571 .sp 572 Example: 573 \f B\fIabort shutdown script\fR = /sbin/shutdown -c\fR574 .RE 575 .PP 591 \fBSeRemoteShutdownPrivilege\fR, right, this command will be run as user\. 592 .sp 593 Default: 594 \fI\fIabort shutdown script\fR\fR\fI = \fR\fI""\fR\fI \fR 595 .sp 596 Example: 597 \fI\fIabort shutdown script\fR\fR\fI = \fR\fI/sbin/shutdown \-c\fR\fI \fR 598 .RE 599 576 600 acl check permissions (S) 577 .RS 3n 601 .PP 602 .RS 4 578 603 This boolean parameter controls what 579 \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.580 .sp 581 If this parameter is set to "false" Samba doesn 't check permissions on "open for delete" and allows the open. If the user doesn't have permission to delete the file this will only be discovered at close time, which is too late for the Windows user tools to display an error message to the user. The symptom of this is files that appear to have been deleted "magically" re-appearing on a Windows explorer refersh. This is an extremely advanced protocol option which should not need to be changed. This parameter was introduced in its final form in 3.0.21, an earlier version with slightly different semantics was introduced in 3.0.20. That older version is not documented here.582 .sp 583 Default: 584 \f B\fIacl check permissions\fR = True\fR585 .RE 586 .PP 604 \fBsmbd\fR(8)does on receiving a protocol request of "open for delete" from a Windows client\. If a Windows client doesn\'t have permissions to delete a file then they expect this to be denied at open time\. POSIX systems normally only detect restrictions on delete by actually attempting to delete the file or directory\. As Windows clients can (and do) "back out" a delete request by unsetting the "delete on close" bit Samba cannot delete the file immediately on "open for delete" request as we cannot restore such a deleted file\. With this parameter set to true (the default) then smbd checks the file system permissions directly on "open for delete" and denies the request without actually deleting the file if the file system permissions would seem to deny it\. This is not perfect, as it\'s possible a user could have deleted a file without Samba being able to check the permissions correctly, but it is close enough to Windows semantics for mostly correct behaviour\. Samba will correctly check POSIX ACL semantics in this case\. 605 .sp 606 If this parameter is set to "false" Samba doesn\'t check permissions on "open for delete" and allows the open\. If the user doesn\'t have permission to delete the file this will only be discovered at close time, which is too late for the Windows user tools to display an error message to the user\. The symptom of this is files that appear to have been deleted "magically" re\-appearing on a Windows explorer refersh\. This is an extremely advanced protocol option which should not need to be changed\. This parameter was introduced in its final form in 3\.0\.21, an earlier version with slightly different semantics was introduced in 3\.0\.20\. That older version is not documented here\. 607 .sp 608 Default: 609 \fI\fIacl check permissions\fR\fR\fI = \fR\fITrue\fR\fI \fR 610 .RE 611 587 612 acl compatibility (S) 588 .RS 3n 589 This parameter specifies what OS ACL semantics should be compatible with. Possible values are 590 \fBwinnt\fR 613 .PP 614 .RS 4 615 This parameter specifies what OS ACL semantics should be compatible with\. Possible values are 616 \fIwinnt\fR 591 617 for Windows NT 4, 592 \f Bwin2k\fR618 \fIwin2k\fR 593 619 for Windows 2000 and above and 594 \f Bauto\fR. If you specify595 \f Bauto\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.596 .sp 597 Default: 598 \f B\fIacl compatibility\fR = Auto\fR599 .sp 600 Example: 601 \f B\fIacl compatibility\fR = win2k\fR602 .RE 603 .PP 620 \fIauto\fR\. If you specify 621 \fIauto\fR, the value for this parameter will be based upon the version of the client\. There should be no reason to change this parameter from the default\. 622 .sp 623 Default: 624 \fI\fIacl compatibility\fR\fR\fI = \fR\fIAuto\fR\fI \fR 625 .sp 626 Example: 627 \fI\fIacl compatibility\fR\fR\fI = \fR\fIwin2k\fR\fI \fR 628 .RE 629 604 630 acl group control (S) 605 .RS 3n 606 In a POSIX filesystem, only the owner of a file or directory and the superuser can modify the permissions and ACLs on a file. If this parameter is set, then Samba overrides this restriction, and also allows the 607 \fBprimary group owner\fR 608 of a file or directory to modify the permissions and ACLs on that file. 609 .sp 610 On a Windows server, groups may be the owner of a file or directory - thus allowing anyone in that group to modify the permissions on it. This allows the delegation of security controls on a point in the filesystem to the group owner of a directory and anything below it also owned by that group. This means there are multiple people with permissions to modify ACLs on a file or directory, easing managability. 611 .sp 612 This parameter allows Samba to also permit delegation of the control over a point in the exported directory hierarchy in much the same was as Windows. This allows all members of a UNIX group to control the permissions on a file or directory they have group ownership on. 631 .PP 632 .RS 4 633 In a POSIX filesystem, only the owner of a file or directory and the superuser can modify the permissions and ACLs on a file\. If this parameter is set, then Samba overrides this restriction, and also allows the 634 \fIprimary group owner\fR 635 of a file or directory to modify the permissions and ACLs on that file\. 636 .sp 637 On a Windows server, groups may be the owner of a file or directory \- thus allowing anyone in that group to modify the permissions on it\. This allows the delegation of security controls on a point in the filesystem to the group owner of a directory and anything below it also owned by that group\. This means there are multiple people with permissions to modify ACLs on a file or directory, easing managability\. 638 .sp 639 This parameter allows Samba to also permit delegation of the control over a point in the exported directory hierarchy in much the same way as Windows\. This allows all members of a UNIX group to control the permissions on a file or directory they have group ownership on\. 613 640 .sp 614 641 This parameter is best used with the 615 inherit owner option and also on on a share containing directories with the UNIX 616 \fBsetgid bit\fR 617 bit set on them, which causes new files and directories created within it to inherit the group ownership from the containing directory. 618 .sp 619 This is parameter has been marked deprecated in Samba 3.0.23. The same behavior is now implemented by the 642 \fIinherit owner\fR 643 option and also on on a share containing directories with the UNIX 644 \fIsetgid bit\fR 645 set on them, which causes new files and directories created within it to inherit the group ownership from the containing directory\. 646 .sp 647 This is parameter has been marked deprecated in Samba 3\.0\.23\. The same behavior is now implemented by the 620 648 \fIdos filemode\fR 621 option .622 .sp 623 Default: 624 \f B\fIacl group control\fR = no\fR625 .RE 626 .PP 649 option\. 650 .sp 651 Default: 652 \fI\fIacl group control\fR\fR\fI = \fR\fIno\fR\fI \fR 653 .RE 654 627 655 acl map full control (S) 628 .RS 3n 656 .PP 657 .RS 4 629 658 This boolean parameter controls whether 630 \fBsmbd\fR(8)maps a POSIX ACE entry of "rwx" (read/write/execute), the maximum allowed POSIX permission set, into a Windows ACL of "FULL CONTROL" . If this parameter is set to true any POSIX ACE entry of "rwx" will be returned in a Windows ACL as "FULL CONTROL", is this parameter is set to false any POSIX ACE entry of "rwx" will be returned as the specific Windows ACL bits representing read, write and execute.631 .sp 632 Default: 633 \f B\fIacl map full control\fR = True\fR634 .RE 635 .PP 659 \fBsmbd\fR(8)maps a POSIX ACE entry of "rwx" (read/write/execute), the maximum allowed POSIX permission set, into a Windows ACL of "FULL CONTROL"\. If this parameter is set to true any POSIX ACE entry of "rwx" will be returned in a Windows ACL as "FULL CONTROL", is this parameter is set to false any POSIX ACE entry of "rwx" will be returned as the specific Windows ACL bits representing read, write and execute\. 660 .sp 661 Default: 662 \fI\fIacl map full control\fR\fR\fI = \fR\fITrue\fR\fI \fR 663 .RE 664 636 665 add group script (G) 637 .RS 3n 666 .PP 667 .RS 4 638 668 This is the full pathname to a script that will be run 639 \f BAS ROOT\fR669 \fIAS ROOT\fR 640 670 by 641 671 \fBsmbd\fR(8) 642 when a new group is requested . It will expand any672 when a new group is requested\. It will expand any 643 673 \fI%g\fR 644 to the group name passed . This script is only useful for installations using the Windows NT domain administration tools. The script is free to create a group with an arbitrary name to circumvent unix group name restrictions. In that case the script must print the numeric gid of the created group on stdout.645 .sp 646 Default: 647 \f B\fIadd group script\fR =\fR648 .sp 649 Example: 650 \f B\fIadd group script\fR = /usr/sbin/groupadd %g\fR651 .RE 652 .PP 674 to the group name passed\. This script is only useful for installations using the Windows NT domain administration tools\. The script is free to create a group with an arbitrary name to circumvent unix group name restrictions\. In that case the script must print the numeric gid of the created group on stdout\. 675 .sp 676 Default: 677 \fI\fIadd group script\fR\fR\fI = \fR\fI\fR\fI \fR 678 .sp 679 Example: 680 \fI\fIadd group script\fR\fR\fI = \fR\fI/usr/sbin/groupadd %g\fR\fI \fR 681 .RE 682 653 683 add machine script (G) 654 .RS 3n 684 .PP 685 .RS 4 655 686 This is the full pathname to a script that will be run by 656 687 \fBsmbd\fR(8) 657 when a machine is added to Samba 's domain and a Unix account matching the machine's name appended with a "$" does not already exist.688 when a machine is added to Samba\'s domain and a Unix account matching the machine\'s name appended with a "$" does not already exist\. 658 689 .sp 659 690 This option is very similar to the 660 add user script, and likewise uses the %u substitution for the account name. Do not use the %m substitution.661 .sp 662 Default: 663 \f B\fIadd machine script\fR =\fR664 .sp 665 Example: 666 \f B\fIadd machine script\fR = /usr/sbin/adduser -n -g machines -c Machine -d /var/lib/nobody -s /bin/false %u\fR667 .RE 668 .PP 691 \fIadd user script\fR, and likewise uses the %u substitution for the account name\. Do not use the %m substitution\. 692 .sp 693 Default: 694 \fI\fIadd machine script\fR\fR\fI = \fR\fI\fR\fI \fR 695 .sp 696 Example: 697 \fI\fIadd machine script\fR\fR\fI = \fR\fI/usr/sbin/adduser \-n \-g machines \-c Machine \-d /var/lib/nobody \-s /bin/false %u\fR\fI \fR 698 .RE 699 669 700 add port command (G) 670 .RS 3n 671 Samba 3.0.23 introduces 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. he script is passed two parameters: 672 .RS 3n 673 .TP 3n 674 \(bu 701 .PP 702 .RS 4 703 Samba 3\.0\.23 introduced support for adding printer ports remotely using the Windows "Add Standard TCP/IP Port Wizard"\. This option defines an external program to be executed when smbd receives a request to add a new Port to the system\. The script is passed two parameters: 704 .sp 705 .RS 4 706 .ie n \{\ 707 \h'-04'\(bu\h'+03'\c 708 .\} 709 .el \{\ 710 .sp -1 711 .IP \(bu 2.3 712 .\} 675 713 \fIport name\fR 676 .TP 3n 677 \(bu 714 .RE 715 .sp 716 .RS 4 717 .ie n \{\ 718 \h'-04'\(bu\h'+03'\c 719 .\} 720 .el \{\ 721 .sp -1 722 .IP \(bu 2.3 723 .\} 678 724 \fIdevice URI\fR 679 . RE680 . IP "" 3n681 The deviceURI is in the for of socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename> .682 .sp 683 Default: 684 \f B\fIadd port command\fR =\fR685 .sp 686 Example: 687 \f B\fIadd port command\fR = /etc/samba/scripts/addport.sh\fR688 .RE 689 .PP 725 .sp 726 .RE 727 The deviceURI is in the for of socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename>\. 728 .sp 729 Default: 730 \fI\fIadd port command\fR\fR\fI = \fR\fI\fR\fI \fR 731 .sp 732 Example: 733 \fI\fIadd port command\fR\fR\fI = \fR\fI/etc/samba/scripts/addport\.sh\fR\fI \fR 734 .RE 735 690 736 add printer command (G) 691 .RS 3n 692 With the introduction of MS-RPC based printing support for Windows NT/2000 clients in Samba 2.2, The MS Add Printer Wizard (APW) icon is now also available in the "Printers..." folder displayed a share listing. The APW allows for printers to be add remotely to a Samba or Windows NT/2000 print server. 693 .sp 694 For a Samba host this means that the printer must be physically added to the underlying printing system. The 737 .PP 738 .RS 4 739 With the introduction of MS\-RPC based printing support for Windows NT/2000 clients in Samba 2\.2, The MS Add Printer Wizard (APW) icon is now also available in the "Printers\.\.\." folder displayed a share listing\. The APW allows for printers to be add remotely to a Samba or Windows NT/2000 print server\. 740 .sp 741 For a Samba host this means that the printer must be physically added to the underlying printing system\. The 695 742 \fIadd printer command\fR 696 743 defines a script to be run which will perform the necessary operations for adding the printer to the print system and to add the appropriate service definition to the 697 \fIsmb .conf\fR744 \fIsmb\.conf\fR 698 745 file in order that it can be shared by 699 \fBsmbd\fR(8) .746 \fBsmbd\fR(8)\. 700 747 .sp 701 748 The 702 749 \fIaddprinter command\fR 703 750 is automatically invoked with the following parameter (in order): 704 .RS 3n 705 .TP 3n 706 \(bu 751 .sp 752 .RS 4 753 .ie n \{\ 754 \h'-04'\(bu\h'+03'\c 755 .\} 756 .el \{\ 757 .sp -1 758 .IP \(bu 2.3 759 .\} 707 760 \fIprinter name\fR 708 .TP 3n 709 \(bu 761 .RE 762 .sp 763 .RS 4 764 .ie n \{\ 765 \h'-04'\(bu\h'+03'\c 766 .\} 767 .el \{\ 768 .sp -1 769 .IP \(bu 2.3 770 .\} 710 771 \fIshare name\fR 711 .TP 3n 712 \(bu 772 .RE 773 .sp 774 .RS 4 775 .ie n \{\ 776 \h'-04'\(bu\h'+03'\c 777 .\} 778 .el \{\ 779 .sp -1 780 .IP \(bu 2.3 781 .\} 713 782 \fIport name\fR 714 .TP 3n 715 \(bu 783 .RE 784 .sp 785 .RS 4 786 .ie n \{\ 787 \h'-04'\(bu\h'+03'\c 788 .\} 789 .el \{\ 790 .sp -1 791 .IP \(bu 2.3 792 .\} 716 793 \fIdriver name\fR 717 .TP 3n 718 \(bu 794 .RE 795 .sp 796 .RS 4 797 .ie n \{\ 798 \h'-04'\(bu\h'+03'\c 799 .\} 800 .el \{\ 801 .sp -1 802 .IP \(bu 2.3 803 .\} 719 804 \fIlocation\fR 720 .TP 3n 721 \(bu 805 .RE 806 .sp 807 .RS 4 808 .ie n \{\ 809 \h'-04'\(bu\h'+03'\c 810 .\} 811 .el \{\ 812 .sp -1 813 .IP \(bu 2.3 814 .\} 722 815 \fIWindows 9x driver location\fR 723 . RE724 . IP "" 3n725 All parameters are filled in from the PRINTER_INFO_2 structure sent by the Windows NT/2000 client with one exception . The "Windows 9x driver location" parameter is included for backwards compatibility only. The remaining fields in the structure are generated from answers to the APW questions.816 .sp 817 .RE 818 All parameters are filled in from the PRINTER_INFO_2 structure sent by the Windows NT/2000 client with one exception\. The "Windows 9x driver location" parameter is included for backwards compatibility only\. The remaining fields in the structure are generated from answers to the APW questions\. 726 819 .sp 727 820 Once the … … 730 823 smbd 731 824 will reparse the 732 \fI smb .conf\fR733 to determine if the share defined by the APW exists . If the sharename is still invalid, then825 \fI smb\.conf\fR 826 to determine if the share defined by the APW exists\. If the sharename is still invalid, then 734 827 smbd 735 will return an ACCESS_DENIED error to the client .736 .sp 737 The "add printer command" program can output a single line of text, which Samba will set as the port the new printer is connected to . If this line isn't output, Samba won't reload its printer shares.738 .sp 739 Default: 740 \f B\fIadd printer command\fR =\fR741 .sp 742 Example: 743 \f B\fIadd printer command\fR = /usr/bin/addprinter\fR744 .RE 745 .PP 828 will return an ACCESS_DENIED error to the client\. 829 .sp 830 The "add printer command" program can output a single line of text, which Samba will set as the port the new printer is connected to\. If this line isn\'t output, Samba won\'t reload its printer shares\. 831 .sp 832 Default: 833 \fI\fIadd printer command\fR\fR\fI = \fR\fI\fR\fI \fR 834 .sp 835 Example: 836 \fI\fIadd printer command\fR\fR\fI = \fR\fI/usr/bin/addprinter\fR\fI \fR 837 .RE 838 746 839 add share command (G) 747 .RS 3n 748 Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server Manager. The 840 .PP 841 .RS 4 842 Samba 2\.2\.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\.0 Server Manager\. The 749 843 \fIadd share command\fR 750 844 is used to define an external program or script which will add a new service definition to 751 \fIsmb .conf\fR. In order to successfully execute the845 \fIsmb\.conf\fR\. In order to successfully execute the 752 846 \fIadd share command\fR, 753 847 smbd 754 requires that the administrator be connected using a root account (i.e. uid == 0). 848 requires that the administrator be connected using a root account (i\.e\. uid == 0)\. 849 .sp 850 If the connected account has 851 SeDiskOperatorPrivilege, scripts defined in 852 \fIchange share\fR 853 parameter are executed as root\. 755 854 .sp 756 855 When executed, … … 758 857 will automatically invoke the 759 858 \fIadd share command\fR 760 with five parameters. 761 .RS 3n 762 .TP 3n 763 \(bu 859 with five parameters\. 860 .sp 861 .RS 4 862 .ie n \{\ 863 \h'-04'\(bu\h'+03'\c 864 .\} 865 .el \{\ 866 .sp -1 867 .IP \(bu 2.3 868 .\} 764 869 \fIconfigFile\fR 765 - the location of the global 766 \fIsmb.conf\fR 767 file. 768 .TP 3n 769 \(bu 870 \- the location of the global 871 \fIsmb\.conf\fR 872 file\. 873 .RE 874 .sp 875 .RS 4 876 .ie n \{\ 877 \h'-04'\(bu\h'+03'\c 878 .\} 879 .el \{\ 880 .sp -1 881 .IP \(bu 2.3 882 .\} 770 883 \fIshareName\fR 771 - the name of the new share. 772 .TP 3n 773 \(bu 884 \- the name of the new share\. 885 .RE 886 .sp 887 .RS 4 888 .ie n \{\ 889 \h'-04'\(bu\h'+03'\c 890 .\} 891 .el \{\ 892 .sp -1 893 .IP \(bu 2.3 894 .\} 774 895 \fIpathName\fR 775 - path to an **existing** directory on disk. 776 .TP 3n 777 \(bu 896 \- path to an **existing** directory on disk\. 897 .RE 898 .sp 899 .RS 4 900 .ie n \{\ 901 \h'-04'\(bu\h'+03'\c 902 .\} 903 .el \{\ 904 .sp -1 905 .IP \(bu 2.3 906 .\} 778 907 \fIcomment\fR 779 - comment string to associate with the new share. 780 .TP 3n 781 \(bu 908 \- comment string to associate with the new share\. 909 .RE 910 .sp 911 .RS 4 912 .ie n \{\ 913 \h'-04'\(bu\h'+03'\c 914 .\} 915 .el \{\ 916 .sp -1 917 .IP \(bu 2.3 918 .\} 782 919 \fImax connections\fR 783 Number of maximum simultaneous connections to this share .784 . RE785 . IP "" 3n786 This parameter is only used for add file shares . To add printer shares, see the787 addprinter command.788 .sp 789 Default: 790 \f B\fIadd share command\fR =\fR791 .sp 792 Example: 793 \f B\fIadd share command\fR = /usr/local/bin/addshare\fR794 .RE 795 .PP 920 Number of maximum simultaneous connections to this share\. 921 .sp 922 .RE 923 This parameter is only used for add file shares\. To add printer shares, see the 924 \fIaddprinter command\fR\. 925 .sp 926 Default: 927 \fI\fIadd share command\fR\fR\fI = \fR\fI\fR\fI \fR 928 .sp 929 Example: 930 \fI\fIadd share command\fR\fR\fI = \fR\fI/usr/local/bin/addshare\fR\fI \fR 931 .RE 932 796 933 add user script (G) 797 .RS 3n 934 .PP 935 .RS 4 798 936 This is the full pathname to a script that will be run 799 \f BAS ROOT\fR937 \fIAS ROOT\fR 800 938 by 801 939 \fBsmbd\fR(8) 802 under special circumstances described below .803 .sp 804 Normally, a Samba server requires that UNIX users are created for all users accessing files on this server . For sites that use Windows NT account databases as their primary user database creating these users and keeping the user list in sync with the Windows NT PDC is an onerous task. This option allows smbd to create the required UNIX users805 \f BON DEMAND\fR806 when a user accesses the Samba server .940 under special circumstances described below\. 941 .sp 942 Normally, a Samba server requires that UNIX users are created for all users accessing files on this server\. For sites that use Windows NT account databases as their primary user database creating these users and keeping the user list in sync with the Windows NT PDC is an onerous task\. This option allows smbd to create the required UNIX users 943 \fION DEMAND\fR 944 when a user accesses the Samba server\. 807 945 .sp 808 946 In order to use this option, 809 947 \fBsmbd\fR(8) 810 948 must 811 \f BNOT\fR949 \fINOT\fR 812 950 be set to 813 security = share and 814 add user script must be set to a full pathname for a script that will create a UNIX user given one argument of 815 \fI%u\fR, which expands into the UNIX user name to create. 951 \fIsecurity = share\fR 952 and 953 \fIadd user script\fR 954 must be set to a full pathname for a script that will create a UNIX user given one argument of 955 \fI%u\fR, which expands into the UNIX user name to create\. 816 956 .sp 817 957 When the Windows user attempts to access the Samba server, at login (session setup in the SMB protocol) time, 818 958 \fBsmbd\fR(8) 819 959 contacts the 820 password server and attempts to authenticate the given user with the given password. If the authentication succeeds then 960 \fIpassword server\fR 961 and attempts to authenticate the given user with the given password\. If the authentication succeeds then 821 962 smbd 822 attempts to find a UNIX user in the UNIX password database to map the Windows user into. If this lookup fails, and 823 add user script is set then 963 attempts to find a UNIX user in the UNIX password database to map the Windows user into\. If this lookup fails, and 964 \fIadd user script\fR 965 is set then 824 966 smbd 825 967 will call the specified script 826 \f BAS ROOT\fR, expanding any968 \fIAS ROOT\fR, expanding any 827 969 \fI%u\fR 828 argument to be the user name to create .970 argument to be the user name to create\. 829 971 .sp 830 972 If this script successfully creates the user then 831 973 smbd 832 will continue on as though the UNIX user already existed . In this way, UNIX users are dynamically created to match existing Windows NT accounts.974 will continue on as though the UNIX user already existed\. In this way, UNIX users are dynamically created to match existing Windows NT accounts\. 833 975 .sp 834 976 See also 835 security,836 password server,837 delete user script.838 .sp 839 Default: 840 \f B\fIadd user script\fR =\fR841 .sp 842 Example: 843 \f B\fIadd user script\fR = /usr/local/samba/bin/add_user %u\fR844 .RE 845 .PP 977 \fIsecurity\fR, 978 \fIpassword server\fR, 979 \fIdelete user script\fR\. 980 .sp 981 Default: 982 \fI\fIadd user script\fR\fR\fI = \fR\fI\fR\fI \fR 983 .sp 984 Example: 985 \fI\fIadd user script\fR\fR\fI = \fR\fI/usr/local/samba/bin/add_user %u\fR\fI \fR 986 .RE 987 846 988 add user to group script (G) 847 .RS 3n 848 Full path to the script that will be called when a user is added to a group using the Windows NT domain administration tools. It will be run by 989 .PP 990 .RS 4 991 Full path to the script that will be called when a user is added to a group using the Windows NT domain administration tools\. It will be run by 849 992 \fBsmbd\fR(8) 850 \f BAS ROOT\fR. Any993 \fIAS ROOT\fR\. Any 851 994 \fI%g\fR 852 995 will be replaced with the group name and any 853 996 \fI%u\fR 854 will be replaced with the user name .997 will be replaced with the user name\. 855 998 .sp 856 999 Note that the 857 1000 adduser 858 command used in the example below does not support the used syntax on all systems .859 .sp 860 Default: 861 \f B\fIadd user to group script\fR =\fR862 .sp 863 Example: 864 \f B\fIadd user to group script\fR = /usr/sbin/adduser %u %g\fR865 .RE 866 .PP 1001 command used in the example below does not support the used syntax on all systems\. 1002 .sp 1003 Default: 1004 \fI\fIadd user to group script\fR\fR\fI = \fR\fI\fR\fI \fR 1005 .sp 1006 Example: 1007 \fI\fIadd user to group script\fR\fR\fI = \fR\fI/usr/sbin/adduser %u %g\fR\fI \fR 1008 .RE 1009 867 1010 admin users (S) 868 .RS 3n 869 This is a list of users who will be granted administrative privileges on the share. This means that they will do all file operations as the super-user (root). 870 .sp 871 You should use this option very carefully, as any user in this list will be able to do anything they like on the share, irrespective of file permissions. 1011 .PP 1012 .RS 4 1013 This is a list of users who will be granted administrative privileges on the share\. This means that they will do all file operations as the super\-user (root)\. 1014 .sp 1015 You should use this option very carefully, as any user in this list will be able to do anything they like on the share, irrespective of file permissions\. 872 1016 .sp 873 1017 This parameter will not work with the 874 security = share in Samba 3.0. This is by design. 875 .sp 876 Default: 877 \fB\fIadmin users\fR = \fR 878 .sp 879 Example: 880 \fB\fIadmin users\fR = jason \fR 881 .RE 882 .PP 1018 \fIsecurity = share\fR 1019 in Samba 3\.0\. This is by design\. 1020 .sp 1021 Default: 1022 \fI\fIadmin users\fR\fR\fI = \fR\fI\fR\fI \fR 1023 .sp 1024 Example: 1025 \fI\fIadmin users\fR\fR\fI = \fR\fIjason\fR\fI \fR 1026 .RE 1027 883 1028 afs share (S) 884 .RS 3n 885 This parameter controls whether special AFS features are enabled for this share. If enabled, it assumes that the directory exported via the 1029 .PP 1030 .RS 4 1031 This parameter controls whether special AFS features are enabled for this share\. If enabled, it assumes that the directory exported via the 886 1032 \fIpath\fR 887 parameter is a local AFS import . The special AFS features include the attempt to hand-craft an AFS token if you enabled --with-fake-kaserver in configure.888 .sp 889 Default: 890 \f B\fIafs share\fR = no\fR891 .RE 892 .PP 1033 parameter is a local AFS import\. The special AFS features include the attempt to hand\-craft an AFS token if you enabled \-\-with\-fake\-kaserver in configure\. 1034 .sp 1035 Default: 1036 \fI\fIafs share\fR\fR\fI = \fR\fIno\fR\fI \fR 1037 .RE 1038 893 1039 afs username map (G) 894 .RS 3n 895 If you are using the fake kaserver AFS feature, you might want to hand-craft the usernames you are creating tokens for. For example this is necessary if you have users from several domain in your AFS Protection Database. One possible scheme to code users as DOMAIN+User as it is done by winbind with the + as a separator. 896 .sp 897 The mapped user name must contain the cell name to log into, so without setting this parameter there will be no token. 898 .sp 899 Default: 900 \fB\fIafs username map\fR = \fR 901 .sp 902 Example: 903 \fB\fIafs username map\fR = %u@afs.samba.org \fR 904 .RE 905 .PP 1040 .PP 1041 .RS 4 1042 If you are using the fake kaserver AFS feature, you might want to hand\-craft the usernames you are creating tokens for\. For example this is necessary if you have users from several domain in your AFS Protection Database\. One possible scheme to code users as DOMAIN+User as it is done by winbind with the + as a separator\. 1043 .sp 1044 The mapped user name must contain the cell name to log into, so without setting this parameter there will be no token\. 1045 .sp 1046 Default: 1047 \fI\fIafs username map\fR\fR\fI = \fR\fI\fR\fI \fR 1048 .sp 1049 Example: 1050 \fI\fIafs username map\fR\fR\fI = \fR\fI%u@afs\.samba\.org\fR\fI \fR 1051 .RE 1052 906 1053 aio read size (S) 907 .RS 3n 908 If Samba has been built with asynchronous I/O support and this integer parameter is set to non-zero value, Samba will read from file asynchronously when size of request is bigger than this value. Note that it happens only for non-chained and non-chaining reads and when not using write cache. 909 .sp 910 Current implementation of asynchronous I/O in Samba 3.0 does support only up to 10 outstanding asynchronous requests, read and write combined. 911 .sp 912 913 914 write cache size 915 aio write size 916 917 Default: 918 \fB\fIaio read size\fR = 0 \fR 919 .sp 920 Example: 921 \fB\fIaio read size\fR = 16384 # Use asynchronous I/O for reads bigger than 16KB request size \fR 922 .RE 923 .PP 1054 .PP 1055 .RS 4 1056 If Samba has been built with asynchronous I/O support and this integer parameter is set to non\-zero value, Samba will read from file asynchronously when size of request is bigger than this value\. Note that it happens only for non\-chained and non\-chaining reads and when not using write cache\. 1057 .sp 1058 Current implementation of asynchronous I/O in Samba 3\.0 does support only up to 10 outstanding asynchronous requests, read and write combined\. 1059 .sp 1060 Related command: 1061 \fIwrite cache size\fR 1062 .sp 1063 Related command: 1064 \fIaio write size\fR 1065 .sp 1066 Default: 1067 \fI\fIaio read size\fR\fR\fI = \fR\fI0\fR\fI \fR 1068 .sp 1069 Example: 1070 \fI\fIaio read size\fR\fR\fI = \fR\fI16384 # Use asynchronous I/O for reads bigger than 16KB request size\fR\fI \fR 1071 .RE 1072 924 1073 aio write size (S) 925 .RS 3n 926 If Samba has been built with asynchronous I/O support and this integer parameter is set to non-zero value, Samba will write to file asynchronously when size of request is bigger than this value. Note that it happens only for non-chained and non-chaining reads and when not using write cache. 927 .sp 928 Current implementation of asynchronous I/O in Samba 3.0 does support only up to 10 outstanding asynchronous requests, read and write combined. 929 .sp 930 931 932 write cache size 933 aio read size 934 935 Default: 936 \fB\fIaio write size\fR = 0 \fR 937 .sp 938 Example: 939 \fB\fIaio write size\fR = 16384 # Use asynchronous I/O for writes bigger than 16KB request size \fR 940 .RE 941 .PP 1074 .PP 1075 .RS 4 1076 If Samba has been built with asynchronous I/O support and this integer parameter is set to non\-zero value, Samba will write to file asynchronously when size of request is bigger than this value\. Note that it happens only for non\-chained and non\-chaining reads and when not using write cache\. 1077 .sp 1078 Current implementation of asynchronous I/O in Samba 3\.0 does support only up to 10 outstanding asynchronous requests, read and write combined\. 1079 .sp 1080 Related command: 1081 \fIwrite cache size\fR 1082 .sp 1083 Related command: 1084 \fIaio read size\fR 1085 .sp 1086 Default: 1087 \fI\fIaio write size\fR\fR\fI = \fR\fI0\fR\fI \fR 1088 .sp 1089 Example: 1090 \fI\fIaio write size\fR\fR\fI = \fR\fI16384 # Use asynchronous I/O for writes bigger than 16KB request size\fR\fI \fR 1091 .RE 1092 942 1093 algorithmic rid base (G) 943 .RS 3n 944 This determines how Samba will use its algorithmic mapping from uids/gid to the RIDs needed to construct NT Security Identifiers. 945 .sp 946 Setting this option to a larger value could be useful to sites transitioning from WinNT and Win2k, as existing user and group rids would otherwise clash with sytem users etc. 947 .sp 948 All UIDs and GIDs must be able to be resolved into SIDs for the correct operation of ACLs on the server. As such the algorithmic mapping can't be 'turned off', but pushing it 'out of the way' should resolve the issues. Users and groups can then be assigned 'low' RIDs in arbitary-rid supporting backends. 949 .sp 950 Default: 951 \fB\fIalgorithmic rid base\fR = 1000 \fR 952 .sp 953 Example: 954 \fB\fIalgorithmic rid base\fR = 100000 \fR 955 .RE 956 .PP 1094 .PP 1095 .RS 4 1096 This determines how Samba will use its algorithmic mapping from uids/gid to the RIDs needed to construct NT Security Identifiers\. 1097 .sp 1098 Setting this option to a larger value could be useful to sites transitioning from WinNT and Win2k, as existing user and group rids would otherwise clash with sytem users etc\. 1099 .sp 1100 All UIDs and GIDs must be able to be resolved into SIDs for the correct operation of ACLs on the server\. As such the algorithmic mapping can\'t be \'turned off\', but pushing it \'out of the way\' should resolve the issues\. Users and groups can then be assigned \'low\' RIDs in arbitrary\-rid supporting backends\. 1101 .sp 1102 Default: 1103 \fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI1000\fR\fI \fR 1104 .sp 1105 Example: 1106 \fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI100000\fR\fI \fR 1107 .RE 1108 957 1109 allocation roundup size (S) 958 .RS 3n 959 This parameter allows an administrator to tune the allocation size reported to Windows clients. The default size of 1Mb generally results in improved Windows client performance. However, rounding the allocation size may cause difficulties for some applications, e.g. MS Visual Studio. If the MS Visual Studio compiler starts to crash with an internal error, set this parameter to zero for this share. 960 .sp 961 The integer parameter specifies the roundup size in bytes. 962 .sp 963 Default: 964 \fB\fIallocation roundup size\fR = 1048576 \fR 965 .sp 966 Example: 967 \fB\fIallocation roundup size\fR = 0 # (to disable roundups) \fR 968 .RE 969 .PP 1110 .PP 1111 .RS 4 1112 This parameter allows an administrator to tune the allocation size reported to Windows clients\. The default size of 1Mb generally results in improved Windows client performance\. However, rounding the allocation size may cause difficulties for some applications, e\.g\. MS Visual Studio\. If the MS Visual Studio compiler starts to crash with an internal error, set this parameter to zero for this share\. 1113 .sp 1114 The integer parameter specifies the roundup size in bytes\. 1115 .sp 1116 Default: 1117 \fI\fIallocation roundup size\fR\fR\fI = \fR\fI1048576\fR\fI \fR 1118 .sp 1119 Example: 1120 \fI\fIallocation roundup size\fR\fR\fI = \fR\fI0 # (to disable roundups)\fR\fI \fR 1121 .RE 1122 970 1123 allow trusted domains (G) 971 .RS 3n 1124 .PP 1125 .RS 4 972 1126 This option only takes effect when the 973 security option is set to 1127 \fIsecurity\fR 1128 option is set to 974 1129 \fBserver\fR, 975 1130 \fBdomain\fR 976 1131 or 977 \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.978 .sp 979 This is useful if you only want your Samba server to serve resources to users in the domain it is a member of . As an example, suppose that there are two domains DOMA and DOMB. DOMB is trusted by DOMA, which contains the Samba server. Under normal circumstances, a user with an account in DOMB can then access the resources of a UNIX account with the same account name on the Samba server even if they do not have an account in DOMA. This can make implementing a security boundary difficult.980 .sp 981 Default: 982 \f B\fIallow trusted domains\fR = yes\fR983 .RE 984 .PP 1132 \fBads\fR\. If it is set to no, then attempts to connect to a resource from a domain or workgroup other than the one which smbd is running in will fail, even if that domain is trusted by the remote server doing the authentication\. 1133 .sp 1134 This is useful if you only want your Samba server to serve resources to users in the domain it is a member of\. As an example, suppose that there are two domains DOMA and DOMB\. DOMB is trusted by DOMA, which contains the Samba server\. Under normal circumstances, a user with an account in DOMB can then access the resources of a UNIX account with the same account name on the Samba server even if they do not have an account in DOMA\. This can make implementing a security boundary difficult\. 1135 .sp 1136 Default: 1137 \fI\fIallow trusted domains\fR\fR\fI = \fR\fIyes\fR\fI \fR 1138 .RE 1139 985 1140 announce as (G) 986 .RS 3n 1141 .PP 1142 .RS 4 987 1143 This specifies what type of server 988 1144 \fBnmbd\fR(8) 989 will announce itself as, to a network neighborhood browse list . By default this is set to Windows NT. The valid options are : "NT Server" (which can also be written as "NT"), "NT Workstation", "Win95" or "WfW" meaning Windows NT Server, Windows NT Workstation, Windows 95 and Windows for Workgroups respectively. Do not change this parameter unless you have a specific need to stop Samba appearing as an NT server as this may prevent Samba servers from participating as browser servers correctly.990 .sp 991 Default: 992 \f B\fIannounce as\fR = NT Server\fR993 .sp 994 Example: 995 \f B\fIannounce as\fR = Win95\fR996 .RE 997 .PP 1145 will announce itself as, to a network neighborhood browse list\. By default this is set to Windows NT\. The valid options are : "NT Server" (which can also be written as "NT"), "NT Workstation", "Win95" or "WfW" meaning Windows NT Server, Windows NT Workstation, Windows 95 and Windows for Workgroups respectively\. Do not change this parameter unless you have a specific need to stop Samba appearing as an NT server as this may prevent Samba servers from participating as browser servers correctly\. 1146 .sp 1147 Default: 1148 \fI\fIannounce as\fR\fR\fI = \fR\fINT Server\fR\fI \fR 1149 .sp 1150 Example: 1151 \fI\fIannounce as\fR\fR\fI = \fR\fIWin95\fR\fI \fR 1152 .RE 1153 998 1154 announce version (G) 999 .RS 3n 1000 This specifies the major and minor version numbers that nmbd will use when announcing itself as a server. The default is 4.9. Do not change this parameter unless you have a specific need to set a Samba server to be a downlevel server. 1001 .sp 1002 Default: 1003 \fB\fIannounce version\fR = 4.9 \fR 1004 .sp 1005 Example: 1006 \fB\fIannounce version\fR = 2.0 \fR 1007 .RE 1008 .PP 1155 .PP 1156 .RS 4 1157 This specifies the major and minor version numbers that nmbd will use when announcing itself as a server\. The default is 4\.9\. Do not change this parameter unless you have a specific need to set a Samba server to be a downlevel server\. 1158 .sp 1159 Default: 1160 \fI\fIannounce version\fR\fR\fI = \fR\fI4\.9\fR\fI \fR 1161 .sp 1162 Example: 1163 \fI\fIannounce version\fR\fR\fI = \fR\fI2\.0\fR\fI \fR 1164 .RE 1165 1009 1166 auth methods (G) 1010 .RS 3n 1167 .PP 1168 .RS 4 1011 1169 This option allows the administrator to chose what authentication methods 1012 1170 smbd 1013 will use when authenticating a user . This option defaults to sensible values based on1014 security. 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.1015 .sp 1016 Each entry in the list attempts to authenticate the user in turn, until the user authenticates . In practice only one method will ever actually be able to complete the authentication.1171 will use when authenticating a user\. This option defaults to sensible values based on 1172 \fIsecurity\fR\. This should be considered a developer option and used only in rare circumstances\. In the majority (if not all) of production servers, the default setting should be adequate\. 1173 .sp 1174 Each entry in the list attempts to authenticate the user in turn, until the user authenticates\. In practice only one method will ever actually be able to complete the authentication\. 1017 1175 .sp 1018 1176 Possible options include … … 1024 1182 (relay authentication requests for remote users through winbindd), 1025 1183 \fBntdomain\fR 1026 (pre -winbindd method of authentication for remote domain users; deprecated in favour of winbind method),1184 (pre\-winbindd method of authentication for remote domain users; deprecated in favour of winbind method), 1027 1185 \fBtrustdomain\fR 1028 (authenticate trusted users by contacting the remote DC directly from smbd; deprecated in favour of winbind method) .1029 .sp 1030 Default: 1031 \f B\fIauth methods\fR =\fR1032 .sp 1033 Example: 1034 \f B\fIauth methods\fR = guest sam winbind\fR1035 .RE 1036 .PP 1186 (authenticate trusted users by contacting the remote DC directly from smbd; deprecated in favour of winbind method)\. 1187 .sp 1188 Default: 1189 \fI\fIauth methods\fR\fR\fI = \fR\fI\fR\fI \fR 1190 .sp 1191 Example: 1192 \fI\fIauth methods\fR\fR\fI = \fR\fIguest sam winbind\fR\fI \fR 1193 .RE 1194 1037 1195 available (S) 1038 .RS 3n 1039 This parameter lets you "turn off" a service. If 1196 .PP 1197 .RS 4 1198 This parameter lets you "turn off" a service\. If 1040 1199 \fIavailable = no\fR, then 1041 \f BALL\fR1042 attempts to connect to the service will fail . Such failures are logged.1043 .sp 1044 Default: 1045 \f B\fIavailable\fR = yes\fR1046 .RE 1047 .PP 1200 \fIALL\fR 1201 attempts to connect to the service will fail\. Such failures are logged\. 1202 .sp 1203 Default: 1204 \fI\fIavailable\fR\fR\fI = \fR\fIyes\fR\fI \fR 1205 .RE 1206 1048 1207 bind interfaces only (G) 1049 .RS 3n 1050 This global parameter allows the Samba admin to limit what interfaces on a machine will serve SMB requests. It affects file service 1208 .PP 1209 .RS 4 1210 This global parameter allows the Samba admin to limit what interfaces on a machine will serve SMB requests\. It affects file service 1051 1211 \fBsmbd\fR(8) 1052 1212 and name service 1053 1213 \fBnmbd\fR(8) 1054 in a slightly different ways .1214 in a slightly different ways\. 1055 1215 .sp 1056 1216 For name service it causes 1057 1217 nmbd 1058 1218 to bind to ports 137 and 138 on the interfaces listed in the 1059 interfaces parameter. 1219 \fIinterfaces\fR 1220 parameter\. 1060 1221 nmbd 1061 also binds to the "all addresses" interface (0 .0.0.0) on ports 137 and 138 for the purposes of reading broadcast messages. If this option is not set then1222 also binds to the "all addresses" interface (0\.0\.0\.0) on ports 137 and 138 for the purposes of reading broadcast messages\. If this option is not set then 1062 1223 nmbd 1063 will service name requests on all of these sockets. If 1064 bind interfaces only is set then 1224 will service name requests on all of these sockets\. If 1225 \fIbind interfaces only\fR 1226 is set then 1065 1227 nmbd 1066 will check the source address of any packets coming in on the broadcast sockets and discard any that don't match the broadcast addresses of the interfaces in the 1067 interfaces parameter list. As unicast packets are received on the other sockets it allows 1228 will check the source address of any packets coming in on the broadcast sockets and discard any that don\'t match the broadcast addresses of the interfaces in the 1229 \fIinterfaces\fR 1230 parameter list\. As unicast packets are received on the other sockets it allows 1068 1231 nmbd 1069 1232 to refuse to serve names to machines that send packets that arrive through any interfaces not listed in the 1070 interfaces list. IP Source address spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for 1071 nmbd. 1233 \fIinterfaces\fR 1234 list\. IP Source address spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for 1235 nmbd\. 1072 1236 .sp 1073 1237 For file service it causes 1074 1238 \fBsmbd\fR(8) 1075 1239 to bind only to the interface list given in the 1076 interfaces parameter. This restricts the networks that 1240 \fIinterfaces\fR 1241 parameter\. This restricts the networks that 1077 1242 smbd 1078 will serve to packets coming in those interfaces . Note that you should not use this parameter for machines that are serving PPP or other intermittent or non-broadcast network interfaces as it will not cope with non-permanent interfaces.1243 will serve to packets coming in those interfaces\. Note that you should not use this parameter for machines that are serving PPP or other intermittent or non\-broadcast network interfaces as it will not cope with non\-permanent interfaces\. 1079 1244 .sp 1080 1245 If 1081 bind interfaces only is set then unless the network address 1082 \fB127.0.0.1\fR 1246 \fIbind interfaces only\fR 1247 is set then unless the network address 1248 \fI127\.0\.0\.1\fR 1083 1249 is added to the 1084 interfaces parameter list 1250 \fIinterfaces\fR 1251 parameter list 1085 1252 \fBsmbpasswd\fR(8) 1086 1253 and 1087 1254 \fBswat\fR(8) 1088 may not work as expected due to the reasons covered below .1255 may not work as expected due to the reasons covered below\. 1089 1256 .sp 1090 1257 To change a users SMB password, the 1091 1258 smbpasswd 1092 1259 by default connects to the 1093 \fBlocalhost - 127.0.0.1\fR 1094 address as an SMB client to issue the password change request. If 1095 bind interfaces only is set then unless the network address 1096 \fB127.0.0.1\fR 1260 \fIlocalhost \- 127\.0\.0\.1\fR 1261 address as an SMB client to issue the password change request\. If 1262 \fIbind interfaces only\fR 1263 is set then unless the network address 1264 \fI127\.0\.0\.1\fR 1097 1265 is added to the 1098 interfaces parameter list then 1266 \fIinterfaces\fR 1267 parameter list then 1099 1268 smbpasswd 1100 will fail to connect in it 's default mode.1269 will fail to connect in it\'s default mode\. 1101 1270 smbpasswd 1102 1271 can be forced to use the primary IP interface of the local host by using its 1103 1272 \fBsmbpasswd\fR(8) 1104 \fI -r \fR\fI\fIremote machine\fR\fR1273 \fI\-r \fR\fI\fIremote machine\fR\fR 1105 1274 parameter, with 1106 1275 \fIremote machine\fR 1107 set to the IP name of the primary interface of the local host .1276 set to the IP name of the primary interface of the local host\. 1108 1277 .sp 1109 1278 The … … 1114 1283 nmbd 1115 1284 at the address 1116 \f B127.0.0.1\fR1117 to determine if they are running . Not adding1118 \f B127.0.0.1\fR1285 \fI127\.0\.0\.1\fR 1286 to determine if they are running\. Not adding 1287 \fI127\.0\.0\.1\fR 1119 1288 will cause 1120 1289 smbd 1121 1290 and 1122 1291 nmbd 1123 to always show "not running" even if they really are . This can prevent1292 to always show "not running" even if they really are\. This can prevent 1124 1293 swat 1125 1294 from starting/stopping/restarting 1126 1295 smbd 1127 1296 and 1128 nmbd .1129 .sp 1130 Default: 1131 \f B\fIbind interfaces only\fR = no\fR1132 .RE 1133 .PP 1297 nmbd\. 1298 .sp 1299 Default: 1300 \fI\fIbind interfaces only\fR\fR\fI = \fR\fIno\fR\fI \fR 1301 .RE 1302 1134 1303 blocking locks (S) 1135 .RS 3n 1304 .PP 1305 .RS 4 1136 1306 This parameter controls the behavior of 1137 1307 \fBsmbd\fR(8) 1138 when given a request by a client to obtain a byte range lock on a region of an open file, and the request has a time limit associated with it .1139 .sp 1140 If this parameter is set and the lock range requested cannot be immediately satisfied, samba will internally queue the lock request, and periodically attempt to obtain the lock until the timeout period expires .1308 when given a request by a client to obtain a byte range lock on a region of an open file, and the request has a time limit associated with it\. 1309 .sp 1310 If this parameter is set and the lock range requested cannot be immediately satisfied, samba will internally queue the lock request, and periodically attempt to obtain the lock until the timeout period expires\. 1141 1311 .sp 1142 1312 If this parameter is set to 1143 \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 .1144 .sp 1145 Default: 1146 \f B\fIblocking locks\fR = yes\fR1147 .RE 1148 .PP 1313 \fBno\fR, then samba will behave as previous versions of Samba would and will fail the lock request immediately if the lock range cannot be obtained\. 1314 .sp 1315 Default: 1316 \fI\fIblocking locks\fR\fR\fI = \fR\fIyes\fR\fI \fR 1317 .RE 1318 1149 1319 block size (S) 1150 .RS 3n 1320 .PP 1321 .RS 4 1151 1322 This parameter controls the behavior of 1152 1323 \fBsmbd\fR(8) 1153 when reporting disk free sizes . By default, this reports a disk block size of 1024 bytes.1154 .sp 1155 Changing this parameter may have some effect on the efficiency of client writes, this is not yet confirmed . This parameter was added to allow advanced administrators to change it (usually to a higher value) and test the effect it has on client write performance without re-compiling the code. As this is an experimental option it may be removed in a future release.1156 .sp 1157 Changing this option does not change the disk free reporting size, just the block size unit reported to the client .1158 .sp 1159 Default: 1160 \f B\fIblock size\fR = 1024\fR1161 .sp 1162 Example: 1163 \f B\fIblock size\fR = 4096\fR1164 .RE 1165 .PP1166 browsable 1167 .RS 3n 1168 This parameter is a synonym for browseable.1169 .RE 1170 .PP 1324 when reporting disk free sizes\. By default, this reports a disk block size of 1024 bytes\. 1325 .sp 1326 Changing this parameter may have some effect on the efficiency of client writes, this is not yet confirmed\. This parameter was added to allow advanced administrators to change it (usually to a higher value) and test the effect it has on client write performance without re\-compiling the code\. As this is an experimental option it may be removed in a future release\. 1327 .sp 1328 Changing this option does not change the disk free reporting size, just the block size unit reported to the client\. 1329 .sp 1330 Default: 1331 \fI\fIblock size\fR\fR\fI = \fR\fI1024\fR\fI \fR 1332 .sp 1333 Example: 1334 \fI\fIblock size\fR\fR\fI = \fR\fI4096\fR\fI \fR 1335 .RE 1336 browsable.PP 1337 .RS 4 1338 This parameter is a synonym for 1339 browseable\. 1340 .RE 1341 1171 1342 browseable (S) 1172 .RS 3n 1173 This controls whether this share is seen in the list of available shares in a net view and in the browse list. 1174 .sp 1175 Default: 1176 \fB\fIbrowseable\fR = yes \fR 1177 .RE 1178 .PP 1343 .PP 1344 .RS 4 1345 This controls whether this share is seen in the list of available shares in a net view and in the browse list\. 1346 .sp 1347 Default: 1348 \fI\fIbrowseable\fR\fR\fI = \fR\fIyes\fR\fI \fR 1349 .RE 1350 1179 1351 browse list (G) 1180 .RS 3n 1352 .PP 1353 .RS 4 1181 1354 This controls whether 1182 1355 \fBsmbd\fR(8) 1183 1356 will serve a browse list to a client doing a 1184 1357 NetServerEnum 1185 call . Normally set to1186 \fByes\fR . You should never need to change this.1187 .sp 1188 Default: 1189 \f B\fIbrowse list\fR = yes\fR1190 .RE 1191 .PP1192 casesignames 1193 .RS 3n 1194 This parameter is a synonym for case sensitive.1195 .RE 1196 .PP 1358 call\. Normally set to 1359 \fByes\fR\. You should never need to change this\. 1360 .sp 1361 Default: 1362 \fI\fIbrowse list\fR\fR\fI = \fR\fIyes\fR\fI \fR 1363 .RE 1364 casesignames.PP 1365 .RS 4 1366 This parameter is a synonym for 1367 case sensitive\. 1368 .RE 1369 1197 1370 case sensitive (S) 1198 .RS 3n 1371 .PP 1372 .RS 4 1199 1373 See the discussion in the section 1200 name mangling.1201 .sp 1202 Default: 1203 \f B\fIcase sensitive\fR = no\fR1204 .RE 1205 .PP 1374 \fIname mangling\fR\. 1375 .sp 1376 Default: 1377 \fI\fIcase sensitive\fR\fR\fI = \fR\fIno\fR\fI \fR 1378 .RE 1379 1206 1380 change notify (S) 1207 .RS 3n 1208 This parameter specifies whether Samba should reply to a client's file change notify requests. 1381 .PP 1382 .RS 4 1383 This parameter specifies whether Samba should reply to a client\'s file change notify requests\. 1209 1384 .sp 1210 1385 You should never need to change this parameter 1211 1386 .sp 1212 1387 Default: 1213 \f B\fIchange notify\fR = no\fR1214 .RE 1215 .PP 1388 \fI\fIchange notify\fR\fR\fI = \fR\fIyes\fR\fI \fR 1389 .RE 1390 1216 1391 change share command (G) 1217 .RS 3n 1218 Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server Manager. The 1392 .PP 1393 .RS 4 1394 Samba 2\.2\.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\.0 Server Manager\. The 1219 1395 \fIchange share command\fR 1220 1396 is used to define an external program or script which will modify an existing service definition in 1221 \fIsmb .conf\fR. In order to successfully execute the1397 \fIsmb\.conf\fR\. In order to successfully execute the 1222 1398 \fIchange share command\fR, 1223 1399 smbd 1224 requires that the administrator be connected using a root account (i.e. uid == 0). 1400 requires that the administrator be connected using a root account (i\.e\. uid == 0)\. 1401 .sp 1402 If the connected account has 1403 SeDiskOperatorPrivilege, scripts defined in 1404 \fIchange share\fR 1405 parameter are executed as root\. 1225 1406 .sp 1226 1407 When executed, … … 1228 1409 will automatically invoke the 1229 1410 \fIchange share command\fR 1230 with five parameters. 1231 .RS 3n 1232 .TP 3n 1233 \(bu 1411 with five parameters\. 1412 .sp 1413 .RS 4 1414 .ie n \{\ 1415 \h'-04'\(bu\h'+03'\c 1416 .\} 1417 .el \{\ 1418 .sp -1 1419 .IP \(bu 2.3 1420 .\} 1234 1421 \fIconfigFile\fR 1235 - the location of the global 1236 \fIsmb.conf\fR 1237 file. 1238 .TP 3n 1239 \(bu 1422 \- the location of the global 1423 \fIsmb\.conf\fR 1424 file\. 1425 .RE 1426 .sp 1427 .RS 4 1428 .ie n \{\ 1429 \h'-04'\(bu\h'+03'\c 1430 .\} 1431 .el \{\ 1432 .sp -1 1433 .IP \(bu 2.3 1434 .\} 1240 1435 \fIshareName\fR 1241 - the name of the new share. 1242 .TP 3n 1243 \(bu 1436 \- the name of the new share\. 1437 .RE 1438 .sp 1439 .RS 4 1440 .ie n \{\ 1441 \h'-04'\(bu\h'+03'\c 1442 .\} 1443 .el \{\ 1444 .sp -1 1445 .IP \(bu 2.3 1446 .\} 1244 1447 \fIpathName\fR 1245 - path to an **existing** directory on disk. 1246 .TP 3n 1247 \(bu 1448 \- path to an **existing** directory on disk\. 1449 .RE 1450 .sp 1451 .RS 4 1452 .ie n \{\ 1453 \h'-04'\(bu\h'+03'\c 1454 .\} 1455 .el \{\ 1456 .sp -1 1457 .IP \(bu 2.3 1458 .\} 1248 1459 \fIcomment\fR 1249 - comment string to associate with the new share. 1250 .TP 3n 1251 \(bu 1460 \- comment string to associate with the new share\. 1461 .RE 1462 .sp 1463 .RS 4 1464 .ie n \{\ 1465 \h'-04'\(bu\h'+03'\c 1466 .\} 1467 .el \{\ 1468 .sp -1 1469 .IP \(bu 2.3 1470 .\} 1252 1471 \fImax connections\fR 1253 Number of maximum simultaneous connections to this share .1254 . RE1255 . IP "" 3n1256 This parameter is only used modify existing file shares definitions . To modify printer shares, use the "Printers..." folder as seen when browsing the Samba host.1257 .sp 1258 Default: 1259 \f B\fIchange share command\fR =\fR1260 .sp 1261 Example: 1262 \f B\fIchange share command\fR = /usr/local/bin/addshare\fR1263 .RE 1264 .PP 1472 Number of maximum simultaneous connections to this share\. 1473 .sp 1474 .RE 1475 This parameter is only used modify existing file shares definitions\. To modify printer shares, use the "Printers\.\.\." folder as seen when browsing the Samba host\. 1476 .sp 1477 Default: 1478 \fI\fIchange share command\fR\fR\fI = \fR\fI\fR\fI \fR 1479 .sp 1480 Example: 1481 \fI\fIchange share command\fR\fR\fI = \fR\fI/usr/local/bin/addshare\fR\fI \fR 1482 .RE 1483 1265 1484 check password script (G) 1266 .RS 3n 1267 The name of a program that can be used to check password complexity. The password is sent to the program's standrad input. 1268 .sp 1269 The program must return 0 on good password any other value otherwise. In case the password is considered weak (the program do not return 0) the user will be notified and the password change will fail. 1270 .sp 1271 Note: In the example directory there is a sample program called crackcheck that uses cracklib to checkpassword quality 1272 .sp 1273 . 1274 1275 1276 Default: 1277 \fB\fIcheck password script\fR = Disabled \fR 1278 .sp 1279 Example: 1280 \fB\fIcheck password script\fR = check password script = /usr/local/sbin/crackcheck \fR 1281 .RE 1282 .PP 1485 .PP 1486 .RS 4 1487 The name of a program that can be used to check password complexity\. The password is sent to the program\'s standrad input\. 1488 .sp 1489 The program must return 0 on good password any other value otherwise\. In case the password is considered weak (the program do not return 0) the user will be notified and the password change will fail\. 1490 .sp 1491 Note: In the example directory there is a sample program called crackcheck that uses cracklib to checkpassword quality\. 1492 .sp 1493 Default: 1494 \fI\fIcheck password script\fR\fR\fI = \fR\fIDisabled\fR\fI \fR 1495 .sp 1496 Example: 1497 \fI\fIcheck password script\fR\fR\fI = \fR\fIcheck password script = /usr/local/sbin/crackcheck\fR\fI \fR 1498 .RE 1499 1283 1500 client lanman auth (G) 1284 .RS 3n 1501 .PP 1502 .RS 4 1285 1503 This parameter determines whether or not 1286 1504 \fBsmbclient\fR(8) 1287 and other samba client tools will attempt to authenticate itself to servers using the weaker LANMAN password hash . If disabled, only server which support NT password hashes (e.g. Windows NT/2000, Samba, etc... but not Windows 95/98) will be able to be connected from the Samba client.1288 .sp 1289 The LANMAN encrypted response is easily broken, due to it 's case-insensitive nature, and the choice of algorithm. Clients without Windows 95/98 servers are advised to disable this option.1505 and other samba client tools will attempt to authenticate itself to servers using the weaker LANMAN password hash\. If disabled, only server which support NT password hashes (e\.g\. Windows NT/2000, Samba, etc\.\.\. but not Windows 95/98) will be able to be connected from the Samba client\. 1506 .sp 1507 The LANMAN encrypted response is easily broken, due to it\'s case\-insensitive nature, and the choice of algorithm\. Clients without Windows 95/98 servers are advised to disable this option\. 1290 1508 .sp 1291 1509 Disabling this option will also disable the … … 1295 1513 Likewise, if the 1296 1514 client ntlmv2 auth 1297 parameter is enabled, then only NTLMv2 logins will be attempted .1298 .sp 1299 Default: 1300 \f B\fIclient lanman auth\fR = yes\fR1301 .RE 1302 .PP 1515 parameter is enabled, then only NTLMv2 logins will be attempted\. 1516 .sp 1517 Default: 1518 \fI\fIclient lanman auth\fR\fR\fI = \fR\fIyes\fR\fI \fR 1519 .RE 1520 1303 1521 client ntlmv2 auth (G) 1304 .RS 3n 1522 .PP 1523 .RS 4 1305 1524 This parameter determines whether or not 1306 1525 \fBsmbclient\fR(8) 1307 will attempt to authenticate itself to servers using the NTLMv2 encrypted password response .1308 .sp 1309 If enabled, only an NTLMv2 and LMv2 response (both much more secure than earlier versions) will be sent . Many servers (including NT4 < SP4, Win9x and Samba 2.2) are not compatible with NTLMv2.1526 will attempt to authenticate itself to servers using the NTLMv2 encrypted password response\. 1527 .sp 1528 If enabled, only an NTLMv2 and LMv2 response (both much more secure than earlier versions) will be sent\. Many servers (including NT4 < SP4, Win9x and Samba 2\.2) are not compatible with NTLMv2\. 1310 1529 .sp 1311 1530 Similarly, if enabled, NTLMv1, … … 1313 1532 and 1314 1533 client plaintext auth 1315 authentication will be disabled . This also disables share-level authentication.1534 authentication will be disabled\. This also disables share\-level authentication\. 1316 1535 .sp 1317 1536 If disabled, an NTLM response (and possibly a LANMAN response) will be sent by the client, depending on the value of 1318 client lanman auth .1319 .sp 1320 Note that some sites (particularly those following 'best practice' security polices) only allow NTLMv2 responses, and not the weaker LM or NTLM.1321 .sp 1322 Default: 1323 \f B\fIclient ntlmv2 auth\fR = no\fR1324 .RE 1325 .PP 1537 client lanman auth\. 1538 .sp 1539 Note that some sites (particularly those following \'best practice\' security polices) only allow NTLMv2 responses, and not the weaker LM or NTLM\. 1540 .sp 1541 Default: 1542 \fI\fIclient ntlmv2 auth\fR\fR\fI = \fR\fIno\fR\fI \fR 1543 .RE 1544 1326 1545 client plaintext auth (G) 1327 .RS 3n 1328 Specifies whether a client should send a plaintext password if the server does not support encrypted passwords. 1329 .sp 1330 Default: 1331 \fB\fIclient plaintext auth\fR = yes \fR 1332 .RE 1333 .PP 1546 .PP 1547 .RS 4 1548 Specifies whether a client should send a plaintext password if the server does not support encrypted passwords\. 1549 .sp 1550 Default: 1551 \fI\fIclient plaintext auth\fR\fR\fI = \fR\fIyes\fR\fI \fR 1552 .RE 1553 1334 1554 client schannel (G) 1335 .RS 3n 1336 This controls whether the client offers or even demands the use of the netlogon schannel. 1337 client schannel = no does not offer the schannel, 1338 client schannel = auto offers the schannel but does not enforce it, and 1339 client schannel = yes denies access if the server is not able to speak netlogon schannel. 1340 .sp 1341 Default: 1342 \fB\fIclient schannel\fR = auto \fR 1343 .sp 1344 Example: 1345 \fB\fIclient schannel\fR = yes \fR 1346 .RE 1347 .PP 1555 .PP 1556 .RS 4 1557 This controls whether the client offers or even demands the use of the netlogon schannel\. 1558 \fIclient schannel = no\fR 1559 does not offer the schannel, 1560 \fIclient schannel = auto\fR 1561 offers the schannel but does not enforce it, and 1562 \fIclient schannel = yes\fR 1563 denies access if the server is not able to speak netlogon schannel\. 1564 .sp 1565 Default: 1566 \fI\fIclient schannel\fR\fR\fI = \fR\fIauto\fR\fI \fR 1567 .sp 1568 Example: 1569 \fI\fIclient schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR 1570 .RE 1571 1348 1572 client signing (G) 1349 .RS 3n 1350 This controls whether the client offers or requires the server it talks to to use SMB signing. Possible values are 1351 \fBauto\fR, 1352 \fBmandatory\fR 1573 .PP 1574 .RS 4 1575 This controls whether the client offers or requires the server it talks to to use SMB signing\. Possible values are 1576 \fIauto\fR, 1577 \fImandatory\fR 1353 1578 and 1354 \f Bdisabled\fR.1355 .sp 1356 When set to auto, SMB signing is offered, but not enforced . When set to mandatory, SMB signing is required and if set to disabled, SMB signing is not offered either.1357 .sp 1358 Default: 1359 \f B\fIclient signing\fR = auto\fR1360 .RE 1361 .PP 1579 \fIdisabled\fR\. 1580 .sp 1581 When set to auto, SMB signing is offered, but not enforced\. When set to mandatory, SMB signing is required and if set to disabled, SMB signing is not offered either\. 1582 .sp 1583 Default: 1584 \fI\fIclient signing\fR\fR\fI = \fR\fIauto\fR\fI \fR 1585 .RE 1586 1362 1587 client use spnego (G) 1363 .RS 3n 1364 This variable controls whether Samba clients will try to use Simple and Protected NEGOciation (as specified by rfc2478) with supporting servers (including WindowsXP, Windows2000 and Samba 3.0) to agree upon an authentication mechanism. This enables Kerberos authentication in particular. 1365 .sp 1366 Default: 1367 \fB\fIclient use spnego\fR = yes \fR 1368 .RE 1369 .PP 1588 .PP 1589 .RS 4 1590 This variable controls whether Samba clients will try to use Simple and Protected NEGOciation (as specified by rfc2478) with supporting servers (including WindowsXP, Windows2000 and Samba 3\.0) to agree upon an authentication mechanism\. This enables Kerberos authentication in particular\. 1591 .sp 1592 Default: 1593 \fI\fIclient use spnego\fR\fR\fI = \fR\fIyes\fR\fI \fR 1594 .RE 1595 1370 1596 comment (S) 1371 .RS 3n 1597 .PP 1598 .RS 4 1372 1599 This is a text field that is seen next to a share when a client does a queries the server, either via the network neighborhood or via 1373 1600 net view 1374 to list what shares are available .1601 to list what shares are available\. 1375 1602 .sp 1376 1603 If you want to set the string that is displayed next to the machine name then see the 1377 server string parameter. 1378 .sp 1379 Default: 1380 \fB\fIcomment\fR = # No comment \fR 1381 .sp 1382 Example: 1383 \fB\fIcomment\fR = Fred's Files \fR 1384 .RE 1385 .PP 1604 \fIserver string\fR 1605 parameter\. 1606 .sp 1607 Default: 1608 \fI\fIcomment\fR\fR\fI = \fR\fI # No comment\fR\fI \fR 1609 .sp 1610 Example: 1611 \fI\fIcomment\fR\fR\fI = \fR\fIFred\'s Files\fR\fI \fR 1612 .RE 1613 1386 1614 config file (G) 1387 .RS 3n 1615 .PP 1616 .RS 4 1388 1617 This allows you to override the config file to use, instead of the default (usually 1389 \fIsmb .conf\fR). There is a chicken and egg problem here as this option is set in the config file!1390 .sp 1391 For this reason, if the name of the config file has changed when the parameters are loaded then it will reload them from the new config file .1392 .sp 1393 This option takes the usual substitutions, which can be very useful .1394 .sp 1395 If the config file doesn 't exist then it won't be loaded (allowing you to special case the config files of just a few clients).1396 .sp 1397 \f BNo default\fR1398 .sp 1399 Example: 1400 \f B\fIconfig file\fR = /usr/local/samba/lib/smb.conf.%m\fR1401 .RE 1402 .PP 1618 \fIsmb\.conf\fR)\. There is a chicken and egg problem here as this option is set in the config file! 1619 .sp 1620 For this reason, if the name of the config file has changed when the parameters are loaded then it will reload them from the new config file\. 1621 .sp 1622 This option takes the usual substitutions, which can be very useful\. 1623 .sp 1624 If the config file doesn\'t exist then it won\'t be loaded (allowing you to special case the config files of just a few clients)\. 1625 .sp 1626 \fINo default\fR 1627 .sp 1628 Example: 1629 \fI\fIconfig file\fR\fR\fI = \fR\fI/usr/local/samba/lib/smb\.conf\.%m\fR\fI \fR 1630 .RE 1631 1403 1632 copy (S) 1404 .RS 3n 1405 This parameter allows you to "clone" service entries. The specified service is simply duplicated under the current service's name. Any parameters specified in the current section will override those in the section being copied. 1406 .sp 1407 This feature lets you set up a 'template' service and create similar services easily. Note that the service being copied must occur earlier in the configuration file than the service doing the copying. 1408 .sp 1409 Default: 1410 \fB\fIcopy\fR = \fR 1411 .sp 1412 Example: 1413 \fB\fIcopy\fR = otherservice \fR 1414 .RE 1415 .PP 1416 create mode 1417 .RS 3n 1418 This parameter is a synonym for create mask. 1419 .RE 1420 .PP 1633 .PP 1634 .RS 4 1635 This parameter allows you to "clone" service entries\. The specified service is simply duplicated under the current service\'s name\. Any parameters specified in the current section will override those in the section being copied\. 1636 .sp 1637 This feature lets you set up a \'template\' service and create similar services easily\. Note that the service being copied must occur earlier in the configuration file than the service doing the copying\. 1638 .sp 1639 Default: 1640 \fI\fIcopy\fR\fR\fI = \fR\fI\fR\fI \fR 1641 .sp 1642 Example: 1643 \fI\fIcopy\fR\fR\fI = \fR\fIotherservice\fR\fI \fR 1644 .RE 1645 create mode.PP 1646 .RS 4 1647 This parameter is a synonym for 1648 create mask\. 1649 .RE 1650 1421 1651 create mask (S) 1422 .RS 3n 1423 When a file is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit-wise 'AND'ed with this parameter. This parameter may be thought of as a bit-wise MASK for the UNIX modes of a file. Any bit 1424 \fBnot\fR 1425 set here will be removed from the modes set on a file when it is created. 1652 .PP 1653 .RS 4 1654 When a file is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit\-wise \'AND\'ed with this parameter\. This parameter may be thought of as a bit\-wise MASK for the UNIX modes of a file\. Any bit 1655 \fInot\fR 1656 set here will be removed from the modes set on a file when it is created\. 1426 1657 .sp 1427 1658 The default value of this parameter removes the … … 1429 1660 and 1430 1661 other 1431 write and execute bits from the UNIX modes. 1432 .sp 1433 Following this Samba will bit-wise 'OR' the UNIX mode created from this parameter with the value of the 1434 force create mode parameter which is set to 000 by default. 1435 .sp 1436 This parameter does not affect directory masks. See the parameter 1437 directory mask for details. 1438 .sp 1439 Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors. If the administrator wishes to enforce a mask on access control lists also, they need to set the 1440 security mask. 1441 .sp 1442 Default: 1443 \fB\fIcreate mask\fR = 0744 \fR 1444 .sp 1445 Example: 1446 \fB\fIcreate mask\fR = 0775 \fR 1447 .RE 1448 .PP 1662 write and execute bits from the UNIX modes\. 1663 .sp 1664 Following this Samba will bit\-wise \'OR\' the UNIX mode created from this parameter with the value of the 1665 \fIforce create mode\fR 1666 parameter which is set to 000 by default\. 1667 .sp 1668 This parameter does not affect directory masks\. See the parameter 1669 \fIdirectory mask\fR 1670 for details\. 1671 .sp 1672 Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors\. If the administrator wishes to enforce a mask on access control lists also, they need to set the 1673 \fIsecurity mask\fR\. 1674 .sp 1675 Default: 1676 \fI\fIcreate mask\fR\fR\fI = \fR\fI0744\fR\fI \fR 1677 .sp 1678 Example: 1679 \fI\fIcreate mask\fR\fR\fI = \fR\fI0775\fR\fI \fR 1680 .RE 1681 1449 1682 csc policy (S) 1450 .RS 3n 1683 .PP 1684 .RS 4 1451 1685 This stands for 1452 \f Bclient-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.1453 .sp 1454 These values correspond to those used on Windows servers .1686 \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\. 1687 .sp 1688 These values correspond to those used on Windows servers\. 1455 1689 .sp 1456 1690 For example, shares containing roaming profiles can have offline caching disabled using 1457 csc policy = disable.1458 .sp 1459 Default: 1460 \f B\fIcsc policy\fR = manual\fR1461 .sp 1462 Example: 1463 \f B\fIcsc policy\fR = programs\fR1464 .RE 1465 .PP 1691 \fIcsc policy = disable\fR\. 1692 .sp 1693 Default: 1694 \fI\fIcsc policy\fR\fR\fI = \fR\fImanual\fR\fI \fR 1695 .sp 1696 Example: 1697 \fI\fIcsc policy\fR\fR\fI = \fR\fIprograms\fR\fI \fR 1698 .RE 1699 1466 1700 cups options (S) 1467 .RS 3n 1701 .PP 1702 .RS 4 1468 1703 This parameter is only applicable if 1469 printing is set to 1470 \fBcups\fR. Its value is a free form string of options passed directly to the cups library. 1471 .sp 1472 You can pass any generic print option known to CUPS (as listed in the CUPS "Software Users' Manual"). You can also pass any printer specific option (as listed in "lpoptions -d printername -l") valid for the target queue. 1704 \fIprinting\fR 1705 is set to 1706 \fBcups\fR\. Its value is a free form string of options passed directly to the cups library\. 1707 .sp 1708 You can pass any generic print option known to CUPS (as listed in the CUPS "Software Users\' Manual")\. You can also pass any printer specific option (as listed in "lpoptions \-d printername \-l") valid for the target queue\. Multiple parameters should be space\-delimited name/value pairs according to the PAPI text option ABNF specification\. Collection values ("name={a=\.\.\. b=\.\.\. c=\.\.\.}") are stored with the curley brackets intact\. 1473 1709 .sp 1474 1710 You should set this parameter to … … 1476 1712 if your CUPS server 1477 1713 \fIerror_log\fR 1478 file contains messages such as "Unsupported format 'application/octet-stream'" when printing from a Windows client through Samba. It is no longer necessary to enable system wide raw printing in1479 \fI/etc/cups/mime .{convs,types}\fR.1480 .sp 1481 Default: 1482 \f B\fIcups options\fR = ""\fR1483 .sp 1484 Example: 1485 \f B\fIcups options\fR = "raw,media=a4,job-sheets=secret,secret"\fR1486 .RE 1487 .PP 1714 file contains messages such as "Unsupported format \'application/octet\-stream\'" when printing from a Windows client through Samba\. It is no longer necessary to enable system wide raw printing in 1715 \fI/etc/cups/mime\.{convs,types}\fR\. 1716 .sp 1717 Default: 1718 \fI\fIcups options\fR\fR\fI = \fR\fI""\fR\fI \fR 1719 .sp 1720 Example: 1721 \fI\fIcups options\fR\fR\fI = \fR\fI"raw media=a4"\fR\fI \fR 1722 .RE 1723 1488 1724 cups server (G) 1489 .RS 3n 1725 .PP 1726 .RS 4 1490 1727 This parameter is only applicable if 1491 printing is set to 1492 \fBcups\fR. 1728 \fIprinting\fR 1729 is set to 1730 \fBcups\fR\. 1493 1731 .sp 1494 1732 If set, this option overrides the ServerName option in the CUPS 1495 \fIclient .conf\fR. This is necessary if you have virtual samba servers that connect to different CUPS daemons.1496 .sp 1497 Optionally, a port can be specified by separating the server name and port number with a colon . If no port was specified, the default port for IPP (631) will be used.1498 .sp 1499 Default: 1500 \f B\fIcups server\fR = ""\fR1501 .sp 1502 Example: 1503 \f B\fIcups server\fR = mycupsserver\fR1504 .sp 1505 Example: 1506 \f B\fIcups server\fR = mycupsserver:1631\fR1507 .RE 1508 .PP 1733 \fIclient\.conf\fR\. This is necessary if you have virtual samba servers that connect to different CUPS daemons\. 1734 .sp 1735 Optionally, a port can be specified by separating the server name and port number with a colon\. If no port was specified, the default port for IPP (631) will be used\. 1736 .sp 1737 Default: 1738 \fI\fIcups server\fR\fR\fI = \fR\fI""\fR\fI \fR 1739 .sp 1740 Example: 1741 \fI\fIcups server\fR\fR\fI = \fR\fImycupsserver\fR\fI \fR 1742 .sp 1743 Example: 1744 \fI\fIcups server\fR\fR\fI = \fR\fImycupsserver:1631\fR\fI \fR 1745 .RE 1746 1509 1747 deadtime (G) 1510 .RS 3n 1511 The value of the parameter (a decimal integer) represents the number of minutes of inactivity before a connection is considered dead, and it is disconnected. The deadtime only takes effect if the number of open files is zero. 1512 .sp 1513 This is useful to stop a server's resources being exhausted by a large number of inactive connections. 1514 .sp 1515 Most clients have an auto-reconnect feature when a connection is broken so in most cases this parameter should be transparent to users. 1516 .sp 1517 Using this parameter with a timeout of a few minutes is recommended for most systems. 1518 .sp 1519 A deadtime of zero indicates that no auto-disconnection should be performed. 1520 .sp 1521 Default: 1522 \fB\fIdeadtime\fR = 0 \fR 1523 .sp 1524 Example: 1525 \fB\fIdeadtime\fR = 15 \fR 1526 .RE 1527 .PP 1748 .PP 1749 .RS 4 1750 The value of the parameter (a decimal integer) represents the number of minutes of inactivity before a connection is considered dead, and it is disconnected\. The deadtime only takes effect if the number of open files is zero\. 1751 .sp 1752 This is useful to stop a server\'s resources being exhausted by a large number of inactive connections\. 1753 .sp 1754 Most clients have an auto\-reconnect feature when a connection is broken so in most cases this parameter should be transparent to users\. 1755 .sp 1756 Using this parameter with a timeout of a few minutes is recommended for most systems\. 1757 .sp 1758 A deadtime of zero indicates that no auto\-disconnection should be performed\. 1759 .sp 1760 Default: 1761 \fI\fIdeadtime\fR\fR\fI = \fR\fI0\fR\fI \fR 1762 .sp 1763 Example: 1764 \fI\fIdeadtime\fR\fR\fI = \fR\fI15\fR\fI \fR 1765 .RE 1766 1528 1767 debug hires timestamp (G) 1529 .RS 3n 1530 Sometimes the timestamps in the log messages are needed with a resolution of higher that seconds, this boolean parameter adds microsecond resolution to the timestamp message header when turned on. 1768 .PP 1769 .RS 4 1770 Sometimes the timestamps in the log messages are needed with a resolution of higher that seconds, this boolean parameter adds microsecond resolution to the timestamp message header when turned on\. 1531 1771 .sp 1532 1772 Note that the parameter 1533 debug timestamp must be on for this to have an effect. 1534 .sp 1535 Default: 1536 \fB\fIdebug hires timestamp\fR = no \fR 1537 .RE 1538 .PP 1773 \fIdebug timestamp\fR 1774 must be on for this to have an effect\. 1775 .sp 1776 Default: 1777 \fI\fIdebug hires timestamp\fR\fR\fI = \fR\fIno\fR\fI \fR 1778 .RE 1779 1539 1780 debug pid (G) 1540 .RS 3n 1781 .PP 1782 .RS 4 1541 1783 When using only one log file for more then one forked 1542 \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.1784 \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\. 1543 1785 .sp 1544 1786 Note that the parameter 1545 debug timestamp must be on for this to have an effect. 1546 .sp 1547 Default: 1548 \fB\fIdebug pid\fR = no \fR 1549 .RE 1550 .PP 1787 \fIdebug timestamp\fR 1788 must be on for this to have an effect\. 1789 .sp 1790 Default: 1791 \fI\fIdebug pid\fR\fR\fI = \fR\fIno\fR\fI \fR 1792 .RE 1793 1551 1794 debug prefix timestamp (G) 1552 .RS 3n 1795 .PP 1796 .RS 4 1553 1797 With this option enabled, the timestamp message header is prefixed to the debug message without the filename and function information that is included with the 1554 debug timestamp parameter. This gives timestamps to the messages without adding an additional line. 1798 \fIdebug timestamp\fR 1799 parameter\. This gives timestamps to the messages without adding an additional line\. 1555 1800 .sp 1556 1801 Note that this parameter overrides the 1557 debug timestamp parameter. 1558 .sp 1559 Default: 1560 \fB\fIdebug prefix timestamp\fR = no \fR 1561 .RE 1562 .PP 1563 timestamp logs 1564 .RS 3n 1565 This parameter is a synonym for debug timestamp. 1566 .RE 1567 .PP 1802 \fIdebug timestamp\fR 1803 parameter\. 1804 .sp 1805 Default: 1806 \fI\fIdebug prefix timestamp\fR\fR\fI = \fR\fIno\fR\fI \fR 1807 .RE 1808 timestamp logs.PP 1809 .RS 4 1810 This parameter is a synonym for 1811 debug timestamp\. 1812 .RE 1813 1568 1814 debug timestamp (G) 1569 .RS 3n 1570 Samba debug log messages are timestamped by default. If you are running at a high 1571 debug level these timestamps can be distracting. This boolean parameter allows timestamping to be turned off. 1572 .sp 1573 Default: 1574 \fB\fIdebug timestamp\fR = yes \fR 1575 .RE 1576 .PP 1815 .PP 1816 .RS 4 1817 Samba debug log messages are timestamped by default\. If you are running at a high 1818 \fIdebug level\fR 1819 these timestamps can be distracting\. This boolean parameter allows timestamping to be turned off\. 1820 .sp 1821 Default: 1822 \fI\fIdebug timestamp\fR\fR\fI = \fR\fIyes\fR\fI \fR 1823 .RE 1824 1577 1825 debug uid (G) 1578 .RS 3n 1579 Samba is sometimes run as root and sometime run as the connected user, this boolean parameter inserts the current euid, egid, uid and gid to the timestamp message headers in the log file if turned on. 1826 .PP 1827 .RS 4 1828 Samba is sometimes run as root and sometime run as the connected user, this boolean parameter inserts the current euid, egid, uid and gid to the timestamp message headers in the log file if turned on\. 1580 1829 .sp 1581 1830 Note that the parameter 1582 debug timestamp must be on for this to have an effect. 1583 .sp 1584 Default: 1585 \fB\fIdebug uid\fR = no \fR 1586 .RE 1587 .PP 1831 \fIdebug timestamp\fR 1832 must be on for this to have an effect\. 1833 .sp 1834 Default: 1835 \fI\fIdebug uid\fR\fR\fI = \fR\fIno\fR\fI \fR 1836 .RE 1837 1588 1838 default case (S) 1589 .RS 3n 1839 .PP 1840 .RS 4 1590 1841 See the section on 1591 name mangling. Also note the 1592 short preserve case parameter. 1593 .sp 1594 Default: 1595 \fB\fIdefault case\fR = lower \fR 1596 .RE 1597 .PP 1842 \fIname mangling\fR\. Also note the 1843 \fIshort preserve case\fR 1844 parameter\. 1845 .sp 1846 Default: 1847 \fI\fIdefault case\fR\fR\fI = \fR\fIlower\fR\fI \fR 1848 .RE 1849 1598 1850 default devmode (S) 1599 .RS 3n 1851 .PP 1852 .RS 4 1600 1853 This parameter is only applicable to 1601 printable services. When smbd is serving Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba server has a Device Mode which defines things such as paper size and orientation and duplex settings. The device mode can only correctly be generated by the printer driver itself (which can only be executed on a Win32 platform). Because smbd is unable to execute the driver code to generate the device mode, the default behavior is to set this field to NULL. 1602 .sp 1603 Most problems with serving printer drivers to Windows NT/2k/XP clients can be traced to a problem with the generated device mode. Certain drivers will do things such as crashing the client's Explorer.exe with a NULL devmode. However, other printer drivers can cause the client's spooler service (spoolsv.exe) to die if the devmode was not created by the driver itself (i.e. smbd generates a default devmode). 1604 .sp 1605 This parameter should be used with care and tested with the printer driver in question. It is better to leave the device mode to NULL and let the Windows client set the correct values. Because drivers do not do this all the time, setting 1854 \fIprintable\fR 1855 services\. When smbd is serving Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba server has a Device Mode which defines things such as paper size and orientation and duplex settings\. The device mode can only correctly be generated by the printer driver itself (which can only be executed on a Win32 platform)\. Because smbd is unable to execute the driver code to generate the device mode, the default behavior is to set this field to NULL\. 1856 .sp 1857 Most problems with serving printer drivers to Windows NT/2k/XP clients can be traced to a problem with the generated device mode\. Certain drivers will do things such as crashing the client\'s Explorer\.exe with a NULL devmode\. However, other printer drivers can cause the client\'s spooler service (spoolsv\.exe) to die if the devmode was not created by the driver itself (i\.e\. smbd generates a default devmode)\. 1858 .sp 1859 This parameter should be used with care and tested with the printer driver in question\. It is better to leave the device mode to NULL and let the Windows client set the correct values\. Because drivers do not do this all the time, setting 1606 1860 default devmode = yes 1607 will instruct smbd to generate a default one .1861 will instruct smbd to generate a default one\. 1608 1862 .sp 1609 1863 For more information on Windows NT/2k printing and Device Modes, see the 1610 MSDN documentation .1611 .sp 1612 Default: 1613 \f B\fIdefault devmode\fR = yes\fR1614 .RE 1615 .PP1616 default 1617 .RS 3n 1618 This parameter is a synonym for default service.1619 .RE 1620 .PP 1864 MSDN documentation\. 1865 .sp 1866 Default: 1867 \fI\fIdefault devmode\fR\fR\fI = \fR\fIyes\fR\fI \fR 1868 .RE 1869 default.PP 1870 .RS 4 1871 This parameter is a synonym for 1872 default service\. 1873 .RE 1874 1621 1875 default service (G) 1622 .RS 3n 1623 This parameter specifies the name of a service which will be connected to if the service actually requested cannot be found. Note that the square brackets are 1624 \fBNOT\fR 1625 given in the parameter value (see example below). 1626 .sp 1627 There is no default value for this parameter. If this parameter is not given, attempting to connect to a nonexistent service results in an error. 1876 .PP 1877 .RS 4 1878 This parameter specifies the name of a service which will be connected to if the service actually requested cannot be found\. Note that the square brackets are 1879 \fINOT\fR 1880 given in the parameter value (see example below)\. 1881 .sp 1882 There is no default value for this parameter\. If this parameter is not given, attempting to connect to a nonexistent service results in an error\. 1628 1883 .sp 1629 1884 Typically the default service would be a 1630 guest ok, 1631 read-only service. 1885 \fIguest ok\fR, 1886 \fIread\-only\fR 1887 service\. 1632 1888 .sp 1633 1889 Also note that the apparent service name will be changed to equal that of the requested service, this is very useful as it allows you to use macros like 1634 1890 \fI%S\fR 1635 to make a wildcard service .1636 .sp 1637 Note also that any "_" characters in the name of the service used in the default service will get mapped to a "/" . This allows for interesting things.1638 .sp 1639 Default: 1640 \f B\fIdefault service\fR =\fR1641 .sp 1642 Example: 1643 \f B\fIdefault service\fR = pub\fR1644 .RE 1645 .PP 1891 to make a wildcard service\. 1892 .sp 1893 Note also that any "_" characters in the name of the service used in the default service will get mapped to a "/"\. This allows for interesting things\. 1894 .sp 1895 Default: 1896 \fI\fIdefault service\fR\fR\fI = \fR\fI\fR\fI \fR 1897 .sp 1898 Example: 1899 \fI\fIdefault service\fR\fR\fI = \fR\fIpub\fR\fI \fR 1900 .RE 1901 1646 1902 defer sharing violations (G) 1647 .RS 3n 1648 Windows allows specifying how a file will be shared with other processes when it is opened. Sharing violations occur when a file is opened by a different process using options that violate the share settings specified by other processes. This parameter causes smbd to act as a Windows server does, and defer returning a "sharing violation" error message for up to one second, allowing the client to close the file causing the violation in the meantime. 1649 .sp 1650 UNIX by default does not have this behaviour. 1651 .sp 1652 There should be no reason to turn off this parameter, as it is designed to enable Samba to more correctly emulate Windows. 1653 .sp 1654 Default: 1655 \fB\fIdefer sharing violations\fR = True \fR 1656 .RE 1657 .PP 1903 .PP 1904 .RS 4 1905 Windows allows specifying how a file will be shared with other processes when it is opened\. Sharing violations occur when a file is opened by a different process using options that violate the share settings specified by other processes\. This parameter causes smbd to act as a Windows server does, and defer returning a "sharing violation" error message for up to one second, allowing the client to close the file causing the violation in the meantime\. 1906 .sp 1907 UNIX by default does not have this behaviour\. 1908 .sp 1909 There should be no reason to turn off this parameter, as it is designed to enable Samba to more correctly emulate Windows\. 1910 .sp 1911 Default: 1912 \fI\fIdefer sharing violations\fR\fR\fI = \fR\fITrue\fR\fI \fR 1913 .RE 1914 1658 1915 delete group script (G) 1659 .RS 3n 1916 .PP 1917 .RS 4 1660 1918 This is the full pathname to a script that will be run 1661 \f BAS ROOT\fR1919 \fIAS ROOT\fR 1662 1920 \fBsmbd\fR(8) 1663 when a group is requested to be deleted . It will expand any1921 when a group is requested to be deleted\. It will expand any 1664 1922 \fI%g\fR 1665 to the group name passed . This script is only useful for installations using the Windows NT domain administration tools.1666 .sp 1667 Default: 1668 \f B\fIdelete group script\fR =\fR1669 .RE 1670 .PP 1923 to the group name passed\. This script is only useful for installations using the Windows NT domain administration tools\. 1924 .sp 1925 Default: 1926 \fI\fIdelete group script\fR\fR\fI = \fR\fI\fR\fI \fR 1927 .RE 1928 1671 1929 deleteprinter command (G) 1672 .RS 3n 1673 With the introduction of MS-RPC based printer support for Windows NT/2000 clients in Samba 2.2, it is now possible to delete printer at run time by issuing the DeletePrinter() RPC call. 1674 .sp 1675 For a Samba host this means that the printer must be physically deleted from underlying printing system. The 1676 deleteprinter command defines a script to be run which will perform the necessary operations for removing the printer from the print system and from 1677 \fIsmb.conf\fR. 1930 .PP 1931 .RS 4 1932 With the introduction of MS\-RPC based printer support for Windows NT/2000 clients in Samba 2\.2, it is now possible to delete printer at run time by issuing the DeletePrinter() RPC call\. 1933 .sp 1934 For a Samba host this means that the printer must be physically deleted from underlying printing system\. The 1935 \fIdeleteprinter command\fR 1936 defines a script to be run which will perform the necessary operations for removing the printer from the print system and from 1937 \fIsmb\.conf\fR\. 1678 1938 .sp 1679 1939 The 1680 deleteprinter command is automatically called with only one parameter: 1681 printer name. 1940 \fIdeleteprinter command\fR 1941 is automatically called with only one parameter: 1942 \fIprinter name\fR\. 1682 1943 .sp 1683 1944 Once the 1684 deleteprinter command has been executed, 1945 \fIdeleteprinter command\fR 1946 has been executed, 1685 1947 smbd 1686 1948 will reparse the 1687 \fI smb .conf\fR1688 to associated printer no longer exists . If the sharename is still valid, then1949 \fI smb\.conf\fR 1950 to associated printer no longer exists\. If the sharename is still valid, then 1689 1951 smbd 1690 will return an ACCESS_DENIED error to the client .1691 .sp 1692 Default: 1693 \f B\fIdeleteprinter command\fR =\fR1694 .sp 1695 Example: 1696 \f B\fIdeleteprinter command\fR = /usr/bin/removeprinter\fR1697 .RE 1698 .PP 1952 will return an ACCESS_DENIED error to the client\. 1953 .sp 1954 Default: 1955 \fI\fIdeleteprinter command\fR\fR\fI = \fR\fI\fR\fI \fR 1956 .sp 1957 Example: 1958 \fI\fIdeleteprinter command\fR\fR\fI = \fR\fI/usr/bin/removeprinter\fR\fI \fR 1959 .RE 1960 1699 1961 delete readonly (S) 1700 .RS 3n 1701 This parameter allows readonly files to be deleted. This is not normal DOS semantics, but is allowed by UNIX. 1702 .sp 1703 This option may be useful for running applications such as rcs, where UNIX file ownership prevents changing file permissions, and DOS semantics prevent deletion of a read only file. 1704 .sp 1705 Default: 1706 \fB\fIdelete readonly\fR = no \fR 1707 .RE 1708 .PP 1962 .PP 1963 .RS 4 1964 This parameter allows readonly files to be deleted\. This is not normal DOS semantics, but is allowed by UNIX\. 1965 .sp 1966 This option may be useful for running applications such as rcs, where UNIX file ownership prevents changing file permissions, and DOS semantics prevent deletion of a read only file\. 1967 .sp 1968 Default: 1969 \fI\fIdelete readonly\fR\fR\fI = \fR\fIno\fR\fI \fR 1970 .RE 1971 1709 1972 delete share command (G) 1710 .RS 3n 1711 Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server Manager. The 1973 .PP 1974 .RS 4 1975 Samba 2\.2\.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\.0 Server Manager\. The 1712 1976 \fIdelete share command\fR 1713 1977 is used to define an external program or script which will remove an existing service definition from 1714 \fIsmb .conf\fR. In order to successfully execute the1978 \fIsmb\.conf\fR\. In order to successfully execute the 1715 1979 \fIdelete share command\fR, 1716 1980 smbd 1717 requires that the administrator be connected using a root account (i.e. uid == 0). 1981 requires that the administrator be connected using a root account (i\.e\. uid == 0)\. 1982 .sp 1983 If the connected account has 1984 SeDiskOperatorPrivilege, scripts defined in 1985 \fIchange share\fR 1986 parameter are executed as root\. 1718 1987 .sp 1719 1988 When executed, … … 1721 1990 will automatically invoke the 1722 1991 \fIdelete share command\fR 1723 with two parameters. 1724 .RS 3n 1725 .TP 3n 1726 \(bu 1992 with two parameters\. 1993 .sp 1994 .RS 4 1995 .ie n \{\ 1996 \h'-04'\(bu\h'+03'\c 1997 .\} 1998 .el \{\ 1999 .sp -1 2000 .IP \(bu 2.3 2001 .\} 1727 2002 \fIconfigFile\fR 1728 - the location of the global 1729 \fIsmb.conf\fR 1730 file. 1731 .TP 3n 1732 \(bu 2003 \- the location of the global 2004 \fIsmb\.conf\fR 2005 file\. 2006 .RE 2007 .sp 2008 .RS 4 2009 .ie n \{\ 2010 \h'-04'\(bu\h'+03'\c 2011 .\} 2012 .el \{\ 2013 .sp -1 2014 .IP \(bu 2.3 2015 .\} 1733 2016 \fIshareName\fR 1734 - the name of the existing service.1735 . RE1736 . IP "" 3n1737 This parameter is only used to remove file shares . To delete printer shares, see the1738 deleteprinter command.1739 .sp 1740 Default: 1741 \f B\fIdelete share command\fR =\fR1742 .sp 1743 Example: 1744 \f B\fIdelete share command\fR = /usr/local/bin/delshare\fR1745 .RE 1746 .PP 2017 \- the name of the existing service\. 2018 .sp 2019 .RE 2020 This parameter is only used to remove file shares\. To delete printer shares, see the 2021 \fIdeleteprinter command\fR\. 2022 .sp 2023 Default: 2024 \fI\fIdelete share command\fR\fR\fI = \fR\fI\fR\fI \fR 2025 .sp 2026 Example: 2027 \fI\fIdelete share command\fR\fR\fI = \fR\fI/usr/local/bin/delshare\fR\fI \fR 2028 .RE 2029 1747 2030 delete user from group script (G) 1748 .RS 3n 1749 Full path to the script that will be called when a user is removed from a group using the Windows NT domain administration tools. It will be run by 2031 .PP 2032 .RS 4 2033 Full path to the script that will be called when a user is removed from a group using the Windows NT domain administration tools\. It will be run by 1750 2034 \fBsmbd\fR(8) 1751 \f BAS ROOT\fR. Any2035 \fIAS ROOT\fR\. Any 1752 2036 \fI%g\fR 1753 2037 will be replaced with the group name and any 1754 2038 \fI%u\fR 1755 will be replaced with the user name .1756 .sp 1757 Default: 1758 \f B\fIdelete user from group script\fR =\fR1759 .sp 1760 Example: 1761 \f B\fIdelete user from group script\fR = /usr/sbin/deluser %u %g\fR1762 .RE 1763 .PP 2039 will be replaced with the user name\. 2040 .sp 2041 Default: 2042 \fI\fIdelete user from group script\fR\fR\fI = \fR\fI\fR\fI \fR 2043 .sp 2044 Example: 2045 \fI\fIdelete user from group script\fR\fR\fI = \fR\fI/usr/sbin/deluser %u %g\fR\fI \fR 2046 .RE 2047 1764 2048 delete user script (G) 1765 .RS 3n 2049 .PP 2050 .RS 4 1766 2051 This is the full pathname to a script that will be run by 1767 2052 \fBsmbd\fR(8) 1768 when managing users with remote RPC (NT) tools .1769 .sp 1770 This script is called when a remote client removes a user from the server, normally using 'User Manager for Domains' or1771 rpcclient .1772 .sp 1773 This script should delete the given UNIX username .1774 .sp 1775 Default: 1776 \f B\fIdelete user script\fR =\fR1777 .sp 1778 Example: 1779 \f B\fIdelete user script\fR = /usr/local/samba/bin/del_user %u\fR1780 .RE 1781 .PP 2053 when managing users with remote RPC (NT) tools\. 2054 .sp 2055 This script is called when a remote client removes a user from the server, normally using \'User Manager for Domains\' or 2056 rpcclient\. 2057 .sp 2058 This script should delete the given UNIX username\. 2059 .sp 2060 Default: 2061 \fI\fIdelete user script\fR\fR\fI = \fR\fI\fR\fI \fR 2062 .sp 2063 Example: 2064 \fI\fIdelete user script\fR\fR\fI = \fR\fI/usr/local/samba/bin/del_user %u\fR\fI \fR 2065 .RE 2066 1782 2067 delete veto files (S) 1783 .RS 3n 2068 .PP 2069 .RS 4 1784 2070 This option is used when Samba is attempting to delete a directory that contains one or more vetoed directories (see the 1785 veto files option). If this option is set to 2071 \fIveto files\fR 2072 option)\. If this option is set to 1786 2073 \fBno\fR 1787 (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.2074 (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\. 1788 2075 .sp 1789 2076 If this option is set to 1790 \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.1791 \fI .AppleDouble\fR)2077 \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\. 2078 \fI\.AppleDouble\fR) 1792 2079 .sp 1793 2080 Setting 1794 delete veto files = yes allows these directories to be transparently deleted when the parent directory is deleted (so long as the user has permissions to do so). 1795 .sp 1796 Default: 1797 \fB\fIdelete veto files\fR = no \fR 1798 .RE 1799 .PP 2081 \fIdelete veto files = yes\fR 2082 allows these directories to be transparently deleted when the parent directory is deleted (so long as the user has permissions to do so)\. 2083 .sp 2084 Default: 2085 \fI\fIdelete veto files\fR\fR\fI = \fR\fIno\fR\fI \fR 2086 .RE 2087 1800 2088 dfree cache time (S) 1801 .RS 3n 2089 .PP 2090 .RS 4 1802 2091 The 1803 2092 \fIdfree cache time\fR 1804 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. 1805 .sp 1806 This is a new parameter introduced in Samba version 3.0.21. It specifies in seconds the time that smbd will cache the output of a disk free query. If set to zero (the default) no caching is done. This allows a heavily loaded server to prevent rapid spawning of 1807 dfree command scripts increasing the load. 1808 .sp 1809 By default this parameter is zero, meaning no caching will be done. 1810 .sp 1811 \fBNo default\fR 1812 .sp 1813 Example: 1814 \fB\fIdfree cache time\fR = dfree cache time = 60 \fR 1815 .RE 1816 .PP 2093 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\. 2094 .sp 2095 This is a new parameter introduced in Samba version 3\.0\.21\. It specifies in seconds the time that smbd will cache the output of a disk free query\. If set to zero (the default) no caching is done\. This allows a heavily loaded server to prevent rapid spawning of 2096 \fIdfree command\fR 2097 scripts increasing the load\. 2098 .sp 2099 By default this parameter is zero, meaning no caching will be done\. 2100 .sp 2101 \fINo default\fR 2102 .sp 2103 Example: 2104 \fI\fIdfree cache time\fR\fR\fI = \fR\fIdfree cache time = 60\fR\fI \fR 2105 .RE 2106 1817 2107 dfree command (S) 1818 .RS 3n 2108 .PP 2109 .RS 4 1819 2110 The 1820 2111 \fIdfree command\fR 1821 setting should only be used on systems where a problem occurs with the internal disk space calculations. This has been known to happen with Ultrix, but may occur with other operating systems. The symptom that was seen was an error of "Abort Retry Ignore" at the end of each directory listing. 1822 .sp 1823 This setting allows the replacement of the internal routines to calculate the total disk space and amount available with an external routine. The example below gives a possible script that might fulfill this function. 1824 .sp 1825 In Samba version 3.0.21 this parameter has been changed to be a per-share parameter, and in addition the parameter 1826 dfree cache time was added to allow the output of this script to be cached for systems under heavy load. 1827 .sp 1828 The external program will be passed a single parameter indicating a directory in the filesystem being queried. This will typically consist of the string 1829 \fI./\fR. The script should return two integers in ASCII. The first should be the total disk space in blocks, and the second should be the number of available blocks. An optional third return value can give the block size in bytes. The default blocksize is 1024 bytes. 2112 setting should only be used on systems where a problem occurs with the internal disk space calculations\. This has been known to happen with Ultrix, but may occur with other operating systems\. The symptom that was seen was an error of "Abort Retry Ignore" at the end of each directory listing\. 2113 .sp 2114 This setting allows the replacement of the internal routines to calculate the total disk space and amount available with an external routine\. The example below gives a possible script that might fulfill this function\. 2115 .sp 2116 In Samba version 3\.0\.21 this parameter has been changed to be a per\-share parameter, and in addition the parameter 2117 \fIdfree cache time\fR 2118 was added to allow the output of this script to be cached for systems under heavy load\. 2119 .sp 2120 The external program will be passed a single parameter indicating a directory in the filesystem being queried\. This will typically consist of the string 2121 \fI\./\fR\. The script should return two integers in ASCII\. The first should be the total disk space in blocks, and the second should be the number of available blocks\. An optional third return value can give the block size in bytes\. The default blocksize is 1024 bytes\. 1830 2122 .sp 1831 2123 Note: Your script should 1832 \f BNOT\fR2124 \fINOT\fR 1833 2125 be setuid or setgid and should be owned by (and writeable only by) root! 1834 2126 .sp 1835 2127 Where the script dfree (which must be made executable) could be: 1836 1837 .sp 1838 2128 .sp 2129 .RS 4 1839 2130 .nf 1840 2131 1841 2132 #!/bin/sh 1842 df $1 | tail -1 | awk '{print $2" "$4}' 1843 2133 df $1 | tail \-1 | awk \'{print $(NF\-4),$(NF\-2)}\' 1844 2134 .fi 2135 .RE 2136 .sp 1845 2137 or perhaps (on Sys V based systems): 1846 1847 .sp 1848 2138 .sp 2139 .RS 4 1849 2140 .nf 1850 2141 1851 2142 #!/bin/sh 1852 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}' 1853 2143 /usr/bin/df \-k $1 | tail \-1 | awk \'{print $3" "$5}\' 1854 2144 .fi 1855 Note that you may have to replace the command names with full path names on some systems. 1856 .sp 1857 By default internal routines for determining the disk capacity and remaining space will be used. 1858 .sp 1859 \fBNo default\fR 1860 .sp 1861 Example: 1862 \fB\fIdfree command\fR = /usr/local/samba/bin/dfree \fR 1863 .RE 1864 .PP 1865 directory mode 1866 .RS 3n 1867 This parameter is a synonym for directory mask. 1868 .RE 1869 .PP 2145 .RE 2146 .sp 2147 Note that you may have to replace the command names with full path names on some systems\. 2148 .sp 2149 By default internal routines for determining the disk capacity and remaining space will be used\. 2150 .sp 2151 \fINo default\fR 2152 .sp 2153 Example: 2154 \fI\fIdfree command\fR\fR\fI = \fR\fI/usr/local/samba/bin/dfree\fR\fI \fR 2155 .RE 2156 directory mode.PP 2157 .RS 4 2158 This parameter is a synonym for 2159 directory mask\. 2160 .RE 2161 1870 2162 directory mask (S) 1871 .RS 3n 1872 This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories. 1873 .sp 1874 When a directory is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit-wise 'AND'ed with this parameter. This parameter may be thought of as a bit-wise MASK for the UNIX modes of a directory. Any bit 1875 \fBnot\fR 1876 set here will be removed from the modes set on a directory when it is created. 1877 .sp 1878 The default value of this parameter removes the 'group' and 'other' write bits from the UNIX mode, allowing only the user who owns the directory to modify it. 1879 .sp 1880 Following this Samba will bit-wise 'OR' the UNIX mode created from this parameter with the value of the 1881 force directory mode parameter. This parameter is set to 000 by default (i.e. no extra mode bits are added). 1882 .sp 1883 Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors. If the administrator wishes to enforce a mask on access control lists also, they need to set the 1884 directory security mask. 1885 .sp 1886 Default: 1887 \fB\fIdirectory mask\fR = 0755 \fR 1888 .sp 1889 Example: 1890 \fB\fIdirectory mask\fR = 0775 \fR 1891 .RE 1892 .PP 2163 .PP 2164 .RS 4 2165 This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories\. 2166 .sp 2167 When a directory is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit\-wise \'AND\'ed with this parameter\. This parameter may be thought of as a bit\-wise MASK for the UNIX modes of a directory\. Any bit 2168 \fInot\fR 2169 set here will be removed from the modes set on a directory when it is created\. 2170 .sp 2171 The default value of this parameter removes the \'group\' and \'other\' write bits from the UNIX mode, allowing only the user who owns the directory to modify it\. 2172 .sp 2173 Following this Samba will bit\-wise \'OR\' the UNIX mode created from this parameter with the value of the 2174 \fIforce directory mode\fR 2175 parameter\. This parameter is set to 000 by default (i\.e\. no extra mode bits are added)\. 2176 .sp 2177 Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors\. If the administrator wishes to enforce a mask on access control lists also, they need to set the 2178 \fIdirectory security mask\fR\. 2179 .sp 2180 Default: 2181 \fI\fIdirectory mask\fR\fR\fI = \fR\fI0755\fR\fI \fR 2182 .sp 2183 Example: 2184 \fI\fIdirectory mask\fR\fR\fI = \fR\fI0775\fR\fI \fR 2185 .RE 2186 1893 2187 directory security mask (S) 1894 .RS 3n 1895 This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a directory using the native NT security dialog box. 1896 .sp 1897 This parameter is applied as a mask (AND'ed with) to the changed permission bits, thus preventing any bits not in this mask from being modified. Make sure not to mix up this parameter with 1898 force directory security mode, which works similar like this one but uses logical OR instead of AND. Essentially, zero bits in this mask may be treated as a set of bits the user is not allowed to change. 1899 .sp 1900 If not set explicitly this parameter is set to 0777 meaning a user is allowed to modify all the user/group/world permissions on a directory. 1901 .sp 1902 \fBNote\fR 1903 that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems. Administrators of most normal systems will probably want to leave it as the default of 1904 \fB0777\fR. 1905 .sp 1906 Default: 1907 \fB\fIdirectory security mask\fR = 0777 \fR 1908 .sp 1909 Example: 1910 \fB\fIdirectory security mask\fR = 0700 \fR 1911 .RE 1912 .PP 2188 .PP 2189 .RS 4 2190 This parameter controls what UNIX permission bits will be set when a Windows NT client is manipulating the UNIX permission on a directory using the native NT security dialog box\. 2191 .sp 2192 This parameter is applied as a mask (AND\'ed with) to the incoming permission bits, thus resetting any bits not in this mask\. Make sure not to mix up this parameter with 2193 \fIforce directory security mode\fR, which works similar like this one but uses logical OR instead of AND\. Essentially, zero bits in this mask are a set of bits that will always be set to zero\. 2194 .sp 2195 Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the file permissions regardless of the previous status of this bits on the file\. 2196 .sp 2197 If not set explicitly this parameter is set to 0777 meaning a user is allowed to set all the user/group/world permissions on a directory\. 2198 .sp 2199 \fINote\fR 2200 that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems\. Administrators of most normal systems will probably want to leave it as the default of 2201 \fB0777\fR\. 2202 .sp 2203 Default: 2204 \fI\fIdirectory security mask\fR\fR\fI = \fR\fI0777\fR\fI \fR 2205 .sp 2206 Example: 2207 \fI\fIdirectory security mask\fR\fR\fI = \fR\fI0700\fR\fI \fR 2208 .RE 2209 1913 2210 disable netbios (G) 1914 .RS 3n 1915 Enabling this parameter will disable netbios support in Samba. Netbios is the only available form of browsing in all windows versions except for 2000 and XP. 2211 .PP 2212 .RS 4 2213 Enabling this parameter will disable netbios support in Samba\. Netbios is the only available form of browsing in all windows versions except for 2000 and XP\. 1916 2214 .sp 1917 2215 .it 1 an-trap … … 1919 2217 .nr an-break-flag 1 1920 2218 .br 1921 \fBNote\fR 1922 Clients that only support netbios won't be able to see your samba server when netbios support is disabled. 1923 Default: 1924 \fB\fIdisable netbios\fR = no \fR 1925 .RE 1926 .PP 2219 Note 2220 Clients that only support netbios won\'t be able to see your samba server when netbios support is disabled\. 2221 2222 Default: 2223 \fI\fIdisable netbios\fR\fR\fI = \fR\fIno\fR\fI \fR 2224 .RE 2225 1927 2226 disable spoolss (G) 1928 .RS 3n 1929 Enabling this parameter will disable Samba's support for the SPOOLSS set of MS-RPC's and will yield identical behavior as Samba 2.0.x. Windows NT/2000 clients will downgrade to using Lanman style printing commands. Windows 9x/ME will be unaffected by the parameter. However, this will also disable the ability to upload printer drivers to a Samba server via the Windows NT Add Printer Wizard or by using the NT printer properties dialog window. It will also disable the capability of Windows NT/2000 clients to download print drivers from the Samba host upon demand. 1930 \fBBe very careful about enabling this parameter.\fR 1931 .sp 1932 Default: 1933 \fB\fIdisable spoolss\fR = no \fR 1934 .RE 1935 .PP 2227 .PP 2228 .RS 4 2229 Enabling this parameter will disable Samba\'s support for the SPOOLSS set of MS\-RPC\'s and will yield identical behavior as Samba 2\.0\.x\. Windows NT/2000 clients will downgrade to using Lanman style printing commands\. Windows 9x/ME will be unaffected by the parameter\. However, this will also disable the ability to upload printer drivers to a Samba server via the Windows NT Add Printer Wizard or by using the NT printer properties dialog window\. It will also disable the capability of Windows NT/2000 clients to download print drivers from the Samba host upon demand\. 2230 \fIBe very careful about enabling this parameter\.\fR 2231 .sp 2232 Default: 2233 \fI\fIdisable spoolss\fR\fR\fI = \fR\fIno\fR\fI \fR 2234 .RE 2235 1936 2236 display charset (G) 1937 .RS 3n 1938 Specifies the charset that samba will use to print messages to stdout and stderr. The default value is "LOCALE", which means automatically set, depending on the current locale. The value should generally be the same as the value of the parameter 1939 unix charset. 1940 .sp 1941 Default: 1942 \fB\fIdisplay charset\fR = "LOCALE" or "ASCII" (depending on the system) \fR 1943 .sp 1944 Example: 1945 \fB\fIdisplay charset\fR = UTF8 \fR 1946 .RE 1947 .PP 2237 .PP 2238 .RS 4 2239 Specifies the charset that samba will use to print messages to stdout and stderr\. The default value is "LOCALE", which means automatically set, depending on the current locale\. The value should generally be the same as the value of the parameter 2240 \fIunix charset\fR\. 2241 .sp 2242 Default: 2243 \fI\fIdisplay charset\fR\fR\fI = \fR\fI"LOCALE" or "ASCII" (depending on the system)\fR\fI \fR 2244 .sp 2245 Example: 2246 \fI\fIdisplay charset\fR\fR\fI = \fR\fIUTF8\fR\fI \fR 2247 .RE 2248 1948 2249 dmapi support (S) 1949 . RS 3n1950 This parameter specifies whether Samba should use DMAPI to determine whether a file is offline or not. This would typically be used in conjunction with a hierarchical storage system that automatically migrates files to tape. 1951 .sp 1952 Note that Samba infers the status of a file by examining the events that a DMAPI application has registered interest in. This heuristic is satisfactory for a number of hierarchical storage systems, but there may be system for which it will fail. In this case, Samba may erroneously report files to be offline. 1953 .sp 1954 This parameter is only available if a supported DMAPI implementation was found at compilation time. It will only be used if DMAPI is found to enabled on the system at run time. 1955 .sp 1956 1957 .sp 1958 Default: 1959 \f B\fIdmapi support\fR = no\fR1960 .RE 1961 .PP 2250 .PP 2251 .RS 4 2252 This parameter specifies whether Samba should use DMAPI to determine whether a file is offline or not\. This would typically be used in conjunction with a hierarchical storage system that automatically migrates files to tape\. 2253 .sp 2254 Note that Samba infers the status of a file by examining the events that a DMAPI application has registered interest in\. This heuristic is satisfactory for a number of hierarchical storage systems, but there may be system for which it will fail\. In this case, Samba may erroneously report files to be offline\. 2255 .sp 2256 This parameter is only available if a supported DMAPI implementation was found at compilation time\. It will only be used if DMAPI is found to enabled on the system at run time\. 2257 .sp 2258 .sp 2259 Default: 2260 \fI\fIdmapi support\fR\fR\fI = \fR\fIno\fR\fI \fR 2261 .RE 2262 1962 2263 dns proxy (G) 1963 .RS 3n 2264 .PP 2265 .RS 4 1964 2266 Specifies that 1965 2267 \fBnmbd\fR(8) 1966 when acting as a WINS server and finding that a NetBIOS name has not been registered, should treat the NetBIOS name word -for-word as a DNS name and do a lookup with the DNS server for that name on behalf of the name-querying client.1967 .sp 1968 Note that the maximum length for a NetBIOS name is 15 characters, so the DNS name (or DNS alias) can likewise only be 15 characters, maximum .2268 when acting as a WINS server and finding that a NetBIOS name has not been registered, should treat the NetBIOS name word\-for\-word as a DNS name and do a lookup with the DNS server for that name on behalf of the name\-querying client\. 2269 .sp 2270 Note that the maximum length for a NetBIOS name is 15 characters, so the DNS name (or DNS alias) can likewise only be 15 characters, maximum\. 1969 2271 .sp 1970 2272 nmbd 1971 spawns a second copy of itself to do the DNS name lookup requests, as doing a name lookup is a blocking action .1972 .sp 1973 Default: 1974 \f B\fIdns proxy\fR = yes\fR1975 .RE 1976 .PP 2273 spawns a second copy of itself to do the DNS name lookup requests, as doing a name lookup is a blocking action\. 2274 .sp 2275 Default: 2276 \fI\fIdns proxy\fR\fR\fI = \fR\fIyes\fR\fI \fR 2277 .RE 2278 1977 2279 domain logons (G) 1978 .RS 3n 2280 .PP 2281 .RS 4 1979 2282 If set to 1980 2283 \fByes\fR, the Samba server will provide the netlogon service for Windows 9X network logons for the 1981 workgroup it is in. This will also cause the Samba server to act as a domain controller for NT4 style domain services. For more details on setting up this feature see the Domain Control chapter of the Samba HOWTO Collection. 1982 .sp 1983 Default: 1984 \fB\fIdomain logons\fR = no \fR 1985 .RE 1986 .PP 2284 \fIworkgroup\fR 2285 it is in\. This will also cause the Samba server to act as a domain controller for NT4 style domain services\. For more details on setting up this feature see the Domain Control chapter of the Samba HOWTO Collection\. 2286 .sp 2287 Default: 2288 \fI\fIdomain logons\fR\fR\fI = \fR\fIno\fR\fI \fR 2289 .RE 2290 1987 2291 domain master (G) 1988 .RS 3n 2292 .PP 2293 .RS 4 1989 2294 Tell 1990 2295 \fBsmbd\fR(8) 1991 to enable WAN -wide browse list collation. Setting this option causes2296 to enable WAN\-wide browse list collation\. Setting this option causes 1992 2297 nmbd 1993 2298 to claim a special domain specific NetBIOS name that identifies it as a domain master browser for its given 1994 workgroup. Local master browsers in the same 1995 workgroup on broadcast-isolated subnets will give this 2299 \fIworkgroup\fR\. Local master browsers in the same 2300 \fIworkgroup\fR 2301 on broadcast\-isolated subnets will give this 1996 2302 nmbd 1997 2303 their local browse lists, and then ask 1998 2304 \fBsmbd\fR(8) 1999 for a complete copy of the browse list for the whole wide area network . Browser clients will then contact their local master browser, and will receive the domain-wide browse list, instead of just the list for their broadcast-isolated subnet.2305 for a complete copy of the browse list for the whole wide area network\. Browser clients will then contact their local master browser, and will receive the domain\-wide browse list, instead of just the list for their broadcast\-isolated subnet\. 2000 2306 .sp 2001 2307 Note that Windows NT Primary Domain Controllers expect to be able to claim this 2002 workgroup specific special NetBIOS name that identifies them as domain master browsers for that 2003 workgroup by default (i.e. there is no way to prevent a Windows NT PDC from attempting to do this). This means that if this parameter is set and 2308 \fIworkgroup\fR 2309 specific special NetBIOS name that identifies them as domain master browsers for that 2310 \fIworkgroup\fR 2311 by default (i\.e\. there is no way to prevent a Windows NT PDC from attempting to do this)\. This means that if this parameter is set and 2004 2312 nmbd 2005 2313 claims the special name for a 2006 workgroup before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail. 2314 \fIworkgroup\fR 2315 before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail\. 2007 2316 .sp 2008 2317 If 2009 domain logons = yes, then the default behavior is to enable the 2010 domain master parameter. If 2011 domain logons is not enabled (the default setting), then neither will 2012 domain master be enabled by default. 2318 \fIdomain logons = yes\fR, then the default behavior is to enable the 2319 \fIdomain master\fR 2320 parameter\. If 2321 \fIdomain logons\fR 2322 is not enabled (the default setting), then neither will 2323 \fIdomain master\fR 2324 be enabled by default\. 2013 2325 .sp 2014 2326 When 2015 domain logons = Yes the default setting for this parameter is Yes, with the result that Samba will be a PDC. If 2016 domain master = No, Samba will function as a BDC. In general, this parameter should be set to 'No' only on a BDC. 2017 .sp 2018 Default: 2019 \fB\fIdomain master\fR = auto \fR 2020 .RE 2021 .PP 2327 \fIdomain logons = Yes\fR 2328 the default setting for this parameter is Yes, with the result that Samba will be a PDC\. If 2329 \fIdomain master = No\fR, Samba will function as a BDC\. In general, this parameter should be set to \'No\' only on a BDC\. 2330 .sp 2331 Default: 2332 \fI\fIdomain master\fR\fR\fI = \fR\fIauto\fR\fI \fR 2333 .RE 2334 2022 2335 dont descend (S) 2023 .RS 3n 2024 There are certain directories on some systems (e.g., the 2336 .PP 2337 .RS 4 2338 There are certain directories on some systems (e\.g\., the 2025 2339 \fI/proc\fR 2026 tree under Linux) that are either not of interest to clients or are infinitely deep (recursive) . This parameter allows you to specify a comma-delimited list of directories that the server should always show as empty.2027 .sp 2028 Note that Samba can be very fussy about the exact format of the "dont descend" entries . For example you may need2029 \fI ./proc\fR2340 tree under Linux) that are either not of interest to clients or are infinitely deep (recursive)\. This parameter allows you to specify a comma\-delimited list of directories that the server should always show as empty\. 2341 .sp 2342 Note that Samba can be very fussy about the exact format of the "dont descend" entries\. For example you may need 2343 \fI \./proc\fR 2030 2344 instead of just 2031 \fI/proc\fR . Experimentation is the best policy :-)2032 .sp 2033 Default: 2034 \f B\fIdont descend\fR =\fR2035 .sp 2036 Example: 2037 \f B\fIdont descend\fR = /proc,/dev\fR2038 .RE 2039 .PP 2345 \fI/proc\fR\. Experimentation is the best policy :\-) 2346 .sp 2347 Default: 2348 \fI\fIdont descend\fR\fR\fI = \fR\fI\fR\fI \fR 2349 .sp 2350 Example: 2351 \fI\fIdont descend\fR\fR\fI = \fR\fI/proc,/dev\fR\fI \fR 2352 .RE 2353 2040 2354 dos charset (G) 2041 .RS 3n 2042 DOS SMB clients assume the server has the same charset as they do. This option specifies which charset Samba should talk to DOS clients. 2043 .sp 2044 The default depends on which charsets you have installed. Samba tries to use charset 850 but falls back to ASCII in case it is not available. Run 2355 .PP 2356 .RS 4 2357 DOS SMB clients assume the server has the same charset as they do\. This option specifies which charset Samba should talk to DOS clients\. 2358 .sp 2359 The default depends on which charsets you have installed\. Samba tries to use charset 850 but falls back to ASCII in case it is not available\. Run 2045 2360 \fBtestparm\fR(1) 2046 to check the default on your system .2047 .sp 2048 \f BNo default\fR2049 .RE 2050 .PP 2361 to check the default on your system\. 2362 .sp 2363 \fINo default\fR 2364 .RE 2365 2051 2366 dos filemode (S) 2052 .RS 3n 2053 The default behavior in Samba is to provide UNIX-like behavior where only the owner of a file/directory is able to change the permissions on it. However, this behavior is often confusing to DOS/Windows users. Enabling this parameter allows a user who has write access to the file (by whatever means) 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. 2054 .sp 2055 Default: 2056 \fB\fIdos filemode\fR = no \fR 2057 .RE 2058 .PP 2367 .PP 2368 .RS 4 2369 The default behavior in Samba is to provide UNIX\-like behavior where only the owner of a file/directory is able to change the permissions on it\. However, this behavior is often confusing to DOS/Windows users\. Enabling this parameter allows a user who has write access to the file (by whatever means) 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\. 2370 .sp 2371 Default: 2372 \fI\fIdos filemode\fR\fR\fI = \fR\fIno\fR\fI \fR 2373 .RE 2374 2059 2375 dos filetime resolution (S) 2060 .RS 3n 2061 Under the DOS and Windows FAT filesystem, the finest granularity on time resolution is two seconds. Setting this parameter for a share causes Samba to round the reported time down to the nearest two second boundary when a query call that requires one second resolution is made to 2062 \fBsmbd\fR(8). 2063 .sp 2064 This option is mainly used as a compatibility option for Visual C++ when used against Samba shares. If oplocks are enabled on a share, Visual C++ uses two different time reading calls to check if a file has changed since it was last read. One of these calls uses a one-second granularity, the other uses a two second granularity. As the two second call rounds any odd second down, then if the file has a timestamp of an odd number of seconds then the two timestamps will not match and Visual C++ will keep reporting the file has changed. Setting this option causes the two timestamps to match, and Visual C++ is happy. 2065 .sp 2066 Default: 2067 \fB\fIdos filetime resolution\fR = no \fR 2068 .RE 2069 .PP 2376 .PP 2377 .RS 4 2378 Under the DOS and Windows FAT filesystem, the finest granularity on time resolution is two seconds\. Setting this parameter for a share causes Samba to round the reported time down to the nearest two second boundary when a query call that requires one second resolution is made to 2379 \fBsmbd\fR(8)\. 2380 .sp 2381 This option is mainly used as a compatibility option for Visual C++ when used against Samba shares\. If oplocks are enabled on a share, Visual C++ uses two different time reading calls to check if a file has changed since it was last read\. One of these calls uses a one\-second granularity, the other uses a two second granularity\. As the two second call rounds any odd second down, then if the file has a timestamp of an odd number of seconds then the two timestamps will not match and Visual C++ will keep reporting the file has changed\. Setting this option causes the two timestamps to match, and Visual C++ is happy\. 2382 .sp 2383 Default: 2384 \fI\fIdos filetime resolution\fR\fR\fI = \fR\fIno\fR\fI \fR 2385 .RE 2386 2070 2387 dos filetimes (S) 2071 .RS 3n 2072 Under DOS and Windows, if a user can write to a file they can change the timestamp on it. Under POSIX semantics, only the owner of the file or root may change the timestamp. By default, Samba runs with POSIX semantics and refuses to change the timestamp on a file if the user 2388 .PP 2389 .RS 4 2390 Under DOS and Windows, if a user can write to a file they can change the timestamp on it\. Under POSIX semantics, only the owner of the file or root may change the timestamp\. By default, Samba runs with POSIX semantics and refuses to change the timestamp on a file if the user 2073 2391 smbd 2074 is acting on behalf of is not the file owner . Setting this option to2392 is acting on behalf of is not the file owner\. Setting this option to 2075 2393 \fB yes\fR 2076 2394 allows DOS semantics and 2077 2395 \fBsmbd\fR(8) 2078 will change the file timestamp as DOS requires . Due to changes in Microsoft Office 2000 and beyond, the default for this parameter has been changed from "no" to "yes" in Samba 3.0.14 and above. Microsoft Excel will display dialog box warnings about the file being changed by another user if this parameter is not set to "yes" and files are being shared between users.2079 .sp 2080 Default: 2081 \f B\fIdos filetimes\fR = yes\fR2082 .RE 2083 .PP 2396 will change the file timestamp as DOS requires\. Due to changes in Microsoft Office 2000 and beyond, the default for this parameter has been changed from "no" to "yes" in Samba 3\.0\.14 and above\. Microsoft Excel will display dialog box warnings about the file being changed by another user if this parameter is not set to "yes" and files are being shared between users\. 2397 .sp 2398 Default: 2399 \fI\fIdos filetimes\fR\fR\fI = \fR\fIyes\fR\fI \fR 2400 .RE 2401 2084 2402 ea support (S) 2085 .RS 3n 2403 .PP 2404 .RS 4 2086 2405 This boolean parameter controls whether 2087 2406 \fBsmbd\fR(8) 2088 will allow clients to attempt to store OS/2 style Extended attributes on a share . In order to enable this parameter the underlying filesystem exported by the share must support extended attributes (such as provided on XFS and EXT3 on Linux, with the correct kernel patches). On Linux the filesystem must have been mounted with the mount option user_xattr in order for extended attributes to work, also extended attributes must be compiled into the Linux kernel.2089 .sp 2090 Default: 2091 \f B\fIea support\fR = no\fR2092 .RE 2093 .PP 2407 will allow clients to attempt to store OS/2 style Extended attributes on a share\. In order to enable this parameter the underlying filesystem exported by the share must support extended attributes (such as provided on XFS and EXT3 on Linux, with the correct kernel patches)\. On Linux the filesystem must have been mounted with the mount option user_xattr in order for extended attributes to work, also extended attributes must be compiled into the Linux kernel\. 2408 .sp 2409 Default: 2410 \fI\fIea support\fR\fR\fI = \fR\fIno\fR\fI \fR 2411 .RE 2412 2094 2413 enable asu support (G) 2095 .RS 3n 2096 Hosts running the "Advanced Server for Unix (ASU)" product require some special accomodations such as creating a builting [ADMIN$] share that only supports IPC connections. The has been the default behavior in smbd for many years. However, certain Microsoft applications such as the Print Migrator tool require that the remote server support an [ADMIN$} file share. Disabling this parameter allows for creating an [ADMIN$] file share in smb.conf. 2097 .sp 2098 Default: 2099 \fB\fIenable asu support\fR = no \fR 2100 .RE 2101 .PP 2414 .PP 2415 .RS 4 2416 Hosts running the "Advanced Server for Unix (ASU)" product require some special accomodations such as creating a builting [ADMIN$] share that only supports IPC connections\. The has been the default behavior in smbd for many years\. However, certain Microsoft applications such as the Print Migrator tool require that the remote server support an [ADMIN$} file share\. Disabling this parameter allows for creating an [ADMIN$] file share in smb\.conf\. 2417 .sp 2418 Default: 2419 \fI\fIenable asu support\fR\fR\fI = \fR\fIno\fR\fI \fR 2420 .RE 2421 2102 2422 enable privileges (G) 2103 .RS 3n 2423 .PP 2424 .RS 4 2104 2425 This parameter controls whether or not smbd will honor privileges assigned to specific SIDs via either 2105 2426 net rpc rights 2106 or one of the Windows user and group manager tools . This parameter is enabled by default. It can be disabled to prevent members of the Domain Admins group from being able to assign privileges to users or groups which can then result in certain smbd operations running as root that would normally run under the context of the connected user.2107 .sp 2108 An example of how privileges can be used is to assign the right to join clients to a Samba controlled domain without providing root access to the server via smbd .2109 .sp 2110 Please read the extended description provided in the Samba HOWTO documentation .2111 .sp 2112 Default: 2113 \f B\fIenable privileges\fR = yes\fR2114 .RE 2115 .PP 2427 or one of the Windows user and group manager tools\. This parameter is enabled by default\. It can be disabled to prevent members of the Domain Admins group from being able to assign privileges to users or groups which can then result in certain smbd operations running as root that would normally run under the context of the connected user\. 2428 .sp 2429 An example of how privileges can be used is to assign the right to join clients to a Samba controlled domain without providing root access to the server via smbd\. 2430 .sp 2431 Please read the extended description provided in the Samba HOWTO documentation\. 2432 .sp 2433 Default: 2434 \fI\fIenable privileges\fR\fR\fI = \fR\fIyes\fR\fI \fR 2435 .RE 2436 2116 2437 encrypt passwords (G) 2117 .RS 3n 2118 This boolean controls whether encrypted passwords will be negotiated with the client. Note that Windows NT 4.0 SP3 and above and also Windows 98 will by default expect encrypted passwords unless a registry entry is changed. To use encrypted passwords in Samba see the chapter "User Database" in the Samba HOWTO Collection. 2119 .sp 2120 MS Windows clients that expect Microsoft encrypted passwords and that do not have plain text password support enabled will be able to connect only to a Samba server that has encrypted password support enabled and for which the user accounts have a valid encrypted password. Refer to the smbpasswd command man page for information regarding the creation of encrypted passwords for user accounts. 2121 .sp 2122 The use of plain text passwords is NOT advised as support for this feature is no longer maintained in Microsoft Windows products. If you want to use plain text passwords you must set this parameter to no. 2438 .PP 2439 .RS 4 2440 This boolean controls whether encrypted passwords will be negotiated with the client\. Note that Windows NT 4\.0 SP3 and above and also Windows 98 will by default expect encrypted passwords unless a registry entry is changed\. To use encrypted passwords in Samba see the chapter "User Database" in the Samba HOWTO Collection\. 2441 .sp 2442 MS Windows clients that expect Microsoft encrypted passwords and that do not have plain text password support enabled will be able to connect only to a Samba server that has encrypted password support enabled and for which the user accounts have a valid encrypted password\. Refer to the smbpasswd command man page for information regarding the creation of encrypted passwords for user accounts\. 2443 .sp 2444 The use of plain text passwords is NOT advised as support for this feature is no longer maintained in Microsoft Windows products\. If you want to use plain text passwords you must set this parameter to no\. 2123 2445 .sp 2124 2446 In order for encrypted passwords to work correctly … … 2129 2451 \fBsmbpasswd\fR(8) 2130 2452 program for information on how to set up and maintain this file), or set the 2131 security = [server|domain|ads] parameter which causes 2453 \fIsecurity = [server|domain|ads]\fR 2454 parameter which causes 2132 2455 smbd 2133 to authenticate against another server .2134 .sp 2135 Default: 2136 \f B\fIencrypt passwords\fR = yes\fR2137 .RE 2138 .PP 2456 to authenticate against another server\. 2457 .sp 2458 Default: 2459 \fI\fIencrypt passwords\fR\fR\fI = \fR\fIyes\fR\fI \fR 2460 .RE 2461 2139 2462 enhanced browsing (G) 2140 .RS 3n 2141 This option enables a couple of enhancements to cross-subnet browse propagation that have been added in Samba but which are not standard in Microsoft implementations. 2142 .sp 2143 The first enhancement to browse propagation consists of a regular wildcard query to a Samba WINS server for all Domain Master Browsers, followed by a browse synchronization with each of the returned DMBs. The second enhancement consists of a regular randomised browse synchronization with all currently known DMBs. 2144 .sp 2145 You may wish to disable this option if you have a problem with empty workgroups not disappearing from browse lists. Due to the restrictions of the browse protocols these enhancements can cause a empty workgroup to stay around forever which can be annoying. 2146 .sp 2147 In general you should leave this option enabled as it makes cross-subnet browse propagation much more reliable. 2148 .sp 2149 Default: 2150 \fB\fIenhanced browsing\fR = yes \fR 2151 .RE 2152 .PP 2463 .PP 2464 .RS 4 2465 This option enables a couple of enhancements to cross\-subnet browse propagation that have been added in Samba but which are not standard in Microsoft implementations\. 2466 .sp 2467 The first enhancement to browse propagation consists of a regular wildcard query to a Samba WINS server for all Domain Master Browsers, followed by a browse synchronization with each of the returned DMBs\. The second enhancement consists of a regular randomised browse synchronization with all currently known DMBs\. 2468 .sp 2469 You may wish to disable this option if you have a problem with empty workgroups not disappearing from browse lists\. Due to the restrictions of the browse protocols these enhancements can cause a empty workgroup to stay around forever which can be annoying\. 2470 .sp 2471 In general you should leave this option enabled as it makes cross\-subnet browse propagation much more reliable\. 2472 .sp 2473 Default: 2474 \fI\fIenhanced browsing\fR\fR\fI = \fR\fIyes\fR\fI \fR 2475 .RE 2476 2153 2477 enumports command (G) 2154 .RS 3n 2155 The concept of a "port" is fairly foreign to UNIX hosts. Under Windows NT/2000 print servers, a port is associated with a port monitor and generally takes the form of a local port (i.e. LPT1:, COM1:, FILE:) or a remote port (i.e. LPD Port Monitor, etc...). By default, Samba has only one port defined--\fB"Samba Printer Port"\fR. Under Windows NT/2000, all printers must have a valid port name. If you wish to have a list of ports displayed (smbd 2478 .PP 2479 .RS 4 2480 The concept of a "port" is fairly foreign to UNIX hosts\. Under Windows NT/2000 print servers, a port is associated with a port monitor and generally takes the form of a local port (i\.e\. LPT1:, COM1:, FILE:) or a remote port (i\.e\. LPD Port Monitor, etc\.\.\.)\. By default, Samba has only one port defined\-\-\fB"Samba Printer Port"\fR\. Under Windows NT/2000, all printers must have a valid port name\. If you wish to have a list of ports displayed (smbd 2156 2481 does not use a port name for anything) other than the default 2157 2482 \fB"Samba Printer Port"\fR, you can define 2158 2483 \fIenumports command\fR 2159 to point to a program which should generate a list of ports, one per line, to standard output . This listing will then be used in response to the level 1 and 2 EnumPorts() RPC.2160 .sp 2161 Default: 2162 \f B\fIenumports command\fR =\fR2163 .sp 2164 Example: 2165 \f B\fIenumports command\fR = /usr/bin/listports\fR2166 .RE 2167 .PP 2484 to point to a program which should generate a list of ports, one per line, to standard output\. This listing will then be used in response to the level 1 and 2 EnumPorts() RPC\. 2485 .sp 2486 Default: 2487 \fI\fIenumports command\fR\fR\fI = \fR\fI\fR\fI \fR 2488 .sp 2489 Example: 2490 \fI\fIenumports command\fR\fR\fI = \fR\fI/usr/bin/listports\fR\fI \fR 2491 .RE 2492 2168 2493 eventlog list (G) 2169 .RS 3n 2170 This option defines a list of log names that Samba will report to the Microsoft EventViewer utility. The listed eventlogs will be associated with tdb file on disk in the 2171 \fI$(lockdir)/eventlog\fR. 2494 .PP 2495 .RS 4 2496 This option defines a list of log names that Samba will report to the Microsoft EventViewer utility\. The listed eventlogs will be associated with tdb file on disk in the 2497 \fI$(lockdir)/eventlog\fR\. 2172 2498 .sp 2173 2499 The administrator must use an external process to parse the normal Unix logs such as 2174 2500 \fI/var/log/messages\fR 2175 and write then entries to the eventlog tdb files . Refer to the eventlogadm(8) utility for how to write eventlog entries.2176 .sp 2177 Default: 2178 \f B\fIeventlog list\fR =\fR2179 .sp 2180 Example: 2181 \f B\fIeventlog list\fR = Security Application Syslog Apache\fR2182 .RE 2183 .PP 2501 and write then entries to the eventlog tdb files\. Refer to the eventlogadm(8) utility for how to write eventlog entries\. 2502 .sp 2503 Default: 2504 \fI\fIeventlog list\fR\fR\fI = \fR\fI\fR\fI \fR 2505 .sp 2506 Example: 2507 \fI\fIeventlog list\fR\fR\fI = \fR\fISecurity Application Syslog Apache\fR\fI \fR 2508 .RE 2509 2184 2510 fake directory create times (S) 2185 .RS 3n 2186 NTFS and Windows VFAT file systems keep a create time for all files and directories. This is not the same as the ctime - status change time - that Unix keeps, so Samba by default reports the earliest of the various times Unix does keep. Setting this parameter for a share causes Samba to always report midnight 1-1-1980 as the create time for directories. 2187 .sp 2188 This option is mainly used as a compatibility option for Visual C++ when used against Samba shares. Visual C++ generated makefiles have the object directory as a dependency for each object file, and a make rule to create the directory. Also, when NMAKE compares timestamps it uses the creation time when examining a directory. Thus the object directory will be created if it does not exist, but once it does exist it will always have an earlier timestamp than the object files it contains. 2189 .sp 2190 However, Unix time semantics mean that the create time reported by Samba will be updated whenever a file is created or or deleted in the directory. NMAKE finds all object files in the object directory. The timestamp of the last one built is then compared to the timestamp of the object directory. If the directory's timestamp if newer, then all object files will be rebuilt. Enabling this option ensures directories always predate their contents and an NMAKE build will proceed as expected. 2191 .sp 2192 Default: 2193 \fB\fIfake directory create times\fR = no \fR 2194 .RE 2195 .PP 2511 .PP 2512 .RS 4 2513 NTFS and Windows VFAT file systems keep a create time for all files and directories\. This is not the same as the ctime \- status change time \- that Unix keeps, so Samba by default reports the earliest of the various times Unix does keep\. Setting this parameter for a share causes Samba to always report midnight 1\-1\-1980 as the create time for directories\. 2514 .sp 2515 This option is mainly used as a compatibility option for Visual C++ when used against Samba shares\. Visual C++ generated makefiles have the object directory as a dependency for each object file, and a make rule to create the directory\. Also, when NMAKE compares timestamps it uses the creation time when examining a directory\. Thus the object directory will be created if it does not exist, but once it does exist it will always have an earlier timestamp than the object files it contains\. 2516 .sp 2517 However, Unix time semantics mean that the create time reported by Samba will be updated whenever a file is created or or deleted in the directory\. NMAKE finds all object files in the object directory\. The timestamp of the last one built is then compared to the timestamp of the object directory\. If the directory\'s timestamp if newer, then all object files will be rebuilt\. Enabling this option ensures directories always predate their contents and an NMAKE build will proceed as expected\. 2518 .sp 2519 Default: 2520 \fI\fIfake directory create times\fR\fR\fI = \fR\fIno\fR\fI \fR 2521 .RE 2522 2196 2523 fake oplocks (S) 2197 .RS 3n 2198 Oplocks are the way that SMB clients get permission from a server to locally cache file operations. If a server grants an oplock (opportunistic lock) then the client is free to assume that it is the only one accessing the file and it will aggressively cache file data. With some oplock types the client may even cache file open/close operations. This can give enormous performance benefits. 2524 .PP 2525 .RS 4 2526 Oplocks are the way that SMB clients get permission from a server to locally cache file operations\. If a server grants an oplock (opportunistic lock) then the client is free to assume that it is the only one accessing the file and it will aggressively cache file data\. With some oplock types the client may even cache file open/close operations\. This can give enormous performance benefits\. 2199 2527 .sp 2200 2528 When you set 2201 2529 fake oplocks = yes, 2202 2530 \fBsmbd\fR(8) 2203 will always grant oplock requests no matter how many clients are using the file .2531 will always grant oplock requests no matter how many clients are using the file\. 2204 2532 .sp 2205 2533 It is generally much better to use the real 2206 oplocks support rather than this parameter. 2207 .sp 2208 If you enable this option on all read-only shares or shares that you know will only be accessed from one client at a time such as physically read-only media like CDROMs, you will see a big performance improvement on many operations. If you enable this option on shares where multiple clients may be accessing the files read-write at the same time you can get data corruption. Use this option carefully! 2209 .sp 2210 Default: 2211 \fB\fIfake oplocks\fR = no \fR 2212 .RE 2213 .PP 2534 \fIoplocks\fR 2535 support rather than this parameter\. 2536 .sp 2537 If you enable this option on all read\-only shares or shares that you know will only be accessed from one client at a time such as physically read\-only media like CDROMs, you will see a big performance improvement on many operations\. If you enable this option on shares where multiple clients may be accessing the files read\-write at the same time you can get data corruption\. Use this option carefully! 2538 .sp 2539 Default: 2540 \fI\fIfake oplocks\fR\fR\fI = \fR\fIno\fR\fI \fR 2541 .RE 2542 2214 2543 follow symlinks (S) 2215 .RS 3n 2544 .PP 2545 .RS 4 2216 2546 This parameter allows the Samba administrator to stop 2217 2547 \fBsmbd\fR(8) 2218 from following symbolic links in a particular share . Setting this parameter to2548 from following symbolic links in a particular share\. Setting this parameter to 2219 2549 \fBno\fR 2220 prevents any file or directory that is a symbolic link from being followed (the user will get an error) . This option is very useful to stop users from adding a symbolic link to2550 prevents any file or directory that is a symbolic link from being followed (the user will get an error)\. This option is very useful to stop users from adding a symbolic link to 2221 2551 \fI/etc/passwd\fR 2222 in their home directory for instance . However it will slow filename lookups down slightly.2223 .sp 2224 This option is enabled (i .e.2552 in their home directory for instance\. However it will slow filename lookups down slightly\. 2553 .sp 2554 This option is enabled (i\.e\. 2225 2555 smbd 2226 will follow symbolic links) by default .2227 .sp 2228 Default: 2229 \f B\fIfollow symlinks\fR = yes\fR2230 .RE 2231 .PP 2556 will follow symbolic links) by default\. 2557 .sp 2558 Default: 2559 \fI\fIfollow symlinks\fR\fR\fI = \fR\fIyes\fR\fI \fR 2560 .RE 2561 2232 2562 force create mode (S) 2233 .RS 3n 2563 .PP 2564 .RS 4 2234 2565 This parameter specifies a set of UNIX mode bit permissions that will 2235 \f Balways\fR2236 be set on a file created by Samba . This is done by bitwise 'OR'ing these bits onto the mode bits of a file that is being created or having its permissions changed. The default for this parameter is (in octal) 000. The modes in this parameter are bitwise 'OR'ed onto the file mode after the mask set in the2566 \fIalways\fR 2567 be set on a file created by Samba\. This is done by bitwise \'OR\'ing these bits onto the mode bits of a file that is being created or having its permissions changed\. The default for this parameter is (in octal) 000\. The modes in this parameter are bitwise \'OR\'ed onto the file mode after the mask set in the 2237 2568 \fIcreate mask\fR 2238 parameter is applied .2239 .sp 2240 The example below would force all created files to have read and execute permissions set for 'group' and 'other' as well as the read/write/execute bits set for the 'user'.2241 .sp 2242 Default: 2243 \f B\fIforce create mode\fR = 000\fR2244 .sp 2245 Example: 2246 \f B\fIforce create mode\fR = 0755\fR2247 .RE 2248 .PP 2569 parameter is applied\. 2570 .sp 2571 The example below would force all created files to have read and execute permissions set for \'group\' and \'other\' as well as the read/write/execute bits set for the \'user\'\. 2572 .sp 2573 Default: 2574 \fI\fIforce create mode\fR\fR\fI = \fR\fI000\fR\fI \fR 2575 .sp 2576 Example: 2577 \fI\fIforce create mode\fR\fR\fI = \fR\fI0755\fR\fI \fR 2578 .RE 2579 2249 2580 force directory mode (S) 2250 .RS 3n 2581 .PP 2582 .RS 4 2251 2583 This parameter specifies a set of UNIX mode bit permissions that will 2252 \f Balways\fR2253 be set on a directory created by Samba . This is done by bitwise 'OR'ing these bits onto the mode bits of a directory that is being created. The default for this parameter is (in octal) 0000 which will not add any extra permission bits to a created directory. This operation is done after the mode mask in the parameter2584 \fIalways\fR 2585 be set on a directory created by Samba\. This is done by bitwise \'OR\'ing these bits onto the mode bits of a directory that is being created\. The default for this parameter is (in octal) 0000 which will not add any extra permission bits to a created directory\. This operation is done after the mode mask in the parameter 2254 2586 \fIdirectory mask\fR 2255 is applied .2256 .sp 2257 The example below would force all created directories to have read and execute permissions set for 'group' and 'other' as well as the read/write/execute bits set for the 'user'.2258 .sp 2259 Default: 2260 \f B\fIforce directory mode\fR = 000\fR2261 .sp 2262 Example: 2263 \f B\fIforce directory mode\fR = 0755\fR2264 .RE 2265 .PP 2587 is applied\. 2588 .sp 2589 The example below would force all created directories to have read and execute permissions set for \'group\' and \'other\' as well as the read/write/execute bits set for the \'user\'\. 2590 .sp 2591 Default: 2592 \fI\fIforce directory mode\fR\fR\fI = \fR\fI000\fR\fI \fR 2593 .sp 2594 Example: 2595 \fI\fIforce directory mode\fR\fR\fI = \fR\fI0755\fR\fI \fR 2596 .RE 2597 2266 2598 force directory security mode (S) 2267 .RS 3n 2268 This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a directory using the native NT security dialog box. 2269 .sp 2270 This parameter is applied as a mask (OR'ed with) to the changed permission bits, thus forcing any bits in this mask that the user may have modified to be on. Make sure not to mix up this parameter with 2271 directory security mask, which works in a similar manner to this one, but uses a logical AND instead of an OR. 2272 .sp 2273 Essentially, this mask may be treated as a set of bits that, when modifying security on a directory, to will enable (1) any flags that are off (0) but which the mask has set to on (1). 2274 .sp 2275 If not set explicitly this parameter is 0000, which allows a user to modify all the user/group/world permissions on a directory without restrictions. 2599 .PP 2600 .RS 4 2601 This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a directory using the native NT security dialog box\. 2602 .sp 2603 This parameter is applied as a mask (OR\'ed with) to the changed permission bits, thus forcing any bits in this mask that the user may have modified to be on\. Make sure not to mix up this parameter with 2604 \fIdirectory security mask\fR, which works in a similar manner to this one, but uses a logical AND instead of an OR\. 2605 .sp 2606 Essentially, this mask may be treated as a set of bits that, when modifying security on a directory, to will enable (1) any flags that are off (0) but which the mask has set to on (1)\. 2607 .sp 2608 If not set explicitly this parameter is 0000, which allows a user to modify all the user/group/world permissions on a directory without restrictions\. 2276 2609 .sp 2277 2610 .it 1 an-trap … … 2279 2612 .nr an-break-flag 1 2280 2613 .br 2281 \fBNote\fR 2282 Users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems. Administrators of most normal systems will probably want to leave it set as 0000. 2283 Default: 2284 \fB\fIforce directory security mode\fR = 0 \fR 2285 .sp 2286 Example: 2287 \fB\fIforce directory security mode\fR = 700 \fR 2288 .RE 2289 .PP 2290 group 2291 .RS 3n 2292 This parameter is a synonym for force group. 2293 .RE 2294 .PP 2614 Note 2615 Users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems\. Administrators of most normal systems will probably want to leave it set as 0000\. 2616 2617 Default: 2618 \fI\fIforce directory security mode\fR\fR\fI = \fR\fI0\fR\fI \fR 2619 .sp 2620 Example: 2621 \fI\fIforce directory security mode\fR\fR\fI = \fR\fI700\fR\fI \fR 2622 .RE 2623 group.PP 2624 .RS 4 2625 This parameter is a synonym for 2626 force group\. 2627 .RE 2628 2295 2629 force group (S) 2296 .RS 3n 2297 This specifies a UNIX group name that will be assigned as the default primary group for all users connecting to this service. This is useful for sharing files by ensuring that all access to files on service will use the named group for their permissions checking. Thus, by assigning permissions for this group to the files and directories within this service the Samba administrator can restrict or allow sharing of these files. 2298 .sp 2299 In Samba 2.0.5 and above this parameter has extended functionality in the following way. If the group name listed here has a '+' character prepended to it then the current user accessing the share only has the primary group default assigned to this group if they are already assigned as a member of that group. This allows an administrator to decide that only users who are already in a particular group will create files with group ownership set to that group. This gives a finer granularity of ownership assignment. For example, the setting 2630 .PP 2631 .RS 4 2632 This specifies a UNIX group name that will be assigned as the default primary group for all users connecting to this service\. This is useful for sharing files by ensuring that all access to files on service will use the named group for their permissions checking\. Thus, by assigning permissions for this group to the files and directories within this service the Samba administrator can restrict or allow sharing of these files\. 2633 .sp 2634 In Samba 2\.0\.5 and above this parameter has extended functionality in the following way\. If the group name listed here has a \'+\' character prepended to it then the current user accessing the share only has the primary group default assigned to this group if they are already assigned as a member of that group\. This allows an administrator to decide that only users who are already in a particular group will create files with group ownership set to that group\. This gives a finer granularity of ownership assignment\. For example, the setting 2300 2635 \fIforce group = +sys\fR 2301 means that only users who are already in group sys will have their default primary group assigned to sys when accessing this Samba share . All other users will retain their ordinary primary group.2636 means that only users who are already in group sys will have their default primary group assigned to sys when accessing this Samba share\. All other users will retain their ordinary primary group\. 2302 2637 .sp 2303 2638 If the 2304 force user parameter is also set the group specified in 2639 \fIforce user\fR 2640 parameter is also set the group specified in 2305 2641 \fIforce group\fR 2306 2642 will override the primary group set in 2307 \fIforce user\fR .2308 .sp 2309 Default: 2310 \f B\fIforce group\fR =\fR2311 .sp 2312 Example: 2313 \f B\fIforce group\fR = agroup\fR2314 .RE 2315 .PP 2643 \fIforce user\fR\. 2644 .sp 2645 Default: 2646 \fI\fIforce group\fR\fR\fI = \fR\fI\fR\fI \fR 2647 .sp 2648 Example: 2649 \fI\fIforce group\fR\fR\fI = \fR\fIagroup\fR\fI \fR 2650 .RE 2651 2316 2652 force printername (S) 2317 .RS 3n 2653 .PP 2654 .RS 4 2318 2655 When printing from Windows NT (or later), each printer in 2319 \fIsmb .conf\fR2320 has two associated names which can be used by the client . The first is the sharename (or shortname) defined in smb.conf. This is the only printername available for use by Windows 9x clients. The second name associated with a printer can be seen when browsing to the "Printers" (or "Printers and Faxes") folder on the Samba server. This is referred to simply as the printername (not to be confused with the2656 \fIsmb\.conf\fR 2657 has two associated names which can be used by the client\. The first is the sharename (or shortname) defined in smb\.conf\. This is the only printername available for use by Windows 9x clients\. The second name associated with a printer can be seen when browsing to the "Printers" (or "Printers and Faxes") folder on the Samba server\. This is referred to simply as the printername (not to be confused with the 2321 2658 \fIprinter name\fR 2322 option) .2323 .sp 2324 When assigning a new driver to a printer on a remote Windows compatible print server such as Samba, the Windows client will rename the printer to match the driver name just uploaded . This can result in confusion for users when multiple printers are bound to the same driver. To prevent Samba from allowing the printer's printername to differ from the sharename defined in smb.conf, set2325 \fIforce printername = yes\fR .2326 .sp 2327 Be aware that enabling this parameter may affect migrating printers from a Windows server to Samba since Windows has no way to force the sharename and printername to match .2328 .sp 2329 It is recommended that this parameter 's value not be changed once the printer is in use by clients as this could cause a user not be able to delete printer connections from their local Printers folder.2330 .sp 2331 Default: 2332 \f B\fIforce printername\fR = no\fR2333 .RE 2334 .PP 2659 option)\. 2660 .sp 2661 When assigning a new driver to a printer on a remote Windows compatible print server such as Samba, the Windows client will rename the printer to match the driver name just uploaded\. This can result in confusion for users when multiple printers are bound to the same driver\. To prevent Samba from allowing the printer\'s printername to differ from the sharename defined in smb\.conf, set 2662 \fIforce printername = yes\fR\. 2663 .sp 2664 Be aware that enabling this parameter may affect migrating printers from a Windows server to Samba since Windows has no way to force the sharename and printername to match\. 2665 .sp 2666 It is recommended that this parameter\'s value not be changed once the printer is in use by clients as this could cause a user not be able to delete printer connections from their local Printers folder\. 2667 .sp 2668 Default: 2669 \fI\fIforce printername\fR\fR\fI = \fR\fIno\fR\fI \fR 2670 .RE 2671 2335 2672 force security mode (S) 2336 .RS 3n 2337 This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a file using the native NT security dialog box. 2338 .sp 2339 This parameter is applied as a mask (OR'ed with) to the changed permission bits, thus forcing any bits in this mask that the user may have modified to be on. Make sure not to mix up this parameter with 2340 security mask, which works similar like this one but uses logical AND instead of OR. 2341 .sp 2342 Essentially, one bits in this mask may be treated as a set of bits that, when modifying security on a file, the user has always set to be on. 2343 .sp 2344 If not set explicitly this parameter is set to 0, and allows a user to modify all the user/group/world permissions on a file, with no restrictions. 2345 .sp 2346 \fB Note\fR 2347 that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems. Administrators of most normal systems will probably want to leave this set to 0000. 2348 .sp 2349 Default: 2350 \fB\fIforce security mode\fR = 0 \fR 2351 .sp 2352 Example: 2353 \fB\fIforce security mode\fR = 700 \fR 2354 .RE 2355 .PP 2673 .PP 2674 .RS 4 2675 This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a file using the native NT security dialog box\. 2676 .sp 2677 This parameter is applied as a mask (OR\'ed with) to the changed permission bits, thus forcing any bits in this mask that the user may have modified to be on\. Make sure not to mix up this parameter with 2678 \fIsecurity mask\fR, which works similar like this one but uses logical AND instead of OR\. 2679 .sp 2680 Essentially, one bits in this mask may be treated as a set of bits that, when modifying security on a file, the user has always set to be on\. 2681 .sp 2682 If not set explicitly this parameter is set to 0, and allows a user to modify all the user/group/world permissions on a file, with no restrictions\. 2683 .sp 2684 \fI Note\fR 2685 that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems\. Administrators of most normal systems will probably want to leave this set to 0000\. 2686 .sp 2687 Default: 2688 \fI\fIforce security mode\fR\fR\fI = \fR\fI0\fR\fI \fR 2689 .sp 2690 Example: 2691 \fI\fIforce security mode\fR\fR\fI = \fR\fI700\fR\fI \fR 2692 .RE 2693 2356 2694 force unknown acl user (S) 2357 .RS 3n 2358 If this parameter is set, a Windows NT ACL that contains an unknown SID (security descriptor, or representation of a user or group id) as the owner or group owner of the file will be silently mapped into the current UNIX uid or gid of the currently connected user. 2359 .sp 2360 This is designed to allow Windows NT clients to copy files and folders containing ACLs that were created locally on the client machine and contain users local to that machine only (no domain users) to be copied to a Samba server (usually with XCOPY /O) and have the unknown userid and groupid of the file owner map to the current connected user. This can only be fixed correctly when winbindd allows arbitrary mapping from any Windows NT SID to a UNIX uid or gid. 2361 .sp 2362 Try using this parameter when XCOPY /O gives an ACCESS_DENIED error. 2363 .sp 2364 Default: 2365 \fB\fIforce unknown acl user\fR = no \fR 2366 .RE 2367 .PP 2695 .PP 2696 .RS 4 2697 If this parameter is set, a Windows NT ACL that contains an unknown SID (security descriptor, or representation of a user or group id) as the owner or group owner of the file will be silently mapped into the current UNIX uid or gid of the currently connected user\. 2698 .sp 2699 This is designed to allow Windows NT clients to copy files and folders containing ACLs that were created locally on the client machine and contain users local to that machine only (no domain users) to be copied to a Samba server (usually with XCOPY /O) and have the unknown userid and groupid of the file owner map to the current connected user\. This can only be fixed correctly when winbindd allows arbitrary mapping from any Windows NT SID to a UNIX uid or gid\. 2700 .sp 2701 Try using this parameter when XCOPY /O gives an ACCESS_DENIED error\. 2702 .sp 2703 Default: 2704 \fI\fIforce unknown acl user\fR\fR\fI = \fR\fIno\fR\fI \fR 2705 .RE 2706 2368 2707 force user (S) 2369 .RS 3n 2370 This specifies a UNIX user name that will be assigned as the default user for all users connecting to this service. This is useful for sharing files. You should also use it carefully as using it incorrectly can cause security problems. 2371 .sp 2372 This user name only gets used once a connection is established. Thus clients still need to connect as a valid user and supply a valid password. Once connected, all file operations will be performed as the "forced user", no matter what username the client connected as. This can be very useful. 2373 .sp 2374 In Samba 2.0.5 and above this parameter also causes the primary group of the forced user to be used as the primary group for all file activity. Prior to 2.0.5 the primary group was left as the primary group of the connecting user (this was a bug). 2375 .sp 2376 Default: 2377 \fB\fIforce user\fR = \fR 2378 .sp 2379 Example: 2380 \fB\fIforce user\fR = auser \fR 2381 .RE 2382 .PP 2708 .PP 2709 .RS 4 2710 This specifies a UNIX user name that will be assigned as the default user for all users connecting to this service\. This is useful for sharing files\. You should also use it carefully as using it incorrectly can cause security problems\. 2711 .sp 2712 This user name only gets used once a connection is established\. Thus clients still need to connect as a valid user and supply a valid password\. Once connected, all file operations will be performed as the "forced user", no matter what username the client connected as\. This can be very useful\. 2713 .sp 2714 In Samba 2\.0\.5 and above this parameter also causes the primary group of the forced user to be used as the primary group for all file activity\. Prior to 2\.0\.5 the primary group was left as the primary group of the connecting user (this was a bug)\. 2715 .sp 2716 Default: 2717 \fI\fIforce user\fR\fR\fI = \fR\fI\fR\fI \fR 2718 .sp 2719 Example: 2720 \fI\fIforce user\fR\fR\fI = \fR\fIauser\fR\fI \fR 2721 .RE 2722 2383 2723 fstype (S) 2384 .RS 3n 2724 .PP 2725 .RS 4 2385 2726 This parameter allows the administrator to configure the string that specifies the type of filesystem a share is using that is reported by 2386 2727 \fBsmbd\fR(8) 2387 when a client queries the filesystem type for a share . The default type is2728 when a client queries the filesystem type for a share\. The default type is 2388 2729 \fBNTFS\fR 2389 2730 for compatibility with Windows NT but this can be changed to other strings such as … … 2391 2732 or 2392 2733 \fBFAT\fR 2393 if required .2394 .sp 2395 Default: 2396 \f B\fIfstype\fR = NTFS\fR2397 .sp 2398 Example: 2399 \f B\fIfstype\fR = Samba\fR2400 .RE 2401 .PP 2734 if required\. 2735 .sp 2736 Default: 2737 \fI\fIfstype\fR\fR\fI = \fR\fINTFS\fR\fI \fR 2738 .sp 2739 Example: 2740 \fI\fIfstype\fR\fR\fI = \fR\fISamba\fR\fI \fR 2741 .RE 2742 2402 2743 get quota command (G) 2403 .RS 3n 2744 .PP 2745 .RS 4 2404 2746 The 2405 2747 get quota command 2406 should only be used whenever there is no operating system API available from the OS that samba can use .2748 should only be used whenever there is no operating system API available from the OS that samba can use\. 2407 2749 .sp 2408 2750 This option is only available with 2409 ./configure --with-sys-quotas. Or on linux when2410 ./configure --with-quotas2411 was used and a working quota api was found in the system .2412 .sp 2413 This parameter should specify the path to a script that queries the quota information for the specified user/group for the partition that the specified directory is on .2751 \./configure \-\-with\-sys\-quotas\. Or on linux when 2752 \./configure \-\-with\-quotas 2753 was used and a working quota api was found in the system\. 2754 .sp 2755 This parameter should specify the path to a script that queries the quota information for the specified user/group for the partition that the specified directory is on\. 2414 2756 .sp 2415 2757 Such a script should take 3 arguments: 2416 .RS 3n 2417 .TP 3n 2418 \(bu 2758 .sp 2759 .RS 4 2760 .ie n \{\ 2761 \h'-04'\(bu\h'+03'\c 2762 .\} 2763 .el \{\ 2764 .sp -1 2765 .IP \(bu 2.3 2766 .\} 2419 2767 directory 2420 .TP 3n 2421 \(bu 2768 .RE 2769 .sp 2770 .RS 4 2771 .ie n \{\ 2772 \h'-04'\(bu\h'+03'\c 2773 .\} 2774 .el \{\ 2775 .sp -1 2776 .IP \(bu 2.3 2777 .\} 2422 2778 type of query 2423 .TP 3n 2424 \(bu 2779 .RE 2780 .sp 2781 .RS 4 2782 .ie n \{\ 2783 \h'-04'\(bu\h'+03'\c 2784 .\} 2785 .el \{\ 2786 .sp -1 2787 .IP \(bu 2.3 2788 .\} 2425 2789 uid of user or gid of group 2426 . RE2427 . IP "" 3n2790 .sp 2791 .RE 2428 2792 The type of query can be one of : 2429 .RS 3n 2430 .TP 3n 2431 \(bu 2432 1 - user quotas 2433 .TP 3n 2434 \(bu 2435 2 - user default quotas (uid = -1) 2436 .TP 3n 2437 \(bu 2438 3 - group quotas 2439 .TP 3n 2440 \(bu 2441 4 - group default quotas (gid = -1) 2442 .RE 2443 .IP "" 3n 2444 This script should print one line as output with spaces between the arguments. The arguments are: 2445 .RS 3n 2446 .TP 3n 2447 \(bu 2448 Arg 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced) 2449 .TP 3n 2450 \(bu 2451 Arg 2 - number of currently used blocks 2452 .TP 3n 2453 \(bu 2454 Arg 3 - the softlimit number of blocks 2455 .TP 3n 2456 \(bu 2457 Arg 4 - the hardlimit number of blocks 2458 .TP 3n 2459 \(bu 2460 Arg 5 - currently used number of inodes 2461 .TP 3n 2462 \(bu 2463 Arg 6 - the softlimit number of inodes 2464 .TP 3n 2465 \(bu 2466 Arg 7 - the hardlimit number of inodes 2467 .TP 3n 2468 \(bu 2469 Arg 8(optional) - the number of bytes in a block(default is 1024) 2470 .RE 2471 .IP "" 3n 2472 Default: 2473 \fB\fIget quota command\fR = \fR 2474 .sp 2475 Example: 2476 \fB\fIget quota command\fR = /usr/local/sbin/query_quota \fR 2477 .RE 2478 .PP 2793 .sp 2794 .RS 4 2795 .ie n \{\ 2796 \h'-04'\(bu\h'+03'\c 2797 .\} 2798 .el \{\ 2799 .sp -1 2800 .IP \(bu 2.3 2801 .\} 2802 1 \- user quotas 2803 .RE 2804 .sp 2805 .RS 4 2806 .ie n \{\ 2807 \h'-04'\(bu\h'+03'\c 2808 .\} 2809 .el \{\ 2810 .sp -1 2811 .IP \(bu 2.3 2812 .\} 2813 2 \- user default quotas (uid = \-1) 2814 .RE 2815 .sp 2816 .RS 4 2817 .ie n \{\ 2818 \h'-04'\(bu\h'+03'\c 2819 .\} 2820 .el \{\ 2821 .sp -1 2822 .IP \(bu 2.3 2823 .\} 2824 3 \- group quotas 2825 .RE 2826 .sp 2827 .RS 4 2828 .ie n \{\ 2829 \h'-04'\(bu\h'+03'\c 2830 .\} 2831 .el \{\ 2832 .sp -1 2833 .IP \(bu 2.3 2834 .\} 2835 4 \- group default quotas (gid = \-1) 2836 .sp 2837 .RE 2838 This script should print one line as output with spaces between the arguments\. The arguments are: 2839 .sp 2840 .RS 4 2841 .ie n \{\ 2842 \h'-04'\(bu\h'+03'\c 2843 .\} 2844 .el \{\ 2845 .sp -1 2846 .IP \(bu 2.3 2847 .\} 2848 Arg 1 \- quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced) 2849 .RE 2850 .sp 2851 .RS 4 2852 .ie n \{\ 2853 \h'-04'\(bu\h'+03'\c 2854 .\} 2855 .el \{\ 2856 .sp -1 2857 .IP \(bu 2.3 2858 .\} 2859 Arg 2 \- number of currently used blocks 2860 .RE 2861 .sp 2862 .RS 4 2863 .ie n \{\ 2864 \h'-04'\(bu\h'+03'\c 2865 .\} 2866 .el \{\ 2867 .sp -1 2868 .IP \(bu 2.3 2869 .\} 2870 Arg 3 \- the softlimit number of blocks 2871 .RE 2872 .sp 2873 .RS 4 2874 .ie n \{\ 2875 \h'-04'\(bu\h'+03'\c 2876 .\} 2877 .el \{\ 2878 .sp -1 2879 .IP \(bu 2.3 2880 .\} 2881 Arg 4 \- the hardlimit number of blocks 2882 .RE 2883 .sp 2884 .RS 4 2885 .ie n \{\ 2886 \h'-04'\(bu\h'+03'\c 2887 .\} 2888 .el \{\ 2889 .sp -1 2890 .IP \(bu 2.3 2891 .\} 2892 Arg 5 \- currently used number of inodes 2893 .RE 2894 .sp 2895 .RS 4 2896 .ie n \{\ 2897 \h'-04'\(bu\h'+03'\c 2898 .\} 2899 .el \{\ 2900 .sp -1 2901 .IP \(bu 2.3 2902 .\} 2903 Arg 6 \- the softlimit number of inodes 2904 .RE 2905 .sp 2906 .RS 4 2907 .ie n \{\ 2908 \h'-04'\(bu\h'+03'\c 2909 .\} 2910 .el \{\ 2911 .sp -1 2912 .IP \(bu 2.3 2913 .\} 2914 Arg 7 \- the hardlimit number of inodes 2915 .RE 2916 .sp 2917 .RS 4 2918 .ie n \{\ 2919 \h'-04'\(bu\h'+03'\c 2920 .\} 2921 .el \{\ 2922 .sp -1 2923 .IP \(bu 2.3 2924 .\} 2925 Arg 8(optional) \- the number of bytes in a block(default is 1024) 2926 .sp 2927 .RE 2928 Default: 2929 \fI\fIget quota command\fR\fR\fI = \fR\fI\fR\fI \fR 2930 .sp 2931 Example: 2932 \fI\fIget quota command\fR\fR\fI = \fR\fI/usr/local/sbin/query_quota\fR\fI \fR 2933 .RE 2934 2479 2935 getwd cache (G) 2480 .RS 3n 2481 This is a tuning option. When this is enabled a caching algorithm will be used to reduce the time taken for getwd() calls. This can have a significant impact on performance, especially when the 2482 wide smbconfoptions parameter is set to 2483 \fBno\fR. 2484 .sp 2485 Default: 2486 \fB\fIgetwd cache\fR = yes \fR 2487 .RE 2488 .PP 2936 .PP 2937 .RS 4 2938 This is a tuning option\. When this is enabled a caching algorithm will be used to reduce the time taken for getwd() calls\. This can have a significant impact on performance, especially when the 2939 \fIwide smbconfoptions\fR 2940 parameter is set to 2941 \fBno\fR\. 2942 .sp 2943 Default: 2944 \fI\fIgetwd cache\fR\fR\fI = \fR\fIyes\fR\fI \fR 2945 .RE 2946 2489 2947 guest account (G) 2490 .RS 3n 2948 .PP 2949 .RS 4 2491 2950 This is a username which will be used for access to services which are specified as 2492 guest ok (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. 2493 .sp 2494 On some systems the default guest account "nobody" may not be able to print. Use another account in this case. You should test this by trying to log in as your guest user (perhaps by using the 2495 su - 2951 \fIguest ok\fR 2952 (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\. 2953 .sp 2954 On some systems the default guest account "nobody" may not be able to print\. Use another account in this case\. You should test this by trying to log in as your guest user (perhaps by using the 2955 su \- 2496 2956 command) and trying to print using the system print command such as 2497 2957 lpr(1) 2498 2958 or 2499 lp(1) .2500 .sp 2501 This parameter does not accept % macros, because many parts of the system require this value to be constant for correct operation .2502 .sp 2503 Default: 2504 \f B\fIguest account\fR = nobody # default can be changed at compile-time\fR2505 .sp 2506 Example: 2507 \f B\fIguest account\fR = ftp\fR2508 .RE 2509 .PP2510 public 2511 .RS 3n 2512 This parameter is a synonym for guest ok.2513 .RE 2514 .PP 2959 lp(1)\. 2960 .sp 2961 This parameter does not accept % macros, because many parts of the system require this value to be constant for correct operation\. 2962 .sp 2963 Default: 2964 \fI\fIguest account\fR\fR\fI = \fR\fInobody # default can be changed at compile\-time\fR\fI \fR 2965 .sp 2966 Example: 2967 \fI\fIguest account\fR\fR\fI = \fR\fIftp\fR\fI \fR 2968 .RE 2969 public.PP 2970 .RS 4 2971 This parameter is a synonym for 2972 guest ok\. 2973 .RE 2974 2515 2975 guest ok (S) 2516 .RS 3n 2976 .PP 2977 .RS 4 2517 2978 If this parameter is 2518 2979 \fByes\fR 2519 for a service, then no password is required to connect to the service . Privileges will be those of the2520 guest account.2980 for a service, then no password is required to connect to the service\. Privileges will be those of the 2981 \fIguest account\fR\. 2521 2982 .sp 2522 2983 This paramater nullifies the benifits of setting 2523 restrict anonymous = 2 2984 \fIrestrict anonymous = 2\fR 2524 2985 .sp 2525 2986 See the section below on 2526 security for more information about this option. 2527 .sp 2528 Default: 2529 \fB\fIguest ok\fR = no \fR 2530 .RE 2531 .PP 2532 only guest 2533 .RS 3n 2534 This parameter is a synonym for guest only. 2535 .RE 2536 .PP 2987 \fIsecurity\fR 2988 for more information about this option\. 2989 .sp 2990 Default: 2991 \fI\fIguest ok\fR\fR\fI = \fR\fIno\fR\fI \fR 2992 .RE 2993 only guest.PP 2994 .RS 4 2995 This parameter is a synonym for 2996 guest only\. 2997 .RE 2998 2537 2999 guest only (S) 2538 .RS 3n 3000 .PP 3001 .RS 4 2539 3002 If this parameter is 2540 3003 \fByes\fR 2541 for a service, then only guest connections to the service are permitted. This parameter will have no effect if 2542 guest ok is not set for the service. 3004 for a service, then only guest connections to the service are permitted\. This parameter will have no effect if 3005 \fIguest ok\fR 3006 is not set for the service\. 2543 3007 .sp 2544 3008 See the section below on 2545 security for more information about this option. 2546 .sp 2547 Default: 2548 \fB\fIguest only\fR = no \fR 2549 .RE 2550 .PP 3009 \fIsecurity\fR 3010 for more information about this option\. 3011 .sp 3012 Default: 3013 \fI\fIguest only\fR\fR\fI = \fR\fIno\fR\fI \fR 3014 .RE 3015 2551 3016 hide dot files (S) 2552 .RS 3n 2553 This is a boolean parameter that controls whether files starting with a dot appear as hidden files. 2554 .sp 2555 Default: 2556 \fB\fIhide dot files\fR = yes \fR 2557 .RE 2558 .PP 3017 .PP 3018 .RS 4 3019 This is a boolean parameter that controls whether files starting with a dot appear as hidden files\. 3020 .sp 3021 Default: 3022 \fI\fIhide dot files\fR\fR\fI = \fR\fIyes\fR\fI \fR 3023 .RE 3024 2559 3025 hide files (S) 2560 .RS 3n 2561 This is a list of files or directories that are not visible but are accessible. The DOS 'hidden' attribute is applied to any files or directories that match. 2562 .sp 2563 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. 2564 .sp 2565 Each entry must be a Unix path, not a DOS path and must not include the Unix directory separator '/'. 2566 .sp 2567 Note that the case sensitivity option is applicable in hiding files. 2568 .sp 2569 Setting this parameter will affect the performance of Samba, as it will be forced to check all files and directories for a match as they are scanned. 3026 .PP 3027 .RS 4 3028 This is a list of files or directories that are not visible but are accessible\. The DOS \'hidden\' attribute is applied to any files or directories that match\. 3029 .sp 3030 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\. 3031 .sp 3032 Each entry must be a Unix path, not a DOS path and must not include the Unix directory separator \'/\'\. 3033 .sp 3034 Note that the case sensitivity option is applicable in hiding files\. 3035 .sp 3036 Setting this parameter will affect the performance of Samba, as it will be forced to check all files and directories for a match as they are scanned\. 2570 3037 .sp 2571 3038 The example shown above is based on files that the Macintosh SMB client (DAVE) available from 2572 3039 Thursby 2573 creates for internal use, and also still hides all files beginning with a dot .3040 creates for internal use, and also still hides all files beginning with a dot\. 2574 3041 .sp 2575 3042 An example of us of this parameter is: 2576 2577 .sp 2578 3043 .sp 3044 .RS 4 2579 3045 .nf 2580 2581 hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/ 2582 3046 hide files = /\.*/DesktopFolderDB/TrashFor%m/resource\.frk/ 2583 3047 .fi 2584 2585 .sp 2586 Default: 2587 \fB\fIhide files\fR = # no file are hidden \fR 2588 .RE 2589 .PP 3048 .RE 3049 .sp 3050 .sp 3051 Default: 3052 \fI\fIhide files\fR\fR\fI = \fR\fI # no file are hidden\fR\fI \fR 3053 .RE 3054 2590 3055 hide special files (S) 2591 .RS 3n 2592 This parameter prevents clients from seeing special files such as sockets, devices and fifo's in directory listings. 2593 .sp 2594 Default: 2595 \fB\fIhide special files\fR = no \fR 2596 .RE 2597 .PP 3056 .PP 3057 .RS 4 3058 This parameter prevents clients from seeing special files such as sockets, devices and fifo\'s in directory listings\. 3059 .sp 3060 Default: 3061 \fI\fIhide special files\fR\fR\fI = \fR\fIno\fR\fI \fR 3062 .RE 3063 2598 3064 hide unreadable (S) 2599 .RS 3n 2600 This parameter prevents clients from seeing the existance of files that cannot be read. Defaults to off. 2601 .sp 2602 Default: 2603 \fB\fIhide unreadable\fR = no \fR 2604 .RE 2605 .PP 3065 .PP 3066 .RS 4 3067 This parameter prevents clients from seeing the existance of files that cannot be read\. Defaults to off\. 3068 .sp 3069 Default: 3070 \fI\fIhide unreadable\fR\fR\fI = \fR\fIno\fR\fI \fR 3071 .RE 3072 2606 3073 hide unwriteable files (S) 2607 .RS 3n 2608 This parameter prevents clients from seeing the existance of files that cannot be written to. Defaults to off. Note that unwriteable directories are shown as usual. 2609 .sp 2610 Default: 2611 \fB\fIhide unwriteable files\fR = no \fR 2612 .RE 2613 .PP 3074 .PP 3075 .RS 4 3076 This parameter prevents clients from seeing the existance of files that cannot be written to\. Defaults to off\. Note that unwriteable directories are shown as usual\. 3077 .sp 3078 Default: 3079 \fI\fIhide unwriteable files\fR\fR\fI = \fR\fIno\fR\fI \fR 3080 .RE 3081 2614 3082 homedir map (G) 2615 .RS 3n 3083 .PP 3084 .RS 4 2616 3085 If 2617 nis homedir is 3086 \fInis homedir\fR 3087 is 2618 3088 \fByes\fR, and 2619 3089 \fBsmbd\fR(8) 2620 3090 is also acting as a Win95/98 2621 3091 \fIlogon server\fR 2622 then this parameter specifies the NIS (or YP) map from which the server for the user's home directory should be extracted. At present, only the Sun auto.home map format is understood. The form of the map is: 2623 2624 .sp 2625 3092 then this parameter specifies the NIS (or YP) map from which the server for the user\'s home directory should be extracted\. At present, only the Sun auto\.home map format is understood\. The form of the map is: 3093 .sp 3094 .RS 4 2626 3095 .nf 2627 2628 3096 username server:/some/file/system 2629 2630 3097 .fi 2631 and the program will extract the servername from before the first ':'. There should probably be a better parsing system that copes with different map formats and also Amd (another automounter) maps. 3098 .RE 3099 .sp 3100 and the program will extract the servername from before the first \':\'\. There should probably be a better parsing system that copes with different map formats and also Amd (another automounter) maps\. 2632 3101 .sp 2633 3102 .it 1 an-trap … … 2635 3104 .nr an-break-flag 1 2636 3105 .br 2637 \fBNote\fR 2638 A working NIS client is required on the system for this option to work. 2639 Default: 2640 \fB\fIhomedir map\fR = \fR 2641 .sp 2642 Example: 2643 \fB\fIhomedir map\fR = amd.homedir \fR 2644 .RE 2645 .PP 3106 Note 3107 A working NIS client is required on the system for this option to work\. 3108 3109 Default: 3110 \fI\fIhomedir map\fR\fR\fI = \fR\fI\fR\fI \fR 3111 .sp 3112 Example: 3113 \fI\fIhomedir map\fR\fR\fI = \fR\fIamd\.homedir\fR\fI \fR 3114 .RE 3115 2646 3116 host msdfs (G) 2647 .RS 3n 3117 .PP 3118 .RS 4 2648 3119 If set to 2649 \fByes\fR, Samba will act as a Dfs server, and allow Dfs -aware clients to browse Dfs trees hosted on the server.3120 \fByes\fR, Samba will act as a Dfs server, and allow Dfs\-aware clients to browse Dfs trees hosted on the server\. 2650 3121 .sp 2651 3122 See also the 2652 msdfs root share level parameter. For more information on setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3-HOWTO. 2653 .sp 2654 Default: 2655 \fB\fIhost msdfs\fR = yes \fR 2656 .RE 2657 .PP 3123 \fImsdfs root\fR 3124 share level parameter\. For more information on setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3\-HOWTO\. 3125 .sp 3126 Default: 3127 \fI\fIhost msdfs\fR\fR\fI = \fR\fIyes\fR\fI \fR 3128 .RE 3129 2658 3130 hostname lookups (G) 2659 .RS 3n 2660 Specifies whether samba should use (expensive) hostname lookups or use the ip addresses instead. An example place where hostname lookups are currently used is when checking the 3131 .PP 3132 .RS 4 3133 Specifies whether samba should use (expensive) hostname lookups or use the ip addresses instead\. An example place where hostname lookups are currently used is when checking the 2661 3134 hosts deny 2662 3135 and 2663 hosts allow .2664 .sp 2665 Default: 2666 \f B\fIhostname lookups\fR = no\fR2667 .sp 2668 Example: 2669 \f B\fIhostname lookups\fR = yes\fR2670 .RE 2671 .PP2672 allow hosts 2673 .RS 3n 2674 This parameter is a synonym for hosts allow.2675 .RE 2676 .PP 3136 hosts allow\. 3137 .sp 3138 Default: 3139 \fI\fIhostname lookups\fR\fR\fI = \fR\fIno\fR\fI \fR 3140 .sp 3141 Example: 3142 \fI\fIhostname lookups\fR\fR\fI = \fR\fIyes\fR\fI \fR 3143 .RE 3144 allow hosts.PP 3145 .RS 4 3146 This parameter is a synonym for 3147 hosts allow\. 3148 .RE 3149 2677 3150 hosts allow (S) 2678 .RS 3n 3151 .PP 3152 .RS 4 2679 3153 A synonym for this parameter is 2680 allow hosts. 2681 .sp 2682 This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service. 2683 .sp 2684 If specified in the [global] section then it will apply to all services, regardless of whether the individual service has a different setting. 2685 .sp 2686 You can specify the hosts by name or IP number. For example, you could restrict access to only the hosts on a Class C subnet with something like 2687 allow hosts = 150.203.5.. The full syntax of the list is described in the man page 2688 \fIhosts_access(5)\fR. Note that this man page may not be present on your system, so a brief description will be given here also. 2689 .sp 2690 Note that the localhost address 127.0.0.1 will always be allowed access unless specifically denied by a 2691 hosts deny option. 2692 .sp 2693 You can also specify hosts by network/netmask pairs and by netgroup names if your system supports netgroups. The 2694 \fBEXCEPT\fR 2695 keyword can also be used to limit a wildcard list. The following examples may provide some help: 2696 .sp 2697 Example 1: allow all IPs in 150.203.*.*; except one 2698 .sp 2699 hosts allow = 150.203. EXCEPT 150.203.6.66 3154 \fIallow hosts\fR\. 3155 .sp 3156 This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service\. 3157 .sp 3158 If specified in the [global] section then it will apply to all services, regardless of whether the individual service has a different setting\. 3159 .sp 3160 You can specify the hosts by name or IP number\. For example, you could restrict access to only the hosts on a Class C subnet with something like 3161 allow hosts = 150\.203\.5\.\. The full syntax of the list is described in the man page 3162 \fIhosts_access(5)\fR\. Note that this man page may not be present on your system, so a brief description will be given here also\. 3163 .sp 3164 Note that the localhost address 127\.0\.0\.1 will always be allowed access unless specifically denied by a 3165 \fIhosts deny\fR 3166 option\. 3167 .sp 3168 You can also specify hosts by network/netmask pairs and by netgroup names if your system supports netgroups\. The 3169 \fIEXCEPT\fR 3170 keyword can also be used to limit a wildcard list\. The following examples may provide some help: 3171 .sp 3172 Example 1: allow all IPs in 150\.203\.*\.*; except one 3173 .sp 3174 hosts allow = 150\.203\. EXCEPT 150\.203\.6\.66 2700 3175 .sp 2701 3176 Example 2: allow hosts that match the given network/netmask 2702 3177 .sp 2703 hosts allow = 150 .203.15.0/255.255.255.03178 hosts allow = 150\.203\.15\.0/255\.255\.255\.0 2704 3179 .sp 2705 3180 Example 3: allow a couple of hosts … … 2717 3192 .nr an-break-flag 1 2718 3193 .br 2719 \fBNote\fR 2720 Note that access still requires suitable user-level passwords. 3194 Note 3195 Note that access still requires suitable user\-level passwords\. 3196 2721 3197 See 2722 3198 \fBtestparm\fR(1) 2723 for a way of testing your host access to see if it does what you expect .2724 .sp 2725 Default: 2726 \f B\fIhosts allow\fR = # none (i.e., all hosts permitted access)\fR2727 .sp 2728 Example: 2729 \f B\fIhosts allow\fR = 150.203.5. myhost.mynet.edu.au\fR2730 .RE 2731 .PP2732 deny hosts 2733 .RS 3n 2734 This parameter is a synonym for hosts deny.2735 .RE 2736 .PP 3199 for a way of testing your host access to see if it does what you expect\. 3200 .sp 3201 Default: 3202 \fI\fIhosts allow\fR\fR\fI = \fR\fI # none (i\.e\., all hosts permitted access)\fR\fI \fR 3203 .sp 3204 Example: 3205 \fI\fIhosts allow\fR\fR\fI = \fR\fI150\.203\.5\. myhost\.mynet\.edu\.au\fR\fI \fR 3206 .RE 3207 deny hosts.PP 3208 .RS 4 3209 This parameter is a synonym for 3210 hosts deny\. 3211 .RE 3212 2737 3213 hosts deny (S) 2738 .RS 3n 3214 .PP 3215 .RS 4 2739 3216 The opposite of 2740 3217 \fIhosts allow\fR 2741 - hosts listed here are2742 \f BNOT\fR2743 permitted access to services unless the specific services have their own lists to override this one . Where the lists conflict, the3218 \- hosts listed here are 3219 \fINOT\fR 3220 permitted access to services unless the specific services have their own lists to override this one\. Where the lists conflict, the 2744 3221 \fIallow\fR 2745 list takes precedence .3222 list takes precedence\. 2746 3223 .sp 2747 3224 In the event that it is necessary to deny all by default, use the keyword ALL (or the netmask 2748 0.0.0.0/0) and then explicitly specify to the 2749 hosts allow = hosts allow parameter those hosts that should be permitted access. 2750 .sp 2751 Default: 2752 \fB\fIhosts deny\fR = # none (i.e., no hosts specifically excluded) \fR 2753 .sp 2754 Example: 2755 \fB\fIhosts deny\fR = 150.203.4. badhost.mynet.edu.au \fR 2756 .RE 2757 .PP 3225 0\.0\.0\.0/0) and then explicitly specify to the 3226 \fIhosts allow = hosts allow\fR 3227 parameter those hosts that should be permitted access\. 3228 .sp 3229 Default: 3230 \fI\fIhosts deny\fR\fR\fI = \fR\fI # none (i\.e\., no hosts specifically excluded)\fR\fI \fR 3231 .sp 3232 Example: 3233 \fI\fIhosts deny\fR\fR\fI = \fR\fI150\.203\.4\. badhost\.mynet\.edu\.au\fR\fI \fR 3234 .RE 3235 2758 3236 idmap alloc backend (G) 2759 .RS 3n 2760 The idmap alloc backend provides a plugin interface for Winbind to use when allocating Unix uids/gids for Windows SIDs. This option is to be used in conjunction with the 2761 idmap domains parameter and refers to the name of the idmap module which will provide the id allocation functionality. Please refer to the man page for each idmap plugin to determine whether or not the module implements the allocation feature. The most common plugins are the tdb (\fBidmap_tdb\fR(8)) and ldap (\fBidmap_ldap\fR(8)) libraries. 3237 .PP 3238 .RS 4 3239 The idmap alloc backend provides a plugin interface for Winbind to use when allocating Unix uids/gids for Windows SIDs\. This option is to be used in conjunction with the 3240 \fIidmap domains\fR 3241 parameter and refers to the name of the idmap module which will provide the id allocation functionality\. Please refer to the man page for each idmap plugin to determine whether or not the module implements the allocation feature\. The most common plugins are the tdb (\fBidmap_tdb\fR(8)) and ldap (\fBidmap_ldap\fR(8)) libraries\. 2762 3242 .sp 2763 3243 Also refer to the 2764 idmap alloc config option. 2765 .sp 2766 \fBNo default\fR 2767 .sp 2768 Example: 2769 \fB\fIidmap alloc backend\fR = tdb \fR 2770 .RE 2771 .PP 3244 \fIidmap alloc config\fR 3245 option\. 3246 .sp 3247 \fINo default\fR 3248 .sp 3249 Example: 3250 \fI\fIidmap alloc backend\fR\fR\fI = \fR\fItdb\fR\fI \fR 3251 .RE 3252 2772 3253 idmap alloc config (G) 2773 .RS 3n 3254 .PP 3255 .RS 4 2774 3256 The idmap alloc config prefix provides a means of managing settings for the backend defined by the 2775 idmap alloc backend parameter. Refer to the man page for each idmap plugin regarding specific configuration details. 2776 .sp 2777 \fBNo default\fR 2778 .RE 2779 .PP 3257 \fIidmap alloc backend\fR 3258 parameter\. Refer to the man page for each idmap plugin regarding specific configuration details\. 3259 .sp 3260 \fINo default\fR 3261 .RE 3262 2780 3263 idmap backend (G) 2781 .RS 3n 2782 The idmap backend provides a plugin interface for Winbind to use varying backends to store SID/uid/gid mapping tables. This option is mutually exclusive with the newer and more flexible 2783 idmap domains parameter. The main difference between the "idmap backend" and the "idmap domains" is that the former only allows on backend for all domains while the latter supports configuring backends on a per domain basis. 2784 .sp 2785 Examples of SID/uid/gid backends include tdb (\fBidmap_tdb\fR(8)), ldap (\fBidmap_ldap\fR(8)), rid (\fBidmap_rid\fR(8)), and ad (\fBidmap_tdb\fR(8)). 2786 .sp 2787 Default: 2788 \fB\fIidmap backend\fR = tdb \fR 2789 .RE 2790 .PP 3264 .PP 3265 .RS 4 3266 The idmap backend provides a plugin interface for Winbind to use varying backends to store SID/uid/gid mapping tables\. This option is mutually exclusive with the newer and more flexible 3267 \fIidmap domains\fR 3268 parameter\. The main difference between the "idmap backend" and the "idmap domains" is that the former only allows on backend for all domains while the latter supports configuring backends on a per domain basis\. 3269 .sp 3270 Examples of SID/uid/gid backends include tdb (\fBidmap_tdb\fR(8)), ldap (\fBidmap_ldap\fR(8)), rid (\fBidmap_rid\fR(8)), and ad (\fBidmap_tdb\fR(8))\. 3271 .sp 3272 Default: 3273 \fI\fIidmap backend\fR\fR\fI = \fR\fItdb\fR\fI \fR 3274 .RE 3275 2791 3276 idmap cache time (G) 2792 .RS 3n 2793 This parameter specifies the number of seconds that Winbind's idmap interface will cache positive SID/uid/gid query results. 2794 .sp 2795 Default: 2796 \fB\fIidmap cache time\fR = 900 \fR 2797 .RE 2798 .PP 3277 .PP 3278 .RS 4 3279 This parameter specifies the number of seconds that Winbind\'s idmap interface will cache positive SID/uid/gid query results\. 3280 .sp 3281 Default: 3282 \fI\fIidmap cache time\fR\fR\fI = \fR\fI900\fR\fI \fR 3283 .RE 3284 2799 3285 idmap config (G) 2800 .RS 3n 3286 .PP 3287 .RS 4 2801 3288 The idmap config prefix provides a means of managing each domain defined by the 2802 idmap domains option using Samba's parameteric option support. The idmap config prefix should be followed by the name of the domain, a colon, and a setting specific to the chosen backend. There are three options available for all domains: 2803 2804 .RS 3n 3289 \fIidmap domains\fR 3290 option using Samba\'s parameteric option support\. The idmap config prefix should be followed by the name of the domain, a colon, and a setting specific to the chosen backend\. There are three options available for all domains: 2805 3291 .PP 2806 3292 backend = backend_name 2807 .RS 3n2808 Specifies the name of the idmap plugin to use as the SID/uid/gid backend for this domain .3293 .RS 4 3294 Specifies the name of the idmap plugin to use as the SID/uid/gid backend for this domain\. 2809 3295 .RE 2810 3296 .PP 2811 3297 default = [yes|no] 2812 .RS 3n2813 The default domain/backend will be used for searching for users and groups not belonging to one of the explicitly listed domains (matched by comparing the account SID and the domain SID) .3298 .RS 4 3299 The default domain/backend will be used for searching for users and groups not belonging to one of the explicitly listed domains (matched by comparing the account SID and the domain SID)\. 2814 3300 .RE 2815 3301 .PP 2816 3302 readonly = [yes|no] 2817 .RS 3n3303 .RS 4 2818 3304 Mark the domain as readonly which means that no attempts to allocate a uid or gid (by the 2819 idmap alloc backend) for any user or group in that domain will be attempted. 2820 .RE 2821 .RE 2822 .IP "" 3n 3305 \fIidmap alloc backend\fR) for any user or group in that domain will be attempted\. 3306 .RE 3307 .sp 2823 3308 The following example illustrates how to configure the 2824 3309 \fBidmap_ad\fR(8) 2825 3310 for the CORP domain and the 2826 3311 \fBidmap_tdb\fR(8) 2827 backend for all other domains. The TRUSTEDDOMAINS string is simply a key used to reference the "idmap config" settings and does not represent the actual name of a domain. 2828 3312 backend for all other domains\. The TRUSTEDDOMAINS string is simply a key used to reference the "idmap config" settings and does not represent the actual name of a domain\. 3313 .sp 3314 .RS 4 2829 3315 .nf 2830 2831 3316 idmap domains = CORP TRUSTEDDOMAINS 2832 3317 … … 2836 3321 idmap config TRUSTEDDOMAINS:backend = tdb 2837 3322 idmap config TRUSTEDDOMAINS:default = yes 2838 idmap config TRUSTEDDOMAINS:range = 1000 - 99993323 idmap config TRUSTEDDOMAINS:range = 1000 \- 9999 2839 3324 2840 3325 .fi 2841 \fBNo default\fR 2842 .RE 2843 .PP 3326 .RE 3327 \fINo default\fR 3328 .RE 3329 2844 3330 idmap domains (G) 2845 .RS 3n 2846 The idmap domains option defines a list of Windows domains which will each have a separately configured backend for managing Winbind's SID/uid/gid tables. This parameter is mutually exclusive with the older 2847 idmap backend option. 2848 .sp 2849 Values consist of the short domain name for Winbind's primary or collection of trusted domains. You may also use an arbitrary string to represent a catchall domain backend for any domain not explicitly listed. 3331 .PP 3332 .RS 4 3333 The idmap domains option defines a list of Windows domains which will each have a separately configured backend for managing Winbind\'s SID/uid/gid tables\. This parameter is mutually exclusive with the older 3334 \fIidmap backend\fR 3335 option\. 3336 .sp 3337 Values consist of the short domain name for Winbind\'s primary or collection of trusted domains\. You may also use an arbitrary string to represent a catchall domain backend for any domain not explicitly listed\. 2850 3338 .sp 2851 3339 Refer to the 2852 idmap config for details about managing the SID/uid/gid backend for each domain. 2853 .sp 2854 \fBNo default\fR 2855 .sp 2856 Example: 2857 \fB\fIidmap domains\fR = default AD CORP \fR 2858 .RE 2859 .PP 2860 winbind gid 2861 .RS 3n 2862 This parameter is a synonym for idmap gid. 2863 .RE 2864 .PP 3340 \fIidmap config\fR 3341 for details about managing the SID/uid/gid backend for each domain\. 3342 .sp 3343 \fINo default\fR 3344 .sp 3345 Example: 3346 \fI\fIidmap domains\fR\fR\fI = \fR\fIdefault AD CORP\fR\fI \fR 3347 .RE 3348 winbind gid.PP 3349 .RS 4 3350 This parameter is a synonym for 3351 idmap gid\. 3352 .RE 3353 2865 3354 idmap gid (G) 2866 .RS 3n 2867 The idmap gid parameter specifies the range of group ids that are allocated for the purpose of mapping UNX groups to NT group SIDs. This range of group ids should have no existing local or NIS groups within it as strange conflicts can occur otherwise. 3355 .PP 3356 .RS 4 3357 The idmap gid parameter specifies the range of group ids that are allocated for the purpose of mapping UNX groups to NT group SIDs\. This range of group ids should have no existing local or NIS groups within it as strange conflicts can occur otherwise\. 2868 3358 .sp 2869 3359 See also the 2870 idmap backend, 2871 idmap domains, and 2872 idmap config options. 2873 .sp 2874 Default: 2875 \fB\fIidmap gid\fR = \fR 2876 .sp 2877 Example: 2878 \fB\fIidmap gid\fR = 10000-20000 \fR 2879 .RE 2880 .PP 3360 \fIidmap backend\fR, 3361 \fIidmap domains\fR, and 3362 \fIidmap config\fR 3363 options\. 3364 .sp 3365 Default: 3366 \fI\fIidmap gid\fR\fR\fI = \fR\fI\fR\fI \fR 3367 .sp 3368 Example: 3369 \fI\fIidmap gid\fR\fR\fI = \fR\fI10000\-20000\fR\fI \fR 3370 .RE 3371 2881 3372 idmap negative cache time (G) 2882 .RS 3n 2883 This parameter specifies the number of seconds that Winbind's idmap interface will cache negative SID/uid/gid query results. 2884 .sp 2885 Default: 2886 \fB\fIidmap negative cache time\fR = 120 \fR 2887 .RE 2888 .PP 2889 winbind uid 2890 .RS 3n 2891 This parameter is a synonym for idmap uid. 2892 .RE 2893 .PP 3373 .PP 3374 .RS 4 3375 This parameter specifies the number of seconds that Winbind\'s idmap interface will cache negative SID/uid/gid query results\. 3376 .sp 3377 Default: 3378 \fI\fIidmap negative cache time\fR\fR\fI = \fR\fI120\fR\fI \fR 3379 .RE 3380 winbind uid.PP 3381 .RS 4 3382 This parameter is a synonym for 3383 idmap uid\. 3384 .RE 3385 2894 3386 idmap uid (G) 2895 .RS 3n 2896 The idmap uid parameter specifies the range of user ids that are allocated for use in mapping UNIX users to NT user SIDs. This range of ids should have no existing local or NIS users within it as strange conflicts can occur otherwise. 3387 .PP 3388 .RS 4 3389 The idmap uid parameter specifies the range of user ids that are allocated for use in mapping UNIX users to NT user SIDs\. This range of ids should have no existing local or NIS users within it as strange conflicts can occur otherwise\. 2897 3390 .sp 2898 3391 See also the 2899 idmap backend, 2900 idmap domains, and 2901 idmap config options. 2902 .sp 2903 Default: 2904 \fB\fIidmap uid\fR = \fR 2905 .sp 2906 Example: 2907 \fB\fIidmap uid\fR = 10000-20000 \fR 2908 .RE 2909 .PP 3392 \fIidmap backend\fR, 3393 \fIidmap domains\fR, and 3394 \fIidmap config\fR 3395 options\. 3396 .sp 3397 Default: 3398 \fI\fIidmap uid\fR\fR\fI = \fR\fI\fR\fI \fR 3399 .sp 3400 Example: 3401 \fI\fIidmap uid\fR\fR\fI = \fR\fI10000\-20000\fR\fI \fR 3402 .RE 3403 2910 3404 include (G) 2911 .RS 3n 2912 This allows you to include one config file inside another. The file is included literally, as though typed in place. 3405 .PP 3406 .RS 4 3407 This allows you to include one config file inside another\. The file is included literally, as though typed in place\. 2913 3408 .sp 2914 3409 It takes the standard substitutions, except … … 2916 3411 \fI%P\fR 2917 3412 and 2918 \fI%S\fR .2919 .sp 2920 Default: 2921 \f B\fIinclude\fR =\fR2922 .sp 2923 Example: 2924 \f B\fIinclude\fR = /usr/local/samba/lib/admin_smb.conf\fR2925 .RE 2926 .PP 3413 \fI%S\fR\. 3414 .sp 3415 Default: 3416 \fI\fIinclude\fR\fR\fI = \fR\fI\fR\fI \fR 3417 .sp 3418 Example: 3419 \fI\fIinclude\fR\fR\fI = \fR\fI/usr/local/samba/lib/admin_smb\.conf\fR\fI \fR 3420 .RE 3421 2927 3422 inherit acls (S) 2928 .RS 3n 2929 This parameter can be used to ensure that if default acls exist on parent directories, they are always honored when creating a new file or subdirectory in these parent directories. The default behavior is to use the unix mode specified when creating the directory. Enabling this option sets the unix mode to 0777, thus guaranteeing that default directory acls are propagated. 2930 .sp 2931 Default: 2932 \fB\fIinherit acls\fR = no \fR 2933 .RE 2934 .PP 3423 .PP 3424 .RS 4 3425 This parameter can be used to ensure that if default acls exist on parent directories, they are always honored when creating a new file or subdirectory in these parent directories\. The default behavior is to use the unix mode specified when creating the directory\. Enabling this option sets the unix mode to 0777, thus guaranteeing that default directory acls are propagated\. 3426 .sp 3427 Default: 3428 \fI\fIinherit acls\fR\fR\fI = \fR\fIno\fR\fI \fR 3429 .RE 3430 2935 3431 inherit owner (S) 2936 .RS 3n 2937 The ownership of new files and directories is normally governed by effective uid of the connected user. This option allows the Samba administrator to specify that the ownership for new files and directories should be controlled by the ownership of the parent directory. 2938 .sp 2939 Common scenarios where this behavior is useful is in implementing drop-boxes where users can create and edit files but not delete them and to ensure that newly create files in a user's roaming profile directory are actually owner by the user. 2940 .sp 2941 Default: 2942 \fB\fIinherit owner\fR = no \fR 2943 .RE 2944 .PP 3432 .PP 3433 .RS 4 3434 The ownership of new files and directories is normally governed by effective uid of the connected user\. This option allows the Samba administrator to specify that the ownership for new files and directories should be controlled by the ownership of the parent directory\. 3435 .sp 3436 Common scenarios where this behavior is useful is in implementing drop\-boxes where users can create and edit files but not delete them and to ensure that newly create files in a user\'s roaming profile directory are actually owner by the user\. 3437 .sp 3438 Default: 3439 \fI\fIinherit owner\fR\fR\fI = \fR\fIno\fR\fI \fR 3440 .RE 3441 2945 3442 inherit permissions (S) 2946 .RS 3n 3443 .PP 3444 .RS 4 2947 3445 The permissions on new files and directories are normally governed by 2948 create mask, 2949 directory mask, 2950 force create mode and 2951 force directory mode but the boolean inherit permissions parameter overrides this. 2952 .sp 2953 New directories inherit the mode of the parent directory, including bits such as setgid. 2954 .sp 2955 New files inherit their read/write bits from the parent directory. Their execute bits continue to be determined by 2956 map archive, 2957 map hidden and 2958 map system as usual. 3446 \fIcreate mask\fR, 3447 \fIdirectory mask\fR, 3448 \fIforce create mode\fR 3449 and 3450 \fIforce directory mode\fR 3451 but the boolean inherit permissions parameter overrides this\. 3452 .sp 3453 New directories inherit the mode of the parent directory, including bits such as setgid\. 3454 .sp 3455 New files inherit their read/write bits from the parent directory\. Their execute bits continue to be determined by 3456 \fImap archive\fR, 3457 \fImap hidden\fR 3458 and 3459 \fImap system\fR 3460 as usual\. 2959 3461 .sp 2960 3462 Note that the setuid bit is 2961 \f Bnever\fR2962 set via inheritance (the code explicitly prohibits this) .2963 .sp 2964 This can be particularly useful on large systems with many users, perhaps several thousand, to allow a single [homes] share to be used flexibly by each user .2965 .sp 2966 Default: 2967 \f B\fIinherit permissions\fR = no\fR2968 .RE 2969 .PP 3463 \fInever\fR 3464 set via inheritance (the code explicitly prohibits this)\. 3465 .sp 3466 This can be particularly useful on large systems with many users, perhaps several thousand, to allow a single [homes] share to be used flexibly by each user\. 3467 .sp 3468 Default: 3469 \fI\fIinherit permissions\fR\fR\fI = \fR\fIno\fR\fI \fR 3470 .RE 3471 2970 3472 interfaces (G) 2971 .RS 3n 2972 This option allows you to override the default network interfaces list that Samba will use for browsing, name registration and other NBT traffic. By default Samba will query the kernel for the list of all active interfaces and use any interfaces except 127.0.0.1 that are broadcast capable. 2973 .sp 2974 The option takes a list of interface strings. Each string can be in any of the following forms: 2975 .RS 3n 2976 .TP 3n 2977 \(bu 2978 a network interface name (such as eth0). This may include shell-like wildcards so eth* will match any interface starting with the substring "eth" 2979 .TP 3n 2980 \(bu 2981 an IP address. In this case the netmask is determined from the list of interfaces obtained from the kernel 2982 .TP 3n 2983 \(bu 2984 an IP/mask pair. 2985 .TP 3n 2986 \(bu 2987 a broadcast/mask pair. 2988 .RE 2989 .IP "" 3n 2990 The "mask" parameters can either be a bit length (such as 24 for a C class network) or a full netmask in dotted decimal form. 2991 .sp 2992 The "IP" parameters above can either be a full dotted decimal IP address or a hostname which will be looked up via the OS's normal hostname resolution mechanisms. 2993 .sp 2994 By default Samba enables all active interfaces that are broadcast capable except the loopback adaptor (IP address 127.0.0.1). 2995 .sp 2996 The example below configures three network interfaces corresponding to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10. The netmasks of the latter two interfaces would be set to 255.255.255.0. 2997 .sp 2998 Default: 2999 \fB\fIinterfaces\fR = \fR 3000 .sp 3001 Example: 3002 \fB\fIinterfaces\fR = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0 \fR 3003 .RE 3004 .PP 3473 .PP 3474 .RS 4 3475 This option allows you to override the default network interfaces list that Samba will use for browsing, name registration and other NBT traffic\. By default Samba will query the kernel for the list of all active interfaces and use any interfaces except 127\.0\.0\.1 that are broadcast capable\. 3476 .sp 3477 The option takes a list of interface strings\. Each string can be in any of the following forms: 3478 .sp 3479 .RS 4 3480 .ie n \{\ 3481 \h'-04'\(bu\h'+03'\c 3482 .\} 3483 .el \{\ 3484 .sp -1 3485 .IP \(bu 2.3 3486 .\} 3487 a network interface name (such as eth0)\. This may include shell\-like wildcards so eth* will match any interface starting with the substring "eth" 3488 .RE 3489 .sp 3490 .RS 4 3491 .ie n \{\ 3492 \h'-04'\(bu\h'+03'\c 3493 .\} 3494 .el \{\ 3495 .sp -1 3496 .IP \(bu 2.3 3497 .\} 3498 an IP address\. In this case the netmask is determined from the list of interfaces obtained from the kernel 3499 .RE 3500 .sp 3501 .RS 4 3502 .ie n \{\ 3503 \h'-04'\(bu\h'+03'\c 3504 .\} 3505 .el \{\ 3506 .sp -1 3507 .IP \(bu 2.3 3508 .\} 3509 an IP/mask pair\. 3510 .RE 3511 .sp 3512 .RS 4 3513 .ie n \{\ 3514 \h'-04'\(bu\h'+03'\c 3515 .\} 3516 .el \{\ 3517 .sp -1 3518 .IP \(bu 2.3 3519 .\} 3520 a broadcast/mask pair\. 3521 .sp 3522 .RE 3523 The "mask" parameters can either be a bit length (such as 24 for a C class network) or a full netmask in dotted decimal form\. 3524 .sp 3525 The "IP" parameters above can either be a full dotted decimal IP address or a hostname which will be looked up via the OS\'s normal hostname resolution mechanisms\. 3526 .sp 3527 By default Samba enables all active interfaces that are broadcast capable except the loopback adaptor (IP address 127\.0\.0\.1)\. 3528 .sp 3529 The example below configures three network interfaces corresponding to the eth0 device and IP addresses 192\.168\.2\.10 and 192\.168\.3\.10\. The netmasks of the latter two interfaces would be set to 255\.255\.255\.0\. 3530 .sp 3531 Default: 3532 \fI\fIinterfaces\fR\fR\fI = \fR\fI\fR\fI \fR 3533 .sp 3534 Example: 3535 \fI\fIinterfaces\fR\fR\fI = \fR\fIeth0 192\.168\.2\.10/24 192\.168\.3\.10/255\.255\.255\.0\fR\fI \fR 3536 .RE 3537 3005 3538 invalid users (S) 3006 .RS 3n 3007 This is a list of users that should not be allowed to login to this service. This is really a 3008 \fBparanoid\fR 3009 check to absolutely ensure an improper setting does not breach your security. 3010 .sp 3011 A name starting with a '@' is interpreted as an NIS netgroup first (if your system supports NIS), and then as a UNIX group if the name was not found in the NIS netgroup database. 3012 .sp 3013 A name starting with '+' is interpreted only by looking in the UNIX group database via the NSS getgrnam() interface. A name starting with '&' is interpreted only by looking in the NIS netgroup database (this requires NIS to be working on your system). The characters '+' and '&' may be used at the start of the name in either order so the value 3539 .PP 3540 .RS 4 3541 This is a list of users that should not be allowed to login to this service\. This is really a 3542 \fIparanoid\fR 3543 check to absolutely ensure an improper setting does not breach your security\. 3544 .sp 3545 A name starting with a \'@\' is interpreted as an NIS netgroup first (if your system supports NIS), and then as a UNIX group if the name was not found in the NIS netgroup database\. 3546 .sp 3547 A name starting with \'+\' is interpreted only by looking in the UNIX group database via the NSS getgrnam() interface\. A name starting with \'&\' is interpreted only by looking in the NIS netgroup database (this requires NIS to be working on your system)\. The characters \'+\' and \'&\' may be used at the start of the name in either order so the value 3014 3548 \fI+&group\fR 3015 3549 means check the UNIX group database, followed by the NIS netgroup database, and the value 3016 3550 \fI&+group\fR 3017 means check the NIS netgroup database, followed by the UNIX group database (the same as the '@' prefix).3551 means check the NIS netgroup database, followed by the UNIX group database (the same as the \'@\' prefix)\. 3018 3552 .sp 3019 3553 The current servicename is substituted for 3020 \fI%S\fR . This is useful in the [homes] section.3021 .sp 3022 Default: 3023 \f B\fIinvalid users\fR = # no invalid users\fR3024 .sp 3025 Example: 3026 \f B\fIinvalid users\fR = root fred admin @wheel\fR3027 .RE 3028 .PP 3554 \fI%S\fR\. This is useful in the [homes] section\. 3555 .sp 3556 Default: 3557 \fI\fIinvalid users\fR\fR\fI = \fR\fI # no invalid users\fR\fI \fR 3558 .sp 3559 Example: 3560 \fI\fIinvalid users\fR\fR\fI = \fR\fIroot fred admin @wheel\fR\fI \fR 3561 .RE 3562 3029 3563 iprint server (G) 3030 .RS 3n 3564 .PP 3565 .RS 4 3031 3566 This parameter is only applicable if 3032 printing is set to 3033 \fBiprint\fR. 3567 \fIprinting\fR 3568 is set to 3569 \fBiprint\fR\. 3034 3570 .sp 3035 3571 If set, this option overrides the ServerName option in the CUPS 3036 \fIclient .conf\fR. This is necessary if you have virtual samba servers that connect to different CUPS daemons.3037 .sp 3038 Default: 3039 \f B\fIiprint server\fR = ""\fR3040 .sp 3041 Example: 3042 \f B\fIiprint server\fR = MYCUPSSERVER\fR3043 .RE 3044 .PP 3572 \fIclient\.conf\fR\. This is necessary if you have virtual samba servers that connect to different CUPS daemons\. 3573 .sp 3574 Default: 3575 \fI\fIiprint server\fR\fR\fI = \fR\fI""\fR\fI \fR 3576 .sp 3577 Example: 3578 \fI\fIiprint server\fR\fR\fI = \fR\fIMYCUPSSERVER\fR\fI \fR 3579 .RE 3580 3045 3581 keepalive (G) 3046 .RS 3n 3582 .PP 3583 .RS 4 3047 3584 The value of the parameter (an integer) represents the number of seconds between 3048 3585 \fIkeepalive\fR 3049 packets . If this parameter is zero, no keepalive packets will be sent. Keepalive packets, if sent, allow the server to tell whether a client is still present and responding.3050 .sp 3051 Keepalives should, in general, not be needed if the socket has the SO_KEEPALIVE attribute set on it by default . (see3052 socket options). Basically you should only use this option if you strike difficulties.3053 .sp 3054 Default: 3055 \f B\fIkeepalive\fR = 300\fR3056 .sp 3057 Example: 3058 \f B\fIkeepalive\fR = 600\fR3059 .RE 3060 .PP 3586 packets\. If this parameter is zero, no keepalive packets will be sent\. Keepalive packets, if sent, allow the server to tell whether a client is still present and responding\. 3587 .sp 3588 Keepalives should, in general, not be needed if the socket has the SO_KEEPALIVE attribute set on it by default\. (see 3589 \fIsocket options\fR)\. Basically you should only use this option if you strike difficulties\. 3590 .sp 3591 Default: 3592 \fI\fIkeepalive\fR\fR\fI = \fR\fI300\fR\fI \fR 3593 .sp 3594 Example: 3595 \fI\fIkeepalive\fR\fR\fI = \fR\fI600\fR\fI \fR 3596 .RE 3597 3061 3598 kernel change notify (S) 3062 .RS 3n 3063 This parameter specifies whether Samba should ask the kernel for change notifications in directories so that SMB clients can refresh whenever the data on the server changes. 3064 .sp 3065 This parameter is only used when your kernel supports change notification to user programs using the inotify interface. 3066 .sp 3067 Default: 3068 \fB\fIkernel change notify\fR = yes \fR 3069 .RE 3070 .PP 3599 .PP 3600 .RS 4 3601 This parameter specifies whether Samba should ask the kernel for change notifications in directories so that SMB clients can refresh whenever the data on the server changes\. 3602 .sp 3603 This parameter is only used when your kernel supports change notification to user programs using the inotify interface\. 3604 .sp 3605 Default: 3606 \fI\fIkernel change notify\fR\fR\fI = \fR\fIyes\fR\fI \fR 3607 .RE 3608 3071 3609 kernel oplocks (G) 3072 .RS 3n 3610 .PP 3611 .RS 4 3073 3612 For UNIXes that support kernel based 3074 oplocks (currently only IRIX and the Linux 2.4 kernel), this parameter allows the use of them to be turned on or off. 3613 \fIoplocks\fR 3614 (currently only IRIX and the Linux 2\.4 kernel), this parameter allows the use of them to be turned on or off\. 3075 3615 .sp 3076 3616 Kernel oplocks support allows Samba … … 3078 3618 to be broken whenever a local UNIX process or NFS operation accesses a file that 3079 3619 \fBsmbd\fR(8) 3080 has oplocked . This allows complete data consistency between SMB/CIFS, NFS and local file access (and is a3081 \f Bvery\fR3082 cool feature : -).3620 has oplocked\. This allows complete data consistency between SMB/CIFS, NFS and local file access (and is a 3621 \fIvery\fR 3622 cool feature :\-)\. 3083 3623 .sp 3084 3624 This parameter defaults to 3085 \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.3086 .sp 3087 Default: 3088 \f B\fIkernel oplocks\fR = yes\fR3089 .RE 3090 .PP 3625 \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\. 3626 .sp 3627 Default: 3628 \fI\fIkernel oplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR 3629 .RE 3630 3091 3631 lanman auth (G) 3092 .RS 3n 3632 .PP 3633 .RS 4 3093 3634 This parameter determines whether or not 3094 3635 \fBsmbd\fR(8) 3095 will attempt to authenticate users or permit password changes using the LANMAN password hash . If disabled, only clients which support NT password hashes (e.g. Windows NT/2000 clients, smbclient, but not Windows 95/98 or the MS DOS network client) will be able to connect to the Samba host.3096 .sp 3097 The LANMAN encrypted response is easily broken, due to it 's case-insensitive nature, and the choice of algorithm. Servers without Windows 95/98/ME or MS DOS clients are advised to disable this option.3636 will attempt to authenticate users or permit password changes using the LANMAN password hash\. If disabled, only clients which support NT password hashes (e\.g\. Windows NT/2000 clients, smbclient, but not Windows 95/98 or the MS DOS network client) will be able to connect to the Samba host\. 3637 .sp 3638 The LANMAN encrypted response is easily broken, due to it\'s case\-insensitive nature, and the choice of algorithm\. Servers without Windows 95/98/ME or MS DOS clients are advised to disable this option\. 3098 3639 .sp 3099 3640 Unlike the 3100 3641 encrypt passwords 3101 option, this parameter cannot alter client behaviour, and the LANMAN response will still be sent over the network . See the3642 option, this parameter cannot alter client behaviour, and the LANMAN response will still be sent over the network\. See the 3102 3643 client lanman auth 3103 to disable this for Samba 's clients (such as smbclient)3644 to disable this for Samba\'s clients (such as smbclient) 3104 3645 .sp 3105 3646 If this option, and 3106 3647 ntlm auth 3107 are both disabled, then only NTLMv2 logins will be permited . Not all clients support NTLMv2, and most will require special configuration to use it.3108 .sp 3109 Default: 3110 \f B\fIlanman auth\fR = yes\fR3111 .RE 3112 .PP 3648 are both disabled, then only NTLMv2 logins will be permited\. Not all clients support NTLMv2, and most will require special configuration to use it\. 3649 .sp 3650 Default: 3651 \fI\fIlanman auth\fR\fR\fI = \fR\fIyes\fR\fI \fR 3652 .RE 3653 3113 3654 large readwrite (G) 3114 .RS 3n 3655 .PP 3656 .RS 4 3115 3657 This parameter determines whether or not 3116 3658 \fBsmbd\fR(8) 3117 supports the new 64k streaming read and write varient SMB requests introduced with Windows 2000 . Note that due to Windows 2000 client redirector bugs this requires Samba to be running on a 64-bit capable operating system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve performance by 10% with Windows 2000 clients. Defaults to on. Not as tested as some other Samba code paths.3118 .sp 3119 Default: 3120 \f B\fIlarge readwrite\fR = yes\fR3121 .RE 3122 .PP 3659 supports the new 64k streaming read and write varient SMB requests introduced with Windows 2000\. Note that due to Windows 2000 client redirector bugs this requires Samba to be running on a 64\-bit capable operating system such as IRIX, Solaris or a Linux 2\.4 kernel\. Can improve performance by 10% with Windows 2000 clients\. Defaults to on\. Not as tested as some other Samba code paths\. 3660 .sp 3661 Default: 3662 \fI\fIlarge readwrite\fR\fR\fI = \fR\fIyes\fR\fI \fR 3663 .RE 3664 3123 3665 ldap admin dn (G) 3124 .RS 3n 3666 .PP 3667 .RS 4 3125 3668 The 3126 ldap admin dn defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retreiving user account information. The 3127 ldap admin dn is used in conjunction with the admin dn password stored in the 3128 \fIprivate/secrets.tdb\fR 3129 file. See the 3669 \fIldap admin dn\fR 3670 defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retreiving user account information\. The 3671 \fIldap admin dn\fR 3672 is used in conjunction with the admin dn password stored in the 3673 \fIprivate/secrets\.tdb\fR 3674 file\. See the 3130 3675 \fBsmbpasswd\fR(8) 3131 man page for more information on how to accomplish this .3676 man page for more information on how to accomplish this\. 3132 3677 .sp 3133 3678 The 3134 ldap admin dn requires a fully specified DN. The 3135 ldap suffix is not appended to the 3136 ldap admin dn. 3137 .sp 3138 \fBNo default\fR 3139 .RE 3140 .PP 3679 \fIldap admin dn\fR 3680 requires a fully specified DN\. The 3681 \fIldap suffix\fR 3682 is not appended to the 3683 \fIldap admin dn\fR\. 3684 .sp 3685 \fINo default\fR 3686 .RE 3687 3141 3688 ldap delete dn (G) 3142 .RS 3n 3143 This parameter specifies whether a delete operation in the ldapsam deletes the complete entry or only the attributes specific to Samba. 3144 .sp 3145 Default: 3146 \fB\fIldap delete dn\fR = no \fR 3147 .RE 3148 .PP 3689 .PP 3690 .RS 4 3691 This parameter specifies whether a delete operation in the ldapsam deletes the complete entry or only the attributes specific to Samba\. 3692 .sp 3693 Default: 3694 \fI\fIldap delete dn\fR\fR\fI = \fR\fIno\fR\fI \fR 3695 .RE 3696 3149 3697 ldap group suffix (G) 3150 .RS 3n 3151 This parameter specifies the suffix that is used for groups when these are added to the LDAP directory. If this parameter is unset, the value of 3152 ldap suffix will be used instead. The suffix string is pre-pended to the 3153 ldap suffix string so use a partial DN. 3154 .sp 3155 Default: 3156 \fB\fIldap group suffix\fR = \fR 3157 .sp 3158 Example: 3159 \fB\fIldap group suffix\fR = ou=Groups \fR 3160 .RE 3161 .PP 3698 .PP 3699 .RS 4 3700 This parameter specifies the suffix that is used for groups when these are added to the LDAP directory\. If this parameter is unset, the value of 3701 \fIldap suffix\fR 3702 will be used instead\. The suffix string is pre\-pended to the 3703 \fIldap suffix\fR 3704 string so use a partial DN\. 3705 .sp 3706 Default: 3707 \fI\fIldap group suffix\fR\fR\fI = \fR\fI\fR\fI \fR 3708 .sp 3709 Example: 3710 \fI\fIldap group suffix\fR\fR\fI = \fR\fIou=Groups\fR\fI \fR 3711 .RE 3712 3162 3713 ldap idmap suffix (G) 3163 .RS 3n 3164 This parameters specifies the suffix that is used when storing idmap mappings. If this parameter is unset, the value of 3165 ldap suffix will be used instead. The suffix string is pre-pended to the 3166 ldap suffix string so use a partial DN. 3167 .sp 3168 Default: 3169 \fB\fIldap idmap suffix\fR = \fR 3170 .sp 3171 Example: 3172 \fB\fIldap idmap suffix\fR = ou=Idmap \fR 3173 .RE 3174 .PP 3714 .PP 3715 .RS 4 3716 This parameters specifies the suffix that is used when storing idmap mappings\. If this parameter is unset, the value of 3717 \fIldap suffix\fR 3718 will be used instead\. The suffix string is pre\-pended to the 3719 \fIldap suffix\fR 3720 string so use a partial DN\. 3721 .sp 3722 Default: 3723 \fI\fIldap idmap suffix\fR\fR\fI = \fR\fI\fR\fI \fR 3724 .sp 3725 Example: 3726 \fI\fIldap idmap suffix\fR\fR\fI = \fR\fIou=Idmap\fR\fI \fR 3727 .RE 3728 3175 3729 ldap machine suffix (G) 3176 .RS 3n 3177 It specifies where machines should be added to the ldap tree. If this parameter is unset, the value of 3178 ldap suffix will be used instead. The suffix string is pre-pended to the 3179 ldap suffix string so use a partial DN. 3180 .sp 3181 Default: 3182 \fB\fIldap machine suffix\fR = \fR 3183 .sp 3184 Example: 3185 \fB\fIldap machine suffix\fR = ou=Computers \fR 3186 .RE 3187 .PP 3730 .PP 3731 .RS 4 3732 It specifies where machines should be added to the ldap tree\. If this parameter is unset, the value of 3733 \fIldap suffix\fR 3734 will be used instead\. The suffix string is pre\-pended to the 3735 \fIldap suffix\fR 3736 string so use a partial DN\. 3737 .sp 3738 Default: 3739 \fI\fIldap machine suffix\fR\fR\fI = \fR\fI\fR\fI \fR 3740 .sp 3741 Example: 3742 \fI\fIldap machine suffix\fR\fR\fI = \fR\fIou=Computers\fR\fI \fR 3743 .RE 3744 3188 3745 ldap passwd sync (G) 3189 .RS 3n 3190 This option is used to define whether or not Samba should sync the LDAP password with the NT and LM hashes for normal accounts (NOT for workstation, server or domain trusts) on a password change via SAMBA. 3746 .PP 3747 .RS 4 3748 This option is used to define whether or not Samba should sync the LDAP password with the NT and LM hashes for normal accounts (NOT for workstation, server or domain trusts) on a password change via SAMBA\. 3191 3749 .sp 3192 3750 The 3193 ldap passwd sync can be set to one of three values: 3194 .RS 3n 3195 .TP 3n 3196 \(bu 3751 \fIldap passwd sync\fR 3752 can be set to one of three values: 3753 .sp 3754 .RS 4 3755 .ie n \{\ 3756 \h'-04'\(bu\h'+03'\c 3757 .\} 3758 .el \{\ 3759 .sp -1 3760 .IP \(bu 2.3 3761 .\} 3197 3762 \fIYes\fR 3198 = Try to update the LDAP, NT and LM passwords and update the pwdLastSet time. 3199 .TP 3n 3200 \(bu 3763 = Try to update the LDAP, NT and LM passwords and update the pwdLastSet time\. 3764 .RE 3765 .sp 3766 .RS 4 3767 .ie n \{\ 3768 \h'-04'\(bu\h'+03'\c 3769 .\} 3770 .el \{\ 3771 .sp -1 3772 .IP \(bu 2.3 3773 .\} 3201 3774 \fINo\fR 3202 = Update NT and LM passwords and update the pwdLastSet time. 3203 .TP 3n 3204 \(bu 3775 = Update NT and LM passwords and update the pwdLastSet time\. 3776 .RE 3777 .sp 3778 .RS 4 3779 .ie n \{\ 3780 \h'-04'\(bu\h'+03'\c 3781 .\} 3782 .el \{\ 3783 .sp -1 3784 .IP \(bu 2.3 3785 .\} 3205 3786 \fIOnly\fR 3206 = Only update the LDAP password and let the LDAP server do the rest .3207 . RE3208 . IP "" 3n3209 Default: 3210 \f B\fIldap passwd sync\fR = no\fR3211 .RE 3212 .PP 3787 = Only update the LDAP password and let the LDAP server do the rest\. 3788 .sp 3789 .RE 3790 Default: 3791 \fI\fIldap passwd sync\fR\fR\fI = \fR\fIno\fR\fI \fR 3792 .RE 3793 3213 3794 ldap replication sleep (G) 3214 .RS 3n 3215 When Samba is asked to write to a read-only LDAP replica, we are redirected to talk to the read-write master server. This server then replicates our changes back to the 'local' server, however the replication might take some seconds, especially over slow links. Certain client activities, particularly domain joins, can become confused by the 'success' that does not immediately change the LDAP back-end's data. 3216 .sp 3217 This option simply causes Samba to wait a short time, to allow the LDAP server to catch up. If you have a particularly high-latency network, you may wish to time the LDAP replication with a network sniffer, and increase this value accordingly. Be aware that no checking is performed that the data has actually replicated. 3218 .sp 3219 The value is specified in milliseconds, the maximum value is 5000 (5 seconds). 3220 .sp 3221 Default: 3222 \fB\fIldap replication sleep\fR = 1000 \fR 3223 .RE 3224 .PP 3795 .PP 3796 .RS 4 3797 When Samba is asked to write to a read\-only LDAP replica, we are redirected to talk to the read\-write master server\. This server then replicates our changes back to the \'local\' server, however the replication might take some seconds, especially over slow links\. Certain client activities, particularly domain joins, can become confused by the \'success\' that does not immediately change the LDAP back\-end\'s data\. 3798 .sp 3799 This option simply causes Samba to wait a short time, to allow the LDAP server to catch up\. If you have a particularly high\-latency network, you may wish to time the LDAP replication with a network sniffer, and increase this value accordingly\. Be aware that no checking is performed that the data has actually replicated\. 3800 .sp 3801 The value is specified in milliseconds, the maximum value is 5000 (5 seconds)\. 3802 .sp 3803 Default: 3804 \fI\fIldap replication sleep\fR\fR\fI = \fR\fI1000\fR\fI \fR 3805 .RE 3806 3225 3807 ldapsam:editposix (G) 3226 .RS 3n 3227 Editposix is an option that leverages ldapsam:trusted to make it simpler to manage a domain controller eliminating the need to set up custom scripts to add and manage the posix users and groups. This option will instead directly manipulate the ldap tree to create, remove and modify user and group entries. This option also requires a running winbindd as it is used to allocate new uids/gids on user/group creation. The allocation range must be therefore configured. 3228 .sp 3229 To use this option, a basic ldap tree must be provided and the ldap suffix parameters must be properly configured. On virgin servers the default users and groups (Administrator, Guest, Domain Users, Domain Admins, Domain Guests) can be precreated with the command 3230 net sam provision. To run this command the ldap server must be running, Winindd must be running and the smb.conf ldap options must be properly configured. The typical ldap setup used with the 3231 ldapsam:trusted = yes option is usually sufficient to use 3232 ldapsam:editposix = yes as well. 3808 .PP 3809 .RS 4 3810 Editposix is an option that leverages ldapsam:trusted to make it simpler to manage a domain controller eliminating the need to set up custom scripts to add and manage the posix users and groups\. This option will instead directly manipulate the ldap tree to create, remove and modify user and group entries\. This option also requires a running winbindd as it is used to allocate new uids/gids on user/group creation\. The allocation range must be therefore configured\. 3811 .sp 3812 To use this option, a basic ldap tree must be provided and the ldap suffix parameters must be properly configured\. On virgin servers the default users and groups (Administrator, Guest, Domain Users, Domain Admins, Domain Guests) can be precreated with the command 3813 net sam provision\. To run this command the ldap server must be running, Winindd must be running and the smb\.conf ldap options must be properly configured\. The typical ldap setup used with the 3814 \fIldapsam:trusted = yes\fR 3815 option is usually sufficient to use 3816 \fIldapsam:editposix = yes\fR 3817 as well\. 3233 3818 .sp 3234 3819 An example configuration can be the following: 3235 3236 .sp 3237 3820 .sp 3821 .RS 4 3238 3822 .nf 3239 3240 3823 encrypt passwords = true 3241 3824 passdb backend = ldapsam … … 3254 3837 idmap backend = ldap:"ldap://localhost" 3255 3838 3256 idmap uid = 5000 -500003257 idmap gid = 5000 -500003839 idmap uid = 5000\-50000 3840 idmap gid = 5000\-50000 3258 3841 3259 3842 .fi 3843 .RE 3844 .sp 3260 3845 This configuration assume the ldap server have been loaded with a base tree like described in the following ldif: 3261 3262 .sp 3263 3846 .sp 3847 .RS 4 3264 3848 .nf 3265 3266 3849 dn: dc=samba,dc=org 3267 3850 objectClass: top 3268 3851 objectClass: dcObject 3269 3852 objectClass: organization 3270 o: samba .org3853 o: samba\.org 3271 3854 dc: samba 3272 3855 … … 3299 3882 3300 3883 .fi 3301 3302 .sp 3303 Default: 3304 \fB\fIldapsam:editposix\fR = no \fR 3305 .RE 3306 .PP 3884 .RE 3885 .sp 3886 .sp 3887 Default: 3888 \fI\fIldapsam:editposix\fR\fR\fI = \fR\fIno\fR\fI \fR 3889 .RE 3890 3307 3891 ldapsam:trusted (G) 3308 .RS 3n 3309 By default, Samba as a Domain Controller with an LDAP backend needs to use the Unix-style NSS subsystem to access user and group information. Due to the way Unix stores user information in /etc/passwd and /etc/group this inevitably leads to inefficiencies. One important question a user needs to know is the list of groups he is member of. The plain UNIX model involves a complete enumeration of the file /etc/group and its NSS counterparts in LDAP. UNIX has optimized functions to enumerate group membership. Sadly, other functions that are used to deal with user and group attributes lack such optimization. 3892 .PP 3893 .RS 4 3894 By default, Samba as a Domain Controller with an LDAP backend needs to use the Unix\-style NSS subsystem to access user and group information\. Due to the way Unix stores user information in /etc/passwd and /etc/group this inevitably leads to inefficiencies\. One important question a user needs to know is the list of groups he is member of\. The plain UNIX model involves a complete enumeration of the file /etc/group and its NSS counterparts in LDAP\. UNIX has optimized functions to enumerate group membership\. Sadly, other functions that are used to deal with user and group attributes lack such optimization\. 3310 3895 .sp 3311 3896 To make Samba scale well in large environments, the 3312 ldapsam:trusted = yes option assumes that the complete user and group database that is relevant to Samba is stored in LDAP with the standard posixAccount/posixGroup attributes. It further assumes that the Samba auxiliary object classes are stored together with the POSIX data in the same LDAP object. If these assumptions are met, 3313 ldapsam:trusted = yes can be activated and Samba can bypass the NSS system to query user group memberships. Optimized LDAP queries can greatly speed up domain logon and administration tasks. Depending on the size of the LDAP database a factor of 100 or more for common queries is easily achieved. 3314 .sp 3315 Default: 3316 \fB\fIldapsam:trusted\fR = no \fR 3317 .RE 3318 .PP 3897 \fIldapsam:trusted = yes\fR 3898 option assumes that the complete user and group database that is relevant to Samba is stored in LDAP with the standard posixAccount/posixGroup attributes\. It further assumes that the Samba auxiliary object classes are stored together with the POSIX data in the same LDAP object\. If these assumptions are met, 3899 \fIldapsam:trusted = yes\fR 3900 can be activated and Samba can bypass the NSS system to query user group memberships\. Optimized LDAP queries can greatly speed up domain logon and administration tasks\. Depending on the size of the LDAP database a factor of 100 or more for common queries is easily achieved\. 3901 .sp 3902 Default: 3903 \fI\fIldapsam:trusted\fR\fR\fI = \fR\fIno\fR\fI \fR 3904 .RE 3905 3319 3906 ldap ssl (G) 3320 .RS 3n 3907 .PP 3908 .RS 4 3321 3909 This option is used to define whether or not Samba should use SSL when connecting to the ldap server This is 3322 \f BNOT\fR3323 related to Samba 's previous SSL support which was enabled by specifying the3324 --with-ssl3910 \fINOT\fR 3911 related to Samba\'s previous SSL support which was enabled by specifying the 3912 \-\-with\-ssl 3325 3913 option to the 3326 3914 \fIconfigure\fR 3327 script .3915 script\. 3328 3916 .sp 3329 3917 The 3330 ldap ssl can be set to one of three values: 3331 .RS 3n 3332 .TP 3n 3333 \(bu 3918 \fIldap ssl\fR 3919 can be set to one of three values: 3920 .sp 3921 .RS 4 3922 .ie n \{\ 3923 \h'-04'\(bu\h'+03'\c 3924 .\} 3925 .el \{\ 3926 .sp -1 3927 .IP \(bu 2.3 3928 .\} 3334 3929 \fIOff\fR 3335 = Never use SSL when querying the directory. 3336 .TP 3n 3337 \(bu 3930 = Never use SSL when querying the directory\. 3931 .RE 3932 .sp 3933 .RS 4 3934 .ie n \{\ 3935 \h'-04'\(bu\h'+03'\c 3936 .\} 3937 .el \{\ 3938 .sp -1 3939 .IP \(bu 2.3 3940 .\} 3338 3941 \fIStart_tls\fR 3339 = Use the LDAPv3 StartTLS extended operation (RFC2830) for communicating with the directory server. 3340 .TP 3n 3341 \(bu 3942 = Use the LDAPv3 StartTLS extended operation (RFC2830) for communicating with the directory server\. 3943 .RE 3944 .sp 3945 .RS 4 3946 .ie n \{\ 3947 \h'-04'\(bu\h'+03'\c 3948 .\} 3949 .el \{\ 3950 .sp -1 3951 .IP \(bu 2.3 3952 .\} 3342 3953 \fIOn\fR 3343 3954 = Use SSL on the ldaps port when contacting the 3344 \fIldap server\fR . Only available when the backwards-compatiblity3345 --with-ldapsam3346 option is specified to configure . See3347 passdb backend 3348 .3349 . RE3350 . IP "" 3n3351 Default: 3352 \f B\fIldap ssl\fR = start_tls\fR3353 .RE 3354 .PP 3955 \fIldap server\fR\. Only available when the backwards\-compatiblity 3956 \-\-with\-ldapsam 3957 option is specified to configure\. See 3958 \fIpassdb backend\fR 3959 \. 3960 .sp 3961 .RE 3962 Default: 3963 \fI\fIldap ssl\fR\fR\fI = \fR\fIstart_tls\fR\fI \fR 3964 .RE 3965 3355 3966 ldap suffix (G) 3356 .RS 3n 3357 Specifies the base for all ldap suffixes and for storing the sambaDomain object. 3967 .PP 3968 .RS 4 3969 Specifies the base for all ldap suffixes and for storing the sambaDomain object\. 3358 3970 .sp 3359 3971 The ldap suffix will be appended to the values specified for the 3360 ldap user suffix,3361 ldap group suffix,3362 ldap machine suffix, and the3363 ldap idmap suffix. Each of these should be given only a DN relative to the3364 ldap suffix.3365 .sp 3366 Default: 3367 \f B\fIldap suffix\fR =\fR3368 .sp 3369 Example: 3370 \f B\fIldap suffix\fR = dc=samba,dc=org\fR3371 .RE 3372 .PP 3972 \fIldap user suffix\fR, 3973 \fIldap group suffix\fR, 3974 \fIldap machine suffix\fR, and the 3975 \fIldap idmap suffix\fR\. Each of these should be given only a DN relative to the 3976 \fIldap suffix\fR\. 3977 .sp 3978 Default: 3979 \fI\fIldap suffix\fR\fR\fI = \fR\fI\fR\fI \fR 3980 .sp 3981 Example: 3982 \fI\fIldap suffix\fR\fR\fI = \fR\fIdc=samba,dc=org\fR\fI \fR 3983 .RE 3984 3373 3985 ldap timeout (G) 3374 .RS 3n 3375 When Samba connects to an ldap server that servermay be down or unreachable. To prevent Samba from hanging whilst waiting for the connection this parameter specifies in seconds how long Samba should wait before failing the connect. The default is to only wait fifteen seconds for the ldap server to respond to the connect request. 3376 .sp 3377 Default: 3378 \fB\fIldap timeout\fR = 15 \fR 3379 .RE 3380 .PP 3986 .PP 3987 .RS 4 3988 When Samba connects to an ldap server that servermay be down or unreachable\. To prevent Samba from hanging whilst waiting for the connection this parameter specifies in seconds how long Samba should wait before failing the connect\. The default is to only wait fifteen seconds for the ldap server to respond to the connect request\. 3989 .sp 3990 Default: 3991 \fI\fIldap timeout\fR\fR\fI = \fR\fI15\fR\fI \fR 3992 .RE 3993 3381 3994 ldap user suffix (G) 3382 .RS 3n 3383 This parameter specifies where users are added to the tree. If this parameter is unset, the value of 3384 ldap suffix will be used instead. The suffix string is pre-pended to the 3385 ldap suffix string so use a partial DN. 3386 .sp 3387 Default: 3388 \fB\fIldap user suffix\fR = \fR 3389 .sp 3390 Example: 3391 \fB\fIldap user suffix\fR = ou=people \fR 3392 .RE 3393 .PP 3995 .PP 3996 .RS 4 3997 This parameter specifies where users are added to the tree\. If this parameter is unset, the value of 3998 \fIldap suffix\fR 3999 will be used instead\. The suffix string is pre\-pended to the 4000 \fIldap suffix\fR 4001 string so use a partial DN\. 4002 .sp 4003 Default: 4004 \fI\fIldap user suffix\fR\fR\fI = \fR\fI\fR\fI \fR 4005 .sp 4006 Example: 4007 \fI\fIldap user suffix\fR\fR\fI = \fR\fIou=people\fR\fI \fR 4008 .RE 4009 3394 4010 level2 oplocks (S) 3395 .RS 3n 3396 This parameter controls whether Samba supports level2 (read-only) oplocks on a share. 3397 .sp 3398 Level2, or read-only oplocks allow Windows NT clients that have an oplock on a file to downgrade from a read-write oplock to a read-only oplock once a second client opens the file (instead of releasing all oplocks on a second open, as in traditional, exclusive oplocks). This allows all openers of the file that support level2 oplocks to cache the file for read-ahead only (ie. they may not cache writes or lock requests) and increases performance for many accesses of files that are not commonly written (such as application .EXE files). 3399 .sp 3400 Once one of the clients which have a read-only oplock writes to the file all clients are notified (no reply is needed or waited for) and told to break their oplocks to "none" and delete any read-ahead caches. 3401 .sp 3402 It is recommended that this parameter be turned on to speed access to shared executables. 3403 .sp 3404 For more discussions on level2 oplocks see the CIFS spec. 4011 .PP 4012 .RS 4 4013 This parameter controls whether Samba supports level2 (read\-only) oplocks on a share\. 4014 .sp 4015 Level2, or read\-only oplocks allow Windows NT clients that have an oplock on a file to downgrade from a read\-write oplock to a read\-only oplock once a second client opens the file (instead of releasing all oplocks on a second open, as in traditional, exclusive oplocks)\. This allows all openers of the file that support level2 oplocks to cache the file for read\-ahead only (ie\. they may not cache writes or lock requests) and increases performance for many accesses of files that are not commonly written (such as application \.EXE files)\. 4016 .sp 4017 Once one of the clients which have a read\-only oplock writes to the file all clients are notified (no reply is needed or waited for) and told to break their oplocks to "none" and delete any read\-ahead caches\. 4018 .sp 4019 It is recommended that this parameter be turned on to speed access to shared executables\. 4020 .sp 4021 For more discussions on level2 oplocks see the CIFS spec\. 3405 4022 .sp 3406 4023 Currently, if 3407 kernel oplocks are supported then level2 oplocks are not granted (even if this parameter is set to 3408 \fByes\fR). Note also, the 3409 oplocks parameter must be set to 4024 \fIkernel oplocks\fR 4025 are supported then level2 oplocks are not granted (even if this parameter is set to 4026 \fByes\fR)\. Note also, the 4027 \fIoplocks\fR 4028 parameter must be set to 3410 4029 \fByes\fR 3411 on this share in order for this parameter to have any effect .3412 .sp 3413 Default: 3414 \f B\fIlevel2 oplocks\fR = yes\fR3415 .RE 3416 .PP 4030 on this share in order for this parameter to have any effect\. 4031 .sp 4032 Default: 4033 \fI\fIlevel2 oplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR 4034 .RE 4035 3417 4036 lm announce (G) 3418 .RS 3n 4037 .PP 4038 .RS 4 3419 4039 This parameter determines if 3420 4040 \fBnmbd\fR(8) 3421 will produce Lanman announce broadcasts that are needed by OS/2 clients in order for them to see the Samba server in their browse list . This parameter can have three values,4041 will produce Lanman announce broadcasts that are needed by OS/2 clients in order for them to see the Samba server in their browse list\. This parameter can have three values, 3422 4042 \fByes\fR, 3423 4043 \fBno\fR, or 3424 \fBauto\fR . The default is3425 \fBauto\fR . If set to4044 \fBauto\fR\. The default is 4045 \fBauto\fR\. If set to 3426 4046 \fBno\fR 3427 Samba will never produce these broadcasts . If set to4047 Samba will never produce these broadcasts\. If set to 3428 4048 \fByes\fR 3429 4049 Samba will produce Lanman announce broadcasts at a frequency set by the parameter 3430 lm interval. If set to4050 \fIlm interval\fR\. If set to 3431 4051 \fBauto\fR 3432 Samba will not send Lanman announce broadcasts by default but will listen for them . If it hears such a broadcast on the wire it will then start sending them at a frequency set by the parameter3433 lm interval.3434 .sp 3435 Default: 3436 \f B\fIlm announce\fR = auto\fR3437 .sp 3438 Example: 3439 \f B\fIlm announce\fR = yes\fR3440 .RE 3441 .PP 4052 Samba will not send Lanman announce broadcasts by default but will listen for them\. If it hears such a broadcast on the wire it will then start sending them at a frequency set by the parameter 4053 \fIlm interval\fR\. 4054 .sp 4055 Default: 4056 \fI\fIlm announce\fR\fR\fI = \fR\fIauto\fR\fI \fR 4057 .sp 4058 Example: 4059 \fI\fIlm announce\fR\fR\fI = \fR\fIyes\fR\fI \fR 4060 .RE 4061 3442 4062 lm interval (G) 3443 .RS 3n 4063 .PP 4064 .RS 4 3444 4065 If Samba is set to produce Lanman announce broadcasts needed by OS/2 clients (see the 3445 lm announce parameter) then this parameter defines the frequency in seconds with which they will be made. If this is set to zero then no Lanman announcements will be made despite the setting of the 3446 lm announce parameter. 3447 .sp 3448 Default: 3449 \fB\fIlm interval\fR = 60 \fR 3450 .sp 3451 Example: 3452 \fB\fIlm interval\fR = 120 \fR 3453 .RE 3454 .PP 4066 \fIlm announce\fR 4067 parameter) then this parameter defines the frequency in seconds with which they will be made\. If this is set to zero then no Lanman announcements will be made despite the setting of the 4068 \fIlm announce\fR 4069 parameter\. 4070 .sp 4071 Default: 4072 \fI\fIlm interval\fR\fR\fI = \fR\fI60\fR\fI \fR 4073 .sp 4074 Example: 4075 \fI\fIlm interval\fR\fR\fI = \fR\fI120\fR\fI \fR 4076 .RE 4077 3455 4078 load printers (G) 3456 .RS 3n 3457 A boolean variable that controls whether all printers in the printcap will be loaded for browsing by default. See the 3458 printers section for more details. 3459 .sp 3460 Default: 3461 \fB\fIload printers\fR = yes \fR 3462 .RE 3463 .PP 4079 .PP 4080 .RS 4 4081 A boolean variable that controls whether all printers in the printcap will be loaded for browsing by default\. See the 4082 \fIprinters\fR 4083 section for more details\. 4084 .sp 4085 Default: 4086 \fI\fIload printers\fR\fR\fI = \fR\fIyes\fR\fI \fR 4087 .RE 4088 3464 4089 local master (G) 3465 .RS 3n 4090 .PP 4091 .RS 4 3466 4092 This option allows 3467 4093 \fBnmbd\fR(8) 3468 to try and become a local master browser on a subnet . If set to4094 to try and become a local master browser on a subnet\. If set to 3469 4095 \fBno\fR 3470 4096 then 3471 4097 nmbd 3472 will not attempt to become a local master browser on a subnet and will also lose in all browsing elections . By default this value is set to3473 \fByes\fR . Setting this value to4098 will not attempt to become a local master browser on a subnet and will also lose in all browsing elections\. By default this value is set to 4099 \fByes\fR\. Setting this value to 3474 4100 \fByes\fR 3475 doesn 't mean that Samba will3476 \f Bbecome\fR4101 doesn\'t mean that Samba will 4102 \fIbecome\fR 3477 4103 the local master browser on a subnet, just that 3478 4104 nmbd 3479 4105 will 3480 \f Bparticipate\fR3481 in elections for local master browser .4106 \fIparticipate\fR 4107 in elections for local master browser\. 3482 4108 .sp 3483 4109 Setting this value to … … 3485 4111 will cause 3486 4112 nmbd 3487 \f Bnever\fR3488 to become a local master browser .3489 .sp 3490 Default: 3491 \f B\fIlocal master\fR = yes\fR3492 .RE 3493 .PP3494 lock dir 3495 .RS 3n 3496 This parameter is a synonym for lock directory.3497 .RE 3498 .PP 4113 \fInever\fR 4114 to become a local master browser\. 4115 .sp 4116 Default: 4117 \fI\fIlocal master\fR\fR\fI = \fR\fIyes\fR\fI \fR 4118 .RE 4119 lock dir.PP 4120 .RS 4 4121 This parameter is a synonym for 4122 lock directory\. 4123 .RE 4124 3499 4125 lock directory (G) 3500 .RS 3n 3501 This option specifies the directory where lock files will be placed. The lock files are used to implement the 3502 max connections option. 3503 .sp 3504 Default: 3505 \fB\fIlock directory\fR = ${prefix}/var/locks \fR 3506 .sp 3507 Example: 3508 \fB\fIlock directory\fR = /var/run/samba/locks \fR 3509 .RE 3510 .PP 4126 .PP 4127 .RS 4 4128 This option specifies the directory where lock files will be placed\. The lock files are used to implement the 4129 \fImax connections\fR 4130 option\. 4131 .sp 4132 Default: 4133 \fI\fIlock directory\fR\fR\fI = \fR\fI${prefix}/var/locks\fR\fI \fR 4134 .sp 4135 Example: 4136 \fI\fIlock directory\fR\fR\fI = \fR\fI/var/run/samba/locks\fR\fI \fR 4137 .RE 4138 3511 4139 locking (S) 3512 .RS 3n 3513 This controls whether or not locking will be performed by the server in response to lock requests from the client. 4140 .PP 4141 .RS 4 4142 This controls whether or not locking will be performed by the server in response to lock requests from the client\. 3514 4143 .sp 3515 4144 If 3516 locking = no, all lock and unlock requests will appear to succeed and all lock queries will report that the file in question is available for locking .4145 locking = no, all lock and unlock requests will appear to succeed and all lock queries will report that the file in question is available for locking\. 3517 4146 .sp 3518 4147 If 3519 locking = yes, real locking will be performed by the server .4148 locking = yes, real locking will be performed by the server\. 3520 4149 .sp 3521 4150 This option 3522 \f Bmay\fR3523 be useful for read -only filesystems which3524 \f Bmay\fR4151 \fImay\fR 4152 be useful for read\-only filesystems which 4153 \fImay\fR 3525 4154 not need locking (such as CDROM drives), although setting this parameter of 3526 4155 \fBno\fR 3527 is not really recommended even in this case .3528 .sp 3529 Be careful about disabling locking either globally or in a specific service, as lack of locking may result in data corruption . You should never need to set this parameter.3530 .sp 3531 \f BNo default\fR3532 .RE 3533 .PP 4156 is not really recommended even in this case\. 4157 .sp 4158 Be careful about disabling locking either globally or in a specific service, as lack of locking may result in data corruption\. You should never need to set this parameter\. 4159 .sp 4160 \fINo default\fR 4161 .RE 4162 3534 4163 lock spin count (G) 3535 .RS 3n 3536 This parameter has been made inoperative in Samba 3.0.24. The functionality it contolled is now controlled by the parameter 3537 lock spin time. 3538 .sp 3539 Default: 3540 \fB\fIlock spin count\fR = 0 \fR 3541 .RE 3542 .PP 4164 .PP 4165 .RS 4 4166 This parameter has been made inoperative in Samba 3\.0\.24\. The functionality it contolled is now controlled by the parameter 4167 \fIlock spin time\fR\. 4168 .sp 4169 Default: 4170 \fI\fIlock spin count\fR\fR\fI = \fR\fI0\fR\fI \fR 4171 .RE 4172 3543 4173 lock spin time (G) 3544 .RS 3n 3545 The time in microseconds that smbd should keep waiting to see if a failed lock request can be granted. This parameter has changed in default value from Samba 3.0.23 from 10 to 200. The associated 3546 lock spin count parameter is no longer used in Samba 3.0.24. You should not need to change the value of this parameter. 3547 .sp 3548 Default: 3549 \fB\fIlock spin time\fR = 200 \fR 3550 .RE 3551 .PP 4174 .PP 4175 .RS 4 4176 The time in microseconds that smbd should keep waiting to see if a failed lock request can be granted\. This parameter has changed in default value from Samba 3\.0\.23 from 10 to 200\. The associated 4177 \fIlock spin count\fR 4178 parameter is no longer used in Samba 3\.0\.24\. You should not need to change the value of this parameter\. 4179 .sp 4180 Default: 4181 \fI\fIlock spin time\fR\fR\fI = \fR\fI200\fR\fI \fR 4182 .RE 4183 3552 4184 log file (G) 3553 .RS 3n 3554 This option allows you to override the name of the Samba log file (also known as the debug file). 3555 .sp 3556 This option takes the standard substitutions, allowing you to have separate log files for each user or machine. 3557 .sp 3558 \fBNo default\fR 3559 .sp 3560 Example: 3561 \fB\fIlog file\fR = /usr/local/samba/var/log.%m \fR 3562 .RE 3563 .PP 3564 debuglevel 3565 .RS 3n 3566 This parameter is a synonym for log level. 3567 .RE 3568 .PP 4185 .PP 4186 .RS 4 4187 This option allows you to override the name of the Samba log file (also known as the debug file)\. 4188 .sp 4189 This option takes the standard substitutions, allowing you to have separate log files for each user or machine\. 4190 .sp 4191 \fINo default\fR 4192 .sp 4193 Example: 4194 \fI\fIlog file\fR\fR\fI = \fR\fI/usr/local/samba/var/log\.%m\fR\fI \fR 4195 .RE 4196 debuglevel.PP 4197 .RS 4 4198 This parameter is a synonym for 4199 log level\. 4200 .RE 4201 3569 4202 log level (G) 3570 .RS 3n 4203 .PP 4204 .RS 4 3571 4205 The value of the parameter (a astring) allows the debug level (logging level) to be specified in the 3572 \fIsmb.conf\fR 3573 file. This parameter has been extended since the 2.2.x series, now it allow to specify the debug level for multiple debug classes. This is to give greater flexibility in the configuration of the system. 3574 .sp 3575 The default will be the log level specified on the command line or level zero if none was specified. 3576 .sp 3577 \fBNo default\fR 3578 .sp 3579 Example: 3580 \fB\fIlog level\fR = 3 passdb:5 auth:10 winbind:2 \fR 3581 .RE 3582 .PP 4206 \fIsmb\.conf\fR 4207 file\. 4208 .sp 4209 This parameter has been extended since the 2\.2\.x series, now it allows to specify the debug level for multiple debug classes\. This is to give greater flexibility in the configuration of the system\. The following debug classes are currently implemented: 4210 .sp 4211 .RS 4 4212 .ie n \{\ 4213 \h'-04'\(bu\h'+03'\c 4214 .\} 4215 .el \{\ 4216 .sp -1 4217 .IP \(bu 2.3 4218 .\} 4219 \fIall\fR 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 .\} 4230 \fItdb\fR 4231 .RE 4232 .sp 4233 .RS 4 4234 .ie n \{\ 4235 \h'-04'\(bu\h'+03'\c 4236 .\} 4237 .el \{\ 4238 .sp -1 4239 .IP \(bu 2.3 4240 .\} 4241 \fIprintdrivers\fR 4242 .RE 4243 .sp 4244 .RS 4 4245 .ie n \{\ 4246 \h'-04'\(bu\h'+03'\c 4247 .\} 4248 .el \{\ 4249 .sp -1 4250 .IP \(bu 2.3 4251 .\} 4252 \fIlanman\fR 4253 .RE 4254 .sp 4255 .RS 4 4256 .ie n \{\ 4257 \h'-04'\(bu\h'+03'\c 4258 .\} 4259 .el \{\ 4260 .sp -1 4261 .IP \(bu 2.3 4262 .\} 4263 \fIsmb\fR 4264 .RE 4265 .sp 4266 .RS 4 4267 .ie n \{\ 4268 \h'-04'\(bu\h'+03'\c 4269 .\} 4270 .el \{\ 4271 .sp -1 4272 .IP \(bu 2.3 4273 .\} 4274 \fIrpc_parse\fR 4275 .RE 4276 .sp 4277 .RS 4 4278 .ie n \{\ 4279 \h'-04'\(bu\h'+03'\c 4280 .\} 4281 .el \{\ 4282 .sp -1 4283 .IP \(bu 2.3 4284 .\} 4285 \fIrpc_srv\fR 4286 .RE 4287 .sp 4288 .RS 4 4289 .ie n \{\ 4290 \h'-04'\(bu\h'+03'\c 4291 .\} 4292 .el \{\ 4293 .sp -1 4294 .IP \(bu 2.3 4295 .\} 4296 \fIrpc_cli\fR 4297 .RE 4298 .sp 4299 .RS 4 4300 .ie n \{\ 4301 \h'-04'\(bu\h'+03'\c 4302 .\} 4303 .el \{\ 4304 .sp -1 4305 .IP \(bu 2.3 4306 .\} 4307 \fIpassdb\fR 4308 .RE 4309 .sp 4310 .RS 4 4311 .ie n \{\ 4312 \h'-04'\(bu\h'+03'\c 4313 .\} 4314 .el \{\ 4315 .sp -1 4316 .IP \(bu 2.3 4317 .\} 4318 \fIsam\fR 4319 .RE 4320 .sp 4321 .RS 4 4322 .ie n \{\ 4323 \h'-04'\(bu\h'+03'\c 4324 .\} 4325 .el \{\ 4326 .sp -1 4327 .IP \(bu 2.3 4328 .\} 4329 \fIauth\fR 4330 .RE 4331 .sp 4332 .RS 4 4333 .ie n \{\ 4334 \h'-04'\(bu\h'+03'\c 4335 .\} 4336 .el \{\ 4337 .sp -1 4338 .IP \(bu 2.3 4339 .\} 4340 \fIwinbind\fR 4341 .RE 4342 .sp 4343 .RS 4 4344 .ie n \{\ 4345 \h'-04'\(bu\h'+03'\c 4346 .\} 4347 .el \{\ 4348 .sp -1 4349 .IP \(bu 2.3 4350 .\} 4351 \fIvfs\fR 4352 .RE 4353 .sp 4354 .RS 4 4355 .ie n \{\ 4356 \h'-04'\(bu\h'+03'\c 4357 .\} 4358 .el \{\ 4359 .sp -1 4360 .IP \(bu 2.3 4361 .\} 4362 \fIidmap\fR 4363 .RE 4364 .sp 4365 .RS 4 4366 .ie n \{\ 4367 \h'-04'\(bu\h'+03'\c 4368 .\} 4369 .el \{\ 4370 .sp -1 4371 .IP \(bu 2.3 4372 .\} 4373 \fIquota\fR 4374 .RE 4375 .sp 4376 .RS 4 4377 .ie n \{\ 4378 \h'-04'\(bu\h'+03'\c 4379 .\} 4380 .el \{\ 4381 .sp -1 4382 .IP \(bu 2.3 4383 .\} 4384 \fIacls\fR 4385 .RE 4386 .sp 4387 .RS 4 4388 .ie n \{\ 4389 \h'-04'\(bu\h'+03'\c 4390 .\} 4391 .el \{\ 4392 .sp -1 4393 .IP \(bu 2.3 4394 .\} 4395 \fIlocking\fR 4396 .RE 4397 .sp 4398 .RS 4 4399 .ie n \{\ 4400 \h'-04'\(bu\h'+03'\c 4401 .\} 4402 .el \{\ 4403 .sp -1 4404 .IP \(bu 2.3 4405 .\} 4406 \fImsdfs\fR 4407 .RE 4408 .sp 4409 .RS 4 4410 .ie n \{\ 4411 \h'-04'\(bu\h'+03'\c 4412 .\} 4413 .el \{\ 4414 .sp -1 4415 .IP \(bu 2.3 4416 .\} 4417 \fIdmapi\fR 4418 .RE 4419 .sp 4420 .RS 4 4421 .ie n \{\ 4422 \h'-04'\(bu\h'+03'\c 4423 .\} 4424 .el \{\ 4425 .sp -1 4426 .IP \(bu 2.3 4427 .\} 4428 \fIregistry\fR 4429 .sp 4430 .RE 4431 Default: 4432 \fI\fIlog level\fR\fR\fI = \fR\fI0\fR\fI \fR 4433 .sp 4434 Example: 4435 \fI\fIlog level\fR\fR\fI = \fR\fI3 passdb:5 auth:10 winbind:2\fR\fI \fR 4436 .RE 4437 3583 4438 logon drive (G) 3584 .RS 3n 4439 .PP 4440 .RS 4 3585 4441 This parameter specifies the local path to which the home directory will be connected (see 3586 logon home) and is only used by NT Workstations.3587 .sp 3588 Note that this option is only useful if Samba is set up as a logon server .3589 .sp 3590 Default: 3591 \f B\fIlogon drive\fR =\fR3592 .sp 3593 Example: 3594 \f B\fIlogon drive\fR = h:\fR3595 .RE 3596 .PP 4442 \fIlogon home\fR) and is only used by NT Workstations\. 4443 .sp 4444 Note that this option is only useful if Samba is set up as a logon server\. 4445 .sp 4446 Default: 4447 \fI\fIlogon drive\fR\fR\fI = \fR\fI\fR\fI \fR 4448 .sp 4449 Example: 4450 \fI\fIlogon drive\fR\fR\fI = \fR\fIh:\fR\fI \fR 4451 .RE 4452 3597 4453 logon home (G) 3598 .RS 3n 3599 This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC. It allows you to do 3600 .sp 3601 3602 C:\>\fBNET USE H: /HOME\fR 3603 .sp 3604 from a command prompt, for example. 3605 .sp 3606 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine. 3607 .sp 3608 This parameter can be used with Win9X workstations to ensure that roaming profiles are stored in a subdirectory of the user's home directory. This is done in the following way: 3609 .sp 3610 3611 logon home = \\\\%N\\%U\\profile 3612 .sp 3613 This tells Samba to return the above string, with substitutions made when a client requests the info, generally in a NetUserGetInfo request. Win9X clients truncate the info to \\server\share when a user does 4454 .PP 4455 .RS 4 4456 This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC\. It allows you to do 4457 .sp 4458 4459 C:\e>\fBNET USE H: /HOME\fR 4460 .sp 4461 from a command prompt, for example\. 4462 .sp 4463 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\. 4464 .sp 4465 This parameter can be used with Win9X workstations to ensure that roaming profiles are stored in a subdirectory of the user\'s home directory\. This is done in the following way: 4466 .sp 4467 4468 logon home = \e\e%N\e%U\eprofile 4469 .sp 4470 This tells Samba to return the above string, with substitutions made when a client requests the info, generally in a NetUserGetInfo request\. Win9X clients truncate the info to \e\eserver\eshare when a user does 3614 4471 net use /home 3615 but use the whole string when dealing with profiles .4472 but use the whole string when dealing with profiles\. 3616 4473 .sp 3617 4474 Note that in prior versions of Samba, the 3618 logon path was returned rather than 3619 \fIlogon home\fR. This broke 4475 \fIlogon path\fR 4476 was returned rather than 4477 \fIlogon home\fR\. This broke 3620 4478 net use /home 3621 but allowed profiles outside the home directory . The current implementation is correct, and can be used for profiles if you use the above trick.4479 but allowed profiles outside the home directory\. The current implementation is correct, and can be used for profiles if you use the above trick\. 3622 4480 .sp 3623 4481 Disable this feature by setting 3624 logon home = "" - using the empty string. 3625 .sp 3626 This option is only useful if Samba is set up as a logon server. 3627 .sp 3628 Default: 3629 \fB\fIlogon home\fR = \\\\%N\\%U \fR 3630 .sp 3631 Example: 3632 \fB\fIlogon home\fR = \\\\remote_smb_server\\%U \fR 3633 .RE 3634 .PP 4482 \fIlogon home = ""\fR 4483 \- using the empty string\. 4484 .sp 4485 This option is only useful if Samba is set up as a logon server\. 4486 .sp 4487 Default: 4488 \fI\fIlogon home\fR\fR\fI = \fR\fI\e\e%N\e%U\fR\fI \fR 4489 .sp 4490 Example: 4491 \fI\fIlogon home\fR\fR\fI = \fR\fI\e\eremote_smb_server\e%U\fR\fI \fR 4492 .RE 4493 3635 4494 logon path (G) 3636 .RS 3n 3637 This parameter specifies the directory where roaming profiles (Desktop, NTuser.dat, etc) are stored. Contrary to previous versions of these manual pages, it has nothing to do with Win 9X roaming profiles. To find out how to handle roaming profiles for Win 9X system, see the 3638 logon home parameter. 3639 .sp 3640 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine. It also specifies the directory from which the "Application Data", 4495 .PP 4496 .RS 4 4497 This parameter specifies the directory where roaming profiles (Desktop, NTuser\.dat, etc) are stored\. Contrary to previous versions of these manual pages, it has nothing to do with Win 9X roaming profiles\. To find out how to handle roaming profiles for Win 9X system, see the 4498 \fIlogon home\fR 4499 parameter\. 4500 .sp 4501 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\. It also specifies the directory from which the "Application Data", 3641 4502 \fIdesktop\fR, 3642 4503 \fIstart menu\fR, 3643 4504 \fInetwork neighborhood\fR, 3644 4505 \fIprograms\fR 3645 and other folders, and their contents, are loaded and displayed on your Windows NT client .3646 .sp 3647 The share and the path must be readable by the user for the preferences and directories to be loaded onto the Windows NT client . The share must be writeable when the user logs in for the first time, in order that the Windows NT client can create the NTuser.dat and other directories. Thereafter, the directories and any of the contents can, if required, be made read-only. It is not advisable that the NTuser.dat file be made read-only - rename it to NTuser.man to achieve the desired effect (a3648 \f BMAN\fRdatory profile).3649 .sp 3650 Windows clients can sometimes maintain a connection to the [homes] share, even though there is no user logged in . Therefore, it is vital that the logon path does not include a reference to the homes share (i.e. setting this parameter to \\%N\homes\profile_path will cause problems).3651 .sp 3652 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine .4506 and other folders, and their contents, are loaded and displayed on your Windows NT client\. 4507 .sp 4508 The share and the path must be readable by the user for the preferences and directories to be loaded onto the Windows NT client\. The share must be writeable when the user logs in for the first time, in order that the Windows NT client can create the NTuser\.dat and other directories\. Thereafter, the directories and any of the contents can, if required, be made read\-only\. It is not advisable that the NTuser\.dat file be made read\-only \- rename it to NTuser\.man to achieve the desired effect (a 4509 \fIMAN\fRdatory profile)\. 4510 .sp 4511 Windows clients can sometimes maintain a connection to the [homes] share, even though there is no user logged in\. Therefore, it is vital that the logon path does not include a reference to the homes share (i\.e\. setting this parameter to \e\e%N\ehomes\eprofile_path will cause problems)\. 4512 .sp 4513 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\. 3653 4514 .sp 3654 4515 .it 1 an-trap … … 3656 4517 .nr an-break-flag 1 3657 4518 .br 3658 \fBWarning\fR 3659 Do not quote the value. Setting this as 3660 \fB\\%N\profile\%U\fR 3661 will break profile handling. Where the tdbsam or ldapsam passdb backend is used, at the time the user account is created the value configured for this parameter is written to the passdb backend and that value will over-ride the parameter value present in the smb.conf file. Any error present in the passdb backend account record must be editted using the appropriate tool (pdbedit on the command-line, or any other locally provided system tool). 3662 Note that this option is only useful if Samba is set up as a domain controller. 3663 .sp 3664 Disable the use of roaming profiles by setting the value of this parameter to the empty string. For example, 3665 logon path = "". 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. 4519 Warning 4520 Do not quote the value\. Setting this as 4521 \(lq\e\e%N\eprofile\e%U\(rq 4522 will break profile handling\. Where the tdbsam or ldapsam passdb backend is used, at the time the user account is created the value configured for this parameter is written to the passdb backend and that value will over\-ride the parameter value present in the smb\.conf file\. Any error present in the passdb backend account record must be editted using the appropriate tool (pdbedit on the command\-line, or any other locally provided system tool)\. 4523 4524 Note that this option is only useful if Samba is set up as a domain controller\. 4525 .sp 4526 Disable the use of roaming profiles by setting the value of this parameter to the empty string\. For example, 4527 \fIlogon path = ""\fR\. Take note that even if the default setting in the smb\.conf file is the empty string, any value specified in the user account settings in the passdb backend will over\-ride the effect of setting this parameter to null\. Disabling of all roaming profile use requires that the user account settings must also be blank\. 3666 4528 .sp 3667 4529 An example of use is: 3668 3669 .sp 3670 4530 .sp 4531 .RS 4 3671 4532 .nf 3672 3673 logon path = \\PROFILESERVER\PROFILE\%U 3674 4533 logon path = \e\ePROFILESERVER\ePROFILE\e%U 3675 4534 .fi 3676 3677 .sp 3678 Default: 3679 \fB\fIlogon path\fR = \\\\%N\\%U\\profile \fR 3680 .RE 3681 .PP 4535 .RE 4536 .sp 4537 .sp 4538 Default: 4539 \fI\fIlogon path\fR\fR\fI = \fR\fI\e\e%N\e%U\eprofile\fR\fI \fR 4540 .RE 4541 3682 4542 logon script (G) 3683 .RS 3n 3684 This parameter specifies the batch file (\fI.bat\fR) or NT command file (\fI.cmd\fR) to be downloaded and run on a machine when a user successfully logs in. The file must contain the DOS style CR/LF line endings. Using a DOS-style editor to create the file is recommended. 4543 .PP 4544 .RS 4 4545 This parameter specifies the batch file (\fI\.bat\fR) or NT command file (\fI\.cmd\fR) to be downloaded and run on a machine when a user successfully logs in\. The file must contain the DOS style CR/LF line endings\. Using a DOS\-style editor to create the file is recommended\. 3685 4546 .sp 3686 4547 The script must be a relative path to the 3687 4548 \fI[netlogon]\fR 3688 service. If the [netlogon] service specifies a 3689 path of 4549 service\. If the [netlogon] service specifies a 4550 \fIpath\fR 4551 of 3690 4552 \fI/usr/local/samba/netlogon\fR, and 3691 logon script = STARTUP.BAT, then the file that will be downloaded is: 3692 3693 .sp 3694 4553 \fIlogon script = STARTUP\.BAT\fR, then the file that will be downloaded is: 4554 .sp 4555 .RS 4 3695 4556 .nf 3696 3697 /usr/local/samba/netlogon/STARTUP.BAT 3698 4557 /usr/local/samba/netlogon/STARTUP\.BAT 3699 4558 .fi 3700 3701 .sp 3702 The contents of the batch file are entirely your choice. A suggested command would be to add 3703 NET TIME \\\\SERVER /SET /YES, to force every machine to synchronize clocks with the same time server. Another use would be to add 3704 NET USE U: \\\\SERVER\\UTILS 4559 .RE 4560 .sp 4561 .sp 4562 The contents of the batch file are entirely your choice\. A suggested command would be to add 4563 NET TIME \e\eSERVER /SET /YES, to force every machine to synchronize clocks with the same time server\. Another use would be to add 4564 NET USE U: \e\eSERVER\eUTILS 3705 4565 for commonly used utilities, or 3706 3707 .sp 3708 4566 .sp 4567 .RS 4 3709 4568 .nf 3710 3711 \fBNET USE Q: \\SERVER\ISO9001_QA\fR 3712 4569 \fBNET USE Q: \e\eSERVER\eISO9001_QA\fR 3713 4570 .fi 3714 for example. 3715 .sp 3716 Note that it is particularly important not to allow write access to the [netlogon] share, or to grant users write permission on the batch files in a secure environment, as this would allow the batch files to be arbitrarily modified and security to be breached. 3717 .sp 3718 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine. 3719 .sp 3720 This option is only useful if Samba is set up as a logon server. 3721 .sp 3722 Default: 3723 \fB\fIlogon script\fR = \fR 3724 .sp 3725 Example: 3726 \fB\fIlogon script\fR = scripts\\%U.bat \fR 3727 .RE 3728 .PP 4571 .RE 4572 .sp 4573 for example\. 4574 .sp 4575 Note that it is particularly important not to allow write access to the [netlogon] share, or to grant users write permission on the batch files in a secure environment, as this would allow the batch files to be arbitrarily modified and security to be breached\. 4576 .sp 4577 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\. 4578 .sp 4579 This option is only useful if Samba is set up as a logon server\. 4580 .sp 4581 Default: 4582 \fI\fIlogon script\fR\fR\fI = \fR\fI\fR\fI \fR 4583 .sp 4584 Example: 4585 \fI\fIlogon script\fR\fR\fI = \fR\fIscripts\e%U\.bat\fR\fI \fR 4586 .RE 4587 3729 4588 lppause command (S) 3730 .RS 3n 3731 This parameter specifies the command to be executed on the server host in order to stop printing or spooling a specific print job. 3732 .sp 3733 This command should be a program or script which takes a printer name and job number to pause the print job. One way of implementing this is by using job priorities, where jobs having a too low priority won't be sent to the printer. 4589 .PP 4590 .RS 4 4591 This parameter specifies the command to be executed on the server host in order to stop printing or spooling a specific print job\. 4592 .sp 4593 This command should be a program or script which takes a printer name and job number to pause the print job\. One way of implementing this is by using job priorities, where jobs having a too low priority won\'t be sent to the printer\. 3734 4594 .sp 3735 4595 If a 3736 4596 \fI%p\fR 3737 is given then the printer name is put in its place . A4597 is given then the printer name is put in its place\. A 3738 4598 \fI%j\fR 3739 is replaced with the job number (an integer) . On HPUX (see4599 is replaced with the job number (an integer)\. On HPUX (see 3740 4600 \fIprinting=hpux \fR), if the 3741 \fI -p%p\fR3742 option is added to the lpq command, the job will show up with the correct status, i .e. if the job priority is lower than the set fence priority it will have the PAUSED status, whereas if the priority is equal or higher it will have the SPOOLED or PRINTING status.3743 .sp 3744 Note that it is good practice to include the absolute path in the lppause command as the PATH may not be available to the server .3745 .sp 3746 Default: 3747 \f B\fIlppause command\fR = # Currently no default value is given to this string, unless the value of the printing 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.\fR3748 .sp 3749 Example: 3750 \f B\fIlppause command\fR = /usr/bin/lpalt %p-%j -p0\fR3751 .RE 3752 .PP 4601 \fI\-p%p\fR 4602 option is added to the lpq command, the job will show up with the correct status, i\.e\. if the job priority is lower than the set fence priority it will have the PAUSED status, whereas if the priority is equal or higher it will have the SPOOLED or PRINTING status\. 4603 .sp 4604 Note that it is good practice to include the absolute path in the lppause command as the PATH may not be available to the server\. 4605 .sp 4606 Default: 4607 \fI\fIlppause command\fR\fR\fI = \fR\fI # Currently no default value is given to this string, unless the value of the \fIprinting\fR parameter is \fBSYSV\fR, in which case the default is : lp \-i %p\-%j \-H hold or if the value of the \fIprinting\fR parameter is \fBSOFTQ\fR, then the default is: qstat \-s \-j%j \-h\. \fR\fI \fR 4608 .sp 4609 Example: 4610 \fI\fIlppause command\fR\fR\fI = \fR\fI/usr/bin/lpalt %p\-%j \-p0\fR\fI \fR 4611 .RE 4612 3753 4613 lpq cache time (G) 3754 .RS 3n 4614 .PP 4615 .RS 4 3755 4616 This controls how long lpq info will be cached for to prevent the 3756 4617 lpq 3757 command being called too often . A separate cache is kept for each variation of the4618 command being called too often\. A separate cache is kept for each variation of the 3758 4619 lpq 3759 4620 command used by the system, so if you use different 3760 4621 lpq 3761 commands for different users then they won 't share cache information.4622 commands for different users then they won\'t share cache information\. 3762 4623 .sp 3763 4624 The cache files are stored in 3764 \fI/tmp/lpq .xxxx\fR4625 \fI/tmp/lpq\.xxxx\fR 3765 4626 where xxxx is a hash of the 3766 4627 lpq 3767 command in use .4628 command in use\. 3768 4629 .sp 3769 4630 The default is 30 seconds, meaning that the cached results of a previous identical 3770 4631 lpq 3771 command will be used if the cached data is less than 30 seconds old . A large value may be advisable if your4632 command will be used if the cached data is less than 30 seconds old\. A large value may be advisable if your 3772 4633 lpq 3773 command is very slow .3774 .sp 3775 A value of 0 will disable caching completely .3776 .sp 3777 Default: 3778 \f B\fIlpq cache time\fR = 30\fR3779 .sp 3780 Example: 3781 \f B\fIlpq cache time\fR = 10\fR3782 .RE 3783 .PP 4634 command is very slow\. 4635 .sp 4636 A value of 0 will disable caching completely\. 4637 .sp 4638 Default: 4639 \fI\fIlpq cache time\fR\fR\fI = \fR\fI30\fR\fI \fR 4640 .sp 4641 Example: 4642 \fI\fIlpq cache time\fR\fR\fI = \fR\fI10\fR\fI \fR 4643 .RE 4644 3784 4645 lpq command (S) 3785 .RS 3n 4646 .PP 4647 .RS 4 3786 4648 This parameter specifies the command to be executed on the server host in order to obtain 3787 lpq -style printer status information.3788 .sp 3789 This command should be a program or script which takes a printer name as its only parameter and outputs printer status information .3790 .sp 3791 Currently nine styles of printer status information are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ . This covers most UNIX systems. You control which type is expected using the4649 lpq\-style printer status information\. 4650 .sp 4651 This command should be a program or script which takes a printer name as its only parameter and outputs printer status information\. 4652 .sp 4653 Currently nine styles of printer status information are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ\. This covers most UNIX systems\. You control which type is expected using the 3792 4654 \fIprinting =\fR 3793 option .3794 .sp 3795 Some clients (notably Windows for Workgroups) may not correctly send the connection number for the printer they are requesting status information about . To get around this, the server reports on the first printer service connected to by the client. This only happens if the connection number sent is invalid.4655 option\. 4656 .sp 4657 Some clients (notably Windows for Workgroups) may not correctly send the connection number for the printer they are requesting status information about\. To get around this, the server reports on the first printer service connected to by the client\. This only happens if the connection number sent is invalid\. 3796 4658 .sp 3797 4659 If a 3798 4660 \fI%p\fR 3799 is given then the printer name is put in its place . Otherwise it is placed at the end of the command.4661 is given then the printer name is put in its place\. Otherwise it is placed at the end of the command\. 3800 4662 .sp 3801 4663 Note that it is good practice to include the absolute path in the … … 3803 4665 as the 3804 4666 \fB$PATH \fR 3805 may not be available to the server . When compiled with the CUPS libraries, no4667 may not be available to the server\. When compiled with the CUPS libraries, no 3806 4668 \fIlpq command\fR 3807 is needed because smbd will make a library call to obtain the print queue listing .3808 .sp 3809 Default: 3810 \f B\fIlpq command\fR =\fR3811 .sp 3812 Example: 3813 \f B\fIlpq command\fR = /usr/bin/lpq -P%p\fR3814 .RE 3815 .PP 4669 is needed because smbd will make a library call to obtain the print queue listing\. 4670 .sp 4671 Default: 4672 \fI\fIlpq command\fR\fR\fI = \fR\fI\fR\fI \fR 4673 .sp 4674 Example: 4675 \fI\fIlpq command\fR\fR\fI = \fR\fI/usr/bin/lpq \-P%p\fR\fI \fR 4676 .RE 4677 3816 4678 lpresume command (S) 3817 .RS 3n 3818 This parameter specifies the command to be executed on the server host in order to restart or continue printing or spooling a specific print job. 3819 .sp 3820 This command should be a program or script which takes a printer name and job number to resume the print job. See also the 3821 lppause command parameter. 4679 .PP 4680 .RS 4 4681 This parameter specifies the command to be executed on the server host in order to restart or continue printing or spooling a specific print job\. 4682 .sp 4683 This command should be a program or script which takes a printer name and job number to resume the print job\. See also the 4684 \fIlppause command\fR 4685 parameter\. 3822 4686 .sp 3823 4687 If a 3824 4688 \fI%p\fR 3825 is given then the printer name is put in its place . A4689 is given then the printer name is put in its place\. A 3826 4690 \fI%j\fR 3827 is replaced with the job number (an integer) .4691 is replaced with the job number (an integer)\. 3828 4692 .sp 3829 4693 Note that it is good practice to include the absolute path in the 3830 4694 \fIlpresume command\fR 3831 as the PATH may not be available to the server .4695 as the PATH may not be available to the server\. 3832 4696 .sp 3833 4697 See also the 3834 printing parameter. 4698 \fIprinting\fR 4699 parameter\. 3835 4700 .sp 3836 4701 Default: Currently no default value is given to this string, unless the value of the 3837 4702 \fIprinting\fR 3838 4703 parameter is 3839 \fBSYSV\fR, in which case the default is 3840 .sp 3841 lp -i %p-%j-H resume4704 \fBSYSV\fR, in which case the default is: 4705 .sp 4706 lp \-i %p\-%j \-H resume 3842 4707 .sp 3843 4708 or if the value of the … … 3846 4711 \fBSOFTQ\fR, then the default is: 3847 4712 .sp 3848 qstat -s -j%j -r 3849 .sp 3850 Default: 3851 \fB\fIlpresume command\fR = lpresume command = /usr/bin/lpalt %p-%j -p2 \fR 3852 .RE 3853 .PP 4713 qstat \-s \-j%j \-r 4714 .sp 4715 \fINo default\fR 4716 .sp 4717 Example: 4718 \fI\fIlpresume command\fR\fR\fI = \fR\fI/usr/bin/lpalt %p\-%j \-p2\fR\fI \fR 4719 .RE 4720 3854 4721 lprm command (S) 3855 .RS 3n 3856 This parameter specifies the command to be executed on the server host in order to delete a print job. 3857 .sp 3858 This command should be a program or script which takes a printer name and job number, and deletes the print job. 4722 .PP 4723 .RS 4 4724 This parameter specifies the command to be executed on the server host in order to delete a print job\. 4725 .sp 4726 This command should be a program or script which takes a printer name and job number, and deletes the print job\. 3859 4727 .sp 3860 4728 If a 3861 4729 \fI%p\fR 3862 is given then the printer name is put in its place . A4730 is given then the printer name is put in its place\. A 3863 4731 \fI%j\fR 3864 is replaced with the job number (an integer) .4732 is replaced with the job number (an integer)\. 3865 4733 .sp 3866 4734 Note that it is good practice to include the absolute path in the 3867 4735 \fIlprm command\fR 3868 as the PATH may not be available to the server .4736 as the PATH may not be available to the server\. 3869 4737 .sp 3870 4738 Examples of use are: 3871 3872 .sp 3873 4739 .sp 4740 .RS 4 3874 4741 .nf 3875 3876 lprm command = /usr/bin/lprm -P%p %j 4742 lprm command = /usr/bin/lprm \-P%p %j 3877 4743 3878 4744 or 3879 4745 3880 lprm command = /usr/bin/cancel %p-%j 3881 4746 lprm command = /usr/bin/cancel %p\-%j 3882 4747 .fi 3883 3884 .sp 3885 Default: 3886 \fB\fIlprm command\fR = determined by printing parameter \fR 3887 .RE 3888 .PP 4748 .RE 4749 .sp 4750 .sp 4751 Default: 4752 \fI\fIlprm command\fR\fR\fI = \fR\fI determined by printing parameter\fR\fI \fR 4753 .RE 4754 3889 4755 machine password timeout (G) 3890 .RS 3n 4756 .PP 4757 .RS 4 3891 4758 If a Samba server is a member of a Windows NT Domain (see the 3892 security = domain parameter) then periodically a running smbd process will try and change the MACHINE ACCOUNT PASSWORD stored in the TDB called 3893 \fIprivate/secrets.tdb \fR. This parameter specifies how often this password will be changed, in seconds. The default is one week (expressed in seconds), the same as a Windows NT Domain member server. 4759 \fIsecurity = domain\fR 4760 parameter) then periodically a running smbd process will try and change the MACHINE ACCOUNT PASSWORD stored in the TDB called 4761 \fIprivate/secrets\.tdb \fR\. This parameter specifies how often this password will be changed, in seconds\. The default is one week (expressed in seconds), the same as a Windows NT Domain member server\. 3894 4762 .sp 3895 4763 See also 3896 4764 \fBsmbpasswd\fR(8), and the 3897 security = domain parameter. 3898 .sp 3899 Default: 3900 \fB\fImachine password timeout\fR = 604800 \fR 3901 .RE 3902 .PP 4765 \fIsecurity = domain\fR 4766 parameter\. 4767 .sp 4768 Default: 4769 \fI\fImachine password timeout\fR\fR\fI = \fR\fI604800\fR\fI \fR 4770 .RE 4771 3903 4772 magic output (S) 3904 .RS 3n 4773 .PP 4774 .RS 4 3905 4775 This parameter specifies the name of a file which will contain output created by a magic script (see the 3906 magic script parameter below). 4776 \fImagic script\fR 4777 parameter below)\. 3907 4778 .sp 3908 4779 .it 1 an-trap … … 3910 4781 .nr an-break-flag 1 3911 4782 .br 3912 \fBWarning\fR 4783 Warning 3913 4784 If two clients use the same 3914 4785 \fImagic script \fR 3915 in the same directory the output file content is undefined. 3916 Default: 3917 \fB\fImagic output\fR = <magic script name>.out \fR 3918 .sp 3919 Example: 3920 \fB\fImagic output\fR = myfile.txt \fR 3921 .RE 3922 .PP 4786 in the same directory the output file content is undefined\. 4787 4788 Default: 4789 \fI\fImagic output\fR\fR\fI = \fR\fI<magic script name>\.out\fR\fI \fR 4790 .sp 4791 Example: 4792 \fI\fImagic output\fR\fR\fI = \fR\fImyfile\.txt\fR\fI \fR 4793 .RE 4794 3923 4795 magic script (S) 3924 .RS 3n 3925 This parameter specifies the name of a file which, if opened, will be executed by the server when the file is closed. This allows a UNIX script to be sent to the Samba host and executed on behalf of the connected user. 3926 .sp 3927 Scripts executed in this way will be deleted upon completion assuming that the user has the appropriate level of privilege and the file permissions allow the deletion. 4796 .PP 4797 .RS 4 4798 This parameter specifies the name of a file which, if opened, will be executed by the server when the file is closed\. This allows a UNIX script to be sent to the Samba host and executed on behalf of the connected user\. 4799 .sp 4800 Scripts executed in this way will be deleted upon completion assuming that the user has the appropriate level of privilege and the file permissions allow the deletion\. 3928 4801 .sp 3929 4802 If the script generates output, output will be sent to the file specified by the 3930 magic output parameter (see above). 3931 .sp 3932 Note that some shells are unable to interpret scripts containing CR/LF instead of CR as the end-of-line marker. Magic scripts must be executable 3933 \fBas is\fR 3934 on the host, which for some hosts and some shells will require filtering at the DOS end. 4803 \fImagic output\fR 4804 parameter (see above)\. 4805 .sp 4806 Note that some shells are unable to interpret scripts containing CR/LF instead of CR as the end\-of\-line marker\. Magic scripts must be executable 4807 \fIas is\fR 4808 on the host, which for some hosts and some shells will require filtering at the DOS end\. 3935 4809 .sp 3936 4810 Magic scripts are 3937 \f BEXPERIMENTAL\fR4811 \fIEXPERIMENTAL\fR 3938 4812 and should 3939 \f BNOT\fR3940 be relied upon .3941 .sp 3942 Default: 3943 \f B\fImagic script\fR =\fR3944 .sp 3945 Example: 3946 \f B\fImagic script\fR = user.csh\fR3947 .RE 3948 .PP 4813 \fINOT\fR 4814 be relied upon\. 4815 .sp 4816 Default: 4817 \fI\fImagic script\fR\fR\fI = \fR\fI\fR\fI \fR 4818 .sp 4819 Example: 4820 \fI\fImagic script\fR\fR\fI = \fR\fIuser\.csh\fR\fI \fR 4821 .RE 4822 3949 4823 mangled map (S) 3950 .RS 3n 3951 This is for those who want to directly map UNIX file names which cannot be represented on Windows/DOS. The mangling of names is not always what is needed. In particular you may have documents with file extensions that differ between DOS and UNIX. For example, under UNIX it is common to use 3952 \fI.html\fR 4824 .PP 4825 .RS 4 4826 This is for those who want to directly map UNIX file names which cannot be represented on Windows/DOS\. The mangling of names is not always what is needed\. In particular you may have documents with file extensions that differ between DOS and UNIX\. For example, under UNIX it is common to use 4827 \fI\.html\fR 3953 4828 for HTML files, whereas under Windows/DOS 3954 \fI .htm\fR3955 is more commonly used .4829 \fI\.htm\fR 4830 is more commonly used\. 3956 4831 .sp 3957 4832 So to map … … 3962 4837 .sp 3963 4838 3964 mangled map = (*.html *.htm).4839 \fImangled map = (*\.html *\.htm)\fR\. 3965 4840 .sp 3966 4841 One very useful case is to remove the annoying 3967 4842 \fI;1\fR 3968 off the ends of filenames on some CDROMs (only visible under some UNIXes) . To do this use a map of (*;1 *;).3969 .sp 3970 Default: 3971 \f B\fImangled map\fR = # no mangled map\fR3972 .sp 3973 Example: 3974 \f B\fImangled map\fR = (*;1 *;)\fR3975 .RE 3976 .PP 4843 off the ends of filenames on some CDROMs (only visible under some UNIXes)\. To do this use a map of (*;1 *;)\. 4844 .sp 4845 Default: 4846 \fI\fImangled map\fR\fR\fI = \fR\fI # no mangled map\fR\fI \fR 4847 .sp 4848 Example: 4849 \fI\fImangled map\fR\fR\fI = \fR\fI(*;1 *;)\fR\fI \fR 4850 .RE 4851 3977 4852 mangled names (S) 3978 .RS 3n 3979 This controls whether non-DOS names under UNIX should be mapped to DOS-compatible names ("mangled") and made visible, or whether non-DOS names should simply be ignored. 4853 .PP 4854 .RS 4 4855 This controls whether non\-DOS names under UNIX should be mapped to DOS\-compatible names ("mangled") and made visible, or whether non\-DOS names should simply be ignored\. 3980 4856 .sp 3981 4857 See the section on 3982 name mangling for details on how to control the mangling process. 4858 \fIname mangling\fR 4859 for details on how to control the mangling process\. 3983 4860 .sp 3984 4861 If mangling is used then the mangling algorithm is as follows: 3985 .RS 3n 3986 .TP 3n 3987 \(bu 3988 The first (up to) five alphanumeric characters before the rightmost dot of the filename are preserved, forced to upper case, and appear as the first (up to) five characters of the mangled name. 3989 .TP 3n 3990 \(bu 3991 A tilde "~" is appended to the first part of the mangled name, followed by a two-character unique sequence, based on the original root name (i.e., the original filename minus its final extension). The final extension is included in the hash calculation only if it contains any upper case characters or is longer than three characters. 4862 .sp 4863 .RS 4 4864 .ie n \{\ 4865 \h'-04'\(bu\h'+03'\c 4866 .\} 4867 .el \{\ 4868 .sp -1 4869 .IP \(bu 2.3 4870 .\} 4871 The first (up to) five alphanumeric characters before the rightmost dot of the filename are preserved, forced to upper case, and appear as the first (up to) five characters of the mangled name\. 4872 .RE 4873 .sp 4874 .RS 4 4875 .ie n \{\ 4876 \h'-04'\(bu\h'+03'\c 4877 .\} 4878 .el \{\ 4879 .sp -1 4880 .IP \(bu 2.3 4881 .\} 4882 A tilde "~" is appended to the first part of the mangled name, followed by a two\-character unique sequence, based on the original root name (i\.e\., the original filename minus its final extension)\. The final extension is included in the hash calculation only if it contains any upper case characters or is longer than three characters\. 3992 4883 .sp 3993 4884 Note that the character to use may be specified using the 3994 mangling char option, if you don't like '~'. 3995 .TP 3n 3996 \(bu 3997 Files whose UNIX name begins with a dot will be presented as DOS hidden files. The mangled name will be created as for other filenames, but with the leading dot removed and "___" as its extension regardless of actual original extension (that's three underscores). 3998 .RE 3999 .IP "" 3n 4000 The two-digit hash value consists of upper case alphanumeric characters. 4001 .sp 4002 This algorithm can cause name collisions only if files in a directory share the same first five alphanumeric characters. The probability of such a clash is 1/1300. 4003 .sp 4004 The name mangling (if enabled) allows a file to be copied between UNIX directories from Windows/DOS while retaining the long UNIX filename. UNIX files can be renamed to a new extension from Windows/DOS and will retain the same basename. Mangled names do not change between sessions. 4005 .sp 4006 Default: 4007 \fB\fImangled names\fR = yes \fR 4008 .RE 4009 .PP 4885 \fImangling char\fR 4886 option, if you don\'t like \'~\'\. 4887 .RE 4888 .sp 4889 .RS 4 4890 .ie n \{\ 4891 \h'-04'\(bu\h'+03'\c 4892 .\} 4893 .el \{\ 4894 .sp -1 4895 .IP \(bu 2.3 4896 .\} 4897 Files whose UNIX name begins with a dot will be presented as DOS hidden files\. The mangled name will be created as for other filenames, but with the leading dot removed and "___" as its extension regardless of actual original extension (that\'s three underscores)\. 4898 .sp 4899 .RE 4900 The two\-digit hash value consists of upper case alphanumeric characters\. 4901 .sp 4902 This algorithm can cause name collisions only if files in a directory share the same first five alphanumeric characters\. The probability of such a clash is 1/1300\. 4903 .sp 4904 The name mangling (if enabled) allows a file to be copied between UNIX directories from Windows/DOS while retaining the long UNIX filename\. UNIX files can be renamed to a new extension from Windows/DOS and will retain the same basename\. Mangled names do not change between sessions\. 4905 .sp 4906 Default: 4907 \fI\fImangled names\fR\fR\fI = \fR\fIyes\fR\fI \fR 4908 .RE 4909 4010 4910 mangle prefix (G) 4011 .RS 3n 4012 controls the number of prefix characters from the original name used when generating the mangled names. A larger value will give a weaker hash and therefore more name collisions. The minimum value is 1 and the maximum value is 6. 4013 .sp 4014 mangle prefix is effective only when mangling method is hash2. 4015 .sp 4016 Default: 4017 \fB\fImangle prefix\fR = 1 \fR 4018 .sp 4019 Example: 4020 \fB\fImangle prefix\fR = 4 \fR 4021 .RE 4022 .PP 4911 .PP 4912 .RS 4 4913 controls the number of prefix characters from the original name used when generating the mangled names\. A larger value will give a weaker hash and therefore more name collisions\. The minimum value is 1 and the maximum value is 6\. 4914 .sp 4915 mangle prefix is effective only when mangling method is hash2\. 4916 .sp 4917 Default: 4918 \fI\fImangle prefix\fR\fR\fI = \fR\fI1\fR\fI \fR 4919 .sp 4920 Example: 4921 \fI\fImangle prefix\fR\fR\fI = \fR\fI4\fR\fI \fR 4922 .RE 4923 4023 4924 mangling char (S) 4024 .RS 3n 4925 .PP 4926 .RS 4 4025 4927 This controls what character is used as the 4026 \f Bmagic\fR4928 \fImagic\fR 4027 4929 character in 4028 name mangling. 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.4029 .sp 4030 Default: 4031 \f B\fImangling char\fR = ~\fR4032 .sp 4033 Example: 4034 \f B\fImangling char\fR = ^\fR4035 .RE 4036 .PP 4930 \fIname mangling\fR\. The default is a \'~\' but this may interfere with some software\. Use this option to set it to whatever you prefer\. This is effective only when mangling method is hash\. 4931 .sp 4932 Default: 4933 \fI\fImangling char\fR\fR\fI = \fR\fI~\fR\fI \fR 4934 .sp 4935 Example: 4936 \fI\fImangling char\fR\fR\fI = \fR\fI^\fR\fI \fR 4937 .RE 4938 4037 4939 mangling method (G) 4038 .RS 3n 4039 controls the algorithm used for the generating the mangled names. Can take two different values, "hash" and "hash2". "hash" is the algorithm that was used used in Samba for many years and was the default in Samba 2.2.x "hash2" is now the default and is newer and considered a better algorithm (generates less collisions) in the names. Many Win32 applications store the mangled names and so changing to algorithms must not be done lightly as these applications may break unless reinstalled. 4040 .sp 4041 Default: 4042 \fB\fImangling method\fR = hash2 \fR 4043 .sp 4044 Example: 4045 \fB\fImangling method\fR = hash \fR 4046 .RE 4047 .PP 4940 .PP 4941 .RS 4 4942 controls the algorithm used for the generating the mangled names\. Can take two different values, "hash" and "hash2"\. "hash" is the algorithm that was used used in Samba for many years and was the default in Samba 2\.2\.x "hash2" is now the default and is newer and considered a better algorithm (generates less collisions) in the names\. Many Win32 applications store the mangled names and so changing to algorithms must not be done lightly as these applications may break unless reinstalled\. 4943 .sp 4944 Default: 4945 \fI\fImangling method\fR\fR\fI = \fR\fIhash2\fR\fI \fR 4946 .sp 4947 Example: 4948 \fI\fImangling method\fR\fR\fI = \fR\fIhash\fR\fI \fR 4949 .RE 4950 4048 4951 map acl inherit (S) 4049 .RS 3n 4952 .PP 4953 .RS 4 4050 4954 This boolean parameter controls whether 4051 4955 \fBsmbd\fR(8) 4052 will attempt to map the 'inherit' and 'protected' access control entry flags stored in Windows ACLs into an extended attribute called user.SAMBA_PAI. This parameter only takes effect if Samba is being run on a platform that supports extended attributes (Linux and IRIX so far) and allows the Windows 2000 ACL editor to correctly use inheritance with the Samba POSIX ACL mapping code.4053 .sp 4054 Default: 4055 \f B\fImap acl inherit\fR = no\fR4056 .RE 4057 .PP 4956 will attempt to map the \'inherit\' and \'protected\' access control entry flags stored in Windows ACLs into an extended attribute called user\.SAMBA_PAI\. This parameter only takes effect if Samba is being run on a platform that supports extended attributes (Linux and IRIX so far) and allows the Windows 2000 ACL editor to correctly use inheritance with the Samba POSIX ACL mapping code\. 4957 .sp 4958 Default: 4959 \fI\fImap acl inherit\fR\fR\fI = \fR\fIno\fR\fI \fR 4960 .RE 4961 4058 4962 map archive (S) 4059 .RS 3n 4060 This controls whether the DOS archive attribute should be mapped to the UNIX owner execute bit. The DOS archive bit is set when a file has been modified since its last backup. One motivation for this option is to keep Samba/your PC from making any file it touches from becoming executable under UNIX. This can be quite annoying for shared source code, documents, etc... 4963 .PP 4964 .RS 4 4965 This controls whether the DOS archive attribute should be mapped to the UNIX owner execute bit\. The DOS archive bit is set when a file has been modified since its last backup\. One motivation for this option is to keep Samba/your PC from making any file it touches from becoming executable under UNIX\. This can be quite annoying for shared source code, documents, etc\.\.\. 4061 4966 .sp 4062 4967 Note that this requires the 4063 create mask parameter to be set such that owner execute bit is not masked out (i.e. it must include 100). See the parameter 4064 create mask for details. 4065 .sp 4066 Default: 4067 \fB\fImap archive\fR = yes \fR 4068 .RE 4069 .PP 4968 \fIcreate mask\fR 4969 parameter to be set such that owner execute bit is not masked out (i\.e\. it must include 100)\. See the parameter 4970 \fIcreate mask\fR 4971 for details\. 4972 .sp 4973 Default: 4974 \fI\fImap archive\fR\fR\fI = \fR\fIyes\fR\fI \fR 4975 .RE 4976 4070 4977 map hidden (S) 4071 .RS 3n 4072 This controls whether DOS style hidden files should be mapped to the UNIX world execute bit. 4978 .PP 4979 .RS 4 4980 This controls whether DOS style hidden files should be mapped to the UNIX world execute bit\. 4073 4981 .sp 4074 4982 Note that this requires the 4075 create mask to be set such that the world execute bit is not masked out (i.e. it must include 001). See the parameter 4076 create mask for details. 4077 .sp 4078 \fBNo default\fR 4079 .RE 4080 .PP 4983 \fIcreate mask\fR 4984 to be set such that the world execute bit is not masked out (i\.e\. it must include 001)\. See the parameter 4985 \fIcreate mask\fR 4986 for details\. 4987 .sp 4988 \fINo default\fR 4989 .RE 4990 4081 4991 map read only (S) 4082 .RS 3n 4083 This controls how the DOS read only attribute should be mapped from a UNIX filesystem. 4992 .PP 4993 .RS 4 4994 This controls how the DOS read only attribute should be mapped from a UNIX filesystem\. 4084 4995 .sp 4085 4996 This parameter can take three different values, which tell 4086 4997 \fBsmbd\fR(8) 4087 4998 how to display the read only attribute on files, where either 4088 store dos attributes is set to 4089 \fBNo\fR, or no extended attribute is present. If 4090 store dos attributes is set to 4999 \fIstore dos attributes\fR 5000 is set to 5001 \fBNo\fR, or no extended attribute is present\. If 5002 \fIstore dos attributes\fR 5003 is set to 4091 5004 \fByes\fR 4092 5005 then this parameter is 4093 \f Bignored\fR. This is a new parameter introduced in Samba version 3.0.21.5006 \fIignored\fR\. This is a new parameter introduced in Samba version 3\.0\.21\. 4094 5007 .sp 4095 5008 The three settings are : 4096 .RS 3n 4097 .TP 3n 4098 \(bu 5009 .sp 5010 .RS 4 5011 .ie n \{\ 5012 \h'-04'\(bu\h'+03'\c 5013 .\} 5014 .el \{\ 5015 .sp -1 5016 .IP \(bu 2.3 5017 .\} 4099 5018 4100 5019 \fBYes\fR 4101 - 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. 4102 .TP 3n 4103 \(bu 5020 \- 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\. 5021 .RE 5022 .sp 5023 .RS 4 5024 .ie n \{\ 5025 \h'-04'\(bu\h'+03'\c 5026 .\} 5027 .el \{\ 5028 .sp -1 5029 .IP \(bu 2.3 5030 .\} 4104 5031 4105 5032 \fBPermissions\fR 4106 - The read only DOS attribute is mapped to the effective permissions of the connecting user, as evaluated by5033 \- The read only DOS attribute is mapped to the effective permissions of the connecting user, as evaluated by 4107 5034 \fBsmbd\fR(8) 4108 by reading the unix permissions and POSIX ACL (if present). If the connecting user does not have permission to modify the file, the read only attribute is reported as being set on the file. 4109 .TP 3n 4110 \(bu 5035 by reading the unix permissions and POSIX ACL (if present)\. If the connecting user does not have permission to modify the file, the read only attribute is reported as being set on the file\. 5036 .RE 5037 .sp 5038 .RS 4 5039 .ie n \{\ 5040 \h'-04'\(bu\h'+03'\c 5041 .\} 5042 .el \{\ 5043 .sp -1 5044 .IP \(bu 2.3 5045 .\} 4111 5046 4112 5047 \fBNo\fR 4113 - The read only DOS attribute is unaffected by permissions, and can only be set by the 4114 store dos attributes method. This may be useful for exporting mounted CDs. 4115 .RE 4116 .IP "" 3n 4117 Default: 4118 \fB\fImap read only\fR = yes \fR 4119 .RE 4120 .PP 5048 \- The read only DOS attribute is unaffected by permissions, and can only be set by the 5049 \fIstore dos attributes\fR 5050 method\. This may be useful for exporting mounted CDs\. 5051 .sp 5052 .RE 5053 Default: 5054 \fI\fImap read only\fR\fR\fI = \fR\fIyes\fR\fI \fR 5055 .RE 5056 4121 5057 map system (S) 4122 .RS 3n 4123 This controls whether DOS style system files should be mapped to the UNIX group execute bit. 5058 .PP 5059 .RS 4 5060 This controls whether DOS style system files should be mapped to the UNIX group execute bit\. 4124 5061 .sp 4125 5062 Note that this requires the 4126 create mask to be set such that the group execute bit is not masked out (i.e. it must include 010). See the parameter 4127 create mask for details. 4128 .sp 4129 Default: 4130 \fB\fImap system\fR = no \fR 4131 .RE 4132 .PP 5063 \fIcreate mask\fR 5064 to be set such that the group execute bit is not masked out (i\.e\. it must include 010)\. See the parameter 5065 \fIcreate mask\fR 5066 for details\. 5067 .sp 5068 Default: 5069 \fI\fImap system\fR\fR\fI = \fR\fIno\fR\fI \fR 5070 .RE 5071 4133 5072 map to guest (G) 4134 .RS 3n 5073 .PP 5074 .RS 4 4135 5075 This parameter is only useful in 4136 SECURITY = security modes other than 5076 \fISECURITY = security\fR 5077 modes other than 4137 5078 \fIsecurity = share\fR 4138 5079 and 4139 5080 \fIsecurity = server\fR 4140 - i.e.5081 \- i\.e\. 4141 5082 \fBuser\fR, and 4142 \fBdomain\fR .5083 \fBdomain\fR\. 4143 5084 .sp 4144 5085 This parameter can take four different values, which tell 4145 5086 \fBsmbd\fR(8) 4146 what to do with user login requests that don 't match a valid UNIX user in some way.5087 what to do with user login requests that don\'t match a valid UNIX user in some way\. 4147 5088 .sp 4148 5089 The four settings are : 4149 .RS 3n 4150 .TP 3n 4151 \(bu 5090 .sp 5091 .RS 4 5092 .ie n \{\ 5093 \h'-04'\(bu\h'+03'\c 5094 .\} 5095 .el \{\ 5096 .sp -1 5097 .IP \(bu 2.3 5098 .\} 4152 5099 \fBNever\fR 4153 - Means user login requests with an invalid password are rejected. This is the default. 4154 .TP 3n 4155 \(bu 5100 \- Means user login requests with an invalid password are rejected\. This is the default\. 5101 .RE 5102 .sp 5103 .RS 4 5104 .ie n \{\ 5105 \h'-04'\(bu\h'+03'\c 5106 .\} 5107 .el \{\ 5108 .sp -1 5109 .IP \(bu 2.3 5110 .\} 4156 5111 \fBBad User\fR 4157 - 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 4158 guest account. 4159 .TP 3n 4160 \(bu 5112 \- 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 5113 \fIguest account\fR\. 5114 .RE 5115 .sp 5116 .RS 4 5117 .ie n \{\ 5118 \h'-04'\(bu\h'+03'\c 5119 .\} 5120 .el \{\ 5121 .sp -1 5122 .IP \(bu 2.3 5123 .\} 4161 5124 \fBBad Password\fR 4162 - Means user logins with an invalid password are treated as a guest login and mapped into the4163 guest account. 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 will4164 \f Bhate\fR5125 \- Means user logins with an invalid password are treated as a guest login and mapped into the 5126 \fIguest account\fR\. Note that this can cause problems as it means that any user incorrectly typing their password will be silently logged on as "guest" \- and will not know the reason they cannot access files they think they should \- there will have been no message given to them that they got their password wrong\. Helpdesk services will 5127 \fIhate\fR 4165 5128 you if you set the 4166 5129 \fImap to guest\fR 4167 parameter this way :-). 4168 .TP 3n 4169 \(bu 5130 parameter this way :\-)\. 5131 .RE 5132 .sp 5133 .RS 4 5134 .ie n \{\ 5135 \h'-04'\(bu\h'+03'\c 5136 .\} 5137 .el \{\ 5138 .sp -1 5139 .IP \(bu 2.3 5140 .\} 4170 5141 \fBBad Uid\fR 4171 - 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.4172 . RE4173 . IP "" 3n5142 \- 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\. 5143 .sp 5144 .RE 4174 5145 Note that this parameter is needed to set up "Guest" share services when using 4175 5146 \fIsecurity\fR 4176 modes other than share and server . This is because in these modes the name of the resource being requested is4177 \f Bnot\fR4178 sent to the server until after the server has successfully authenticated the client so the server cannot make authentication decisions at the correct time (connection to the share) for "Guest" shares . This parameter is not useful with5147 modes other than share and server\. This is because in these modes the name of the resource being requested is 5148 \fInot\fR 5149 sent to the server until after the server has successfully authenticated the client so the server cannot make authentication decisions at the correct time (connection to the share) for "Guest" shares\. This parameter is not useful with 4179 5150 \fIsecurity = server\fR 4180 as in this security mode no information is returned about whether a user logon failed due to a bad username or bad password, the same error is returned from a modern server in both cases .4181 .sp 4182 For people familiar with the older Samba releases, this parameter maps to the old compile -time setting of the5151 as in this security mode no information is returned about whether a user logon failed due to a bad username or bad password, the same error is returned from a modern server in both cases\. 5152 .sp 5153 For people familiar with the older Samba releases, this parameter maps to the old compile\-time setting of the 4183 5154 \fB GUEST_SESSSETUP\fR 4184 value in local .h.4185 .sp 4186 Default: 4187 \f B\fImap to guest\fR = Never\fR4188 .sp 4189 Example: 4190 \f B\fImap to guest\fR = Bad User\fR4191 .RE 4192 .PP 5155 value in local\.h\. 5156 .sp 5157 Default: 5158 \fI\fImap to guest\fR\fR\fI = \fR\fINever\fR\fI \fR 5159 .sp 5160 Example: 5161 \fI\fImap to guest\fR\fR\fI = \fR\fIBad User\fR\fI \fR 5162 .RE 5163 4193 5164 max connections (S) 4194 .RS 3n 4195 This option allows the number of simultaneous connections to a service to be limited. If 5165 .PP 5166 .RS 4 5167 This option allows the number of simultaneous connections to a service to be limited\. If 4196 5168 \fImax connections\fR 4197 is greater than 0 then connections will be refused if this number of connections to the service are already open. A value of zero mean an unlimited number of connections may be made. 4198 .sp 4199 Record lock files are used to implement this feature. The lock files will be stored in the directory specified by the 4200 lock directory option. 4201 .sp 4202 Default: 4203 \fB\fImax connections\fR = 0 \fR 4204 .sp 4205 Example: 4206 \fB\fImax connections\fR = 10 \fR 4207 .RE 4208 .PP 5169 is greater than 0 then connections will be refused if this number of connections to the service are already open\. A value of zero mean an unlimited number of connections may be made\. 5170 .sp 5171 Record lock files are used to implement this feature\. The lock files will be stored in the directory specified by the 5172 \fIlock directory\fR 5173 option\. 5174 .sp 5175 Default: 5176 \fI\fImax connections\fR\fR\fI = \fR\fI0\fR\fI \fR 5177 .sp 5178 Example: 5179 \fI\fImax connections\fR\fR\fI = \fR\fI10\fR\fI \fR 5180 .RE 5181 4209 5182 max disk size (G) 4210 .RS 3n 4211 This option allows you to put an upper limit on the apparent size of disks. If you set this option to 100 then all shares will appear to be not larger than 100 MB in size. 4212 .sp 4213 Note that this option does not limit the amount of data you can put on the disk. In the above case you could still store much more than 100 MB on the disk, but if a client ever asks for the amount of free disk space or the total disk size then the result will be bounded by the amount specified in 4214 \fImax disk size\fR. 4215 .sp 4216 This option is primarily useful to work around bugs in some pieces of software that can't handle very large disks, particularly disks over 1GB in size. 5183 .PP 5184 .RS 4 5185 This option allows you to put an upper limit on the apparent size of disks\. If you set this option to 100 then all shares will appear to be not larger than 100 MB in size\. 5186 .sp 5187 Note that this option does not limit the amount of data you can put on the disk\. In the above case you could still store much more than 100 MB on the disk, but if a client ever asks for the amount of free disk space or the total disk size then the result will be bounded by the amount specified in 5188 \fImax disk size\fR\. 5189 .sp 5190 This option is primarily useful to work around bugs in some pieces of software that can\'t handle very large disks, particularly disks over 1GB in size\. 4217 5191 .sp 4218 5192 A 4219 5193 \fImax disk size\fR 4220 of 0 means no limit .4221 .sp 4222 Default: 4223 \f B\fImax disk size\fR = 0\fR4224 .sp 4225 Example: 4226 \f B\fImax disk size\fR = 1000\fR4227 .RE 4228 .PP 5194 of 0 means no limit\. 5195 .sp 5196 Default: 5197 \fI\fImax disk size\fR\fR\fI = \fR\fI0\fR\fI \fR 5198 .sp 5199 Example: 5200 \fI\fImax disk size\fR\fR\fI = \fR\fI1000\fR\fI \fR 5201 .RE 5202 4229 5203 max log size (G) 4230 .RS 3n 4231 This option (an integer in kilobytes) specifies the max size the log file should grow to. Samba periodically checks the size and if it is exceeded it will rename the file, adding a 4232 \fI.old\fR 4233 extension. 4234 .sp 4235 A size of 0 means no limit. 4236 .sp 4237 Default: 4238 \fB\fImax log size\fR = 5000 \fR 4239 .sp 4240 Example: 4241 \fB\fImax log size\fR = 1000 \fR 4242 .RE 4243 .PP 5204 .PP 5205 .RS 4 5206 This option (an integer in kilobytes) specifies the max size the log file should grow to\. Samba periodically checks the size and if it is exceeded it will rename the file, adding a 5207 \fI\.old\fR 5208 extension\. 5209 .sp 5210 A size of 0 means no limit\. 5211 .sp 5212 Default: 5213 \fI\fImax log size\fR\fR\fI = \fR\fI5000\fR\fI \fR 5214 .sp 5215 Example: 5216 \fI\fImax log size\fR\fR\fI = \fR\fI1000\fR\fI \fR 5217 .RE 5218 4244 5219 max mux (G) 4245 .RS 3n 4246 This option controls the maximum number of outstanding simultaneous SMB operations that Samba tells the client it will allow. You should never need to set this parameter. 4247 .sp 4248 Default: 4249 \fB\fImax mux\fR = 50 \fR 4250 .RE 4251 .PP 5220 .PP 5221 .RS 4 5222 This option controls the maximum number of outstanding simultaneous SMB operations that Samba tells the client it will allow\. You should never need to set this parameter\. 5223 .sp 5224 Default: 5225 \fI\fImax mux\fR\fR\fI = \fR\fI50\fR\fI \fR 5226 .RE 5227 4252 5228 max open files (G) 4253 .RS 3n 5229 .PP 5230 .RS 4 4254 5231 This parameter limits the maximum number of open files that one 4255 5232 \fBsmbd\fR(8) 4256 file serving process may have open for a client at any one time . The default for this parameter is set very high (10,000) as Samba uses only one bit per unopened file.4257 .sp 4258 The limit of the number of open files is usually set by the UNIX per -process file descriptor limit rather than this parameter so you should never need to touch this parameter.4259 .sp 4260 Default: 4261 \f B\fImax open files\fR = 10000\fR4262 .RE 4263 .PP 5233 file serving process may have open for a client at any one time\. The default for this parameter is set very high (10,000) as Samba uses only one bit per unopened file\. 5234 .sp 5235 The limit of the number of open files is usually set by the UNIX per\-process file descriptor limit rather than this parameter so you should never need to touch this parameter\. 5236 .sp 5237 Default: 5238 \fI\fImax open files\fR\fR\fI = \fR\fI10000\fR\fI \fR 5239 .RE 5240 4264 5241 max print jobs (S) 4265 .RS 3n 4266 This parameter limits the maximum number of jobs allowable in a Samba printer queue at any given moment. If this number is exceeded, 5242 .PP 5243 .RS 4 5244 This parameter limits the maximum number of jobs allowable in a Samba printer queue at any given moment\. If this number is exceeded, 4267 5245 \fBsmbd\fR(8) 4268 will remote "Out of Space" to the client .4269 .sp 4270 Default: 4271 \f B\fImax print jobs\fR = 1000\fR4272 .sp 4273 Example: 4274 \f B\fImax print jobs\fR = 5000\fR4275 .RE 4276 .PP4277 protocol 4278 .RS 3n 4279 This parameter is a synonym for max protocol.4280 .RE 4281 .PP 5246 will remote "Out of Space" to the client\. 5247 .sp 5248 Default: 5249 \fI\fImax print jobs\fR\fR\fI = \fR\fI1000\fR\fI \fR 5250 .sp 5251 Example: 5252 \fI\fImax print jobs\fR\fR\fI = \fR\fI5000\fR\fI \fR 5253 .RE 5254 protocol.PP 5255 .RS 4 5256 This parameter is a synonym for 5257 max protocol\. 5258 .RE 5259 4282 5260 max protocol (G) 4283 .RS 3n 4284 The value of the parameter (a string) is the highest protocol level that will be supported by the server. 5261 .PP 5262 .RS 4 5263 The value of the parameter (a string) is the highest protocol level that will be supported by the server\. 4285 5264 .sp 4286 5265 Possible values are : 4287 .RS 3n 4288 .TP 3n 4289 \(bu 4290 \fBCORE\fR: Earliest version. No concept of user names. 4291 .TP 3n 4292 \(bu 4293 \fBCOREPLUS\fR: Slight improvements on CORE for efficiency. 4294 .TP 3n 4295 \(bu 5266 .sp 5267 .RS 4 5268 .ie n \{\ 5269 \h'-04'\(bu\h'+03'\c 5270 .\} 5271 .el \{\ 5272 .sp -1 5273 .IP \(bu 2.3 5274 .\} 5275 \fBCORE\fR: Earliest version\. No concept of user names\. 5276 .RE 5277 .sp 5278 .RS 4 5279 .ie n \{\ 5280 \h'-04'\(bu\h'+03'\c 5281 .\} 5282 .el \{\ 5283 .sp -1 5284 .IP \(bu 2.3 5285 .\} 5286 \fBCOREPLUS\fR: Slight improvements on CORE for efficiency\. 5287 .RE 5288 .sp 5289 .RS 4 5290 .ie n \{\ 5291 \h'-04'\(bu\h'+03'\c 5292 .\} 5293 .el \{\ 5294 .sp -1 5295 .IP \(bu 2.3 5296 .\} 4296 5297 \fBLANMAN1\fR: First 4297 \fB modern\fR 4298 version of the protocol. Long filename support. 4299 .TP 3n 4300 \(bu 4301 \fBLANMAN2\fR: Updates to Lanman1 protocol. 4302 .TP 3n 4303 \(bu 4304 \fBNT1\fR: Current up to date version of the protocol. Used by Windows NT. Known as CIFS. 4305 .RE 4306 .IP "" 3n 4307 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol. 4308 .sp 4309 Default: 4310 \fB\fImax protocol\fR = NT1 \fR 4311 .sp 4312 Example: 4313 \fB\fImax protocol\fR = LANMAN1 \fR 4314 .RE 4315 .PP 5298 \fI modern\fR 5299 version of the protocol\. Long filename support\. 5300 .RE 5301 .sp 5302 .RS 4 5303 .ie n \{\ 5304 \h'-04'\(bu\h'+03'\c 5305 .\} 5306 .el \{\ 5307 .sp -1 5308 .IP \(bu 2.3 5309 .\} 5310 \fBLANMAN2\fR: Updates to Lanman1 protocol\. 5311 .RE 5312 .sp 5313 .RS 4 5314 .ie n \{\ 5315 \h'-04'\(bu\h'+03'\c 5316 .\} 5317 .el \{\ 5318 .sp -1 5319 .IP \(bu 2.3 5320 .\} 5321 \fBNT1\fR: Current up to date version of the protocol\. Used by Windows NT\. Known as CIFS\. 5322 .sp 5323 .RE 5324 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\. 5325 .sp 5326 Default: 5327 \fI\fImax protocol\fR\fR\fI = \fR\fINT1\fR\fI \fR 5328 .sp 5329 Example: 5330 \fI\fImax protocol\fR\fR\fI = \fR\fILANMAN1\fR\fI \fR 5331 .RE 5332 4316 5333 max reported print jobs (S) 4317 .RS 3n 4318 This parameter limits the maximum number of jobs displayed in a port monitor for Samba printer queue at any given moment. If this number is exceeded, the excess jobs will not be shown. A value of zero means there is no limit on the number of print jobs reported. 4319 .sp 4320 Default: 4321 \fB\fImax reported print jobs\fR = 0 \fR 4322 .sp 4323 Example: 4324 \fB\fImax reported print jobs\fR = 1000 \fR 4325 .RE 4326 .PP 5334 .PP 5335 .RS 4 5336 This parameter limits the maximum number of jobs displayed in a port monitor for Samba printer queue at any given moment\. If this number is exceeded, the excess jobs will not be shown\. A value of zero means there is no limit on the number of print jobs reported\. 5337 .sp 5338 Default: 5339 \fI\fImax reported print jobs\fR\fR\fI = \fR\fI0\fR\fI \fR 5340 .sp 5341 Example: 5342 \fI\fImax reported print jobs\fR\fR\fI = \fR\fI1000\fR\fI \fR 5343 .RE 5344 4327 5345 max smbd processes (G) 4328 .RS 3n 5346 .PP 5347 .RS 4 4329 5348 This parameter limits the maximum number of 4330 5349 \fBsmbd\fR(8) 4331 processes concurrently running on a system and is intended as a stopgap to prevent degrading service to clients in the event that the server has insufficient resources to handle more than this number of connections . Remember that under normal operating conditions, each user will have an5350 processes concurrently running on a system and is intended as a stopgap to prevent degrading service to clients in the event that the server has insufficient resources to handle more than this number of connections\. Remember that under normal operating conditions, each user will have an 4332 5351 \fBsmbd\fR(8) 4333 associated with him or her to handle connections to all shares from a given host .4334 .sp 4335 Default: 4336 \f B\fImax smbd processes\fR = 0\fR4337 .sp 4338 Example: 4339 \f B\fImax smbd processes\fR = 1000\fR4340 .RE 4341 .PP 5352 associated with him or her to handle connections to all shares from a given host\. 5353 .sp 5354 Default: 5355 \fI\fImax smbd processes\fR\fR\fI = \fR\fI0\fR\fI \fR 5356 .sp 5357 Example: 5358 \fI\fImax smbd processes\fR\fR\fI = \fR\fI1000\fR\fI \fR 5359 .RE 5360 4342 5361 max stat cache size (G) 4343 .RS 3n 5362 .PP 5363 .RS 4 4344 5364 This parameter limits the size in memory of any 4345 5365 \fIstat cache\fR 4346 being used to speed up case insensitive name mappings . This parameter is the number of kilobyte (1024) units the stat cache can use. A value of zero means unlimited which is not advised aѕ it can use a lot of memory. You should not need to change this parameter.4347 .sp 4348 Default: 4349 \f B\fImax stat cache size\fR = 1024\fR4350 .sp 4351 Example: 4352 \f B\fImax stat cache size\fR = 100\fR4353 .RE 4354 .PP 5366 being used to speed up case insensitive name mappings\. It represents the number of kilobyte (1024) units the stat cache can use\. A value of zero, meaning unlimited, is not advisable due to increased memory useage\. You should not need to change this parameter\. 5367 .sp 5368 Default: 5369 \fI\fImax stat cache size\fR\fR\fI = \fR\fI256\fR\fI \fR 5370 .sp 5371 Example: 5372 \fI\fImax stat cache size\fR\fR\fI = \fR\fI100\fR\fI \fR 5373 .RE 5374 4355 5375 max ttl (G) 4356 .RS 3n 5376 .PP 5377 .RS 4 4357 5378 This option tells 4358 5379 \fBnmbd\fR(8) 4359 what the default 'time to live' of NetBIOS names should be (in seconds) when5380 what the default \'time to live\' of NetBIOS names should be (in seconds) when 4360 5381 nmbd 4361 is requesting a name using either a broadcast packet or from a WINS server . You should never need to change this parameter. The default is 3 days.4362 .sp 4363 Default: 4364 \f B\fImax ttl\fR = 259200\fR4365 .RE 4366 .PP 5382 is requesting a name using either a broadcast packet or from a WINS server\. You should never need to change this parameter\. The default is 3 days\. 5383 .sp 5384 Default: 5385 \fI\fImax ttl\fR\fR\fI = \fR\fI259200\fR\fI \fR 5386 .RE 5387 4367 5388 max wins ttl (G) 4368 .RS 3n 5389 .PP 5390 .RS 4 4369 5391 This option tells 4370 5392 \fBsmbd\fR(8) 4371 when acting as a WINS server ( wins support = yes) what the maximum 'time to live' of NetBIOS names that5393 when acting as a WINS server (\fIwins support = yes\fR) what the maximum \'time to live\' of NetBIOS names that 4372 5394 nmbd 4373 will grant will be (in seconds) . You should never need to change this parameter. The default is 6 days (518400 seconds).4374 .sp 4375 Default: 4376 \f B\fImax wins ttl\fR = 518400\fR4377 .RE 4378 .PP 5395 will grant will be (in seconds)\. You should never need to change this parameter\. The default is 6 days (518400 seconds)\. 5396 .sp 5397 Default: 5398 \fI\fImax wins ttl\fR\fR\fI = \fR\fI518400\fR\fI \fR 5399 .RE 5400 4379 5401 max xmit (G) 4380 .RS 3n 4381 This option controls the maximum packet size that will be negotiated by Samba. The default is 16644, which matches the behavior of Windows 2000. A value below 2048 is likely to cause problems. You should never need to change this parameter from its default value. 4382 .sp 4383 Default: 4384 \fB\fImax xmit\fR = 16644 \fR 4385 .sp 4386 Example: 4387 \fB\fImax xmit\fR = 8192 \fR 4388 .RE 4389 .PP 5402 .PP 5403 .RS 4 5404 This option controls the maximum packet size that will be negotiated by Samba\. The default is 16644, which matches the behavior of Windows 2000\. A value below 2048 is likely to cause problems\. You should never need to change this parameter from its default value\. 5405 .sp 5406 Default: 5407 \fI\fImax xmit\fR\fR\fI = \fR\fI16644\fR\fI \fR 5408 .sp 5409 Example: 5410 \fI\fImax xmit\fR\fR\fI = \fR\fI8192\fR\fI \fR 5411 .RE 5412 4390 5413 message command (G) 4391 .RS 3n 4392 This specifies what command to run when the server receives a WinPopup style message. 4393 .sp 4394 This would normally be a command that would deliver the message somehow. How this is to be done is up to your imagination. 5414 .PP 5415 .RS 4 5416 This specifies what command to run when the server receives a WinPopup style message\. 5417 .sp 5418 This would normally be a command that would deliver the message somehow\. How this is to be done is up to your imagination\. 4395 5419 .sp 4396 5420 An example is: 4397 4398 .sp 4399 5421 .sp 5422 .RS 4 4400 5423 .nf 4401 4402 message command = csh -c 'xedit %s;rm %s' & 4403 5424 message command = csh \-c \'xedit %s;rm %s\' & 4404 5425 .fi 4405 5426 .RE 5427 .sp 4406 5428 .sp 4407 5429 This delivers the message using 4408 xedit, then removes it afterwards .4409 \f BNOTE 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).4410 .sp 4411 All messages are delivered as the global guest user . The command takes the standard substitutions, although5430 xedit, then removes it afterwards\. 5431 \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)\. 5432 .sp 5433 All messages are delivered as the global guest user\. The command takes the standard substitutions, although 4412 5434 \fI %u\fR 4413 won't work (\fI%U\fR 4414 may be better in this case). 4415 .sp 4416 Apart from the standard substitutions, some additional ones apply. In particular: 4417 .RS 3n 4418 .TP 3n 4419 \(bu 5435 won\'t work (\fI%U\fR 5436 may be better in this case)\. 5437 .sp 5438 Apart from the standard substitutions, some additional ones apply\. In particular: 5439 .sp 5440 .RS 4 5441 .ie n \{\ 5442 \h'-04'\(bu\h'+03'\c 5443 .\} 5444 .el \{\ 5445 .sp -1 5446 .IP \(bu 2.3 5447 .\} 4420 5448 \fI%s\fR 4421 = the filename containing the message. 4422 .TP 3n 4423 \(bu 5449 = the filename containing the message\. 5450 .RE 5451 .sp 5452 .RS 4 5453 .ie n \{\ 5454 \h'-04'\(bu\h'+03'\c 5455 .\} 5456 .el \{\ 5457 .sp -1 5458 .IP \(bu 2.3 5459 .\} 4424 5460 \fI%t\fR 4425 = the destination that the message was sent to (probably the server name). 4426 .TP 3n 4427 \(bu 5461 = the destination that the message was sent to (probably the server name)\. 5462 .RE 5463 .sp 5464 .RS 4 5465 .ie n \{\ 5466 \h'-04'\(bu\h'+03'\c 5467 .\} 5468 .el \{\ 5469 .sp -1 5470 .IP \(bu 2.3 5471 .\} 4428 5472 \fI%f\fR 4429 = who the message is from. 4430 .RE 4431 .IP "" 3n 4432 You could make this command send mail, or whatever else takes your fancy. Please let us know of any really interesting ideas you have. 4433 .sp 4434 Here's a way of sending the messages as mail to root: 4435 4436 .sp 4437 5473 = who the message is from\. 5474 .sp 5475 .RE 5476 You could make this command send mail, or whatever else takes your fancy\. Please let us know of any really interesting ideas you have\. 5477 .sp 5478 Here\'s a way of sending the messages as mail to root: 5479 .sp 5480 .RS 4 4438 5481 .nf 4439 4440 message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s 4441 5482 message command = /bin/mail \-s \'message from %f on %m\' root < %s; rm %s 4442 5483 .fi 4443 4444 .sp 4445 If you don't have a message command then the message won't be delivered and Samba will tell the sender there was an error. Unfortunately WfWg totally ignores the error code and carries on regardless, saying that the message was delivered. 5484 .RE 5485 .sp 5486 .sp 5487 If you don\'t have a message command then the message won\'t be delivered and Samba will tell the sender there was an error\. Unfortunately WfWg totally ignores the error code and carries on regardless, saying that the message was delivered\. 4446 5488 .sp 4447 5489 If you want to silently delete it then try: 4448 4449 .sp 4450 5490 .sp 5491 .RS 4 4451 5492 .nf 4452 4453 5493 message command = rm %s 4454 4455 5494 .fi 4456 4457 .sp 4458 Default: 4459 \fB\fImessage command\fR = \fR 4460 .sp 4461 Example: 4462 \fB\fImessage command\fR = csh -c 'xedit %s; rm %s' & \fR 4463 .RE 4464 .PP 5495 .RE 5496 .sp 5497 .sp 5498 Default: 5499 \fI\fImessage command\fR\fR\fI = \fR\fI\fR\fI \fR 5500 .sp 5501 Example: 5502 \fI\fImessage command\fR\fR\fI = \fR\fIcsh \-c \'xedit %s; rm %s\' &\fR\fI \fR 5503 .RE 5504 4465 5505 min print space (S) 4466 .RS 3n 4467 This sets the minimum amount of free disk space that must be available before a user will be able to spool a print job. It is specified in kilobytes. The default is 0, which means a user can always spool a print job. 4468 .sp 4469 Default: 4470 \fB\fImin print space\fR = 0 \fR 4471 .sp 4472 Example: 4473 \fB\fImin print space\fR = 2000 \fR 4474 .RE 4475 .PP 5506 .PP 5507 .RS 4 5508 This sets the minimum amount of free disk space that must be available before a user will be able to spool a print job\. It is specified in kilobytes\. The default is 0, which means a user can always spool a print job\. 5509 .sp 5510 Default: 5511 \fI\fImin print space\fR\fR\fI = \fR\fI0\fR\fI \fR 5512 .sp 5513 Example: 5514 \fI\fImin print space\fR\fR\fI = \fR\fI2000\fR\fI \fR 5515 .RE 5516 4476 5517 min protocol (G) 4477 .RS 3n 4478 The value of the parameter (a string) is the lowest SMB protocol dialect than Samba will support. Please refer to the 4479 max protocol parameter for a list of valid protocol names and a brief description of each. You may also wish to refer to the C source code in 4480 \fIsource/smbd/negprot.c\fR 4481 for a listing of known protocol dialects supported by clients. 5518 .PP 5519 .RS 4 5520 The value of the parameter (a string) is the lowest SMB protocol dialect than Samba will support\. Please refer to the 5521 \fImax protocol\fR 5522 parameter for a list of valid protocol names and a brief description of each\. You may also wish to refer to the C source code in 5523 \fIsource/smbd/negprot\.c\fR 5524 for a listing of known protocol dialects supported by clients\. 4482 5525 .sp 4483 5526 If you are viewing this parameter as a security measure, you should also refer to the 4484 lanman auth parameter. Otherwise, you should never need to change this parameter. 4485 .sp 4486 Default: 4487 \fB\fImin protocol\fR = CORE \fR 4488 .sp 4489 Example: 4490 \fB\fImin protocol\fR = NT1 \fR 4491 .RE 4492 .PP 5527 \fIlanman auth\fR 5528 parameter\. Otherwise, you should never need to change this parameter\. 5529 .sp 5530 Default: 5531 \fI\fImin protocol\fR\fR\fI = \fR\fICORE\fR\fI \fR 5532 .sp 5533 Example: 5534 \fI\fImin protocol\fR\fR\fI = \fR\fINT1\fR\fI \fR 5535 .RE 5536 4493 5537 min wins ttl (G) 4494 .RS 3n 5538 .PP 5539 .RS 4 4495 5540 This option tells 4496 5541 \fBnmbd\fR(8) 4497 when acting as a WINS server ( wins support = yes) what the minimum 'time to live' of NetBIOS names that5542 when acting as a WINS server (\fIwins support = yes\fR) what the minimum \'time to live\' of NetBIOS names that 4498 5543 nmbd 4499 will grant will be (in seconds) . You should never need to change this parameter. The default is 6 hours (21600 seconds).4500 .sp 4501 Default: 4502 \f B\fImin wins ttl\fR = 21600\fR4503 .RE 4504 .PP 5544 will grant will be (in seconds)\. You should never need to change this parameter\. The default is 6 hours (21600 seconds)\. 5545 .sp 5546 Default: 5547 \fI\fImin wins ttl\fR\fR\fI = \fR\fI21600\fR\fI \fR 5548 .RE 5549 4505 5550 msdfs proxy (S) 4506 .RS 3n 4507 This parameter indicates that the share is a stand-in for another CIFS share whose location is specified by the value of the parameter. When clients attempt to connect to this share, they are redirected to the proxied share using the SMB-Dfs protocol. 4508 .sp 4509 Only Dfs roots can act as proxy shares. Take a look at the 4510 msdfs root and 4511 host msdfs options to find out how to set up a Dfs root share. 4512 .sp 4513 \fBNo default\fR 4514 .sp 4515 Example: 4516 \fB\fImsdfs proxy\fR = \\\\otherserver\\someshare \fR 4517 .RE 4518 .PP 5551 .PP 5552 .RS 4 5553 This parameter indicates that the share is a stand\-in for another CIFS share whose location is specified by the value of the parameter\. When clients attempt to connect to this share, they are redirected to the proxied share using the SMB\-Dfs protocol\. 5554 .sp 5555 Only Dfs roots can act as proxy shares\. Take a look at the 5556 \fImsdfs root\fR 5557 and 5558 \fIhost msdfs\fR 5559 options to find out how to set up a Dfs root share\. 5560 .sp 5561 \fINo default\fR 5562 .sp 5563 Example: 5564 \fI\fImsdfs proxy\fR\fR\fI = \fR\fI\eotherserver\esomeshare\fR\fI \fR 5565 .RE 5566 4519 5567 msdfs root (S) 4520 .RS 3n 5568 .PP 5569 .RS 4 4521 5570 If set to 4522 \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 form4523 \fImsdfs:serverA\ \shareA,serverB\\shareB\fR4524 and so on . For more information on setting up a Dfs tree on Samba, refer to the MSDFS chapter in the Samba3-HOWTO book.4525 .sp 4526 Default: 4527 \f B\fImsdfs root\fR = no\fR4528 .RE 4529 .PP 5571 \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 5572 \fImsdfs:serverA\e\eshareA,serverB\e\eshareB\fR 5573 and so on\. For more information on setting up a Dfs tree on Samba, refer to the MSDFS chapter in the Samba3\-HOWTO book\. 5574 .sp 5575 Default: 5576 \fI\fImsdfs root\fR\fR\fI = \fR\fIno\fR\fI \fR 5577 .RE 5578 4530 5579 name cache timeout (G) 4531 .RS 3n 4532 Specifies the number of seconds it takes before entries in samba's hostname resolve cache time out. If the timeout is set to 0. the caching is disabled. 4533 .sp 4534 Default: 4535 \fB\fIname cache timeout\fR = 660 \fR 4536 .sp 4537 Example: 4538 \fB\fIname cache timeout\fR = 0 \fR 4539 .RE 4540 .PP 5580 .PP 5581 .RS 4 5582 Specifies the number of seconds it takes before entries in samba\'s hostname resolve cache time out\. If the timeout is set to 0\. the caching is disabled\. 5583 .sp 5584 Default: 5585 \fI\fIname cache timeout\fR\fR\fI = \fR\fI660\fR\fI \fR 5586 .sp 5587 Example: 5588 \fI\fIname cache timeout\fR\fR\fI = \fR\fI0\fR\fI \fR 5589 .RE 5590 4541 5591 name resolve order (G) 4542 .RS 3n 4543 This option is used by the programs in the Samba suite to determine what naming services to use and in what order to resolve host names to IP addresses. Its main purpose to is to control how netbios name resolution is performed. The option takes a space separated string of name resolution options. 4544 .sp 4545 The options are: "lmhosts", "host", "wins" and "bcast". They cause names to be resolved as follows: 4546 .RS 3n 4547 .TP 3n 4548 \(bu 5592 .PP 5593 .RS 4 5594 This option is used by the programs in the Samba suite to determine what naming services to use and in what order to resolve host names to IP addresses\. Its main purpose to is to control how netbios name resolution is performed\. The option takes a space separated string of name resolution options\. 5595 .sp 5596 The options are: "lmhosts", "host", "wins" and "bcast"\. They cause names to be resolved as follows: 5597 .sp 5598 .RS 4 5599 .ie n \{\ 5600 \h'-04'\(bu\h'+03'\c 5601 .\} 5602 .el \{\ 5603 .sp -1 5604 .IP \(bu 2.3 5605 .\} 4549 5606 4550 5607 \fBlmhosts\fR 4551 : 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. 4552 .TP 3n 4553 \(bu 5608 : 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\. 5609 .RE 5610 .sp 5611 .RS 4 5612 .ie n \{\ 5613 \h'-04'\(bu\h'+03'\c 5614 .\} 5615 .el \{\ 5616 .sp -1 5617 .IP \(bu 2.3 5618 .\} 4554 5619 4555 5620 \fBhost\fR 4556 5621 : Do a standard host name to IP address resolution, using the system 4557 \fI/etc/hosts \fR, NIS, or DNS lookups. This method of name resolution is operating system depended for instance on IRIX or Solaris this may be controlled by the 4558 \fI/etc/nsswitch.conf\fR 4559 file. Note that this method is used only if the NetBIOS name type being queried is the 0x20 (server) name type or 0x1c (domain controllers). The latter case is only useful for active directory domains and results in a DNS query for the SRV RR entry matching _ldap._tcp.domain. 4560 .TP 3n 4561 \(bu 5622 \fI/etc/hosts \fR, NIS, or DNS lookups\. This method of name resolution is operating system depended for instance on IRIX or Solaris this may be controlled by the 5623 \fI/etc/nsswitch\.conf\fR 5624 file\. Note that this method is used only if the NetBIOS name type being queried is the 0x20 (server) name type or 0x1c (domain controllers)\. The latter case is only useful for active directory domains and results in a DNS query for the SRV RR entry matching _ldap\._tcp\.domain\. 5625 .RE 5626 .sp 5627 .RS 4 5628 .ie n \{\ 5629 \h'-04'\(bu\h'+03'\c 5630 .\} 5631 .el \{\ 5632 .sp -1 5633 .IP \(bu 2.3 5634 .\} 4562 5635 \fBwins\fR 4563 5636 : Query a name with the IP address listed in the 4564 WINSSERVER parameter. If no WINS server has been specified this method will be ignored. 4565 .TP 3n 4566 \(bu 5637 \fIWINSSERVER\fR 5638 parameter\. If no WINS server has been specified this method will be ignored\. 5639 .RE 5640 .sp 5641 .RS 4 5642 .ie n \{\ 5643 \h'-04'\(bu\h'+03'\c 5644 .\} 5645 .el \{\ 5646 .sp -1 5647 .IP \(bu 2.3 5648 .\} 4567 5649 \fBbcast\fR 4568 5650 : Do a broadcast on each of the known local interfaces listed in the 4569 interfaces parameter. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet. 4570 .RE 4571 .IP "" 3n 4572 The example below will cause the local lmhosts file to be examined first, followed by a broadcast attempt, followed by a normal system hostname lookup. 5651 \fIinterfaces\fR 5652 parameter\. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\. 5653 .sp 5654 .RE 5655 The example below will cause the local lmhosts file to be examined first, followed by a broadcast attempt, followed by a normal system hostname lookup\. 4573 5656 .sp 4574 5657 When Samba is functioning in ADS security mode (security = ads) it is advised to use following settings for … … 4577 5660 name resolve order = wins bcast 4578 5661 .sp 4579 DC lookups will still be done via DNS, but fallbacks to netbios names will not inundate your DNS servers with needless querys for DOMAIN<0x1c> lookups .4580 .sp 4581 Default: 4582 \f B\fIname resolve order\fR = lmhosts host wins bcast\fR4583 .sp 4584 Example: 4585 \f B\fIname resolve order\fR = lmhosts bcast host\fR4586 .RE 4587 .PP 5662 DC lookups will still be done via DNS, but fallbacks to netbios names will not inundate your DNS servers with needless querys for DOMAIN<0x1c> lookups\. 5663 .sp 5664 Default: 5665 \fI\fIname resolve order\fR\fR\fI = \fR\fIlmhosts host wins bcast\fR\fI \fR 5666 .sp 5667 Example: 5668 \fI\fIname resolve order\fR\fR\fI = \fR\fIlmhosts bcast host\fR\fI \fR 5669 .RE 5670 4588 5671 netbios aliases (G) 4589 .RS 3n 4590 This is a list of NetBIOS names that nmbd will advertise as additional names by which the Samba server is known. This allows one machine to appear in browse lists under multiple names. If a machine is acting as a browse server or logon server none of these names will be advertised as either browse server or logon servers, only the primary name of the machine will be advertised with these capabilities. 4591 .sp 4592 Default: 4593 \fB\fInetbios aliases\fR = # empty string (no additional names) \fR 4594 .sp 4595 Example: 4596 \fB\fInetbios aliases\fR = TEST TEST1 TEST2 \fR 4597 .RE 4598 .PP 5672 .PP 5673 .RS 4 5674 This is a list of NetBIOS names that nmbd will advertise as additional names by which the Samba server is known\. This allows one machine to appear in browse lists under multiple names\. If a machine is acting as a browse server or logon server none of these names will be advertised as either browse server or logon servers, only the primary name of the machine will be advertised with these capabilities\. 5675 .sp 5676 Default: 5677 \fI\fInetbios aliases\fR\fR\fI = \fR\fI # empty string (no additional names)\fR\fI \fR 5678 .sp 5679 Example: 5680 \fI\fInetbios aliases\fR\fR\fI = \fR\fITEST TEST1 TEST2\fR\fI \fR 5681 .RE 5682 4599 5683 netbios name (G) 4600 .RS 3n 4601 This sets the NetBIOS name by which a Samba server is known. By default it is the same as the first component of the host's DNS name. If a machine is a browse server or logon server this name (or the first component of the hosts DNS name) will be the name that these services are advertised under. 4602 .sp 4603 There is a bug in Samba-3 that breaks operation of browsing and access to shares if the netbios name is set to the literal name 4604 PIPE. To avoid this problem, do not name your Samba-3 server 4605 PIPE. 4606 .sp 4607 Default: 4608 \fB\fInetbios name\fR = # machine DNS name \fR 4609 .sp 4610 Example: 4611 \fB\fInetbios name\fR = MYNAME \fR 4612 .RE 4613 .PP 5684 .PP 5685 .RS 4 5686 This sets the NetBIOS name by which a Samba server is known\. By default it is the same as the first component of the host\'s DNS name\. If a machine is a browse server or logon server this name (or the first component of the hosts DNS name) will be the name that these services are advertised under\. 5687 .sp 5688 There is a bug in Samba\-3 that breaks operation of browsing and access to shares if the netbios name is set to the literal name 5689 PIPE\. To avoid this problem, do not name your Samba\-3 server 5690 PIPE\. 5691 .sp 5692 Default: 5693 \fI\fInetbios name\fR\fR\fI = \fR\fI # machine DNS name\fR\fI \fR 5694 .sp 5695 Example: 5696 \fI\fInetbios name\fR\fR\fI = \fR\fIMYNAME\fR\fI \fR 5697 .RE 5698 4614 5699 netbios scope (G) 4615 .RS 3n 4616 This sets the NetBIOS scope that Samba will operate under. This should not be set unless every machine on your LAN also sets this value. 4617 .sp 4618 Default: 4619 \fB\fInetbios scope\fR = \fR 4620 .RE 4621 .PP 5700 .PP 5701 .RS 4 5702 This sets the NetBIOS scope that Samba will operate under\. This should not be set unless every machine on your LAN also sets this value\. 5703 .sp 5704 Default: 5705 \fI\fInetbios scope\fR\fR\fI = \fR\fI\fR\fI \fR 5706 .RE 5707 4622 5708 nis homedir (G) 4623 .RS 3n 4624 Get the home share server from a NIS map. For UNIX systems that use an automounter, the user's home directory will often be mounted on a workstation on demand from a remote server. 4625 .sp 4626 When the Samba logon server is not the actual home directory server, but is mounting the home directories via NFS then two network hops would be required to access the users home directory if the logon server told the client to use itself as the SMB server for home directories (one over SMB and one over NFS). This can be very slow. 4627 .sp 4628 This option allows Samba to return the home share as being on a different server to the logon server and as long as a Samba daemon is running on the home directory server, it will be mounted on the Samba client directly from the directory server. When Samba is returning the home share to the client, it will consult the NIS map specified in 4629 homedir map and return the server listed there. 4630 .sp 4631 Note that for this option to work there must be a working NIS system and the Samba server with this option must also be a logon server. 4632 .sp 4633 Default: 4634 \fB\fInis homedir\fR = no \fR 4635 .RE 4636 .PP 5709 .PP 5710 .RS 4 5711 Get the home share server from a NIS map\. For UNIX systems that use an automounter, the user\'s home directory will often be mounted on a workstation on demand from a remote server\. 5712 .sp 5713 When the Samba logon server is not the actual home directory server, but is mounting the home directories via NFS then two network hops would be required to access the users home directory if the logon server told the client to use itself as the SMB server for home directories (one over SMB and one over NFS)\. This can be very slow\. 5714 .sp 5715 This option allows Samba to return the home share as being on a different server to the logon server and as long as a Samba daemon is running on the home directory server, it will be mounted on the Samba client directly from the directory server\. When Samba is returning the home share to the client, it will consult the NIS map specified in 5716 \fIhomedir map\fR 5717 and return the server listed there\. 5718 .sp 5719 Note that for this option to work there must be a working NIS system and the Samba server with this option must also be a logon server\. 5720 .sp 5721 Default: 5722 \fI\fInis homedir\fR\fR\fI = \fR\fIno\fR\fI \fR 5723 .RE 5724 4637 5725 nt acl support (S) 4638 .RS 3n 5726 .PP 5727 .RS 4 4639 5728 This boolean parameter controls whether 4640 5729 \fBsmbd\fR(8) 4641 will attempt to map UNIX permissions into Windows NT access control lists . The UNIX permissions considered are the the traditional UNIX owner and group permissions, as well as POSIX ACLs set on any files or directories. This parameter was formally a global parameter in releases prior to 2.2.2.4642 .sp 4643 Default: 4644 \f B\fInt acl support\fR = yes\fR4645 .RE 4646 .PP 5730 will attempt to map UNIX permissions into Windows NT access control lists\. The UNIX permissions considered are the the traditional UNIX owner and group permissions, as well as POSIX ACLs set on any files or directories\. This parameter was formally a global parameter in releases prior to 2\.2\.2\. 5731 .sp 5732 Default: 5733 \fI\fInt acl support\fR\fR\fI = \fR\fIyes\fR\fI \fR 5734 .RE 5735 4647 5736 ntlm auth (G) 4648 .RS 3n 5737 .PP 5738 .RS 4 4649 5739 This parameter determines whether or not 4650 5740 \fBsmbd\fR(8) 4651 will attempt to authenticate users using the NTLM encrypted password response . If disabled, either the lanman password hash or an NTLMv2 response will need to be sent by the client.5741 will attempt to authenticate users using the NTLM encrypted password response\. If disabled, either the lanman password hash or an NTLMv2 response will need to be sent by the client\. 4652 5742 .sp 4653 5743 If this option, and 4654 5744 lanman auth 4655 are both disabled, then only NTLMv2 logins will be permited . Not all clients support NTLMv2, and most will require special configuration to us it.4656 .sp 4657 Default: 4658 \f B\fIntlm auth\fR = yes\fR4659 .RE 4660 .PP 5745 are both disabled, then only NTLMv2 logins will be permited\. Not all clients support NTLMv2, and most will require special configuration to us it\. 5746 .sp 5747 Default: 5748 \fI\fIntlm auth\fR\fR\fI = \fR\fIyes\fR\fI \fR 5749 .RE 5750 4661 5751 nt pipe support (G) 4662 .RS 3n 5752 .PP 5753 .RS 4 4663 5754 This boolean parameter controls whether 4664 5755 \fBsmbd\fR(8) 4665 5756 will allow Windows NT clients to connect to the NT SMB specific 4666 5757 \fBIPC$\fR 4667 pipes . This is a developer debugging option and can be left alone.4668 .sp 4669 Default: 4670 \f B\fInt pipe support\fR = yes\fR4671 .RE 4672 .PP 5758 pipes\. This is a developer debugging option and can be left alone\. 5759 .sp 5760 Default: 5761 \fI\fInt pipe support\fR\fR\fI = \fR\fIyes\fR\fI \fR 5762 .RE 5763 4673 5764 nt status support (G) 4674 .RS 3n 5765 .PP 5766 .RS 4 4675 5767 This boolean parameter controls whether 4676 5768 \fBsmbd\fR(8) 4677 will negotiate NT specific status support with Windows NT/2k/XP clients . This is a developer debugging option and should be left alone. If this option is set to5769 will negotiate NT specific status support with Windows NT/2k/XP clients\. This is a developer debugging option and should be left alone\. If this option is set to 4678 5770 \fBno\fR 4679 then Samba offers exactly the same DOS error codes that versions prior to Samba 2 .2.3 reported.4680 .sp 4681 You should not need to ever disable this parameter .4682 .sp 4683 Default: 4684 \f B\fInt status support\fR = yes\fR4685 .RE 4686 .PP 5771 then Samba offers exactly the same DOS error codes that versions prior to Samba 2\.2\.3 reported\. 5772 .sp 5773 You should not need to ever disable this parameter\. 5774 .sp 5775 Default: 5776 \fI\fInt status support\fR\fR\fI = \fR\fIyes\fR\fI \fR 5777 .RE 5778 4687 5779 null passwords (G) 4688 .RS 3n 4689 Allow or disallow client access to accounts that have null passwords. 5780 .PP 5781 .RS 4 5782 Allow or disallow client access to accounts that have null passwords\. 4690 5783 .sp 4691 5784 See also 4692 \fBsmbpasswd\fR(5) .4693 .sp 4694 Default: 4695 \f B\fInull passwords\fR = no\fR4696 .RE 4697 .PP 5785 \fBsmbpasswd\fR(5)\. 5786 .sp 5787 Default: 5788 \fI\fInull passwords\fR\fR\fI = \fR\fIno\fR\fI \fR 5789 .RE 5790 4698 5791 obey pam restrictions (G) 4699 .RS 3n 4700 When Samba 3.0 is configured to enable PAM support (i.e. --with-pam), this parameter will control whether or not Samba should obey PAM's account and session management directives. The default behavior is to use PAM for clear text authentication only and to ignore any account or session management. Note that Samba always ignores PAM for authentication in the case of 4701 encrypt passwords = yes. The reason is that PAM modules cannot support the challenge/response authentication mechanism needed in the presence of SMB password encryption. 4702 .sp 4703 Default: 4704 \fB\fIobey pam restrictions\fR = no \fR 4705 .RE 4706 .PP 5792 .PP 5793 .RS 4 5794 When Samba 3\.0 is configured to enable PAM support (i\.e\. \-\-with\-pam), this parameter will control whether or not Samba should obey PAM\'s account and session management directives\. The default behavior is to use PAM for clear text authentication only and to ignore any account or session management\. Note that Samba always ignores PAM for authentication in the case of 5795 \fIencrypt passwords = yes\fR\. The reason is that PAM modules cannot support the challenge/response authentication mechanism needed in the presence of SMB password encryption\. 5796 .sp 5797 Default: 5798 \fI\fIobey pam restrictions\fR\fR\fI = \fR\fIno\fR\fI \fR 5799 .RE 5800 4707 5801 only user (S) 4708 .RS 3n 5802 .PP 5803 .RS 4 4709 5804 This is a boolean option that controls whether connections with usernames not in the 4710 5805 \fIuser\fR 4711 list will be allowed . By default this option is disabled so that a client can supply a username to be used by the server. Enabling this parameter will force the server to only use the login names from the5806 list will be allowed\. By default this option is disabled so that a client can supply a username to be used by the server\. Enabling this parameter will force the server to only use the login names from the 4712 5807 \fIuser\fR 4713 5808 list and is only really useful in 4714 security = share level security. 4715 .sp 4716 Note that this also means Samba won't try to deduce usernames from the service name. This can be annoying for the [homes] section. To get around this you could use 5809 \fIsecurity = share\fR 5810 level security\. 5811 .sp 5812 Note that this also means Samba won\'t try to deduce usernames from the service name\. This can be annoying for the [homes] section\. To get around this you could use 4717 5813 user = %S 4718 5814 which means your 4719 5815 \fIuser\fR 4720 list will be just the service name, which for home directories is the name of the user .4721 .sp 4722 Default: 4723 \f B\fIonly user\fR = no\fR4724 .RE 4725 .PP 5816 list will be just the service name, which for home directories is the name of the user\. 5817 .sp 5818 Default: 5819 \fI\fIonly user\fR\fR\fI = \fR\fIno\fR\fI \fR 5820 .RE 5821 4726 5822 open files database hash size (G) 4727 .RS 3n 4728 This parameter was added in Samba 3.0.23. This is an internal tuning parameter that sets the hash size of the tdb used for the open file databases. The presence of this parameter allows tuning of the system for very large (thousands of concurrent users) Samba setups. The default setting of this parameter should be sufficient for most normal environments. It is advised not to change this parameter unless advised to by a Samba Team member. 4729 .sp 4730 Default: 4731 \fB\fIopen files database hash size\fR = 10007 \fR 4732 .sp 4733 Example: 4734 \fB\fIopen files database hash size\fR = 1338457 \fR 4735 .RE 4736 .PP 5823 .PP 5824 .RS 4 5825 This parameter was added in Samba 3\.0\.23\. This is an internal tuning parameter that sets the hash size of the tdb used for the open file databases\. The presence of this parameter allows tuning of the system for very large (thousands of concurrent users) Samba setups\. The default setting of this parameter should be sufficient for most normal environments\. It is advised not to change this parameter unless advised to by a Samba Team member\. 5826 .sp 5827 Default: 5828 \fI\fIopen files database hash size\fR\fR\fI = \fR\fI10007\fR\fI \fR 5829 .sp 5830 Example: 5831 \fI\fIopen files database hash size\fR\fR\fI = \fR\fI1338457\fR\fI \fR 5832 .RE 5833 4737 5834 oplock break wait time (G) 4738 .RS 3n 4739 This is a tuning parameter added due to bugs in both Windows 9x and WinNT. If Samba responds to a client too quickly when that client issues an SMB that can cause an oplock break request, then the network client can fail and not respond to the break request. This tuning parameter (which is set in milliseconds) is the amount of time Samba will wait before sending an oplock break request to such (broken) clients. 5835 .PP 5836 .RS 4 5837 This is a tuning parameter added due to bugs in both Windows 9x and WinNT\. If Samba responds to a client too quickly when that client issues an SMB that can cause an oplock break request, then the network client can fail and not respond to the break request\. This tuning parameter (which is set in milliseconds) is the amount of time Samba will wait before sending an oplock break request to such (broken) clients\. 4740 5838 .sp 4741 5839 .it 1 an-trap … … 4743 5841 .nr an-break-flag 1 4744 5842 .br 4745 \fBWarning\fR 4746 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE. 4747 Default: 4748 \fB\fIoplock break wait time\fR = 0 \fR 4749 .RE 4750 .PP 5843 Warning 5844 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\. 5845 5846 Default: 5847 \fI\fIoplock break wait time\fR\fR\fI = \fR\fI0\fR\fI \fR 5848 .RE 5849 4751 5850 oplock contention limit (S) 4752 .RS 3n 5851 .PP 5852 .RS 4 4753 5853 This is a 4754 \f Bvery\fR5854 \fIvery\fR 4755 5855 advanced 4756 5856 \fBsmbd\fR(8) 4757 tuning option to improve the efficiency of the granting of oplocks under multiple client contention for the same file .5857 tuning option to improve the efficiency of the granting of oplocks under multiple client contention for the same file\. 4758 5858 .sp 4759 5859 In brief it specifies a number, which causes 4760 \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 causes5860 \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 4761 5861 smbd 4762 to behave in a similar way to Windows NT .5862 to behave in a similar way to Windows NT\. 4763 5863 .sp 4764 5864 .it 1 an-trap … … 4766 5866 .nr an-break-flag 1 4767 5867 .br 4768 \fBWarning\fR 4769 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE. 4770 Default: 4771 \fB\fIoplock contention limit\fR = 2 \fR 4772 .RE 4773 .PP 5868 Warning 5869 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\. 5870 5871 Default: 5872 \fI\fIoplock contention limit\fR\fR\fI = \fR\fI2\fR\fI \fR 5873 .RE 5874 4774 5875 oplocks (S) 4775 .RS 3n 5876 .PP 5877 .RS 4 4776 5878 This boolean option tells 4777 5879 smbd 4778 whether to issue oplocks (opportunistic locks) to file open requests on this share . The oplock code can dramatically (approx. 30% or more) improve the speed of access to files on Samba servers. It allows the clients to aggressively cache files locally and you may want to disable this option for unreliable network environments (it is turned on by default in Windows NT Servers). For more information see the file4779 \fISpeed .txt\fR5880 whether to issue oplocks (opportunistic locks) to file open requests on this share\. The oplock code can dramatically (approx\. 30% or more) improve the speed of access to files on Samba servers\. It allows the clients to aggressively cache files locally and you may want to disable this option for unreliable network environments (it is turned on by default in Windows NT Servers)\. For more information see the file 5881 \fISpeed\.txt\fR 4780 5882 in the Samba 4781 5883 \fIdocs/\fR 4782 directory. 4783 .sp 4784 Oplocks may be selectively turned off on certain files with a share. See the 4785 veto oplock files parameter. On some systems oplocks are recognized by the underlying operating system. This allows data synchronization between all access to oplocked files, whether it be via Samba or NFS or a local UNIX process. See the 4786 kernel oplocks parameter for details. 4787 .sp 4788 Default: 4789 \fB\fIoplocks\fR = yes \fR 4790 .RE 4791 .PP 5884 directory\. 5885 .sp 5886 Oplocks may be selectively turned off on certain files with a share\. See the 5887 \fIveto oplock files\fR 5888 parameter\. On some systems oplocks are recognized by the underlying operating system\. This allows data synchronization between all access to oplocked files, whether it be via Samba or NFS or a local UNIX process\. See the 5889 \fIkernel oplocks\fR 5890 parameter for details\. 5891 .sp 5892 Default: 5893 \fI\fIoplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR 5894 .RE 5895 4792 5896 os2 driver map (G) 4793 .RS 3n 4794 The parameter is used to define the absolute path to a file containing a mapping of Windows NT printer driver names to OS/2 printer driver names. The format is: 4795 .sp 4796 <nt driver name> = <os2 driver name>.<device name> 5897 .PP 5898 .RS 4 5899 The parameter is used to define the absolute path to a file containing a mapping of Windows NT printer driver names to OS/2 printer driver names\. The format is: 5900 .sp 5901 <nt driver name> = <os2 driver name>\.<device name> 4797 5902 .sp 4798 5903 For example, a valid entry using the HP LaserJet 5 printer driver would appear as 4799 HP LaserJet 5L = LASERJET .HP LaserJet 5L.4800 .sp 4801 The need for the file is due to the printer driver namespace problem described in the chapter on Classical Printing in the Samba3 -HOWTO book. For more details on OS/2 clients, please refer to chapter on other clients in the Samba3-HOWTO book.4802 .sp 4803 Default: 4804 \f B\fIos2 driver map\fR =\fR4805 .RE 4806 .PP 5904 HP LaserJet 5L = LASERJET\.HP LaserJet 5L\. 5905 .sp 5906 The need for the file is due to the printer driver namespace problem described in the chapter on Classical Printing in the Samba3\-HOWTO book\. For more details on OS/2 clients, please refer to chapter on other clients in the Samba3\-HOWTO book\. 5907 .sp 5908 Default: 5909 \fI\fIos2 driver map\fR\fR\fI = \fR\fI\fR\fI \fR 5910 .RE 5911 4807 5912 os level (G) 4808 .RS 3n 4809 This integer value controls what level Samba advertises itself as for browse elections. The value of this parameter determines whether 5913 .PP 5914 .RS 4 5915 This integer value controls what level Samba advertises itself as for browse elections\. The value of this parameter determines whether 4810 5916 \fBnmbd\fR(8) 4811 5917 has a chance of becoming a local master browser for the 4812 workgroup in the local broadcast area. 4813 .sp 4814 \fB Note :\fRBy 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 over-ride the default setting. Please refer to chapter 9 of the Samba-3 HOWTO document for further information regarding the use of this parameter. 4815 .sp 4816 Default: 4817 \fB\fIos level\fR = 20 \fR 4818 .sp 4819 Example: 4820 \fB\fIos level\fR = 65 \fR 4821 .RE 4822 .PP 5918 \fIworkgroup\fR 5919 in the local broadcast area\. 5920 .sp 5921 \fI Note:\fR 5922 By default, Samba will win a local master browsing election over all Microsoft operating systems except a Windows NT 4\.0/2000 Domain Controller\. This means that a misconfigured Samba host can effectively isolate a subnet for browsing purposes\. This parameter is largely auto\-configured in the Samba\-3 release series and it is seldom necessary to manually override the default setting\. Please refer to chapter 9 of the Samba\-3 HOWTO document for further information regarding the use of this parameter\. 5923 \fINote:\fR 5924 The maximum value for this parameter is 255\. If you use higher values, counting will start at 0! 5925 .sp 5926 Default: 5927 \fI\fIos level\fR\fR\fI = \fR\fI20\fR\fI \fR 5928 .sp 5929 Example: 5930 \fI\fIos level\fR\fR\fI = \fR\fI65\fR\fI \fR 5931 .RE 5932 4823 5933 pam password change (G) 4824 .RS 3n 4825 With the addition of better PAM support in Samba 2.2, this parameter, it is possible to use PAM's password change control flag for Samba. If enabled, then PAM will be used for password changes when requested by an SMB client instead of the program listed in 4826 passwd program. It should be possible to enable this without changing your 4827 passwd chat parameter for most setups. 4828 .sp 4829 Default: 4830 \fB\fIpam password change\fR = no \fR 4831 .RE 4832 .PP 5934 .PP 5935 .RS 4 5936 With the addition of better PAM support in Samba 2\.2, this parameter, it is possible to use PAM\'s password change control flag for Samba\. If enabled, then PAM will be used for password changes when requested by an SMB client instead of the program listed in 5937 \fIpasswd program\fR\. It should be possible to enable this without changing your 5938 \fIpasswd chat\fR 5939 parameter for most setups\. 5940 .sp 5941 Default: 5942 \fI\fIpam password change\fR\fR\fI = \fR\fIno\fR\fI \fR 5943 .RE 5944 4833 5945 panic action (G) 4834 .RS 3n 5946 .PP 5947 .RS 4 4835 5948 This is a Samba developer option that allows a system command to be called when either 4836 5949 \fBsmbd\fR(8) 4837 5950 or 4838 \fB smbd\fR(8)4839 crashes . This is usually used to draw attention to the fact that a problem occurred.4840 .sp 4841 Default: 4842 \f B\fIpanic action\fR =\fR4843 .sp 4844 Example: 4845 \f B\fIpanic action\fR = "/bin/sleep 90000"\fR4846 .RE 4847 .PP 5951 \fBnmbd\fR(8) 5952 crashes\. This is usually used to draw attention to the fact that a problem occurred\. 5953 .sp 5954 Default: 5955 \fI\fIpanic action\fR\fR\fI = \fR\fI\fR\fI \fR 5956 .sp 5957 Example: 5958 \fI\fIpanic action\fR\fR\fI = \fR\fI"/bin/sleep 90000"\fR\fI \fR 5959 .RE 5960 4848 5961 paranoid server security (G) 4849 .RS 3n 4850 Some version of NT 4.x allow non-guest users with a bad passowrd. When this option is enabled, samba will not use a broken NT 4.x server as password server, but instead complain to the logs and exit. 4851 .sp 4852 Disabling this option prevents Samba from making this check, which involves deliberatly attempting a bad logon to the remote server. 4853 .sp 4854 Default: 4855 \fB\fIparanoid server security\fR = yes \fR 4856 .RE 4857 .PP 5962 .PP 5963 .RS 4 5964 Some version of NT 4\.x allow non\-guest users with a bad passowrd\. When this option is enabled, samba will not use a broken NT 4\.x server as password server, but instead complain to the logs and exit\. 5965 .sp 5966 Disabling this option prevents Samba from making this check, which involves deliberatly attempting a bad logon to the remote server\. 5967 .sp 5968 Default: 5969 \fI\fIparanoid server security\fR\fR\fI = \fR\fIyes\fR\fI \fR 5970 .RE 5971 4858 5972 passdb backend (G) 4859 .RS 3n 4860 This option allows the administrator to chose which backend will be used for storing user and possibly group information. This allows you to swap between dfferent storage mechanisms without recompile. 4861 .sp 4862 The parameter value is divided into two parts, the backend's name, and a 'location' string that has meaning only to that particular backed. These are separated by a : character. 5973 .PP 5974 .RS 4 5975 This option allows the administrator to chose which backend will be used for storing user and possibly group information\. This allows you to swap between different storage mechanisms without recompile\. 5976 .sp 5977 The parameter value is divided into two parts, the backend\'s name, and a \'location\' string that has meaning only to that particular backed\. These are separated by a : character\. 4863 5978 .sp 4864 5979 Available backends can include: 4865 .RS 3n 4866 .TP 3n 4867 \(bu 5980 .sp 5981 .RS 4 5982 .ie n \{\ 5983 \h'-04'\(bu\h'+03'\c 5984 .\} 5985 .el \{\ 5986 .sp -1 5987 .IP \(bu 2.3 5988 .\} 4868 5989 smbpasswd 4869 - The default smbpasswd backend. Takes a path to the smbpasswd file as an optional argument. 4870 .TP 3n 4871 \(bu 5990 \- The default smbpasswd backend\. Takes a path to the smbpasswd file as an optional argument\. 5991 .RE 5992 .sp 5993 .RS 4 5994 .ie n \{\ 5995 \h'-04'\(bu\h'+03'\c 5996 .\} 5997 .el \{\ 5998 .sp -1 5999 .IP \(bu 2.3 6000 .\} 4872 6001 tdbsam 4873 - The TDB based password storage backend. Takes a path to the TDB as an optional argument (defaults to passdb.tdb in the 4874 private dir directory. 4875 .TP 3n 4876 \(bu 6002 \- The TDB based password storage backend\. Takes a path to the TDB as an optional argument (defaults to passdb\.tdb in the 6003 \fIprivate dir\fR 6004 directory\. 6005 .RE 6006 .sp 6007 .RS 4 6008 .ie n \{\ 6009 \h'-04'\(bu\h'+03'\c 6010 .\} 6011 .el \{\ 6012 .sp -1 6013 .IP \(bu 2.3 6014 .\} 4877 6015 ldapsam 4878 - The LDAP based passdb backend. Takes an LDAP URL as an optional argument (defaults to6016 \- The LDAP based passdb backend\. Takes an LDAP URL as an optional argument (defaults to 4879 6017 ldap://localhost) 4880 6018 .sp 4881 LDAP connections should be secured where possible . This may be done using either Start-TLS (see4882 ldap ssl) or by specifying6019 LDAP connections should be secured where possible\. This may be done using either Start\-TLS (see 6020 \fIldap ssl\fR) or by specifying 4883 6021 \fIldaps://\fR 4884 in the URL argument. 4885 .sp 4886 Multiple servers may also be specified in double-quotes, if your LDAP libraries supports the LDAP URL notation. (OpenLDAP does). 4887 .RE 4888 .IP "" 3n 4889 6022 in the URL argument\. 6023 .sp 6024 Multiple servers may also be specified in double\-quotes\. Whether multiple servers are supported or not and the exact syntax depends on the LDAP library you use\. 6025 .sp 6026 .RE 4890 6027 4891 6028 Examples of use are: 4892 6029 .sp 6030 .RS 4 4893 6031 .nf 4894 4895 passdb backend = tdbsam:/etc/samba/private/passdb.tdb 4896 4897 or 4898 4899 passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com" 4900 6032 passdb backend = tdbsam:/etc/samba/private/passdb\.tdb 6033 6034 or multi server LDAP URL with OpenLDAP library: 6035 6036 passdb backend = ldapsam:"ldap://ldap\-1\.example\.com ldap://ldap\-2\.example\.com" 6037 6038 or multi server LDAP URL with Netscape based LDAP library: 6039 6040 passdb backend = ldapsam:"ldap://ldap\-1\.example\.com ldap\-2\.example\.com" 4901 6041 .fi 4902 Default: 4903 \fB\fIpassdb backend\fR = smbpasswd \fR 4904 .RE 4905 .PP 6042 .RE 6043 Default: 6044 \fI\fIpassdb backend\fR\fR\fI = \fR\fIsmbpasswd\fR\fI \fR 6045 .RE 6046 4906 6047 passdb expand explicit (G) 4907 .RS 3n 4908 This parameter controls whether Samba substitutes %-macros in the passdb fields if they are explicitly set. We used to expand macros here, but this turned out to be a bug because the Windows client can expand a variable %G_osver% in which %G would have been substituted by the user's primary group. 4909 .sp 4910 Default: 4911 \fB\fIpassdb expand explicit\fR = no \fR 4912 .RE 4913 .PP 4914 passwd chat (G) 4915 .RS 3n 4916 This string controls the 4917 \fB"chat"\fR 4918 conversation that takes places between 4919 \fBsmbd\fR(8) 4920 and the local password changing program to change the user's password. The string describes a sequence of response-receive pairs that 4921 \fBsmbd\fR(8) 4922 uses to determine what to send to the 4923 passwd program and what to expect back. If the expected output is not received then the password is not changed. 4924 .sp 4925 This chat sequence is often quite site specific, depending on what local methods are used for password control (such as NIS etc). 4926 .sp 4927 Note that this parameter only is only used if the 4928 unix password sync parameter is set to 4929 \fByes\fR. This sequence is then called 4930 \fBAS ROOT\fR 4931 when the SMB password in the smbpasswd file is being changed, without access to the old password cleartext. This means that root must be able to reset the user's password without knowing the text of the previous password. In the presence of NIS/YP, this means that the 4932 passwd program must be executed on the NIS master. 4933 .sp 4934 The string can contain the macro 4935 \fI%n\fR 4936 which is substituted for the new password. The chat sequence can also contain the standard macros \n, \r, \t and \s to give line-feed, carriage-return, tab and space. The chat sequence string can also contain a '*' which matches any sequence of characters. Double quotes can be used to collect strings with spaces in them into a single string. 4937 .sp 4938 If the send string in any part of the chat sequence is a full stop ".", then no string is sent. Similarly, if the expect string is a full stop then no string is expected. 4939 .sp 4940 If the 4941 pam password change parameter is set to 4942 \fByes\fR, the chat pairs may be matched in any order, and success is determined by the PAM result, not any particular output. The \n macro is ignored for PAM conversions. 4943 .sp 4944 Default: 4945 \fB\fIpasswd chat\fR = *new*password* %n\\n*new*password* %n\\n *changed* \fR 4946 .sp 4947 Example: 4948 \fB\fIpasswd chat\fR = "*Enter OLD password*" %o\\n "*Enter NEW password*" %n\\n "*Reenter NEW password*" %n\\n "*Password changed*" \fR 4949 .RE 4950 .PP 6048 .PP 6049 .RS 4 6050 This parameter controls whether Samba substitutes %\-macros in the passdb fields if they are explicitly set\. We used to expand macros here, but this turned out to be a bug because the Windows client can expand a variable %G_osver% in which %G would have been substituted by the user\'s primary group\. 6051 .sp 6052 Default: 6053 \fI\fIpassdb expand explicit\fR\fR\fI = \fR\fIno\fR\fI \fR 6054 .RE 6055 4951 6056 passwd chat debug (G) 4952 .RS 3n 6057 .PP 6058 .RS 4 4953 6059 This boolean specifies if the passwd chat script parameter is run in 4954 \f Bdebug\fR4955 mode . In this mode the strings passed to and received from the passwd chat are printed in the6060 \fIdebug\fR 6061 mode\. In this mode the strings passed to and received from the passwd chat are printed in the 4956 6062 \fBsmbd\fR(8) 4957 6063 log with a 4958 debug level of 100. This is a dangerous option as it will allow plaintext passwords to be seen in the 6064 \fIdebug level\fR 6065 of 100\. This is a dangerous option as it will allow plaintext passwords to be seen in the 4959 6066 smbd 4960 log . It is available to help Samba admins debug their6067 log\. It is available to help Samba admins debug their 4961 6068 \fIpasswd chat\fR 4962 6069 scripts when calling the 4963 6070 \fIpasswd program\fR 4964 and should be turned off after this has been done. This option has no effect if the 4965 pam password change paramter is set. This parameter is off by default. 4966 .sp 4967 Default: 4968 \fB\fIpasswd chat debug\fR = no \fR 4969 .RE 4970 .PP 6071 and should be turned off after this has been done\. This option has no effect if the 6072 \fIpam password change\fR 6073 parameter is set\. This parameter is off by default\. 6074 .sp 6075 Default: 6076 \fI\fIpasswd chat debug\fR\fR\fI = \fR\fIno\fR\fI \fR 6077 .RE 6078 4971 6079 passwd chat timeout (G) 4972 .RS 3n 4973 This integer specifies the number of seconds smbd will wait for an initial answer from a passwd chat script being run. Once the initial answer is received the subsequent answers must be received in one tenth of this time. The default it two seconds. 4974 .sp 4975 Default: 4976 \fB\fIpasswd chat timeout\fR = 2 \fR 4977 .RE 4978 .PP 6080 .PP 6081 .RS 4 6082 This integer specifies the number of seconds smbd will wait for an initial answer from a passwd chat script being run\. Once the initial answer is received the subsequent answers must be received in one tenth of this time\. The default it two seconds\. 6083 .sp 6084 Default: 6085 \fI\fIpasswd chat timeout\fR\fR\fI = \fR\fI2\fR\fI \fR 6086 .RE 6087 6088 passwd chat (G) 6089 .PP 6090 .RS 4 6091 This string controls the 6092 \fI"chat"\fR 6093 conversation that takes places between 6094 \fBsmbd\fR(8) 6095 and the local password changing program to change the user\'s password\. The string describes a sequence of response\-receive pairs that 6096 \fBsmbd\fR(8) 6097 uses to determine what to send to the 6098 \fIpasswd program\fR 6099 and what to expect back\. If the expected output is not received then the password is not changed\. 6100 .sp 6101 This chat sequence is often quite site specific, depending on what local methods are used for password control (such as NIS etc)\. 6102 .sp 6103 Note that this parameter only is only used if the 6104 \fIunix password sync\fR 6105 parameter is set to 6106 \fByes\fR\. This sequence is then called 6107 \fIAS ROOT\fR 6108 when the SMB password in the smbpasswd file is being changed, without access to the old password cleartext\. This means that root must be able to reset the user\'s password without knowing the text of the previous password\. In the presence of NIS/YP, this means that the 6109 \fIpasswd program\fR 6110 must be executed on the NIS master\. 6111 .sp 6112 The string can contain the macro 6113 \fI%n\fR 6114 which is substituted for the new password\. The old passsword (\fI%o\fR) is only available when 6115 \fIencrypt passwords\fR 6116 has been disabled\. The chat sequence can also contain the standard macros \en, \er, \et and \es to give line\-feed, carriage\-return, tab and space\. The chat sequence string can also contain a \'*\' which matches any sequence of characters\. Double quotes can be used to collect strings with spaces in them into a single string\. 6117 .sp 6118 If the send string in any part of the chat sequence is a full stop "\.", then no string is sent\. Similarly, if the expect string is a full stop then no string is expected\. 6119 .sp 6120 If the 6121 \fIpam password change\fR 6122 parameter is set to 6123 \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\. 6124 .sp 6125 Default: 6126 \fI\fIpasswd chat\fR\fR\fI = \fR\fI*new*password* %n\en*new*password* %n\en *changed*\fR\fI \fR 6127 .sp 6128 Example: 6129 \fI\fIpasswd chat\fR\fR\fI = \fR\fI"*Enter NEW password*" %n\en "*Reenter NEW password*" %n\en "*Password changed*"\fR\fI \fR 6130 .RE 6131 4979 6132 passwd program (G) 4980 .RS 3n 4981 The name of a program that can be used to set UNIX user passwords. Any occurrences of 6133 .PP 6134 .RS 4 6135 The name of a program that can be used to set UNIX user passwords\. Any occurrences of 4982 6136 \fI%u\fR 4983 will be replaced with the user name . The user name is checked for existence before calling the password changing program.6137 will be replaced with the user name\. The user name is checked for existence before calling the password changing program\. 4984 6138 .sp 4985 6139 Also note that many passwd programs insist in 4986 \f Breasonable \fR4987 passwords, such as a minimum length, or the inclusion of mixed case chars and digits . This can pose a problem as some clients (such as Windows for Workgroups) uppercase the password before sending it.4988 .sp 4989 \f BNote\fR6140 \fIreasonable \fR 6141 passwords, such as a minimum length, or the inclusion of mixed case chars and digits\. This can pose a problem as some clients (such as Windows for Workgroups) uppercase the password before sending it\. 6142 .sp 6143 \fINote\fR 4990 6144 that if the 4991 6145 \fIunix password sync\fR … … 4993 6147 \fByes \fR 4994 6148 then this program is called 4995 \f BAS ROOT\fR4996 before the SMB password in the smbpasswd file is changed . If this UNIX password change fails, then6149 \fIAS ROOT\fR 6150 before the SMB password in the smbpasswd file is changed\. If this UNIX password change fails, then 4997 6151 smbd 4998 will fail to change the SMB password also (this is by design) .6152 will fail to change the SMB password also (this is by design)\. 4999 6153 .sp 5000 6154 If the 5001 6155 \fIunix password sync\fR 5002 6156 parameter is set this parameter 5003 \f BMUST USE ABSOLUTE PATHS\fR6157 \fIMUST USE ABSOLUTE PATHS\fR 5004 6158 for 5005 \f BALL\fR5006 programs called, and must be examined for security implications . Note that by default6159 \fIALL\fR 6160 programs called, and must be examined for security implications\. Note that by default 5007 6161 \fIunix password sync\fR 5008 6162 is set to 5009 \fBno\fR .5010 .sp 5011 Default: 5012 \f B\fIpasswd program\fR =\fR5013 .sp 5014 Example: 5015 \f B\fIpasswd program\fR = /bin/passwd %u\fR5016 .RE 5017 .PP 6163 \fBno\fR\. 6164 .sp 6165 Default: 6166 \fI\fIpasswd program\fR\fR\fI = \fR\fI\fR\fI \fR 6167 .sp 6168 Example: 6169 \fI\fIpasswd program\fR\fR\fI = \fR\fI/bin/passwd %u\fR\fI \fR 6170 .RE 6171 5018 6172 password level (G) 5019 .RS 3n 5020 Some client/server combinations have difficulty with mixed-case passwords. One offending client is Windows for Workgroups, which for some reason forces passwords to upper case when using the LANMAN1 protocol, but leaves them alone when using COREPLUS! Another problem child is the Windows 95/98 family of operating systems. These clients upper case clear text passwords even when NT LM 0.12 selected by the protocol negotiation request/response. 5021 .sp 5022 This parameter defines the maximum number of characters that may be upper case in passwords. 5023 .sp 5024 For example, say the password given was "FRED". If 6173 .PP 6174 .RS 4 6175 Some client/server combinations have difficulty with mixed\-case passwords\. One offending client is Windows for Workgroups, which for some reason forces passwords to upper case when using the LANMAN1 protocol, but leaves them alone when using COREPLUS! Another problem child is the Windows 95/98 family of operating systems\. These clients upper case clear text passwords even when NT LM 0\.12 selected by the protocol negotiation request/response\. 6176 .sp 6177 This parameter defines the maximum number of characters that may be upper case in passwords\. 6178 .sp 6179 For example, say the password given was "FRED"\. If 5025 6180 \fI password level\fR 5026 6181 is set to 1, the following combinations would be tried if "FRED" failed: … … 5032 6187 was set to 2, the following combinations would also be tried: 5033 6188 .sp 5034 "FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..5035 .sp 5036 And so on .5037 .sp 5038 The higher value this parameter is set to the more likely it is that a mixed case password will be matched against a single case password . However, you should be aware that use of this parameter reduces security and increases the time taken to process a new connection.5039 .sp 5040 A value of zero will cause only two attempts to be made - the password as is and the password in all-lower case.5041 .sp 5042 This parameter is used only when using plain -text passwords. It is not at all used when encrypted passwords as in use (that is the default since samba-3.0.0). Use this only when5043 encrypt passwords = No.5044 .sp 5045 Default: 5046 \f B\fIpassword level\fR = 0\fR5047 .sp 5048 Example: 5049 \f B\fIpassword level\fR = 4\fR5050 .RE 5051 .PP 6189 "FRed", "FrEd", "FreD", "fREd", "fReD", "frED", \.\. 6190 .sp 6191 And so on\. 6192 .sp 6193 The higher value this parameter is set to the more likely it is that a mixed case password will be matched against a single case password\. However, you should be aware that use of this parameter reduces security and increases the time taken to process a new connection\. 6194 .sp 6195 A value of zero will cause only two attempts to be made \- the password as is and the password in all\-lower case\. 6196 .sp 6197 This parameter is used only when using plain\-text passwords\. It is not at all used when encrypted passwords as in use (that is the default since samba\-3\.0\.0)\. Use this only when 6198 \fIencrypt passwords = No\fR\. 6199 .sp 6200 Default: 6201 \fI\fIpassword level\fR\fR\fI = \fR\fI0\fR\fI \fR 6202 .sp 6203 Example: 6204 \fI\fIpassword level\fR\fR\fI = \fR\fI4\fR\fI \fR 6205 .RE 6206 5052 6207 password server (G) 5053 .RS 3n 6208 .PP 6209 .RS 4 5054 6210 By specifying the name of another SMB server or Active Directory domain controller with this option, and using 5055 6211 security = [ads|domain|server] 5056 it is possible to get Samba to to do all its username/password validation using a specific remote server .5057 .sp 5058 This option sets the name or IP address of the password server to use . New syntax has been added to support defining the port to use when connecting to the server the case of an ADS realm. To define a port other than the default LDAP port of 389, add the port number using a colon after the name or IP address (e.g. 192.168.1.100:389). If you do not specify a port, Samba will use the standard LDAP port of tcp/389. Note that port numbers have no effect on password servers for Windows NT 4.0 domains or netbios connections.6212 it is possible to get Samba to to do all its username/password validation using a specific remote server\. 6213 .sp 6214 This option sets the name or IP address of the password server to use\. New syntax has been added to support defining the port to use when connecting to the server the case of an ADS realm\. To define a port other than the default LDAP port of 389, add the port number using a colon after the name or IP address (e\.g\. 192\.168\.1\.100:389)\. If you do not specify a port, Samba will use the standard LDAP port of tcp/389\. Note that port numbers have no effect on password servers for Windows NT 4\.0 domains or netbios connections\. 5059 6215 .sp 5060 6216 If parameter is a name, it is looked up using the parameter 5061 name resolve order and so may resolved by any method and order described in that parameter. 5062 .sp 5063 The password server must be a machine capable of using the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in user level security mode. 6217 \fIname resolve order\fR 6218 and so may resolved by any method and order described in that parameter\. 6219 .sp 6220 The password server must be a machine capable of using the "LM1\.2X002" or the "NT LM 0\.12" protocol, and it must be in user level security mode\. 5064 6221 .sp 5065 6222 .it 1 an-trap … … 5067 6224 .nr an-break-flag 1 5068 6225 .br 5069 \fBNote\fR 5070 Using a password server means your UNIX box (running Samba) is only as secure as your password server. 5071 \fBDO NOT CHOOSE A PASSWORD SERVER THAT YOU DON'T COMPLETELY TRUST\fR. 5072 Never point a Samba server at itself for password serving. This will cause a loop and could lock up your Samba server! 6226 Note 6227 Using a password server means your UNIX box (running Samba) is only as secure as your password server\. 6228 \fIDO NOT CHOOSE A PASSWORD SERVER THAT YOU DON\'T COMPLETELY TRUST\fR\. 6229 6230 Never point a Samba server at itself for password serving\. This will cause a loop and could lock up your Samba server! 5073 6231 .sp 5074 6232 The name of the password server takes the standard substitutions, but probably the only useful one is 5075 \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!6233 \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! 5076 6234 .sp 5077 6235 If the … … 5080 6238 \fBdomain\fR 5081 6239 or 5082 \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 using6240 \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 5083 6241 security = domain 5084 6242 is that if you list several hosts in the … … 5086 6244 option then 5087 6245 smbd 5088 will try each in turn till it finds one that responds . This is useful in case your primary server goes down.6246 will try each in turn till it finds one that responds\. This is useful in case your primary server goes down\. 5089 6247 .sp 5090 6248 If the 5091 6249 \fIpassword server\fR 5092 option is set to the character '*', then Samba will attempt to auto-locate the Primary or Backup Domain controllers to authenticate against by doing a query for the name6250 option is set to the character \'*\', then Samba will attempt to auto\-locate the Primary or Backup Domain controllers to authenticate against by doing a query for the name 5093 6251 \fBWORKGROUP<1C>\fR 5094 and then contacting each server returned in the list of IP addresses from the name resolution source .5095 .sp 5096 If the list of servers contains both names/IP 's and the '*' character, the list is treated as a list of preferred domain controllers, but an auto lookup of all remaining DC's will be added to the list as well. Samba will not attempt to optimize this list by locating the closest DC.6252 and then contacting each server returned in the list of IP addresses from the name resolution source\. 6253 .sp 6254 If the list of servers contains both names/IP\'s and the \'*\' character, the list is treated as a list of preferred domain controllers, but an auto lookup of all remaining DC\'s will be added to the list as well\. Samba will not attempt to optimize this list by locating the closest DC\. 5097 6255 .sp 5098 6256 If the … … 5101 6259 \fBserver\fR, then there are different restrictions that 5102 6260 security = domain 5103 doesn't suffer from: 5104 .RS 3n 5105 .TP 3n 5106 \(bu 6261 doesn\'t suffer from: 6262 .sp 6263 .RS 4 6264 .ie n \{\ 6265 \h'-04'\(bu\h'+03'\c 6266 .\} 6267 .el \{\ 6268 .sp -1 6269 .IP \(bu 2.3 6270 .\} 5107 6271 You may list several password servers in the 5108 6272 \fIpassword server\fR … … 5110 6274 smbd 5111 6275 makes a connection to a password server, and then the password server fails, no more users will be able to be authenticated from this 5112 smbd . This is a restriction of the SMB/CIFS protocol when in6276 smbd\. This is a restriction of the SMB/CIFS protocol when in 5113 6277 security = server 5114 mode and cannot be fixed in Samba. 5115 .TP 3n 5116 \(bu 6278 mode and cannot be fixed in Samba\. 6279 .RE 6280 .sp 6281 .RS 4 6282 .ie n \{\ 6283 \h'-04'\(bu\h'+03'\c 6284 .\} 6285 .el \{\ 6286 .sp -1 6287 .IP \(bu 2.3 6288 .\} 5117 6289 If you are using a Windows NT server as your password server then you will have to ensure that your users are able to login from the Samba server, as when in 5118 6290 security = server 5119 mode the network logon will appear to come from there rather than from the users workstation .5120 . RE5121 . IP "" 3n5122 Default: 5123 \f B\fIpassword server\fR =\fR5124 .sp 5125 Example: 5126 \f B\fIpassword server\fR = NT-PDC, NT-BDC1, NT-BDC2, *\fR5127 .sp 5128 Example: 5129 \f B\fIpassword server\fR = windc.mydomain.com:389 192.168.1.101 *\fR5130 .sp 5131 Example: 5132 \f B\fIpassword server\fR = *\fR5133 .RE 5134 .PP5135 directory 5136 .RS 3n 5137 This parameter is a synonym for path.5138 .RE 5139 .PP 6291 mode the network logon will appear to come from there rather than from the users workstation\. 6292 .sp 6293 .RE 6294 Default: 6295 \fI\fIpassword server\fR\fR\fI = \fR\fI\fR\fI \fR 6296 .sp 6297 Example: 6298 \fI\fIpassword server\fR\fR\fI = \fR\fINT\-PDC, NT\-BDC1, NT\-BDC2, *\fR\fI \fR 6299 .sp 6300 Example: 6301 \fI\fIpassword server\fR\fR\fI = \fR\fIwindc\.mydomain\.com:389 192\.168\.1\.101 *\fR\fI \fR 6302 .sp 6303 Example: 6304 \fI\fIpassword server\fR\fR\fI = \fR\fI*\fR\fI \fR 6305 .RE 6306 directory.PP 6307 .RS 4 6308 This parameter is a synonym for 6309 path\. 6310 .RE 6311 5140 6312 path (S) 5141 .RS 3n 5142 This parameter specifies a directory to which the user of the service is to be given access. In the case of printable services, this is where print data will spool prior to being submitted to the host for printing. 5143 .sp 5144 For a printable service offering guest access, the service should be readonly and the path should be world-writeable and have the sticky bit set. This is not mandatory of course, but you probably won't get the results you expect if you do otherwise. 6313 .PP 6314 .RS 4 6315 This parameter specifies a directory to which the user of the service is to be given access\. In the case of printable services, this is where print data will spool prior to being submitted to the host for printing\. 6316 .sp 6317 For a printable service offering guest access, the service should be readonly and the path should be world\-writeable and have the sticky bit set\. This is not mandatory of course, but you probably won\'t get the results you expect if you do otherwise\. 5145 6318 .sp 5146 6319 Any occurrences of 5147 6320 \fI%u\fR 5148 in the path will be replaced with the UNIX username that the client is using on this connection . Any occurrences of6321 in the path will be replaced with the UNIX username that the client is using on this connection\. Any occurrences of 5149 6322 \fI%m\fR 5150 will be replaced by the NetBIOS name of the machine they are connecting from . These replacements are very useful for setting up pseudo home directories for users.6323 will be replaced by the NetBIOS name of the machine they are connecting from\. These replacements are very useful for setting up pseudo home directories for users\. 5151 6324 .sp 5152 6325 Note that this path will be based on 5153 root dir if one was specified. 5154 .sp 5155 Default: 5156 \fB\fIpath\fR = \fR 5157 .sp 5158 Example: 5159 \fB\fIpath\fR = /home/fred \fR 5160 .RE 5161 .PP 6326 \fIroot dir\fR 6327 if one was specified\. 6328 .sp 6329 Default: 6330 \fI\fIpath\fR\fR\fI = \fR\fI\fR\fI \fR 6331 .sp 6332 Example: 6333 \fI\fIpath\fR\fR\fI = \fR\fI/home/fred\fR\fI \fR 6334 .RE 6335 5162 6336 pid directory (G) 5163 .RS 3n 5164 This option specifies the directory where pid files will be placed. 5165 .sp 5166 Default: 5167 \fB\fIpid directory\fR = ${prefix}/var/locks \fR 5168 .sp 5169 Example: 5170 \fB\fIpid directory\fR = pid directory = /var/run/ \fR 5171 .RE 5172 .PP 6337 .PP 6338 .RS 4 6339 This option specifies the directory where pid files will be placed\. 6340 .sp 6341 Default: 6342 \fI\fIpid directory\fR\fR\fI = \fR\fI${prefix}/var/locks\fR\fI \fR 6343 .sp 6344 Example: 6345 \fI\fIpid directory\fR\fR\fI = \fR\fIpid directory = /var/run/\fR\fI \fR 6346 .RE 6347 5173 6348 posix locking (S) 5174 .RS 3n 6349 .PP 6350 .RS 4 5175 6351 The 5176 6352 \fBsmbd\fR(8) 5177 daemon maintains an database of file locks obtained by SMB clients . The default behavior is to map this internal database to POSIX locks. This means that file locks obtained by SMB clients are consistent with those seen by POSIX compliant applications accessing the files via a non-SMB method (e.g. NFS or local file access). You should never need to disable this parameter.5178 .sp 5179 Default: 5180 \f B\fIposix locking\fR = yes\fR5181 .RE 5182 .PP 6353 daemon maintains an database of file locks obtained by SMB clients\. The default behavior is to map this internal database to POSIX locks\. This means that file locks obtained by SMB clients are consistent with those seen by POSIX compliant applications accessing the files via a non\-SMB method (e\.g\. NFS or local file access)\. You should never need to disable this parameter\. 6354 .sp 6355 Default: 6356 \fI\fIposix locking\fR\fR\fI = \fR\fIyes\fR\fI \fR 6357 .RE 6358 5183 6359 postexec (S) 5184 .RS 3n 5185 This option specifies a command to be run whenever the service is disconnected. It takes the usual substitutions. The command may be run as the root on some systems. 6360 .PP 6361 .RS 4 6362 This option specifies a command to be run whenever the service is disconnected\. It takes the usual substitutions\. The command may be run as the root on some systems\. 5186 6363 .sp 5187 6364 An interesting example may be to unmount server resources: … … 5190 6367 .sp 5191 6368 Default: 5192 \fB\fIpostexec\fR = \fR 5193 .sp 5194 Example: 5195 \fB\fIpostexec\fR = echo \\"%u disconnected from %S from %m (%I)\\" >> /tmp/log \fR 5196 .RE 5197 .PP 5198 exec 5199 .RS 3n 5200 This parameter is a synonym for preexec. 5201 .RE 5202 .PP 6369 \fI\fIpostexec\fR\fR\fI = \fR\fI\fR\fI \fR 6370 .sp 6371 Example: 6372 \fI\fIpostexec\fR\fR\fI = \fR\fIecho \e"%u disconnected from %S from %m (%I)\e" >> /tmp/log\fR\fI \fR 6373 .RE 6374 6375 preexec close (S) 6376 .PP 6377 .RS 4 6378 This boolean option controls whether a non\-zero return code from 6379 \fIpreexec\fR 6380 should close the service being connected to\. 6381 .sp 6382 Default: 6383 \fI\fIpreexec close\fR\fR\fI = \fR\fIno\fR\fI \fR 6384 .RE 6385 exec.PP 6386 .RS 4 6387 This parameter is a synonym for 6388 preexec\. 6389 .RE 6390 5203 6391 preexec (S) 5204 .RS 3n 5205 This option specifies a command to be run whenever the service is connected to. It takes the usual substitutions. 5206 .sp 5207 An interesting example is to send the users a welcome message every time they log in. Maybe a message of the day? Here is an example: 5208 .sp 5209 5210 preexec = csh -c 'echo \\"Welcome to %S!\\" | /usr/local/samba/bin/smbclient -M %m -I %I' & 5211 .sp 5212 Of course, this could get annoying after a while :-) 6392 .PP 6393 .RS 4 6394 This option specifies a command to be run whenever the service is connected to\. It takes the usual substitutions\. 6395 .sp 6396 An interesting example is to send the users a welcome message every time they log in\. Maybe a message of the day? Here is an example: 6397 .sp 6398 6399 preexec = csh \-c \'echo \e"Welcome to %S!\e" | /usr/local/samba/bin/smbclient \-M %m \-I %I\' & 6400 .sp 6401 Of course, this could get annoying after a while :\-) 5213 6402 .sp 5214 6403 See also 5215 preexec close and 5216 postexec. 5217 .sp 5218 Default: 5219 \fB\fIpreexec\fR = \fR 5220 .sp 5221 Example: 5222 \fB\fIpreexec\fR = echo \\"%u connected to %S from %m (%I)\\" >> /tmp/log \fR 5223 .RE 5224 .PP 5225 preexec close (S) 5226 .RS 3n 5227 This boolean option controls whether a non-zero return code from 5228 preexec should close the service being connected to. 5229 .sp 5230 Default: 5231 \fB\fIpreexec close\fR = no \fR 5232 .RE 5233 .PP 5234 prefered master 5235 .RS 3n 5236 This parameter is a synonym for preferred master. 5237 .RE 5238 .PP 6404 \fIpreexec close\fR 6405 and 6406 \fIpostexec\fR\. 6407 .sp 6408 Default: 6409 \fI\fIpreexec\fR\fR\fI = \fR\fI\fR\fI \fR 6410 .sp 6411 Example: 6412 \fI\fIpreexec\fR\fR\fI = \fR\fIecho \e"%u connected to %S from %m (%I)\e" >> /tmp/log\fR\fI \fR 6413 .RE 6414 prefered master.PP 6415 .RS 4 6416 This parameter is a synonym for 6417 preferred master\. 6418 .RE 6419 5239 6420 preferred master (G) 5240 .RS 3n 6421 .PP 6422 .RS 4 5241 6423 This boolean parameter controls if 5242 6424 \fBnmbd\fR(8) 5243 is a preferred master browser for its workgroup .6425 is a preferred master browser for its workgroup\. 5244 6426 .sp 5245 6427 If this is set to 5246 6428 \fByes\fR, on startup, 5247 6429 nmbd 5248 will force an election, and it will have a slight advantage in winning the election . It is recommended that this parameter is used in conjunction with5249 domain master = yes, so that6430 will force an election, and it will have a slight advantage in winning the election\. It is recommended that this parameter is used in conjunction with 6431 \fIdomain master = yes\fR, so that 5250 6432 nmbd 5251 can guarantee becoming a domain master. 5252 .sp 5253 Use this option with caution, because if there are several hosts (whether Samba servers, Windows 95 or NT) that are preferred master browsers on the same subnet, they will each periodically and continuously attempt to become the local master browser. This will result in unnecessary broadcast traffic and reduced browsing capabilities. 5254 .sp 5255 Default: 5256 \fB\fIpreferred master\fR = auto \fR 5257 .RE 5258 .PP 5259 auto services 5260 .RS 3n 5261 This parameter is a synonym for preload. 5262 .RE 5263 .PP 6433 can guarantee becoming a domain master\. 6434 .sp 6435 Use this option with caution, because if there are several hosts (whether Samba servers, Windows 95 or NT) that are preferred master browsers on the same subnet, they will each periodically and continuously attempt to become the local master browser\. This will result in unnecessary broadcast traffic and reduced browsing capabilities\. 6436 .sp 6437 Default: 6438 \fI\fIpreferred master\fR\fR\fI = \fR\fIauto\fR\fI \fR 6439 .RE 6440 6441 preload modules (G) 6442 .PP 6443 .RS 4 6444 This is a list of paths to modules that should be loaded into smbd before a client connects\. This improves the speed of smbd when reacting to new connections somewhat\. 6445 .sp 6446 Default: 6447 \fI\fIpreload modules\fR\fR\fI = \fR\fI\fR\fI \fR 6448 .sp 6449 Example: 6450 \fI\fIpreload modules\fR\fR\fI = \fR\fI/usr/lib/samba/passdb/mysql\.so\fR\fI \fR 6451 .RE 6452 auto services.PP 6453 .RS 4 6454 This parameter is a synonym for 6455 preload\. 6456 .RE 6457 5264 6458 preload (G) 5265 .RS 3n 5266 This is a list of services that you want to be automatically added to the browse lists. This is most useful for homes and printers services that would otherwise not be visible. 6459 .PP 6460 .RS 4 6461 This is a list of services that you want to be automatically added to the browse lists\. This is most useful for homes and printers services that would otherwise not be visible\. 5267 6462 .sp 5268 6463 Note that if you just want all printers in your printcap file loaded then the 5269 load printers option is easier. 5270 .sp 5271 Default: 5272 \fB\fIpreload\fR = \fR 5273 .sp 5274 Example: 5275 \fB\fIpreload\fR = fred lp colorlp \fR 5276 .RE 5277 .PP 5278 preload modules (G) 5279 .RS 3n 5280 This is a list of paths to modules that should be loaded into smbd before a client connects. This improves the speed of smbd when reacting to new connections somewhat. 5281 .sp 5282 Default: 5283 \fB\fIpreload modules\fR = \fR 5284 .sp 5285 Example: 5286 \fB\fIpreload modules\fR = /usr/lib/samba/passdb/mysql.so \fR 5287 .RE 5288 .PP 6464 \fIload printers\fR 6465 option is easier\. 6466 .sp 6467 Default: 6468 \fI\fIpreload\fR\fR\fI = \fR\fI\fR\fI \fR 6469 .sp 6470 Example: 6471 \fI\fIpreload\fR\fR\fI = \fR\fIfred lp colorlp\fR\fI \fR 6472 .RE 6473 5289 6474 preserve case (S) 5290 .RS 3n 6475 .PP 6476 .RS 4 5291 6477 This controls if new filenames are created with the case that the client passes, or if they are forced to be the 5292 default case.6478 \fIdefault case\fR\. 5293 6479 .sp 5294 6480 See the section on 5295 6481 NAME MANGLING 5296 for a fuller discussion .5297 .sp 5298 Default: 5299 \f B\fIpreserve case\fR = yes\fR5300 .RE 5301 .PP5302 print ok 5303 .RS 3n 5304 This parameter is a synonym for printable.5305 .RE 5306 .PP 6482 for a fuller discussion\. 6483 .sp 6484 Default: 6485 \fI\fIpreserve case\fR\fR\fI = \fR\fIyes\fR\fI \fR 6486 .RE 6487 print ok.PP 6488 .RS 4 6489 This parameter is a synonym for 6490 printable\. 6491 .RE 6492 5307 6493 printable (S) 5308 .RS 3n 6494 .PP 6495 .RS 4 5309 6496 If this parameter is 5310 \fByes\fR, then clients may open, write to and submit spool files on the directory specified for the service. 5311 .sp 5312 Note that a printable service will ALWAYS allow writing to the service path (user privileges permitting) via the spooling of print data. The 5313 read only parameter controls only non-printing access to the resource. 5314 .sp 5315 Default: 5316 \fB\fIprintable\fR = no \fR 5317 .RE 5318 .PP 6497 \fByes\fR, then clients may open, write to and submit spool files on the directory specified for the service\. 6498 .sp 6499 Note that a printable service will ALWAYS allow writing to the service path (user privileges permitting) via the spooling of print data\. The 6500 \fIread only\fR 6501 parameter controls only non\-printing access to the resource\. 6502 .sp 6503 Default: 6504 \fI\fIprintable\fR\fR\fI = \fR\fIno\fR\fI \fR 6505 .RE 6506 5319 6507 printcap cache time (G) 5320 .RS 3n 5321 This option specifies the number of seconds before the printing subsystem is again asked for the known printers. If the value is greater than 60 the initial waiting time is set to 60 seconds to allow an earlier first rescan of the printing subsystem. 5322 .sp 5323 Setting this parameter to 0 disables any rescanning for new or removed printers after the initial startup. 5324 .sp 5325 Default: 5326 \fB\fIprintcap cache time\fR = 750 \fR 5327 .sp 5328 Example: 5329 \fB\fIprintcap cache time\fR = 600 \fR 5330 .RE 5331 .PP 5332 printcap 5333 .RS 3n 5334 This parameter is a synonym for printcap name. 5335 .RE 5336 .PP 6508 .PP 6509 .RS 4 6510 This option specifies the number of seconds before the printing subsystem is again asked for the known printers\. If the value is greater than 60 the initial waiting time is set to 60 seconds to allow an earlier first rescan of the printing subsystem\. 6511 .sp 6512 Setting this parameter to 0 disables any rescanning for new or removed printers after the initial startup\. 6513 .sp 6514 Default: 6515 \fI\fIprintcap cache time\fR\fR\fI = \fR\fI750\fR\fI \fR 6516 .sp 6517 Example: 6518 \fI\fIprintcap cache time\fR\fR\fI = \fR\fI600\fR\fI \fR 6519 .RE 6520 printcap.PP 6521 .RS 4 6522 This parameter is a synonym for 6523 printcap name\. 6524 .RE 6525 5337 6526 printcap name (S) 5338 .RS 3n 5339 This parameter may be used to override the compiled-in default printcap name used by the server (usually 5340 \fI /etc/printcap\fR). See the discussion of the 6527 .PP 6528 .RS 4 6529 This parameter may be used to override the compiled\-in default printcap name used by the server (usually 6530 \fI /etc/printcap\fR)\. See the discussion of the 5341 6531 [printers] 5342 section above for reasons why you might want to do this .6532 section above for reasons why you might want to do this\. 5343 6533 .sp 5344 6534 To use the CUPS printing interface set 5345 printcap name = cups. This should be supplemented by an addtional setting 5346 printing = cups in the [global] section. 6535 printcap name = cups\. This should be supplemented by an addtional setting 6536 \fIprinting = cups\fR 6537 in the [global] section\. 5347 6538 printcap name = cups 5348 will use the "dummy" printcap created by CUPS, as specified in your CUPS configuration file .6539 will use the "dummy" printcap created by CUPS, as specified in your CUPS configuration file\. 5349 6540 .sp 5350 6541 On System V systems that use … … 5352 6543 to list available printers you can use 5353 6544 printcap name = lpstat 5354 to automatically obtain lists of available printers . This is the default for systems that define SYSV at configure time in Samba (this includes most System V based systems). If6545 to automatically obtain lists of available printers\. This is the default for systems that define SYSV at configure time in Samba (this includes most System V based systems)\. If 5355 6546 \fI printcap name\fR 5356 6547 is set to 5357 6548 lpstat 5358 6549 on these systems then Samba will launch 5359 lpstat -v5360 and attempt to parse the output to obtain a printer list .6550 lpstat \-v 6551 and attempt to parse the output to obtain a printer list\. 5361 6552 .sp 5362 6553 A minimal printcap file would look something like this: 5363 5364 .sp 5365 6554 .sp 6555 .RS 4 5366 6556 .nf 5367 5368 6557 print1|My Printer 1 5369 6558 print2|My Printer 2 … … 5371 6560 print4|My Printer 4 5372 6561 print5|My Printer 5 5373 5374 6562 .fi 5375 where the '|' separates aliases of a printer. The fact that the second alias has a space in it gives a hint to Samba that it's a comment. 6563 .RE 6564 .sp 6565 where the \'|\' separates aliases of a printer\. The fact that the second alias has a space in it gives a hint to Samba that it\'s a comment\. 5376 6566 .sp 5377 6567 .it 1 an-trap … … 5379 6569 .nr an-break-flag 1 5380 6570 .br 5381 \fBNote\fR 6571 Note 5382 6572 Under AIX the default printcap name is 5383 \fI/etc/qconfig\fR . Samba will assume the file is in AIX6573 \fI/etc/qconfig\fR\. Samba will assume the file is in AIX 5384 6574 \fIqconfig\fR 5385 6575 format if the string 5386 6576 \fIqconfig\fR 5387 appears in the printcap filename. 5388 Default: 5389 \fB\fIprintcap name\fR = /etc/printcap \fR 5390 .sp 5391 Example: 5392 \fB\fIprintcap name\fR = /etc/myprintcap \fR 5393 .RE 5394 .PP 6577 appears in the printcap filename\. 6578 6579 Default: 6580 \fI\fIprintcap name\fR\fR\fI = \fR\fI/etc/printcap\fR\fI \fR 6581 .sp 6582 Example: 6583 \fI\fIprintcap name\fR\fR\fI = \fR\fI/etc/myprintcap\fR\fI \fR 6584 .RE 6585 5395 6586 print command (S) 5396 .RS 3n 6587 .PP 6588 .RS 4 5397 6589 After a print job has finished spooling to a service, this command will be used via a 5398 6590 system() 5399 call to process the spool file . Typically the command specified will submit the spool file to the host's printing subsystem, but there is no requirement that this be the case. The server will not remove the spool file, so whatever command you specify should remove the spool file when it has been processed, otherwise you will need to manually remove old spool files.5400 .sp 5401 The print command is simply a text string . It will be used verbatim after macro substitutions have been made:5402 .sp 5403 %s, %f - the path to the spool file name5404 .sp 5405 %p - the appropriate printer name5406 .sp 5407 %J - the job name as transmitted by the client.5408 .sp 5409 %c - The number of printed pages of the spooled job (if known).5410 .sp 5411 %z - the size of the spooled print job (in bytes)6591 call to process the spool file\. Typically the command specified will submit the spool file to the host\'s printing subsystem, but there is no requirement that this be the case\. The server will not remove the spool file, so whatever command you specify should remove the spool file when it has been processed, otherwise you will need to manually remove old spool files\. 6592 .sp 6593 The print command is simply a text string\. It will be used verbatim after macro substitutions have been made: 6594 .sp 6595 %s, %f \- the path to the spool file name 6596 .sp 6597 %p \- the appropriate printer name 6598 .sp 6599 %J \- the job name as transmitted by the client\. 6600 .sp 6601 %c \- The number of printed pages of the spooled job (if known)\. 6602 .sp 6603 %z \- the size of the spooled print job (in bytes) 5412 6604 .sp 5413 6605 The print command 5414 \f BMUST\fR6606 \fIMUST\fR 5415 6607 contain at least one occurrence of 5416 6608 \fI%s\fR 5417 6609 or 5418 6610 \fI%f \fR 5419 - the6611 \- the 5420 6612 \fI%p\fR 5421 is optional . At the time a job is submitted, if no printer name is supplied the6613 is optional\. At the time a job is submitted, if no printer name is supplied the 5422 6614 \fI%p \fR 5423 will be silently removed from the printer command .5424 .sp 5425 If specified in the [global] section, the print command given will be used for any printable service that does not have its own print command specified .5426 .sp 5427 If there is neither a specified print command for a printable service nor a global print command, spool files will be created but not processed and (most importantly) not removed .6615 will be silently removed from the printer command\. 6616 .sp 6617 If specified in the [global] section, the print command given will be used for any printable service that does not have its own print command specified\. 6618 .sp 6619 If there is neither a specified print command for a printable service nor a global print command, spool files will be created but not processed and (most importantly) not removed\. 5428 6620 .sp 5429 6621 Note that printing may fail on some UNIXes from the 5430 6622 \fBnobody\fR 5431 account. If this happens then create an alternative guest account that can print and set the 5432 guest account in the [global] section. 5433 .sp 5434 You can form quite complex print commands by realizing that they are just passed to a shell. For example the following will log a print job, print the file, then remove it. Note that ';' is the usual separator for command in shell scripts. 5435 .sp 5436 print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s; rm %s 5437 .sp 5438 You may have to vary this command considerably depending on how you normally print files on your system. The default for the parameter varies depending on the setting of the 5439 printing parameter. 6623 account\. If this happens then create an alternative guest account that can print and set the 6624 \fIguest account\fR 6625 in the [global] section\. 6626 .sp 6627 You can form quite complex print commands by realizing that they are just passed to a shell\. For example the following will log a print job, print the file, then remove it\. Note that \';\' is the usual separator for command in shell scripts\. 6628 .sp 6629 print command = echo Printing %s >> /tmp/print\.log; lpr \-P %p %s; rm %s 6630 .sp 6631 You may have to vary this command considerably depending on how you normally print files on your system\. The default for the parameter varies depending on the setting of the 6632 \fIprinting\fR 6633 parameter\. 5440 6634 .sp 5441 6635 Default: For 5442 6636 printing = BSD, AIX, QNX, LPRNG or PLP : 5443 6637 .sp 5444 print command = lpr -r-P%p %s6638 print command = lpr \-r \-P%p %s 5445 6639 .sp 5446 6640 For 5447 6641 printing = SYSV or HPUX : 5448 6642 .sp 5449 print command = lp -c-d%p %s; rm %s6643 print command = lp \-c \-d%p %s; rm %s 5450 6644 .sp 5451 6645 For 5452 6646 printing = SOFTQ : 5453 6647 .sp 5454 print command = lp -d%p-s %s; rm %s6648 print command = lp \-d%p \-s %s; rm %s 5455 6649 .sp 5456 6650 For printing = CUPS : If SAMBA is compiled against libcups, then 5457 printcap = cups uses the CUPS API to submit jobs, etc. Otherwise it maps to the System V commands with the -oraw option for printing, i.e. it uses 5458 lp -c -d%p -oraw; rm %s. With 5459 printing = cups, and if SAMBA is compiled against libcups, any manually set print command will be ignored. 5460 .sp 5461 \fBNo default\fR 5462 .sp 5463 Example: 5464 \fB\fIprint command\fR = /usr/local/samba/bin/myprintscript %p %s \fR 5465 .RE 5466 .PP 6651 \fIprintcap = cups\fR 6652 uses the CUPS API to submit jobs, etc\. Otherwise it maps to the System V commands with the \-oraw option for printing, i\.e\. it uses 6653 lp \-c \-d%p \-oraw; rm %s\. With 6654 printing = cups, and if SAMBA is compiled against libcups, any manually set print command will be ignored\. 6655 .sp 6656 \fINo default\fR 6657 .sp 6658 Example: 6659 \fI\fIprint command\fR\fR\fI = \fR\fI/usr/local/samba/bin/myprintscript %p %s\fR\fI \fR 6660 .RE 6661 5467 6662 printer admin (S) 5468 .RS 3n 5469 This lists users who can do anything to printers via the remote administration interfaces offered by MS-RPC (usually using a NT workstation). This parameter can be set per-share or globally. Note: The root user always has admin rights. Use caution with use in the global stanza as this can cause side effects. 5470 .sp 5471 This parameter has been marked deprecated in favor of using the SePrintOperatorPrivilege and individual print security descriptors. It will be removed in a future release. 5472 .sp 5473 Default: 5474 \fB\fIprinter admin\fR = \fR 5475 .sp 5476 Example: 5477 \fB\fIprinter admin\fR = admin, @staff \fR 5478 .RE 5479 .PP 5480 printer 5481 .RS 3n 5482 This parameter is a synonym for printer name. 5483 .RE 5484 .PP 6663 .PP 6664 .RS 4 6665 This lists users who can do anything to printers via the remote administration interfaces offered by MS\-RPC (usually using a NT workstation)\. This parameter can be set per\-share or globally\. Note: The root user always has admin rights\. Use caution with use in the global stanza as this can cause side effects\. 6666 .sp 6667 This parameter has been marked deprecated in favor of using the SePrintOperatorPrivilege and individual print security descriptors\. It will be removed in a future release\. 6668 .sp 6669 Default: 6670 \fI\fIprinter admin\fR\fR\fI = \fR\fI\fR\fI \fR 6671 .sp 6672 Example: 6673 \fI\fIprinter admin\fR\fR\fI = \fR\fIadmin, @staff\fR\fI \fR 6674 .RE 6675 printer.PP 6676 .RS 4 6677 This parameter is a synonym for 6678 printer name\. 6679 .RE 6680 5485 6681 printer name (S) 5486 .RS 3n 5487 This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent. 5488 .sp 5489 If specified in the [global] section, the printer name given will be used for any printable service that does not have its own printer name specified. 6682 .PP 6683 .RS 4 6684 This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent\. 6685 .sp 6686 If specified in the [global] section, the printer name given will be used for any printable service that does not have its own printer name specified\. 5490 6687 .sp 5491 6688 The default value of the 5492 printer name may be 6689 \fIprinter name\fR 6690 may be 5493 6691 lp 5494 on many systems .5495 .sp 5496 Default: 5497 \f B\fIprinter name\fR = none\fR5498 .sp 5499 Example: 5500 \f B\fIprinter name\fR = laserwriter\fR5501 .RE 5502 .PP 6692 on many systems\. 6693 .sp 6694 Default: 6695 \fI\fIprinter name\fR\fR\fI = \fR\fInone\fR\fI \fR 6696 .sp 6697 Example: 6698 \fI\fIprinter name\fR\fR\fI = \fR\fIlaserwriter\fR\fI \fR 6699 .RE 6700 5503 6701 printing (S) 5504 .RS 3n 5505 This parameters controls how printer status information is interpreted on your system. It also affects the default values for the 6702 .PP 6703 .RS 4 6704 This parameters controls how printer status information is interpreted on your system\. It also affects the default values for the 5506 6705 \fIprint command\fR, 5507 6706 \fIlpq command\fR, … … 5509 6708 \fIlpresume command\fR, and 5510 6709 \fIlprm command\fR 5511 if specified in the [global] section .5512 .sp 5513 Currently nine printing styles are supported . They are6710 if specified in the [global] section\. 6711 .sp 6712 Currently nine printing styles are supported\. They are 5514 6713 \fBBSD\fR, 5515 6714 \fBAIX\fR, … … 5520 6719 \fBQNX\fR, 5521 6720 \fBSOFTQ\fR, and 5522 \fBCUPS\fR .6721 \fBCUPS\fR\. 5523 6722 .sp 5524 6723 To see what the defaults are for the other print commands when using the various options use the 5525 6724 \fBtestparm\fR(1) 5526 program .5527 .sp 5528 This option can be set on a per printer basis . Please be aware however, that you must place any of the various printing commands (e.g. print command, lpq command, etc...) after defining the value for the6725 program\. 6726 .sp 6727 This option can be set on a per printer basis\. Please be aware however, that you must place any of the various printing commands (e\.g\. print command, lpq command, etc\.\.\.) after defining the value for the 5529 6728 \fIprinting\fR 5530 option since it will reset the printing commands to default values .6729 option since it will reset the printing commands to default values\. 5531 6730 .sp 5532 6731 See also the discussion in the 5533 6732 [printers] 5534 section .5535 .sp 5536 \f BNo default\fR5537 .RE 5538 .PP 6733 section\. 6734 .sp 6735 \fINo default\fR 6736 .RE 6737 5539 6738 printjob username (S) 5540 .RS 3n 5541 This parameter specifies which user information will be passed to the printing system. Usually, the username is sent, but in some cases, e.g. the domain prefix is useful, too. 5542 .sp 5543 Default: 5544 \fB\fIprintjob username\fR = %U \fR 5545 .sp 5546 Example: 5547 \fB\fIprintjob username\fR = %D\\%U \fR 5548 .RE 5549 .PP 6739 .PP 6740 .RS 4 6741 This parameter specifies which user information will be passed to the printing system\. Usually, the username is sent, but in some cases, e\.g\. the domain prefix is useful, too\. 6742 .sp 6743 Default: 6744 \fI\fIprintjob username\fR\fR\fI = \fR\fI%U\fR\fI \fR 6745 .sp 6746 Example: 6747 \fI\fIprintjob username\fR\fR\fI = \fR\fI%D\e%U\fR\fI \fR 6748 .RE 6749 5550 6750 private dir (G) 5551 .RS 3n 6751 .PP 6752 .RS 4 5552 6753 This parameters defines the directory smbd will use for storing such files as 5553 6754 \fIsmbpasswd\fR 5554 6755 and 5555 \fIsecrets .tdb\fR.5556 .sp 5557 Default: 5558 \f B\fIprivate dir\fR = ${prefix}/private\fR5559 .RE 5560 .PP 6756 \fIsecrets\.tdb\fR\. 6757 .sp 6758 Default: 6759 \fI\fIprivate dir\fR\fR\fI = \fR\fI${prefix}/private\fR\fI \fR 6760 .RE 6761 5561 6762 profile acls (S) 5562 .RS 3n 5563 This boolean parameter was added to fix the problems that people have been having with storing user profiles on Samba shares from Windows 2000 or Windows XP clients. New versions of Windows 2000 or Windows XP service packs do security ACL checking on the owner and ability to write of the profile directory stored on a local workstation when copied from a Samba share. 5564 .sp 5565 When not in domain mode with winbindd then the security info copied onto the local workstation has no meaning to the logged in user (SID) on that workstation so the profile storing fails. Adding this parameter onto a share used for profile storage changes two things about the returned Windows ACL. Firstly it changes the owner and group owner of all reported files and directories to be BUILTIN\\Administrators, BUILTIN\\Users respectively (SIDs S-1-5-32-544, S-1-5-32-545). Secondly it adds an ACE entry of "Full Control" to the SID BUILTIN\\Users to every returned ACL. This will allow any Windows 2000 or XP workstation user to access the profile. 5566 .sp 5567 Note that if you have multiple users logging on to a workstation then in order to prevent them from being able to access each others profiles you must remove the "Bypass traverse checking" advanced user right. This will prevent access to other users profile directories as the top level profile directory (named after the user) is created by the workstation profile code and has an ACL restricting entry to the directory tree to the owning user. 5568 .sp 5569 Default: 5570 \fB\fIprofile acls\fR = no \fR 5571 .RE 5572 .PP 6763 .PP 6764 .RS 4 6765 This boolean parameter was added to fix the problems that people have been having with storing user profiles on Samba shares from Windows 2000 or Windows XP clients\. New versions of Windows 2000 or Windows XP service packs do security ACL checking on the owner and ability to write of the profile directory stored on a local workstation when copied from a Samba share\. 6766 .sp 6767 When not in domain mode with winbindd then the security info copied onto the local workstation has no meaning to the logged in user (SID) on that workstation so the profile storing fails\. Adding this parameter onto a share used for profile storage changes two things about the returned Windows ACL\. Firstly it changes the owner and group owner of all reported files and directories to be BUILTIN\e\eAdministrators, BUILTIN\e\eUsers respectively (SIDs S\-1\-5\-32\-544, S\-1\-5\-32\-545)\. Secondly it adds an ACE entry of "Full Control" to the SID BUILTIN\e\eUsers to every returned ACL\. This will allow any Windows 2000 or XP workstation user to access the profile\. 6768 .sp 6769 Note that if you have multiple users logging on to a workstation then in order to prevent them from being able to access each others profiles you must remove the "Bypass traverse checking" advanced user right\. This will prevent access to other users profile directories as the top level profile directory (named after the user) is created by the workstation profile code and has an ACL restricting entry to the directory tree to the owning user\. 6770 .sp 6771 Default: 6772 \fI\fIprofile acls\fR\fR\fI = \fR\fIno\fR\fI \fR 6773 .RE 6774 5573 6775 queuepause command (S) 5574 .RS 3n 5575 This parameter specifies the command to be executed on the server host in order to pause the printer queue. 5576 .sp 5577 This command should be a program or script which takes a printer name as its only parameter and stops the printer queue, such that no longer jobs are submitted to the printer. 5578 .sp 5579 This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT. 6776 .PP 6777 .RS 4 6778 This parameter specifies the command to be executed on the server host in order to pause the printer queue\. 6779 .sp 6780 This command should be a program or script which takes a printer name as its only parameter and stops the printer queue, such that no longer jobs are submitted to the printer\. 6781 .sp 6782 This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\. 5580 6783 .sp 5581 6784 If a 5582 6785 \fI%p\fR 5583 is given then the printer name is put in its place . Otherwise it is placed at the end of the command.5584 .sp 5585 Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server .5586 .sp 5587 \f BNo default\fR5588 .sp 5589 Example: 5590 \f B\fIqueuepause command\fR = disable %p\fR5591 .RE 5592 .PP 6786 is given then the printer name is put in its place\. Otherwise it is placed at the end of the command\. 6787 .sp 6788 Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\. 6789 .sp 6790 \fINo default\fR 6791 .sp 6792 Example: 6793 \fI\fIqueuepause command\fR\fR\fI = \fR\fIdisable %p\fR\fI \fR 6794 .RE 6795 5593 6796 queueresume command (S) 5594 .RS 3n 5595 This parameter specifies the command to be executed on the server host in order to resume the printer queue. It is the command to undo the behavior that is caused by the previous parameter (queuepause command). 5596 .sp 5597 This command should be a program or script which takes a printer name as its only parameter and resumes the printer queue, such that queued jobs are resubmitted to the printer. 5598 .sp 5599 This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT. 6797 .PP 6798 .RS 4 6799 This parameter specifies the command to be executed on the server host in order to resume the printer queue\. It is the command to undo the behavior that is caused by the previous parameter (\fIqueuepause command\fR)\. 6800 .sp 6801 This command should be a program or script which takes a printer name as its only parameter and resumes the printer queue, such that queued jobs are resubmitted to the printer\. 6802 .sp 6803 This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\. 5600 6804 .sp 5601 6805 If a 5602 6806 \fI%p\fR 5603 is given then the printer name is put in its place . Otherwise it is placed at the end of the command.5604 .sp 5605 Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server .5606 .sp 5607 Default: 5608 \f B\fIqueueresume command\fR =\fR5609 .sp 5610 Example: 5611 \f B\fIqueueresume command\fR = enable %p\fR5612 .RE 5613 .PP 6807 is given then the printer name is put in its place\. Otherwise it is placed at the end of the command\. 6808 .sp 6809 Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\. 6810 .sp 6811 Default: 6812 \fI\fIqueueresume command\fR\fR\fI = \fR\fI\fR\fI \fR 6813 .sp 6814 Example: 6815 \fI\fIqueueresume command\fR\fR\fI = \fR\fIenable %p\fR\fI \fR 6816 .RE 6817 5614 6818 read bmpx (G) 5615 .RS 3n 6819 .PP 6820 .RS 4 5616 6821 This boolean parameter controls whether 5617 6822 \fBsmbd\fR(8) 5618 will support the "Read Block Multiplex" SMB . This is now rarely used and defaults to5619 \fBno\fR . You should never need to set this parameter.5620 .sp 5621 Default: 5622 \f B\fIread bmpx\fR = no\fR5623 .RE 5624 .PP 6823 will support the "Read Block Multiplex" SMB\. This is now rarely used and defaults to 6824 \fBno\fR\. You should never need to set this parameter\. 6825 .sp 6826 Default: 6827 \fI\fIread bmpx\fR\fR\fI = \fR\fIno\fR\fI \fR 6828 .RE 6829 5625 6830 read list (S) 5626 .RS 3n 5627 This is a list of users that are given read-only access to a service. If the connecting user is in this list then they will not be given write access, no matter what the 5628 read only option is set to. The list can include group names using the syntax described in the 5629 invalid users parameter. 6831 .PP 6832 .RS 4 6833 This is a list of users that are given read\-only access to a service\. If the connecting user is in this list then they will not be given write access, no matter what the 6834 \fIread only\fR 6835 option is set to\. The list can include group names using the syntax described in the 6836 \fIinvalid users\fR 6837 parameter\. 5630 6838 .sp 5631 6839 This parameter will not work with the 5632 security = share in Samba 3.0. This is by design. 5633 .sp 5634 Default: 5635 \fB\fIread list\fR = \fR 5636 .sp 5637 Example: 5638 \fB\fIread list\fR = mary, @students \fR 5639 .RE 5640 .PP 6840 \fIsecurity = share\fR 6841 in Samba 3\.0\. This is by design\. 6842 .sp 6843 Default: 6844 \fI\fIread list\fR\fR\fI = \fR\fI\fR\fI \fR 6845 .sp 6846 Example: 6847 \fI\fIread list\fR\fR\fI = \fR\fImary, @students\fR\fI \fR 6848 .RE 6849 5641 6850 read only (S) 5642 .RS 3n 6851 .PP 6852 .RS 4 5643 6853 An inverted synonym is 5644 writeable.6854 \fIwriteable\fR\. 5645 6855 .sp 5646 6856 If this parameter is 5647 \fByes\fR, then users of a service may not create or modify files in the service 's directory.6857 \fByes\fR, then users of a service may not create or modify files in the service\'s directory\. 5648 6858 .sp 5649 6859 Note that a printable service (printable = yes) will 5650 \f BALWAYS\fR5651 allow writing to the directory (user privileges permitting), but only via spooling operations .5652 .sp 5653 Default: 5654 \f B\fIread only\fR = yes\fR5655 .RE 5656 .PP 6860 \fIALWAYS\fR 6861 allow writing to the directory (user privileges permitting), but only via spooling operations\. 6862 .sp 6863 Default: 6864 \fI\fIread only\fR\fR\fI = \fR\fIyes\fR\fI \fR 6865 .RE 6866 5657 6867 read raw (G) 5658 .RS 3n 5659 This parameter controls whether or not the server will support the raw read SMB requests when transferring data to clients. 5660 .sp 5661 If enabled, raw reads allow reads of 65535 bytes in one packet. This typically provides a major performance benefit. 5662 .sp 5663 However, some clients either negotiate the allowable block size incorrectly or are incapable of supporting larger block sizes, and for these clients you may need to disable raw reads. 5664 .sp 5665 In general this parameter should be viewed as a system tuning tool and left severely alone. 5666 .sp 5667 Default: 5668 \fB\fIread raw\fR = yes \fR 5669 .RE 5670 .PP 6868 .PP 6869 .RS 4 6870 This parameter controls whether or not the server will support the raw read SMB requests when transferring data to clients\. 6871 .sp 6872 If enabled, raw reads allow reads of 65535 bytes in one packet\. This typically provides a major performance benefit\. 6873 .sp 6874 However, some clients either negotiate the allowable block size incorrectly or are incapable of supporting larger block sizes, and for these clients you may need to disable raw reads\. 6875 .sp 6876 In general this parameter should be viewed as a system tuning tool and left severely alone\. 6877 .sp 6878 Default: 6879 \fI\fIread raw\fR\fR\fI = \fR\fIyes\fR\fI \fR 6880 .RE 6881 5671 6882 realm (G) 5672 .RS 3n 5673 This option specifies the kerberos realm to use. The realm is used as the ADS equivalent of the NT4 5674 domain. It is usually set to the DNS name of the kerberos server. 5675 .sp 5676 Default: 5677 \fB\fIrealm\fR = \fR 5678 .sp 5679 Example: 5680 \fB\fIrealm\fR = mysambabox.mycompany.com \fR 5681 .RE 5682 .PP 6883 .PP 6884 .RS 4 6885 This option specifies the kerberos realm to use\. The realm is used as the ADS equivalent of the NT4 6886 domain\. It is usually set to the DNS name of the kerberos server\. 6887 .sp 6888 Default: 6889 \fI\fIrealm\fR\fR\fI = \fR\fI\fR\fI \fR 6890 .sp 6891 Example: 6892 \fI\fIrealm\fR\fR\fI = \fR\fImysambabox\.mycompany\.com\fR\fI \fR 6893 .RE 6894 5683 6895 remote announce (G) 5684 .RS 3n 6896 .PP 6897 .RS 4 5685 6898 This option allows you to setup 5686 \fBnmbd\fR(8)to periodically announce itself to arbitrary IP addresses with an arbitrary workgroup name .5687 .sp 5688 This is useful if you want your Samba server to appear in a remote workgroup for which the normal browse propagation rules don 't work. The remote workgroup can be anywhere that you can send IP packets to.6899 \fBnmbd\fR(8)to periodically announce itself to arbitrary IP addresses with an arbitrary workgroup name\. 6900 .sp 6901 This is useful if you want your Samba server to appear in a remote workgroup for which the normal browse propagation rules don\'t work\. The remote workgroup can be anywhere that you can send IP packets to\. 5689 6902 .sp 5690 6903 For example: 5691 5692 .sp 5693 6904 .sp 6905 .RS 4 5694 6906 .nf 5695 5696 remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF 5697 6907 remote announce = 192\.168\.2\.255/SERVERS 192\.168\.4\.255/STAFF 5698 6908 .fi 6909 .RE 6910 .sp 5699 6911 the above line would cause 5700 6912 nmbd 5701 to announce itself to the two given IP addresses using the given workgroup names. If you leave out the workgroup name then the one given in the 5702 workgroup parameter is used instead. 5703 .sp 5704 The IP addresses you choose would normally be the broadcast addresses of the remote networks, but can also be the IP addresses of known browse masters if your network config is that stable. 5705 .sp 5706 See the chapter on Network Browsing in the Samba-HOWTO book. 5707 .sp 5708 Default: 5709 \fB\fIremote announce\fR = \fR 5710 .RE 5711 .PP 6913 to announce itself to the two given IP addresses using the given workgroup names\. If you leave out the workgroup name then the one given in the 6914 \fIworkgroup\fR 6915 parameter is used instead\. 6916 .sp 6917 The IP addresses you choose would normally be the broadcast addresses of the remote networks, but can also be the IP addresses of known browse masters if your network config is that stable\. 6918 .sp 6919 See the chapter on Network Browsing in the Samba\-HOWTO book\. 6920 .sp 6921 Default: 6922 \fI\fIremote announce\fR\fR\fI = \fR\fI\fR\fI \fR 6923 .RE 6924 5712 6925 remote browse sync (G) 5713 .RS 3n 6926 .PP 6927 .RS 4 5714 6928 This option allows you to setup 5715 6929 \fBnmbd\fR(8) 5716 to periodically request synchronization of browse lists with the master browser of a Samba server that is on a remote segment . This option will allow you to gain browse lists for multiple workgroups across routed networks. This is done in a manner that does not work with any non-Samba servers.5717 .sp 5718 This is useful if you want your Samba server and all local clients to appear in a remote workgroup for which the normal browse propagation rules don 't work. The remote workgroup can be anywhere that you can send IP packets to.6930 to periodically request synchronization of browse lists with the master browser of a Samba server that is on a remote segment\. This option will allow you to gain browse lists for multiple workgroups across routed networks\. This is done in a manner that does not work with any non\-Samba servers\. 6931 .sp 6932 This is useful if you want your Samba server and all local clients to appear in a remote workgroup for which the normal browse propagation rules don\'t work\. The remote workgroup can be anywhere that you can send IP packets to\. 5719 6933 .sp 5720 6934 For example: 5721 5722 .sp 5723 6935 .sp 6936 .RS 4 5724 6937 .nf 5725 5726 \fIremote browse sync = 192.168.2.255 192.168.4.255\fR 5727 6938 \fIremote browse sync = 192\.168\.2\.255 192\.168\.4\.255\fR 5728 6939 .fi 6940 .RE 6941 .sp 5729 6942 the above line would cause 5730 6943 nmbd 5731 to request the master browser on the specified subnets or addresses to synchronize their browse lists with the local server .5732 .sp 5733 The IP addresses you choose would normally be the broadcast addresses of the remote networks, but can also be the IP addresses of known browse masters if your network config is that stable . If a machine IP address is given Samba makes NO attempt to validate that the remote machine is available, is listening, nor that it is in fact the browse master on its segment.6944 to request the master browser on the specified subnets or addresses to synchronize their browse lists with the local server\. 6945 .sp 6946 The IP addresses you choose would normally be the broadcast addresses of the remote networks, but can also be the IP addresses of known browse masters if your network config is that stable\. If a machine IP address is given Samba makes NO attempt to validate that the remote machine is available, is listening, nor that it is in fact the browse master on its segment\. 5734 6947 .sp 5735 6948 The 5736 remote browse sync may be used on networks where there is no WINS server, and may be used on disjoint networks where each network has its own WINS server. 5737 .sp 5738 Default: 5739 \fB\fIremote browse sync\fR = \fR 5740 .RE 5741 .PP 6949 \fIremote browse sync\fR 6950 may be used on networks where there is no WINS server, and may be used on disjoint networks where each network has its own WINS server\. 6951 .sp 6952 Default: 6953 \fI\fIremote browse sync\fR\fR\fI = \fR\fI\fR\fI \fR 6954 .RE 6955 5742 6956 rename user script (G) 5743 .RS 3n 6957 .PP 6958 .RS 4 5744 6959 This is the full pathname to a script that will be run as root by 5745 6960 \fBsmbd\fR(8) 5746 under special circumstances described below .5747 .sp 5748 When a user with admin authority or SeAddUserPrivilege rights renames a user (e .g.: from the NT4 User Manager for Domains), this script will be run to rename the POSIX user. Two variables,6961 under special circumstances described below\. 6962 .sp 6963 When a user with admin authority or SeAddUserPrivilege rights renames a user (e\.g\.: from the NT4 User Manager for Domains), this script will be run to rename the POSIX user\. Two variables, 5749 6964 %uold 5750 6965 and 5751 %unew, will be substituted with the old and new usernames, respectively . The script should return 0 upon successful completion, and nonzero otherwise.6966 %unew, will be substituted with the old and new usernames, respectively\. The script should return 0 upon successful completion, and nonzero otherwise\. 5752 6967 .sp 5753 6968 .it 1 an-trap … … 5755 6970 .nr an-break-flag 1 5756 6971 .br 5757 \fBNote\fR 5758 The script has all responsibility to rename all the necessary data that is accessible in this posix method. This can mean different requirements for different backends. The tdbsam and smbpasswd backends will take care of the contents of their respective files, so the script is responsible only for changing the POSIX username, and other data that may required for your circumstances, such as home directory. Please also consider whether or not you need to rename the actual home directories themselves. The ldapsam backend will not make any changes, because of the potential issues with renaming the LDAP naming attribute. In this case the script is responsible for changing the attribute that samba uses (uid) for locating users, as well as any data that needs to change for other applications using the same directory. 5759 Default: 5760 \fB\fIrename user script\fR = no \fR 5761 .RE 5762 .PP 6972 Note 6973 The script has all responsibility to rename all the necessary data that is accessible in this posix method\. This can mean different requirements for different backends\. The tdbsam and smbpasswd backends will take care of the contents of their respective files, so the script is responsible only for changing the POSIX username, and other data that may required for your circumstances, such as home directory\. Please also consider whether or not you need to rename the actual home directories themselves\. The ldapsam backend will not make any changes, because of the potential issues with renaming the LDAP naming attribute\. In this case the script is responsible for changing the attribute that samba uses (uid) for locating users, as well as any data that needs to change for other applications using the same directory\. 6974 6975 Default: 6976 \fI\fIrename user script\fR\fR\fI = \fR\fIno\fR\fI \fR 6977 .RE 6978 5763 6979 reset on zero vc (G) 5764 .RS 3n 5765 This boolean option controls whether an incoming session setup should kill other connections coming from the same IP. This matches the default Windows 2003 behaviour. Setting this parameter to yes becomes necessary when you have a flaky network and windows decides to reconnect while the old connection still has files with share modes open. These files become inaccessible over the new connection. The client sends a zero VC on the new connection, and Windows 2003 kills all other connections coming from the same IP. This way the locked files are accessible again. Please be aware that enabling this option will kill connections behind a masquerading router. 5766 .sp 5767 Default: 5768 \fB\fIreset on zero vc\fR = no \fR 5769 .RE 5770 .PP 6980 .PP 6981 .RS 4 6982 This boolean option controls whether an incoming session setup should kill other connections coming from the same IP\. This matches the default Windows 2003 behaviour\. Setting this parameter to yes becomes necessary when you have a flaky network and windows decides to reconnect while the old connection still has files with share modes open\. These files become inaccessible over the new connection\. The client sends a zero VC on the new connection, and Windows 2003 kills all other connections coming from the same IP\. This way the locked files are accessible again\. Please be aware that enabling this option will kill connections behind a masquerading router\. 6983 .sp 6984 Default: 6985 \fI\fIreset on zero vc\fR\fR\fI = \fR\fIno\fR\fI \fR 6986 .RE 6987 5771 6988 restrict anonymous (G) 5772 . RS 3n5773 The setting of this parameter determines whether user and group list information is returned for an anonymous connection. and mirrors the effects of the 5774 5775 .sp 5776 6989 .PP 6990 .RS 4 6991 The setting of this parameter determines whether user and group list information is returned for an anonymous connection\. and mirrors the effects of the 6992 .sp 6993 .RS 4 5777 6994 .nf 5778 5779 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\ 5780 Control\LSA\RestrictAnonymous 5781 6995 HKEY_LOCAL_MACHINE\eSYSTEM\eCurrentControlSet\e 6996 Control\eLSA\eRestrictAnonymous 5782 6997 .fi 5783 registry key in Windows 2000 and Windows NT. When set to 0, user and group list information is returned to anyone who asks. When set to 1, only an authenticated user can retrive user and group list information. For the value 2, supported by Windows 2000/XP and Samba, no anonymous connections are allowed at all. This can break third party and Microsoft applications which expect to be allowed to perform operations anonymously. 5784 .sp 5785 The security advantage of using restrict anonymous = 1 is dubious, as user and group list information can be obtained using other means. 6998 .RE 6999 .sp 7000 registry key in Windows 2000 and Windows NT\. When set to 0, user and group list information is returned to anyone who asks\. When set to 1, only an authenticated user can retrive user and group list information\. For the value 2, supported by Windows 2000/XP and Samba, no anonymous connections are allowed at all\. This can break third party and Microsoft applications which expect to be allowed to perform operations anonymously\. 7001 .sp 7002 The security advantage of using restrict anonymous = 1 is dubious, as user and group list information can be obtained using other means\. 5786 7003 .sp 5787 7004 .it 1 an-trap … … 5789 7006 .nr an-break-flag 1 5790 7007 .br 5791 \fBNote\fR 7008 Note 5792 7009 The security advantage of using restrict anonymous = 2 is removed by setting 5793 guest ok = yes on any share. 5794 Default: 5795 \fB\fIrestrict anonymous\fR = 0 \fR 5796 .RE 5797 .PP 5798 root 5799 .RS 3n 5800 This parameter is a synonym for root directory. 5801 .RE 5802 .PP 5803 root dir 5804 .RS 3n 5805 This parameter is a synonym for root directory. 5806 .RE 5807 .PP 7010 \fIguest ok = yes\fR 7011 on any share\. 7012 7013 Default: 7014 \fI\fIrestrict anonymous\fR\fR\fI = \fR\fI0\fR\fI \fR 7015 .RE 7016 root.PP 7017 .RS 4 7018 This parameter is a synonym for 7019 root directory\. 7020 .RE 7021 root dir.PP 7022 .RS 4 7023 This parameter is a synonym for 7024 root directory\. 7025 .RE 7026 5808 7027 root directory (G) 5809 .RS 3n 7028 .PP 7029 .RS 4 5810 7030 The server will 5811 7031 chroot() 5812 (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 5813 wide smbconfoptions parameter). 7032 (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 7033 \fIwide smbconfoptions\fR 7034 parameter)\. 5814 7035 .sp 5815 7036 Adding a 5816 7037 \fIroot directory\fR 5817 entry other than "/" adds an extra level of security, but at a price . It absolutely ensures that no access is given to files not in the sub-tree specified in the7038 entry other than "/" adds an extra level of security, but at a price\. It absolutely ensures that no access is given to files not in the sub\-tree specified in the 5818 7039 \fIroot directory\fR 5819 7040 option, 5820 \f Bincluding\fR5821 some files needed for complete operation of the server . To maintain full operability of the server you will need to mirror some system files into the7041 \fIincluding\fR 7042 some files needed for complete operation of the server\. To maintain full operability of the server you will need to mirror some system files into the 5822 7043 \fIroot directory\fR 5823 tree . In particular you will need to mirror7044 tree\. In particular you will need to mirror 5824 7045 \fI/etc/passwd\fR 5825 (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.5826 .sp 5827 Default: 5828 \f B\fIroot directory\fR = /\fR5829 .sp 5830 Example: 5831 \f B\fIroot directory\fR = /homes/smb\fR5832 .RE 5833 .PP 7046 (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\. 7047 .sp 7048 Default: 7049 \fI\fIroot directory\fR\fR\fI = \fR\fI/\fR\fI \fR 7050 .sp 7051 Example: 7052 \fI\fIroot directory\fR\fR\fI = \fR\fI/homes/smb\fR\fI \fR 7053 .RE 7054 5834 7055 root postexec (S) 5835 .RS 3n 7056 .PP 7057 .RS 4 5836 7058 This is the same as the 5837 7059 \fIpostexec\fR 5838 parameter except that the command is run as root. This is useful for unmounting filesystems (such as CDROMs) after a connection is closed. 5839 .sp 5840 Default: 5841 \fB\fIroot postexec\fR = \fR 5842 .RE 5843 .PP 7060 parameter except that the command is run as root\. This is useful for unmounting filesystems (such as CDROMs) after a connection is closed\. 7061 .sp 7062 Default: 7063 \fI\fIroot postexec\fR\fR\fI = \fR\fI\fR\fI \fR 7064 .RE 7065 7066 root preexec close (S) 7067 .PP 7068 .RS 4 7069 This is the same as the 7070 \fIpreexec close \fR 7071 parameter except that the command is run as root\. 7072 .sp 7073 Default: 7074 \fI\fIroot preexec close\fR\fR\fI = \fR\fIno\fR\fI \fR 7075 .RE 7076 5844 7077 root preexec (S) 5845 .RS 3n 7078 .PP 7079 .RS 4 5846 7080 This is the same as the 5847 7081 \fIpreexec\fR 5848 parameter except that the command is run as root. This is useful for mounting filesystems (such as CDROMs) when a connection is opened. 5849 .sp 5850 Default: 5851 \fB\fIroot preexec\fR = \fR 5852 .RE 5853 .PP 5854 root preexec close (S) 5855 .RS 3n 5856 This is the same as the 5857 \fIpreexec close \fR 5858 parameter except that the command is run as root. 5859 .sp 5860 Default: 5861 \fB\fIroot preexec close\fR = no \fR 5862 .RE 5863 .PP 7082 parameter except that the command is run as root\. This is useful for mounting filesystems (such as CDROMs) when a connection is opened\. 7083 .sp 7084 Default: 7085 \fI\fIroot preexec\fR\fR\fI = \fR\fI\fR\fI \fR 7086 .RE 7087 7088 security mask (S) 7089 .PP 7090 .RS 4 7091 This parameter controls what UNIX permission bits will be set when a Windows NT client is manipulating the UNIX permission on a file using the native NT security dialog box\. 7092 .sp 7093 This parameter is applied as a mask (AND\'ed with) to the incoming permission bits, thus resetting any bits not in this mask\. Make sure not to mix up this parameter with 7094 \fIforce security mode\fR, which works in a manner similar to this one but uses a logical OR instead of an AND\. 7095 .sp 7096 Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the file permissions regardless of the previous status of this bits on the file\. 7097 .sp 7098 If not set explicitly this parameter is 0777, allowing a user to set all the user/group/world permissions on a file\. 7099 .sp 7100 \fI Note\fR 7101 that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems\. Administrators of most normal systems will probably want to leave it set to 7102 \fB0777\fR\. 7103 .sp 7104 Default: 7105 \fI\fIsecurity mask\fR\fR\fI = \fR\fI0777\fR\fI \fR 7106 .sp 7107 Example: 7108 \fI\fIsecurity mask\fR\fR\fI = \fR\fI0770\fR\fI \fR 7109 .RE 7110 5864 7111 security (G) 5865 .RS 3n 7112 .PP 7113 .RS 4 5866 7114 This option affects how clients respond to Samba and is one of the most important settings in the 5867 \fI smb .conf\fR5868 file .7115 \fI smb\.conf\fR 7116 file\. 5869 7117 .sp 5870 7118 The option sets the "security mode bit" in replies to protocol negotiations with 5871 7119 \fBsmbd\fR(8) 5872 to turn share level security on or off . Clients decide based on this bit whether (and how) to transfer user and password information to the server.7120 to turn share level security on or off\. Clients decide based on this bit whether (and how) to transfer user and password information to the server\. 5873 7121 .sp 5874 7122 The default is 5875 security = user, as this is the most common setting needed when talking to Windows 98 and Windows NT .7123 security = user, as this is the most common setting needed when talking to Windows 98 and Windows NT\. 5876 7124 .sp 5877 7125 The alternatives are … … 5879 7127 security = server 5880 7128 or 5881 security = domain .5882 .sp 5883 In versions of Samba prior to 2 .0.0, the default was7129 security = domain\. 7130 .sp 7131 In versions of Samba prior to 2\.0\.0, the default was 5884 7132 security = share 5885 mainly because that was the only option at one stage .5886 .sp 5887 There is a bug in WfWg that has relevance to this setting . When in user or server level security a WfWg client will totally ignore the username and password you type in the "connect drive" dialog box. This makes it very difficult (if not impossible) to connect to a Samba service as anyone except the user that you are logged into WfWg as.7133 mainly because that was the only option at one stage\. 7134 .sp 7135 There is a bug in WfWg that has relevance to this setting\. When in user or server level security a WfWg client will totally ignore the username and password you type in the "connect drive" dialog box\. This makes it very difficult (if not impossible) to connect to a Samba service as anyone except the user that you are logged into WfWg as\. 5888 7136 .sp 5889 7137 If your PCs use usernames that are the same as their usernames on the UNIX machine then you will want to use 5890 security = user . If you mostly use usernames that don't exist on the UNIX box then use5891 security = share .7138 security = user\. If you mostly use usernames that don\'t exist on the UNIX box then use 7139 security = share\. 5892 7140 .sp 5893 7141 You should also use 5894 7142 security = share 5895 if you want to mainly setup shares without a password (guest shares) . This is commonly used for a shared printer server. It is more difficult to setup guest shares with7143 if you want to mainly setup shares without a password (guest shares)\. This is commonly used for a shared printer server\. It is more difficult to setup guest shares with 5896 7144 security = user, see the 5897 map to guestparameter for details.7145 \fImap to guest\fRparameter for details\. 5898 7146 .sp 5899 7147 It is possible to use 5900 7148 smbd 5901 7149 in a 5902 \f Bhybrid mode\fR7150 \fI hybrid mode\fR 5903 7151 where it is offers both user and share level security under different 5904 NetBIOS aliases.5905 .sp 5906 The different settings will now be explained .5907 .sp 5908 \f BSECURITY = SHARE\fR7152 \fINetBIOS aliases\fR\. 7153 .sp 7154 The different settings will now be explained\. 7155 .sp 7156 \fISECURITY = SHARE\fR 5909 7157 .sp 5910 7158 When clients connect to a share level security server they need not log onto the server with a valid username and password before attempting to connect to a shared resource (although modern clients such as Windows 95/98 and Windows NT will send a logon request with a username but no password when talking to a 5911 7159 security = share 5912 server) . Instead, the clients send authentication information (passwords) on a per-share basis, at the time they attempt to connect to that share.7160 server)\. Instead, the clients send authentication information (passwords) on a per\-share basis, at the time they attempt to connect to that share\. 5913 7161 .sp 5914 7162 Note that 5915 7163 smbd 5916 \f BALWAYS\fR7164 \fIALWAYS\fR 5917 7165 uses a valid UNIX user to act on behalf of the client, even in 5918 7166 security = share 5919 level security .7167 level security\. 5920 7168 .sp 5921 7169 As clients are not required to send a username to the server in share level security, 5922 7170 smbd 5923 uses several techniques to determine the correct UNIX user to use on behalf of the client .7171 uses several techniques to determine the correct UNIX user to use on behalf of the client\. 5924 7172 .sp 5925 7173 A list of possible UNIX usernames to match with the given client password is constructed using the following methods : 5926 .RS 3n 5927 .TP 3n 5928 \(bu 5929 If the 5930 guest only parameter is set, then all the other stages are missed and only the 5931 guest account username is checked. 5932 .TP 3n 5933 \(bu 5934 Is a username is sent with the share connection request, then this username (after mapping - see 5935 username map), is added as a potential username. 5936 .TP 3n 5937 \(bu 5938 If the client did a previous 5939 \fBlogon \fR 5940 request (the SessionSetup SMB call) then the username sent in this SMB will be added as a potential username. 5941 .TP 3n 5942 \(bu 5943 The name of the service the client requested is added as a potential username. 5944 .TP 3n 5945 \(bu 5946 The NetBIOS name of the client is added to the list as a potential username. 5947 .TP 3n 5948 \(bu 5949 Any users on the 5950 user list are added as potential usernames. 5951 .RE 5952 .IP "" 3n 7174 .sp 7175 .RS 4 7176 .ie n \{\ 7177 \h'-04'\(bu\h'+03'\c 7178 .\} 7179 .el \{\ 7180 .sp -1 7181 .IP \(bu 2.3 7182 .\} 5953 7183 If the 5954 7184 \fIguest only\fR 5955 parameter is not set, then this list is then tried with the supplied password. The first user for whom the password matches will be used as the UNIX user. 7185 parameter is set, then all the other stages are missed and only the 7186 \fIguest account\fR 7187 username is checked\. 7188 .RE 7189 .sp 7190 .RS 4 7191 .ie n \{\ 7192 \h'-04'\(bu\h'+03'\c 7193 .\} 7194 .el \{\ 7195 .sp -1 7196 .IP \(bu 2.3 7197 .\} 7198 Is a username is sent with the share connection request, then this username (after mapping \- see 7199 \fIusername map\fR), is added as a potential username\. 7200 .RE 7201 .sp 7202 .RS 4 7203 .ie n \{\ 7204 \h'-04'\(bu\h'+03'\c 7205 .\} 7206 .el \{\ 7207 .sp -1 7208 .IP \(bu 2.3 7209 .\} 7210 If the client did a previous 7211 \fIlogon \fR 7212 request (the SessionSetup SMB call) then the username sent in this SMB will be added as a potential username\. 7213 .RE 7214 .sp 7215 .RS 4 7216 .ie n \{\ 7217 \h'-04'\(bu\h'+03'\c 7218 .\} 7219 .el \{\ 7220 .sp -1 7221 .IP \(bu 2.3 7222 .\} 7223 The name of the service the client requested is added as a potential username\. 7224 .RE 7225 .sp 7226 .RS 4 7227 .ie n \{\ 7228 \h'-04'\(bu\h'+03'\c 7229 .\} 7230 .el \{\ 7231 .sp -1 7232 .IP \(bu 2.3 7233 .\} 7234 The NetBIOS name of the client is added to the list as a potential username\. 7235 .RE 7236 .sp 7237 .RS 4 7238 .ie n \{\ 7239 \h'-04'\(bu\h'+03'\c 7240 .\} 7241 .el \{\ 7242 .sp -1 7243 .IP \(bu 2.3 7244 .\} 7245 Any users on the 7246 \fIuser\fR 7247 list are added as potential usernames\. 7248 .sp 7249 .RE 7250 If the 7251 \fIguest only\fR 7252 parameter is not set, then this list is then tried with the supplied password\. The first user for whom the password matches will be used as the UNIX user\. 5956 7253 .sp 5957 7254 If the 5958 7255 \fIguest only\fR 5959 7256 parameter is set, or no username can be determined then if the share is marked as available to the 5960 \fIguest account\fR, then this guest user will be used, otherwise access is denied .7257 \fIguest account\fR, then this guest user will be used, otherwise access is denied\. 5961 7258 .sp 5962 7259 Note that it can be 5963 \f Bvery\fR5964 confusing in share -level security as to which UNIX username will eventually be used in granting access.7260 \fIvery\fR 7261 confusing in share\-level security as to which UNIX username will eventually be used in granting access\. 5965 7262 .sp 5966 7263 See also the section 5967 NOTE ABOUT USERNAME/PASSWORD VALIDATION. 5968 .sp 5969 \fBSECURITY = USER\fR 5970 .sp 5971 This is the default security setting in Samba 3.0. With user-level security a client must first "log-on" with a valid username and password (which can be mapped using the 5972 username map parameter). Encrypted passwords (see the 5973 encrypted passwords parameter) can also be used in this security mode. Parameters such as 5974 user and 5975 guest only if set are then applied and may change the UNIX user to use on this connection, but only after the user has been successfully authenticated. 5976 .sp 5977 \fBNote\fR 7264 NOTE ABOUT USERNAME/PASSWORD VALIDATION\. 7265 .sp 7266 \fISECURITY = USER\fR 7267 .sp 7268 This is the default security setting in Samba 3\.0\. With user\-level security a client must first "log\-on" with a valid username and password (which can be mapped using the 7269 \fIusername map\fR 7270 parameter)\. Encrypted passwords (see the 7271 \fIencrypted passwords\fR 7272 parameter) can also be used in this security mode\. Parameters such as 7273 \fIuser\fR 7274 and 7275 \fIguest only\fR 7276 if set are then applied and may change the UNIX user to use on this connection, but only after the user has been successfully authenticated\. 7277 .sp 7278 \fINote\fR 5978 7279 that the name of the resource being requested is 5979 \fBnot\fR 5980 sent to the server until after the server has successfully authenticated the client. This is why guest shares don't work in user level security without allowing the server to automatically map unknown users into the 5981 guest account. See the 5982 map to guest parameter for details on doing this. 7280 \fInot\fR 7281 sent to the server until after the server has successfully authenticated the client\. This is why guest shares don\'t work in user level security without allowing the server to automatically map unknown users into the 7282 \fIguest account\fR\. See the 7283 \fImap to guest\fR 7284 parameter for details on doing this\. 5983 7285 .sp 5984 7286 See also the section 5985 NOTE ABOUT USERNAME/PASSWORD VALIDATION .5986 .sp 5987 \f BSECURITY = DOMAIN\fR7287 NOTE ABOUT USERNAME/PASSWORD VALIDATION\. 7288 .sp 7289 \fISECURITY = DOMAIN\fR 5988 7290 .sp 5989 7291 This mode will only work correctly if 5990 7292 \fBnet\fR(8) 5991 has been used to add this machine into a Windows NT Domain. It expects the 5992 encrypted passwords parameter to be set to 5993 \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. 5994 .sp 5995 \fBNote\fR 5996 that a valid UNIX user must still exist as well as the account on the Domain Controller to allow Samba to have a valid UNIX account to map file access to. 5997 .sp 5998 \fBNote\fR 5999 that from the client's point of view 7293 has been used to add this machine into a Windows NT Domain\. It expects the 7294 \fIencrypted passwords\fR 7295 parameter to be set to 7296 \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\. 7297 .sp 7298 \fINote\fR 7299 that a valid UNIX user must still exist as well as the account on the Domain Controller to allow Samba to have a valid UNIX account to map file access to\. 7300 .sp 7301 \fINote\fR 7302 that from the client\'s point of view 6000 7303 security = domain 6001 7304 is the same as 6002 security = user . It only affects how the server deals with the authentication, it does not in any way affect what the client sees.6003 .sp 6004 \f BNote\fR7305 security = user\. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\. 7306 .sp 7307 \fINote\fR 6005 7308 that the name of the resource being requested is 6006 \fBnot\fR 6007 sent to the server until after the server has successfully authenticated the client. This is why guest shares don't work in user level security without allowing the server to automatically map unknown users into the 6008 guest account. See the 6009 map to guest parameter for details on doing this. 7309 \fInot\fR 7310 sent to the server until after the server has successfully authenticated the client\. This is why guest shares don\'t work in user level security without allowing the server to automatically map unknown users into the 7311 \fIguest account\fR\. See the 7312 \fImap to guest\fR 7313 parameter for details on doing this\. 6010 7314 .sp 6011 7315 See also the section 6012 NOTE ABOUT USERNAME/PASSWORD VALIDATION .7316 NOTE ABOUT USERNAME/PASSWORD VALIDATION\. 6013 7317 .sp 6014 7318 See also the 6015 password server parameter and the 6016 encrypted passwords parameter. 6017 .sp 6018 \fBSECURITY = SERVER\fR 6019 .sp 6020 In this mode Samba will try to validate the username/password by passing it to another SMB server, such as an NT box. If this fails it will revert to 6021 security = user. It expects the 6022 encrypted passwords parameter to be set to 6023 \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 7319 \fIpassword server\fR 7320 parameter and the 7321 \fIencrypted passwords\fR 7322 parameter\. 7323 .sp 7324 \fISECURITY = SERVER\fR 7325 .sp 7326 In this mode Samba will try to validate the username/password by passing it to another SMB server, such as an NT box\. If this fails it will revert to 7327 security = user\. It expects the 7328 \fIencrypted passwords\fR 7329 parameter to be set to 7330 \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 6024 7331 \fIsmbpasswd\fR 6025 file to check users against . See the chapter about the User Database in the Samba HOWTO Collection for details on how to set this up.7332 file to check users against\. See the chapter about the User Database in the Samba HOWTO Collection for details on how to set this up\. 6026 7333 .sp 6027 7334 .it 1 an-trap … … 6029 7336 .nr an-break-flag 1 6030 7337 .br 6031 \fBNote\fR 6032 This mode of operation has significant pitfalls since it is more vulnerable to man -in-the-middle attacks and server impersonation. In particular, this mode of operation can cause significant resource consuption on the PDC, as it must maintain an active connection for the duration of the user's session. Furthermore, if this connection is lost, there is no way to reestablish it, and futher authentications to the Samba server may fail (from a single client, till it disconnects).7338 Note 7339 This mode of operation has significant pitfalls since it is more vulnerable to man\-in\-the\-middle attacks and server impersonation\. In particular, this mode of operation can cause significant resource consuption on the PDC, as it must maintain an active connection for the duration of the user\'s session\. Furthermore, if this connection is lost, there is no way to reestablish it, and futher authentications to the Samba server may fail (from a single client, till it disconnects)\. 6033 7340 .sp 6034 7341 .it 1 an-trap … … 6036 7343 .nr an-break-flag 1 6037 7344 .br 6038 \fBNote\fR 6039 From the client 's point of view7345 Note 7346 From the client\'s point of view 6040 7347 security = server 6041 7348 is the same as 6042 security = user. It only affects how the server deals with the authentication, it does not in any way affect what the client sees. 6043 \fBNote\fR 7349 security = user\. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\. 7350 7351 \fINote\fR 6044 7352 that the name of the resource being requested is 6045 \fBnot\fR 6046 sent to the server until after the server has successfully authenticated the client. This is why guest shares don't work in user level security without allowing the server to automatically map unknown users into the 6047 guest account. See the 6048 map to guest parameter for details on doing this. 7353 \fInot\fR 7354 sent to the server until after the server has successfully authenticated the client\. This is why guest shares don\'t work in user level security without allowing the server to automatically map unknown users into the 7355 \fIguest account\fR\. See the 7356 \fImap to guest\fR 7357 parameter for details on doing this\. 6049 7358 .sp 6050 7359 See also the section 6051 NOTE ABOUT USERNAME/PASSWORD VALIDATION .7360 NOTE ABOUT USERNAME/PASSWORD VALIDATION\. 6052 7361 .sp 6053 7362 See also the 6054 password server parameter and the 6055 encrypted passwords parameter. 6056 .sp 6057 \fBSECURITY = ADS\fR 6058 .sp 6059 In this mode, Samba will act as a domain member in an ADS realm. To operate in this mode, the machine running Samba will need to have Kerberos installed and configured and Samba will need to be joined to the ADS realm using the net utility. 6060 .sp 6061 Note that this mode does NOT make Samba operate as a Active Directory Domain Controller. 6062 .sp 6063 Read the chapter about Domain Membership in the HOWTO for details. 6064 .sp 6065 Default: 6066 \fB\fIsecurity\fR = USER \fR 6067 .sp 6068 Example: 6069 \fB\fIsecurity\fR = DOMAIN \fR 6070 .RE 6071 .PP 6072 security mask (S) 6073 .RS 3n 6074 This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a file using the native NT security dialog box. 6075 .sp 6076 This parameter is applied as a mask (AND'ed with) to the changed permission bits, thus preventing any bits not in this mask from being modified. Make sure not to mix up this parameter with 6077 force security mode, which works in a manner similar to this one but uses a logical OR instead of an AND. 6078 .sp 6079 Essentially, zero bits in this mask may be treated as a set of bits the user is not allowed to change. 6080 .sp 6081 If not set explicitly this parameter is 0777, allowing a user to modify all the user/group/world permissions on a file. 6082 .sp 6083 \fB Note\fR 6084 that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems. Administrators of most normal systems will probably want to leave it set to 6085 \fB0777\fR. 6086 .sp 6087 Default: 6088 \fB\fIsecurity mask\fR = 0777 \fR 6089 .sp 6090 Example: 6091 \fB\fIsecurity mask\fR = 0770 \fR 6092 .RE 6093 .PP 7363 \fIpassword server\fR 7364 parameter and the 7365 \fIencrypted passwords\fR 7366 parameter\. 7367 .sp 7368 \fISECURITY = ADS\fR 7369 .sp 7370 In this mode, Samba will act as a domain member in an ADS realm\. To operate in this mode, the machine running Samba will need to have Kerberos installed and configured and Samba will need to be joined to the ADS realm using the net utility\. 7371 .sp 7372 Note that this mode does NOT make Samba operate as a Active Directory Domain Controller\. 7373 .sp 7374 Read the chapter about Domain Membership in the HOWTO for details\. 7375 .sp 7376 Default: 7377 \fI\fIsecurity\fR\fR\fI = \fR\fIUSER\fR\fI \fR 7378 .sp 7379 Example: 7380 \fI\fIsecurity\fR\fR\fI = \fR\fIDOMAIN\fR\fI \fR 7381 .RE 7382 6094 7383 server schannel (G) 6095 .RS 3n 6096 This controls whether the server offers or even demands the use of the netlogon schannel. 6097 server schannel = no does not offer the schannel, 6098 server schannel = auto offers the schannel but does not enforce it, and 6099 server schannel = yes denies access if the client is not able to speak netlogon schannel. This is only the case for Windows NT4 before SP4. 7384 .PP 7385 .RS 4 7386 This controls whether the server offers or even demands the use of the netlogon schannel\. 7387 \fIserver schannel = no\fR 7388 does not offer the schannel, 7389 \fIserver schannel = auto\fR 7390 offers the schannel but does not enforce it, and 7391 \fIserver schannel = yes\fR 7392 denies access if the client is not able to speak netlogon schannel\. This is only the case for Windows NT4 before SP4\. 6100 7393 .sp 6101 7394 Please note that with this set to 6102 7395 no 6103 7396 you will have to apply the WindowsXP 6104 \fIWinXP_SignOrSeal .reg\fR6105 registry patch found in the docs/registry subdirectory of the Samba distribution tarball .6106 .sp 6107 Default: 6108 \f B\fIserver schannel\fR = auto\fR6109 .sp 6110 Example: 6111 \f B\fIserver schannel\fR = yes\fR6112 .RE 6113 .PP 7397 \fIWinXP_SignOrSeal\.reg\fR 7398 registry patch found in the docs/registry subdirectory of the Samba distribution tarball\. 7399 .sp 7400 Default: 7401 \fI\fIserver schannel\fR\fR\fI = \fR\fIauto\fR\fI \fR 7402 .sp 7403 Example: 7404 \fI\fIserver schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR 7405 .RE 7406 6114 7407 server signing (G) 6115 .RS 3n 6116 This controls whether the server offers or requires the client it talks to to use SMB signing. Possible values are 6117 \fBauto\fR, 6118 \fBmandatory\fR 7408 .PP 7409 .RS 4 7410 This controls whether the server offers or requires the client it talks to to use SMB signing\. Possible values are 7411 \fIauto\fR, 7412 \fImandatory\fR 6119 7413 and 6120 \f Bdisabled\fR.6121 .sp 6122 When set to auto, SMB signing is offered, but not enforced . When set to mandatory, SMB signing is required and if set to disabled, SMB signing is not offered either.6123 .sp 6124 Default: 6125 \f B\fIserver signing\fR = Disabled\fR6126 .RE 6127 .PP 7414 \fIdisabled\fR\. 7415 .sp 7416 When set to auto, SMB signing is offered, but not enforced\. When set to mandatory, SMB signing is required and if set to disabled, SMB signing is not offered either\. 7417 .sp 7418 Default: 7419 \fI\fIserver signing\fR\fR\fI = \fR\fIDisabled\fR\fI \fR 7420 .RE 7421 6128 7422 server string (G) 6129 .RS 3n 7423 .PP 7424 .RS 4 6130 7425 This controls what string will show up in the printer comment box in print manager and next to the IPC connection in 6131 net view . It can be any string that you wish to show to your users.6132 .sp 6133 It also sets what will appear in browse lists next to the machine name .7426 net view\. It can be any string that you wish to show to your users\. 7427 .sp 7428 It also sets what will appear in browse lists next to the machine name\. 6134 7429 .sp 6135 7430 A 6136 7431 \fI%v\fR 6137 will be replaced with the Samba version number .7432 will be replaced with the Samba version number\. 6138 7433 .sp 6139 7434 A 6140 7435 \fI%h\fR 6141 will be replaced with the hostname .6142 .sp 6143 Default: 6144 \f B\fIserver string\fR = Samba %v\fR6145 .sp 6146 Example: 6147 \f B\fIserver string\fR = University of GNUs Samba Server\fR6148 .RE 6149 .PP 7436 will be replaced with the hostname\. 7437 .sp 7438 Default: 7439 \fI\fIserver string\fR\fR\fI = \fR\fISamba %v\fR\fI \fR 7440 .sp 7441 Example: 7442 \fI\fIserver string\fR\fR\fI = \fR\fIUniversity of GNUs Samba Server\fR\fI \fR 7443 .RE 7444 6150 7445 set directory (S) 6151 .RS 3n 7446 .PP 7447 .RS 4 6152 7448 If 6153 set directory = no, then users of the service may not use the setdir command to change directory .7449 set directory = no, then users of the service may not use the setdir command to change directory\. 6154 7450 .sp 6155 7451 The 6156 7452 setdir 6157 command is only implemented in the Digital Pathworks client . See the Pathworks documentation for details.6158 .sp 6159 Default: 6160 \f B\fIset directory\fR = no\fR6161 .RE 6162 .PP 7453 command is only implemented in the Digital Pathworks client\. See the Pathworks documentation for details\. 7454 .sp 7455 Default: 7456 \fI\fIset directory\fR\fR\fI = \fR\fIno\fR\fI \fR 7457 .RE 7458 6163 7459 set primary group script (G) 6164 .RS 3n 6165 Thanks to the Posix subsystem in NT a Windows User has a primary group in addition to the auxiliary groups. This script sets the primary group in the unix userdatase when an administrator sets the primary group from the windows user manager or when fetching a SAM with 6166 net rpc vampire. 7460 .PP 7461 .RS 4 7462 Thanks to the Posix subsystem in NT a Windows User has a primary group in addition to the auxiliary groups\. This script sets the primary group in the unix userdatase when an administrator sets the primary group from the windows user manager or when fetching a SAM with 7463 net rpc vampire\. 6167 7464 \fI%u\fR 6168 will be replaced with the user whose primary group is to be set .7465 will be replaced with the user whose primary group is to be set\. 6169 7466 \fI%g\fR 6170 will be replaced with the group to set .6171 .sp 6172 Default: 6173 \f B\fIset primary group script\fR =\fR6174 .sp 6175 Example: 6176 \f B\fIset primary group script\fR = /usr/sbin/usermod -g '%g' '%u'\fR6177 .RE 6178 .PP 7467 will be replaced with the group to set\. 7468 .sp 7469 Default: 7470 \fI\fIset primary group script\fR\fR\fI = \fR\fI\fR\fI \fR 7471 .sp 7472 Example: 7473 \fI\fIset primary group script\fR\fR\fI = \fR\fI/usr/sbin/usermod \-g \'%g\' \'%u\'\fR\fI \fR 7474 .RE 7475 6179 7476 set quota command (G) 6180 .RS 3n 7477 .PP 7478 .RS 4 6181 7479 The 6182 7480 set quota command 6183 should only be used whenever there is no operating system API available from the OS that samba can use .7481 should only be used whenever there is no operating system API available from the OS that samba can use\. 6184 7482 .sp 6185 7483 This option is only available if Samba was configured with the argument 6186 --with-sys-quotas7484 \-\-with\-sys\-quotas 6187 7485 or on linux when 6188 ./configure --with-quotas6189 was used and a working quota api was found in the system . Most packages are configured with these options already.6190 .sp 6191 This parameter should specify the path to a script that can set quota for the specified arguments .7486 \./configure \-\-with\-quotas 7487 was used and a working quota api was found in the system\. Most packages are configured with these options already\. 7488 .sp 7489 This parameter should specify the path to a script that can set quota for the specified arguments\. 6192 7490 .sp 6193 7491 The specified script should take the following arguments: 6194 .RS 3n 6195 .TP 3n 6196 \(bu 6197 1 - quota type 6198 .RS 3n 6199 .TP 3n 6200 \(bu 6201 1 - user quotas 6202 .TP 3n 6203 \(bu 6204 2 - user default quotas (uid = -1) 6205 .TP 3n 6206 \(bu 6207 3 - group quotas 6208 .TP 3n 6209 \(bu 6210 4 - group default quotas (gid = -1) 6211 .RE 6212 .IP "" 3n 6213 6214 .TP 3n 6215 \(bu 6216 2 - id (uid for user, gid for group, -1 if N/A) 6217 .TP 3n 6218 \(bu 6219 3 - quota state (0 = disable, 1 = enable, 2 = enable and enforce) 6220 .TP 3n 6221 \(bu 6222 4 - block softlimit 6223 .TP 3n 6224 \(bu 6225 5 - block hardlimit 6226 .TP 3n 6227 \(bu 6228 6 - inode softlimit 6229 .TP 3n 6230 \(bu 6231 7 - inode hardlimit 6232 .TP 3n 6233 \(bu 6234 8(optional) - block size, defaults to 1024 6235 .RE 6236 .IP "" 3n 6237 The script should output at least one line of data on success. And nothing on failure. 6238 .sp 6239 Default: 6240 \fB\fIset quota command\fR = \fR 6241 .sp 6242 Example: 6243 \fB\fIset quota command\fR = /usr/local/sbin/set_quota \fR 6244 .RE 6245 .PP 7492 .sp 7493 .RS 4 7494 .ie n \{\ 7495 \h'-04'\(bu\h'+03'\c 7496 .\} 7497 .el \{\ 7498 .sp -1 7499 .IP \(bu 2.3 7500 .\} 7501 1 \- quota type 7502 .sp 7503 .RS 4 7504 .ie n \{\ 7505 \h'-04'\(bu\h'+03'\c 7506 .\} 7507 .el \{\ 7508 .sp -1 7509 .IP \(bu 2.3 7510 .\} 7511 1 \- user quotas 7512 .RE 7513 .sp 7514 .RS 4 7515 .ie n \{\ 7516 \h'-04'\(bu\h'+03'\c 7517 .\} 7518 .el \{\ 7519 .sp -1 7520 .IP \(bu 2.3 7521 .\} 7522 2 \- user default quotas (uid = \-1) 7523 .RE 7524 .sp 7525 .RS 4 7526 .ie n \{\ 7527 \h'-04'\(bu\h'+03'\c 7528 .\} 7529 .el \{\ 7530 .sp -1 7531 .IP \(bu 2.3 7532 .\} 7533 3 \- group quotas 7534 .RE 7535 .sp 7536 .RS 4 7537 .ie n \{\ 7538 \h'-04'\(bu\h'+03'\c 7539 .\} 7540 .el \{\ 7541 .sp -1 7542 .IP \(bu 2.3 7543 .\} 7544 4 \- group default quotas (gid = \-1) 7545 .sp 7546 .RE 7547 .RE 7548 .sp 7549 .RS 4 7550 .ie n \{\ 7551 \h'-04'\(bu\h'+03'\c 7552 .\} 7553 .el \{\ 7554 .sp -1 7555 .IP \(bu 2.3 7556 .\} 7557 2 \- id (uid for user, gid for group, \-1 if N/A) 7558 .RE 7559 .sp 7560 .RS 4 7561 .ie n \{\ 7562 \h'-04'\(bu\h'+03'\c 7563 .\} 7564 .el \{\ 7565 .sp -1 7566 .IP \(bu 2.3 7567 .\} 7568 3 \- quota state (0 = disable, 1 = enable, 2 = enable and enforce) 7569 .RE 7570 .sp 7571 .RS 4 7572 .ie n \{\ 7573 \h'-04'\(bu\h'+03'\c 7574 .\} 7575 .el \{\ 7576 .sp -1 7577 .IP \(bu 2.3 7578 .\} 7579 4 \- block softlimit 7580 .RE 7581 .sp 7582 .RS 4 7583 .ie n \{\ 7584 \h'-04'\(bu\h'+03'\c 7585 .\} 7586 .el \{\ 7587 .sp -1 7588 .IP \(bu 2.3 7589 .\} 7590 5 \- block hardlimit 7591 .RE 7592 .sp 7593 .RS 4 7594 .ie n \{\ 7595 \h'-04'\(bu\h'+03'\c 7596 .\} 7597 .el \{\ 7598 .sp -1 7599 .IP \(bu 2.3 7600 .\} 7601 6 \- inode softlimit 7602 .RE 7603 .sp 7604 .RS 4 7605 .ie n \{\ 7606 \h'-04'\(bu\h'+03'\c 7607 .\} 7608 .el \{\ 7609 .sp -1 7610 .IP \(bu 2.3 7611 .\} 7612 7 \- inode hardlimit 7613 .RE 7614 .sp 7615 .RS 4 7616 .ie n \{\ 7617 \h'-04'\(bu\h'+03'\c 7618 .\} 7619 .el \{\ 7620 .sp -1 7621 .IP \(bu 2.3 7622 .\} 7623 8(optional) \- block size, defaults to 1024 7624 .sp 7625 .RE 7626 The script should output at least one line of data on success\. And nothing on failure\. 7627 .sp 7628 Default: 7629 \fI\fIset quota command\fR\fR\fI = \fR\fI\fR\fI \fR 7630 .sp 7631 Example: 7632 \fI\fIset quota command\fR\fR\fI = \fR\fI/usr/local/sbin/set_quota\fR\fI \fR 7633 .RE 7634 6246 7635 share modes (S) 6247 .RS 3n 7636 .PP 7637 .RS 4 6248 7638 This enables or disables the honoring of the 6249 7639 \fIshare modes\fR 6250 during a file open . These modes are used by clients to gain exclusive read or write access to a file.6251 .sp 6252 These open modes are not directly supported by UNIX, so they are simulated using shared memory, or lock files if your UNIX doesn 't support shared memory (almost all do).7640 during a file open\. These modes are used by clients to gain exclusive read or write access to a file\. 7641 .sp 7642 These open modes are not directly supported by UNIX, so they are simulated using shared memory, or lock files if your UNIX doesn\'t support shared memory (almost all do)\. 6253 7643 .sp 6254 7644 The share modes that are enabled by this option are … … 6259 7649 \fBDENY_NONE\fR 6260 7650 and 6261 \fBDENY_FCB\fR .6262 .sp 6263 This option gives full share compatibility and enabled by default .7651 \fBDENY_FCB\fR\. 7652 .sp 7653 This option gives full share compatibility and enabled by default\. 6264 7654 .sp 6265 7655 You should 6266 \f BNEVER\fR6267 turn this parameter off as many Windows applications will break if you do so .6268 .sp 6269 Default: 6270 \f B\fIshare modes\fR = yes\fR6271 .RE 6272 .PP 7656 \fINEVER\fR 7657 turn this parameter off as many Windows applications will break if you do so\. 7658 .sp 7659 Default: 7660 \fI\fIshare modes\fR\fR\fI = \fR\fIyes\fR\fI \fR 7661 .RE 7662 6273 7663 short preserve case (S) 6274 .RS 3n 6275 This boolean parameter controls if new files which conform to 8.3 syntax, that is all in upper case and of suitable length, are created upper case, or if they are forced to be the 6276 default case. This option can be use with 6277 preserve case = yes to permit long filenames to retain their case, while short names are lowered. 7664 .PP 7665 .RS 4 7666 This boolean parameter controls if new files which conform to 8\.3 syntax, that is all in upper case and of suitable length, are created upper case, or if they are forced to be the 7667 \fIdefault case\fR\. This option can be use with 7668 \fIpreserve case = yes\fR 7669 to permit long filenames to retain their case, while short names are lowered\. 6278 7670 .sp 6279 7671 See the section on 6280 NAME MANGLING .6281 .sp 6282 Default: 6283 \f B\fIshort preserve case\fR = yes\fR6284 .RE 6285 .PP 7672 NAME MANGLING\. 7673 .sp 7674 Default: 7675 \fI\fIshort preserve case\fR\fR\fI = \fR\fIyes\fR\fI \fR 7676 .RE 7677 6286 7678 show add printer wizard (G) 6287 .RS 3n 6288 With the introduction of MS-RPC based printing support for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will appear on Samba hosts in the share listing. Normally this folder will contain an icon for the MS Add Printer Wizard (APW). However, it is possible to disable this feature regardless of the level of privilege of the connected user. 6289 .sp 6290 Under normal circumstances, the Windows NT/2000 client will open a handle on the printer server with OpenPrinterEx() asking for Administrator privileges. If the user does not have administrative access on the print server (i.e is not root or a member of the 7679 .PP 7680 .RS 4 7681 With the introduction of MS\-RPC based printing support for Windows NT/2000 client in Samba 2\.2, a "Printers\.\.\." folder will appear on Samba hosts in the share listing\. Normally this folder will contain an icon for the MS Add Printer Wizard (APW)\. However, it is possible to disable this feature regardless of the level of privilege of the connected user\. 7682 .sp 7683 Under normal circumstances, the Windows NT/2000 client will open a handle on the printer server with OpenPrinterEx() asking for Administrator privileges\. If the user does not have administrative access on the print server (i\.e is not root or a member of the 6291 7684 \fIprinter admin\fR 6292 group), the OpenPrinterEx() call fails and the client makes another open call with a request for a lower privilege level . This should succeed, however the APW icon will not be displayed.7685 group), the OpenPrinterEx() call fails and the client makes another open call with a request for a lower privilege level\. This should succeed, however the APW icon will not be displayed\. 6293 7686 .sp 6294 7687 Disabling the 6295 7688 \fIshow add printer wizard\fR 6296 parameter will always cause the OpenPrinterEx() on the server to fail . Thus the APW icon will never be displayed.7689 parameter will always cause the OpenPrinterEx() on the server to fail\. Thus the APW icon will never be displayed\. 6297 7690 .sp 6298 7691 .it 1 an-trap … … 6300 7693 .nr an-break-flag 1 6301 7694 .br 6302 \fBNote\fR 6303 This does not prevent the same user from having administrative privilege on an individual printer. 6304 Default: 6305 \fB\fIshow add printer wizard\fR = yes \fR 6306 .RE 6307 .PP 7695 Note 7696 This does not prevent the same user from having administrative privilege on an individual printer\. 7697 7698 Default: 7699 \fI\fIshow add printer wizard\fR\fR\fI = \fR\fIyes\fR\fI \fR 7700 .RE 7701 6308 7702 shutdown script (G) 6309 .RS 3n 7703 .PP 7704 .RS 4 6310 7705 This a full path name to a script called by 6311 7706 \fBsmbd\fR(8) 6312 that should start a shutdown procedure .7707 that should start a shutdown procedure\. 6313 7708 .sp 6314 7709 If the connected user posseses the 6315 \fBSeRemoteShutdownPrivilege\fR, right, this command will be run as user .7710 \fBSeRemoteShutdownPrivilege\fR, right, this command will be run as user\. 6316 7711 .sp 6317 7712 The %z %t %r %f variables are expanded as follows: 6318 .RS 3n 6319 .TP 3n 6320 \(bu 7713 .sp 7714 .RS 4 7715 .ie n \{\ 7716 \h'-04'\(bu\h'+03'\c 7717 .\} 7718 .el \{\ 7719 .sp -1 7720 .IP \(bu 2.3 7721 .\} 6321 7722 \fI%z\fR 6322 will be substituted with the shutdown message sent to the server. 6323 .TP 3n 6324 \(bu 7723 will be substituted with the shutdown message sent to the server\. 7724 .RE 7725 .sp 7726 .RS 4 7727 .ie n \{\ 7728 \h'-04'\(bu\h'+03'\c 7729 .\} 7730 .el \{\ 7731 .sp -1 7732 .IP \(bu 2.3 7733 .\} 6325 7734 \fI%t\fR 6326 will be substituted with the number of seconds to wait before effectively starting the shutdown procedure. 6327 .TP 3n 6328 \(bu 7735 will be substituted with the number of seconds to wait before effectively starting the shutdown procedure\. 7736 .RE 7737 .sp 7738 .RS 4 7739 .ie n \{\ 7740 \h'-04'\(bu\h'+03'\c 7741 .\} 7742 .el \{\ 7743 .sp -1 7744 .IP \(bu 2.3 7745 .\} 6329 7746 \fI%r\fR 6330 7747 will be substituted with the switch 6331 \fB-r\fR. It means reboot after shutdown for NT. 6332 .TP 3n 6333 \(bu 7748 \fI\-r\fR\. It means reboot after shutdown for NT\. 7749 .RE 7750 .sp 7751 .RS 4 7752 .ie n \{\ 7753 \h'-04'\(bu\h'+03'\c 7754 .\} 7755 .el \{\ 7756 .sp -1 7757 .IP \(bu 2.3 7758 .\} 6334 7759 \fI%f\fR 6335 7760 will be substituted with the switch 6336 \f B-f\fR. It means force the shutdown even if applications do not respond for NT.6337 . RE6338 . IP "" 3n7761 \fI\-f\fR\. It means force the shutdown even if applications do not respond for NT\. 7762 .sp 7763 .RE 6339 7764 Shutdown script example: 6340 6341 .sp 6342 7765 .sp 7766 .RS 4 6343 7767 .nf 6344 6345 7768 #!/bin/bash 6346 7769 … … 6350 7773 6351 7774 /sbin/shutdown $3 $4 +$time $1 & 6352 6353 7775 .fi 6354 Shutdown does not return so we need to launch it in background. 6355 .sp 6356 Default: 6357 \fB\fIshutdown script\fR = \fR 6358 .sp 6359 Example: 6360 \fB\fIshutdown script\fR = /usr/local/samba/sbin/shutdown %m %t %r %f \fR 6361 .RE 6362 .PP 7776 .RE 7777 .sp 7778 Shutdown does not return so we need to launch it in background\. 7779 .sp 7780 Default: 7781 \fI\fIshutdown script\fR\fR\fI = \fR\fI\fR\fI \fR 7782 .sp 7783 Example: 7784 \fI\fIshutdown script\fR\fR\fI = \fR\fI/usr/local/samba/sbin/shutdown %m %t %r %f\fR\fI \fR 7785 .RE 7786 6363 7787 smb passwd file (G) 6364 .RS 3n 6365 This option sets the path to the encrypted smbpasswd file. By default the path to the smbpasswd file is compiled into Samba. 7788 .PP 7789 .RS 4 7790 This option sets the path to the encrypted smbpasswd file\. By default the path to the smbpasswd file is compiled into Samba\. 6366 7791 .sp 6367 7792 An example of use is: 6368 6369 .sp 6370 7793 .sp 7794 .RS 4 6371 7795 .nf 6372 6373 7796 smb passwd file = /etc/samba/smbpasswd 6374 6375 7797 .fi 6376 6377 .sp 6378 Default: 6379 \fB\fIsmb passwd file\fR = ${prefix}/private/smbpasswd \fR 6380 .RE 6381 .PP 7798 .RE 7799 .sp 7800 .sp 7801 Default: 7802 \fI\fIsmb passwd file\fR\fR\fI = \fR\fI${prefix}/private/smbpasswd\fR\fI \fR 7803 .RE 7804 6382 7805 smb ports (G) 6383 .RS 3n 6384 Specifies which ports the server should listen on for SMB traffic. 6385 .sp 6386 Default: 6387 \fB\fIsmb ports\fR = 445 139 \fR 6388 .RE 6389 .PP 7806 .PP 7807 .RS 4 7808 Specifies which ports the server should listen on for SMB traffic\. 7809 .sp 7810 Default: 7811 \fI\fIsmb ports\fR\fR\fI = \fR\fI445 139\fR\fI \fR 7812 .RE 7813 6390 7814 socket address (G) 6391 .RS 3n 6392 This option allows you to control what address Samba will listen for connections on. This is used to support multiple virtual interfaces on the one server, each with a different configuration. 6393 .sp 6394 By default Samba will accept connections on any address. 6395 .sp 6396 Default: 6397 \fB\fIsocket address\fR = \fR 6398 .sp 6399 Example: 6400 \fB\fIsocket address\fR = 192.168.2.20 \fR 6401 .RE 6402 .PP 7815 .PP 7816 .RS 4 7817 This option allows you to control what address Samba will listen for connections on\. This is used to support multiple virtual interfaces on the one server, each with a different configuration\. 7818 .sp 7819 By default Samba will accept connections on any address\. 7820 .sp 7821 Default: 7822 \fI\fIsocket address\fR\fR\fI = \fR\fI\fR\fI \fR 7823 .sp 7824 Example: 7825 \fI\fIsocket address\fR\fR\fI = \fR\fI192\.168\.2\.20\fR\fI \fR 7826 .RE 7827 6403 7828 socket options (G) 6404 .RS 3n 6405 This option allows you to set socket options to be used when talking with the client. 6406 .sp 6407 Socket options are controls on the networking layer of the operating systems which allow the connection to be tuned. 6408 .sp 6409 This option will typically be used to tune your Samba server for optimal performance for your local network. There is no way that Samba can know what the optimal parameters are for your net, so you must experiment and choose them yourself. We strongly suggest you read the appropriate documentation for your operating system first (perhaps 7829 .PP 7830 .RS 4 7831 This option allows you to set socket options to be used when talking with the client\. 7832 .sp 7833 Socket options are controls on the networking layer of the operating systems which allow the connection to be tuned\. 7834 .sp 7835 This option will typically be used to tune your Samba server for optimal performance for your local network\. There is no way that Samba can know what the optimal parameters are for your net, so you must experiment and choose them yourself\. We strongly suggest you read the appropriate documentation for your operating system first (perhaps 6410 7836 man setsockopt 6411 will help) .6412 .sp 6413 You may find that on some systems Samba will say "Unknown socket option" when you supply an option . This means you either incorrectly typed it or you need to add an include file to includes.h for your OS. If the latter is the case please send the patch to6414 samba -technical@samba.org.6415 .sp 6416 Any of the supported socket options may be combined in any way you like, as long as your OS allows it .7837 will help)\. 7838 .sp 7839 You may find that on some systems Samba will say "Unknown socket option" when you supply an option\. This means you either incorrectly typed it or you need to add an include file to includes\.h for your OS\. If the latter is the case please send the patch to 7840 samba\-technical@samba\.org\. 7841 .sp 7842 Any of the supported socket options may be combined in any way you like, as long as your OS allows it\. 6417 7843 .sp 6418 7844 This is the list of socket options currently settable using this option: 6419 .RS 3n 6420 .TP 3n 6421 \(bu 7845 .sp 7846 .RS 4 7847 .ie n \{\ 7848 \h'-04'\(bu\h'+03'\c 7849 .\} 7850 .el \{\ 7851 .sp -1 7852 .IP \(bu 2.3 7853 .\} 6422 7854 SO_KEEPALIVE 6423 .TP 3n 6424 \(bu 7855 .RE 7856 .sp 7857 .RS 4 7858 .ie n \{\ 7859 \h'-04'\(bu\h'+03'\c 7860 .\} 7861 .el \{\ 7862 .sp -1 7863 .IP \(bu 2.3 7864 .\} 6425 7865 SO_REUSEADDR 6426 .TP 3n 6427 \(bu 7866 .RE 7867 .sp 7868 .RS 4 7869 .ie n \{\ 7870 \h'-04'\(bu\h'+03'\c 7871 .\} 7872 .el \{\ 7873 .sp -1 7874 .IP \(bu 2.3 7875 .\} 6428 7876 SO_BROADCAST 6429 .TP 3n 6430 \(bu 7877 .RE 7878 .sp 7879 .RS 4 7880 .ie n \{\ 7881 \h'-04'\(bu\h'+03'\c 7882 .\} 7883 .el \{\ 7884 .sp -1 7885 .IP \(bu 2.3 7886 .\} 6431 7887 TCP_NODELAY 6432 .TP 3n 6433 \(bu 7888 .RE 7889 .sp 7890 .RS 4 7891 .ie n \{\ 7892 \h'-04'\(bu\h'+03'\c 7893 .\} 7894 .el \{\ 7895 .sp -1 7896 .IP \(bu 2.3 7897 .\} 6434 7898 IPTOS_LOWDELAY 6435 .TP 3n 6436 \(bu 7899 .RE 7900 .sp 7901 .RS 4 7902 .ie n \{\ 7903 \h'-04'\(bu\h'+03'\c 7904 .\} 7905 .el \{\ 7906 .sp -1 7907 .IP \(bu 2.3 7908 .\} 6437 7909 IPTOS_THROUGHPUT 6438 .TP 3n 6439 \(bu 7910 .RE 7911 .sp 7912 .RS 4 7913 .ie n \{\ 7914 \h'-04'\(bu\h'+03'\c 7915 .\} 7916 .el \{\ 7917 .sp -1 7918 .IP \(bu 2.3 7919 .\} 6440 7920 SO_SNDBUF * 6441 .TP 3n 6442 \(bu 7921 .RE 7922 .sp 7923 .RS 4 7924 .ie n \{\ 7925 \h'-04'\(bu\h'+03'\c 7926 .\} 7927 .el \{\ 7928 .sp -1 7929 .IP \(bu 2.3 7930 .\} 6443 7931 SO_RCVBUF * 6444 .TP 3n 6445 \(bu 7932 .RE 7933 .sp 7934 .RS 4 7935 .ie n \{\ 7936 \h'-04'\(bu\h'+03'\c 7937 .\} 7938 .el \{\ 7939 .sp -1 7940 .IP \(bu 2.3 7941 .\} 6446 7942 SO_SNDLOWAT * 6447 .TP 3n 6448 \(bu 7943 .RE 7944 .sp 7945 .RS 4 7946 .ie n \{\ 7947 \h'-04'\(bu\h'+03'\c 7948 .\} 7949 .el \{\ 7950 .sp -1 7951 .IP \(bu 2.3 7952 .\} 6449 7953 SO_RCVLOWAT * 6450 . RE6451 . IP "" 3n7954 .sp 7955 .RE 6452 7956 Those marked with a 6453 \f B'*'\fR6454 take an integer argument . The others can optionally take a 1 or 0 argument to enable or disable the option, by default they will be enabled if you don't specify 1 or 0.7957 \fI\'*\'\fR 7958 take an integer argument\. The others can optionally take a 1 or 0 argument to enable or disable the option, by default they will be enabled if you don\'t specify 1 or 0\. 6455 7959 .sp 6456 7960 To specify an argument use the syntax SOME_OPTION = VALUE for example 6457 SO_SNDBUF = 8192 . Note that you must not have any spaces before or after the = sign.7961 SO_SNDBUF = 8192\. Note that you must not have any spaces before or after the = sign\. 6458 7962 .sp 6459 7963 If you are on a local network then a sensible option might be: … … 6465 7969 socket options = IPTOS_LOWDELAY TCP_NODELAY 6466 7970 .sp 6467 If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT .6468 .sp 6469 Note that several of the options may cause your Samba server to fail completely . Use these options with caution!6470 .sp 6471 Default: 6472 \f B\fIsocket options\fR = TCP_NODELAY\fR6473 .sp 6474 Example: 6475 \f B\fIsocket options\fR = IPTOS_LOWDELAY\fR6476 .RE 6477 .PP 7971 If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT\. 7972 .sp 7973 Note that several of the options may cause your Samba server to fail completely\. Use these options with caution! 7974 .sp 7975 Default: 7976 \fI\fIsocket options\fR\fR\fI = \fR\fITCP_NODELAY\fR\fI \fR 7977 .sp 7978 Example: 7979 \fI\fIsocket options\fR\fR\fI = \fR\fIIPTOS_LOWDELAY\fR\fI \fR 7980 .RE 7981 6478 7982 stat cache (G) 6479 .RS 3n 7983 .PP 7984 .RS 4 6480 7985 This parameter determines if 6481 7986 \fBsmbd\fR(8) 6482 will use a cache in order to speed up case insensitive name mappings . You should never need to change this parameter.6483 .sp 6484 Default: 6485 \f B\fIstat cache\fR = yes\fR6486 .RE 6487 .PP 7987 will use a cache in order to speed up case insensitive name mappings\. You should never need to change this parameter\. 7988 .sp 7989 Default: 7990 \fI\fIstat cache\fR\fR\fI = \fR\fIyes\fR\fI \fR 7991 .RE 7992 6488 7993 store dos attributes (S) 6489 .RS 3n 6490 If this parameter is set Samba attempts to first read DOS attributes (SYSTEM, HIDDEN, ARCHIVE or READ-ONLY) from a filesystem extended attribute, before mapping DOS attributes to UNIX permission bits (such as occurs with 6491 map hidden and 6492 map readonly). 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 6493 map hidden, 6494 map system, 6495 map archive and 6496 map readonly must be set to off. This parameter writes the DOS attributes as a string into the extended attribute named "user.DOSATTRIB". This extended attribute is explicitly hidden from smbd clients requesting an EA list. On Linux the filesystem must have been mounted with the mount option user_xattr in order for extended attributes to work, also extended attributes must be compiled into the Linux kernel. 6497 .sp 6498 Default: 6499 \fB\fIstore dos attributes\fR = no \fR 6500 .RE 6501 .PP 7994 .PP 7995 .RS 4 7996 If this parameter is set Samba attempts to first read DOS attributes (SYSTEM, HIDDEN, ARCHIVE or READ\-ONLY) from a filesystem extended attribute, before mapping DOS attributes to UNIX permission bits (such as occurs with 7997 \fImap hidden\fR 7998 and 7999 \fImap readonly\fR)\. When set, DOS attributes will be stored onto an extended attribute in the UNIX filesystem, associated with the file or directory\. For no other mapping to occur as a fall\-back, the parameters 8000 \fImap hidden\fR, 8001 \fImap system\fR, 8002 \fImap archive\fR 8003 and 8004 \fImap readonly\fR 8005 must be set to off\. This parameter writes the DOS attributes as a string into the extended attribute named "user\.DOSATTRIB"\. This extended attribute is explicitly hidden from smbd clients requesting an EA list\. On Linux the filesystem must have been mounted with the mount option user_xattr in order for extended attributes to work, also extended attributes must be compiled into the Linux kernel\. 8006 .sp 8007 Default: 8008 \fI\fIstore dos attributes\fR\fR\fI = \fR\fIno\fR\fI \fR 8009 .RE 8010 6502 8011 strict allocate (S) 6503 .RS 3n 6504 This is a boolean that controls the handling of disk space allocation in the server. When this is set to 8012 .PP 8013 .RS 4 8014 This is a boolean that controls the handling of disk space allocation in the server\. When this is set to 6505 8015 \fByes\fR 6506 the server will change from UNIX behaviour of not committing real disk storage blocks when a file is extended to the Windows behaviour of actually forcing the disk system to allocate real storage blocks when a file is created or extended to be a given size . In UNIX terminology this means that Samba will stop creating sparse files. This can be slow on some systems.8016 the server will change from UNIX behaviour of not committing real disk storage blocks when a file is extended to the Windows behaviour of actually forcing the disk system to allocate real storage blocks when a file is created or extended to be a given size\. In UNIX terminology this means that Samba will stop creating sparse files\. This can be slow on some systems\. 6507 8017 .sp 6508 8018 When strict allocate is 6509 8019 \fBno\fR 6510 the server does sparse disk block allocation when a file is extended .8020 the server does sparse disk block allocation when a file is extended\. 6511 8021 .sp 6512 8022 Setting this to 6513 8023 \fByes\fR 6514 can help Samba return out of quota messages on systems that are restricting the disk quota of users .6515 .sp 6516 Default: 6517 \f B\fIstrict allocate\fR = no\fR6518 .RE 6519 .PP 8024 can help Samba return out of quota messages on systems that are restricting the disk quota of users\. 8025 .sp 8026 Default: 8027 \fI\fIstrict allocate\fR\fR\fI = \fR\fIno\fR\fI \fR 8028 .RE 8029 6520 8030 strict locking (S) 6521 .RS 3n 6522 This is an enumerated type that controls the handling of file locking in the server. When this is set to 6523 \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. 6524 .sp 6525 When strict locking is set to Auto (the default), the server performs file lock checks only on non-oplocked files. As most Windows redirectors perform file locking checks locally on oplocked files this is a good trade off for inproved performance. 6526 .sp 6527 When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them. 6528 .sp 6529 Well-behaved clients always ask for lock checks when it is important. So in the vast majority of cases, 8031 .PP 8032 .RS 4 8033 This is an enumerated type that controls the handling of file locking in the server\. When this is set to 8034 \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\. 8035 .sp 8036 When strict locking is set to Auto (the default), the server performs file lock checks only on non\-oplocked files\. As most Windows redirectors perform file locking checks locally on oplocked files this is a good trade off for inproved performance\. 8037 .sp 8038 When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them\. 8039 .sp 8040 Well\-behaved clients always ask for lock checks when it is important\. So in the vast majority of cases, 6530 8041 strict locking = Auto 6531 8042 or 6532 8043 strict locking = no 6533 is acceptable .6534 .sp 6535 Default: 6536 \f B\fIstrict locking\fR = Auto\fR6537 .RE 6538 .PP 8044 is acceptable\. 8045 .sp 8046 Default: 8047 \fI\fIstrict locking\fR\fR\fI = \fR\fIAuto\fR\fI \fR 8048 .RE 8049 6539 8050 strict sync (S) 6540 .RS 3n 6541 Many Windows applications (including the Windows 98 explorer shell) seem to confuse flushing buffer contents to disk with doing a sync to disk. Under UNIX, a sync call forces the process to be suspended until the kernel has ensured that all outstanding data in kernel disk buffers has been safely stored onto stable storage. This is very slow and should only be done rarely. Setting this parameter to 8051 .PP 8052 .RS 4 8053 Many Windows applications (including the Windows 98 explorer shell) seem to confuse flushing buffer contents to disk with doing a sync to disk\. Under UNIX, a sync call forces the process to be suspended until the kernel has ensured that all outstanding data in kernel disk buffers has been safely stored onto stable storage\. This is very slow and should only be done rarely\. Setting this parameter to 6542 8054 \fBno\fR 6543 8055 (the default) means that 6544 8056 \fBsmbd\fR(8) 6545 ignores the Windows applications requests for a sync call . There is only a possibility of losing data if the operating system itself that Samba is running on crashes, so there is little danger in this default setting. In addition, this fixes many performance problems that people have reported with the new Windows98 explorer shell file copies.6546 .sp 6547 Default: 6548 \f B\fIstrict sync\fR = no\fR6549 .RE 6550 .PP 8057 ignores the Windows applications requests for a sync call\. There is only a possibility of losing data if the operating system itself that Samba is running on crashes, so there is little danger in this default setting\. In addition, this fixes many performance problems that people have reported with the new Windows98 explorer shell file copies\. 8058 .sp 8059 Default: 8060 \fI\fIstrict sync\fR\fR\fI = \fR\fIno\fR\fI \fR 8061 .RE 8062 6551 8063 svcctl list (G) 6552 .RS 3n 6553 This option defines a list of init scripts that smbd will use for starting and stopping Unix services via the Win32 ServiceControl API. This allows Windows administrators to utilize the MS Management Console plug-ins to manage a Unix server running Samba. 8064 .PP 8065 .RS 4 8066 This option defines a list of init scripts that smbd will use for starting and stopping Unix services via the Win32 ServiceControl API\. This allows Windows administrators to utilize the MS Management Console plug\-ins to manage a Unix server running Samba\. 6554 8067 .sp 6555 8068 The administrator must create a directory name 6556 8069 \fIsvcctl\fR 6557 in Samba 's $(libdir) and create symbolic links to the init scripts in6558 \fI/etc/init .d/\fR. The name of the links must match the names given as part of the6559 \fIsvcctl list\fR .6560 .sp 6561 Default: 6562 \f B\fIsvcctl list\fR =\fR6563 .sp 6564 Example: 6565 \f B\fIsvcctl list\fR = cups postfix portmap httpd\fR6566 .RE 6567 .PP 8070 in Samba\'s $(libdir) and create symbolic links to the init scripts in 8071 \fI/etc/init\.d/\fR\. The name of the links must match the names given as part of the 8072 \fIsvcctl list\fR\. 8073 .sp 8074 Default: 8075 \fI\fIsvcctl list\fR\fR\fI = \fR\fI\fR\fI \fR 8076 .sp 8077 Example: 8078 \fI\fIsvcctl list\fR\fR\fI = \fR\fIcups postfix portmap httpd\fR\fI \fR 8079 .RE 8080 6568 8081 sync always (S) 6569 .RS 3n 6570 This is a boolean parameter that controls whether writes will always be written to stable storage before the write call returns. If this is 8082 .PP 8083 .RS 4 8084 This is a boolean parameter that controls whether writes will always be written to stable storage before the write call returns\. If this is 6571 8085 \fBno\fR 6572 then the server will be guided by the client 's request in each write call (clients can set a bit indicating that a particular write should be synchronous). If this is8086 then the server will be guided by the client\'s request in each write call (clients can set a bit indicating that a particular write should be synchronous)\. If this is 6573 8087 \fByes\fR 6574 8088 then every write will be followed by a 6575 8089 fsync() 6576 call to ensure the data is written to disk . Note that the8090 call to ensure the data is written to disk\. Note that the 6577 8091 \fIstrict sync\fR 6578 8092 parameter must be set to 6579 8093 \fByes\fR 6580 in order for this parameter to have any affect. 6581 .sp 6582 Default: 6583 \fB\fIsync always\fR = no \fR 6584 .RE 6585 .PP 8094 in order for this parameter to have any affect\. 8095 .sp 8096 Default: 8097 \fI\fIsync always\fR\fR\fI = \fR\fIno\fR\fI \fR 8098 .RE 8099 8100 syslog only (G) 8101 .PP 8102 .RS 4 8103 If this parameter is set then Samba debug messages are logged into the system syslog only, and not to the debug log files\. There still will be some logging to log\.[sn]mbd even if 8104 \fIsyslog only\fR 8105 is enabled\. 8106 .sp 8107 Default: 8108 \fI\fIsyslog only\fR\fR\fI = \fR\fIno\fR\fI \fR 8109 .RE 8110 6586 8111 syslog (G) 6587 .RS 3n 6588 This parameter maps how Samba debug messages are logged onto the system syslog logging levels. Samba debug level zero maps onto syslog 8112 .PP 8113 .RS 4 8114 This parameter maps how Samba debug messages are logged onto the system syslog logging levels\. Samba debug level zero maps onto syslog 6589 8115 \fBLOG_ERR\fR, debug level one maps onto 6590 8116 \fBLOG_WARNING\fR, debug level two maps onto 6591 \fBLOG_NOTICE\fR, debug level three maps onto LOG_INFO. All higher levels are mapped to 6592 \fBLOG_DEBUG\fR. 6593 .sp 6594 This parameter sets the threshold for sending messages to syslog. Only messages with debug level less than this value will be sent to syslog. 6595 .sp 6596 Default: 6597 \fB\fIsyslog\fR = 1 \fR 6598 .RE 6599 .PP 6600 syslog only (G) 6601 .RS 3n 6602 If this parameter is set then Samba debug messages are logged into the system syslog only, and not to the debug log files. 6603 .sp 6604 Default: 6605 \fB\fIsyslog only\fR = no \fR 6606 .RE 6607 .PP 8117 \fBLOG_NOTICE\fR, debug level three maps onto LOG_INFO\. All higher levels are mapped to 8118 \fBLOG_DEBUG\fR\. 8119 .sp 8120 This parameter sets the threshold for sending messages to syslog\. Only messages with debug level less than this value will be sent to syslog\. There still will be some logging to log\.[sn]mbd even if 8121 \fIsyslog only\fR 8122 is enabled\. 8123 .sp 8124 Default: 8125 \fI\fIsyslog\fR\fR\fI = \fR\fI1\fR\fI \fR 8126 .RE 8127 6608 8128 template homedir (G) 6609 .RS 3n 8129 .PP 8130 .RS 4 6610 8131 When filling out the user information for a Windows NT user, the 6611 8132 \fBwinbindd\fR(8) 6612 daemon uses this parameter to fill in the home directory for that user . If the string8133 daemon uses this parameter to fill in the home directory for that user\. If the string 6613 8134 \fI%D\fR 6614 is present it is substituted with the user 's Windows NT domain name. If the string8135 is present it is substituted with the user\'s Windows NT domain name\. If the string 6615 8136 \fI%U\fR 6616 is present it is substituted with the user 's Windows NT user name.6617 .sp 6618 Default: 6619 \f B\fItemplate homedir\fR = /home/%D/%U\fR6620 .RE 6621 .PP 8137 is present it is substituted with the user\'s Windows NT user name\. 8138 .sp 8139 Default: 8140 \fI\fItemplate homedir\fR\fR\fI = \fR\fI/home/%D/%U\fR\fI \fR 8141 .RE 8142 6622 8143 template shell (G) 6623 .RS 3n 8144 .PP 8145 .RS 4 6624 8146 When filling out the user information for a Windows NT user, the 6625 8147 \fBwinbindd\fR(8) 6626 daemon uses this parameter to fill in the login shell for that user .6627 .sp 6628 \f BNo default\fR6629 .RE 6630 .PP 8148 daemon uses this parameter to fill in the login shell for that user\. 8149 .sp 8150 \fINo default\fR 8151 .RE 8152 6631 8153 time offset (G) 6632 .RS 3n 6633 This parameter is a setting in minutes to add to the normal GMT to local time conversion. This is useful if you are serving a lot of PCs that have incorrect daylight saving time handling. 6634 .sp 6635 Default: 6636 \fB\fItime offset\fR = 0 \fR 6637 .sp 6638 Example: 6639 \fB\fItime offset\fR = 60 \fR 6640 .RE 6641 .PP 8154 .PP 8155 .RS 4 8156 This parameter is a setting in minutes to add to the normal GMT to local time conversion\. This is useful if you are serving a lot of PCs that have incorrect daylight saving time handling\. 8157 .sp 8158 Default: 8159 \fI\fItime offset\fR\fR\fI = \fR\fI0\fR\fI \fR 8160 .sp 8161 Example: 8162 \fI\fItime offset\fR\fR\fI = \fR\fI60\fR\fI \fR 8163 .RE 8164 6642 8165 time server (G) 6643 .RS 3n 8166 .PP 8167 .RS 4 6644 8168 This parameter determines if 6645 8169 \fBnmbd\fR(8) 6646 advertises itself as a time server to Windows clients .6647 .sp 6648 Default: 6649 \f B\fItime server\fR = no\fR6650 .RE 6651 .PP 8170 advertises itself as a time server to Windows clients\. 8171 .sp 8172 Default: 8173 \fI\fItime server\fR\fR\fI = \fR\fIno\fR\fI \fR 8174 .RE 8175 6652 8176 unix charset (G) 6653 .RS 3n 6654 Specifies the charset the unix machine Samba runs on uses. Samba needs to know this in order to be able to convert text to the charsets other SMB clients use. 6655 .sp 6656 This is also the charset Samba will use when specifying arguments to scripts that it invokes. 6657 .sp 6658 Default: 6659 \fB\fIunix charset\fR = UTF8 \fR 6660 .sp 6661 Example: 6662 \fB\fIunix charset\fR = ASCII \fR 6663 .RE 6664 .PP 8177 .PP 8178 .RS 4 8179 Specifies the charset the unix machine Samba runs on uses\. Samba needs to know this in order to be able to convert text to the charsets other SMB clients use\. 8180 .sp 8181 This is also the charset Samba will use when specifying arguments to scripts that it invokes\. 8182 .sp 8183 Default: 8184 \fI\fIunix charset\fR\fR\fI = \fR\fIUTF8\fR\fI \fR 8185 .sp 8186 Example: 8187 \fI\fIunix charset\fR\fR\fI = \fR\fIASCII\fR\fI \fR 8188 .RE 8189 6665 8190 unix extensions (G) 6666 .RS 3n 6667 This boolean parameter controls whether Samba implments the CIFS UNIX extensions, as defined by HP. These extensions enable Samba to better serve UNIX CIFS clients by supporting features such as symbolic links, hard links, etc... These extensions require a similarly enabled client, and are of no current use to Windows clients. 6668 .sp 6669 Default: 6670 \fB\fIunix extensions\fR = yes \fR 6671 .RE 6672 .PP 8191 .PP 8192 .RS 4 8193 This boolean parameter controls whether Samba implments the CIFS UNIX extensions, as defined by HP\. These extensions enable Samba to better serve UNIX CIFS clients by supporting features such as symbolic links, hard links, etc\.\.\. These extensions require a similarly enabled client, and are of no current use to Windows clients\. 8194 .sp 8195 Default: 8196 \fI\fIunix extensions\fR\fR\fI = \fR\fIyes\fR\fI \fR 8197 .RE 8198 6673 8199 unix password sync (G) 6674 .RS 3n 6675 This boolean parameter controls whether Samba attempts to synchronize the UNIX password with the SMB password when the encrypted SMB password in the smbpasswd file is changed. If this is set to 8200 .PP 8201 .RS 4 8202 This boolean parameter controls whether Samba attempts to synchronize the UNIX password with the SMB password when the encrypted SMB password in the smbpasswd file is changed\. If this is set to 6676 8203 \fByes\fR 6677 8204 the program specified in the 6678 8205 \fIpasswd program\fRparameter is called 6679 \f BAS ROOT\fR6680 - 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).6681 .sp 6682 Default: 6683 \f B\fIunix password sync\fR = no\fR6684 .RE 6685 .PP 8206 \fIAS ROOT\fR 8207 \- 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)\. 8208 .sp 8209 Default: 8210 \fI\fIunix password sync\fR\fR\fI = \fR\fIno\fR\fI \fR 8211 .RE 8212 6686 8213 update encrypted (G) 6687 .RS 3n 6688 This boolean parameter allows a user logging on with a plaintext password to have their encrypted (hashed) password in the smbpasswd file to be updated automatically as they log on. This option allows a site to migrate from plaintext password authentication (users authenticate with plaintext password over the wire, and are checked against a UNIX account atabase) to encrypted password authentication (the SMB challenge/response authentication mechanism) without forcing all users to re-enter their passwords via smbpasswd at the time the change is made. This is a convenience option to allow the change over to encrypted passwords to be made over a longer period. Once all users have encrypted representations of their passwords in the smbpasswd file this parameter should be set to 6689 \fBno\fR. 8214 .PP 8215 .RS 4 8216 This boolean parameter allows a user logging on with a plaintext password to have their encrypted (hashed) password in the smbpasswd file to be updated automatically as they log on\. This option allows a site to migrate from plaintext password authentication (users authenticate with plaintext password over the wire, and are checked against a UNIX account atabase) to encrypted password authentication (the SMB challenge/response authentication mechanism) without forcing all users to re\-enter their passwords via smbpasswd at the time the change is made\. This is a convenience option to allow the change over to encrypted passwords to be made over a longer period\. Once all users have encrypted representations of their passwords in the smbpasswd file this parameter should be set to 8217 \fBno\fR\. 6690 8218 .sp 6691 8219 In order for this parameter to be operative the 6692 encrypt passwords parameter must be set to 6693 \fBno\fR. The default value of 6694 encrypt passwords = Yes. Note: This must be set to 8220 \fIencrypt passwords\fR 8221 parameter must be set to 8222 \fBno\fR\. The default value of 8223 \fIencrypt passwords = Yes\fR\. Note: This must be set to 6695 8224 \fBno\fR 6696 8225 for this 6697 update encrypted to work. 8226 \fIupdate encrypted\fR 8227 to work\. 6698 8228 .sp 6699 8229 Note that even when this parameter is set a user authenticating to 6700 8230 smbd 6701 must still enter a valid password in order to connect correctly, and to update their hashed (smbpasswd) passwords .6702 .sp 6703 Default: 6704 \f B\fIupdate encrypted\fR = no\fR6705 .RE 6706 .PP 8231 must still enter a valid password in order to connect correctly, and to update their hashed (smbpasswd) passwords\. 8232 .sp 8233 Default: 8234 \fI\fIupdate encrypted\fR\fR\fI = \fR\fIno\fR\fI \fR 8235 .RE 8236 6707 8237 use client driver (S) 6708 .RS 3n 6709 This parameter applies only to Windows NT/2000 clients. It has no effect on Windows 95/98/ME clients. When serving a printer to Windows NT/2000 clients without first installing a valid printer driver on the Samba host, the client will be required to install a local printer driver. From this point on, the client will treat the print as a local printer and not a network printer connection. This is much the same behavior that will occur when 6710 disable spoolss = yes. 6711 .sp 6712 The differentiating factor is that under normal circumstances, the NT/2000 client will attempt to open the network printer using MS-RPC. The problem is that because the client considers the printer to be local, it will attempt to issue the OpenPrinterEx() call requesting access rights associated with the logged on user. If the user possesses local administator rights but not root privilege on the Samba host (often the case), the OpenPrinterEx() call will fail. The result is that the client will now display an "Access Denied; Unable to connect" message in the printer queue window (even though jobs may successfully be printed). 6713 .sp 6714 If this parameter is enabled for a printer, then any attempt to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx() call to succeed. 6715 \fBThis parameter MUST not be able enabled on a print share which has valid print driver installed on the Samba server.\fR 6716 .sp 6717 Default: 6718 \fB\fIuse client driver\fR = no \fR 6719 .RE 6720 .PP 8238 .PP 8239 .RS 4 8240 This parameter applies only to Windows NT/2000 clients\. It has no effect on Windows 95/98/ME clients\. When serving a printer to Windows NT/2000 clients without first installing a valid printer driver on the Samba host, the client will be required to install a local printer driver\. From this point on, the client will treat the print as a local printer and not a network printer connection\. This is much the same behavior that will occur when 8241 disable spoolss = yes\. 8242 .sp 8243 The differentiating factor is that under normal circumstances, the NT/2000 client will attempt to open the network printer using MS\-RPC\. The problem is that because the client considers the printer to be local, it will attempt to issue the OpenPrinterEx() call requesting access rights associated with the logged on user\. If the user possesses local administator rights but not root privilege on the Samba host (often the case), the OpenPrinterEx() call will fail\. The result is that the client will now display an "Access Denied; Unable to connect" message in the printer queue window (even though jobs may successfully be printed)\. 8244 .sp 8245 If this parameter is enabled for a printer, then any attempt to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped to PRINTER_ACCESS_USE instead\. Thus allowing the OpenPrinterEx() call to succeed\. 8246 \fIThis parameter MUST not be able enabled on a print share which has valid print driver installed on the Samba server\.\fR 8247 .sp 8248 Default: 8249 \fI\fIuse client driver\fR\fR\fI = \fR\fIno\fR\fI \fR 8250 .RE 8251 6721 8252 use kerberos keytab (G) 6722 .RS 3n 8253 .PP 8254 .RS 4 6723 8255 Specifies whether Samba should attempt to maintain service principals in the systems keytab file for 6724 8256 \fBhost/FQDN\fR 6725 8257 and 6726 \fBcifs/FQDN\fR .8258 \fBcifs/FQDN\fR\. 6727 8259 .sp 6728 8260 When you are using the heimdal Kerberos libraries, you must also specify the following in 6729 \fI/etc/krb5.conf\fR: 6730 6731 .sp 6732 8261 \fI/etc/krb5\.conf\fR: 8262 .sp 8263 .RS 4 6733 8264 .nf 6734 6735 8265 [libdefaults] 6736 default_keytab_name = FILE:/etc/krb5.keytab 6737 8266 default_keytab_name = FILE:/etc/krb5\.keytab 6738 8267 .fi 6739 6740 .sp 6741 Default: 6742 \fB\fIuse kerberos keytab\fR = False \fR 6743 .RE 6744 .PP 8268 .RE 8269 .sp 8270 .sp 8271 Default: 8272 \fI\fIuse kerberos keytab\fR\fR\fI = \fR\fIFalse\fR\fI \fR 8273 .RE 8274 6745 8275 use mmap (G) 6746 .RS 3n 6747 This global parameter determines if the tdb internals of Samba can depend on mmap working correctly on the running system. Samba requires a coherent mmap/read-write system memory cache. Currently only HPUX does not have such a coherent cache, and so this parameter is set to 8276 .PP 8277 .RS 4 8278 This global parameter determines if the tdb internals of Samba can depend on mmap working correctly on the running system\. Samba requires a coherent mmap/read\-write system memory cache\. Currently only HPUX does not have such a coherent cache, and so this parameter is set to 6748 8279 \fBno\fR 6749 by default on HPUX. On all other systems this parameter should be left alone. This parameter is provided to help the Samba developers track down problems with the tdb internal code. 6750 .sp 6751 Default: 6752 \fB\fIuse mmap\fR = yes \fR 6753 .RE 6754 .PP 6755 user 6756 .RS 3n 6757 This parameter is a synonym for username. 6758 .RE 6759 .PP 6760 users 6761 .RS 3n 6762 This parameter is a synonym for username. 6763 .RE 6764 .PP 6765 username (S) 6766 .RS 3n 6767 Multiple users may be specified in a comma-delimited list, in which case the supplied password will be tested against each username in turn (left to right). 6768 .sp 6769 The 6770 \fIusername\fR 6771 line is needed only when the PC is unable to supply its own username. This is the case for the COREPLUS protocol or where your users have different WfWg usernames to UNIX usernames. In both these cases you may also be better using the \\server\share%user syntax instead. 6772 .sp 6773 The 6774 \fIusername\fR 6775 line is not a great solution in many cases as it means Samba will try to validate the supplied password against each of the usernames in the 6776 \fIusername\fR 6777 line in turn. This is slow and a bad idea for lots of users in case of duplicate passwords. You may get timeouts or security breaches using this parameter unwisely. 6778 .sp 6779 Samba relies on the underlying UNIX security. This parameter does not restrict who can login, it just offers hints to the Samba server as to what usernames might correspond to the supplied password. Users can login as whoever they please and they will be able to do no more damage than if they started a telnet session. The daemon runs as the user that they log in as, so they cannot do anything that user cannot do. 6780 .sp 6781 To restrict a service to a particular set of users you can use the 6782 valid users parameter. 6783 .sp 6784 If any of the usernames begin with a '@' then the name will be looked up first in the NIS netgroups list (if Samba is compiled with netgroup support), followed by a lookup in the UNIX groups database and will expand to a list of all users in the group of that name. 6785 .sp 6786 If any of the usernames begin with a '+' then the name will be looked up only in the UNIX groups database and will expand to a list of all users in the group of that name. 6787 .sp 6788 If any of the usernames begin with a '&' then the name will be looked up only in the NIS netgroups database (if Samba is compiled with netgroup support) and will expand to a list of all users in the netgroup group of that name. 6789 .sp 6790 Note that searching though a groups database can take quite some time, and some clients may time out during the search. 6791 .sp 6792 See the section 6793 NOTE ABOUT USERNAME/PASSWORD VALIDATION 6794 for more information on how this parameter determines access to the services. 6795 .sp 6796 Default: 6797 \fB\fIusername\fR = # The guest account if a guest service, else <empty string>. \fR 6798 .sp 6799 Example: 6800 \fB\fIusername\fR = fred, mary, jack, jane, @users, @pcgroup \fR 6801 .RE 6802 .PP 8280 by default on HPUX\. On all other systems this parameter should be left alone\. This parameter is provided to help the Samba developers track down problems with the tdb internal code\. 8281 .sp 8282 Default: 8283 \fI\fIuse mmap\fR\fR\fI = \fR\fIyes\fR\fI \fR 8284 .RE 8285 6803 8286 username level (G) 6804 .RS 3n 6805 This option helps Samba to try and 'guess' at the real UNIX username, as many DOS clients send an all-uppercase username. By default Samba tries all lowercase, followed by the username with the first letter capitalized, and fails if the username is not found on the UNIX machine. 6806 .sp 6807 If this parameter is set to non-zero the behavior changes. This parameter is a number that specifies the number of uppercase combinations to try while trying to determine the UNIX user name. The higher the number the more combinations will be tried, but the slower the discovery of usernames will be. Use this parameter when you have strange usernames on your UNIX machine, such as 6808 \fBAstrangeUser \fR. 6809 .sp 6810 This parameter is needed only on UNIX systems that have case sensitive usernames. 6811 .sp 6812 Default: 6813 \fB\fIusername level\fR = 0 \fR 6814 .sp 6815 Example: 6816 \fB\fIusername level\fR = 5 \fR 6817 .RE 6818 .PP 8287 .PP 8288 .RS 4 8289 This option helps Samba to try and \'guess\' at the real UNIX username, as many DOS clients send an all\-uppercase username\. By default Samba tries all lowercase, followed by the username with the first letter capitalized, and fails if the username is not found on the UNIX machine\. 8290 .sp 8291 If this parameter is set to non\-zero the behavior changes\. This parameter is a number that specifies the number of uppercase combinations to try while trying to determine the UNIX user name\. The higher the number the more combinations will be tried, but the slower the discovery of usernames will be\. Use this parameter when you have strange usernames on your UNIX machine, such as 8292 \fBAstrangeUser \fR\. 8293 .sp 8294 This parameter is needed only on UNIX systems that have case sensitive usernames\. 8295 .sp 8296 Default: 8297 \fI\fIusername level\fR\fR\fI = \fR\fI0\fR\fI \fR 8298 .sp 8299 Example: 8300 \fI\fIusername level\fR\fR\fI = \fR\fI5\fR\fI \fR 8301 .RE 8302 8303 username map script (G) 8304 .PP 8305 .RS 4 8306 This script is a mutually exclusive alternative to the 8307 \fIusername map\fR 8308 parameter\. This parameter specifies and external program or script that must accept a single command line option (the username transmitted in the authentication request) and return a line line on standard output (the name to which the account should mapped)\. In this way, it is possible to store username map tables in an LDAP or NIS directory services\. 8309 .sp 8310 Default: 8311 \fI\fIusername map script\fR\fR\fI = \fR\fI\fR\fI \fR 8312 .sp 8313 Example: 8314 \fI\fIusername map script\fR\fR\fI = \fR\fI/etc/samba/scripts/mapusers\.sh\fR\fI \fR 8315 .RE 8316 6819 8317 username map (G) 6820 .RS 3n 6821 This option allows you to specify a file containing a mapping of usernames from the clients to the server. This can be used for several purposes. The most common is to map usernames that users use on DOS or Windows machines to those that the UNIX box uses. The other is to map multiple users to a single username so that they can more easily share files. 6822 .sp 6823 Please note that for user or share mode security, the username map is applied prior to validating the user credentials. Domain member servers (domain or ads) apply the username map after the user has been successfully authenticated by the domain controller and require fully qualified enties in the map table (e.g. biddle = DOMAIN\foo). 6824 .sp 6825 The map file is parsed line by line. Each line should contain a single UNIX username on the left then a '=' followed by a list of usernames on the right. The list of usernames on the right may contain names of the form @group in which case they will match any UNIX username in that group. The special client name '*' is a wildcard and matches any name. Each line of the map file may be up to 1023 characters long. 6826 .sp 6827 The file is processed on each line by taking the supplied username and comparing it with each username on the right hand side of the '=' signs. If the supplied name matches any of the names on the right hand side then it is replaced with the name on the left. Processing then continues with the next line. 6828 .sp 6829 If any line begins with a '#' or a ';' then it is ignored. 6830 .sp 6831 If any line begins with an '!' then the processing will stop after that line if a mapping was done by the line. Otherwise mapping continues with every line being processed. Using '!' is most useful when you have a wildcard mapping line later in the file. 8318 .PP 8319 .RS 4 8320 This option allows you to specify a file containing a mapping of usernames from the clients to the server\. This can be used for several purposes\. The most common is to map usernames that users use on DOS or Windows machines to those that the UNIX box uses\. The other is to map multiple users to a single username so that they can more easily share files\. 8321 .sp 8322 Please note that for user or share mode security, the username map is applied prior to validating the user credentials\. Domain member servers (domain or ads) apply the username map after the user has been successfully authenticated by the domain controller and require fully qualified enties in the map table (e\.g\. biddle = 8323 DOMAIN\efoo)\. 8324 .sp 8325 The map file is parsed line by line\. Each line should contain a single UNIX username on the left then a \'=\' followed by a list of usernames on the right\. The list of usernames on the right may contain names of the form @group in which case they will match any UNIX username in that group\. The special client name \'*\' is a wildcard and matches any name\. Each line of the map file may be up to 1023 characters long\. 8326 .sp 8327 The file is processed on each line by taking the supplied username and comparing it with each username on the right hand side of the \'=\' signs\. If the supplied name matches any of the names on the right hand side then it is replaced with the name on the left\. Processing then continues with the next line\. 8328 .sp 8329 If any line begins with a \'#\' or a \';\' then it is ignored\. 8330 .sp 8331 If any line begins with an \'!\' then the processing will stop after that line if a mapping was done by the line\. Otherwise mapping continues with every line being processed\. Using \'!\' is most useful when you have a wildcard mapping line later in the file\. 6832 8332 .sp 6833 8333 For example to map from the name … … 6838 8338 \fB root\fR 6839 8339 you would use: 6840 6841 .sp 6842 8340 .sp 8341 .RS 4 6843 8342 .nf 6844 6845 8343 root = admin administrator 6846 6847 8344 .fi 8345 .RE 8346 .sp 6848 8347 Or to map anyone in the UNIX group 6849 8348 \fBsystem\fR … … 6851 8350 \fBsys\fR 6852 8351 you would use: 6853 6854 .sp 6855 8352 .sp 8353 .RS 4 6856 8354 .nf 6857 6858 8355 sys = @system 6859 6860 8356 .fi 6861 6862 .sp 6863 You can have as many mappings as you like in a username map file. 8357 .RE 8358 .sp 8359 .sp 8360 You can have as many mappings as you like in a username map file\. 6864 8361 .sp 6865 8362 If your system supports the NIS NETGROUP option then the netgroup database is checked before the 6866 8363 \fI/etc/group \fR 6867 database for matching groups. 6868 .sp 6869 You can map Windows usernames that have spaces in them by using double quotes around the name. For example: 6870 6871 .sp 6872 8364 database for matching groups\. 8365 .sp 8366 You can map Windows usernames that have spaces in them by using double quotes around the name\. For example: 8367 .sp 8368 .RS 4 6873 8369 .nf 6874 6875 8370 tridge = "Andrew Tridgell" 6876 6877 8371 .fi 6878 would map the windows username "Andrew Tridgell" to the unix username "tridge". 6879 .sp 6880 The following example would map mary and fred to the unix user sys, and map the rest to guest. Note the use of the '!' to tell Samba to stop processing if it gets a match on that line: 6881 6882 .sp 6883 8372 .RE 8373 .sp 8374 would map the windows username "Andrew Tridgell" to the unix username "tridge"\. 8375 .sp 8376 The following example would map mary and fred to the unix user sys, and map the rest to guest\. Note the use of the \'!\' to tell Samba to stop processing if it gets a match on that line: 8377 .sp 8378 .RS 4 6884 8379 .nf 6885 6886 8380 !sys = mary fred 6887 8381 guest = * 6888 6889 8382 .fi 6890 6891 .sp 6892 Note that the remapping is applied to all occurrences of usernames. Thus if you connect to \\server\fred and 8383 .RE 8384 .sp 8385 .sp 8386 Note that the remapping is applied to all occurrences of usernames\. Thus if you connect to \e\eserver\efred and 6893 8387 \fBfred\fR 6894 8388 is remapped to 6895 8389 \fBmary\fR 6896 then you will actually be connecting to \ \server\mary and will need to supply a password suitable for8390 then you will actually be connecting to \e\eserver\emary and will need to supply a password suitable for 6897 8391 \fBmary\fR 6898 8392 not 6899 \fBfred\fR. The only exception to this is the username passed to the 6900 password server (if you have one). The password server will receive whatever username the client supplies without modification. 6901 .sp 6902 Also note that no reverse mapping is done. The main effect this has is with printing. Users who have been mapped may have trouble deleting print jobs as PrintManager under WfWg will think they don't own the print job. 6903 .sp 6904 Samba versions prior to 3.0.8 would only support reading the fully qualified username (e.g.: DOMAIN\user) 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. 6905 .sp 6906 The following functionality is obeyed in version 3.0.8 and later: 6907 .sp 6908 When performing local authentication, the username map is applied to the login name before attempting to authenticate the connection. 6909 .sp 6910 When relying upon a external domain controller for validating authentication requests, smbd will apply the username map to the fully qualified username (i.e. DOMAIN\user) only after the user has been successfully authenticated. 8393 \fBfred\fR\. The only exception to this is the username passed to the 8394 \fIpassword server\fR 8395 (if you have one)\. The password server will receive whatever username the client supplies without modification\. 8396 .sp 8397 Also note that no reverse mapping is done\. The main effect this has is with printing\. Users who have been mapped may have trouble deleting print jobs as PrintManager under WfWg will think they don\'t own the print job\. 8398 .sp 8399 Samba versions prior to 3\.0\.8 would only support reading the fully qualified username (e\.g\.: 8400 DOMAIN\euser) from the username map when performing a kerberos login from a client\. However, when looking up a map entry for a user authenticated by NTLM[SSP], only the login name would be used for matches\. This resulted in inconsistent behavior sometimes even on the same server\. 8401 .sp 8402 The following functionality is obeyed in version 3\.0\.8 and later: 8403 .sp 8404 When performing local authentication, the username map is applied to the login name before attempting to authenticate the connection\. 8405 .sp 8406 When relying upon a external domain controller for validating authentication requests, smbd will apply the username map to the fully qualified username (i\.e\. 8407 DOMAIN\euser) only after the user has been successfully authenticated\. 6911 8408 .sp 6912 8409 An example of use is: 6913 6914 .sp 6915 8410 .sp 8411 .RS 4 6916 8412 .nf 6917 6918 username map = /usr/local/samba/lib/users.map 6919 8413 username map = /usr/local/samba/lib/users\.map 6920 8414 .fi 6921 6922 .sp 6923 Default: 6924 \fB\fIusername map\fR = # no username map \fR 6925 .RE 6926 .PP 6927 username map script (G) 6928 .RS 3n 6929 This script is a mutually exclusive alternative to the 6930 username map parameter. This parameter specifies and external program or script that must accept a single command line option (the username transmitted in the authentication request) and return a line line on standard output (the name to which the account should mapped). In this way, it is possible to store username map tables in an LDAP or NIS directory services. 6931 .sp 6932 Default: 6933 \fB\fIusername map script\fR = \fR 6934 .sp 6935 Example: 6936 \fB\fIusername map script\fR = /etc/samba/scripts/mapusers.sh \fR 6937 .RE 6938 .PP 8415 .RE 8416 .sp 8417 .sp 8418 Default: 8419 \fI\fIusername map\fR\fR\fI = \fR\fI # no username map\fR\fI \fR 8420 .RE 8421 user.PP 8422 .RS 4 8423 This parameter is a synonym for 8424 username\. 8425 .RE 8426 users.PP 8427 .RS 4 8428 This parameter is a synonym for 8429 username\. 8430 .RE 8431 8432 username (S) 8433 .PP 8434 .RS 4 8435 Multiple users may be specified in a comma\-delimited list, in which case the supplied password will be tested against each username in turn (left to right)\. 8436 .sp 8437 The 8438 \fIusername\fR 8439 line is needed only when the PC is unable to supply its own username\. This is the case for the COREPLUS protocol or where your users have different WfWg usernames to UNIX usernames\. In both these cases you may also be better using the \e\eserver\eshare%user syntax instead\. 8440 .sp 8441 The 8442 \fIusername\fR 8443 line is not a great solution in many cases as it means Samba will try to validate the supplied password against each of the usernames in the 8444 \fIusername\fR 8445 line in turn\. This is slow and a bad idea for lots of users in case of duplicate passwords\. You may get timeouts or security breaches using this parameter unwisely\. 8446 .sp 8447 Samba relies on the underlying UNIX security\. This parameter does not restrict who can login, it just offers hints to the Samba server as to what usernames might correspond to the supplied password\. Users can login as whoever they please and they will be able to do no more damage than if they started a telnet session\. The daemon runs as the user that they log in as, so they cannot do anything that user cannot do\. 8448 .sp 8449 To restrict a service to a particular set of users you can use the 8450 \fIvalid users\fR 8451 parameter\. 8452 .sp 8453 If any of the usernames begin with a \'@\' then the name will be looked up first in the NIS netgroups list (if Samba is compiled with netgroup support), followed by a lookup in the UNIX groups database and will expand to a list of all users in the group of that name\. 8454 .sp 8455 If any of the usernames begin with a \'+\' then the name will be looked up only in the UNIX groups database and will expand to a list of all users in the group of that name\. 8456 .sp 8457 If any of the usernames begin with a \'&\' then the name will be looked up only in the NIS netgroups database (if Samba is compiled with netgroup support) and will expand to a list of all users in the netgroup group of that name\. 8458 .sp 8459 Note that searching though a groups database can take quite some time, and some clients may time out during the search\. 8460 .sp 8461 See the section 8462 NOTE ABOUT USERNAME/PASSWORD VALIDATION 8463 for more information on how this parameter determines access to the services\. 8464 .sp 8465 Default: 8466 \fI\fIusername\fR\fR\fI = \fR\fI # The guest account if a guest service, else <empty string>\.\fR\fI \fR 8467 .sp 8468 Example: 8469 \fI\fIusername\fR\fR\fI = \fR\fIfred, mary, jack, jane, @users, @pcgroup\fR\fI \fR 8470 .RE 8471 6939 8472 usershare allow guests (G) 6940 .RS 3n 6941 This parameter controls whether user defined shares are allowed to be accessed by non-authenticated users or not. It is the equivalent of allowing people who can create a share the option of setting 8473 .PP 8474 .RS 4 8475 This parameter controls whether user defined shares are allowed to be accessed by non\-authenticated users or not\. It is the equivalent of allowing people who can create a share the option of setting 6942 8476 \fIguest ok = yes\fR 6943 in a share definition . Due to the security sensitive nature of this the default is set to off.6944 .sp 6945 Default: 6946 \f B\fIusershare allow guests\fR = no\fR6947 .RE 6948 .PP 8477 in a share definition\. Due to the security sensitive nature of this the default is set to off\. 8478 .sp 8479 Default: 8480 \fI\fIusershare allow guests\fR\fR\fI = \fR\fIno\fR\fI \fR 8481 .RE 8482 6949 8483 usershare max shares (G) 6950 .RS 3n 6951 This parameter specifies the number of user defined shares that are allowed to be created by users belonging to the group owning the usershare directory. If set to zero (the default) user defined shares are ignored. 6952 .sp 6953 Default: 6954 \fB\fIusershare max shares\fR = 0 \fR 6955 .RE 6956 .PP 8484 .PP 8485 .RS 4 8486 This parameter specifies the number of user defined shares that are allowed to be created by users belonging to the group owning the usershare directory\. If set to zero (the default) user defined shares are ignored\. 8487 .sp 8488 Default: 8489 \fI\fIusershare max shares\fR\fR\fI = \fR\fI0\fR\fI \fR 8490 .RE 8491 6957 8492 usershare owner only (G) 6958 .RS 3n 6959 This parameter controls whether the pathname exported by a user defined shares must be owned by the user creating the user defined share or not. If set to True (the default) then smbd checks that the directory path being shared is owned by the user who owns the usershare file defining this share and refuses to create the share if not. If set to False then no such check is performed and any directory path may be exported regardless of who owns it. 6960 .sp 6961 Default: 6962 \fB\fIusershare owner only\fR = True \fR 6963 .RE 6964 .PP 8493 .PP 8494 .RS 4 8495 This parameter controls whether the pathname exported by a user defined shares must be owned by the user creating the user defined share or not\. If set to True (the default) then smbd checks that the directory path being shared is owned by the user who owns the usershare file defining this share and refuses to create the share if not\. If set to False then no such check is performed and any directory path may be exported regardless of who owns it\. 8496 .sp 8497 Default: 8498 \fI\fIusershare owner only\fR\fR\fI = \fR\fITrue\fR\fI \fR 8499 .RE 8500 6965 8501 usershare path (G) 6966 . RS 3n6967 This parameter specifies the absolute path of the directory on the filesystem used to store the user defined share definition files. This directory must be owned by root, and have no access for other, and be writable only by the group owner. In addition the "sticky" bit must also be set, restricting rename and delete to owners of a file (in the same way the /tmp directory is usually configured). Members of the group owner of this directory are the users allowed to create usershares. If this parameter is undefined then no user defined shares are allowed. 6968 .sp 6969 For example, a valid usershare directory might be /usr/local/samba/lib/usershares, set up as follows. 6970 .sp 6971 6972 6973 .sp 6974 8502 .PP 8503 .RS 4 8504 This parameter specifies the absolute path of the directory on the filesystem used to store the user defined share definition files\. This directory must be owned by root, and have no access for other, and be writable only by the group owner\. In addition the "sticky" bit must also be set, restricting rename and delete to owners of a file (in the same way the /tmp directory is usually configured)\. Members of the group owner of this directory are the users allowed to create usershares\. If this parameter is undefined then no user defined shares are allowed\. 8505 .sp 8506 For example, a valid usershare directory might be /usr/local/samba/lib/usershares, set up as follows\. 8507 .sp 8508 8509 .sp 8510 .RS 4 6975 8511 .nf 6976 6977 ls -ld /usr/local/samba/lib/usershares/ 6978 drwxrwx--T 2 root power_users 4096 2006-05-05 12:27 /usr/local/samba/lib/usershares/ 8512 ls \-ld /usr/local/samba/lib/usershares/ 8513 drwxrwx\-\-T 2 root power_users 4096 2006\-05\-05 12:27 /usr/local/samba/lib/usershares/ 6979 8514 6980 8515 .fi 6981 6982 .sp 6983 In this case, only members of the group "power_users" can create user defined shares. 6984 .sp 6985 Default: 6986 \fB\fIusershare path\fR = NULL \fR 6987 .RE 6988 .PP 8516 .RE 8517 .sp 8518 .sp 8519 In this case, only members of the group "power_users" can create user defined shares\. 8520 .sp 8521 Default: 8522 \fI\fIusershare path\fR\fR\fI = \fR\fINULL\fR\fI \fR 8523 .RE 8524 6989 8525 usershare prefix allow list (G) 6990 .RS 3n 6991 This parameter specifies a list of absolute pathnames the root of which are allowed to be exported by user defined share definitions. If the pathname exported doesn't start with one of the strings in this list the user defined share will not be allowed. This allows the Samba administrator to restrict the directories on the system that can be exported by user defined shares. 6992 .sp 6993 If there is a "usershare prefix deny list" and also a "usershare prefix allow list" the deny list is processed first, followed by the allow list, thus leading to the most restrictive interpretation. 6994 .sp 6995 Default: 6996 \fB\fIusershare prefix allow list\fR = NULL \fR 6997 .sp 6998 Example: 6999 \fB\fIusershare prefix allow list\fR = /home /data /space \fR 7000 .RE 7001 .PP 8526 .PP 8527 .RS 4 8528 This parameter specifies a list of absolute pathnames the root of which are allowed to be exported by user defined share definitions\. If the pathname exported doesn\'t start with one of the strings in this list the user defined share will not be allowed\. This allows the Samba administrator to restrict the directories on the system that can be exported by user defined shares\. 8529 .sp 8530 If there is a "usershare prefix deny list" and also a "usershare prefix allow list" the deny list is processed first, followed by the allow list, thus leading to the most restrictive interpretation\. 8531 .sp 8532 Default: 8533 \fI\fIusershare prefix allow list\fR\fR\fI = \fR\fINULL\fR\fI \fR 8534 .sp 8535 Example: 8536 \fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI/home /data /space\fR\fI \fR 8537 .RE 8538 7002 8539 usershare prefix deny list (G) 7003 .RS 3n 7004 This parameter specifies a list of absolute pathnames the root of which are NOT allowed to be exported by user defined share definitions. If the pathname exported starts with one of the strings in this list the user defined share will not be allowed. Any pathname not starting with one of these strings will be allowed to be exported as a usershare. This allows the Samba administrator to restrict the directories on the system that can be exported by user defined shares. 7005 .sp 7006 If there is a "usershare prefix deny list" and also a "usershare prefix allow list" the deny list is processed first, followed by the allow list, thus leading to the most restrictive interpretation. 7007 .sp 7008 Default: 7009 \fB\fIusershare prefix deny list\fR = NULL \fR 7010 .sp 7011 Example: 7012 \fB\fIusershare prefix deny list\fR = /etc /dev /private \fR 7013 .RE 7014 .PP 8540 .PP 8541 .RS 4 8542 This parameter specifies a list of absolute pathnames the root of which are NOT allowed to be exported by user defined share definitions\. If the pathname exported starts with one of the strings in this list the user defined share will not be allowed\. Any pathname not starting with one of these strings will be allowed to be exported as a usershare\. This allows the Samba administrator to restrict the directories on the system that can be exported by user defined shares\. 8543 .sp 8544 If there is a "usershare prefix deny list" and also a "usershare prefix allow list" the deny list is processed first, followed by the allow list, thus leading to the most restrictive interpretation\. 8545 .sp 8546 Default: 8547 \fI\fIusershare prefix deny list\fR\fR\fI = \fR\fINULL\fR\fI \fR 8548 .sp 8549 Example: 8550 \fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI/etc /dev /private\fR\fI \fR 8551 .RE 8552 7015 8553 usershare template share (G) 7016 .RS 3n 7017 User defined shares only have limited possible parameters such as path, guest ok etc. This parameter allows usershares to "cloned" from an existing share. If "usershare template share" is set to the name of an existing share, then all usershares created have their defaults set from the parameters set on this share. 7018 .sp 7019 The target share may be set to be invalid for real file sharing by setting the parameter "-valid = False" on the template share definition. This causes it not to be seen as a real exported share but to be able to be used as a template for usershares. 7020 .sp 7021 Default: 7022 \fB\fIusershare template share\fR = NULL \fR 7023 .sp 7024 Example: 7025 \fB\fIusershare template share\fR = template_share \fR 7026 .RE 7027 .PP 8554 .PP 8555 .RS 4 8556 User defined shares only have limited possible parameters such as path, guest ok etc\. This parameter allows usershares to "cloned" from an existing share\. If "usershare template share" is set to the name of an existing share, then all usershares created have their defaults set from the parameters set on this share\. 8557 .sp 8558 The target share may be set to be invalid for real file sharing by setting the parameter "\-valid = False" on the template share definition\. This causes it not to be seen as a real exported share but to be able to be used as a template for usershares\. 8559 .sp 8560 Default: 8561 \fI\fIusershare template share\fR\fR\fI = \fR\fINULL\fR\fI \fR 8562 .sp 8563 Example: 8564 \fI\fIusershare template share\fR\fR\fI = \fR\fItemplate_share\fR\fI \fR 8565 .RE 8566 7028 8567 use sendfile (S) 7029 .RS 3n 8568 .PP 8569 .RS 4 7030 8570 If this parameter is 7031 8571 \fByes\fR, and the 7032 8572 \fBsendfile()\fR 7033 system call is supported by the underlying operating system, then some SMB read calls (mainly ReadAndX and ReadRaw) will use the more efficient sendfile system call for files that are exclusively oplocked . This may make more efficient use of the system CPU's and cause Samba to be faster. Samba automatically turns this off for clients that use protocol levels lower than NT LM 0.12 and when it detects a client is Windows 9x (using sendfile from Linux will cause these clients to fail).7034 .sp 7035 Default: 7036 \f B\fIuse sendfile\fR = false\fR7037 .RE 7038 .PP 8573 system call is supported by the underlying operating system, then some SMB read calls (mainly ReadAndX and ReadRaw) will use the more efficient sendfile system call for files that are exclusively oplocked\. This may make more efficient use of the system CPU\'s and cause Samba to be faster\. Samba automatically turns this off for clients that use protocol levels lower than NT LM 0\.12 and when it detects a client is Windows 9x (using sendfile from Linux will cause these clients to fail)\. 8574 .sp 8575 Default: 8576 \fI\fIuse sendfile\fR\fR\fI = \fR\fIfalse\fR\fI \fR 8577 .RE 8578 7039 8579 use spnego (G) 7040 .RS 3n 7041 This variable controls controls whether samba will try to use Simple and Protected NEGOciation (as specified by rfc2478) with WindowsXP and Windows2000 clients to agree upon an authentication mechanism. 7042 .sp 7043 Unless further issues are discovered with our SPNEGO implementation, there is no reason this should ever be disabled. 7044 .sp 7045 Default: 7046 \fB\fIuse spnego\fR = yes \fR 7047 .RE 7048 .PP 8580 .PP 8581 .RS 4 8582 This variable controls controls whether samba will try to use Simple and Protected NEGOciation (as specified by rfc2478) with WindowsXP and Windows2000 clients to agree upon an authentication mechanism\. 8583 .sp 8584 Unless further issues are discovered with our SPNEGO implementation, there is no reason this should ever be disabled\. 8585 .sp 8586 Default: 8587 \fI\fIuse spnego\fR\fR\fI = \fR\fIyes\fR\fI \fR 8588 .RE 8589 8590 utmp directory (G) 8591 .PP 8592 .RS 4 8593 This parameter is only available if Samba has been configured and compiled with the option 8594 \-\-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 8595 \fI/var/run/utmp\fR 8596 on Linux)\. 8597 .sp 8598 Default: 8599 \fI\fIutmp directory\fR\fR\fI = \fR\fI # Determined automatically\fR\fI \fR 8600 .sp 8601 Example: 8602 \fI\fIutmp directory\fR\fR\fI = \fR\fI/var/run/utmp\fR\fI \fR 8603 .RE 8604 7049 8605 utmp (G) 7050 .RS 3n 8606 .PP 8607 .RS 4 7051 8608 This boolean parameter is only available if Samba has been configured and compiled with the option 7052 --with-utmp. If set to8609 \-\-with\-utmp\. If set to 7053 8610 \fByes\fR 7054 then Samba will attempt to add utmp or utmpx records (depending on the UNIX system) whenever a connection is made to a Samba server. Sites may use this to record the user connecting to a Samba share. 7055 .sp 7056 Due to the requirements of the utmp record, we are required to create a unique identifier for the incoming user. Enabling this option creates an n^2 algorithm to find this number. This may impede performance on large installations. 7057 .sp 7058 Default: 7059 \fB\fIutmp\fR = no \fR 7060 .RE 7061 .PP 7062 utmp directory (G) 7063 .RS 3n 7064 This parameter is only available if Samba has been configured and compiled with the option 7065 --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 7066 \fI/var/run/utmp\fR 7067 on Linux). 7068 .sp 7069 Default: 7070 \fB\fIutmp directory\fR = # Determined automatically \fR 7071 .sp 7072 Example: 7073 \fB\fIutmp directory\fR = /var/run/utmp \fR 7074 .RE 7075 .PP 7076 -valid (S) 7077 .RS 3n 7078 This parameter indicates whether a share is valid and thus can be used. When this parameter is set to false, the share will be in no way visible nor accessible. 7079 .sp 7080 This option should not be used by regular users but might be of help to developers. Samba uses this option internally to mark shares as deleted. 7081 .sp 7082 Default: 7083 \fB\fI-valid\fR = yes \fR 7084 .RE 7085 .PP 8611 then Samba will attempt to add utmp or utmpx records (depending on the UNIX system) whenever a connection is made to a Samba server\. Sites may use this to record the user connecting to a Samba share\. 8612 .sp 8613 Due to the requirements of the utmp record, we are required to create a unique identifier for the incoming user\. Enabling this option creates an n^2 algorithm to find this number\. This may impede performance on large installations\. 8614 .sp 8615 Default: 8616 \fI\fIutmp\fR\fR\fI = \fR\fIno\fR\fI \fR 8617 .RE 8618 7086 8619 valid users (S) 7087 .RS 3n 7088 This is a list of users that should be allowed to login to this service. Names starting with '@', '+' and '&' are interpreted using the same rules as described in the 8620 .PP 8621 .RS 4 8622 This is a list of users that should be allowed to login to this service\. Names starting with \'@\', \'+\' and \'&\' are interpreted using the same rules as described in the 7089 8623 \fIinvalid users\fR 7090 parameter .7091 .sp 7092 If this is empty (the default) then any user can login . If a username is in both this list and the8624 parameter\. 8625 .sp 8626 If this is empty (the default) then any user can login\. If a username is in both this list and the 7093 8627 \fIinvalid users\fR 7094 list then access is denied for that user .8628 list then access is denied for that user\. 7095 8629 .sp 7096 8630 The current servicename is substituted for 7097 \fI%S\fR. This is useful in the [homes] section. 7098 .sp 7099 Default: 7100 \fB\fIvalid users\fR = # No valid users list (anyone can login) \fR 7101 .sp 7102 Example: 7103 \fB\fIvalid users\fR = greg, @pcusers \fR 7104 .RE 7105 .PP 8631 \fI%S\fR\. This is useful in the [homes] section\. 8632 .sp 8633 Default: 8634 \fI\fIvalid users\fR\fR\fI = \fR\fI # No valid users list (anyone can login) \fR\fI \fR 8635 .sp 8636 Example: 8637 \fI\fIvalid users\fR\fR\fI = \fR\fIgreg, @pcusers\fR\fI \fR 8638 .RE 8639 8640 \-valid (S) 8641 .PP 8642 .RS 4 8643 This parameter indicates whether a share is valid and thus can be used\. When this parameter is set to false, the share will be in no way visible nor accessible\. 8644 .sp 8645 This option should not be used by regular users but might be of help to developers\. Samba uses this option internally to mark shares as deleted\. 8646 .sp 8647 Default: 8648 \fI\fI\-valid\fR\fR\fI = \fR\fIyes\fR\fI \fR 8649 .RE 8650 7106 8651 veto files (S) 7107 .RS 3n 7108 This is a list of files and directories that are neither visible nor accessible. Each entry in the list must be separated by a '/', which allows spaces to be included in the entry. '*' and '?' can be used to specify multiple files or directories as in DOS wildcards. 8652 .PP 8653 .RS 4 8654 This is a list of files and directories that are neither visible nor accessible\. Each entry in the list must be separated by a \'/\', which allows spaces to be included in the entry\. \'*\' and \'?\' can be used to specify multiple files or directories as in DOS wildcards\. 7109 8655 .sp 7110 8656 Each entry must be a unix path, not a DOS path and must 7111 \f Bnot\fR7112 include the unix directory separator '/'.8657 \fInot\fR 8658 include the unix directory separator \'/\'\. 7113 8659 .sp 7114 8660 Note that the 7115 case sensitive option is applicable in vetoing files. 7116 .sp 7117 One feature of the veto files parameter that it is important to be aware of is Samba's behaviour when trying to delete a directory. If a directory that is to be deleted contains nothing but veto files this deletion will 7118 \fBfail\fR 8661 \fIcase sensitive\fR 8662 option is applicable in vetoing files\. 8663 .sp 8664 One feature of the veto files parameter that it is important to be aware of is Samba\'s behaviour when trying to delete a directory\. If a directory that is to be deleted contains nothing but veto files this deletion will 8665 \fIfail\fR 7119 8666 unless you also set the 7120 delete veto files parameter to 7121 \fIyes\fR. 7122 .sp 7123 Setting this parameter will affect the performance of Samba, as it will be forced to check all files and directories for a match as they are scanned. 8667 \fIdelete veto files\fR 8668 parameter to 8669 \fIyes\fR\. 8670 .sp 8671 Setting this parameter will affect the performance of Samba, as it will be forced to check all files and directories for a match as they are scanned\. 7124 8672 .sp 7125 8673 Examples of use include: 7126 7127 .sp 7128 8674 .sp 8675 .RS 4 7129 8676 .nf 7130 7131 8677 ; Veto any files containing the word Security, 7132 ; any ending in .tmp, and any directory containing the7133 ; word root .7134 veto files = /*Security*/* .tmp/*root*/8678 ; any ending in \.tmp, and any directory containing the 8679 ; word root\. 8680 veto files = /*Security*/*\.tmp/*root*/ 7135 8681 7136 8682 ; Veto the Apple specific files that a NetAtalk server 7137 ; creates. 7138 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ 7139 8683 ; creates\. 8684 veto files = /\.AppleDouble/\.bin/\.AppleDesktop/Network Trash Folder/ 7140 8685 .fi 7141 7142 .sp 7143 Default: 7144 \fB\fIveto files\fR = No files or directories are vetoed. \fR 7145 .RE 7146 .PP 8686 .RE 8687 .sp 8688 .sp 8689 Default: 8690 \fI\fIveto files\fR\fR\fI = \fR\fINo files or directories are vetoed\.\fR\fI \fR 8691 .RE 8692 7147 8693 veto oplock files (S) 7148 .RS 3n 8694 .PP 8695 .RS 4 7149 8696 This parameter is only valid when the 7150 oplocks parameter is turned on for a share. It allows the Samba administrator to selectively turn off the granting of oplocks on selected files that match a wildcarded list, similar to the wildcarded list used in the 7151 veto files parameter. 7152 .sp 7153 You might want to do this on files that you know will be heavily contended for by clients. A good example of this is in the NetBench SMB benchmark program, which causes heavy client contention for files ending in 7154 \fI.SEM\fR. To cause Samba not to grant oplocks on these files you would use the line (either in the [global] section or in the section for the particular NetBench share. 8697 \fIoplocks\fR 8698 parameter is turned on for a share\. It allows the Samba administrator to selectively turn off the granting of oplocks on selected files that match a wildcarded list, similar to the wildcarded list used in the 8699 \fIveto files\fR 8700 parameter\. 8701 .sp 8702 You might want to do this on files that you know will be heavily contended for by clients\. A good example of this is in the NetBench SMB benchmark program, which causes heavy client contention for files ending in 8703 \fI\.SEM\fR\. To cause Samba not to grant oplocks on these files you would use the line (either in the [global] section or in the section for the particular NetBench share\. 7155 8704 .sp 7156 8705 An example of use is: 7157 7158 .sp 7159 8706 .sp 8707 .RS 4 7160 8708 .nf 7161 7162 veto oplock files = /.*SEM/ 7163 8709 veto oplock files = /\.*SEM/ 7164 8710 .fi 7165 7166 .sp 7167 Default: 7168 \fB\fIveto oplock files\fR = # No files are vetoed for oplock grants \fR 7169 .RE 7170 .PP 7171 vfs object 7172 .RS 3n 7173 This parameter is a synonym for vfs objects. 7174 .RE 7175 .PP 8711 .RE 8712 .sp 8713 .sp 8714 Default: 8715 \fI\fIveto oplock files\fR\fR\fI = \fR\fI # No files are vetoed for oplock grants\fR\fI \fR 8716 .RE 8717 vfs object.PP 8718 .RS 4 8719 This parameter is a synonym for 8720 vfs objects\. 8721 .RE 8722 7176 8723 vfs objects (S) 7177 .RS 3n 7178 This parameter specifies the backend names which are used for Samba VFS I/O operations. By default, normal disk I/O operations are used but these can be overloaded with one or more VFS objects. 7179 .sp 7180 Default: 7181 \fB\fIvfs objects\fR = \fR 7182 .sp 7183 Example: 7184 \fB\fIvfs objects\fR = extd_audit recycle \fR 7185 .RE 7186 .PP 8724 .PP 8725 .RS 4 8726 This parameter specifies the backend names which are used for Samba VFS I/O operations\. By default, normal disk I/O operations are used but these can be overloaded with one or more VFS objects\. 8727 .sp 8728 Default: 8729 \fI\fIvfs objects\fR\fR\fI = \fR\fI\fR\fI \fR 8730 .sp 8731 Example: 8732 \fI\fIvfs objects\fR\fR\fI = \fR\fIextd_audit recycle\fR\fI \fR 8733 .RE 8734 7187 8735 volume (S) 7188 .RS 3n 7189 This allows you to override the volume label returned for a share. Useful for CDROMs with installation programs that insist on a particular volume label. 7190 .sp 7191 Default: 7192 \fB\fIvolume\fR = # the name of the share \fR 7193 .RE 7194 .PP 8736 .PP 8737 .RS 4 8738 This allows you to override the volume label returned for a share\. Useful for CDROMs with installation programs that insist on a particular volume label\. 8739 .sp 8740 Default: 8741 \fI\fIvolume\fR\fR\fI = \fR\fI # the name of the share\fR\fI \fR 8742 .RE 8743 7195 8744 wide links (S) 7196 .RS 3n 7197 This parameter controls whether or not links in the UNIX file system may be followed by the server. Links that point to areas within the directory tree exported by the server are always allowed; this parameter controls access only to areas that are outside the directory tree being exported. 7198 .sp 7199 Note that setting this parameter can have a negative effect on your server performance due to the extra system calls that Samba has to do in order to perform the link checks. 7200 .sp 7201 Default: 7202 \fB\fIwide links\fR = yes \fR 7203 .RE 7204 .PP 8745 .PP 8746 .RS 4 8747 This parameter controls whether or not links in the UNIX file system may be followed by the server\. Links that point to areas within the directory tree exported by the server are always allowed; this parameter controls access only to areas that are outside the directory tree being exported\. 8748 .sp 8749 Note that setting this parameter can have a negative effect on your server performance due to the extra system calls that Samba has to do in order to perform the link checks\. 8750 .sp 8751 Default: 8752 \fI\fIwide links\fR\fR\fI = \fR\fIyes\fR\fI \fR 8753 .RE 8754 7205 8755 winbind cache time (G) 7206 .RS 3n 8756 .PP 8757 .RS 4 7207 8758 This parameter specifies the number of seconds the 7208 8759 \fBwinbindd\fR(8) 7209 daemon will cache user and group information before querying a Windows NT server again .8760 daemon will cache user and group information before querying a Windows NT server again\. 7210 8761 .sp 7211 8762 This does not apply to authentication requests, these are always evaluated in real time unless the 7212 winbind offline logon option has been enabled. 7213 .sp 7214 Default: 7215 \fB\fIwinbind cache time\fR = 300 \fR 7216 .RE 7217 .PP 8763 \fIwinbind offline logon\fR 8764 option has been enabled\. 8765 .sp 8766 Default: 8767 \fI\fIwinbind cache time\fR\fR\fI = \fR\fI300\fR\fI \fR 8768 .RE 8769 7218 8770 winbind enum groups (G) 7219 .RS 3n 8771 .PP 8772 .RS 4 7220 8773 On large installations using 7221 8774 \fBwinbindd\fR(8) … … 7225 8778 and 7226 8779 endgrent() 7227 group of system calls . If the8780 group of system calls\. If the 7228 8781 \fIwinbind enum groups\fR 7229 8782 parameter is 7230 8783 \fBno\fR, calls to the 7231 8784 getgrent() 7232 system call will not return any data .8785 system call will not return any data\. 7233 8786 .sp 7234 8787 .it 1 an-trap … … 7236 8789 .nr an-break-flag 1 7237 8790 .br 7238 \fBWarning\fR 7239 Turning off group enumeration may cause some programs to behave oddly. 7240 Default: 7241 \fB\fIwinbind enum groups\fR = no \fR 7242 .RE 7243 .PP 8791 Warning 8792 Turning off group enumeration may cause some programs to behave oddly\. 8793 8794 Default: 8795 \fI\fIwinbind enum groups\fR\fR\fI = \fR\fIno\fR\fI \fR 8796 .RE 8797 7244 8798 winbind enum users (G) 7245 .RS 3n 8799 .PP 8800 .RS 4 7246 8801 On large installations using 7247 8802 \fBwinbindd\fR(8) … … 7251 8806 and 7252 8807 endpwent() 7253 group of system calls . If the8808 group of system calls\. If the 7254 8809 \fIwinbind enum users\fR 7255 8810 parameter is 7256 8811 \fBno\fR, calls to the 7257 8812 getpwent 7258 system call will not return any data .8813 system call will not return any data\. 7259 8814 .sp 7260 8815 .it 1 an-trap … … 7262 8817 .nr an-break-flag 1 7263 8818 .br 7264 \fBWarning\fR 7265 Turning off user enumeration may cause some programs to behave oddly. For example, the finger program relies on having access to the full user list when searching for matching usernames. 7266 Default: 7267 \fB\fIwinbind enum users\fR = no \fR 7268 .RE 7269 .PP 7270 winbind expand groups (G) 7271 .RS 3n 7272 This option controls the maximum depth that winbindd will traverse when flattening nested group memberships of Windows domain groups. This is different from the 7273 winbind nested groups option which implements the Windows NT4 model of local group nesting. The "winbind expand groups" parameter specifically applies to the membership of domain groups. 7274 .sp 7275 Be aware that a high value for this parameter can result in system slowdown as the main parent winbindd daemon must perform the group unrolling and will be unable to answer incoming NSS or authentication requests during this time. 7276 .sp 7277 Default: 7278 \fB\fIwinbind expand groups\fR = 1 \fR 7279 .RE 7280 .PP 8819 Warning 8820 Turning off user enumeration may cause some programs to behave oddly\. For example, the finger program relies on having access to the full user list when searching for matching usernames\. 8821 8822 Default: 8823 \fI\fIwinbind enum users\fR\fR\fI = \fR\fIno\fR\fI \fR 8824 .RE 8825 7281 8826 winbind nested groups (G) 7282 .RS 3n 7283 If set to yes, this parameter activates the support for nested groups. Nested groups are also called local groups or aliases. They work like their counterparts in Windows: Nested groups are defined locally on any machine (they are shared between DC's through their SAM) and can contain users and global groups from any trusted SAM. To be able to use nested groups, you need to run nss_winbind. 7284 .sp 7285 Default: 7286 \fB\fIwinbind nested groups\fR = yes \fR 7287 .RE 7288 .PP 8827 .PP 8828 .RS 4 8829 If set to yes, this parameter activates the support for nested groups\. Nested groups are also called local groups or aliases\. They work like their counterparts in Windows: Nested groups are defined locally on any machine (they are shared between DC\'s through their SAM) and can contain users and global groups from any trusted SAM\. To be able to use nested groups, you need to run nss_winbind\. 8830 .sp 8831 Default: 8832 \fI\fIwinbind nested groups\fR\fR\fI = \fR\fIyes\fR\fI \fR 8833 .RE 8834 7289 8835 winbind normalize names (G) 7290 .RS 3n 7291 This parameter controls whether winbindd will replace whitespace in user and group names with an underscore (_) character. For example, whether the name "Space Kadet" should be replaced with the string "space_kadet". Frequently Unix shell scripts will have difficulty with usernames contains whitespace due to the default field separator in the shell. Do not enable this option if the underscore character is used in account names within your domain 7292 .sp 7293 Default: 7294 \fB\fIwinbind normalize names\fR = no \fR 7295 .sp 7296 Example: 7297 \fB\fIwinbind normalize names\fR = yes \fR 7298 .RE 7299 .PP 8836 .PP 8837 .RS 4 8838 This parameter controls whether winbindd will replace whitespace in user and group names with an underscore (_) character\. For example, whether the name "Space Kadet" should be replaced with the string "space_kadet"\. Frequently Unix shell scripts will have difficulty with usernames contains whitespace due to the default field separator in the shell\. Do not enable this option if the underscore character is used in account names within your domain 8839 .sp 8840 Default: 8841 \fI\fIwinbind normalize names\fR\fR\fI = \fR\fIno\fR\fI \fR 8842 .sp 8843 Example: 8844 \fI\fIwinbind normalize names\fR\fR\fI = \fR\fIyes\fR\fI \fR 8845 .RE 8846 7300 8847 winbind nss info (G) 7301 .RS 3n 7302 This parameter is designed to control how Winbind retrieves Name Service Information to construct a user's home directory and login shell. Currently the following settings are available: 7303 .RS 3n 7304 .TP 3n 7305 \(bu 8848 .PP 8849 .RS 4 8850 This parameter is designed to control how Winbind retrieves Name Service Information to construct a user\'s home directory and login shell\. Currently the following settings are available: 8851 .sp 8852 .RS 4 8853 .ie n \{\ 8854 \h'-04'\(bu\h'+03'\c 8855 .\} 8856 .el \{\ 8857 .sp -1 8858 .IP \(bu 2.3 8859 .\} 7306 8860 \fItemplate\fR 7307 - The default, using the parameters of8861 \- The default, using the parameters of 7308 8862 \fItemplate shell\fR 7309 8863 and 7310 8864 \fItemplate homedir\fR) 7311 .TP 3n 7312 \(bu 7313 \fIsfu\fR 7314 - 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 8865 .RE 8866 .sp 8867 .RS 4 8868 .ie n \{\ 8869 \h'-04'\(bu\h'+03'\c 8870 .\} 8871 .el \{\ 8872 .sp -1 8873 .IP \(bu 2.3 8874 .\} 8875 \fI<sfu | rfc2307 >\fR 8876 \- 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 7315 8877 \fIidmap backend\fR 7316 = idmap_ad as well. 7317 .RE 7318 .IP "" 3n 7319 7320 .sp 7321 Default: 7322 \fB\fIwinbind nss info\fR = template \fR 7323 .sp 7324 Example: 7325 \fB\fIwinbind nss info\fR = template sfu \fR 7326 .RE 7327 .PP 8878 = ad or 8879 \fIidmap config DOMAIN:backend\fR 8880 = ad as well\. 8881 .sp 8882 .RE 8883 .sp 8884 Default: 8885 \fI\fIwinbind nss info\fR\fR\fI = \fR\fItemplate\fR\fI \fR 8886 .sp 8887 Example: 8888 \fI\fIwinbind nss info\fR\fR\fI = \fR\fItemplate sfu\fR\fI \fR 8889 .RE 8890 7328 8891 winbind offline logon (G) 7329 .RS 3n 8892 .PP 8893 .RS 4 7330 8894 This parameter is designed to control whether Winbind should allow to login with the 7331 8895 \fIpam_winbind\fR 7332 module using Cached Credentials . If enabled, winbindd will store user credentials from successful logins encrypted in a local cache.7333 .sp 7334 Default: 7335 \f B\fIwinbind offline logon\fR = false\fR7336 .sp 7337 Example: 7338 \f B\fIwinbind offline logon\fR = true\fR7339 .RE 7340 .PP 8896 module using Cached Credentials\. If enabled, winbindd will store user credentials from successful logins encrypted in a local cache\. 8897 .sp 8898 Default: 8899 \fI\fIwinbind offline logon\fR\fR\fI = \fR\fIfalse\fR\fI \fR 8900 .sp 8901 Example: 8902 \fI\fIwinbind offline logon\fR\fR\fI = \fR\fItrue\fR\fI \fR 8903 .RE 8904 7341 8905 winbind refresh tickets (G) 7342 .RS 3n 8906 .PP 8907 .RS 4 7343 8908 This parameter is designed to control whether Winbind should refresh Kerberos Tickets retrieved using the 7344 8909 \fIpam_winbind\fR 7345 module. 7346 .sp 7347 Default: 7348 \fB\fIwinbind refresh tickets\fR = false \fR 7349 .sp 7350 Example: 7351 \fB\fIwinbind refresh tickets\fR = true \fR 7352 .RE 7353 .PP 7354 winbind rpc only (G) 7355 .RS 3n 7356 Setting this parameter to 7357 yes 7358 forces winbindd to use RPC instead of LDAP to retrieve information from Domain Controllers. 7359 .sp 7360 Default: 7361 \fB\fIwinbind rpc only\fR = no \fR 7362 .RE 7363 .PP 8910 module\. 8911 .sp 8912 Default: 8913 \fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fIfalse\fR\fI \fR 8914 .sp 8915 Example: 8916 \fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fItrue\fR\fI \fR 8917 .RE 8918 7364 8919 winbind separator (G) 7365 .RS 3n 8920 .PP 8921 .RS 4 7366 8922 This parameter allows an admin to define the character used when listing a username of the form of 7367 \fIDOMAIN \fR\ \fIuser\fR. This parameter is only applicable when using the7368 \fIpam_winbind .so\fR8923 \fIDOMAIN \fR\e\fIuser\fR\. This parameter is only applicable when using the 8924 \fIpam_winbind\.so\fR 7369 8925 and 7370 \fInss_winbind .so\fR7371 modules for UNIX services .7372 .sp 7373 Please note that setting this parameter to + causes problems with group membership at least on glibc systems, as the character + is used as a special character for NIS in /etc/group .7374 .sp 7375 Default: 7376 \f B\fIwinbind separator\fR = '\\'\fR7377 .sp 7378 Example: 7379 \f B\fIwinbind separator\fR = +\fR7380 .RE 7381 .PP 8926 \fInss_winbind\.so\fR 8927 modules for UNIX services\. 8928 .sp 8929 Please note that setting this parameter to + causes problems with group membership at least on glibc systems, as the character + is used as a special character for NIS in /etc/group\. 8930 .sp 8931 Default: 8932 \fI\fIwinbind separator\fR\fR\fI = \fR\fI\'\e\'\fR\fI \fR 8933 .sp 8934 Example: 8935 \fI\fIwinbind separator\fR\fR\fI = \fR\fI+\fR\fI \fR 8936 .RE 8937 7382 8938 winbind trusted domains only (G) 7383 .RS 3n 7384 This parameter is designed to allow Samba servers that are members of a Samba controlled domain to use UNIX accounts distributed via NIS, rsync, or LDAP as the uid's for winbindd users in the hosts primary domain. Therefore, the user 7385 DOMAIN\\user1 7386 would be mapped to the account user1 in /etc/passwd instead of allocating a new uid for him or her. 7387 .sp 7388 This parameter is now deprecated in favor of the newer idmap_nss backend. Refer to the 7389 idmap domains smb.conf option and the 8939 .PP 8940 .RS 4 8941 This parameter is designed to allow Samba servers that are members of a Samba controlled domain to use UNIX accounts distributed via NIS, rsync, or LDAP as the uid\'s for winbindd users in the hosts primary domain\. Therefore, the user 8942 DOMAIN\euser1 8943 would be mapped to the account user1 in /etc/passwd instead of allocating a new uid for him or her\. 8944 .sp 8945 This parameter is now deprecated in favor of the newer idmap_nss backend\. Refer to the 8946 \fIidmap domains\fR 8947 smb\.conf option and the 7390 8948 \fBidmap_nss\fR(8) 7391 man page for more information .7392 .sp 7393 Default: 7394 \f B\fIwinbind trusted domains only\fR = no\fR7395 .RE 7396 .PP 8949 man page for more information\. 8950 .sp 8951 Default: 8952 \fI\fIwinbind trusted domains only\fR\fR\fI = \fR\fIno\fR\fI \fR 8953 .RE 8954 7397 8955 winbind use default domain (G) 7398 .RS 3n 8956 .PP 8957 .RS 4 7399 8958 This parameter specifies whether the 7400 8959 \fBwinbindd\fR(8) 7401 daemon should operate on users without domain component in their username . Users without a domain component are treated as is part of the winbindd server's own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail function in a way much closer to the way they would in a native unix system.7402 .sp 7403 Default: 7404 \f B\fIwinbind use default domain\fR = no\fR7405 .sp 7406 Example: 7407 \f B\fIwinbind use default domain\fR = yes\fR7408 .RE 7409 .PP 8960 daemon should operate on users without domain component in their username\. Users without a domain component are treated as is part of the winbindd server\'s own domain\. While this does not benifit Windows users, it makes SSH, FTP and e\-mail function in a way much closer to the way they would in a native unix system\. 8961 .sp 8962 Default: 8963 \fI\fIwinbind use default domain\fR\fR\fI = \fR\fIno\fR\fI \fR 8964 .sp 8965 Example: 8966 \fI\fIwinbind use default domain\fR\fR\fI = \fR\fIyes\fR\fI \fR 8967 .RE 8968 7410 8969 wins hook (G) 7411 .RS 3n 7412 When Samba is running as a WINS server this allows you to call an external program for all changes to the WINS database. The primary use for this option is to allow the dynamic update of external name resolution databases such as dynamic DNS. 8970 .PP 8971 .RS 4 8972 When Samba is running as a WINS server this allows you to call an external program for all changes to the WINS database\. The primary use for this option is to allow the dynamic update of external name resolution databases such as dynamic DNS\. 7413 8973 .sp 7414 8974 The wins hook parameter specifies the name of a script or executable that will be called as follows: 7415 8975 .sp 7416 8976 wins_hook operation name nametype ttl IP_list 7417 .RS 3n 7418 .TP 3n 7419 \(bu 7420 The first argument is the operation and is one of "add", "delete", or "refresh". In most cases the operation can be ignored as the rest of the parameters provide sufficient information. Note that "refresh" may sometimes be called when the name has not previously been added, in that case it should be treated as an add. 7421 .TP 3n 7422 \(bu 7423 The second argument is the NetBIOS name. If the name is not a legal name then the wins hook is not called. Legal names contain only letters, digits, hyphens, underscores and periods. 7424 .TP 3n 7425 \(bu 7426 The third argument is the NetBIOS name type as a 2 digit hexadecimal number. 7427 .TP 3n 7428 \(bu 7429 The fourth argument is the TTL (time to live) for the name in seconds. 7430 .TP 3n 7431 \(bu 7432 The fifth and subsequent arguments are the IP addresses currently registered for that name. If this list is empty then the name should be deleted. 7433 .RE 7434 .IP "" 3n 8977 .sp 8978 .RS 4 8979 .ie n \{\ 8980 \h'-04'\(bu\h'+03'\c 8981 .\} 8982 .el \{\ 8983 .sp -1 8984 .IP \(bu 2.3 8985 .\} 8986 The first argument is the operation and is one of "add", "delete", or "refresh"\. In most cases the operation can be ignored as the rest of the parameters provide sufficient information\. Note that "refresh" may sometimes be called when the name has not previously been added, in that case it should be treated as an add\. 8987 .RE 8988 .sp 8989 .RS 4 8990 .ie n \{\ 8991 \h'-04'\(bu\h'+03'\c 8992 .\} 8993 .el \{\ 8994 .sp -1 8995 .IP \(bu 2.3 8996 .\} 8997 The second argument is the NetBIOS name\. If the name is not a legal name then the wins hook is not called\. Legal names contain only letters, digits, hyphens, underscores and periods\. 8998 .RE 8999 .sp 9000 .RS 4 9001 .ie n \{\ 9002 \h'-04'\(bu\h'+03'\c 9003 .\} 9004 .el \{\ 9005 .sp -1 9006 .IP \(bu 2.3 9007 .\} 9008 The third argument is the NetBIOS name type as a 2 digit hexadecimal number\. 9009 .RE 9010 .sp 9011 .RS 4 9012 .ie n \{\ 9013 \h'-04'\(bu\h'+03'\c 9014 .\} 9015 .el \{\ 9016 .sp -1 9017 .IP \(bu 2.3 9018 .\} 9019 The fourth argument is the TTL (time to live) for the name in seconds\. 9020 .RE 9021 .sp 9022 .RS 4 9023 .ie n \{\ 9024 \h'-04'\(bu\h'+03'\c 9025 .\} 9026 .el \{\ 9027 .sp -1 9028 .IP \(bu 2.3 9029 .\} 9030 The fifth and subsequent arguments are the IP addresses currently registered for that name\. If this list is empty then the name should be deleted\. 9031 .sp 9032 .RE 7435 9033 An example script that calls the BIND dynamic DNS update program 7436 9034 nsupdate 7437 is provided in the examples directory of the Samba source code .7438 .sp 7439 \f BNo default\fR7440 .RE 7441 .PP 9035 is provided in the examples directory of the Samba source code\. 9036 .sp 9037 \fINo default\fR 9038 .RE 9039 7442 9040 wins proxy (G) 7443 .RS 3n 9041 .PP 9042 .RS 4 7444 9043 This is a boolean that controls if 7445 9044 \fBnmbd\fR(8) 7446 will respond to broadcast name queries on behalf of other hosts . You may need to set this to9045 will respond to broadcast name queries on behalf of other hosts\. You may need to set this to 7447 9046 \fByes\fR 7448 for some older clients .7449 .sp 7450 Default: 7451 \f B\fIwins proxy\fR = no\fR7452 .RE 7453 .PP 9047 for some older clients\. 9048 .sp 9049 Default: 9050 \fI\fIwins proxy\fR\fR\fI = \fR\fIno\fR\fI \fR 9051 .RE 9052 7454 9053 wins server (G) 7455 .RS 3n 9054 .PP 9055 .RS 4 7456 9056 This specifies the IP address (or DNS name: IP address for preference) of the WINS server that 7457 9057 \fBnmbd\fR(8) 7458 should register with . If you have a WINS server on your network then you should set this to the WINS server's IP.7459 .sp 7460 You should point this at your WINS server if you have a multi -subnetted network.7461 .sp 7462 If you want to work in multiple namespaces, you can give every wins server a 'tag'. For each tag, only one (working) server will be queried for a name. The tag should be separated from the ip address by a colon.9058 should register with\. If you have a WINS server on your network then you should set this to the WINS server\'s IP\. 9059 .sp 9060 You should point this at your WINS server if you have a multi\-subnetted network\. 9061 .sp 9062 If you want to work in multiple namespaces, you can give every wins server a \'tag\'\. For each tag, only one (working) server will be queried for a name\. The tag should be separated from the ip address by a colon\. 7463 9063 .sp 7464 9064 .it 1 an-trap … … 7466 9066 .nr an-break-flag 1 7467 9067 .br 7468 \fBNote\fR 7469 You need to set up Samba to point to a WINS server if you have multiple subnets and wish cross-subnet browsing to work correctly. 7470 See the chapter in the Samba3-HOWTO on Network Browsing. 7471 .sp 7472 Default: 7473 \fB\fIwins server\fR = \fR 7474 .sp 7475 Example: 7476 \fB\fIwins server\fR = mary:192.9.200.1 fred:192.168.3.199 mary:192.168.2.61 # For this example when querying a certain name, 192.19.200.1 will be asked first and if that doesn't respond 192.168.2.61. If either of those doesn't know the name 192.168.3.199 will be queried. \fR 7477 .sp 7478 Example: 7479 \fB\fIwins server\fR = 192.9.200.1 192.168.2.61 \fR 7480 .RE 7481 .PP 9068 Note 9069 You need to set up Samba to point to a WINS server if you have multiple subnets and wish cross\-subnet browsing to work correctly\. 9070 9071 See the chapter in the Samba3\-HOWTO on Network Browsing\. 9072 .sp 9073 Default: 9074 \fI\fIwins server\fR\fR\fI = \fR\fI\fR\fI \fR 9075 .sp 9076 Example: 9077 \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 9078 .sp 9079 Example: 9080 \fI\fIwins server\fR\fR\fI = \fR\fI192\.9\.200\.1 192\.168\.2\.61\fR\fI \fR 9081 .RE 9082 7482 9083 wins support (G) 7483 .RS 3n 9084 .PP 9085 .RS 4 7484 9086 This boolean controls if the 7485 9087 \fBnmbd\fR(8) 7486 process in Samba will act as a WINS server . You should not set this to9088 process in Samba will act as a WINS server\. You should not set this to 7487 9089 \fByes\fR 7488 unless you have a multi -subnetted network and you wish a particular9090 unless you have a multi\-subnetted network and you wish a particular 7489 9091 nmbd 7490 to be your WINS server . Note that you should7491 \f BNEVER\fR9092 to be your WINS server\. Note that you should 9093 \fINEVER\fR 7492 9094 set this to 7493 9095 \fByes\fR 7494 on more than one machine in your network .7495 .sp 7496 Default: 7497 \f B\fIwins support\fR = no\fR7498 .RE 7499 .PP 9096 on more than one machine in your network\. 9097 .sp 9098 Default: 9099 \fI\fIwins support\fR\fR\fI = \fR\fIno\fR\fI \fR 9100 .RE 9101 7500 9102 workgroup (G) 7501 .RS 3n 7502 This controls what workgroup your server will appear to be in when queried by clients. Note that this parameter also controls the Domain name used with the 7503 security = domain setting. 7504 .sp 7505 Default: 7506 \fB\fIworkgroup\fR = WORKGROUP \fR 7507 .sp 7508 Example: 7509 \fB\fIworkgroup\fR = MYGROUP \fR 7510 .RE 7511 .PP 7512 writable 7513 .RS 3n 7514 This parameter is a synonym for writeable. 7515 .RE 7516 .PP 9103 .PP 9104 .RS 4 9105 This controls what workgroup your server will appear to be in when queried by clients\. Note that this parameter also controls the Domain name used with the 9106 \fIsecurity = domain\fR 9107 setting\. 9108 .sp 9109 Default: 9110 \fI\fIworkgroup\fR\fR\fI = \fR\fIWORKGROUP\fR\fI \fR 9111 .sp 9112 Example: 9113 \fI\fIworkgroup\fR\fR\fI = \fR\fIMYGROUP\fR\fI \fR 9114 .RE 9115 writable.PP 9116 .RS 4 9117 This parameter is a synonym for 9118 writeable\. 9119 .RE 9120 7517 9121 writeable (S) 7518 .RS 3n 9122 .PP 9123 .RS 4 7519 9124 Inverted synonym for 7520 read only.7521 .sp 7522 \f BNo default\fR7523 .RE 7524 .PP 9125 \fIread only\fR\. 9126 .sp 9127 \fINo default\fR 9128 .RE 9129 7525 9130 write cache size (S) 7526 .RS 3n 7527 If this integer parameter is set to non-zero value, Samba will create an in-memory cache for each oplocked file (it does 7528 \fBnot\fR 7529 do this for non-oplocked files). All writes that the client does not request to be flushed directly to disk will be stored in this cache if possible. The cache is flushed onto disk when a write comes in whose offset would not fit into the cache or when the file is closed by the client. Reads for the file are also served from this cache if the data is stored within it. 7530 .sp 7531 This cache allows Samba to batch client writes into a more efficient write size for RAID disks (i.e. writes may be tuned to be the RAID stripe size) and can improve performance on systems where the disk subsystem is a bottleneck but there is free memory for userspace programs. 7532 .sp 7533 The integer parameter specifies the size of this cache (per oplocked file) in bytes. 7534 .sp 7535 Default: 7536 \fB\fIwrite cache size\fR = 0 \fR 7537 .sp 7538 Example: 7539 \fB\fIwrite cache size\fR = 262144 # for a 256k cache size per file \fR 7540 .RE 7541 .PP 9131 .PP 9132 .RS 4 9133 If this integer parameter is set to non\-zero value, Samba will create an in\-memory cache for each oplocked file (it does 9134 \fInot\fR 9135 do this for non\-oplocked files)\. All writes that the client does not request to be flushed directly to disk will be stored in this cache if possible\. The cache is flushed onto disk when a write comes in whose offset would not fit into the cache or when the file is closed by the client\. Reads for the file are also served from this cache if the data is stored within it\. 9136 .sp 9137 This cache allows Samba to batch client writes into a more efficient write size for RAID disks (i\.e\. writes may be tuned to be the RAID stripe size) and can improve performance on systems where the disk subsystem is a bottleneck but there is free memory for userspace programs\. 9138 .sp 9139 The integer parameter specifies the size of this cache (per oplocked file) in bytes\. 9140 .sp 9141 Default: 9142 \fI\fIwrite cache size\fR\fR\fI = \fR\fI0\fR\fI \fR 9143 .sp 9144 Example: 9145 \fI\fIwrite cache size\fR\fR\fI = \fR\fI262144 # for a 256k cache size per file\fR\fI \fR 9146 .RE 9147 7542 9148 write list (S) 7543 .RS 3n 7544 This is a list of users that are given read-write access to a service. If the connecting user is in this list then they will be given write access, no matter what the 7545 read only option is set to. The list can include group names using the @group syntax. 7546 .sp 7547 Note that if a user is in both the read list and the write list then they will be given write access. 9149 .PP 9150 .RS 4 9151 This is a list of users that are given read\-write access to a service\. If the connecting user is in this list then they will be given write access, no matter what the 9152 \fIread only\fR 9153 option is set to\. The list can include group names using the @group syntax\. 9154 .sp 9155 Note that if a user is in both the read list and the write list then they will be given write access\. 7548 9156 .sp 7549 9157 By design, this parameter will not work with the 7550 security = share in Samba 3.0. 7551 .sp 7552 Default: 7553 \fB\fIwrite list\fR = \fR 7554 .sp 7555 Example: 7556 \fB\fIwrite list\fR = admin, root, @staff \fR 7557 .RE 7558 .PP 9158 \fIsecurity = share\fR 9159 in Samba 3\.0\. 9160 .sp 9161 Default: 9162 \fI\fIwrite list\fR\fR\fI = \fR\fI\fR\fI \fR 9163 .sp 9164 Example: 9165 \fI\fIwrite list\fR\fR\fI = \fR\fIadmin, root, @staff\fR\fI \fR 9166 .RE 9167 7559 9168 write raw (G) 7560 .RS 3n 7561 This parameter controls whether or not the server will support raw write SMB's when transferring data from clients. You should never need to change this parameter. 7562 .sp 7563 Default: 7564 \fB\fIwrite raw\fR = yes \fR 7565 .RE 7566 .PP 9169 .PP 9170 .RS 4 9171 This parameter controls whether or not the server will support raw write SMB\'s when transferring data from clients\. You should never need to change this parameter\. 9172 .sp 9173 Default: 9174 \fI\fIwrite raw\fR\fR\fI = \fR\fIyes\fR\fI \fR 9175 .RE 9176 7567 9177 wtmp directory (G) 7568 .RS 3n 9178 .PP 9179 .RS 4 7569 9180 This parameter is only available if Samba has been configured and compiled with the option 7570 --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.9181 \-\-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\. 7571 9182 .sp 7572 9183 By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually 7573 9184 \fI/var/run/wtmp\fR 7574 on Linux) .7575 .sp 7576 Default: 7577 \f B\fIwtmp directory\fR =\fR7578 .sp 7579 Example: 7580 \f B\fIwtmp directory\fR = /var/log/wtmp\fR9185 on Linux)\. 9186 .sp 9187 Default: 9188 \fI\fIwtmp directory\fR\fR\fI = \fR\fI\fR\fI \fR 9189 .sp 9190 Example: 9191 \fI\fIwtmp directory\fR\fR\fI = \fR\fI/var/log/wtmp\fR\fI \fR 7581 9192 .RE 7582 9193 .SH "WARNINGS" 7583 9194 .PP 7584 Although the configuration file permits service names to contain spaces, your client software may not . Spaces will be ignored in comparisons anyway, so it shouldn't be a problem - but be aware of the possibility.7585 .PP 7586 On a similar note, many clients - especially DOS clients - limit service names to eight characters.9195 Although the configuration file permits service names to contain spaces, your client software may not\. Spaces will be ignored in comparisons anyway, so it shouldn\'t be a problem \- but be aware of the possibility\. 9196 .PP 9197 On a similar note, many clients \- especially DOS clients \- limit service names to eight characters\. 7587 9198 \fBsmbd\fR(8) 7588 has no such limitation, but attempts to connect from such clients will fail if they truncate the service names . For this reason you should probably keep your service names down to eight characters in length.9199 has no such limitation, but attempts to connect from such clients will fail if they truncate the service names\. For this reason you should probably keep your service names down to eight characters in length\. 7589 9200 .PP 7590 9201 Use of the … … 7592 9203 and 7593 9204 [printers] 7594 special sections make life for an administrator easy, but the various combinations of default attributes can be tricky . Take extreme care when designing these sections. In particular, ensure that the permissions on spool directories are correct.9205 special sections make life for an administrator easy, but the various combinations of default attributes can be tricky\. Take extreme care when designing these sections\. In particular, ensure that the permissions on spool directories are correct\. 7595 9206 .SH "VERSION" 7596 9207 .PP 7597 This man page is correct for version 3 .0 of the Samba suite.9208 This man page is correct for version 3\.0 of the Samba suite\. 7598 9209 .SH "SEE ALSO" 7599 9210 .PP … … 7607 9218 \fBnmblookup\fR(1), 7608 9219 \fBtestparm\fR(1), 7609 \fBtestprns\fR(1) .9220 \fBtestprns\fR(1)\. 7610 9221 .SH "AUTHOR" 7611 9222 .PP 7612 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 7613 .PP 7614 The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 7615 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 7616 9223 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 9224 .PP 9225 The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 9226 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/smbcacls.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBCACLS" 1 "" "" "" 1 .\" Title: smbcacls 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBCACLS" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbcacls - Set or get ACLs on an NT file or directory names 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 smbcacls {//server/share} {filename} [ -D acls] [-M acls] [-a acls] [-S acls] [-C name] [-G name] [--numeric] [-t] [-U username] [-h] [-d]17 smbcacls {//server/share} {filename} [\-D\ acls] [\-M\ acls] [\-a\ acls] [\-S\ acls] [\-C\ name] [\-G\ name] [\-\-numeric] [\-t] [\-U\ username] [\-h] [\-d] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The 33 25 smbcacls 34 program manipulates NT Access Control Lists (ACLs) on SMB file shares .26 program manipulates NT Access Control Lists (ACLs) on SMB file shares\. 35 27 .SH "OPTIONS" 36 28 .PP 37 29 The following options are available to the 38 30 smbcacls 39 program . The format of ACLs is described in the section ACL FORMAT40 .PP 41 -a acls42 .RS 3n43 Add the ACLs specified to the ACL list . Existing access control entries are unchanged.44 .RE 45 .PP 46 -M acls47 .RS 3n48 Modify the mask value (permissions) for the ACLs specified on the command line . An error will be printed for each ACL specified that was not already present in the ACL list49 .RE 50 .PP 51 -D acls52 .RS 3n53 Delete any ACLs specified on the command line . An error will be printed for each ACL specified that was not already present in the ACL list.54 .RE 55 .PP 56 -S acls57 .RS 3n58 This command sets the ACLs on the file with only the ones specified on the command line . All other ACLs are erased. Note that the ACL specified must contain at least a revision, type, owner and group for the call to succeed.59 .RE 60 .PP 61 -U username62 .RS 3n63 Specifies a username used to connect to the specified service . The username may be of the form "username" in which case the user is prompted to enter in a password and the workgroup specified in the31 program\. The format of ACLs is described in the section ACL FORMAT 32 .PP 33 \-a acls 34 .RS 4 35 Add the ACLs specified to the ACL list\. Existing access control entries are unchanged\. 36 .RE 37 .PP 38 \-M acls 39 .RS 4 40 Modify the mask value (permissions) for the ACLs specified on the command line\. An error will be printed for each ACL specified that was not already present in the ACL list 41 .RE 42 .PP 43 \-D acls 44 .RS 4 45 Delete any ACLs specified on the command line\. An error will be printed for each ACL specified that was not already present in the ACL list\. 46 .RE 47 .PP 48 \-S acls 49 .RS 4 50 This command sets the ACLs on the file with only the ones specified on the command line\. All other ACLs are erased\. Note that the ACL specified must contain at least a revision, type, owner and group for the call to succeed\. 51 .RE 52 .PP 53 \-U username 54 .RS 4 55 Specifies a username used to connect to the specified service\. The username may be of the form "username" in which case the user is prompted to enter in a password and the workgroup specified in the 64 56 \fBsmb.conf\fR(5) 65 file is used, or "username%password" or "DOMAIN\ username%password" and the password and workgroup names are used as provided.66 .RE 67 .PP 68 -C name69 .RS 3n57 file is used, or "username%password" or "DOMAIN\eusername%password" and the password and workgroup names are used as provided\. 58 .RE 59 .PP 60 \-C name 61 .RS 4 70 62 The owner of a file or directory can be changed to the name given using the 71 \fI -C\fR72 option . The name can be a sid in the form S-1-x-y-z or a name resolved against the server specified in the first argument.73 .sp 74 This command is a shortcut for -M OWNER:name.75 .RE 76 .PP 77 -G name78 .RS 3n63 \fI\-C\fR 64 option\. The name can be a sid in the form S\-1\-x\-y\-z or a name resolved against the server specified in the first argument\. 65 .sp 66 This command is a shortcut for \-M OWNER:name\. 67 .RE 68 .PP 69 \-G name 70 .RS 4 79 71 The group owner of a file or directory can be changed to the name given using the 80 \fI-G\fR 81 option. The name can be a sid in the form S-1-x-y-z or a name resolved against the server specified n the first argument. 82 .sp 83 This command is a shortcut for -M GROUP:name. 84 .RE 85 .PP 86 --numeric 87 .RS 3n 88 This option displays all ACL information in numeric format. The default is to convert SIDs to names and ACE types and masks to a readable string format. 89 .RE 90 .PP 91 -t 92 .RS 3n 93 Don't actually do anything, only validate the correctness of the arguments. 94 .RE 95 .PP 96 -h|--help 97 .RS 3n 98 Print a summary of command line options. 99 .RE 100 .PP 101 -V 102 .RS 3n 103 Prints the program version number. 104 .RE 105 .PP 106 -s <configuration file> 107 .RS 3n 108 The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See 109 \fIsmb.conf\fR 110 for more information. The default configuration file name is determined at compile time. 111 .RE 112 .PP 113 -d|--debuglevel=level 114 .RS 3n 72 \fI\-G\fR 73 option\. The name can be a sid in the form S\-1\-x\-y\-z or a name resolved against the server specified n the first argument\. 74 .sp 75 This command is a shortcut for \-M GROUP:name\. 76 .RE 77 .PP 78 \-\-numeric 79 .RS 4 80 This option displays all ACL information in numeric format\. The default is to convert SIDs to names and ACE types and masks to a readable string format\. 81 .RE 82 .PP 83 \-t 84 .RS 4 85 Don\'t actually do anything, only validate the correctness of the arguments\. 86 .RE 87 .PP 88 \-h|\-\-help 89 .RS 4 90 Print a summary of command line options\. 91 .RE 92 .PP 93 \-d|\-\-debuglevel=level 94 .RS 4 115 95 \fIlevel\fR 116 is an integer from 0 to 10 . The default value if this parameter is not specified is zero.117 .sp 118 The higher this value, the more detail will be logged to the log files about the activities of the server . At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out.119 .sp 120 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem . Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic.96 is an integer from 0 to 10\. The default value if this parameter is not specified is 0\. 97 .sp 98 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 99 .sp 100 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 121 101 .sp 122 102 Note that specifying this parameter here will override the 123 103 \fIlog level\fR 124 104 parameter in the 125 \fIsmb.conf\fR 126 file. 127 .RE 128 .PP 129 -l|--logfile=logdirectory 130 .RS 3n 131 Base directory name for log/debug files. The extension 132 \fB".progname"\fR 133 will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client. 105 \fIsmb\.conf\fR 106 file\. 107 .RE 108 .PP 109 \-V 110 .RS 4 111 Prints the program version number\. 112 .RE 113 .PP 114 \-s <configuration file> 115 .RS 4 116 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 117 \fIsmb\.conf\fR 118 for more information\. The default configuration file name is determined at compile time\. 119 .RE 120 .PP 121 \-l|\-\-log\-basename=logdirectory 122 .RS 4 123 Base directory name for log/debug files\. The extension 124 \fB"\.progname"\fR 125 will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\. 134 126 .RE 135 127 .SH "ACL FORMAT" 136 128 .PP 137 The format of an ACL is one or more ACL entries separated by either commas or newlines. An ACL entry is one of the following: 138 .PP 139 140 .sp 141 129 The format of an ACL is one or more ACL entries separated by either commas or newlines\. An ACL entry is one of the following: 130 .PP 131 .RS 4 142 132 .nf 143 133 … … 146 136 GROUP:<sid or name> 147 137 ACL:<sid or name>:<type>/<flags>/<mask> 148 149 138 .fi 150 151 .PP 152 The revision of the ACL specifies the internal Windows NT ACL revision for the security descriptor. If not specified it defaults to 1. Using values other than 1 may cause strange behaviour. 153 .PP 154 The owner and group specify the owner and group sids for the object. If a SID in the format S-1-x-y-z is specified this is used, otherwise the name specified is resolved using the server on which the file or directory resides. 155 .PP 156 ACLs specify permissions granted to the SID. This SID again can be specified in S-1-x-y-z format or as a name in which case it is resolved against the server on which the file or directory resides. The type, flags and mask values determine the type of access granted to the SID. 157 .PP 158 The type can be either 0 or 1 corresponding to ALLOWED or DENIED access to the SID. The flags values are generally zero for file ACLs and either 9 or 2 for directory ACLs. Some common flags are: 159 .TP 3n 160 \(bu 139 .RE 140 .PP 141 The revision of the ACL specifies the internal Windows NT ACL revision for the security descriptor\. If not specified it defaults to 1\. Using values other than 1 may cause strange behaviour\. 142 .PP 143 The owner and group specify the owner and group sids for the object\. If a SID in the format S\-1\-x\-y\-z is specified this is used, otherwise the name specified is resolved using the server on which the file or directory resides\. 144 .PP 145 ACLs specify permissions granted to the SID\. This SID again can be specified in S\-1\-x\-y\-z format or as a name in which case it is resolved against the server on which the file or directory resides\. The type, flags and mask values determine the type of access granted to the SID\. 146 .PP 147 The type can be either 0 or 1 corresponding to ALLOWED or DENIED access to the SID\. The flags values are generally zero for file ACLs and either 9 or 2 for directory ACLs\. Some common flags are: 148 .sp 149 .RS 4 150 .ie n \{\ 151 \h'-04'\(bu\h'+03'\c 152 .\} 153 .el \{\ 154 .sp -1 155 .IP \(bu 2.3 156 .\} 161 157 \fB#define SEC_ACE_FLAG_OBJECT_INHERIT 0x1\fR 162 .TP 3n 163 \(bu 158 .RE 159 .sp 160 .RS 4 161 .ie n \{\ 162 \h'-04'\(bu\h'+03'\c 163 .\} 164 .el \{\ 165 .sp -1 166 .IP \(bu 2.3 167 .\} 164 168 \fB#define SEC_ACE_FLAG_CONTAINER_INHERIT 0x2\fR 165 .TP 3n 166 \(bu 169 .RE 170 .sp 171 .RS 4 172 .ie n \{\ 173 \h'-04'\(bu\h'+03'\c 174 .\} 175 .el \{\ 176 .sp -1 177 .IP \(bu 2.3 178 .\} 167 179 \fB#define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT 0x4\fR 168 .TP 3n 169 \(bu 180 .RE 181 .sp 182 .RS 4 183 .ie n \{\ 184 \h'-04'\(bu\h'+03'\c 185 .\} 186 .el \{\ 187 .sp -1 188 .IP \(bu 2.3 189 .\} 170 190 \fB#define SEC_ACE_FLAG_INHERIT_ONLY 0x8\fR 171 .PP 172 At present flags can only be specified as decimal or hexadecimal values. 173 .PP 174 The mask is a value which expresses the access right granted to the SID. It can be given as a decimal or hexadecimal value, or by using one of the following text strings which map to the NT file permissions of the same name. 175 .TP 3n 176 \(bu 177 \fBR\fR 178 - Allow read access 179 .TP 3n 180 \(bu 181 \fBW\fR 182 - Allow write access 183 .TP 3n 184 \(bu 185 \fBX\fR 186 - Execute permission on the object 187 .TP 3n 188 \(bu 189 \fBD\fR 190 - Delete the object 191 .TP 3n 192 \(bu 193 \fBP\fR 194 - Change permissions 195 .TP 3n 196 \(bu 197 \fBO\fR 198 - Take ownership 191 .sp 192 .RE 193 .PP 194 At present flags can only be specified as decimal or hexadecimal values\. 195 .PP 196 The mask is a value which expresses the access right granted to the SID\. It can be given as a decimal or hexadecimal value, or by using one of the following text strings which map to the NT file permissions of the same name\. 197 .sp 198 .RS 4 199 .ie n \{\ 200 \h'-04'\(bu\h'+03'\c 201 .\} 202 .el \{\ 203 .sp -1 204 .IP \(bu 2.3 205 .\} 206 \fIR\fR 207 \- Allow read access 208 .RE 209 .sp 210 .RS 4 211 .ie n \{\ 212 \h'-04'\(bu\h'+03'\c 213 .\} 214 .el \{\ 215 .sp -1 216 .IP \(bu 2.3 217 .\} 218 \fIW\fR 219 \- Allow write access 220 .RE 221 .sp 222 .RS 4 223 .ie n \{\ 224 \h'-04'\(bu\h'+03'\c 225 .\} 226 .el \{\ 227 .sp -1 228 .IP \(bu 2.3 229 .\} 230 \fIX\fR 231 \- Execute permission on the object 232 .RE 233 .sp 234 .RS 4 235 .ie n \{\ 236 \h'-04'\(bu\h'+03'\c 237 .\} 238 .el \{\ 239 .sp -1 240 .IP \(bu 2.3 241 .\} 242 \fID\fR 243 \- Delete the object 244 .RE 245 .sp 246 .RS 4 247 .ie n \{\ 248 \h'-04'\(bu\h'+03'\c 249 .\} 250 .el \{\ 251 .sp -1 252 .IP \(bu 2.3 253 .\} 254 \fIP\fR 255 \- Change permissions 256 .RE 257 .sp 258 .RS 4 259 .ie n \{\ 260 \h'-04'\(bu\h'+03'\c 261 .\} 262 .el \{\ 263 .sp -1 264 .IP \(bu 2.3 265 .\} 266 \fIO\fR 267 \- Take ownership 268 .sp 269 .RE 199 270 .PP 200 271 The following combined permissions can be specified: 201 .TP 3n 202 \(bu 203 \fBREAD\fR 204 - Equivalent to 'RX' permissions 205 .TP 3n 206 \(bu 207 \fBCHANGE\fR 208 - Equivalent to 'RXWD' permissions 209 .TP 3n 210 \(bu 211 \fBFULL\fR 212 - Equivalent to 'RWXDPO' permissions 272 .sp 273 .RS 4 274 .ie n \{\ 275 \h'-04'\(bu\h'+03'\c 276 .\} 277 .el \{\ 278 .sp -1 279 .IP \(bu 2.3 280 .\} 281 \fIREAD\fR 282 \- Equivalent to \'RX\' permissions 283 .RE 284 .sp 285 .RS 4 286 .ie n \{\ 287 \h'-04'\(bu\h'+03'\c 288 .\} 289 .el \{\ 290 .sp -1 291 .IP \(bu 2.3 292 .\} 293 \fICHANGE\fR 294 \- Equivalent to \'RXWD\' permissions 295 .RE 296 .sp 297 .RS 4 298 .ie n \{\ 299 \h'-04'\(bu\h'+03'\c 300 .\} 301 .el \{\ 302 .sp -1 303 .IP \(bu 2.3 304 .\} 305 \fIFULL\fR 306 \- Equivalent to \'RWXDPO\' permissions 213 307 .SH "EXIT STATUS" 214 308 .PP 215 309 The 216 310 smbcacls 217 program sets the exit status depending on the success or otherwise of the operations performed . The exit status may be one of the following values.218 .PP 219 If the operation succeeded, smbcacls returns and exit status of 0 . If220 smbcacls 221 couldn 't connect to the specified server, or there was an error getting or setting the ACLs, an exit status of 1 is returned. If there was an error parsing any command line arguments, an exit status of 2 is returned.311 program sets the exit status depending on the success or otherwise of the operations performed\. The exit status may be one of the following values\. 312 .PP 313 If the operation succeeded, smbcacls returns and exit status of 0\. If 314 smbcacls 315 couldn\'t connect to the specified server, or there was an error getting or setting the ACLs, an exit status of 1 is returned\. If there was an error parsing any command line arguments, an exit status of 2 is returned\. 222 316 .SH "VERSION" 223 317 .PP 224 This man page is correct for version 3 .0 of the Samba suite.318 This man page is correct for version 3\.0 of the Samba suite\. 225 319 .SH "AUTHOR" 226 320 .PP 227 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 228 .PP 229 smbcacls 230 was written by Andrew Tridgell and Tim Potter. 231 .PP 232 The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 233 321 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 322 .PP 323 smbcacls 324 was written by Andrew Tridgell and Tim Potter\. 325 .PP 326 The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/smbclient.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBCLIENT" 1 "" "" "" 1 .\" Title: smbclient 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBCLIENT" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbclient - ftp-like client to access SMB/CIFS resources on servers 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 smbclient [ -b <buffer size>] [-d debuglevel] [-L <netbios name>] [-U username] [-I destinationIP] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-k] [-P] [-c<command>]17 smbclient [\-b\ <buffer\ size>] [\-d\ debuglevel] [\-e] [\-L\ <netbios\ name>] [\-U\ username] [\-I\ destinationIP] [\-M\ <netbios\ name>] [\-m\ maxprotocol] [\-A\ authfile] [\-N] [\-i\ scope] [\-O\ <socket\ options>] [\-p\ port] [\-R\ <name\ resolve\ order>] [\-s\ <smb\ config\ file>] [\-k] [\-P] [\-c\ <command>] 26 18 .HP 1 27 smbclient {servicename} [password] [ -b <buffer size>] [-d debuglevel] [-D Directory] [-U username] [-W workgroup] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-l logdir] [-I destinationIP] [-E] [-c <command string>] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-T<c|x>IXFqgbNan] [-k]19 smbclient {servicename} [password] [\-b\ <buffer\ size>] [\-d\ debuglevel] [\-e] [\-D\ Directory] [\-U\ username] [\-W\ workgroup] [\-M\ <netbios\ name>] [\-m\ maxprotocol] [\-A\ authfile] [\-N] [\-l\ log\-basename] [\-I\ destinationIP] [\-E] [\-c\ <command\ string>] [\-i\ scope] [\-O\ <socket\ options>] [\-p\ port] [\-R\ <name\ resolve\ order>] [\-s\ <smb\ config\ file>] [\-T<c|x>IXFqgbNan] [\-k] 28 20 .SH "DESCRIPTION" 29 21 .PP 30 22 This tool is part of the 31 23 \fBsamba\fR(7) 32 suite .24 suite\. 33 25 .PP 34 26 smbclient 35 is a client that can 'talk' to an SMB/CIFS server. It offers an interface similar to that of the ftp program (see36 \fBftp\fR(1)) . Operations include things like getting files from the server to the local machine, putting files from the local machine to the server, retrieving directory information from the server and so on.27 is a client that can \'talk\' to an SMB/CIFS server\. It offers an interface similar to that of the ftp program (see 28 \fBftp\fR(1))\. Operations include things like getting files from the server to the local machine, putting files from the local machine to the server, retrieving directory information from the server and so on\. 37 29 .SH "OPTIONS" 38 30 .PP 39 31 servicename 40 .RS 3n41 servicename is the name of the service you want to use on the server . A service name takes the form32 .RS 4 33 servicename is the name of the service you want to use on the server\. A service name takes the form 42 34 \fI//server/service\fR 43 35 where … … 45 37 is the NetBIOS name of the SMB/CIFS server offering the desired service and 46 38 \fIservice\fR 47 is the name of the service offered . Thus to connect to the service "printer" on the SMB/CIFS server "smbserver", you would use the servicename39 is the name of the service offered\. Thus to connect to the service "printer" on the SMB/CIFS server "smbserver", you would use the servicename 48 40 \fI//smbserver/printer \fR 49 41 .sp 50 Note that the server name required is NOT necessarily the IP (DNS) host name of the server ! The name required is a NetBIOS server name, which may or may not be the same as the IP hostname of the machine running the server .42 Note that the server name required is NOT necessarily the IP (DNS) host name of the server ! The name required is a NetBIOS server name, which may or may not be the same as the IP hostname of the machine running the server\. 51 43 .sp 52 44 The server name is looked up according to either the 53 \fI -R\fR45 \fI\-R\fR 54 46 parameter to 55 47 smbclient 56 48 or using the name resolve order parameter in the 57 49 \fBsmb.conf\fR(5) 58 file, allowing an administrator to change the order and methods by which server names are looked up .50 file, allowing an administrator to change the order and methods by which server names are looked up\. 59 51 .RE 60 52 .PP 61 53 password 62 .RS 3n63 The password required to access the specified service on the specified server . If this parameter is supplied, the64 \fI -N\fR65 option (suppress password prompt) is assumed .66 .sp 67 There is no default password . If no password is supplied on the command line (either by using this parameter or adding a password to the68 \fI -U\fR54 .RS 4 55 The password required to access the specified service on the specified server\. If this parameter is supplied, the 56 \fI\-N\fR 57 option (suppress password prompt) is assumed\. 58 .sp 59 There is no default password\. If no password is supplied on the command line (either by using this parameter or adding a password to the 60 \fI\-U\fR 69 61 option (see below)) and the 70 \fI-N\fR 71 option is not specified, the client will prompt for a password, even if the desired service does not require one. (If no password is required, simply press ENTER to provide a null password.) 72 .sp 73 Note: Some servers (including OS/2 and Windows for Workgroups) insist on an uppercase password. Lowercase or mixed case passwords may be rejected by these servers. 74 .sp 75 Be cautious about including passwords in scripts. 76 .RE 77 .PP 78 -R <name resolve order> 79 .RS 3n 80 This option is used by the programs in the Samba suite to determine what naming services and in what order to resolve host names to IP addresses. The option takes a space-separated string of different name resolution options. 81 .sp 82 The options are :"lmhosts", "host", "wins" and "bcast". They cause names to be resolved as follows: 83 .RS 3n 84 .TP 3n 85 \(bu 86 \fBlmhosts\fR: 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 62 \fI\-N\fR 63 option is not specified, the client will prompt for a password, even if the desired service does not require one\. (If no password is required, simply press ENTER to provide a null password\.) 64 .sp 65 Note: Some servers (including OS/2 and Windows for Workgroups) insist on an uppercase password\. Lowercase or mixed case passwords may be rejected by these servers\. 66 .sp 67 Be cautious about including passwords in scripts\. 68 .RE 69 .PP 70 \-R <name resolve order> 71 .RS 4 72 This option is used by the programs in the Samba suite to determine what naming services and in what order to resolve host names to IP addresses\. The option takes a space\-separated string of different name resolution options\. 73 .sp 74 The options are :"lmhosts", "host", "wins" and "bcast"\. They cause names to be resolved as follows: 75 .sp 76 .RS 4 77 .ie n \{\ 78 \h'-04'\(bu\h'+03'\c 79 .\} 80 .el \{\ 81 .sp -1 82 .IP \(bu 2.3 83 .\} 84 \fBlmhosts\fR: 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 87 85 \fBlmhosts\fR(5) 88 for details) then any name type matches for lookup. 89 .TP 3n 90 \(bu 86 for details) then any name type matches for lookup\. 87 .RE 88 .sp 89 .RS 4 90 .ie n \{\ 91 \h'-04'\(bu\h'+03'\c 92 .\} 93 .el \{\ 94 .sp -1 95 .IP \(bu 2.3 96 .\} 91 97 \fBhost\fR: Do a standard host name to IP address resolution, using the system 92 \fI/etc/hosts \fR, NIS, or DNS lookups. This method of name resolution is operating system dependent, for instance on IRIX or Solaris this may be controlled by the 93 \fI/etc/nsswitch.conf\fR 94 file). Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise it is ignored. 95 .TP 3n 96 \(bu 98 \fI/etc/hosts \fR, NIS, or DNS lookups\. This method of name resolution is operating system dependent, for instance on IRIX or Solaris this may be controlled by the 99 \fI/etc/nsswitch\.conf\fR 100 file)\. Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise it is ignored\. 101 .RE 102 .sp 103 .RS 4 104 .ie n \{\ 105 \h'-04'\(bu\h'+03'\c 106 .\} 107 .el \{\ 108 .sp -1 109 .IP \(bu 2.3 110 .\} 97 111 \fBwins\fR: Query a name with the IP address listed in the 98 112 \fIwins server\fR 99 parameter. If no WINS server has been specified this method will be ignored. 100 .TP 3n 101 \(bu 113 parameter\. If no WINS server has been specified this method will be ignored\. 114 .RE 115 .sp 116 .RS 4 117 .ie n \{\ 118 \h'-04'\(bu\h'+03'\c 119 .\} 120 .el \{\ 121 .sp -1 122 .IP \(bu 2.3 123 .\} 102 124 \fBbcast\fR: Do a broadcast on each of the known local interfaces listed in the 103 125 \fIinterfaces\fR 104 parameter . This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet.105 . RE106 . IP "" 3n126 parameter\. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\. 127 .sp 128 .RE 107 129 If this parameter is not set then the name resolve order defined in the 108 130 \fBsmb.conf\fR(5) 109 file parameter (name resolve order) will be used .131 file parameter (name resolve order) will be used\. 110 132 .sp 111 133 The default order is lmhosts, host, wins, bcast and without this parameter or any entry in the … … 113 135 parameter of the 114 136 \fBsmb.conf\fR(5) 115 file the name resolution methods will be attempted in this order. 116 .RE 117 .PP 118 -M NetBIOS name 119 .RS 3n 120 This options allows you to send messages, using the "WinPopup" protocol, to another computer. Once a connection is established you then type your message, pressing ^D (control-D) to end. 121 .sp 122 If the receiving computer is running WinPopup the user will receive the message and probably a beep. If they are not running WinPopup the message will be lost, and no error message will occur. 123 .sp 124 The message is also automatically truncated if the message is over 1600 bytes, as this is the limit of the protocol. 125 .sp 126 One useful trick is to cat the message through 127 smbclient. For example: 128 129 .sp 130 131 .nf 132 133 cat mymessage.txt | smbclient -M FRED 134 135 .fi 136 will send the message in the file 137 \fImymessage.txt\fR 138 to the machine FRED. 137 file the name resolution methods will be attempted in this order\. 138 .RE 139 .PP 140 \-M NetBIOS name 141 .RS 4 142 This options allows you to send messages, using the "WinPopup" protocol, to another computer\. Once a connection is established you then type your message, pressing ^D (control\-D) to end\. 143 .sp 144 If the receiving computer is running WinPopup the user will receive the message and probably a beep\. If they are not running WinPopup the message will be lost, and no error message will occur\. 145 .sp 146 The message is also automatically truncated if the message is over 1600 bytes, as this is the limit of the protocol\. 147 .sp 148 One useful trick is to pipe the message through 149 smbclient\. For example: smbclient \-M FRED < mymessage\.txt will send the message in the file 150 \fImymessage\.txt\fR 151 to the machine FRED\. 139 152 .sp 140 153 You may also find the 141 \fI -U\fR154 \fI\-U\fR 142 155 and 143 \fI -I\fR144 options useful, as they allow you to control the FROM and TO parts of the message .156 \fI\-I\fR 157 options useful, as they allow you to control the FROM and TO parts of the message\. 145 158 .sp 146 159 See the … … 148 161 parameter in the 149 162 \fBsmb.conf\fR(5) 150 for a description of how to handle incoming WinPopup messages in Samba .151 .sp 152 \f BNote\fR: Copy WinPopup into the startup group on your WfWg PCs if you want them to always be able to receive messages.153 .RE 154 .PP 155 -p port156 .RS 3n157 This number is the TCP port number that will be used when making connections to the server . The standard (well-known) TCP port number for an SMB/CIFS server is 139, which is the default.158 .RE 159 .PP 160 -P161 .RS 3n162 Make queries to the external server using the machine account of the local server .163 .RE 164 .PP 165 -h|--help166 .RS 3n167 Print a summary of command line options .168 .RE 169 .PP 170 -I IP-address171 .RS 3n163 for a description of how to handle incoming WinPopup messages in Samba\. 164 .sp 165 \fINote\fR: Copy WinPopup into the startup group on your WfWg PCs if you want them to always be able to receive messages\. 166 .RE 167 .PP 168 \-p port 169 .RS 4 170 This number is the TCP port number that will be used when making connections to the server\. The standard (well\-known) TCP port number for an SMB/CIFS server is 139, which is the default\. 171 .RE 172 .PP 173 \-P 174 .RS 4 175 Make queries to the external server using the machine account of the local server\. 176 .RE 177 .PP 178 \-h|\-\-help 179 .RS 4 180 Print a summary of command line options\. 181 .RE 182 .PP 183 \-I IP\-address 184 .RS 4 172 185 \fIIP address\fR 173 is the address of the server to connect to . It should be specified in standard "a.b.c.d" notation.186 is the address of the server to connect to\. It should be specified in standard "a\.b\.c\.d" notation\. 174 187 .sp 175 188 Normally the client would attempt to locate a named SMB/CIFS server by looking it up via the NetBIOS name resolution mechanism described above in the 176 189 \fIname resolve order\fR 177 parameter above . Using this parameter will force the client to assume that the server is on the machine with the specified IP address and the NetBIOS name component of the resource being connected to will be ignored.178 .sp 179 There is no default for this parameter . If not supplied, it will be determined automatically by the client as described above.180 .RE 181 .PP 182 -E183 .RS 3n184 This parameter causes the client to write messages to the standard error stream (stderr) rather than to the standard output stream .185 .sp 186 By default, the client writes messages to standard output - typically the user's tty.187 .RE 188 .PP 189 -L190 .RS 3n191 This option allows you to look at what services are available on a server . You use it as192 smbclient -L host193 and a list should appear . The194 \fI -I \fR195 option may be useful if your NetBIOS names don 't match your TCP/IP DNS host names or if you are trying to reach a host on another network.196 .RE 197 .PP 198 -t terminal code199 .RS 3n190 parameter above\. Using this parameter will force the client to assume that the server is on the machine with the specified IP address and the NetBIOS name component of the resource being connected to will be ignored\. 191 .sp 192 There is no default for this parameter\. If not supplied, it will be determined automatically by the client as described above\. 193 .RE 194 .PP 195 \-E 196 .RS 4 197 This parameter causes the client to write messages to the standard error stream (stderr) rather than to the standard output stream\. 198 .sp 199 By default, the client writes messages to standard output \- typically the user\'s tty\. 200 .RE 201 .PP 202 \-L 203 .RS 4 204 This option allows you to look at what services are available on a server\. You use it as 205 smbclient \-L host 206 and a list should appear\. The 207 \fI\-I \fR 208 option may be useful if your NetBIOS names don\'t match your TCP/IP DNS host names or if you are trying to reach a host on another network\. 209 .RE 210 .PP 211 \-t terminal code 212 .RS 4 200 213 This option tells 201 214 smbclient 202 how to interpret filenames coming from the remote server . Usually Asian language multibyte UNIX implementations use different character sets than SMB/CIFS servers (\fBEUC\fR215 how to interpret filenames coming from the remote server\. Usually Asian language multibyte UNIX implementations use different character sets than SMB/CIFS servers (\fIEUC\fR 203 216 instead of 204 \f BSJIS\fR205 for example) . Setting this parameter will let217 \fI SJIS\fR 218 for example)\. Setting this parameter will let 206 219 smbclient 207 convert between the UNIX filenames and the SMB filenames correctly. This option has not been seriously tested and may have some problems. 208 .sp 209 The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8, CWjunet, CWhex, CWcap. This is not a complete list, check the Samba source code for the complete list. 210 .RE 211 .PP 212 -b buffersize 213 .RS 3n 214 This option changes the transmit/send buffer size when getting or putting a file from/to the server. The default is 65520 bytes. Setting this value smaller (to 1200 bytes) has been observed to speed up file transfers to and from a Win9x server. 215 .RE 216 .PP 217 -V 218 .RS 3n 219 Prints the program version number. 220 .RE 221 .PP 222 -s <configuration file> 223 .RS 3n 224 The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See 225 \fIsmb.conf\fR 226 for more information. The default configuration file name is determined at compile time. 227 .RE 228 .PP 229 -d|--debuglevel=level 230 .RS 3n 220 convert between the UNIX filenames and the SMB filenames correctly\. This option has not been seriously tested and may have some problems\. 221 .sp 222 The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8, CWjunet, CWhex, CWcap\. This is not a complete list, check the Samba source code for the complete list\. 223 .RE 224 .PP 225 \-b buffersize 226 .RS 4 227 This option changes the transmit/send buffer size when getting or putting a file from/to the server\. The default is 65520 bytes\. Setting this value smaller (to 1200 bytes) has been observed to speed up file transfers to and from a Win9x server\. 228 .RE 229 .PP 230 \-e 231 .RS 4 232 This command line parameter requires the remote server support the UNIX extensions\. Request that the connection be encrypted\. This is new for Samba 3\.2 and will only work with Samba 3\.2 or above servers\. Negotiates SMB encryption using GSSAPI\. Uses the given credentials for the encryption negotiaion (either kerberos or NTLMv1/v2 if given domain/username/password triple\. Fails the connection if encryption cannot be negotiated\. 233 .RE 234 .PP 235 \-d|\-\-debuglevel=level 236 .RS 4 231 237 \fIlevel\fR 232 is an integer from 0 to 10 . The default value if this parameter is not specified is zero.233 .sp 234 The higher this value, the more detail will be logged to the log files about the activities of the server . At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out.235 .sp 236 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem . Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic.238 is an integer from 0 to 10\. The default value if this parameter is not specified is 1\. 239 .sp 240 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 241 .sp 242 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 237 243 .sp 238 244 Note that specifying this parameter here will override the 239 245 \fIlog level\fR 240 246 parameter in the 241 \fIsmb.conf\fR 242 file. 243 .RE 244 .PP 245 -l|--logfile=logdirectory 246 .RS 3n 247 Base directory name for log/debug files. The extension 248 \fB".progname"\fR 249 will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client. 250 .RE 251 .PP 252 -N 253 .RS 3n 254 If specified, this parameter suppresses the normal password prompt from the client to the user. This is useful when accessing a service that does not require a password. 255 .sp 256 Unless a password is specified on the command line or this parameter is specified, the client will request a password. 257 .sp 258 If a password is specified on the command line and this option is also defined the password on the command line will be silently ingnored and no password will be used. 259 .RE 260 .PP 261 -k 262 .RS 3n 263 Try to authenticate with kerberos. Only useful in an Active Directory environment. 264 .RE 265 .PP 266 -A|--authentication-file=filename 267 .RS 3n 268 This option allows you to specify a file from which to read the username and password used in the connection. The format of the file is 269 .sp 270 271 .sp 272 247 \fIsmb\.conf\fR 248 file\. 249 .RE 250 .PP 251 \-V 252 .RS 4 253 Prints the program version number\. 254 .RE 255 .PP 256 \-s <configuration file> 257 .RS 4 258 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 259 \fIsmb\.conf\fR 260 for more information\. The default configuration file name is determined at compile time\. 261 .RE 262 .PP 263 \-l|\-\-log\-basename=logdirectory 264 .RS 4 265 Base directory name for log/debug files\. The extension 266 \fB"\.progname"\fR 267 will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\. 268 .RE 269 .PP 270 \-N 271 .RS 4 272 If specified, this parameter suppresses the normal password prompt from the client to the user\. This is useful when accessing a service that does not require a password\. 273 .sp 274 Unless a password is specified on the command line or this parameter is specified, the client will request a password\. 275 .sp 276 If a password is specified on the command line and this option is also defined the password on the command line will be silently ingnored and no password will be used\. 277 .RE 278 .PP 279 \-k 280 .RS 4 281 Try to authenticate with kerberos\. Only useful in an Active Directory environment\. 282 .RE 283 .PP 284 \-A|\-\-authentication\-file=filename 285 .RS 4 286 This option allows you to specify a file from which to read the username and password used in the connection\. The format of the file is 287 .sp 288 .sp 289 .RS 4 273 290 .nf 274 275 291 username = <value> 276 292 password = <value> 277 293 domain = <value> 278 279 294 .fi 280 281 .sp 282 Make certain that the permissions on the file restrict access from unwanted users .283 .RE 284 .PP 285 -U|--user=username[%password]286 .RS 3n287 Sets the SMB username or username and password .288 .sp 289 If %password is not specified, the user will be prompted . The client will first check the295 .RE 296 .sp 297 Make certain that the permissions on the file restrict access from unwanted users\. 298 .RE 299 .PP 300 \-U|\-\-user=username[%password] 301 .RS 4 302 Sets the SMB username or username and password\. 303 .sp 304 If %password is not specified, the user will be prompted\. The client will first check the 290 305 \fBUSER\fR 291 306 environment variable, then the 292 307 \fBLOGNAME\fR 293 variable and if either exists, the string is uppercased . If these environmental variables are not found, the username308 variable and if either exists, the string is uppercased\. If these environmental variables are not found, the username 294 309 \fBGUEST\fR 295 is used .296 .sp 297 A third option is to use a credentials file which contains the plaintext of the username and password . This option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables. If this method is used, make certain that the permissions on the file restrict access from unwanted users. See the298 \fI -A\fR299 for more details .300 .sp 301 Be cautious about including passwords in scripts . Also, on many systems the command line of a running process may be seen via the310 is used\. 311 .sp 312 A third option is to use a credentials file which contains the plaintext of the username and password\. This option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables\. If this method is used, make certain that the permissions on the file restrict access from unwanted users\. See the 313 \fI\-A\fR 314 for more details\. 315 .sp 316 Be cautious about including passwords in scripts\. Also, on many systems the command line of a running process may be seen via the 302 317 ps 303 command . To be safe always allow318 command\. To be safe always allow 304 319 rpcclient 305 to prompt for a password and type it in directly .306 .RE 307 .PP 308 -n <primary NetBIOS name>309 .RS 3n310 This option allows you to override the NetBIOS name that Samba uses for itself . This is identical to setting the311 320 to prompt for a password and type it in directly\. 321 .RE 322 .PP 323 \-n <primary NetBIOS name> 324 .RS 4 325 This option allows you to override the NetBIOS name that Samba uses for itself\. This is identical to setting the 326 \fInetbios name\fR 312 327 parameter in the 313 \fIsmb .conf\fR314 file . However, a command line setting will take precedence over settings in315 \fIsmb .conf\fR.316 .RE 317 .PP 318 -i <scope>319 .RS 3n328 \fIsmb\.conf\fR 329 file\. However, a command line setting will take precedence over settings in 330 \fIsmb\.conf\fR\. 331 .RE 332 .PP 333 \-i <scope> 334 .RS 4 320 335 This specifies a NetBIOS scope that 321 336 nmblookup 322 will use to communicate with when generating NetBIOS names . For details on the use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are323 \f Bvery\fR324 rarely used, only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with .325 .RE 326 .PP 327 -W|--workgroup=domain328 .RS 3n329 Set the SMB domain of the username . This overrides the default domain which is the domain defined in smb.conf. If the domain specified is the same as the servers NetBIOS name, it causes the client to log on using the servers local SAM (as opposed to the Domain SAM).330 .RE 331 .PP 332 -O socket options333 .RS 3n334 TCP socket options to set on the client socket . See the socket options parameter in the335 \fIsmb .conf\fR336 manual page for the list of valid options .337 .RE 338 .PP 339 -T tar options340 .RS 3n337 will use to communicate with when generating NetBIOS names\. For details on the use of NetBIOS scopes, see rfc1001\.txt and rfc1002\.txt\. NetBIOS scopes are 338 \fIvery\fR 339 rarely used, only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with\. 340 .RE 341 .PP 342 \-W|\-\-workgroup=domain 343 .RS 4 344 Set the SMB domain of the username\. This overrides the default domain which is the domain defined in smb\.conf\. If the domain specified is the same as the servers NetBIOS name, it causes the client to log on using the servers local SAM (as opposed to the Domain SAM)\. 345 .RE 346 .PP 347 \-O socket options 348 .RS 4 349 TCP socket options to set on the client socket\. See the socket options parameter in the 350 \fIsmb\.conf\fR 351 manual page for the list of valid options\. 352 .RE 353 .PP 354 \-T tar options 355 .RS 4 341 356 smbclient may be used to create 342 357 tar(1) 343 compatible backups of all the files on an SMB/CIFS share. The secondary tar flags that can be given to this option are : 344 .RS 3n 345 .TP 3n 346 \(bu 358 compatible backups of all the files on an SMB/CIFS share\. The secondary tar flags that can be given to this option are : 359 .sp 360 .RS 4 361 .ie n \{\ 362 \h'-04'\(bu\h'+03'\c 363 .\} 364 .el \{\ 365 .sp -1 366 .IP \(bu 2.3 367 .\} 347 368 \fIc\fR 348 - Create a tar file on UNIX. Must be followed by the name of a tar file, tape device or "-" for standard output. If using standard output you must turn the log level to its lowest value -d0 to avoid corrupting your tar file. This flag is mutually exclusive with the369 \- Create a tar file on UNIX\. Must be followed by the name of a tar file, tape device or "\-" for standard output\. If using standard output you must turn the log level to its lowest value \-d0 to avoid corrupting your tar file\. This flag is mutually exclusive with the 349 370 \fIx\fR 350 flag. 351 .TP 3n 352 \(bu 371 flag\. 372 .RE 373 .sp 374 .RS 4 375 .ie n \{\ 376 \h'-04'\(bu\h'+03'\c 377 .\} 378 .el \{\ 379 .sp -1 380 .IP \(bu 2.3 381 .\} 353 382 \fIx\fR 354 - Extract (restore) a local tar file back to a share. Unless the -D option is given, the tar files will be restored from the top level of the share. Must be followed by the name of the tar file, device or "-" for standard input. Mutually exclusive with the383 \- Extract (restore) a local tar file back to a share\. Unless the \-D option is given, the tar files will be restored from the top level of the share\. Must be followed by the name of the tar file, device or "\-" for standard input\. Mutually exclusive with the 355 384 \fIc\fR 356 flag. Restored files have their creation times (mtime) set to the date saved in the tar file. Directories currently do not get their creation dates restored properly. 357 .TP 3n 358 \(bu 385 flag\. Restored files have their creation times (mtime) set to the date saved in the tar file\. Directories currently do not get their creation dates restored properly\. 386 .RE 387 .sp 388 .RS 4 389 .ie n \{\ 390 \h'-04'\(bu\h'+03'\c 391 .\} 392 .el \{\ 393 .sp -1 394 .IP \(bu 2.3 395 .\} 359 396 \fII\fR 360 - Include files and directories. Is the default behavior when filenames are specified above. Causes files to be included in an extract or create (and therefore everything else to be excluded). See example below. Filename globbing works in one of two ways. See397 \- Include files and directories\. Is the default behavior when filenames are specified above\. Causes files to be included in an extract or create (and therefore everything else to be excluded)\. See example below\. Filename globbing works in one of two ways\. See 361 398 \fIr\fR 362 below. 363 .TP 3n 364 \(bu 399 below\. 400 .RE 401 .sp 402 .RS 4 403 .ie n \{\ 404 \h'-04'\(bu\h'+03'\c 405 .\} 406 .el \{\ 407 .sp -1 408 .IP \(bu 2.3 409 .\} 365 410 \fIX\fR 366 - Exclude files and directories. Causes files to be excluded from an extract or create. See example below. Filename globbing works in one of two ways now. See411 \- Exclude files and directories\. Causes files to be excluded from an extract or create\. See example below\. Filename globbing works in one of two ways now\. See 367 412 \fIr\fR 368 below. 369 .TP 3n 370 \(bu 413 below\. 414 .RE 415 .sp 416 .RS 4 417 .ie n \{\ 418 \h'-04'\(bu\h'+03'\c 419 .\} 420 .el \{\ 421 .sp -1 422 .IP \(bu 2.3 423 .\} 371 424 \fIF\fR 372 - File containing a list of files and directories. The425 \- File containing a list of files and directories\. The 373 426 \fIF\fR 374 causes the name following the tarfile to create to be read as a filename that contains a list of files and directories to be included in an extract or create (and therefore everything else to be excluded) . See example below. Filename globbing works in one of two ways. See427 causes the name following the tarfile to create to be read as a filename that contains a list of files and directories to be included in an extract or create (and therefore everything else to be excluded)\. See example below\. Filename globbing works in one of two ways\. See 375 428 \fIr\fR 376 below. 377 .TP 3n 378 \(bu 429 below\. 430 .RE 431 .sp 432 .RS 4 433 .ie n \{\ 434 \h'-04'\(bu\h'+03'\c 435 .\} 436 .el \{\ 437 .sp -1 438 .IP \(bu 2.3 439 .\} 379 440 \fIb\fR 380 - Blocksize. Must be followed by a valid (greater than zero) blocksize. Causes tar file to be written out in blocksize*TBLOCK (usually 512 byte) blocks. 381 .TP 3n 382 \(bu 441 \- Blocksize\. Must be followed by a valid (greater than zero) blocksize\. Causes tar file to be written out in blocksize*TBLOCK (usually 512 byte) blocks\. 442 .RE 443 .sp 444 .RS 4 445 .ie n \{\ 446 \h'-04'\(bu\h'+03'\c 447 .\} 448 .el \{\ 449 .sp -1 450 .IP \(bu 2.3 451 .\} 383 452 \fIg\fR 384 - Incremental. Only back up files that have the archive bit set. Useful only with the453 \- Incremental\. Only back up files that have the archive bit set\. Useful only with the 385 454 \fIc\fR 386 flag. 387 .TP 3n 388 \(bu 455 flag\. 456 .RE 457 .sp 458 .RS 4 459 .ie n \{\ 460 \h'-04'\(bu\h'+03'\c 461 .\} 462 .el \{\ 463 .sp -1 464 .IP \(bu 2.3 465 .\} 389 466 \fIq\fR 390 - Quiet. Keeps tar from printing diagnostics as it works. This is the same as tarmode quiet. 391 .TP 3n 392 \(bu 467 \- Quiet\. Keeps tar from printing diagnostics as it works\. This is the same as tarmode quiet\. 468 .RE 469 .sp 470 .RS 4 471 .ie n \{\ 472 \h'-04'\(bu\h'+03'\c 473 .\} 474 .el \{\ 475 .sp -1 476 .IP \(bu 2.3 477 .\} 393 478 \fIr\fR 394 - Regular expression include or exclude. Uses regular expression matching for excluding or excluding files if compiled with HAVE_REGEX_H. However this mode can be very slow. If not compiled with HAVE_REGEX_H, does a limited wildcard match on '*' and '?'. 395 .TP 3n 396 \(bu 479 \- Regular expression include or exclude\. Uses regular expression matching for excluding or excluding files if compiled with HAVE_REGEX_H\. However this mode can be very slow\. If not compiled with HAVE_REGEX_H, does a limited wildcard match on \'*\' and \'?\'\. 480 .RE 481 .sp 482 .RS 4 483 .ie n \{\ 484 \h'-04'\(bu\h'+03'\c 485 .\} 486 .el \{\ 487 .sp -1 488 .IP \(bu 2.3 489 .\} 397 490 \fIN\fR 398 - Newer than. Must be followed by the name of a file whose date is compared against files found on the share during a create. Only files newer than the file specified are backed up to the tar file. Useful only with the491 \- Newer than\. Must be followed by the name of a file whose date is compared against files found on the share during a create\. Only files newer than the file specified are backed up to the tar file\. Useful only with the 399 492 \fIc\fR 400 flag. 401 .TP 3n 402 \(bu 493 flag\. 494 .RE 495 .sp 496 .RS 4 497 .ie n \{\ 498 \h'-04'\(bu\h'+03'\c 499 .\} 500 .el \{\ 501 .sp -1 502 .IP \(bu 2.3 503 .\} 403 504 \fIa\fR 404 - Set archive bit. Causes the archive bit to be reset when a file is backed up. Useful with the505 \- Set archive bit\. Causes the archive bit to be reset when a file is backed up\. Useful with the 405 506 \fIg\fR 406 507 and 407 508 \fIc\fR 408 flags .409 . RE410 . IP "" 3n411 \f BTar Long File Names\fR412 .sp 413 smbclient 's tar option now supports long file names both on backup and restore. However, the full path name of the file must be less than 1024 bytes. Also, when a tar archive is created,414 smbclient 's tar option places all files in the archive with relative names, not absolute names.415 .sp 416 \f BTar Filenames\fR417 .sp 418 All file names can be given as DOS path names (with '\\' as the component separator) or as UNIX path names (with '/' as the component separator).419 .sp 420 \f BExamples\fR509 flags\. 510 .sp 511 .RE 512 \fITar Long File Names\fR 513 .sp 514 smbclient\'s tar option now supports long file names both on backup and restore\. However, the full path name of the file must be less than 1024 bytes\. Also, when a tar archive is created, 515 smbclient\'s tar option places all files in the archive with relative names, not absolute names\. 516 .sp 517 \fITar Filenames\fR 518 .sp 519 All file names can be given as DOS path names (with \'\e\e\' as the component separator) or as UNIX path names (with \'/\' as the component separator)\. 520 .sp 521 \fIExamples\fR 421 522 .sp 422 523 Restore from tar file 423 \fIbackup .tar\fR424 into myshare on mypc (no password on share) .425 .sp 426 smbclient //mypc/yshare "" -N -Tx backup.tar524 \fIbackup\.tar\fR 525 into myshare on mypc (no password on share)\. 526 .sp 527 smbclient //mypc/yshare "" \-N \-Tx backup\.tar 427 528 .sp 428 529 Restore everything except 429 530 \fIusers/docs\fR 430 531 .sp 431 smbclient //mypc/myshare "" -N -TXx backup.tar users/docs532 smbclient //mypc/myshare "" \-N \-TXx backup\.tar users/docs 432 533 .sp 433 534 Create a tar file of the files beneath 434 \fI users/docs\fR .435 .sp 436 smbclient //mypc/myshare "" -N -Tc backup.tar users/docs437 .sp 438 Create the same tar file as above, but now use a DOS path name .439 .sp 440 smbclient //mypc/myshare "" -N -tc backup.tar users\\edocs535 \fI users/docs\fR\. 536 .sp 537 smbclient //mypc/myshare "" \-N \-Tc backup\.tar users/docs 538 .sp 539 Create the same tar file as above, but now use a DOS path name\. 540 .sp 541 smbclient //mypc/myshare "" \-N \-tc backup\.tar users\eedocs 441 542 .sp 442 543 Create a tar file of the files listed in the file 443 \fItarlist\fR .444 .sp 445 smbclient //mypc/myshare "" -N -TcF backup.tar tarlist446 .sp 447 Create a tar file of all the files and directories in the share .448 .sp 449 smbclient //mypc/myshare "" -N -Tc backup.tar *450 .RE 451 .PP 452 -D initial directory453 .RS 3n454 Change to initial directory before starting . Probably only of any use with the tar -T option.455 .RE 456 .PP 457 -c command string458 .RS 3n459 command string is a semicolon -separated list of commands to be executed instead of prompting from stdin.460 \fI -N\fR544 \fItarlist\fR\. 545 .sp 546 smbclient //mypc/myshare "" \-N \-TcF backup\.tar tarlist 547 .sp 548 Create a tar file of all the files and directories in the share\. 549 .sp 550 smbclient //mypc/myshare "" \-N \-Tc backup\.tar * 551 .RE 552 .PP 553 \-D initial directory 554 .RS 4 555 Change to initial directory before starting\. Probably only of any use with the tar \-T option\. 556 .RE 557 .PP 558 \-c command string 559 .RS 4 560 command string is a semicolon\-separated list of commands to be executed instead of prompting from stdin\. 561 \fI \-N\fR 461 562 is implied by 462 \fI -c\fR.463 .sp 464 This is particularly useful in scripts and for printing stdin to the server, e .g.465 -c 'print -'.563 \fI\-c\fR\. 564 .sp 565 This is particularly useful in scripts and for printing stdin to the server, e\.g\. 566 \-c \'print \-\'\. 466 567 .RE 467 568 .SH "OPERATIONS" … … 469 570 Once the client is running, the user is presented with a prompt : 470 571 .PP 471 smb:\ >472 .PP 473 The backslash ("\ \") indicates the current working directory on the server, and will change if the current working directory is changed.474 .PP 475 The prompt indicates that the client is ready and waiting to carry out a user command . Each command is a single word, optionally followed by parameters specific to that command. Command and parameters are space-delimited unless these notes specifically state otherwise. All commands are case-insensitive. Parameters to commands may or may not be case sensitive, depending on the command.476 .PP 477 You can specify file names which have spaces in them by quoting the name with double quotes, for example "a long file name" .478 .PP 479 Parameters shown in square brackets (e .g., "[parameter]") are optional. If not given, the command will use suitable defaults. Parameters shown in angle brackets (e.g., "<parameter>") are required.480 .PP 481 Note that all commands operating on the server are actually performed by issuing a request to the server . Thus the behavior may vary from server to server, depending on how the server was implemented.482 .PP 483 The commands available are given here in alphabetical order .572 smb:\e> 573 .PP 574 The backslash ("\e\e") indicates the current working directory on the server, and will change if the current working directory is changed\. 575 .PP 576 The prompt indicates that the client is ready and waiting to carry out a user command\. Each command is a single word, optionally followed by parameters specific to that command\. Command and parameters are space\-delimited unless these notes specifically state otherwise\. All commands are case\-insensitive\. Parameters to commands may or may not be case sensitive, depending on the command\. 577 .PP 578 You can specify file names which have spaces in them by quoting the name with double quotes, for example "a long file name"\. 579 .PP 580 Parameters shown in square brackets (e\.g\., "[parameter]") are optional\. If not given, the command will use suitable defaults\. Parameters shown in angle brackets (e\.g\., "<parameter>") are required\. 581 .PP 582 Note that all commands operating on the server are actually performed by issuing a request to the server\. Thus the behavior may vary from server to server, depending on how the server was implemented\. 583 .PP 584 The commands available are given here in alphabetical order\. 484 585 .PP 485 586 ? [command] 486 .RS 3n587 .RS 4 487 588 If 488 589 \fIcommand\fR 489 is specified, the ? command will display a brief informative message about the specified command . If no command is specified, a list of available commands will be displayed.590 is specified, the ? command will display a brief informative message about the specified command\. If no command is specified, a list of available commands will be displayed\. 490 591 .RE 491 592 .PP 492 593 ! [shell command] 493 .RS 3n594 .RS 4 494 595 If 495 596 \fIshell command\fR 496 is specified, the ! command will execute a shell locally and run the specified shell command. If no command is specified, a local shell will be run. 597 is specified, the ! command will execute a shell locally and run the specified shell command\. If no command is specified, a local shell will be run\. 598 .RE 599 .PP 600 allinfo file 601 .RS 4 602 The client will request that the server return all known information about a file or directory (including streams)\. 497 603 .RE 498 604 .PP 499 605 altname file 500 .RS 3n 501 The client will request that the server return the "alternate" name (the 8.3 name) for a file or directory. 606 .RS 4 607 The client will request that the server return the "alternate" name (the 8\.3 name) for a file or directory\. 608 .RE 609 .PP 610 archive <number> 611 .RS 4 612 Sets the archive level when operating on files\. 0 means ignore the archive bit, 1 means only operate on files with this bit set, 2 means only operate on files with this bit set and reset it after operation, 3 means operate on all files and reset it after operation\. The default is 0\. 613 .RE 614 .PP 615 blocksize <number> 616 .RS 4 617 Sets the blocksize parameter for a tar operation\. The default is 20\. Causes tar file to be written out in blocksize*TBLOCK (normally 512 byte) units\. 618 .RE 619 .PP 620 cancel jobid0 [jobid1] \.\.\. [jobidN] 621 .RS 4 622 The client will request that the server cancel the printjobs identified by the given numeric print job ids\. 502 623 .RE 503 624 .PP 504 625 case_sensitive 505 .RS 3n 506 Toggles the setting of the flag in SMB packets that tells the server to treat filenames as case sensitive. Set to OFF by default (tells file server to treat filenames as case insensitive). Only currently affects Samba 3.0.5 and above file servers with the case sensitive parameter set to auto in the smb.conf. 507 .RE 508 .PP 509 cancel jobid0 [jobid1] ... [jobidN] 510 .RS 3n 511 The client will request that the server cancel the printjobs identified by the given numeric print job ids. 626 .RS 4 627 Toggles the setting of the flag in SMB packets that tells the server to treat filenames as case sensitive\. Set to OFF by default (tells file server to treat filenames as case insensitive)\. Only currently affects Samba 3\.0\.5 and above file servers with the case sensitive parameter set to auto in the smb\.conf\. 628 .RE 629 .PP 630 cd <directory name> 631 .RS 4 632 If "directory name" is specified, the current working directory on the server will be changed to the directory specified\. This operation will fail if for any reason the specified directory is inaccessible\. 633 .sp 634 If no directory name is specified, the current working directory on the server will be reported\. 512 635 .RE 513 636 .PP 514 637 chmod file mode in octal 515 .RS 3n516 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not . The client requests that the server change the UNIX permissions to the given octal mode, in standard UNIX format.638 .RS 4 639 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\. The client requests that the server change the UNIX permissions to the given octal mode, in standard UNIX format\. 517 640 .RE 518 641 .PP 519 642 chown file uid gid 520 .RS 3n 521 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. The client requests that the server change the UNIX user and group ownership to the given decimal values. Note there is currently no way to remotely look up the UNIX uid and gid values for a given name. This may be addressed in future versions of the CIFS UNIX extensions. 522 .RE 523 .PP 524 cd [directory name] 525 .RS 3n 526 If "directory name" is specified, the current working directory on the server will be changed to the directory specified. This operation will fail if for any reason the specified directory is inaccessible. 527 .sp 528 If no directory name is specified, the current working directory on the server will be reported. 643 .RS 4 644 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\. The client requests that the server change the UNIX user and group ownership to the given decimal values\. Note there is currently no way to remotely look up the UNIX uid and gid values for a given name\. This may be addressed in future versions of the CIFS UNIX extensions\. 645 .RE 646 .PP 647 close <fileid> 648 .RS 4 649 Closes a file explicitly opened by the open command\. Used for internal Samba testing purposes\. 529 650 .RE 530 651 .PP 531 652 del <mask> 532 .RS 3n653 .RS 4 533 654 The client will request that the server attempt to delete all files matching 534 655 \fImask\fR 535 from the current working directory on the server .656 from the current working directory on the server\. 536 657 .RE 537 658 .PP 538 659 dir <mask> 539 .RS 3n660 .RS 4 540 661 A list of the files matching 541 662 \fImask\fR 542 in the current working directory on the server will be retrieved from the server and displayed. 663 in the current working directory on the server will be retrieved from the server and displayed\. 664 .RE 665 .PP 666 du <filename> 667 .RS 4 668 Does a directory listing and then prints out the current disk useage and free space on a share\. 669 .RE 670 .PP 671 echo <number> <data> 672 .RS 4 673 Does an SMBecho request to ping the server\. Used for internal Samba testing purposes\. 543 674 .RE 544 675 .PP 545 676 exit 546 .RS 3n547 Terminate the connection with the server and exit from the program .677 .RS 4 678 Terminate the connection with the server and exit from the program\. 548 679 .RE 549 680 .PP 550 681 get <remote file name> [local file name] 551 .RS 3n682 .RS 4 552 683 Copy the file called 553 684 \fIremote file name\fR 554 from the server to the machine running the client . If specified, name the local copy555 \fIlocal file name\fR . Note that all transfers in685 from the server to the machine running the client\. If specified, name the local copy 686 \fIlocal file name\fR\. Note that all transfers in 556 687 smbclient 557 are binary. See also the lowercase command. 688 are binary\. See also the lowercase command\. 689 .RE 690 .PP 691 getfacl <filename> 692 .RS 4 693 Requires the server support the UNIX extensions\. Requests and prints the POSIX ACL on a file\. 694 .RE 695 .PP 696 hardlink <src> <dest< 697 .RS 4 698 Creates a hardlink on the server using Windows CIFS semantics\. the POSIX ACL on a file\. 558 699 .RE 559 700 .PP 560 701 help [command] 561 .RS 3n 562 See the ? command above. 702 .RS 4 703 See the ? command above\. 704 .RE 705 .PP 706 history 707 .RS 4 708 Displays the command history\. 709 .RE 710 .PP 711 iosize <bytes> 712 .RS 4 713 When sending or receiving files, smbclient uses an internal memory buffer by default of size 64512 bytes\. This command allows this size to be set to any range between 16384 (0x4000) bytes and 16776960 (0xFFFF00) bytes\. Larger sizes may mean more efficient data transfer as smbclient will try and use the most efficient read and write calls for the connected server\. 563 714 .RE 564 715 .PP 565 716 lcd [directory name] 566 .RS 3n717 .RS 4 567 718 If 568 719 \fIdirectory name\fR 569 is specified, the current working directory on the local machine will be changed to the directory specified . This operation will fail if for any reason the specified directory is inaccessible.570 .sp 571 If no directory name is specified, the name of the current working directory on the local machine will be reported .720 is specified, the current working directory on the local machine will be changed to the directory specified\. This operation will fail if for any reason the specified directory is inaccessible\. 721 .sp 722 If no directory name is specified, the name of the current working directory on the local machine will be reported\. 572 723 .RE 573 724 .PP 574 725 link target linkname 575 .RS 3n 576 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. The client requests that the server create a hard link between the linkname and target files. The linkname file must not exist. 726 .RS 4 727 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\. The client requests that the server create a hard link between the linkname and target files\. The linkname file must not exist\. 728 .RE 729 .PP 730 listconnect 731 .RS 4 732 Show the current connections held for DFS purposes\. 733 .RE 734 .PP 735 lock <filenum> <r|w> <hex\-start> <hex\-len> 736 .RS 4 737 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\. Tries to set a POSIX fcntl lock of the given type on the given range\. Used for internal Samba testing purposes\. 738 .RE 739 .PP 740 logon <username> <password> 741 .RS 4 742 Establishes a new vuid for this session by logging on again\. Replaces the current vuid\. Prints out the new vuid\. Used for internal Samba testing purposes\. 577 743 .RE 578 744 .PP 579 745 lowercase 580 .RS 3n581 Toggle lowercasing of filenames for the get and mget commands .582 .sp 583 When lowercasing is toggled ON, local filenames are converted to lowercase when using the get and mget commands . This is often useful when copying (say) MSDOS files from a server, because lowercase filenames are the norm on UNIX systems.746 .RS 4 747 Toggle lowercasing of filenames for the get and mget commands\. 748 .sp 749 When lowercasing is toggled ON, local filenames are converted to lowercase when using the get and mget commands\. This is often useful when copying (say) MSDOS files from a server, because lowercase filenames are the norm on UNIX systems\. 584 750 .RE 585 751 .PP 586 752 ls <mask> 587 .RS 3n588 See the dir command above .753 .RS 4 754 See the dir command above\. 589 755 .RE 590 756 .PP 591 757 mask <mask> 592 .RS 3n593 This command allows the user to set up a mask which will be used during recursive operation of the mget and mput commands .594 .sp 595 The masks specified to the mget and mput commands act as filters for directories rather than files when recursion is toggled ON .596 .sp 597 The mask specified with the mask command is necessary to filter files within those directories . For example, if the mask specified in an mget command is "source*" and the mask specified with the mask command is "*.c" and recursion is toggled ON, the mget command will retrieve all files matching "*.c" in all directories below and including all directories matching "source*" in the current working directory.598 .sp 599 Note that the value for mask defaults to blank (equivalent to "*") and remains so until the mask command is used to change it . It retains the most recently specified value indefinitely. To avoid unexpected results it would be wise to change the value of mask back to "*" after using the mget or mput commands.758 .RS 4 759 This command allows the user to set up a mask which will be used during recursive operation of the mget and mput commands\. 760 .sp 761 The masks specified to the mget and mput commands act as filters for directories rather than files when recursion is toggled ON\. 762 .sp 763 The mask specified with the mask command is necessary to filter files within those directories\. For example, if the mask specified in an mget command is "source*" and the mask specified with the mask command is "*\.c" and recursion is toggled ON, the mget command will retrieve all files matching "*\.c" in all directories below and including all directories matching "source*" in the current working directory\. 764 .sp 765 Note that the value for mask defaults to blank (equivalent to "*") and remains so until the mask command is used to change it\. It retains the most recently specified value indefinitely\. To avoid unexpected results it would be wise to change the value of mask back to "*" after using the mget or mput commands\. 600 766 .RE 601 767 .PP 602 768 md <directory name> 603 .RS 3n604 See the mkdir command .769 .RS 4 770 See the mkdir command\. 605 771 .RE 606 772 .PP 607 773 mget <mask> 608 .RS 3n774 .RS 4 609 775 Copy all files matching 610 776 \fImask\fR 611 from the server to the machine running the client .777 from the server to the machine running the client\. 612 778 .sp 613 779 Note that 614 780 \fImask\fR 615 is interpreted differently during recursive operation and non -recursive operation - refer to the recurse and mask commands for more information. Note that all transfers in781 is interpreted differently during recursive operation and non\-recursive operation \- refer to the recurse and mask commands for more information\. Note that all transfers in 616 782 smbclient 617 are binary . See also the lowercase command.783 are binary\. See also the lowercase command\. 618 784 .RE 619 785 .PP 620 786 mkdir <directory name> 621 .RS 3n 622 Create a new directory on the server (user access privileges permitting) with the specified name. 787 .RS 4 788 Create a new directory on the server (user access privileges permitting) with the specified name\. 789 .RE 790 .PP 791 more <file name> 792 .RS 4 793 Fetch a remote file and view it with the contents of your PAGER environment variable\. 623 794 .RE 624 795 .PP 625 796 mput <mask> 626 .RS 3n797 .RS 4 627 798 Copy all files matching 628 799 \fImask\fR 629 in the current working directory on the local machine to the current working directory on the server .800 in the current working directory on the local machine to the current working directory on the server\. 630 801 .sp 631 802 Note that 632 803 \fImask\fR 633 is interpreted differently during recursive operation and non -recursive operation - refer to the recurse and mask commands for more information. Note that all transfers in804 is interpreted differently during recursive operation and non\-recursive operation \- refer to the recurse and mask commands for more information\. Note that all transfers in 634 805 smbclient 635 are binary. 806 are binary\. 807 .RE 808 .PP 809 posix 810 .RS 4 811 Query the remote server to see if it supports the CIFS UNIX extensions and prints out the list of capabilities supported\. If so, turn on POSIX pathname processing and large file read/writes (if available),\. 812 .RE 813 .PP 814 posix_encrypt <domain> <username> <password> 815 .RS 4 816 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\. Attempt to negotiate SMB encryption on this connection\. If smbclient connected with kerberos credentials (\-k) the arguments to this command are ignored and the kerberos credentials are used to negotiate GSSAPI signing and sealing instead\. See also the \-e option to smbclient to force encryption on initial connection\. This command is new with Samba 3\.2\. 817 .RE 818 .PP 819 posix_open <filename> <octal mode> 820 .RS 4 821 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\. Opens a remote file using the CIFS UNIX extensions and prints a fileid\. Used for internal Samba testing purposes\. 822 .RE 823 .PP 824 posix_mkdir <directoryname> <octal mode> 825 .RS 4 826 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\. Creates a remote directory using the CIFS UNIX extensions with the given mode\. 827 .RE 828 .PP 829 posix_rmdir <directoryname> 830 .RS 4 831 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\. Deletes a remote directory using the CIFS UNIX extensions\. 832 .RE 833 .PP 834 posix_unlink <filename> 835 .RS 4 836 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\. Deletes a remote file using the CIFS UNIX extensions\. 636 837 .RE 637 838 .PP 638 839 print <file name> 639 .RS 3n640 Print the specified file from the local machine through a printable service on the server .840 .RS 4 841 Print the specified file from the local machine through a printable service on the server\. 641 842 .RE 642 843 .PP 643 844 prompt 644 .RS 3n645 Toggle prompting for filenames during operation of the mget and mput commands .646 .sp 647 When toggled ON, the user will be prompted to confirm the transfer of each file during these commands . When toggled OFF, all specified files will be transferred without prompting.845 .RS 4 846 Toggle prompting for filenames during operation of the mget and mput commands\. 847 .sp 848 When toggled ON, the user will be prompted to confirm the transfer of each file during these commands\. When toggled OFF, all specified files will be transferred without prompting\. 648 849 .RE 649 850 .PP 650 851 put <local file name> [remote file name] 651 .RS 3n852 .RS 4 652 853 Copy the file called 653 854 \fIlocal file name\fR 654 from the machine running the client to the server . If specified, name the remote copy655 \fIremote file name\fR . Note that all transfers in855 from the machine running the client to the server\. If specified, name the remote copy 856 \fIremote file name\fR\. Note that all transfers in 656 857 smbclient 657 are binary . See also the lowercase command.858 are binary\. See also the lowercase command\. 658 859 .RE 659 860 .PP 660 861 queue 661 .RS 3n662 Displays the print queue, showing the job id, name, size and current status .862 .RS 4 863 Displays the print queue, showing the job id, name, size and current status\. 663 864 .RE 664 865 .PP 665 866 quit 666 .RS 3n667 See the exit command .867 .RS 4 868 See the exit command\. 668 869 .RE 669 870 .PP 670 871 rd <directory name> 671 .RS 3n672 See the rmdir command .872 .RS 4 873 See the rmdir command\. 673 874 .RE 674 875 .PP 675 876 recurse 676 .RS 3n677 Toggle directory recursion for the commands mget and mput .678 .sp 679 When toggled ON, these commands will process all directories in the source directory (i .e., the directory they are copying from ) and will recurse into any that match the mask specified to the command. Only files that match the mask specified using the mask command will be retrieved. See also the mask command.680 .sp 681 When recursion is toggled OFF, only files from the current working directory on the source machine that match the mask specified to the mget or mput commands will be copied, and any mask specified using the mask command will be ignored .877 .RS 4 878 Toggle directory recursion for the commands mget and mput\. 879 .sp 880 When toggled ON, these commands will process all directories in the source directory (i\.e\., the directory they are copying from ) and will recurse into any that match the mask specified to the command\. Only files that match the mask specified using the mask command will be retrieved\. See also the mask command\. 881 .sp 882 When recursion is toggled OFF, only files from the current working directory on the source machine that match the mask specified to the mget or mput commands will be copied, and any mask specified using the mask command will be ignored\. 682 883 .RE 683 884 .PP 684 885 rm <mask> 685 .RS 3n886 .RS 4 686 887 Remove all files matching 687 888 \fImask\fR 688 from the current working directory on the server .889 from the current working directory on the server\. 689 890 .RE 690 891 .PP 691 892 rmdir <directory name> 692 .RS 3n693 Remove the specified directory (user access privileges permitting) from the server .694 .RE 695 .PP 696 setmode <filename> <perm=[+|\ -]rsha>697 .RS 3n698 A version of the DOS attrib command to set file permissions . For example:893 .RS 4 894 Remove the specified directory (user access privileges permitting) from the server\. 895 .RE 896 .PP 897 setmode <filename> <perm=[+|\e\-]rsha> 898 .RS 4 899 A version of the DOS attrib command to set file permissions\. For example: 699 900 .sp 700 901 setmode myfile +r 701 902 .sp 702 would make myfile read only. 903 would make myfile read only\. 904 .RE 905 .PP 906 showconnect 907 .RS 4 908 Show the currently active connection held for DFS purposes\. 703 909 .RE 704 910 .PP 705 911 stat file 706 .RS 3n707 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not . The client requests the UNIX basic info level and prints out the same info that the Linux stat command would about the file. This includes the size, blocks used on disk, file type, permissions, inode number, number of links and finally the three timestamps (access, modify and change). If the file is a special file (symlink, character or block device, fifo or socket) then extra information may also be printed.912 .RS 4 913 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\. The client requests the UNIX basic info level and prints out the same info that the Linux stat command would about the file\. This includes the size, blocks used on disk, file type, permissions, inode number, number of links and finally the three timestamps (access, modify and change)\. If the file is a special file (symlink, character or block device, fifo or socket) then extra information may also be printed\. 708 914 .RE 709 915 .PP 710 916 symlink target linkname 711 .RS 3n712 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not . The client requests that the server create a symbolic hard link between the target and linkname files. The linkname file must not exist. Note that the server will not create a link to any path that lies outside the currently connected share. This is enforced by the Samba server.917 .RS 4 918 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\. The client requests that the server create a symbolic hard link between the target and linkname files\. The linkname file must not exist\. Note that the server will not create a link to any path that lies outside the currently connected share\. This is enforced by the Samba server\. 713 919 .RE 714 920 .PP 715 921 tar <c|x>[IXbgNa] 716 .RS 3n717 Performs a tar operation - see the718 \fI -T \fR719 command line option above . Behavior may be affected by the tarmode command (see below). Using g (incremental) and N (newer) will affect tarmode settings. Note that using the "-" option with tar x may not work - use the command line option instead.922 .RS 4 923 Performs a tar operation \- see the 924 \fI\-T \fR 925 command line option above\. Behavior may be affected by the tarmode command (see below)\. Using g (incremental) and N (newer) will affect tarmode settings\. Note that using the "\-" option with tar x may not work \- use the command line option instead\. 720 926 .RE 721 927 .PP 722 928 blocksize <blocksize> 723 .RS 3n724 Blocksize . Must be followed by a valid (greater than zero) blocksize. Causes tar file to be written out in725 \fIblocksize\fR*TBLOCK (usually 512 byte) blocks .929 .RS 4 930 Blocksize\. Must be followed by a valid (greater than zero) blocksize\. Causes tar file to be written out in 931 \fIblocksize\fR*TBLOCK (usually 512 byte) blocks\. 726 932 .RE 727 933 .PP 728 934 tarmode <full|inc|reset|noreset> 729 .RS 3n 730 Changes tar's behavior with regard to archive bits. In full mode, tar will back up everything regardless of the archive bit setting (this is the default mode). In incremental mode, tar will only back up files with the archive bit set. In reset mode, tar will reset the archive bit on all files it backs up (implies read/write share). 935 .RS 4 936 Changes tar\'s behavior with regard to archive bits\. In full mode, tar will back up everything regardless of the archive bit setting (this is the default mode)\. In incremental mode, tar will only back up files with the archive bit set\. In reset mode, tar will reset the archive bit on all files it backs up (implies read/write share)\. 937 .RE 938 .PP 939 unlock <filenum> <hex\-start> <hex\-len> 940 .RS 4 941 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\. Tries to unlock a POSIX fcntl lock on the given range\. Used for internal Samba testing purposes\. 942 .RE 943 .PP 944 volume 945 .RS 4 946 Prints the current volume name of the share\. 947 .RE 948 .PP 949 vuid <number> 950 .RS 4 951 Changes the currently used vuid in the protocol to the given arbitrary number\. Without an argument prints out the current vuid being used\. Used for internal Samba testing purposes\. 731 952 .RE 732 953 .SH "NOTES" 733 954 .PP 734 Some servers are fussy about the case of supplied usernames, passwords, share names (AKA service names) and machine names . If you fail to connect try giving all parameters in uppercase.735 .PP 736 It is often necessary to use the -n option when connecting to some types of servers. For example OS/2 LanManager insists on a valid NetBIOS name being used, so you need to supply a valid name that would be known to the server.737 .PP 738 smbclient supports long file names where the server supports the LANMAN2 protocol or above .955 Some servers are fussy about the case of supplied usernames, passwords, share names (AKA service names) and machine names\. If you fail to connect try giving all parameters in uppercase\. 956 .PP 957 It is often necessary to use the \-n option when connecting to some types of servers\. For example OS/2 LanManager insists on a valid NetBIOS name being used, so you need to supply a valid name that would be known to the server\. 958 .PP 959 smbclient supports long file names where the server supports the LANMAN2 protocol or above\. 739 960 .SH "ENVIRONMENT VARIABLES" 740 961 .PP 741 962 The variable 742 963 \fBUSER\fR 743 may contain the username of the person using the client . This information is used only if the protocol level is high enough to support session-level passwords.964 may contain the username of the person using the client\. This information is used only if the protocol level is high enough to support session\-level passwords\. 744 965 .PP 745 966 The variable 746 967 \fBPASSWD\fR 747 may contain the password of the person using the client . This information is used only if the protocol level is high enough to support session-level passwords.968 may contain the password of the person using the client\. This information is used only if the protocol level is high enough to support session\-level passwords\. 748 969 .PP 749 970 The variable 750 971 \fBLIBSMB_PROG\fR 751 may contain the path, executed with system(), which the client should connect to instead of connecting to a server . This functionality is primarily intended as a development aid, and works best when using a LMHOSTS file972 may contain the path, executed with system(), which the client should connect to instead of connecting to a server\. This functionality is primarily intended as a development aid, and works best when using a LMHOSTS file 752 973 .SH "INSTALLATION" 753 974 .PP 754 The location of the client program is a matter for individual system administrators . The following are thus suggestions only.975 The location of the client program is a matter for individual system administrators\. The following are thus suggestions only\. 755 976 .PP 756 977 It is recommended that the smbclient software be installed in the … … 758 979 or 759 980 \fI /usr/samba/bin/\fR 760 directory, this directory readable by all, writeable only by root . The client program itself should be executable by all. The client should761 \f BNOT\fR981 directory, this directory readable by all, writeable only by root\. The client program itself should be executable by all\. The client should 982 \fINOT\fR 762 983 be setuid or setgid! 763 984 .PP 764 The client log files should be put in a directory readable and writeable only by the user .765 .PP 766 To test the client, you will need to know the name of a running SMB/CIFS server . It is possible to run985 The client log files should be put in a directory readable and writeable only by the user\. 986 .PP 987 To test the client, you will need to know the name of a running SMB/CIFS server\. It is possible to run 767 988 \fBsmbd\fR(8) 768 as an ordinary user - running that server as a daemon on a user-accessible port (typically any port number over 1024) would provide a suitable test server.989 as an ordinary user \- running that server as a daemon on a user\-accessible port (typically any port number over 1024) would provide a suitable test server\. 769 990 .SH "DIAGNOSTICS" 770 991 .PP 771 Most diagnostics issued by the client are logged in a specified log file . The log file name is specified at compile time, but may be overridden on the command line.772 .PP 773 The number and nature of diagnostics available depends on the debug level used by the client . If you have problems, set the debug level to 3 and peruse the log files.992 Most diagnostics issued by the client are logged in a specified log file\. The log file name is specified at compile time, but may be overridden on the command line\. 993 .PP 994 The number and nature of diagnostics available depends on the debug level used by the client\. If you have problems, set the debug level to 3 and peruse the log files\. 774 995 .SH "VERSION" 775 996 .PP 776 This man page is correct for version 3 of the Samba suite.997 This man page is correct for version 3\.2 of the Samba suite\. 777 998 .SH "AUTHOR" 778 999 .PP 779 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 780 .PP 781 The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 782 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 783 1000 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 1001 .PP 1002 The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 1003 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/smbcontrol.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBCONTROL" 1 "" "" "" 1 .\" Title: smbcontrol 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBCONTROL" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbcontrol - send messages to smbd, nmbd or winbindd processes 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 smbcontrol [ -i] [-s]17 smbcontrol [\-i] [\-s] 26 18 .HP 1 27 smbcontrol [destination] [message -type] [parameter]19 smbcontrol [destination] [message\-type] [parameter] 28 20 .SH "DESCRIPTION" 29 21 .PP 30 22 This tool is part of the 31 23 \fBsamba\fR(7) 32 suite .24 suite\. 33 25 .PP 34 26 smbcontrol … … 37 29 \fBnmbd\fR(8), or a 38 30 \fBwinbindd\fR(8) 39 daemon running on the system .31 daemon running on the system\. 40 32 .SH "OPTIONS" 41 33 .PP 42 -h|--help43 .RS 3n44 Print a summary of command line options .45 .RE 46 .PP 47 -s <configuration file>48 .RS 3n49 The file specified contains the configuration details required by the server . The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See50 \fIsmb .conf\fR51 for more information . The default configuration file name is determined at compile time.52 .RE 53 .PP 54 -i55 .RS 3n56 Run interactively . Individual commands of the form destination message-type parameters can be entered on STDIN. An empty command line or a "q" will quit the program.34 \-h|\-\-help 35 .RS 4 36 Print a summary of command line options\. 37 .RE 38 .PP 39 \-s <configuration file> 40 .RS 4 41 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 42 \fIsmb\.conf\fR 43 for more information\. The default configuration file name is determined at compile time\. 44 .RE 45 .PP 46 \-i 47 .RS 4 48 Run interactively\. Individual commands of the form destination message\-type parameters can be entered on STDIN\. An empty command line or a "q" will quit the program\. 57 49 .RE 58 50 .PP 59 51 destination 60 .RS 3n52 .RS 4 61 53 One of 62 54 \fInmbd\fR, 63 55 \fIsmbd\fR 64 or a process ID .56 or a process ID\. 65 57 .sp 66 58 The 67 59 \fIsmbd\fR 68 destination causes the message to "broadcast" to all smbd daemons .60 destination causes the message to "broadcast" to all smbd daemons\. 69 61 .sp 70 62 The 71 63 \fInmbd\fR 72 64 destination causes the message to be sent to the nmbd daemon specified in the 73 \fInmbd .pid\fR74 file .75 .sp 76 If a single process ID is given, the message is sent to only that process .77 .RE 78 .PP 79 message -type80 .RS 3n81 Type of message to send . See the section82 \fBMESSAGE -TYPES\fR83 for details .65 \fInmbd\.pid\fR 66 file\. 67 .sp 68 If a single process ID is given, the message is sent to only that process\. 69 .RE 70 .PP 71 message\-type 72 .RS 4 73 Type of message to send\. See the section 74 \fBMESSAGE\-TYPES\fR 75 for details\. 84 76 .RE 85 77 .PP 86 78 parameters 87 .RS 3n88 any parameters required for the message -type79 .RS 4 80 any parameters required for the message\-type 89 81 .RE 90 82 .SH "MESSAGE-TYPES" … … 92 84 Available message types are: 93 85 .PP 94 close -share95 .RS 3n96 Order smbd to close the client connections to the named share . Note that this doesn't affect client connections to any other shares. This message-type takes an argument of the share name for which client connections will be closed, or the "*" character which will close all currently open shares. This may be useful if you made changes to the access controls on the share. This message can only be sent to97 \fBsmbd\fR .86 close\-share 87 .RS 4 88 Order smbd to close the client connections to the named share\. Note that this doesn\'t affect client connections to any other shares\. This message\-type takes an argument of the share name for which client connections will be closed, or the "*" character which will close all currently open shares\. This may be useful if you made changes to the access controls on the share\. This message can only be sent to 89 \fBsmbd\fR\. 98 90 .RE 99 91 .PP 100 92 debug 101 .RS 3n102 Set debug level to the value specified by the parameter . This can be sent to any of the destinations.103 .RE 104 .PP 105 force -election106 .RS 3n93 .RS 4 94 Set debug level to the value specified by the parameter\. This can be sent to any of the destinations\. 95 .RE 96 .PP 97 force\-election 98 .RS 4 107 99 This message causes the 108 100 nmbd 109 daemon to force a new browse master election .101 daemon to force a new browse master election\. 110 102 .RE 111 103 .PP 112 104 ping 113 .RS 3n114 Send specified number of "ping" messages and wait for the same number of reply "pong" messages . This can be sent to any of the destinations.105 .RS 4 106 Send specified number of "ping" messages and wait for the same number of reply "pong" messages\. This can be sent to any of the destinations\. 115 107 .RE 116 108 .PP 117 109 profile 118 .RS 3n119 Change profile settings of a daemon, based on the parameter . The parameter can be "on" to turn on profile stats collection, "off" to turn off profile stats collection, "count" to enable only collection of count stats (time stats are disabled), and "flush" to zero the current profile stats. This can be sent to any smbd or nmbd destinations.110 .RS 4 111 Change profile settings of a daemon, based on the parameter\. The parameter can be "on" to turn on profile stats collection, "off" to turn off profile stats collection, "count" to enable only collection of count stats (time stats are disabled), and "flush" to zero the current profile stats\. This can be sent to any smbd or nmbd destinations\. 120 112 .RE 121 113 .PP 122 114 debuglevel 123 .RS 3n124 Request debuglevel of a certain daemon and write it to stdout . This can be sent to any of the destinations.115 .RS 4 116 Request debuglevel of a certain daemon and write it to stdout\. This can be sent to any of the destinations\. 125 117 .RE 126 118 .PP 127 119 profilelevel 128 .RS 3n129 Request profilelevel of a certain daemon and write it to stdout . This can be sent to any smbd or nmbd destinations.120 .RS 4 121 Request profilelevel of a certain daemon and write it to stdout\. This can be sent to any smbd or nmbd destinations\. 130 122 .RE 131 123 .PP 132 124 printnotify 133 .RS 3n 134 Order smbd to send a printer notify message to any Windows NT clients connected to a printer. This message-type takes the following arguments: 135 136 .RS 3n 125 .RS 4 126 Order smbd to send a printer notify message to any Windows NT clients connected to a printer\. This message\-type takes the following arguments: 137 127 .PP 138 128 queuepause printername 139 .RS 3n140 Send a queue pause change notify message to the printer specified .129 .RS 4 130 Send a queue pause change notify message to the printer specified\. 141 131 .RE 142 132 .PP 143 133 queueresume printername 144 .RS 3n145 Send a queue resume change notify message for the printer specified .134 .RS 4 135 Send a queue resume change notify message for the printer specified\. 146 136 .RE 147 137 .PP 148 138 jobpause printername unixjobid 149 .RS 3n150 Send a job pause change notify message for the printer and unix jobid specified .139 .RS 4 140 Send a job pause change notify message for the printer and unix jobid specified\. 151 141 .RE 152 142 .PP 153 143 jobresume printername unixjobid 154 .RS 3n155 Send a job resume change notify message for the printer and unix jobid specified .144 .RS 4 145 Send a job resume change notify message for the printer and unix jobid specified\. 156 146 .RE 157 147 .PP 158 148 jobdelete printername unixjobid 159 .RS 3n 160 Send a job delete change notify message for the printer and unix jobid specified. 161 .RE 162 .RE 163 .IP "" 3n 164 Note that this message only sends notification that an event has occured. It doesn't actually cause the event to happen. 149 .RS 4 150 Send a job delete change notify message for the printer and unix jobid specified\. 151 .RE 152 .sp 153 Note that this message only sends notification that an event has occured\. It doesn\'t actually cause the event to happen\. 165 154 .sp 166 155 This message can only be sent to 167 \fBsmbd\fR .156 \fBsmbd\fR\. 168 157 .RE 169 158 .PP 170 159 samsync 171 .RS 3n172 Order smbd to synchronise sam database from PDC (being BDC) . Can only be sent to173 \fBsmbd\fR .160 .RS 4 161 Order smbd to synchronise sam database from PDC (being BDC)\. Can only be sent to 162 \fBsmbd\fR\. 174 163 .sp 175 164 .it 1 an-trap … … 177 166 .nr an-break-flag 1 178 167 .br 179 \fBNote\fR 168 Note 180 169 Not working at the moment 181 170 .RE 182 171 .PP 183 172 samrepl 184 .RS 3n185 Send sam replication message, with specified serial . Can only be sent to186 \fBsmbd\fR . Should not be used manually.187 .RE 188 .PP 189 dmalloc -mark190 .RS 3n191 Set a mark for dmalloc . Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support.192 .RE 193 .PP 194 dmalloc -log-changed195 .RS 3n196 Dump the pointers that have changed since the mark set by dmalloc -mark. Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support.173 .RS 4 174 Send sam replication message, with specified serial\. Can only be sent to 175 \fBsmbd\fR\. Should not be used manually\. 176 .RE 177 .PP 178 dmalloc\-mark 179 .RS 4 180 Set a mark for dmalloc\. Can be sent to both smbd and nmbd\. Only available if samba is built with dmalloc support\. 181 .RE 182 .PP 183 dmalloc\-log\-changed 184 .RS 4 185 Dump the pointers that have changed since the mark set by dmalloc\-mark\. Can be sent to both smbd and nmbd\. Only available if samba is built with dmalloc support\. 197 186 .RE 198 187 .PP 199 188 shutdown 200 .RS 3n201 Shut down specified daemon . Can be sent to both smbd and nmbd.202 .RE 203 .PP 204 pool -usage205 .RS 3n206 Print a human -readable description of all talloc(pool) memory usage by the specified daemon/process. Available for both smbd and nmbd.189 .RS 4 190 Shut down specified daemon\. Can be sent to both smbd and nmbd\. 191 .RE 192 .PP 193 pool\-usage 194 .RS 4 195 Print a human\-readable description of all talloc(pool) memory usage by the specified daemon/process\. Available for both smbd and nmbd\. 207 196 .RE 208 197 .PP 209 198 drvupgrade 210 .RS 3n211 Force clients of printers using specified driver to update their local version of the driver . Can only be sent to smbd.212 .RE 213 .PP 214 reload -config215 .RS 3n216 Force daemon to reload smb .conf configuration file. Can be sent to199 .RS 4 200 Force clients of printers using specified driver to update their local version of the driver\. Can only be sent to smbd\. 201 .RE 202 .PP 203 reload\-config 204 .RS 4 205 Force daemon to reload smb\.conf configuration file\. Can be sent to 217 206 \fBsmbd\fR, 218 207 \fBnmbd\fR, or 219 \fBwinbindd\fR .208 \fBwinbindd\fR\. 220 209 .RE 221 210 .SH "VERSION" 222 211 .PP 223 This man page is correct for version 3 .0 of the Samba suite.212 This man page is correct for version 3\.0 of the Samba suite\. 224 213 .SH "SEE ALSO" 225 214 .PP 226 215 \fBnmbd\fR(8) 227 216 and 228 \fBsmbd\fR(8) .217 \fBsmbd\fR(8)\. 229 218 .SH "AUTHOR" 230 219 .PP 231 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 232 .PP 233 The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 234 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 235 220 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 221 .PP 222 The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 223 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/smbcquotas.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBCQUOTAS" 1 "" "" "" 1 .\" Title: smbcquotas 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBCQUOTAS" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbcquotas - Set or get QUOTAs of NTFS 5 shares 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 smbcquotas {//server/share} [ -u user] [-L] [-F] [-S QUOTA_SET_COMMAND] [-n] [-t] [-v] [-d debuglevel] [-s configfile] [-l logdir] [-V] [-U username] [-N] [-k] [-A]17 smbcquotas {//server/share} [\-u\ user] [\-L] [\-F] [\-S\ QUOTA_SET_COMMAND] [\-n] [\-t] [\-v] [\-d\ debuglevel] [\-s\ configfile] [\-l\ logdir] [\-V] [\-U\ username] [\-N] [\-k] [\-A] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The 33 25 smbcquotas 34 program manipulates NT Quotas on SMB file shares .26 program manipulates NT Quotas on SMB file shares\. 35 27 .SH "OPTIONS" 36 28 .PP 37 29 The following options are available to the 38 30 smbcquotas 39 program .31 program\. 40 32 .PP 41 -u user42 .RS 3n43 Specifies the user of whom the quotas are get or set . By default the current user's username will be used.33 \-u user 34 .RS 4 35 Specifies the user of whom the quotas are get or set\. By default the current user\'s username will be used\. 44 36 .RE 45 37 .PP 46 -L47 .RS 3n48 Lists all quota records of the share .38 \-L 39 .RS 4 40 Lists all quota records of the share\. 49 41 .RE 50 42 .PP 51 -F52 .RS 3n53 Show the share quota status and default limits .43 \-F 44 .RS 4 45 Show the share quota status and default limits\. 54 46 .RE 55 47 .PP 56 -S QUOTA_SET_COMMAND57 .RS 3n58 This command sets/modifies quotas for a user or on the share, depending on the QUOTA_SET_COMMAND parameter which is described later .48 \-S QUOTA_SET_COMMAND 49 .RS 4 50 This command sets/modifies quotas for a user or on the share, depending on the QUOTA_SET_COMMAND parameter which is described later\. 59 51 .RE 60 52 .PP 61 -n62 .RS 3n63 This option displays all QUOTA information in numeric format . The default is to convert SIDs to names and QUOTA limits to a readable string format.53 \-n 54 .RS 4 55 This option displays all QUOTA information in numeric format\. The default is to convert SIDs to names and QUOTA limits to a readable string format\. 64 56 .RE 65 57 .PP 66 -t67 .RS 3n68 Don 't actually do anything, only validate the correctness of the arguments.58 \-t 59 .RS 4 60 Don\'t actually do anything, only validate the correctness of the arguments\. 69 61 .RE 70 62 .PP 71 -v72 .RS 3n73 Be verbose .63 \-v 64 .RS 4 65 Be verbose\. 74 66 .RE 75 67 .PP 76 -h|--help77 .RS 3n78 Print a summary of command line options .68 \-h|\-\-help 69 .RS 4 70 Print a summary of command line options\. 79 71 .RE 80 72 .PP 81 -V 82 .RS 3n 83 Prints the program version number. 73 \-d|\-\-debuglevel=level 74 .RS 4 75 \fIlevel\fR 76 is an integer from 0 to 10\. The default value if this parameter is not specified is 0\. 77 .sp 78 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 79 .sp 80 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 81 .sp 82 Note that specifying this parameter here will override the 83 \fIlog level\fR 84 parameter in the 85 \fIsmb\.conf\fR 86 file\. 84 87 .RE 85 88 .PP 86 -s <configuration file> 87 .RS 3n 88 The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See 89 \fIsmb.conf\fR 90 for more information. The default configuration file name is determined at compile time. 89 \-V 90 .RS 4 91 Prints the program version number\. 91 92 .RE 92 93 .PP 93 -d|--debuglevel=level 94 .RS 3n 95 \fIlevel\fR 96 is an integer from 0 to 10. The default value if this parameter is not specified is zero. 97 .sp 98 The higher this value, the more detail will be logged to the log files about the activities of the server. At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out. 99 .sp 100 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic. 101 .sp 102 Note that specifying this parameter here will override the 103 104 parameter in the 105 \fIsmb.conf\fR 106 file. 94 \-s <configuration file> 95 .RS 4 96 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 97 \fIsmb\.conf\fR 98 for more information\. The default configuration file name is determined at compile time\. 107 99 .RE 108 100 .PP 109 -l|--logfile=logdirectory110 .RS 3n111 Base directory name for log/debug files . The extension112 \fB" .progname"\fR113 will be appended (e .g. log.smbclient, log.smbd, etc...). The log file is never removed by the client.101 \-l|\-\-log\-basename=logdirectory 102 .RS 4 103 Base directory name for log/debug files\. The extension 104 \fB"\.progname"\fR 105 will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\. 114 106 .RE 115 107 .PP 116 -N117 .RS 3n118 If specified, this parameter suppresses the normal password prompt from the client to the user . This is useful when accessing a service that does not require a password.108 \-N 109 .RS 4 110 If specified, this parameter suppresses the normal password prompt from the client to the user\. This is useful when accessing a service that does not require a password\. 119 111 .sp 120 Unless a password is specified on the command line or this parameter is specified, the client will request a password .112 Unless a password is specified on the command line or this parameter is specified, the client will request a password\. 121 113 .sp 122 If a password is specified on the command line and this option is also defined the password on the command line will be silently ingnored and no password will be used .114 If a password is specified on the command line and this option is also defined the password on the command line will be silently ingnored and no password will be used\. 123 115 .RE 124 116 .PP 125 -k126 .RS 3n127 Try to authenticate with kerberos . Only useful in an Active Directory environment.117 \-k 118 .RS 4 119 Try to authenticate with kerberos\. Only useful in an Active Directory environment\. 128 120 .RE 129 121 .PP 130 -A|--authentication-file=filename131 .RS 3n132 This option allows you to specify a file from which to read the username and password used in the connection . The format of the file is122 \-A|\-\-authentication\-file=filename 123 .RS 4 124 This option allows you to specify a file from which to read the username and password used in the connection\. The format of the file is 133 125 .sp 134 135 126 .sp 136 127 .RS 4 137 128 .nf 138 139 129 username = <value> 140 130 password = <value> 141 131 domain = <value> 142 143 132 .fi 144 133 .RE 145 134 .sp 146 Make certain that the permissions on the file restrict access from unwanted users .135 Make certain that the permissions on the file restrict access from unwanted users\. 147 136 .RE 148 137 .PP 149 -U|--user=username[%password]150 .RS 3n151 Sets the SMB username or username and password .138 \-U|\-\-user=username[%password] 139 .RS 4 140 Sets the SMB username or username and password\. 152 141 .sp 153 If %password is not specified, the user will be prompted . The client will first check the142 If %password is not specified, the user will be prompted\. The client will first check the 154 143 \fBUSER\fR 155 144 environment variable, then the 156 145 \fBLOGNAME\fR 157 variable and if either exists, the string is uppercased . If these environmental variables are not found, the username146 variable and if either exists, the string is uppercased\. If these environmental variables are not found, the username 158 147 \fBGUEST\fR 159 is used .148 is used\. 160 149 .sp 161 A third option is to use a credentials file which contains the plaintext of the username and password . This option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables. If this method is used, make certain that the permissions on the file restrict access from unwanted users. See the162 \fI -A\fR163 for more details .150 A third option is to use a credentials file which contains the plaintext of the username and password\. This option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables\. If this method is used, make certain that the permissions on the file restrict access from unwanted users\. See the 151 \fI\-A\fR 152 for more details\. 164 153 .sp 165 Be cautious about including passwords in scripts . Also, on many systems the command line of a running process may be seen via the154 Be cautious about including passwords in scripts\. Also, on many systems the command line of a running process may be seen via the 166 155 ps 167 command . To be safe always allow156 command\. To be safe always allow 168 157 rpcclient 169 to prompt for a password and type it in directly .158 to prompt for a password and type it in directly\. 170 159 .RE 171 160 .SH "QUOTA_SET_COMAND" 172 161 .PP 173 The format of an the QUOTA_SET_COMMAND is an operation name followed by a set of parameters specific to that operation .162 The format of an the QUOTA_SET_COMMAND is an operation name followed by a set of parameters specific to that operation\. 174 163 .PP 175 To set user quotas for the user specified by -u or for the current username:164 To set user quotas for the user specified by \-u or for the current username: 176 165 .PP 177 166 \fB UQLIM:<username>:<softlimit>/<hardlimit> \fR … … 185 174 \fB FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT \fR 186 175 .PP 187 All limits are specified as a number of bytes .176 All limits are specified as a number of bytes\. 188 177 .SH "EXIT STATUS" 189 178 .PP 190 179 The 191 180 smbcquotas 192 program sets the exit status depending on the success or otherwise of the operations performed . The exit status may be one of the following values.181 program sets the exit status depending on the success or otherwise of the operations performed\. The exit status may be one of the following values\. 193 182 .PP 194 If the operation succeeded, smbcquotas returns an exit status of 0 . If183 If the operation succeeded, smbcquotas returns an exit status of 0\. If 195 184 smbcquotas 196 couldn 't connect to the specified server, or when there was an error getting or setting the quota(s), an exit status of 1 is returned. If there was an error parsing any command line arguments, an exit status of 2 is returned.185 couldn\'t connect to the specified server, or when there was an error getting or setting the quota(s), an exit status of 1 is returned\. If there was an error parsing any command line arguments, an exit status of 2 is returned\. 197 186 .SH "VERSION" 198 187 .PP 199 This man page is correct for version 3 .0 of the Samba suite.188 This man page is correct for version 3\.0 of the Samba suite\. 200 189 .SH "AUTHOR" 201 190 .PP 202 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.191 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 203 192 .PP 204 193 smbcquotas 205 was written by Stefan Metzmacher. 206 194 was written by Stefan Metzmacher\. -
branches/samba-3.0/docs/manpages/smbd.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBD" 8 "" "" "" 1 .\" Title: smbd 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBD" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbd - server to provide SMB/CIFS services to clients 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 smbd [ -D] [-F] [-S] [-i] [-h] [-V] [-b] [-d <debug level>] [-l <log directory>] [-p <port number(s)>] [-P <profiling level>] [-O <socket option>] [-s <configurationfile>]17 smbd [\-D] [\-F] [\-S] [\-i] [\-h] [\-V] [\-b] [\-d\ <debug\ level>] [\-l\ <log\ directory>] [\-p\ <port\ number(s)>] [\-P\ <profiling\ level>] [\-O\ <socket\ option>] [\-s\ <configuration\ file>] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This program is part of the 29 21 \fBsamba\fR(7) 30 suite .31 .PP 32 smbd 33 is the server daemon that provides filesharing and printing services to Windows clients . The server provides filespace and printer services to clients using the SMB (or CIFS) protocol. This is compatible with the LanManager protocol, and can service LanManager clients. These include MSCLIENT 3.0 for DOS, Windows for Workgroups, Windows 95/98/ME, Windows NT, Windows 2000, OS/2, DAVE for Macintosh, and smbfs for Linux.22 suite\. 23 .PP 24 smbd 25 is the server daemon that provides filesharing and printing services to Windows clients\. The server provides filespace and printer services to clients using the SMB (or CIFS) protocol\. This is compatible with the LanManager protocol, and can service LanManager clients\. These include MSCLIENT 3\.0 for DOS, Windows for Workgroups, Windows 95/98/ME, Windows NT, Windows 2000, OS/2, DAVE for Macintosh, and smbfs for Linux\. 34 26 .PP 35 27 An extensive description of the services that the server can provide is given in the man page for the configuration file controlling the attributes of those services (see 36 \fBsmb.conf\fR(5) . This man page will not describe the services, but will concentrate on the administrative aspects of running the server.28 \fBsmb.conf\fR(5)\. This man page will not describe the services, but will concentrate on the administrative aspects of running the server\. 37 29 .PP 38 30 Please note that there are significant security implications to running this server, and the 39 31 \fBsmb.conf\fR(5) 40 manual page should be regarded as mandatory reading before proceeding with installation .41 .PP 42 A session is created whenever a client requests one . Each client gets a copy of the server for each session. This copy then services all connections made by the client during that session. When all connections from its client are closed, the copy of the server for that client terminates.43 .PP 44 The configuration file, and any files that it includes, are automatically reloaded every minute, if they change . You can force a reload by sending a SIGHUP to the server. Reloading the configuration file will not affect connections to any service that is already established. Either the user will have to disconnect from the service, or45 smbd 46 killed and restarted .32 manual page should be regarded as mandatory reading before proceeding with installation\. 33 .PP 34 A session is created whenever a client requests one\. Each client gets a copy of the server for each session\. This copy then services all connections made by the client during that session\. When all connections from its client are closed, the copy of the server for that client terminates\. 35 .PP 36 The configuration file, and any files that it includes, are automatically reloaded every minute, if they change\. You can force a reload by sending a SIGHUP to the server\. Reloading the configuration file will not affect connections to any service that is already established\. Either the user will have to disconnect from the service, or 37 smbd 38 killed and restarted\. 47 39 .SH "OPTIONS" 48 40 .PP 49 -D50 .RS 3n51 If specified, this parameter causes the server to operate as a daemon . That is, it detaches itself and runs in the background, fielding requests on the appropriate port. Operating the server as a daemon is the recommended way of running52 smbd 53 for servers that provide more than casual use file and print services . This switch is assumed if54 smbd 55 is executed on the command line of a shell .56 .RE 57 .PP 58 -F59 .RS 3n41 \-D 42 .RS 4 43 If specified, this parameter causes the server to operate as a daemon\. That is, it detaches itself and runs in the background, fielding requests on the appropriate port\. Operating the server as a daemon is the recommended way of running 44 smbd 45 for servers that provide more than casual use file and print services\. This switch is assumed if 46 smbd 47 is executed on the command line of a shell\. 48 .RE 49 .PP 50 \-F 51 .RS 4 60 52 If specified, this parameter causes the main 61 53 smbd 62 process to not daemonize, i .e. double-fork and disassociate with the terminal. Child processes are still created as normal to service each connection request, but the main process does not exit. This operation mode is suitable for running54 process to not daemonize, i\.e\. double\-fork and disassociate with the terminal\. Child processes are still created as normal to service each connection request, but the main process does not exit\. This operation mode is suitable for running 63 55 smbd 64 56 under process supervisors such as … … 66 58 and 67 59 svscan 68 from Daniel J . Bernstein's60 from Daniel J\. Bernstein\'s 69 61 daemontools 70 package, or the AIX process monitor .71 .RE 72 .PP 73 -S74 .RS 3n62 package, or the AIX process monitor\. 63 .RE 64 .PP 65 \-S 66 .RS 4 75 67 If specified, this parameter causes 76 68 smbd 77 to log to standard output rather than a file .78 .RE 79 .PP 80 -i81 .RS 3n82 If this parameter is specified it causes the server to run "interactively", not as a daemon, even if the server is executed on the command line of a shell . Setting this parameter negates the implicit deamon mode when run from the command line.69 to log to standard output rather than a file\. 70 .RE 71 .PP 72 \-i 73 .RS 4 74 If this parameter is specified it causes the server to run "interactively", not as a daemon, even if the server is executed on the command line of a shell\. Setting this parameter negates the implicit deamon mode when run from the command line\. 83 75 smbd 84 76 also logs to standard output, as if the 85 -S 86 parameter had been given. 87 .RE 88 .PP 89 -V 90 .RS 3n 91 Prints the program version number. 92 .RE 93 .PP 94 -s <configuration file> 95 .RS 3n 96 The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See 97 \fIsmb.conf\fR 98 for more information. The default configuration file name is determined at compile time. 99 .RE 100 .PP 101 -d|--debuglevel=level 102 .RS 3n 77 \-S 78 parameter had been given\. 79 .RE 80 .PP 81 \-d|\-\-debuglevel=level 82 .RS 4 103 83 \fIlevel\fR 104 is an integer from 0 to 10 . The default value if this parameter is not specified is zero.105 .sp 106 The higher this value, the more detail will be logged to the log files about the activities of the server . At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out.107 .sp 108 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem . Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic.84 is an integer from 0 to 10\. The default value if this parameter is not specified is 0\. 85 .sp 86 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 87 .sp 88 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 109 89 .sp 110 90 Note that specifying this parameter here will override the 111 91 \fIlog level\fR 112 92 parameter in the 113 \fIsmb.conf\fR 114 file. 115 .RE 116 .PP 117 -l|--logfile=logdirectory 118 .RS 3n 119 Base directory name for log/debug files. The extension 120 \fB".progname"\fR 121 will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client. 122 .RE 123 .PP 124 -h|--help 125 .RS 3n 126 Print a summary of command line options. 127 .RE 128 .PP 129 -b 130 .RS 3n 131 Prints information about how Samba was built. 132 .RE 133 .PP 134 -p|--port<port number(s)> 135 .RS 3n 93 \fIsmb\.conf\fR 94 file\. 95 .RE 96 .PP 97 \-V 98 .RS 4 99 Prints the program version number\. 100 .RE 101 .PP 102 \-s <configuration file> 103 .RS 4 104 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 105 \fIsmb\.conf\fR 106 for more information\. The default configuration file name is determined at compile time\. 107 .RE 108 .PP 109 \-l|\-\-log\-basename=logdirectory 110 .RS 4 111 Base directory name for log/debug files\. The extension 112 \fB"\.progname"\fR 113 will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\. 114 .RE 115 .PP 116 \-h|\-\-help 117 .RS 4 118 Print a summary of command line options\. 119 .RE 120 .PP 121 \-b 122 .RS 4 123 Prints information about how Samba was built\. 124 .RE 125 .PP 126 \-p|\-\-port<port number(s)> 127 .RS 4 136 128 \fIport number(s)\fR 137 is a space or comma-separated list of TCP ports smbd should listen on. The default value is taken from the 138 ports parameter in 139 \fIsmb.conf\fR 140 .sp 141 The default ports are 139 (used for SMB over NetBIOS over TCP) and port 445 (used for plain SMB over TCP). 142 .RE 143 .PP 144 -P|--profiling-level<profiling level> 145 .RS 3n 129 is a space or comma\-separated list of TCP ports smbd should listen on\. The default value is taken from the 130 \fIports\fR 131 parameter in 132 \fIsmb\.conf\fR 133 .sp 134 The default ports are 139 (used for SMB over NetBIOS over TCP) and port 445 (used for plain SMB over TCP)\. 135 .RE 136 .PP 137 \-P|\-\-profiling\-level<profiling level> 138 .RS 4 146 139 \fIprofiling level\fR 147 is a number specifying the level of profiling data to be collected . 0 turns off profiling, 1 turns on counter profiling only, 2 turns on complete profiling, and 3 resets all profiling data.140 is a number specifying the level of profiling data to be collected\. 0 turns off profiling, 1 turns on counter profiling only, 2 turns on complete profiling, and 3 resets all profiling data\. 148 141 .RE 149 142 .SH "FILES" 150 143 .PP 151 \fI/etc/inetd .conf\fR152 .RS 3n144 \fI/etc/inetd\.conf\fR 145 .RS 4 153 146 If the server is to be run by the 154 147 inetd 155 meta -daemon, this file must contain suitable startup information for the meta-daemon.148 meta\-daemon, this file must contain suitable startup information for the meta\-daemon\. 156 149 .RE 157 150 .PP 158 151 \fI/etc/rc\fR 159 .RS 3n160 or whatever initialization script your system uses) .161 .sp 162 If running the server as a daemon at startup, this file will need to contain an appropriate startup sequence for the server .152 .RS 4 153 or whatever initialization script your system uses)\. 154 .sp 155 If running the server as a daemon at startup, this file will need to contain an appropriate startup sequence for the server\. 163 156 .RE 164 157 .PP 165 158 \fI/etc/services\fR 166 .RS 3n167 If running the server via the meta -daemon168 inetd, this file must contain a mapping of service name (e .g., netbios-ssn) to service port (e.g., 139) and protocol type (e.g., tcp).169 .RE 170 .PP 171 \fI/usr/local/samba/lib/smb .conf\fR172 .RS 3n159 .RS 4 160 If running the server via the meta\-daemon 161 inetd, this file must contain a mapping of service name (e\.g\., netbios\-ssn) to service port (e\.g\., 139) and protocol type (e\.g\., tcp)\. 162 .RE 163 .PP 164 \fI/usr/local/samba/lib/smb\.conf\fR 165 .RS 4 173 166 This is the default location of the 174 167 \fBsmb.conf\fR(5) 175 server configuration file . Other common places that systems install this file are176 \fI/usr/samba/lib/smb .conf\fR168 server configuration file\. Other common places that systems install this file are 169 \fI/usr/samba/lib/smb\.conf\fR 177 170 and 178 \fI/etc/samba/smb .conf\fR.179 .sp 180 This file describes all the services the server is to make available to clients . See171 \fI/etc/samba/smb\.conf\fR\. 172 .sp 173 This file describes all the services the server is to make available to clients\. See 181 174 \fBsmb.conf\fR(5) 182 for more information .175 for more information\. 183 176 .RE 184 177 .SH "LIMITATIONS" … … 186 179 On some systems 187 180 smbd 188 cannot change uid back to root after a setuid() call . Such systems are called trapdoor uid systems. If you have such a system, you will be unable to connect from a client (such as a PC) as two different users at once. Attempts to connect the second user will result in access denied or similar.181 cannot change uid back to root after a setuid() call\. Such systems are called trapdoor uid systems\. If you have such a system, you will be unable to connect from a client (such as a PC) as two different users at once\. Attempts to connect the second user will result in access denied or similar\. 189 182 .SH "ENVIRONMENT VARIABLES" 190 183 .PP 191 184 \fBPRINTER\fR 192 .RS 3n185 .RS 4 193 186 If no printer name is specified to printable services, most systems will use the value of this variable (or 194 187 \fBlp\fR 195 if this variable is not defined) as the name of the printer to use . This is not specific to the server, however.188 if this variable is not defined) as the name of the printer to use\. This is not specific to the server, however\. 196 189 .RE 197 190 .SH "PAM INTERACTION" 198 191 .PP 199 Samba uses PAM for authentication (when presented with a plaintext password), for account checking (is this account disabled?) and for session management . The degree too which samba supports PAM is restricted by the limitations of the SMB protocol and the200 obey pam restrictions 192 Samba uses PAM for authentication (when presented with a plaintext password), for account checking (is this account disabled?) and for session management\. The degree too which samba supports PAM is restricted by the limitations of the SMB protocol and the 193 \fIobey pam restrictions\fR 201 194 \fBsmb.conf\fR(5) 202 paramater. When this is set, the following restrictions apply: 203 .TP 3n 204 \(bu 205 \fBAccount Validation\fR: All accesses to a samba server are checked against PAM to see if the account is vaild, not disabled and is permitted to login at this time. This also applies to encrypted logins. 206 .TP 3n 207 \(bu 208 \fBSession Management\fR: When not using share level secuirty, users must pass PAM's session checks before access is granted. Note however, that this is bypassed in share level secuirty. Note also that some older pam configuration files may need a line added for session support. 195 paramater\. When this is set, the following restrictions apply: 196 .sp 197 .RS 4 198 .ie n \{\ 199 \h'-04'\(bu\h'+03'\c 200 .\} 201 .el \{\ 202 .sp -1 203 .IP \(bu 2.3 204 .\} 205 \fIAccount Validation\fR: All accesses to a samba server are checked against PAM to see if the account is vaild, not disabled and is permitted to login at this time\. This also applies to encrypted logins\. 206 .RE 207 .sp 208 .RS 4 209 .ie n \{\ 210 \h'-04'\(bu\h'+03'\c 211 .\} 212 .el \{\ 213 .sp -1 214 .IP \(bu 2.3 215 .\} 216 \fISession Management\fR: When not using share level secuirty, users must pass PAM\'s session checks before access is granted\. Note however, that this is bypassed in share level secuirty\. Note also that some older pam configuration files may need a line added for session support\. 209 217 .SH "VERSION" 210 218 .PP 211 This man page is correct for version 3 .0 of the Samba suite.219 This man page is correct for version 3\.0 of the Samba suite\. 212 220 .SH "DIAGNOSTICS" 213 221 .PP 214 Most diagnostics issued by the server are logged in a specified log file . The log file name is specified at compile time, but may be overridden on the command line.215 .PP 216 The number and nature of diagnostics available depends on the debug level used by the server . If you have problems, set the debug level to 3 and peruse the log files.217 .PP 218 Most messages are reasonably self -explanatory. Unfortunately, at the time this man page was created, there are too many diagnostics available in the source code to warrant describing each and every diagnostic. At this stage your best bet is still to grep the source code and inspect the conditions that gave rise to the diagnostics you are seeing.222 Most diagnostics issued by the server are logged in a specified log file\. The log file name is specified at compile time, but may be overridden on the command line\. 223 .PP 224 The number and nature of diagnostics available depends on the debug level used by the server\. If you have problems, set the debug level to 3 and peruse the log files\. 225 .PP 226 Most messages are reasonably self\-explanatory\. Unfortunately, at the time this man page was created, there are too many diagnostics available in the source code to warrant describing each and every diagnostic\. At this stage your best bet is still to grep the source code and inspect the conditions that gave rise to the diagnostics you are seeing\. 219 227 .SH "TDB FILES" 220 228 .PP 221 Samba stores it 's data in several TDB (Trivial Database) files, usually located in222 \fI/var/lib/samba\fR .223 .PP 224 (*) information persistent across restarts (but not necessarily important to backup) .225 .PP 226 account_policy .tdb*227 .RS 3n228 NT account policy settings such as pw expiration, etc ...229 .RE 230 .PP 231 brlock .tdb232 .RS 3n229 Samba stores it\'s data in several TDB (Trivial Database) files, usually located in 230 \fI/var/lib/samba\fR\. 231 .PP 232 (*) information persistent across restarts (but not necessarily important to backup)\. 233 .PP 234 account_policy\.tdb* 235 .RS 4 236 NT account policy settings such as pw expiration, etc\.\.\. 237 .RE 238 .PP 239 brlock\.tdb 240 .RS 4 233 241 byte range locks 234 242 .RE 235 243 .PP 236 browse .dat237 .RS 3n244 browse\.dat 245 .RS 4 238 246 browse lists 239 247 .RE 240 248 .PP 241 connections .tdb242 .RS 3n243 share connections (used to enforce max connections, etc ...)244 .RE 245 .PP 246 gencache .tdb247 .RS 3n249 connections\.tdb 250 .RS 4 251 share connections (used to enforce max connections, etc\.\.\.) 252 .RE 253 .PP 254 gencache\.tdb 255 .RS 4 248 256 generic caching db 249 257 .RE 250 258 .PP 251 group_mapping .tdb*252 .RS 3n259 group_mapping\.tdb* 260 .RS 4 253 261 group mapping information 254 262 .RE 255 263 .PP 256 locking .tdb257 .RS 3n264 locking\.tdb 265 .RS 4 258 266 share modes & oplocks 259 267 .RE 260 268 .PP 261 login_cache .tdb*262 .RS 3n269 login_cache\.tdb* 270 .RS 4 263 271 bad pw attempts 264 272 .RE 265 273 .PP 266 messages .tdb267 .RS 3n274 messages\.tdb 275 .RS 4 268 276 Samba messaging system 269 277 .RE 270 278 .PP 271 netsamlogon_cache .tdb*272 .RS 3n279 netsamlogon_cache\.tdb* 280 .RS 4 273 281 cache of user net_info_3 struct from net_samlogon() request (as a domain member) 274 282 .RE 275 283 .PP 276 ntdrivers .tdb*277 .RS 3n284 ntdrivers\.tdb* 285 .RS 4 278 286 installed printer drivers 279 287 .RE 280 288 .PP 281 ntforms .tdb*282 .RS 3n289 ntforms\.tdb* 290 .RS 4 283 291 installed printer forms 284 292 .RE 285 293 .PP 286 ntprinters .tdb*287 .RS 3n294 ntprinters\.tdb* 295 .RS 4 288 296 installed printer information 289 297 .RE 290 298 .PP 291 299 printing/ 292 .RS 3n300 .RS 4 293 301 directory containing tdb per print queue of cached lpq output 294 302 .RE 295 303 .PP 296 registry .tdb297 .RS 3n298 Windows registry skeleton (connect via regedit .exe)299 .RE 300 .PP 301 sessionid .tdb302 .RS 3n303 session information (e .g. support for 'utmp = yes')304 .RE 305 .PP 306 share_info .tdb*307 .RS 3n304 registry\.tdb 305 .RS 4 306 Windows registry skeleton (connect via regedit\.exe) 307 .RE 308 .PP 309 sessionid\.tdb 310 .RS 4 311 session information (e\.g\. support for \'utmp = yes\') 312 .RE 313 .PP 314 share_info\.tdb* 315 .RS 4 308 316 share acls 309 317 .RE 310 318 .PP 311 winbindd_cache .tdb312 .RS 3n313 winbindd 's cache of user lists, etc...314 .RE 315 .PP 316 winbindd_idmap .tdb*317 .RS 3n318 winbindd 's local idmap db319 .RE 320 .PP 321 wins .dat*322 .RS 3n323 wins database when 'wins support = yes'319 winbindd_cache\.tdb 320 .RS 4 321 winbindd\'s cache of user lists, etc\.\.\. 322 .RE 323 .PP 324 winbindd_idmap\.tdb* 325 .RS 4 326 winbindd\'s local idmap db 327 .RE 328 .PP 329 wins\.dat* 330 .RS 4 331 wins database when \'wins support = yes\' 324 332 .RE 325 333 .SH "SIGNALS" … … 328 336 smbd 329 337 a SIGHUP will cause it to reload its 330 \fIsmb .conf\fR331 configuration file within a short period of time .332 .PP 333 To shut down a user 's338 \fIsmb\.conf\fR 339 configuration file within a short period of time\. 340 .PP 341 To shut down a user\'s 334 342 smbd 335 343 process it is recommended that 336 SIGKILL ( -9)337 \f BNOT\fR338 be used, except as a last resort, as this may leave the shared memory area in an inconsistent state . The safe way to terminate an339 smbd 340 is to send it a SIGTERM ( -15) signal and wait for it to die on its own.344 SIGKILL (\-9) 345 \fINOT\fR 346 be used, except as a last resort, as this may leave the shared memory area in an inconsistent state\. The safe way to terminate an 347 smbd 348 is to send it a SIGTERM (\-15) signal and wait for it to die on its own\. 341 349 .PP 342 350 The debug log level of … … 344 352 may be raised or lowered using 345 353 \fBsmbcontrol\fR(1) 346 program (SIGUSR[1|2] signals are no longer used since Samba 2 .2). This is to allow transient problems to be diagnosed, whilst still running at a normally low log level.347 .PP 348 Note that as the signal handlers send a debug write, they are not re -entrant in349 smbd . This you should wait until350 smbd 351 is in a state of waiting for an incoming SMB before issuing them . It is possible to make the signal handlers safe by un-blocking the signals before the select call and re-blocking them after, however this would affect performance.354 program (SIGUSR[1|2] signals are no longer used since Samba 2\.2)\. This is to allow transient problems to be diagnosed, whilst still running at a normally low log level\. 355 .PP 356 Note that as the signal handlers send a debug write, they are not re\-entrant in 357 smbd\. This you should wait until 358 smbd 359 is in a state of waiting for an incoming SMB before issuing them\. It is possible to make the signal handlers safe by un\-blocking the signals before the select call and re\-blocking them after, however this would affect performance\. 352 360 .SH "SEE ALSO" 353 361 .PP … … 358 366 \fBsmbclient\fR(1), 359 367 \fBtestparm\fR(1), 360 \fBtestprns\fR(1), and the Internet RFC 's361 \fIrfc1001 .txt\fR,362 \fIrfc1002 .txt\fR. In addition the CIFS (formerly SMB) specification is available as a link from the Web page363 http://samba .org/cifs/.368 \fBtestprns\fR(1), and the Internet RFC\'s 369 \fIrfc1001\.txt\fR, 370 \fIrfc1002\.txt\fR\. In addition the CIFS (formerly SMB) specification is available as a link from the Web page 371 http://samba\.org/cifs/\. 364 372 .SH "AUTHOR" 365 373 .PP 366 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 367 .PP 368 The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 369 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 370 374 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 375 .PP 376 The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 377 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/smbget.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBGET" 1 "" "" "" 1 .\" Title: smbget 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBGET" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbget - wget-like utility for download files over SMB 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 smbget [ -a, --guest] [-r, --resume] [-R, --recursive] [-u, --username=STRING] [-p, --password=STRING] [-w, --workgroup=STRING] [-n, --nonprompt] [-d, --debuglevel=INT] [-D, --dots] [-P, --keep-permissions] [-o, --outputfile] [-f, --rcfile] [-q, --quiet] [-v, --verbose] [-b, --blocksize] [-?, --help] [--usage] {smb://host/share/path/to/file} [smb://url2/] [...]17 smbget [\-a,\ \-\-guest] [\-r,\ \-\-resume] [\-R,\ \-\-recursive] [\-u,\ \-\-username=STRING] [\-p,\ \-\-password=STRING] [\-w,\ \-\-workgroup=STRING] [\-n,\ \-\-nonprompt] [\-d,\ \-\-debuglevel=INT] [\-D,\ \-\-dots] [\-P,\ \-\-keep\-permissions] [\-o,\ \-\-outputfile] [\-f,\ \-\-rcfile] [\-q,\ \-\-quiet] [\-v,\ \-\-verbose] [\-b,\ \-\-blocksize] [\-?,\ \-\-help] [\-\-usage] {smb://host/share/path/to/file} [smb://url2/] [\.\.\.] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 smbget is a simple utility with wget -like semantics, that can download files from SMB servers. You can specify the files you would like to download on the command-line.24 smbget is a simple utility with wget\-like semantics, that can download files from SMB servers\. You can specify the files you would like to download on the command\-line\. 33 25 .PP 34 The files should be in the smb -URL standard, e.g. use smb://host/share/file for the UNC path35 \f B\\\\HOST\\SHARE\\file\fR.26 The files should be in the smb\-URL standard, e\.g\. use smb://host/share/file for the UNC path 27 \fI\e\e\e\eHOST\e\eSHARE\e\efile\fR\. 36 28 .SH "OPTIONS" 37 29 .PP 38 -a, --guest39 .RS 3n30 \-a, \-\-guest 31 .RS 4 40 32 Work as user guest 41 33 .RE 42 34 .PP 43 -r, --resume44 .RS 3n35 \-r, \-\-resume 36 .RS 4 45 37 Automatically resume aborted files 46 38 .RE 47 39 .PP 48 -R, --recursive49 .RS 3n40 \-R, \-\-recursive 41 .RS 4 50 42 Recursively download files 51 43 .RE 52 44 .PP 53 -u, --username=STRING54 .RS 3n45 \-u, \-\-username=STRING 46 .RS 4 55 47 Username to use 56 48 .RE 57 49 .PP 58 -p, --password=STRING59 .RS 3n50 \-p, \-\-password=STRING 51 .RS 4 60 52 Password to use 61 53 .RE 62 54 .PP 63 -w, --workgroup=STRING64 .RS 3n55 \-w, \-\-workgroup=STRING 56 .RS 4 65 57 Workgroup to use (optional) 66 58 .RE 67 59 .PP 68 -n, --nonprompt69 .RS 3n70 Don 't ask anything (non-interactive)60 \-n, \-\-nonprompt 61 .RS 4 62 Don\'t ask anything (non\-interactive) 71 63 .RE 72 64 .PP 73 -d, --debuglevel=INT74 .RS 3n65 \-d, \-\-debuglevel=INT 66 .RS 4 75 67 Debuglevel to use 76 68 .RE 77 69 .PP 78 -D, --dots79 .RS 3n70 \-D, \-\-dots 71 .RS 4 80 72 Show dots as progress indication 81 73 .RE 82 74 .PP 83 -P, --keep-permissions84 .RS 3n85 Set same permissions on local file as are set on remote file .75 \-P, \-\-keep\-permissions 76 .RS 4 77 Set same permissions on local file as are set on remote file\. 86 78 .RE 87 79 .PP 88 -o, --outputfile89 .RS 3n90 Write the file that is being download to the specified file . Can not be used together with -R.80 \-o, \-\-outputfile 81 .RS 4 82 Write the file that is being download to the specified file\. Can not be used together with \-R\. 91 83 .RE 92 84 .PP 93 -f, --rcfile94 .RS 3n95 Use specified rcfile . This will be loaded in the order it was specified - e.g. if you specify any options before this one, they might get overriden by the contents of the rcfile.85 \-f, \-\-rcfile 86 .RS 4 87 Use specified rcfile\. This will be loaded in the order it was specified \- e\.g\. if you specify any options before this one, they might get overriden by the contents of the rcfile\. 96 88 .RE 97 89 .PP 98 -q, --quiet99 .RS 3n90 \-q, \-\-quiet 91 .RS 4 100 92 Be quiet 101 93 .RE 102 94 .PP 103 -v, --verbose104 .RS 3n95 \-v, \-\-verbose 96 .RS 4 105 97 Be verbose 106 98 .RE 107 99 .PP 108 -b, --blocksize109 .RS 3n110 Number of bytes to download in a block . Defaults to 64000.100 \-b, \-\-blocksize 101 .RS 4 102 Number of bytes to download in a block\. Defaults to 64000\. 111 103 .RE 112 104 .PP 113 -?, --help114 .RS 3n105 \-?, \-\-help 106 .RS 4 115 107 Show help message 116 108 .RE 117 109 .PP 118 --usage119 .RS 3n110 \-\-usage 111 .RS 4 120 112 Display brief usage message 121 113 .RE 122 114 .SH "SMB URLS" 123 115 .PP 124 SMB URL 's should be specified in the following format:116 SMB URL\'s should be specified in the following format: 125 117 .PP 126 118 .RS 4 119 .nf 120 smb://[[[domain;]user[:password@]]server[/share[/path[/file]]]] 121 .fi 122 .RE 123 .PP 124 .RS 4 125 .nf 126 smb:// means all the workgroups 127 .fi 128 .RE 129 .PP 130 .RS 4 131 .nf 132 smb://name/ means, if \fIname\fR is a workgroup, all the servers in this workgroup, or if \fIname\fR is a server, all the shares on this server\. 133 .fi 134 .RE 135 .SH "EXAMPLES" 127 136 .sp 128 137 .RS 4 129 138 .nf 130 131 smb://[[[domain;]user[:password@]]server[/share[/path[/file]]]] 132 139 # Recursively download \'src\' directory 140 smbget \-R smb://rhonwyn/jelmer/src 141 # Download FreeBSD ISO and enable resuming 142 smbget \-r smb://rhonwyn/isos/FreeBSD5\.1\.iso 143 # Recursively download all ISOs 144 smbget \-Rr smb://rhonwyn/isos 145 # Backup my data on rhonwyn 146 smbget \-Rr smb://rhonwyn/ 133 147 .fi 134 135 .PP 136 137 .sp 138 139 .nf 140 141 smb:// means all the workgroups 142 143 .fi 144 145 .PP 146 147 .sp 148 149 .nf 150 151 smb://name/ means, if \fIname\fR is a workgroup, all the servers in this workgroup, or if \fIname\fR is a server, all the shares on this server. 152 153 .fi 154 155 .SH "EXAMPLES" 156 157 .nf 158 159 # Recursively download 'src' directory 160 smbget -R smb://rhonwyn/jelmer/src 161 # Download FreeBSD ISO and enable resuming 162 smbget -r smb://rhonwyn/isos/FreeBSD5.1.iso 163 # Recursively download all ISOs 164 smbget -Rr smb://rhonwyn/isos 165 # Backup my data on rhonwyn 166 smbget -Rr smb://rhonwyn/ 167 168 .fi 148 .RE 169 149 .SH "BUGS" 170 150 .PP 171 Permission denied is returned in some cases where the cause of the error is unknown (such as an illegally formatted smb:// url or trying to get a directory without -R turned on).151 Permission denied is returned in some cases where the cause of the error is unknown (such as an illegally formatted smb:// url or trying to get a directory without \-R turned on)\. 172 152 .SH "VERSION" 173 153 .PP 174 This man page is correct for version 3 .0 of the Samba suite.154 This man page is correct for version 3\.0 of the Samba suite\. 175 155 .SH "AUTHOR" 176 156 .PP 177 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.157 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 178 158 .PP 179 The smbget manpage was written by Jelmer Vernooij. 180 159 The smbget manpage was written by Jelmer Vernooij\. -
branches/samba-3.0/docs/manpages/smbgetrc.5
r39 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBGETRC" 5 "" "" "" 1 .\" Title: smbgetrc 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: File Formats and Conventions 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBGETRC" "5" "05/21/2008" "Samba 3\.0" "File Formats and Conventions" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbgetrc - configuration file for smbget … … 27 19 .PP 28 20 This manual page documents the format and options of the 29 \f Bsmbgetrc\fR30 file . This is the configuration file used by the21 \fIsmbgetrc\fR 22 file\. This is the configuration file used by the 31 23 \fBsmbget\fR(1) 32 utility . The file contains of key-value pairs, one pair on each line. The key and value should be separated by a space.24 utility\. The file contains of key\-value pairs, one pair on each line\. The key and value should be separated by a space\. 33 25 .PP 34 26 By default, smbget reads its configuration from 35 \f B$HOME/.smbgetrc\fR, though other locations can be specified using the command-line options.27 \fI$HOME/\.smbgetrc\fR, though other locations can be specified using the command\-line options\. 36 28 .SH "OPTIONS" 37 29 .PP … … 39 31 .PP 40 32 resume on|off 41 .RS 3n42 Whether aborted downloads should be automatically resumed .33 .RS 4 34 Whether aborted downloads should be automatically resumed\. 43 35 .RE 44 36 .PP 45 37 recursive on|off 46 .RS 3n38 .RS 4 47 39 Whether directories should be downloaded recursively 48 40 .RE 49 41 .PP 50 42 username \fIname\fR 51 .RS 3n52 Username to use when logging in to the remote server . Use an empty string for anonymous access.43 .RS 4 44 Username to use when logging in to the remote server\. Use an empty string for anonymous access\. 53 45 .RE 54 46 .PP 55 47 password \fIpass\fR 56 .RS 3n57 Password to use when logging in .48 .RS 4 49 Password to use when logging in\. 58 50 .RE 59 51 .PP 60 52 workgroup \fIwg\fR 61 .RS 3n53 .RS 4 62 54 Workgroup to use when logging in 63 55 .RE 64 56 .PP 65 57 nonprompt on|off 66 .RS 3n67 Turns off asking for username and password . Useful for scripts.58 .RS 4 59 Turns off asking for username and password\. Useful for scripts\. 68 60 .RE 69 61 .PP 70 62 debuglevel \fIint\fR 71 .RS 3n72 (Samba) debuglevel to run at . Useful for tracking down protocol level problems.63 .RS 4 64 (Samba) debuglevel to run at\. Useful for tracking down protocol level problems\. 73 65 .RE 74 66 .PP 75 67 dots on|off 76 .RS 3n77 Whether a single dot should be printed for each block that has been downloaded, instead of the default progress indicator .68 .RS 4 69 Whether a single dot should be printed for each block that has been downloaded, instead of the default progress indicator\. 78 70 .RE 79 71 .PP 80 72 blocksize \fIint\fR 81 .RS 3n82 Number of bytes to put in a block .73 .RS 4 74 Number of bytes to put in a block\. 83 75 .RE 84 76 .SH "VERSION" 85 77 .PP 86 This man page is correct for version 3 .0 of the Samba suite.78 This man page is correct for version 3\.0 of the Samba suite\. 87 79 .SH "SEE ALSO" 88 80 .PP 89 81 \fBsmbget\fR(1) 90 82 and 91 \fBSamba\fR(7) .83 \fBSamba\fR(7)\. 92 84 .SH "AUTHOR" 93 85 .PP 94 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.86 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 95 87 .PP 96 88 This manual page was written by Jelmer Vernooij 97 -
branches/samba-3.0/docs/manpages/smbmnt.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBMNT" 8 "" "" "" 1 .\" Title: smbmnt 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: 6 .\" Source: 7 .\" 8 .TH "SMBMNT" "8" "05/21/2008" "" "" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbmnt - helper utility for mounting SMB filesystems 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 smbmnt {mount -point} [-s <share>] [-r] [-u <uid>] [-g <gid>] [-f <mask>] [-d <mask>] [-o <options>] [-h]17 smbmnt {mount\-point} [\-s\ <share>] [\-r] [\-u\ <uid>] [\-g\ <gid>] [\-f\ <mask>] [\-d\ <mask>] [\-o\ <options>] [\-h] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 smbmnt 29 is a helper application used by the smbmount program to do the actual mounting of SMB shares .21 is a helper application used by the smbmount program to do the actual mounting of SMB shares\. 30 22 smbmnt 31 can be installed setuid root if you want normal users to be able to mount their SMB shares .23 can be installed setuid root if you want normal users to be able to mount their SMB shares\. 32 24 .PP 33 A setuid smbmnt will only allow mounts on directories owned by the user, and that the user has write permission on .25 A setuid smbmnt will only allow mounts on directories owned by the user, and that the user has write permission on\. 34 26 .PP 35 27 The 36 28 smbmnt 37 29 program is normally invoked by 38 \fBsmbmount\fR(8) . It should not be invoked directly by users.30 \fBsmbmount\fR(8)\. It should not be invoked directly by users\. 39 31 .PP 40 smbmount searches the normal PATH for smbmnt . You must ensure that the smbmnt version in your path matches the smbmount used.32 smbmount searches the normal PATH for smbmnt\. You must ensure that the smbmnt version in your path matches the smbmount used\. 41 33 .SH "OPTIONS" 42 34 .PP 43 -r44 .RS 3n45 mount the filesystem read -only35 \-r 36 .RS 4 37 mount the filesystem read\-only 46 38 .RE 47 39 .PP 48 -u uid49 .RS 3n40 \-u uid 41 .RS 4 50 42 specify the uid that the files will be owned by 51 43 .RE 52 44 .PP 53 -g gid54 .RS 3n45 \-g gid 46 .RS 4 55 47 specify the gid that the files will be owned by 56 48 .RE 57 49 .PP 58 -f mask59 .RS 3n50 \-f mask 51 .RS 4 60 52 specify the octal file mask applied 61 53 .RE 62 54 .PP 63 -d mask64 .RS 3n55 \-d mask 56 .RS 4 65 57 specify the octal directory mask applied 66 58 .RE 67 59 .PP 68 -o options69 .RS 3n70 list of options that are passed as -is to smbfs, if this command is run on a 2.4 or higher Linux kernel.60 \-o options 61 .RS 4 62 list of options that are passed as\-is to smbfs, if this command is run on a 2\.4 or higher Linux kernel\. 71 63 .RE 72 64 .PP 73 -h|--help74 .RS 3n75 Print a summary of command line options .65 \-h|\-\-help 66 .RS 4 67 Print a summary of command line options\. 76 68 .RE 77 69 .SH "AUTHOR" 78 70 .PP 79 Volker Lendecke, Andrew Tridgell, Michael H . Warfield and others.71 Volker Lendecke, Andrew Tridgell, Michael H\. Warfield and others\. 80 72 .PP 81 73 The current maintainer of smbfs and the userspace tools … … 84 76 smbmnt 85 77 is 86 Urban Widmark . The78 Urban Widmark\. The 87 79 SAMBA Mailing list 88 is the preferred place to ask questions regarding these programs .80 is the preferred place to ask questions regarding these programs\. 89 81 .PP 90 The conversion of this manpage for Samba 2.2 was performed by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 91 82 The conversion of this manpage for Samba 2\.2 was performed by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/smbmount.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBMOUNT" 8 "" "" "" 1 .\" Title: smbmount 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: 6 .\" Source: 7 .\" 8 .TH "SMBMOUNT" "8" "05/21/2008" "" "" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbmount - mount an smbfs filesystem 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 smbmount {service} {mount -point} [-ooptions]17 smbmount {service} {mount\-point} [\-o\ options] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 smbmount 29 mounts a Linux SMB filesystem . It is usually invoked as30 mount .smbfs21 mounts a Linux SMB filesystem\. It is usually invoked as 22 mount\.smbfs 31 23 by the 32 24 \fBmount\fR(8) 33 command when using the " -t smbfs" option. This command only works in Linux, and the kernel must support the smbfs filesystem.25 command when using the "\-t smbfs" option\. This command only works in Linux, and the kernel must support the smbfs filesystem\. 34 26 .PP 35 27 WARNING: 36 28 smbmount 37 is deprecated and not maintained any longer .38 mount .cifs39 (mount -t cifs) should be used instead of40 smbmount .29 is deprecated and not maintained any longer\. 30 mount\.cifs 31 (mount \-t cifs) should be used instead of 32 smbmount\. 41 33 .PP 42 34 Options to 43 35 smbmount 44 are specified as a comma -separated list of key=value pairs. It is possible to send options other than those listed here, assuming that smbfs supports them. If you get mount failures, check your kernel log for errors on unknown options.45 .PP 46 smbmount 47 is a daemon . After mounting it keeps running until the mounted smbfs is umounted. It will log things that happen when in daemon mode using the "machine name" smbmount, so typically this output will end up in48 \fIlog .smbmount\fR. The49 smbmount 50 process may also be called mount .smbfs.36 are specified as a comma\-separated list of key=value pairs\. It is possible to send options other than those listed here, assuming that smbfs supports them\. If you get mount failures, check your kernel log for errors on unknown options\. 37 .PP 38 smbmount 39 is a daemon\. After mounting it keeps running until the mounted smbfs is umounted\. It will log things that happen when in daemon mode using the "machine name" smbmount, so typically this output will end up in 40 \fIlog\.smbmount\fR\. The 41 smbmount 42 process may also be called mount\.smbfs\. 51 43 .sp 52 44 .it 1 an-trap … … 54 46 .nr an-break-flag 1 55 47 .br 56 \fBNote\fR 48 Note 57 49 .PP 58 50 … … 60 52 calls 61 53 \fBsmbmnt\fR(8) 62 to do the actual mount . You must make sure that54 to do the actual mount\. You must make sure that 63 55 smbmnt 64 is in the path so that it can be found .56 is in the path so that it can be found\. 65 57 .SH "OPTIONS" 66 58 .PP 67 59 username=<arg> 68 .RS 3n69 specifies the username to connect as . If this is not given, then the environment variable60 .RS 4 61 specifies the username to connect as\. If this is not given, then the environment variable 70 62 \fB USER\fR 71 is used . This option can also take the form "user%password" or "user/workgroup" or "user/workgroup%password" to allow the password and workgroup to be specified as part of the username.63 is used\. This option can also take the form "user%password" or "user/workgroup" or "user/workgroup%password" to allow the password and workgroup to be specified as part of the username\. 72 64 .RE 73 65 .PP 74 66 password=<arg> 75 .RS 3n76 specifies the SMB password . If this option is not given then the environment variable67 .RS 4 68 specifies the SMB password\. If this option is not given then the environment variable 77 69 PASSWD 78 is used . If it can find no password79 smbmount 80 will prompt for a password, unless the guest option is given .81 .sp 82 Note that passwords which contain the argument delimiter character (i .e. a comma ',') will failed to be parsed correctly on the command line. However, the same password defined in the PASSWD environment variable or a credentials file (see below) will be read correctly.70 is used\. If it can find no password 71 smbmount 72 will prompt for a password, unless the guest option is given\. 73 .sp 74 Note that passwords which contain the argument delimiter character (i\.e\. a comma \',\') will failed to be parsed correctly on the command line\. However, the same password defined in the PASSWD environment variable or a credentials file (see below) will be read correctly\. 83 75 .RE 84 76 .PP 85 77 credentials=<filename> 86 .RS 3n 87 specifies a file that contains a username and/or password. The format of the file is: 88 89 .sp 90 78 .RS 4 79 specifies a file that contains a username and/or password\. The format of the file is: 80 .sp 81 .RS 4 91 82 .nf 92 93 username = <value> 94 password = <value> 95 83 username=value 84 password=value 96 85 .fi 97 86 .RE 98 87 .sp 99 88 This is preferred over having passwords in plaintext in a shared file, such as 100 \fI/etc/fstab\fR . Be sure to protect any credentials file properly.89 \fI/etc/fstab\fR\. Be sure to protect any credentials file properly\. 101 90 .RE 102 91 .PP 103 92 krb 104 .RS 3n105 Use kerberos (Active Directory) .93 .RS 4 94 Use kerberos (Active Directory)\. 106 95 .RE 107 96 .PP 108 97 netbiosname=<arg> 109 .RS 3n110 sets the source NetBIOS name . It defaults to the local hostname.98 .RS 4 99 sets the source NetBIOS name\. It defaults to the local hostname\. 111 100 .RE 112 101 .PP 113 102 uid=<arg> 114 .RS 3n115 sets the uid that will own all files on the mounted filesystem . It may be specified as either a username or a numeric uid.103 .RS 4 104 sets the uid that will own all files on the mounted filesystem\. It may be specified as either a username or a numeric uid\. 116 105 .RE 117 106 .PP 118 107 gid=<arg> 119 .RS 3n120 sets the gid that will own all files on the mounted filesystem . It may be specified as either a groupname or a numeric gid.108 .RS 4 109 sets the gid that will own all files on the mounted filesystem\. It may be specified as either a groupname or a numeric gid\. 121 110 .RE 122 111 .PP 123 112 port=<arg> 124 .RS 3n125 sets the remote SMB port number . The default is 445, fallback is 139.113 .RS 4 114 sets the remote SMB port number\. The default is 445, fallback is 139\. 126 115 .RE 127 116 .PP 128 117 fmask=<arg> 129 .RS 3n130 sets the file mask . This determines the permissions that remote files have in the local filesystem. This is not a umask, but the actual permissions for the files. The default is based on the current umask.118 .RS 4 119 sets the file mask\. This determines the permissions that remote files have in the local filesystem\. This is not a umask, but the actual permissions for the files\. The default is based on the current umask\. 131 120 .RE 132 121 .PP 133 122 dmask=<arg> 134 .RS 3n135 Sets the directory mask . This determines the permissions that remote directories have in the local filesystem. This is not a umask, but the actual permissions for the directories. The default is based on the current umask.123 .RS 4 124 Sets the directory mask\. This determines the permissions that remote directories have in the local filesystem\. This is not a umask, but the actual permissions for the directories\. The default is based on the current umask\. 136 125 .RE 137 126 .PP 138 127 debug=<arg> 139 .RS 3n140 Sets the debug level . This is useful for tracking down SMB connection problems. A suggested value to start with is 4. If set too high there will be a lot of output, possibly hiding the useful output.128 .RS 4 129 Sets the debug level\. This is useful for tracking down SMB connection problems\. A suggested value to start with is 4\. If set too high there will be a lot of output, possibly hiding the useful output\. 141 130 .RE 142 131 .PP 143 132 ip=<arg> 144 .RS 3n145 Sets the destination host or IP address .133 .RS 4 134 Sets the destination host or IP address\. 146 135 .RE 147 136 .PP 148 137 workgroup=<arg> 149 .RS 3n138 .RS 4 150 139 Sets the workgroup on the destination 151 140 .RE 152 141 .PP 153 142 sockopt=<arg> 154 .RS 3n155 Sets the TCP socket options . See the143 .RS 4 144 Sets the TCP socket options\. See the 156 145 \fBsmb.conf\fR(5) 157 146 \fIsocket options\fR 158 option .147 option\. 159 148 .RE 160 149 .PP 161 150 scope=<arg> 162 .RS 3n151 .RS 4 163 152 Sets the NetBIOS scope 164 153 .RE 165 154 .PP 166 155 guest 167 .RS 3n168 Don 't prompt for a password156 .RS 4 157 Don\'t prompt for a password 169 158 .RE 170 159 .PP 171 160 ro 172 .RS 3n173 mount read -only161 .RS 4 162 mount read\-only 174 163 .RE 175 164 .PP 176 165 rw 177 .RS 3n178 mount read -write166 .RS 4 167 mount read\-write 179 168 .RE 180 169 .PP 181 170 iocharset=<arg> 182 .RS 3n183 sets the charset used by the Linux side for codepage to charset translations (NLS) . Argument should be the name of a charset, like iso8859-1. (Note: only kernel 2.4.0 or later)171 .RS 4 172 sets the charset used by the Linux side for codepage to charset translations (NLS)\. Argument should be the name of a charset, like iso8859\-1\. (Note: only kernel 2\.4\.0 or later) 184 173 .RE 185 174 .PP 186 175 codepage=<arg> 187 .RS 3n188 sets the codepage the server uses . See the iocharset option. Example value cp850. (Note: only kernel 2.4.0 or later)176 .RS 4 177 sets the codepage the server uses\. See the iocharset option\. Example value cp850\. (Note: only kernel 2\.4\.0 or later) 189 178 .RE 190 179 .PP 191 180 ttl=<arg> 192 .RS 3n193 sets how long a directory listing is cached in milliseconds (also affects visibility of file size and date changes) . A higher value means that changes on the server take longer to be noticed but it can give better performance on large directories, especially over long distances. Default is 1000ms but something like 10000ms (10 seconds) is probably more reasonable in many cases. (Note: only kernel 2.4.2 or later)181 .RS 4 182 sets how long a directory listing is cached in milliseconds (also affects visibility of file size and date changes)\. A higher value means that changes on the server take longer to be noticed but it can give better performance on large directories, especially over long distances\. Default is 1000ms but something like 10000ms (10 seconds) is probably more reasonable in many cases\. (Note: only kernel 2\.4\.2 or later) 194 183 .RE 195 184 .SH "ENVIRONMENT VARIABLES" … … 197 186 The variable 198 187 \fBUSER\fR 199 may contain the username of the person using the client . This information is used only if the protocol level is high enough to support session-level passwords. The variable can be used to set both username and password by using the format username%password.188 may contain the username of the person using the client\. This information is used only if the protocol level is high enough to support session\-level passwords\. The variable can be used to set both username and password by using the format username%password\. 200 189 .PP 201 190 The variable 202 191 \fBPASSWD\fR 203 may contain the password of the person using the client . This information is used only if the protocol level is high enough to support session-level passwords.192 may contain the password of the person using the client\. This information is used only if the protocol level is high enough to support session\-level passwords\. 204 193 .PP 205 194 The variable 206 195 \fBPASSWD_FILE\fR 207 may contain the pathname of a file to read the password from . A single line of input is read and used as the password.196 may contain the pathname of a file to read the password from\. A single line of input is read and used as the password\. 208 197 .SH "OTHER COMMANDS" 209 198 .PP … … 214 203 or the UNIX system 215 204 umount 216 command .205 command\. 217 206 .SH "BUGS" 218 207 .PP 219 Passwords and other options containing , can not be handled . For passwords an alternative way of passing them is in a credentials file or in the PASSWD environment.220 .PP 221 The credentials file does not handle usernames or passwords with leading space .208 Passwords and other options containing , can not be handled\. For passwords an alternative way of passing them is in a credentials file or in the PASSWD environment\. 209 .PP 210 The credentials file does not handle usernames or passwords with leading space\. 222 211 .PP 223 212 One smbfs bug is important enough to mention here, even if it is a bit misplaced: 224 .TP 3n 225 \(bu 226 Mounts sometimes stop working. This is usually caused by smbmount terminating. Since smbfs needs smbmount to reconnect when the server disconnects, the mount will eventually go dead. An umount/mount normally fixes this. At least 2 ways to trigger this bug are known. 227 .PP 228 Note that the typical response to a bug report is suggestion to try the latest version first. So please try doing that first, and always include which versions you use of relevant software when reporting bugs (minimum: samba, kernel, distribution) 213 .sp 214 .RS 4 215 .ie n \{\ 216 \h'-04'\(bu\h'+03'\c 217 .\} 218 .el \{\ 219 .sp -1 220 .IP \(bu 2.3 221 .\} 222 Mounts sometimes stop working\. This is usually caused by smbmount terminating\. Since smbfs needs smbmount to reconnect when the server disconnects, the mount will eventually go dead\. An umount/mount normally fixes this\. At least 2 ways to trigger this bug are known\. 223 .sp 224 .RE 225 .PP 226 Note that the typical response to a bug report is suggestion to try the latest version first\. So please try doing that first, and always include which versions you use of relevant software when reporting bugs (minimum: samba, kernel, distribution) 229 227 .SH "SEE ALSO" 230 228 .PP 231 Documentation/filesystems/smbfs .txt in the linux kernel source tree may contain additional options and information.229 Documentation/filesystems/smbfs\.txt in the linux kernel source tree may contain additional options and information\. 232 230 .PP 233 231 FreeBSD also has a smbfs, but it is not related to smbmount 234 232 .PP 235 For Solaris, HP -UX and others you may want to look at233 For Solaris, HP\-UX and others you may want to look at 236 234 \fBsmbsh\fR(1) 237 or at other solutions, such as Sharity or perhaps replacing the SMB server with a NFS server .235 or at other solutions, such as Sharity or perhaps replacing the SMB server with a NFS server\. 238 236 .SH "AUTHOR" 239 237 .PP 240 Volker Lendecke, Andrew Tridgell, Michael H . Warfield and others.238 Volker Lendecke, Andrew Tridgell, Michael H\. Warfield and others\. 241 239 .PP 242 240 The current maintainer of smbfs and the userspace tools … … 245 243 smbmnt 246 244 is 247 Urban Widmark . The245 Urban Widmark\. The 248 246 SAMBA Mailing list 249 is the preferred place to ask questions regarding these programs. 250 .PP 251 The conversion of this manpage for Samba 2.2 was performed by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 252 247 is the preferred place to ask questions regarding these programs\. 248 .PP 249 The conversion of this manpage for Samba 2\.2 was performed by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/smbpasswd.5
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBPASSWD" 5 "" "" "" 1 .\" Title: smbpasswd 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: File Formats and Conventions 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBPASSWD" "5" "05/21/2008" "Samba 3\.0" "File Formats and Conventions" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbpasswd - The Samba encrypted password file … … 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 smbpasswd is the Samba encrypted password file . It contains the username, Unix user id and the SMB hashed passwords of the user, as well as account flag information and the time the password was last changed. This file format has been evolving with Samba and has had several different formats in the past.24 smbpasswd is the Samba encrypted password file\. It contains the username, Unix user id and the SMB hashed passwords of the user, as well as account flag information and the time the password was last changed\. This file format has been evolving with Samba and has had several different formats in the past\. 33 25 .SH "FILE FORMAT" 34 26 .PP 35 The format of the smbpasswd file used by Samba 2 .2 is very similar to the familiar Unix27 The format of the smbpasswd file used by Samba 2\.2 is very similar to the familiar Unix 36 28 \fIpasswd(5)\fR 37 file . It is an ASCII file containing one line for each user. Each field ithin each line is separated from the next by a colon. Any entry beginning with '#' is ignored. The smbpasswd file contains the following information for each user:29 file\. It is an ASCII file containing one line for each user\. Each field ithin each line is separated from the next by a colon\. Any entry beginning with \'#\' is ignored\. The smbpasswd file contains the following information for each user: 38 30 .PP 39 31 name 40 .RS 3n41 This is the user name . It must be a name that already exists in the standard UNIX passwd file.32 .RS 4 33 This is the user name\. It must be a name that already exists in the standard UNIX passwd file\. 42 34 .RE 43 35 .PP 44 36 uid 45 .RS 3n46 This is the UNIX uid . It must match the uid field for the same user entry in the standard UNIX passwd file. If this does not match then Samba will refuse to recognize this smbpasswd file entry as being valid for a user.37 .RS 4 38 This is the UNIX uid\. It must match the uid field for the same user entry in the standard UNIX passwd file\. If this does not match then Samba will refuse to recognize this smbpasswd file entry as being valid for a user\. 47 39 .RE 48 40 .PP 49 41 Lanman Password Hash 50 .RS 3n51 This is the LANMAN hash of the user 's password, encoded as 32 hex digits. The LANMAN hash is created by DES encrypting a well known string with the user's password as the DES key. This is the same password used by Windows 95/98 machines. Note that this password hash is regarded as weak as it is vulnerable to dictionary attacks and if two users choose the same password this entry will be identical (i.e. the password is not "salted" as the UNIX password is). If the user has a null password this field will contain the characters "NO PASSWORD" as the start of the hex string. If the hex string is equal to 32 'X' characters then the user's account is marked as42 .RS 4 43 This is the LANMAN hash of the user\'s password, encoded as 32 hex digits\. The LANMAN hash is created by DES encrypting a well known string with the user\'s password as the DES key\. This is the same password used by Windows 95/98 machines\. Note that this password hash is regarded as weak as it is vulnerable to dictionary attacks and if two users choose the same password this entry will be identical (i\.e\. the password is not "salted" as the UNIX password is)\. If the user has a null password this field will contain the characters "NO PASSWORD" as the start of the hex string\. If the hex string is equal to 32 \'X\' characters then the user\'s account is marked as 52 44 \fBdisabled\fR 53 and the user will not be able to log onto the Samba server .45 and the user will not be able to log onto the Samba server\. 54 46 .sp 55 \f BWARNING !!\fR56 Note that, due to the challenge -response nature of the SMB/CIFS authentication protocol, anyone with a knowledge of this password hash will be able to impersonate the user on the network. For this reason these hashes are known as57 \f Bplain text equivalents\fR47 \fIWARNING !!\fR 48 Note that, due to the challenge\-response nature of the SMB/CIFS authentication protocol, anyone with a knowledge of this password hash will be able to impersonate the user on the network\. For this reason these hashes are known as 49 \fIplain text equivalents\fR 58 50 and must 59 \f BNOT\fR60 be made available to anyone but the root user . To protect these passwords the smbpasswd file is placed in a directory with read and traverse access only to the root user and the smbpasswd file itself must be set to be read/write only by root, with no other access.51 \fINOT\fR 52 be made available to anyone but the root user\. To protect these passwords the smbpasswd file is placed in a directory with read and traverse access only to the root user and the smbpasswd file itself must be set to be read/write only by root, with no other access\. 61 53 .RE 62 54 .PP 63 55 NT Password Hash 64 .RS 3n65 This is the Windows NT hash of the user 's password, encoded as 32 hex digits. The Windows NT hash is created by taking the user's password as represented in 16-bit, little-endian UNICODE and then applying the MD4 (internet rfc1321) hashing algorithm to it.56 .RS 4 57 This is the Windows NT hash of the user\'s password, encoded as 32 hex digits\. The Windows NT hash is created by taking the user\'s password as represented in 16\-bit, little\-endian UNICODE and then applying the MD4 (internet rfc1321) hashing algorithm to it\. 66 58 .sp 67 This password hash is considered more secure than the LANMAN Password Hash as it preserves the case of the password and uses a much higher quality hashing algorithm . However, it is still the case that if two users choose the same password this entry will be identical (i.e. the password is not "salted" as the UNIX password is).59 This password hash is considered more secure than the LANMAN Password Hash as it preserves the case of the password and uses a much higher quality hashing algorithm\. However, it is still the case that if two users choose the same password this entry will be identical (i\.e\. the password is not "salted" as the UNIX password is)\. 68 60 .sp 69 \f BWARNING !!\fR. Note that, due to the challenge-response nature of the SMB/CIFS authentication protocol, anyone with a knowledge of this password hash will be able to impersonate the user on the network. For this reason these hashes are known as70 \f Bplain text equivalents\fR61 \fIWARNING !!\fR\. Note that, due to the challenge\-response nature of the SMB/CIFS authentication protocol, anyone with a knowledge of this password hash will be able to impersonate the user on the network\. For this reason these hashes are known as 62 \fIplain text equivalents\fR 71 63 and must 72 \f BNOT\fR73 be made available to anyone but the root user . To protect these passwords the smbpasswd file is placed in a directory with read and traverse access only to the root user and the smbpasswd file itself must be set to be read/write only by root, with no other access.64 \fINOT\fR 65 be made available to anyone but the root user\. To protect these passwords the smbpasswd file is placed in a directory with read and traverse access only to the root user and the smbpasswd file itself must be set to be read/write only by root, with no other access\. 74 66 .RE 75 67 .PP 76 68 Account Flags 77 .RS 3n 78 This section contains flags that describe the attributes of the users account. This field is bracketed by '[' and ']' characters and is always 13 characters in length (including the '[' and ']' characters). The contents of this field may be any of the following characters: 79 .RS 3n 80 .TP 3n 81 \(bu 82 \fBU\fR 83 - This means this is a "User" account, i.e. an ordinary user. 84 .TP 3n 85 \(bu 86 \fBN\fR 87 - This means the account has no password (the passwords in the fields LANMAN Password Hash and NT Password Hash are ignored). Note that this will only allow users to log on with no password if the 69 .RS 4 70 This section contains flags that describe the attributes of the users account\. This field is bracketed by \'[\' and \']\' characters and is always 13 characters in length (including the \'[\' and \']\' characters)\. The contents of this field may be any of the following characters: 71 .sp 72 .RS 4 73 .ie n \{\ 74 \h'-04'\(bu\h'+03'\c 75 .\} 76 .el \{\ 77 .sp -1 78 .IP \(bu 2.3 79 .\} 80 \fIU\fR 81 \- This means this is a "User" account, i\.e\. an ordinary user\. 82 .RE 83 .sp 84 .RS 4 85 .ie n \{\ 86 \h'-04'\(bu\h'+03'\c 87 .\} 88 .el \{\ 89 .sp -1 90 .IP \(bu 2.3 91 .\} 92 \fIN\fR 93 \- This means the account has no password (the passwords in the fields LANMAN Password Hash and NT Password Hash are ignored)\. Note that this will only allow users to log on with no password if the 88 94 \fI null passwords\fR 89 95 parameter is set in the 90 96 \fBsmb.conf\fR(5) 91 config file. 92 .TP 3n 93 \(bu 94 \fBD\fR 95 - This means the account is disabled and no SMB/CIFS logins will be allowed for this user. 96 .TP 3n 97 \(bu 98 \fBX\fR 99 - This means the password does not expire. 100 .TP 3n 101 \(bu 102 \fBW\fR 103 - This means this account is a "Workstation Trust" account. This kind of account is used in the Samba PDC code stream to allow Windows NT Workstations and Servers to join a Domain hosted by a Samba PDC. 97 config file\. 104 98 .RE 105 .IP "" 3n 106 Other flags may be added as the code is extended in future. The rest of this field space is filled in with spaces. For further information regarding the flags that are supported please refer to the man page for the 99 .sp 100 .RS 4 101 .ie n \{\ 102 \h'-04'\(bu\h'+03'\c 103 .\} 104 .el \{\ 105 .sp -1 106 .IP \(bu 2.3 107 .\} 108 \fID\fR 109 \- This means the account is disabled and no SMB/CIFS logins will be allowed for this user\. 110 .RE 111 .sp 112 .RS 4 113 .ie n \{\ 114 \h'-04'\(bu\h'+03'\c 115 .\} 116 .el \{\ 117 .sp -1 118 .IP \(bu 2.3 119 .\} 120 \fIX\fR 121 \- This means the password does not expire\. 122 .RE 123 .sp 124 .RS 4 125 .ie n \{\ 126 \h'-04'\(bu\h'+03'\c 127 .\} 128 .el \{\ 129 .sp -1 130 .IP \(bu 2.3 131 .\} 132 \fIW\fR 133 \- This means this account is a "Workstation Trust" account\. This kind of account is used in the Samba PDC code stream to allow Windows NT Workstations and Servers to join a Domain hosted by a Samba PDC\. 134 .sp 135 .RE 136 Other flags may be added as the code is extended in future\. The rest of this field space is filled in with spaces\. For further information regarding the flags that are supported please refer to the man page for the 107 137 pdbedit 108 command .138 command\. 109 139 .RE 110 140 .PP 111 141 Last Change Time 112 .RS 3n113 This field consists of the time the account was last modified . It consists of the characters 'LCT-' (standing for "Last Change Time") followed by a numeric encoding of the UNIX time in seconds since the epoch (1970) that the last change was made.142 .RS 4 143 This field consists of the time the account was last modified\. It consists of the characters \'LCT\-\' (standing for "Last Change Time") followed by a numeric encoding of the UNIX time in seconds since the epoch (1970) that the last change was made\. 114 144 .RE 115 145 .PP 116 All other colon separated fields are ignored at this time .146 All other colon separated fields are ignored at this time\. 117 147 .SH "VERSION" 118 148 .PP 119 This man page is correct for version 3 .0 of the Samba suite.149 This man page is correct for version 3\.0 of the Samba suite\. 120 150 .SH "SEE ALSO" 121 151 .PP 122 152 \fBsmbpasswd\fR(8), 123 \fBSamba\fR(7), and the Internet RFC1321 for details on the MD4 algorithm .153 \fBSamba\fR(7), and the Internet RFC1321 for details on the MD4 algorithm\. 124 154 .SH "AUTHOR" 125 155 .PP 126 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.156 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 127 157 .PP 128 The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 129 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 130 158 The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 159 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/smbpasswd.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBPASSWD" 8 "" "" "" 1 .\" Title: smbpasswd 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBPASSWD" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbpasswd - change a user's SMB password 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 smbpasswd [ -a] [-c <config file>] [-x] [-d] [-e] [-D debuglevel] [-n] [-r <remote machine>] [-R <name resolve order>] [-m] [-U username[%password]] [-h] [-s] [-w pass] [-W] [-i] [-L] [username]17 smbpasswd [\-a] [\-c\ <config\ file>] [\-x] [\-d] [\-e] [\-D\ debuglevel] [\-n] [\-r\ <remote\ machine>] [\-R\ <name\ resolve\ order>] [\-m] [\-U\ username[%password]] [\-h] [\-s] [\-w\ pass] [\-W] [\-i] [\-L] [username] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The smbpasswd program has several different functions, depending on whether it is run by the 33 \f Broot\fR34 user or not . When run as a normal user it allows the user to change the password used for their SMB sessions on any machines that store SMB passwords.35 .PP 36 By default (when run with no arguments) it will attempt to change the current user 's SMB password on the local machine. This is similar to the way the25 \fIroot\fR 26 user or not\. When run as a normal user it allows the user to change the password used for their SMB sessions on any machines that store SMB passwords\. 27 .PP 28 By default (when run with no arguments) it will attempt to change the current user\'s SMB password on the local machine\. This is similar to the way the 37 29 passwd(1) 38 program works .30 program works\. 39 31 smbpasswd 40 32 differs from how the passwd program works however in that it is not 41 \f Bsetuid root\fR42 but works in a client -server mode and communicates with a locally running43 \fBsmbd\fR(8) . As a consequence in order for this to succeed the smbd daemon must be running on the local machine. On a UNIX machine the encrypted SMB passwords are usually stored in the33 \fIsetuid root\fR 34 but works in a client\-server mode and communicates with a locally running 35 \fBsmbd\fR(8)\. As a consequence in order for this to succeed the smbd daemon must be running on the local machine\. On a UNIX machine the encrypted SMB passwords are usually stored in the 44 36 \fBsmbpasswd\fR(5) 45 file .46 .PP 47 When run by an ordinary user with no options, smbpasswd will prompt them for their old SMB password and then ask them for their new password twice, to ensure that the new password was typed correctly . No passwords will be echoed on the screen whilst being typed. If you have a blank SMB password (specified by the string "NO PASSWORD" in the smbpasswd file) then just press the <Enter> key when asked for your old password.48 .PP 49 smbpasswd can also be used by a normal user to change their SMB password on remote machines, such as Windows NT Primary Domain Controllers . See the (\fI-r\fR) and50 \fI -U\fR51 options below .52 .PP 53 When run by root, smbpasswd allows new users to be added and deleted in the smbpasswd file, as well as allows changes to the attributes of the user in this file to be made . When run by root,37 file\. 38 .PP 39 When run by an ordinary user with no options, smbpasswd will prompt them for their old SMB password and then ask them for their new password twice, to ensure that the new password was typed correctly\. No passwords will be echoed on the screen whilst being typed\. If you have a blank SMB password (specified by the string "NO PASSWORD" in the smbpasswd file) then just press the <Enter> key when asked for your old password\. 40 .PP 41 smbpasswd can also be used by a normal user to change their SMB password on remote machines, such as Windows NT Primary Domain Controllers\. See the (\fI\-r\fR) and 42 \fI\-U\fR 43 options below\. 44 .PP 45 When run by root, smbpasswd allows new users to be added and deleted in the smbpasswd file, as well as allows changes to the attributes of the user in this file to be made\. When run by root, 54 46 smbpasswd 55 accesses the local smbpasswd file directly, thus enabling changes to be made even if smbd is not running .47 accesses the local smbpasswd file directly, thus enabling changes to be made even if smbd is not running\. 56 48 .SH "OPTIONS" 57 49 .PP 58 -a59 .RS 3n60 This option specifies that the username following should be added to the local smbpasswd file, with the new password typed (type <Enter> for the old password) . This option is ignored if the username following already exists in the smbpasswd file and it is treated like a regular change password command. Note that the default passdb backends require the user to already exist in the system password file (usually61 \fI/etc/passwd\fR), else the request to add the user will fail .62 .sp 63 This option is only available when running smbpasswd as root .64 .RE 65 .PP 66 -c67 .RS 3n50 \-a 51 .RS 4 52 This option specifies that the username following should be added to the local smbpasswd file, with the new password typed (type <Enter> for the old password)\. This option is ignored if the username following already exists in the smbpasswd file and it is treated like a regular change password command\. Note that the default passdb backends require the user to already exist in the system password file (usually 53 \fI/etc/passwd\fR), else the request to add the user will fail\. 54 .sp 55 This option is only available when running smbpasswd as root\. 56 .RE 57 .PP 58 \-c 59 .RS 4 68 60 This option can be used to specify the path and file name of the 69 \fIsmb .conf\fR70 configuration file when it is important to use other than the default file and / or location .71 .RE 72 .PP 73 -x74 .RS 3n75 This option specifies that the username following should be deleted from the local smbpasswd file .76 .sp 77 This option is only available when running smbpasswd as root .78 .RE 79 .PP 80 -d81 .RS 3n61 \fIsmb\.conf\fR 62 configuration file when it is important to use other than the default file and / or location\. 63 .RE 64 .PP 65 \-x 66 .RS 4 67 This option specifies that the username following should be deleted from the local smbpasswd file\. 68 .sp 69 This option is only available when running smbpasswd as root\. 70 .RE 71 .PP 72 \-d 73 .RS 4 82 74 This option specifies that the username following should be 83 75 \fBdisabled\fR 84 in the local smbpasswd file . This is done by writing a85 \fB 'D'\fR86 flag into the account control space in the smbpasswd file . Once this is done all attempts to authenticate via SMB using this username will fail.87 .sp 88 If the smbpasswd file is in the 'old' format (pre-Samba 2.0 format) there is no space in the user's password entry to write this information and the command will FAIL. See76 in the local smbpasswd file\. This is done by writing a 77 \fB\'D\'\fR 78 flag into the account control space in the smbpasswd file\. Once this is done all attempts to authenticate via SMB using this username will fail\. 79 .sp 80 If the smbpasswd file is in the \'old\' format (pre\-Samba 2\.0 format) there is no space in the user\'s password entry to write this information and the command will FAIL\. See 89 81 \fBsmbpasswd\fR(5) 90 for details on the 'old' and new password file formats.91 .sp 92 This option is only available when running smbpasswd as root .93 .RE 94 .PP 95 -e96 .RS 3n82 for details on the \'old\' and new password file formats\. 83 .sp 84 This option is only available when running smbpasswd as root\. 85 .RE 86 .PP 87 \-e 88 .RS 4 97 89 This option specifies that the username following should be 98 90 \fBenabled\fR 99 in the local smbpasswd file, if the account was previously disabled . If the account was not disabled this option has no effect. Once the account is enabled then the user will be able to authenticate via SMB once again.100 .sp 101 If the smbpasswd file is in the 'old' format, then91 in the local smbpasswd file, if the account was previously disabled\. If the account was not disabled this option has no effect\. Once the account is enabled then the user will be able to authenticate via SMB once again\. 92 .sp 93 If the smbpasswd file is in the \'old\' format, then 102 94 smbpasswd 103 will FAIL to enable the account . See95 will FAIL to enable the account\. See 104 96 \fBsmbpasswd\fR(5) 105 for details on the 'old' and new password file formats.106 .sp 107 This option is only available when running smbpasswd as root .108 .RE 109 .PP 110 -D debuglevel111 .RS 3n97 for details on the \'old\' and new password file formats\. 98 .sp 99 This option is only available when running smbpasswd as root\. 100 .RE 101 .PP 102 \-D debuglevel 103 .RS 4 112 104 \fIdebuglevel\fR 113 is an integer from 0 to 10 . The default value if this parameter is not specified is zero.114 .sp 115 The higher this value, the more detail will be logged to the log files about the activities of smbpasswd . At level 0, only critical errors and serious warnings will be logged.116 .sp 117 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem . Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic.118 .RE 119 .PP 120 -n121 .RS 3n122 This option specifies that the username following should have their password set to null (i .e. a blank password) in the local smbpasswd file. This is done by writing the string "NO PASSWORD" as the first part of the first password stored in the smbpasswd file.105 is an integer from 0 to 10\. The default value if this parameter is not specified is zero\. 106 .sp 107 The higher this value, the more detail will be logged to the log files about the activities of smbpasswd\. At level 0, only critical errors and serious warnings will be logged\. 108 .sp 109 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 110 .RE 111 .PP 112 \-n 113 .RS 4 114 This option specifies that the username following should have their password set to null (i\.e\. a blank password) in the local smbpasswd file\. This is done by writing the string "NO PASSWORD" as the first part of the first password stored in the smbpasswd file\. 123 115 .sp 124 116 Note that to allow users to logon to a Samba server once the password has been set to "NO PASSWORD" in the smbpasswd file the administrator must set the following parameter in the [global] section of the 125 \fIsmb .conf\fR117 \fIsmb\.conf\fR 126 118 file : 127 119 .sp 128 120 null passwords = yes 129 121 .sp 130 This option is only available when running smbpasswd as root .131 .RE 132 .PP 133 -r remote machine name134 .RS 3n135 This option allows a user to specify what machine they wish to change their password on . Without this parameter smbpasswd defaults to the local host. The122 This option is only available when running smbpasswd as root\. 123 .RE 124 .PP 125 \-r remote machine name 126 .RS 4 127 This option allows a user to specify what machine they wish to change their password on\. Without this parameter smbpasswd defaults to the local host\. The 136 128 \fIremote machine name\fR 137 is the NetBIOS name of the SMB/CIFS server to contact to attempt the password change. This name is resolved into an IP address using the standard name resolution mechanism in all programs of the Samba suite. See the 138 \fI-R name resolve order\fR 139 parameter for details on changing this resolving mechanism. 140 .sp 141 The username whose password is changed is that of the current UNIX logged on user. See the 142 \fI-U username\fR 143 parameter for details on changing the password for a different username. 144 .sp 145 Note that if changing a Windows NT Domain password the remote machine specified must be the Primary Domain Controller for the domain (Backup Domain Controllers only have a read-only copy of the user account database and will not allow the password change). 146 .sp 147 \fBNote\fR 148 that Windows 95/98 do not have a real password database so it is not possible to change passwords specifying a Win95/98 machine as remote machine target. 149 .RE 150 .PP 151 -R name resolve order 152 .RS 3n 153 This option allows the user of smbpasswd to determine what name resolution services to use when looking up the NetBIOS name of the host being connected to. 154 .sp 155 The options are :"lmhosts", "host", "wins" and "bcast". They cause names to be resolved as follows: 156 .RS 3n 157 .TP 3n 158 \(bu 159 \fBlmhosts\fR: 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 129 is the NetBIOS name of the SMB/CIFS server to contact to attempt the password change\. This name is resolved into an IP address using the standard name resolution mechanism in all programs of the Samba suite\. See the 130 \fI\-R name resolve order\fR 131 parameter for details on changing this resolving mechanism\. 132 .sp 133 The username whose password is changed is that of the current UNIX logged on user\. See the 134 \fI\-U username\fR 135 parameter for details on changing the password for a different username\. 136 .sp 137 Note that if changing a Windows NT Domain password the remote machine specified must be the Primary Domain Controller for the domain (Backup Domain Controllers only have a read\-only copy of the user account database and will not allow the password change)\. 138 .sp 139 \fINote\fR 140 that Windows 95/98 do not have a real password database so it is not possible to change passwords specifying a Win95/98 machine as remote machine target\. 141 .RE 142 .PP 143 \-R name resolve order 144 .RS 4 145 This option allows the user of smbpasswd to determine what name resolution services to use when looking up the NetBIOS name of the host being connected to\. 146 .sp 147 The options are :"lmhosts", "host", "wins" and "bcast"\. They cause names to be resolved as follows: 148 .sp 149 .RS 4 150 .ie n \{\ 151 \h'-04'\(bu\h'+03'\c 152 .\} 153 .el \{\ 154 .sp -1 155 .IP \(bu 2.3 156 .\} 157 \fBlmhosts\fR: 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 160 158 \fBlmhosts\fR(5) 161 for details) then any name type matches for lookup. 162 .TP 3n 163 \(bu 159 for details) then any name type matches for lookup\. 160 .RE 161 .sp 162 .RS 4 163 .ie n \{\ 164 \h'-04'\(bu\h'+03'\c 165 .\} 166 .el \{\ 167 .sp -1 168 .IP \(bu 2.3 169 .\} 164 170 \fBhost\fR: Do a standard host name to IP address resolution, using the system 165 \fI/etc/hosts \fR, NIS, or DNS lookups. This method of name resolution is operating system depended for instance on IRIX or Solaris this may be controlled by the 166 \fI/etc/nsswitch.conf\fR 167 file). Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise it is ignored. 168 .TP 3n 169 \(bu 171 \fI/etc/hosts \fR, NIS, or DNS lookups\. This method of name resolution is operating system depended for instance on IRIX or Solaris this may be controlled by the 172 \fI/etc/nsswitch\.conf\fR 173 file)\. Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise it is ignored\. 174 .RE 175 .sp 176 .RS 4 177 .ie n \{\ 178 \h'-04'\(bu\h'+03'\c 179 .\} 180 .el \{\ 181 .sp -1 182 .IP \(bu 2.3 183 .\} 170 184 \fBwins\fR: Query a name with the IP address listed in the 171 185 \fIwins server\fR 172 parameter. If no WINS server has been specified this method will be ignored. 173 .TP 3n 174 \(bu 186 parameter\. If no WINS server has been specified this method will be ignored\. 187 .RE 188 .sp 189 .RS 4 190 .ie n \{\ 191 \h'-04'\(bu\h'+03'\c 192 .\} 193 .el \{\ 194 .sp -1 195 .IP \(bu 2.3 196 .\} 175 197 \fBbcast\fR: Do a broadcast on each of the known local interfaces listed in the 176 198 \fIinterfaces\fR 177 parameter . This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet.178 . RE179 . IP "" 3n199 parameter\. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\. 200 .sp 201 .RE 180 202 The default order is 181 203 lmhosts, host, wins, bcast 182 204 and without this parameter or any entry in the 183 205 \fBsmb.conf\fR(5) 184 file the name resolution methods will be attempted in this order .185 .RE 186 .PP 187 -m188 .RS 3n189 This option tells smbpasswd that the account being changed is a MACHINE account . Currently this is used when Samba is being used as an NT Primary Domain Controller.190 .sp 191 This option is only available when running smbpasswd as root .192 .RE 193 .PP 194 -U username195 .RS 3n206 file the name resolution methods will be attempted in this order\. 207 .RE 208 .PP 209 \-m 210 .RS 4 211 This option tells smbpasswd that the account being changed is a MACHINE account\. Currently this is used when Samba is being used as an NT Primary Domain Controller\. 212 .sp 213 This option is only available when running smbpasswd as root\. 214 .RE 215 .PP 216 \-U username 217 .RS 4 196 218 This option may only be used in conjunction with the 197 \fI -r\fR198 option . When changing a password on a remote machine it allows the user to specify the user name on that machine whose password will be changed. It is present to allow users who have different user names on different systems to change these passwords.199 .RE 200 .PP 201 -h202 .RS 3n219 \fI\-r\fR 220 option\. When changing a password on a remote machine it allows the user to specify the user name on that machine whose password will be changed\. It is present to allow users who have different user names on different systems to change these passwords\. 221 .RE 222 .PP 223 \-h 224 .RS 4 203 225 This option prints the help string for 204 smbpasswd, selecting the correct one for running as root or as an ordinary user .205 .RE 206 .PP 207 -s208 .RS 3n209 This option causes smbpasswd to be silent (i .e. not issue prompts) and to read its old and new passwords from standard input, rather than from226 smbpasswd, selecting the correct one for running as root or as an ordinary user\. 227 .RE 228 .PP 229 \-s 230 .RS 4 231 This option causes smbpasswd to be silent (i\.e\. not issue prompts) and to read its old and new passwords from standard input, rather than from 210 232 \fI/dev/tty\fR 211 233 (like the 212 234 passwd(1) 213 program does) . This option is to aid people writing scripts to drive smbpasswd214 .RE 215 .PP 216 -w password217 .RS 3n218 This parameter is only available if Samba has been compiled with LDAP support . The219 \fI -w\fR235 program does)\. This option is to aid people writing scripts to drive smbpasswd 236 .RE 237 .PP 238 \-w password 239 .RS 4 240 This parameter is only available if Samba has been compiled with LDAP support\. The 241 \fI\-w\fR 220 242 switch is used to specify the password to be used with the 221 ldap admin dn. Note that the password is stored in the222 \fIsecrets .tdb\fR223 and is keyed off of the admin 's DN. This means that if the value of243 \fIldap admin dn\fR\. Note that the password is stored in the 244 \fIsecrets\.tdb\fR 245 and is keyed off of the admin\'s DN\. This means that if the value of 224 246 \fIldap admin dn\fR 225 ever changes, the password will need to be manually updated as well .226 .RE 227 .PP 228 -W229 .RS 3n247 ever changes, the password will need to be manually updated as well\. 248 .RE 249 .PP 250 \-W 251 .RS 4 230 252 NOTE: 231 This option is same as " -w" except that the password should be entered using stdin.232 .sp 233 This parameter is only available if Samba has been compiled with LDAP support . The234 \fI -W\fR253 This option is same as "\-w" except that the password should be entered using stdin\. 254 .sp 255 This parameter is only available if Samba has been compiled with LDAP support\. The 256 \fI\-W\fR 235 257 switch is used to specify the password to be used with the 236 ldap admin dn. Note that the password is stored in the237 \fIsecrets .tdb\fR238 and is keyed off of the admin 's DN. This means that if the value of258 \fIldap admin dn\fR\. Note that the password is stored in the 259 \fIsecrets\.tdb\fR 260 and is keyed off of the admin\'s DN\. This means that if the value of 239 261 \fIldap admin dn\fR 240 ever changes, the password will need to be manually updated as well .241 .RE 242 .PP 243 -i244 .RS 3n245 This option tells smbpasswd that the account being changed is an interdomain trust account . Currently this is used when Samba is being used as an NT Primary Domain Controller. The account contains the info about another trusted domain.246 .sp 247 This option is only available when running smbpasswd as root .248 .RE 249 .PP 250 -L251 .RS 3n252 Run in local mode .262 ever changes, the password will need to be manually updated as well\. 263 .RE 264 .PP 265 \-i 266 .RS 4 267 This option tells smbpasswd that the account being changed is an interdomain trust account\. Currently this is used when Samba is being used as an NT Primary Domain Controller\. The account contains the info about another trusted domain\. 268 .sp 269 This option is only available when running smbpasswd as root\. 270 .RE 271 .PP 272 \-L 273 .RS 4 274 Run in local mode\. 253 275 .RE 254 276 .PP 255 277 username 256 .RS 3n278 .RS 4 257 279 This specifies the username for all of the 258 \f Broot only\fR259 options to operate on . Only root can specify this parameter as only root has the permission needed to modify attributes directly in the local smbpasswd file.280 \fIroot only\fR 281 options to operate on\. Only root can specify this parameter as only root has the permission needed to modify attributes directly in the local smbpasswd file\. 260 282 .RE 261 283 .SH "NOTES" … … 263 285 Since 264 286 smbpasswd 265 works in client -server mode communicating with a local smbd for a non-root user then the smbd daemon must be running for this to work. A common problem is to add a restriction to the hosts that may access the287 works in client\-server mode communicating with a local smbd for a non\-root user then the smbd daemon must be running for this to work\. A common problem is to add a restriction to the hosts that may access the 266 288 smbd 267 289 running on the local machine by specifying either … … 271 293 entry in the 272 294 \fBsmb.conf\fR(5) 273 file and neglecting to allow "localhost" access to the smbd .274 .PP 275 In addition, the smbpasswd command is only useful if Samba has been set up to use encrypted passwords .295 file and neglecting to allow "localhost" access to the smbd\. 296 .PP 297 In addition, the smbpasswd command is only useful if Samba has been set up to use encrypted passwords\. 276 298 .SH "VERSION" 277 299 .PP 278 This man page is correct for version 3 .0 of the Samba suite.300 This man page is correct for version 3\.0 of the Samba suite\. 279 301 .SH "SEE ALSO" 280 302 .PP 281 303 \fBsmbpasswd\fR(5), 282 \fBSamba\fR(7) .304 \fBSamba\fR(7)\. 283 305 .SH "AUTHOR" 284 306 .PP 285 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 286 .PP 287 The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 288 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 289 307 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 308 .PP 309 The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 310 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/smbsh.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBSH" 1 "" "" "" 1 .\" Title: smbsh 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBSH" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbsh - Allows access to remote SMB shares using UNIX commands 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 smbsh [ -W workgroup] [-U username] [-P prefix] [-R <name resolve order>] [-d <debug level>] [-l logdir] [-Llibdir]17 smbsh [\-W\ workgroup] [\-U\ username] [\-P\ prefix] [\-R\ <name\ resolve\ order>] [\-d\ <debug\ level>] [\-l\ logdir] [\-L\ libdir] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 smbsh … … 34 26 ls, 35 27 egrep, and 36 rcp . You must use a shell that is dynamically linked in order for37 smbsh 38 to work correctly .28 rcp\. You must use a shell that is dynamically linked in order for 29 smbsh 30 to work correctly\. 39 31 .SH "OPTIONS" 40 32 .PP 41 -W WORKGROUP42 .RS 3n33 \-W WORKGROUP 34 .RS 4 43 35 Override the default workgroup specified in the workgroup parameter of the 44 36 \fBsmb.conf\fR(5) 45 file for this session . This may be needed to connect to some servers.46 .RE 47 .PP 48 -U username[%pass]49 .RS 3n50 Sets the SMB username or username and password . If this option is not specified, the user will be prompted for both the username and the password. If %pass is not specified, the user will be prompted for the password.51 .RE 52 .PP 53 -P prefix54 .RS 3n55 This option allows the user to set the directory prefix for SMB access . The default value if this option is not specified is56 \f Bsmb\fR.57 .RE 58 .PP 59 -s <configuration file>60 .RS 3n61 The file specified contains the configuration details required by the server . The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See62 \fIsmb .conf\fR63 for more information . The default configuration file name is determined at compile time.64 .RE 65 .PP 66 -d|--debuglevel=level67 .RS 3n37 file for this session\. This may be needed to connect to some servers\. 38 .RE 39 .PP 40 \-U username[%pass] 41 .RS 4 42 Sets the SMB username or username and password\. If this option is not specified, the user will be prompted for both the username and the password\. If %pass is not specified, the user will be prompted for the password\. 43 .RE 44 .PP 45 \-P prefix 46 .RS 4 47 This option allows the user to set the directory prefix for SMB access\. The default value if this option is not specified is 48 \fIsmb\fR\. 49 .RE 50 .PP 51 \-s <configuration file> 52 .RS 4 53 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 54 \fIsmb\.conf\fR 55 for more information\. The default configuration file name is determined at compile time\. 56 .RE 57 .PP 58 \-d|\-\-debuglevel=level 59 .RS 4 68 60 \fIlevel\fR 69 is an integer from 0 to 10 . The default value if this parameter is not specified is zero.70 .sp 71 The higher this value, the more detail will be logged to the log files about the activities of the server . At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out.72 .sp 73 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem . Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic.61 is an integer from 0 to 10\. The default value if this parameter is not specified is 0\. 62 .sp 63 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 64 .sp 65 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 74 66 .sp 75 67 Note that specifying this parameter here will override the 76 68 \fIlog level\fR 77 69 parameter in the 78 \fIsmb.conf\fR 79 file. 80 .RE 81 .PP 82 -R <name resolve order> 83 .RS 3n 84 This option is used to determine what naming services and in what order to resolve host names to IP addresses. The option takes a space-separated string of different name resolution options. 85 .sp 86 The options are: "lmhosts", "host", "wins" and "bcast". They cause names to be resolved as follows : 87 .RS 3n 88 .TP 3n 89 \(bu 90 \fBlmhosts\fR: 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 70 \fIsmb\.conf\fR 71 file\. 72 .RE 73 .PP 74 \-R <name resolve order> 75 .RS 4 76 This option is used to determine what naming services and in what order to resolve host names to IP addresses\. The option takes a space\-separated string of different name resolution options\. 77 .sp 78 The options are: "lmhosts", "host", "wins" and "bcast"\. They cause names to be resolved as follows : 79 .sp 80 .RS 4 81 .ie n \{\ 82 \h'-04'\(bu\h'+03'\c 83 .\} 84 .el \{\ 85 .sp -1 86 .IP \(bu 2.3 87 .\} 88 \fBlmhosts\fR: 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 91 89 \fBlmhosts\fR(5) 92 for details) then any name type matches for lookup. 93 .TP 3n 94 \(bu 90 for details) then any name type matches for lookup\. 91 .RE 92 .sp 93 .RS 4 94 .ie n \{\ 95 \h'-04'\(bu\h'+03'\c 96 .\} 97 .el \{\ 98 .sp -1 99 .IP \(bu 2.3 100 .\} 95 101 \fBhost\fR: Do a standard host name to IP address resolution, using the system 96 \fI/etc/hosts\fR, NIS, or DNS lookups. This method of name resolution is operating system dependent, for instance on IRIX or Solaris this may be controlled by the 97 \fI/etc/nsswitch.conf \fR 98 file). Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise it is ignored. 99 .TP 3n 100 \(bu 102 \fI/etc/hosts\fR, NIS, or DNS lookups\. This method of name resolution is operating system dependent, for instance on IRIX or Solaris this may be controlled by the 103 \fI/etc/nsswitch\.conf \fR 104 file)\. Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise it is ignored\. 105 .RE 106 .sp 107 .RS 4 108 .ie n \{\ 109 \h'-04'\(bu\h'+03'\c 110 .\} 111 .el \{\ 112 .sp -1 113 .IP \(bu 2.3 114 .\} 101 115 \fBwins\fR: Query a name with the IP address listed in the 102 116 \fIwins server\fR 103 parameter. If no WINS server has been specified this method will be ignored. 104 .TP 3n 105 \(bu 117 parameter\. If no WINS server has been specified this method will be ignored\. 118 .RE 119 .sp 120 .RS 4 121 .ie n \{\ 122 \h'-04'\(bu\h'+03'\c 123 .\} 124 .el \{\ 125 .sp -1 126 .IP \(bu 2.3 127 .\} 106 128 \fBbcast\fR: Do a broadcast on each of the known local interfaces listed in the 107 129 \fIinterfaces\fR 108 parameter . This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet.109 . RE110 . IP "" 3n130 parameter\. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\. 131 .sp 132 .RE 111 133 If this parameter is not set then the name resolve order defined in the 112 \fIsmb .conf\fR113 file parameter ( ) will be used.114 .sp 115 The default order is lmhosts, host, wins, bcast . Without this parameter or any entry in the116 134 \fIsmb\.conf\fR 135 file parameter (\fIname resolve order\fR) will be used\. 136 .sp 137 The default order is lmhosts, host, wins, bcast\. Without this parameter or any entry in the 138 \fIname resolve order\fR 117 139 parameter of the 118 \fIsmb .conf\fR119 file, the name resolution methods will be attempted in this order .120 .RE 121 .PP 122 -L libdir123 .RS 3n140 \fIsmb\.conf\fR 141 file, the name resolution methods will be attempted in this order\. 142 .RE 143 .PP 144 \-L libdir 145 .RS 4 124 146 This parameter specifies the location of the shared libraries used by 125 smbsh . The default value is specified at compile time.147 smbsh\. The default value is specified at compile time\. 126 148 .RE 127 149 .SH "EXAMPLES" … … 131 153 command, execute 132 154 smbsh 133 from the prompt and enter the username and password that authenticates you to the machine running the Windows NT operating system. 134 135 .sp 136 155 from the prompt and enter the username and password that authenticates you to the machine running the Windows NT operating system\. 156 .sp 157 .RS 4 137 158 .nf 138 139 159 system% \fBsmbsh\fR 140 160 Username: \fBuser\fR 141 161 Password: \fBXXXXXXX\fR 142 143 162 .fi 144 163 .RE 145 164 .PP 146 165 Any dynamically linked command you execute from this shell will access the 147 166 \fI/smb\fR 148 directory using the smb protocol . For example, the command167 directory using the smb protocol\. For example, the command 149 168 ls /smb 150 will show a list of workgroups . The command169 will show a list of workgroups\. The command 151 170 ls /smb/MYGROUP 152 will show all the machines in the workgroup MYGROUP . The command153 ls /smb/MYGROUP/<machine -name>154 will show the share names for that machine . You could then, for example, use the171 will show all the machines in the workgroup MYGROUP\. The command 172 ls /smb/MYGROUP/<machine\-name> 173 will show the share names for that machine\. You could then, for example, use the 155 174 cd 156 175 command to change directories, … … 158 177 to edit files, and 159 178 rcp 160 to copy files .179 to copy files\. 161 180 .SH "VERSION" 162 181 .PP 163 This man page is correct for version 3 .0 of the Samba suite.182 This man page is correct for version 3\.0 of the Samba suite\. 164 183 .SH "BUGS" 165 184 .PP 166 185 smbsh 167 186 works by intercepting the standard libc calls with the dynamically loaded versions in 168 \fI smbwrapper .o\fR. Not all calls have been "wrapped", so some programs may not function correctly under169 smbsh .187 \fI smbwrapper\.o\fR\. Not all calls have been "wrapped", so some programs may not function correctly under 188 smbsh\. 170 189 .PP 171 190 Programs which are not dynamically linked cannot make use of 172 smbsh 's functionality. Most versions of UNIX have a191 smbsh\'s functionality\. Most versions of UNIX have a 173 192 file 174 command that will describe how a program was linked .193 command that will describe how a program was linked\. 175 194 .SH "SEE ALSO" 176 195 .PP … … 179 198 .SH "AUTHOR" 180 199 .PP 181 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 182 .PP 183 The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 184 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 185 200 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 201 .PP 202 The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 203 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/smbspool.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBSPOOL" 8 "" "" "" 1 .\" Title: smbspool 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBSPOOL" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbspool - send a print file to an SMB printer … … 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 smbspool is a very small print spooling program that sends a print file to an SMB printer . The command-line arguments are position-dependent for compatibility with the Common UNIX Printing System, but you can use smbspool with any printing system or from a program or script.24 smbspool is a very small print spooling program that sends a print file to an SMB printer\. The command\-line arguments are position\-dependent for compatibility with the Common UNIX Printing System, but you can use smbspool with any printing system or from a program or script\. 33 25 .PP 34 \f BDEVICE URI\fR26 \fIDEVICE URI\fR 35 27 .PP 36 smbspool specifies the destination using a Uniform Resource Identifier ("URI") with a method of "smb". This string can take a number of forms: 37 .TP 3n 38 \(bu 28 smbspool specifies the destination using a Uniform Resource Identifier ("URI") with a method of "smb"\. This string can take a number of forms: 29 .sp 30 .RS 4 31 .ie n \{\ 32 \h'-04'\(bu\h'+03'\c 33 .\} 34 .el \{\ 35 .sp -1 36 .IP \(bu 2.3 37 .\} 39 38 smb://server[:port]/printer 40 .TP 3n 41 \(bu 39 .RE 40 .sp 41 .RS 4 42 .ie n \{\ 43 \h'-04'\(bu\h'+03'\c 44 .\} 45 .el \{\ 46 .sp -1 47 .IP \(bu 2.3 48 .\} 42 49 smb://workgroup/server[:port]/printer 43 .TP 3n 44 \(bu 50 .RE 51 .sp 52 .RS 4 53 .ie n \{\ 54 \h'-04'\(bu\h'+03'\c 55 .\} 56 .el \{\ 57 .sp -1 58 .IP \(bu 2.3 59 .\} 45 60 smb://username:password@server[:port]/printer 46 .TP 3n 47 \(bu 61 .RE 62 .sp 63 .RS 4 64 .ie n \{\ 65 \h'-04'\(bu\h'+03'\c 66 .\} 67 .el \{\ 68 .sp -1 69 .IP \(bu 2.3 70 .\} 48 71 smb://username:password@workgroup/server[:port]/printer 72 .sp 73 .RE 49 74 .PP 50 75 smbspool tries to get the URI from the environment variable 51 \fBDEVICE_URI\fR . If76 \fBDEVICE_URI\fR\. If 52 77 \fBDEVICE_URI\fR 53 78 is not present, smbspool will use argv[0] if that starts with 54 \ fBsmb://\fR55 or argv[1] if that is not the case .79 \(lqsmb://\(rq 80 or argv[1] if that is not the case\. 56 81 .PP 57 82 Programs using the … … 59 84 functions can pass the URI in argv[0], while shell scripts must set the 60 85 \fBDEVICE_URI\fR 61 environment variable prior to running smbspool .86 environment variable prior to running smbspool\. 62 87 .SH "OPTIONS" 63 .TP 3n 64 \(bu 65 The job argument (argv[1]) contains the job ID number and is presently not used by smbspool. 66 .TP 3n 67 \(bu 68 The user argument (argv[2]) contains the print user's name and is presently not used by smbspool. 69 .TP 3n 70 \(bu 71 The title argument (argv[3]) contains the job title string and is passed as the remote file name when sending the print job. 72 .TP 3n 73 \(bu 74 The copies argument (argv[4]) contains the number of copies to be printed of the named file. If no filename is provided then this argument is not used by smbspool. 75 .TP 3n 76 \(bu 77 The options argument (argv[5]) contains the print options in a single string and is currently not used by smbspool. 78 .TP 3n 79 \(bu 80 The filename argument (argv[6]) contains the name of the file to print. If this argument is not specified then the print file is read from the standard input. 88 .sp 89 .RS 4 90 .ie n \{\ 91 \h'-04'\(bu\h'+03'\c 92 .\} 93 .el \{\ 94 .sp -1 95 .IP \(bu 2.3 96 .\} 97 The job argument (argv[1]) contains the job ID number and is presently not used by smbspool\. 98 .RE 99 .sp 100 .RS 4 101 .ie n \{\ 102 \h'-04'\(bu\h'+03'\c 103 .\} 104 .el \{\ 105 .sp -1 106 .IP \(bu 2.3 107 .\} 108 The user argument (argv[2]) contains the print user\'s name and is presently not used by smbspool\. 109 .RE 110 .sp 111 .RS 4 112 .ie n \{\ 113 \h'-04'\(bu\h'+03'\c 114 .\} 115 .el \{\ 116 .sp -1 117 .IP \(bu 2.3 118 .\} 119 The title argument (argv[3]) contains the job title string and is passed as the remote file name when sending the print job\. 120 .RE 121 .sp 122 .RS 4 123 .ie n \{\ 124 \h'-04'\(bu\h'+03'\c 125 .\} 126 .el \{\ 127 .sp -1 128 .IP \(bu 2.3 129 .\} 130 The copies argument (argv[4]) contains the number of copies to be printed of the named file\. If no filename is provided then this argument is not used by smbspool\. 131 .RE 132 .sp 133 .RS 4 134 .ie n \{\ 135 \h'-04'\(bu\h'+03'\c 136 .\} 137 .el \{\ 138 .sp -1 139 .IP \(bu 2.3 140 .\} 141 The options argument (argv[5]) contains the print options in a single string and is currently not used by smbspool\. 142 .RE 143 .sp 144 .RS 4 145 .ie n \{\ 146 \h'-04'\(bu\h'+03'\c 147 .\} 148 .el \{\ 149 .sp -1 150 .IP \(bu 2.3 151 .\} 152 The filename argument (argv[6]) contains the name of the file to print\. If this argument is not specified then the print file is read from the standard input\. 81 153 .SH "VERSION" 82 154 .PP 83 This man page is correct for version 3 .0 of the Samba suite.155 This man page is correct for version 3\.0 of the Samba suite\. 84 156 .SH "SEE ALSO" 85 157 .PP 86 158 \fBsmbd\fR(8) 87 159 and 88 \fBsamba\fR(7) .160 \fBsamba\fR(7)\. 89 161 .SH "AUTHOR" 90 162 .PP 91 163 smbspool 92 was written by Michael Sweet at Easy Software Products .164 was written by Michael Sweet at Easy Software Products\. 93 165 .PP 94 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.166 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 95 167 .PP 96 The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 97 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 98 168 The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 169 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/smbstatus.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBSTATUS" 1 "" "" "" 1 .\" Title: smbstatus 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBSTATUS" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbstatus - report on current Samba connections 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 smbstatus [ -P] [-b] [-d <debug level>] [-v] [-L] [-B] [-p] [-S] [-s <configuration file>] [-u<username>]17 smbstatus [\-P] [\-b] [\-d\ <debug\ level>] [\-v] [\-L] [\-B] [\-p] [\-S] [\-s\ <configuration\ file>] [\-u\ <username>] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 smbstatus 33 is a very simple program to list the current Samba connections .25 is a very simple program to list the current Samba connections\. 34 26 .SH "OPTIONS" 35 27 .PP 36 -P|--profile37 .RS 3n38 If samba has been compiled with the profiling option, print only the contents of the profiling shared memory area .28 \-P|\-\-profile 29 .RS 4 30 If samba has been compiled with the profiling option, print only the contents of the profiling shared memory area\. 39 31 .RE 40 32 .PP 41 -b|--brief42 .RS 3n43 gives brief output .33 \-b|\-\-brief 34 .RS 4 35 gives brief output\. 44 36 .RE 45 37 .PP 46 -V 47 .RS 3n 48 Prints the program version number. 38 \-d|\-\-debuglevel=level 39 .RS 4 40 \fIlevel\fR 41 is an integer from 0 to 10\. The default value if this parameter is not specified is 0\. 42 .sp 43 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 44 .sp 45 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 46 .sp 47 Note that specifying this parameter here will override the 48 \fIlog level\fR 49 parameter in the 50 \fIsmb\.conf\fR 51 file\. 49 52 .RE 50 53 .PP 51 -s <configuration file> 52 .RS 3n 53 The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See 54 \fIsmb.conf\fR 55 for more information. The default configuration file name is determined at compile time. 54 \-V 55 .RS 4 56 Prints the program version number\. 56 57 .RE 57 58 .PP 58 -d|--debuglevel=level 59 .RS 3n 60 \fIlevel\fR 61 is an integer from 0 to 10. The default value if this parameter is not specified is zero. 62 .sp 63 The higher this value, the more detail will be logged to the log files about the activities of the server. At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out. 64 .sp 65 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic. 66 .sp 67 Note that specifying this parameter here will override the 68 69 parameter in the 70 \fIsmb.conf\fR 71 file. 59 \-s <configuration file> 60 .RS 4 61 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 62 \fIsmb\.conf\fR 63 for more information\. The default configuration file name is determined at compile time\. 72 64 .RE 73 65 .PP 74 -l|--logfile=logdirectory75 .RS 3n76 Base directory name for log/debug files . The extension77 \fB" .progname"\fR78 will be appended (e .g. log.smbclient, log.smbd, etc...). The log file is never removed by the client.66 \-l|\-\-log\-basename=logdirectory 67 .RS 4 68 Base directory name for log/debug files\. The extension 69 \fB"\.progname"\fR 70 will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\. 79 71 .RE 80 72 .PP 81 -v|--verbose82 .RS 3n83 gives verbose output .73 \-v|\-\-verbose 74 .RS 4 75 gives verbose output\. 84 76 .RE 85 77 .PP 86 -L|--locks87 .RS 3n88 causes smbstatus to only list locks .78 \-L|\-\-locks 79 .RS 4 80 causes smbstatus to only list locks\. 89 81 .RE 90 82 .PP 91 -B|--byterange92 .RS 3n93 causes smbstatus to include byte range locks .83 \-B|\-\-byterange 84 .RS 4 85 causes smbstatus to include byte range locks\. 94 86 .RE 95 87 .PP 96 -p|--processes97 .RS 3n88 \-p|\-\-processes 89 .RS 4 98 90 print a list of 99 91 \fBsmbd\fR(8) 100 processes and exit . Useful for scripting.92 processes and exit\. Useful for scripting\. 101 93 .RE 102 94 .PP 103 -S|--shares104 .RS 3n105 causes smbstatus to only list shares .95 \-S|\-\-shares 96 .RS 4 97 causes smbstatus to only list shares\. 106 98 .RE 107 99 .PP 108 -h|--help109 .RS 3n110 Print a summary of command line options .100 \-h|\-\-help 101 .RS 4 102 Print a summary of command line options\. 111 103 .RE 112 104 .PP 113 -u|--user=<username>114 .RS 3n105 \-u|\-\-user=<username> 106 .RS 4 115 107 selects information relevant to 116 108 \fIusername\fR 117 only .109 only\. 118 110 .RE 119 111 .SH "VERSION" 120 112 .PP 121 This man page is correct for version 3 .0 of the Samba suite.113 This man page is correct for version 3\.0 of the Samba suite\. 122 114 .SH "SEE ALSO" 123 115 .PP 124 116 \fBsmbd\fR(8) 125 117 and 126 \fBsmb.conf\fR(5) .118 \fBsmb.conf\fR(5)\. 127 119 .SH "AUTHOR" 128 120 .PP 129 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.121 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 130 122 .PP 131 The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 132 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 133 123 The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 124 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/smbtar.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBTAR" 1 "" "" "" 1 .\" Title: smbtar 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBTAR" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbtar - shell script for backing up SMB/CIFS shares directly to UNIX tape drives 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 smbtar [ -r] [-i] [-a] [-v] {-s server} [-p password] [-x services] [-X] [-N filename] [-b blocksize] [-d directory] [-l loglevel] [-u user] [-ttape] {filenames}17 smbtar [\-r] [\-i] [\-a] [\-v] {\-s\ server} [\-p\ password] [\-x\ services] [\-X] [\-N\ filename] [\-b\ blocksize] [\-d\ directory] [\-l\ loglevel] [\-u\ user] [\-t\ tape] {filenames} 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 smbtar 33 25 is a very small shell script on top of 34 26 \fBsmbclient\fR(1) 35 which dumps SMB shares directly to tape .27 which dumps SMB shares directly to tape\. 36 28 .SH "OPTIONS" 37 29 .PP 38 -s server39 .RS 3n40 The SMB/CIFS server that the share resides upon .30 \-s server 31 .RS 4 32 The SMB/CIFS server that the share resides upon\. 41 33 .RE 42 34 .PP 43 -x service44 .RS 3n45 The share name on the server to connect to . The default is "backup".35 \-x service 36 .RS 4 37 The share name on the server to connect to\. The default is "backup"\. 46 38 .RE 47 39 .PP 48 -X49 .RS 3n50 Exclude mode . Exclude filenames... from tar create or restore.40 \-X 41 .RS 4 42 Exclude mode\. Exclude filenames\.\.\. from tar create or restore\. 51 43 .RE 52 44 .PP 53 -d directory54 .RS 3n45 \-d directory 46 .RS 4 55 47 Change to initial 56 48 \fIdirectory \fR 57 before restoring / backing up files .49 before restoring / backing up files\. 58 50 .RE 59 51 .PP 60 -v61 .RS 3n62 Verbose mode .52 \-v 53 .RS 4 54 Verbose mode\. 63 55 .RE 64 56 .PP 65 -p password66 .RS 3n67 The password to use to access a share . Default: none57 \-p password 58 .RS 4 59 The password to use to access a share\. Default: none 68 60 .RE 69 61 .PP 70 -u user71 .RS 3n72 The user id to connect as . Default: UNIX login name.62 \-u user 63 .RS 4 64 The user id to connect as\. Default: UNIX login name\. 73 65 .RE 74 66 .PP 75 -a76 .RS 3n77 Reset DOS archive bit mode to indicate file has been archived .67 \-a 68 .RS 4 69 Reset DOS archive bit mode to indicate file has been archived\. 78 70 .RE 79 71 .PP 80 -t tape81 .RS 3n82 Tape device . May be regular file or tape device. Default:72 \-t tape 73 .RS 4 74 Tape device\. May be regular file or tape device\. Default: 83 75 \fI$TAPE\fR 84 76 environmental variable; if not set, a file called 85 \fItar .out \fR.77 \fItar\.out \fR\. 86 78 .RE 87 79 .PP 88 -b blocksize89 .RS 3n90 Blocking factor . Defaults to 20. See80 \-b blocksize 81 .RS 4 82 Blocking factor\. Defaults to 20\. See 91 83 tar(1) 92 for a fuller explanation .84 for a fuller explanation\. 93 85 .RE 94 86 .PP 95 -N filename96 .RS 3n97 Backup only files newer than filename . Could be used (for example) on a log file to implement incremental backups.87 \-N filename 88 .RS 4 89 Backup only files newer than filename\. Could be used (for example) on a log file to implement incremental backups\. 98 90 .RE 99 91 .PP 100 -i101 .RS 3n102 Incremental mode; tar files are only backed up if they have the archive bit set . The archive bit is reset after each file is read.92 \-i 93 .RS 4 94 Incremental mode; tar files are only backed up if they have the archive bit set\. The archive bit is reset after each file is read\. 103 95 .RE 104 96 .PP 105 -r106 .RS 3n107 Restore . Files are restored to the share from the tar file.97 \-r 98 .RS 4 99 Restore\. Files are restored to the share from the tar file\. 108 100 .RE 109 101 .PP 110 -l log level111 .RS 3n112 Log (debug) level . Corresponds to the113 \fI -d\fR102 \-l log level 103 .RS 4 104 Log (debug) level\. Corresponds to the 105 \fI\-d\fR 114 106 flag of 115 \fBsmbclient\fR(1) .107 \fBsmbclient\fR(1)\. 116 108 .RE 117 109 .SH "ENVIRONMENT VARIABLES" … … 119 111 The 120 112 \fI$TAPE\fR 121 variable specifies the default tape device to write to . May be overridden with the -t option.113 variable specifies the default tape device to write to\. May be overridden with the \-t option\. 122 114 .SH "BUGS" 123 115 .PP 124 116 The 125 117 smbtar 126 script has different options from ordinary tar and from smbclient 's tar command.118 script has different options from ordinary tar and from smbclient\'s tar command\. 127 119 .SH "CAVEATS" 128 120 .PP 129 Sites that are more careful about security may not like the way the script handles PC passwords . Backup and restore work on entire shares; should work on file lists. smbtar works best with GNU tar and may not work well with other versions.121 Sites that are more careful about security may not like the way the script handles PC passwords\. Backup and restore work on entire shares; should work on file lists\. smbtar works best with GNU tar and may not work well with other versions\. 130 122 .SH "DIAGNOSTICS" 131 123 .PP 132 124 See the 133 \f BDIAGNOSTICS\fR125 \fIDIAGNOSTICS\fR 134 126 section for the 135 127 \fBsmbclient\fR(1) 136 command .128 command\. 137 129 .SH "VERSION" 138 130 .PP 139 This man page is correct for version 3 .0 of the Samba suite.131 This man page is correct for version 3\.0 of the Samba suite\. 140 132 .SH "SEE ALSO" 141 133 .PP 142 134 \fBsmbd\fR(8), 143 135 \fBsmbclient\fR(1), 144 \fBsmb.conf\fR(5) .136 \fBsmb.conf\fR(5)\. 145 137 .SH "AUTHOR" 146 138 .PP 147 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.139 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 148 140 .PP 149 141 Ricky Poulten 150 wrote the tar extension and this man page . The142 wrote the tar extension and this man page\. The 151 143 smbtar 152 144 script was heavily rewritten and improved by 153 Martin Kraemer. Many thanks to everyone who suggested extensions, improvements, bug fixes, etc. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 154 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 155 145 Martin Kraemer\. Many thanks to everyone who suggested extensions, improvements, bug fixes, etc\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 146 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/smbtree.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBTREE" 1 "" "" "" 1 .\" Title: smbtree 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBTREE" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbtree - A text based smb network browser 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 smbtree [ -b] [-D] [-S]17 smbtree [\-b] [\-D] [\-S] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 smbtree 33 is a smb browser program in text mode . It is similar to the "Network Neighborhood" found on Windows computers. It prints a tree with all the known domains, the servers in those domains and the shares on the servers.25 is a smb browser program in text mode\. It is similar to the "Network Neighborhood" found on Windows computers\. It prints a tree with all the known domains, the servers in those domains and the shares on the servers\. 34 26 .SH "OPTIONS" 35 27 .PP 36 -b37 .RS 3n38 Query network nodes by sending requests as broadcasts instead of querying the local master browser .28 \-b 29 .RS 4 30 Query network nodes by sending requests as broadcasts instead of querying the local master browser\. 39 31 .RE 40 32 .PP 41 -D42 .RS 3n33 \-D 34 .RS 4 43 35 Only print a list of all the domains known on broadcast or by the master browser 44 36 .RE 45 37 .PP 46 -S47 .RS 3n48 Only print a list of all the domains and servers responding on broadcast or known by the master browser .38 \-S 39 .RS 4 40 Only print a list of all the domains and servers responding on broadcast or known by the master browser\. 49 41 .RE 50 42 .PP 51 -V 52 .RS 3n 53 Prints the program version number. 43 \-d|\-\-debuglevel=level 44 .RS 4 45 \fIlevel\fR 46 is an integer from 0 to 10\. The default value if this parameter is not specified is 0\. 47 .sp 48 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 49 .sp 50 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 51 .sp 52 Note that specifying this parameter here will override the 53 \fIlog level\fR 54 parameter in the 55 \fIsmb\.conf\fR 56 file\. 54 57 .RE 55 58 .PP 56 -s <configuration file> 57 .RS 3n 58 The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See 59 \fIsmb.conf\fR 60 for more information. The default configuration file name is determined at compile time. 59 \-V 60 .RS 4 61 Prints the program version number\. 61 62 .RE 62 63 .PP 63 -d|--debuglevel=level 64 .RS 3n 65 \fIlevel\fR 66 is an integer from 0 to 10. The default value if this parameter is not specified is zero. 67 .sp 68 The higher this value, the more detail will be logged to the log files about the activities of the server. At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out. 69 .sp 70 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic. 71 .sp 72 Note that specifying this parameter here will override the 73 74 parameter in the 75 \fIsmb.conf\fR 76 file. 64 \-s <configuration file> 65 .RS 4 66 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 67 \fIsmb\.conf\fR 68 for more information\. The default configuration file name is determined at compile time\. 77 69 .RE 78 70 .PP 79 -l|--logfile=logdirectory80 .RS 3n81 Base directory name for log/debug files . The extension82 \fB" .progname"\fR83 will be appended (e .g. log.smbclient, log.smbd, etc...). The log file is never removed by the client.71 \-l|\-\-log\-basename=logdirectory 72 .RS 4 73 Base directory name for log/debug files\. The extension 74 \fB"\.progname"\fR 75 will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\. 84 76 .RE 85 77 .PP 86 -N87 .RS 3n88 If specified, this parameter suppresses the normal password prompt from the client to the user . This is useful when accessing a service that does not require a password.78 \-N 79 .RS 4 80 If specified, this parameter suppresses the normal password prompt from the client to the user\. This is useful when accessing a service that does not require a password\. 89 81 .sp 90 Unless a password is specified on the command line or this parameter is specified, the client will request a password .82 Unless a password is specified on the command line or this parameter is specified, the client will request a password\. 91 83 .sp 92 If a password is specified on the command line and this option is also defined the password on the command line will be silently ingnored and no password will be used .84 If a password is specified on the command line and this option is also defined the password on the command line will be silently ingnored and no password will be used\. 93 85 .RE 94 86 .PP 95 -k96 .RS 3n97 Try to authenticate with kerberos . Only useful in an Active Directory environment.87 \-k 88 .RS 4 89 Try to authenticate with kerberos\. Only useful in an Active Directory environment\. 98 90 .RE 99 91 .PP 100 -A|--authentication-file=filename101 .RS 3n102 This option allows you to specify a file from which to read the username and password used in the connection . The format of the file is92 \-A|\-\-authentication\-file=filename 93 .RS 4 94 This option allows you to specify a file from which to read the username and password used in the connection\. The format of the file is 103 95 .sp 104 105 96 .sp 106 97 .RS 4 107 98 .nf 108 109 99 username = <value> 110 100 password = <value> 111 101 domain = <value> 112 113 102 .fi 114 103 .RE 115 104 .sp 116 Make certain that the permissions on the file restrict access from unwanted users .105 Make certain that the permissions on the file restrict access from unwanted users\. 117 106 .RE 118 107 .PP 119 -U|--user=username[%password]120 .RS 3n121 Sets the SMB username or username and password .108 \-U|\-\-user=username[%password] 109 .RS 4 110 Sets the SMB username or username and password\. 122 111 .sp 123 If %password is not specified, the user will be prompted . The client will first check the112 If %password is not specified, the user will be prompted\. The client will first check the 124 113 \fBUSER\fR 125 114 environment variable, then the 126 115 \fBLOGNAME\fR 127 variable and if either exists, the string is uppercased . If these environmental variables are not found, the username116 variable and if either exists, the string is uppercased\. If these environmental variables are not found, the username 128 117 \fBGUEST\fR 129 is used .118 is used\. 130 119 .sp 131 A third option is to use a credentials file which contains the plaintext of the username and password . This option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables. If this method is used, make certain that the permissions on the file restrict access from unwanted users. See the132 \fI -A\fR133 for more details .120 A third option is to use a credentials file which contains the plaintext of the username and password\. This option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables\. If this method is used, make certain that the permissions on the file restrict access from unwanted users\. See the 121 \fI\-A\fR 122 for more details\. 134 123 .sp 135 Be cautious about including passwords in scripts . Also, on many systems the command line of a running process may be seen via the124 Be cautious about including passwords in scripts\. Also, on many systems the command line of a running process may be seen via the 136 125 ps 137 command . To be safe always allow126 command\. To be safe always allow 138 127 rpcclient 139 to prompt for a password and type it in directly .128 to prompt for a password and type it in directly\. 140 129 .RE 141 130 .PP 142 -h|--help143 .RS 3n144 Print a summary of command line options .131 \-h|\-\-help 132 .RS 4 133 Print a summary of command line options\. 145 134 .RE 146 135 .SH "VERSION" 147 136 .PP 148 This man page is correct for version 3 .0 of the Samba suite.137 This man page is correct for version 3\.0 of the Samba suite\. 149 138 .SH "AUTHOR" 150 139 .PP 151 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.140 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 152 141 .PP 153 The smbtree man page was written by Jelmer Vernooij. 154 142 The smbtree man page was written by Jelmer Vernooij\. -
branches/samba-3.0/docs/manpages/smbumount.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBUMOUNT" 8 "" "" "" 1 .\" Title: smbumount 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: 6 .\" Source: 7 .\" 8 .TH "SMBUMOUNT" "8" "05/21/2008" "" "" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbumount - smbfs umount for normal users 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 smbumount {mount -point}17 smbumount {mount\-point} 26 18 .SH "DESCRIPTION" 27 19 .PP 28 With this program, normal users can unmount smb -filesystems, provided that it is suid root.20 With this program, normal users can unmount smb\-filesystems, provided that it is suid root\. 29 21 smbumount 30 has been written to give normal Linux users more control over their resources . It is safe to install this program suid root, because only the user who has mounted a filesystem is allowed to unmount it again. For root it is not necessary to use smbumount. The normal umount program works perfectly well.22 has been written to give normal Linux users more control over their resources\. It is safe to install this program suid root, because only the user who has mounted a filesystem is allowed to unmount it again\. For root it is not necessary to use smbumount\. The normal umount program works perfectly well\. 31 23 .PP 32 24 WARNING: 33 25 smbumount 34 is deprecated and not maintained any longer .35 umount .cifs26 is deprecated and not maintained any longer\. 27 umount\.cifs 36 28 should be used instead of 37 smbumount .29 smbumount\. 38 30 .SH "OPTIONS" 39 31 .PP 40 mount -point41 .RS 3n42 The directory to unmount .32 mount\-point 33 .RS 4 34 The directory to unmount\. 43 35 .RE 44 36 .SH "SEE ALSO" … … 47 39 .SH "AUTHOR" 48 40 .PP 49 Volker Lendecke, Andrew Tridgell, Michael H . Warfield and others.41 Volker Lendecke, Andrew Tridgell, Michael H\. Warfield and others\. 50 42 .PP 51 43 The current maintainer of smbfs and the userspace tools … … 54 46 smbmnt 55 47 is 56 Urban Widmark . The48 Urban Widmark\. The 57 49 SAMBA Mailing list 58 is the preferred place to ask questions regarding these programs .50 is the preferred place to ask questions regarding these programs\. 59 51 .PP 60 The conversion of this manpage for Samba 2.2 was performed by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 61 52 The conversion of this manpage for Samba 2\.2 was performed by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/swat.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SWAT" 8 "" "" "" 1 .\" Title: swat 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SWAT" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 swat - Samba Web Administration Tool 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 swat [ -s <smb config file>] [-a] [-P]17 swat [\-s\ <smb\ config\ file>] [\-a] [\-P] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 swat 33 25 allows a Samba administrator to configure the complex 34 26 \fBsmb.conf\fR(5) 35 file via a Web browser . In addition, a27 file via a Web browser\. In addition, a 36 28 swat 37 29 configuration page has help links to all the configurable options in the 38 \fIsmb .conf\fR39 file allowing an administrator to easily look up the effects of any change .30 \fIsmb\.conf\fR 31 file allowing an administrator to easily look up the effects of any change\. 40 32 .PP 41 33 swat … … 44 36 .SH "OPTIONS" 45 37 .PP 46 -s smb configuration file47 .RS 3n48 The default configuration file path is determined at compile time . The file specified contains the configuration details required by the38 \-s smb configuration file 39 .RS 4 40 The default configuration file path is determined at compile time\. The file specified contains the configuration details required by the 49 41 \fBsmbd\fR(8) 50 server . This is the file that51 swat 52 will modify . The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See53 \fIsmb .conf\fR54 for more information .55 .RE 56 .PP 57 -a58 .RS 3n42 server\. This is the file that 43 swat 44 will modify\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 45 \fIsmb\.conf\fR 46 for more information\. 47 .RE 48 .PP 49 \-a 50 .RS 4 59 51 This option disables authentication and places 60 52 swat 61 in demo mode. In that mode anyone will be able to modify the 62 \fIsmb.conf\fR 63 file. 64 .sp 65 \fBWARNING: Do NOT enable this option on a production server. \fR 66 .RE 67 .PP 68 -P 69 .RS 3n 70 This option restricts read-only users to the password management page. 71 swat 72 can then be used to change user passwords without users seeing the "View" and "Status" menu buttons. 73 .RE 74 .PP 75 -V 76 .RS 3n 77 Prints the program version number. 78 .RE 79 .PP 80 -s <configuration file> 81 .RS 3n 82 The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See 83 \fIsmb.conf\fR 84 for more information. The default configuration file name is determined at compile time. 85 .RE 86 .PP 87 -d|--debuglevel=level 88 .RS 3n 53 in demo mode\. In that mode anyone will be able to modify the 54 \fIsmb\.conf\fR 55 file\. 56 .sp 57 \fIWARNING: Do NOT enable this option on a production server\. \fR 58 .RE 59 .PP 60 \-P 61 .RS 4 62 This option restricts read\-only users to the password management page\. 63 swat 64 can then be used to change user passwords without users seeing the "View" and "Status" menu buttons\. 65 .RE 66 .PP 67 \-d|\-\-debuglevel=level 68 .RS 4 89 69 \fIlevel\fR 90 is an integer from 0 to 10 . The default value if this parameter is not specified is zero.91 .sp 92 The higher this value, the more detail will be logged to the log files about the activities of the server . At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out.93 .sp 94 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem . Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic.70 is an integer from 0 to 10\. The default value if this parameter is not specified is 0\. 71 .sp 72 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 73 .sp 74 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 95 75 .sp 96 76 Note that specifying this parameter here will override the 97 77 \fIlog level\fR 98 78 parameter in the 99 \fIsmb.conf\fR 100 file. 101 .RE 102 .PP 103 -l|--logfile=logdirectory 104 .RS 3n 105 Base directory name for log/debug files. The extension 106 \fB".progname"\fR 107 will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client. 108 .RE 109 .PP 110 -h|--help 111 .RS 3n 112 Print a summary of command line options. 79 \fIsmb\.conf\fR 80 file\. 81 .RE 82 .PP 83 \-V 84 .RS 4 85 Prints the program version number\. 86 .RE 87 .PP 88 \-s <configuration file> 89 .RS 4 90 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 91 \fIsmb\.conf\fR 92 for more information\. The default configuration file name is determined at compile time\. 93 .RE 94 .PP 95 \-l|\-\-log\-basename=logdirectory 96 .RS 4 97 Base directory name for log/debug files\. The extension 98 \fB"\.progname"\fR 99 will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\. 100 .RE 101 .PP 102 \-h|\-\-help 103 .RS 4 104 Print a summary of command line options\. 113 105 .RE 114 106 .SH "INSTALLATION" 115 107 .PP 116 Swat is included as binary package with most distributions . The package manager in this case takes care of the installation and configuration. This section is only for those who have compiled swat from scratch.108 Swat is included as binary package with most distributions\. The package manager in this case takes care of the installation and configuration\. This section is only for those who have compiled swat from scratch\. 117 109 .PP 118 110 After you compile SWAT you need to run … … 120 112 to install the 121 113 swat 122 binary and the various help files and images. A default install would put these in: 123 .TP 3n 124 \(bu 114 binary and the various help files and images\. A default install would put these in: 115 .sp 116 .RS 4 117 .ie n \{\ 118 \h'-04'\(bu\h'+03'\c 119 .\} 120 .el \{\ 121 .sp -1 122 .IP \(bu 2.3 123 .\} 125 124 /usr/local/samba/sbin/swat 126 .TP 3n 127 \(bu 125 .RE 126 .sp 127 .RS 4 128 .ie n \{\ 129 \h'-04'\(bu\h'+03'\c 130 .\} 131 .el \{\ 132 .sp -1 133 .IP \(bu 2.3 134 .\} 128 135 /usr/local/samba/swat/images/* 129 .TP 3n 130 \(bu 136 .RE 137 .sp 138 .RS 4 139 .ie n \{\ 140 \h'-04'\(bu\h'+03'\c 141 .\} 142 .el \{\ 143 .sp -1 144 .IP \(bu 2.3 145 .\} 131 146 /usr/local/samba/swat/help/* 147 .sp 148 .RE 132 149 .SS "Inetd Installation" 133 150 .PP 134 151 You need to edit your 135 \fI/etc/inetd .conf \fR152 \fI/etc/inetd\.conf \fR 136 153 and 137 154 \fI/etc/services\fR 138 155 to enable SWAT to be launched via 139 inetd .156 inetd\. 140 157 .PP 141 158 In … … 145 162 swat 901/tcp 146 163 .PP 147 Note for NIS/YP and LDAP users - you may need to rebuild the NIS service maps rather than alter your local164 Note for NIS/YP and LDAP users \- you may need to rebuild the NIS service maps rather than alter your local 148 165 \fI /etc/services\fR 149 file .150 .PP 151 the choice of port number isn 't really important except that it should be less than 1024 and not currently used (using a number above 1024 presents an obscure security hole depending on the implementation details of your166 file\. 167 .PP 168 the choice of port number isn\'t really important except that it should be less than 1024 and not currently used (using a number above 1024 presents an obscure security hole depending on the implementation details of your 152 169 inetd 153 daemon) .170 daemon)\. 154 171 .PP 155 172 In 156 \fI/etc/inetd .conf\fR173 \fI/etc/inetd\.conf\fR 157 174 you should add a line like this: 158 175 .PP 159 swat stream tcp nowait .400 root /usr/local/samba/sbin/swat swat176 swat stream tcp nowait\.400 root /usr/local/samba/sbin/swat swat 160 177 .PP 161 178 Once you have edited 162 179 \fI/etc/services\fR 163 180 and 164 \fI/etc/inetd .conf\fR165 you need to send a HUP signal to inetd . To do this use166 kill -1 PID167 where PID is the process ID of the inetd daemon .181 \fI/etc/inetd\.conf\fR 182 you need to send a HUP signal to inetd\. To do this use 183 kill \-1 PID 184 where PID is the process ID of the inetd daemon\. 168 185 .SH "LAUNCHING" 169 186 .PP 170 To launch SWAT just run your favorite web browser and point it at "http://localhost:901/" .171 .PP 172 Note that you can attach to SWAT from any IP connected machine but connecting from a remote machine leaves your connection open to password sniffing as passwords will be sent in the clear over the wire .187 To launch SWAT just run your favorite web browser and point it at "http://localhost:901/"\. 188 .PP 189 Note that you can attach to SWAT from any IP connected machine but connecting from a remote machine leaves your connection open to password sniffing as passwords will be sent in the clear over the wire\. 173 190 .SH "FILES" 174 191 .PP 175 \fI/etc/inetd .conf\fR176 .RS 3n177 This file must contain suitable startup information for the meta -daemon.178 .RE 179 .PP 180 \fI/etc/services\fR 181 .RS 3n182 This file must contain a mapping of service name (e .g., swat) to service port (e.g., 901) and protocol type (e.g., tcp).183 .RE 184 .PP 185 \fI/usr/local/samba/lib/smb .conf\fR186 .RS 3n192 \fI/etc/inetd\.conf\fR 193 .RS 4 194 This file must contain suitable startup information for the meta\-daemon\. 195 .RE 196 .PP 197 \fI/etc/services\fR 198 .RS 4 199 This file must contain a mapping of service name (e\.g\., swat) to service port (e\.g\., 901) and protocol type (e\.g\., tcp)\. 200 .RE 201 .PP 202 \fI/usr/local/samba/lib/smb\.conf\fR 203 .RS 4 187 204 This is the default location of the 188 205 \fBsmb.conf\fR(5) 189 server configuration file that swat edits . Other common places that systems install this file are190 \fI /usr/samba/lib/smb .conf\fR191 and 192 \fI/etc/smb .conf \fR. This file describes all the services the server is to make available to clients.206 server configuration file that swat edits\. Other common places that systems install this file are 207 \fI /usr/samba/lib/smb\.conf\fR 208 and 209 \fI/etc/smb\.conf \fR\. This file describes all the services the server is to make available to clients\. 193 210 .RE 194 211 .SH "WARNINGS" … … 197 214 will rewrite your 198 215 \fBsmb.conf\fR(5) 199 file . It will rearrange the entries and delete all comments,216 file\. It will rearrange the entries and delete all comments, 200 217 \fIinclude=\fR 201 218 and 202 219 \fIcopy= \fR 203 options . If you have a carefully crafted204 \fI smb .conf\fR205 then back it up or don 't use swat!220 options\. If you have a carefully crafted 221 \fI smb\.conf\fR 222 then back it up or don\'t use swat! 206 223 .SH "VERSION" 207 224 .PP 208 This man page is correct for version 3 .0 of the Samba suite.225 This man page is correct for version 3\.0 of the Samba suite\. 209 226 .SH "SEE ALSO" 210 227 .PP … … 214 231 .SH "AUTHOR" 215 232 .PP 216 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 217 .PP 218 The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 219 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 220 233 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 234 .PP 235 The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 236 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/tdbbackup.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "TDBBACKUP" 8 "" "" "" 1 .\" Title: tdbbackup 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "TDBBACKUP" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 tdbbackup - tool for backing up and for validating the integrity of samba .tdb files 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 tdbbackup [ -s suffix] [-v] [-h]17 tdbbackup [\-s\ suffix] [\-v] [\-h] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(1) 30 suite .22 suite\. 31 23 .PP 32 24 tdbbackup 33 is a tool that may be used to backup samba .tdb files. This tool may also be used to verify the integrity of the .tdb files prior to samba startup or during normal operation. If it finds file damage and it finds a prior backup the backup file will be restored.25 is a tool that may be used to backup samba \.tdb files\. This tool may also be used to verify the integrity of the \.tdb files prior to samba startup or during normal operation\. If it finds file damage and it finds a prior backup the backup file will be restored\. 34 26 .SH "OPTIONS" 35 27 .PP 36 -h37 .RS 3n38 Get help information .28 \-h 29 .RS 4 30 Get help information\. 39 31 .RE 40 32 .PP 41 -s suffix42 .RS 3n33 \-s suffix 34 .RS 4 43 35 The 44 -s45 option allows the adminisistrator to specify a file backup extension . This way it is possible to keep a history of tdb backup files by using a new suffix for each backup.36 \-s 37 option allows the adminisistrator to specify a file backup extension\. This way it is possible to keep a history of tdb backup files by using a new suffix for each backup\. 46 38 .RE 47 39 .PP 48 -v49 .RS 3n40 \-v 41 .RS 4 50 42 The 51 -v52 will check the database for damages (currupt data) which if detected causes the backup to be restored .43 \-v 44 will check the database for damages (currupt data) which if detected causes the backup to be restored\. 53 45 .RE 54 46 .SH "COMMANDS" 55 47 .PP 56 \f BGENERAL INFORMATION\fR48 \fIGENERAL INFORMATION\fR 57 49 .PP 58 50 The 59 51 tdbbackup 60 utility can safely be run at any time . It was designed so that it can be used at any time to validate the integrity of tdb files, even during Samba operation. Typical usage for the command will be:52 utility can safely be run at any time\. It was designed so that it can be used at any time to validate the integrity of tdb files, even during Samba operation\. Typical usage for the command will be: 61 53 .PP 62 tdbbackup [ -s suffix] *.tdb54 tdbbackup [\-s suffix] *\.tdb 63 55 .PP 64 Before restarting samba the following command may be run to validate .tdb files:56 Before restarting samba the following command may be run to validate \.tdb files: 65 57 .PP 66 tdbbackup -v [-s suffix] *.tdb58 tdbbackup \-v [\-s suffix] *\.tdb 67 59 .PP 68 Samba .tdb files are stored in various locations, be sure to run backup all .tdb file on the system. Important files includes: 69 .TP 3n 70 \(bu 60 Samba \.tdb files are stored in various locations, be sure to run backup all \.tdb file on the system\. Important files includes: 61 .sp 62 .RS 4 63 .ie n \{\ 64 \h'-04'\(bu\h'+03'\c 65 .\} 66 .el \{\ 67 .sp -1 68 .IP \(bu 2.3 69 .\} 71 70 72 secrets.tdb 73 - usual location is in the /usr/local/samba/private directory, or on some systems in /etc/samba. 74 .TP 3n 75 \(bu 71 secrets\.tdb 72 \- usual location is in the /usr/local/samba/private directory, or on some systems in /etc/samba\. 73 .RE 74 .sp 75 .RS 4 76 .ie n \{\ 77 \h'-04'\(bu\h'+03'\c 78 .\} 79 .el \{\ 80 .sp -1 81 .IP \(bu 2.3 82 .\} 76 83 77 passdb.tdb 78 - usual location is in the /usr/local/samba/private directory, or on some systems in /etc/samba. 79 .TP 3n 80 \(bu 84 passdb\.tdb 85 \- usual location is in the /usr/local/samba/private directory, or on some systems in /etc/samba\. 86 .RE 87 .sp 88 .RS 4 89 .ie n \{\ 90 \h'-04'\(bu\h'+03'\c 91 .\} 92 .el \{\ 93 .sp -1 94 .IP \(bu 2.3 95 .\} 81 96 82 * .tdb83 located in the /usr/local/samba/var directory or on some systems in the /var/cache or /var/lib/samba directories .97 *\.tdb 98 located in the /usr/local/samba/var directory or on some systems in the /var/cache or /var/lib/samba directories\. 84 99 .SH "VERSION" 85 100 .PP 86 This man page is correct for version 3 .0 of the Samba suite.101 This man page is correct for version 3\.0 of the Samba suite\. 87 102 .SH "AUTHOR" 88 103 .PP 89 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.104 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 90 105 .PP 91 The tdbbackup man page was written by John H Terpstra. 92 106 The tdbbackup man page was written by John H Terpstra\. -
branches/samba-3.0/docs/manpages/tdbdump.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "TDBDUMP" 8 "" "" "" 1 .\" Title: tdbdump 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "TDBDUMP" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 tdbdump - tool for printing the contents of a TDB file … … 28 20 This tool is part of the 29 21 \fBsamba\fR(1) 30 suite .22 suite\. 31 23 .PP 32 24 tdbdump 33 is a very simple utility that 'dumps' the contents of a TDB (Trivial DataBase) file to standard output in a human-readable format.25 is a very simple utility that \'dumps\' the contents of a TDB (Trivial DataBase) file to standard output in a human\-readable format\. 34 26 .PP 35 This tool can be used when debugging problems with TDB files . It is intended for those who are somewhat familiar with Samba internals.27 This tool can be used when debugging problems with TDB files\. It is intended for those who are somewhat familiar with Samba internals\. 36 28 .SH "VERSION" 37 29 .PP 38 This man page is correct for version 3 .0 of the Samba suite.30 This man page is correct for version 3\.0 of the Samba suite\. 39 31 .SH "AUTHOR" 40 32 .PP 41 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.33 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 42 34 .PP 43 The tdbdump man page was written by Jelmer Vernooij. 44 35 The tdbdump man page was written by Jelmer Vernooij\. -
branches/samba-3.0/docs/manpages/tdbtool.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "TDBTOOL" 8 "" "" "" 1 .\" Title: tdbtool 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "TDBTOOL" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 tdbtool - manipulate the contents TDB files … … 30 22 This tool is part of the 31 23 \fBsamba\fR(1) 32 suite .24 suite\. 33 25 .PP 34 26 tdbtool 35 a tool for displaying and altering the contents of Samba TDB (Trivial DataBase) files . Each of the commands listed below can be entered interactively or provided on the command line.27 a tool for displaying and altering the contents of Samba TDB (Trivial DataBase) files\. Each of the commands listed below can be entered interactively or provided on the command line\. 36 28 .SH "COMMANDS" 37 29 .PP 38 30 \fBcreate\fR \fITDBFILE\fR 39 .RS 3n31 .RS 4 40 32 Create a new database named 41 \fITDBFILE\fR .33 \fITDBFILE\fR\. 42 34 .RE 43 35 .PP 44 36 \fBopen\fR \fITDBFILE\fR 45 .RS 3n37 .RS 4 46 38 Open an existing database named 47 \fITDBFILE\fR .39 \fITDBFILE\fR\. 48 40 .RE 49 41 .PP 50 42 \fBerase\fR 51 .RS 3n52 Erase the current database .43 .RS 4 44 Erase the current database\. 53 45 .RE 54 46 .PP 55 47 \fBdump\fR 56 .RS 3n57 Dump the current database as strings .48 .RS 4 49 Dump the current database as strings\. 58 50 .RE 59 51 .PP 60 52 \fBcdump\fR 61 .RS 3n62 Dump the current database as connection records .53 .RS 4 54 Dump the current database as connection records\. 63 55 .RE 64 56 .PP 65 57 \fBkeys\fR 66 .RS 3n67 Dump the current database keys as strings .58 .RS 4 59 Dump the current database keys as strings\. 68 60 .RE 69 61 .PP 70 62 \fBhexkeys\fR 71 .RS 3n72 Dump the current database keys as hex values .63 .RS 4 64 Dump the current database keys as hex values\. 73 65 .RE 74 66 .PP 75 67 \fBinfo\fR 76 .RS 3n77 Print summary information about the current database .68 .RS 4 69 Print summary information about the current database\. 78 70 .RE 79 71 .PP 80 72 \fBinsert\fR \fIKEY\fR \fIDATA\fR 81 .RS 3n82 Insert a record into the current database .73 .RS 4 74 Insert a record into the current database\. 83 75 .RE 84 76 .PP 85 77 \fBmove\fR \fIKEY\fR \fITDBFILE\fR 86 .RS 3n78 .RS 4 87 79 Move a record from the current database into 88 \fITDBFILE\fR .80 \fITDBFILE\fR\. 89 81 .RE 90 82 .PP 91 83 \fBstore\fR \fIKEY\fR \fIDATA\fR 92 .RS 3n93 Store (replace) a record in the current database .84 .RS 4 85 Store (replace) a record in the current database\. 94 86 .RE 95 87 .PP 96 88 \fBshow\fR \fIKEY\fR 97 .RS 3n98 Show a record by key .89 .RS 4 90 Show a record by key\. 99 91 .RE 100 92 .PP 101 93 \fBdelete\fR \fIKEY\fR 102 .RS 3n103 Delete a record by key .94 .RS 4 95 Delete a record by key\. 104 96 .RE 105 97 .PP 106 98 \fBlist\fR 107 .RS 3n108 Print the current database hash table and free list .99 .RS 4 100 Print the current database hash table and free list\. 109 101 .RE 110 102 .PP 111 103 \fBfree\fR 112 .RS 3n113 Print the current database and free list .104 .RS 4 105 Print the current database and free list\. 114 106 .RE 115 107 .PP 116 108 \fB!\fR \fICOMMAND\fR 117 .RS 3n118 Execute the given system command .109 .RS 4 110 Execute the given system command\. 119 111 .RE 120 112 .PP 121 113 \fBfirst\fR 122 .RS 3n123 Print the first record in the current database .114 .RS 4 115 Print the first record in the current database\. 124 116 .RE 125 117 .PP 126 118 \fBnext\fR 127 .RS 3n128 Print the next record in the current database .119 .RS 4 120 Print the next record in the current database\. 129 121 .RE 130 122 .PP 131 123 \fBquit\fR 132 .RS 3n124 .RS 4 133 125 Exit 134 tdbtool .126 tdbtool\. 135 127 .RE 136 128 .SH "CAVEATS" 137 129 .PP 138 130 The contents of the Samba TDB files are private to the implementation and should not be altered with 139 tdbtool .131 tdbtool\. 140 132 .SH "VERSION" 141 133 .PP 142 This man page is correct for version 3 .0.25 of the Samba suite.134 This man page is correct for version 3\.0\.25 of the Samba suite\. 143 135 .SH "AUTHOR" 144 136 .PP 145 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 146 137 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. -
branches/samba-3.0/docs/manpages/testparm.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "TESTPARM" 1 "" "" "" 1 .\" Title: testparm 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "TESTPARM" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 testparm - check an smb.conf configuration file for internal correctness 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 testparm [ -s] [-h] [-v] [-L <servername>] [-t <encoding>] {config filename} [hostnamehostIP]17 testparm [\-s] [\-h] [\-v] [\-L\ <servername>] [\-t\ <encoding>] {config\ filename} [hostname\ hostIP] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 testparm 33 25 is a very simple test program to check an 34 26 \fBsmbd\fR(8) 35 configuration file for internal correctness . If this program reports no problems, you can use the configuration file with confidence that27 configuration file for internal correctness\. If this program reports no problems, you can use the configuration file with confidence that 36 28 smbd 37 will successfully load the configuration file .29 will successfully load the configuration file\. 38 30 .PP 39 31 Note that this is 40 \f BNOT\fR41 a guarantee that the services specified in the configuration file will be available or will operate as expected .32 \fINOT\fR 33 a guarantee that the services specified in the configuration file will be available or will operate as expected\. 42 34 .PP 43 If the optional host name and host IP address are specified on the command line, this test program will run through the service entries reporting whether the specified host has access to each service .35 If the optional host name and host IP address are specified on the command line, this test program will run through the service entries reporting whether the specified host has access to each service\. 44 36 .PP 45 37 If 46 38 testparm 47 39 finds an error in the 48 \fI smb .conf\fR49 file it returns an exit code of 1 to the calling program, else it returns an exit code of 0 . This allows shell scripts to test the output from50 testparm .40 \fI smb\.conf\fR 41 file it returns an exit code of 1 to the calling program, else it returns an exit code of 0\. This allows shell scripts to test the output from 42 testparm\. 51 43 .SH "OPTIONS" 52 44 .PP 53 -s54 .RS 3n45 \-s 46 .RS 4 55 47 Without this option, 56 48 testparm 57 will prompt for a carriage return after printing the service names and before dumping the service definitions .49 will prompt for a carriage return after printing the service names and before dumping the service definitions\. 58 50 .RE 59 51 .PP 60 -h|--help61 .RS 3n62 Print a summary of command line options .52 \-h|\-\-help 53 .RS 4 54 Print a summary of command line options\. 63 55 .RE 64 56 .PP 65 -V66 .RS 3n67 Prints the program version number .57 \-V 58 .RS 4 59 Prints the program version number\. 68 60 .RE 69 61 .PP 70 -L servername71 .RS 3n62 \-L servername 63 .RS 4 72 64 Sets the value of the %L macro to 73 \fIservername\fR . This is useful for testing include files specified with the %L macro.65 \fIservername\fR\. This is useful for testing include files specified with the %L macro\. 74 66 .RE 75 67 .PP 76 -v77 .RS 3n68 \-v 69 .RS 4 78 70 If this option is specified, testparm will also output all options that were not used in 79 71 \fBsmb.conf\fR(5) 80 and are thus set to their defaults .72 and are thus set to their defaults\. 81 73 .RE 82 74 .PP 83 -t encoding84 .RS 3n85 Output data in specified encoding .75 \-t encoding 76 .RS 4 77 Output data in specified encoding\. 86 78 .RE 87 79 .PP 88 --parameter-name parametername89 .RS 3n90 Dumps the named parameter . If no section-name is set the view is limited by default to the global section. It is also possible to dump a parametrical option. Therfore the option has to be separated by a colon from the parametername.80 \-\-parameter\-name parametername 81 .RS 4 82 Dumps the named parameter\. If no section\-name is set the view is limited by default to the global section\. It is also possible to dump a parametrical option\. Therfore the option has to be separated by a colon from the parametername\. 91 83 .RE 92 84 .PP 93 --section-name sectionname94 .RS 3n95 Dumps the named section .85 \-\-section\-name sectionname 86 .RS 4 87 Dumps the named section\. 96 88 .RE 97 89 .PP 98 90 configfilename 99 .RS 3n100 This is the name of the configuration file to check . If this parameter is not present then the default91 .RS 4 92 This is the name of the configuration file to check\. If this parameter is not present then the default 101 93 \fBsmb.conf\fR(5) 102 file will be checked .94 file will be checked\. 103 95 .RE 104 96 .PP 105 97 hostname 106 .RS 3n98 .RS 4 107 99 If this parameter and the following are specified, then 108 100 testparm … … 115 107 file to determine if the hostname with this IP address would be allowed access to the 116 108 smbd 117 server . If this parameter is supplied, the hostIP parameter must also be supplied.109 server\. If this parameter is supplied, the hostIP parameter must also be supplied\. 118 110 .RE 119 111 .PP 120 112 hostIP 121 .RS 3n122 This is the IP address of the host specified in the previous parameter . This address must be supplied if the hostname parameter is supplied.113 .RS 4 114 This is the IP address of the host specified in the previous parameter\. This address must be supplied if the hostname parameter is supplied\. 123 115 .RE 124 116 .SH "FILES" 125 117 .PP 126 118 \fBsmb.conf\fR(5) 127 .RS 3n119 .RS 4 128 120 This is usually the name of the configuration file used by 129 \fBsmbd\fR(8) .121 \fBsmbd\fR(8)\. 130 122 .RE 131 123 .SH "DIAGNOSTICS" 132 124 .PP 133 The program will issue a message saying whether the configuration file loaded OK or not . This message may be preceded by errors and warnings if the file did not load. If the file was loaded OK, the program then dumps all known service details to stdout.125 The program will issue a message saying whether the configuration file loaded OK or not\. This message may be preceded by errors and warnings if the file did not load\. If the file was loaded OK, the program then dumps all known service details to stdout\. 134 126 .SH "VERSION" 135 127 .PP 136 This man page is correct for version 3 .0 of the Samba suite.128 This man page is correct for version 3\.0 of the Samba suite\. 137 129 .SH "SEE ALSO" 138 130 .PP … … 141 133 .SH "AUTHOR" 142 134 .PP 143 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.135 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 144 136 .PP 145 The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 146 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 147 137 The original Samba man pages were written by Karl Auer\. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 138 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/umount.cifs.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "UMOUNT.CIFS" 8 "" "" "" 1 .\" Title: umount.cifs 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "UMOUNT\.CIFS" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 umount.cifs - for normal, non-root users, to unmount their own Common Internet File System (CIFS) mounts 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 umount .cifs {mount-point} [-nVvhfle]17 umount\.cifs {mount\-point} [\-nVvhfle] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 umount .cifs unmounts a Linux CIFS filesystem. It can be invoked indirectly by the24 umount\.cifs unmounts a Linux CIFS filesystem\. It can be invoked indirectly by the 33 25 \fBumount\fR(8) 34 command when umount .cifs is in /sbin directory, unless you specify the "-i" option to umount. Specifying -i to umount avoids execution of umount helpers such as umount.cifs. The umount.cifs command only works in Linux, and the kernel must support the cifs filesystem. The CIFS protocol is the successor to the SMB protocol and is supported by most Windows servers and many other commercial servers and Network Attached Storage appliances as well as by the popular Open Source server Samba.26 command when umount\.cifs is in /sbin directory, unless you specify the "\-i" option to umount\. Specifying \-i to umount avoids execution of umount helpers such as umount\.cifs\. The umount\.cifs command only works in Linux, and the kernel must support the cifs filesystem\. The CIFS protocol is the successor to the SMB protocol and is supported by most Windows servers and many other commercial servers and Network Attached Storage appliances as well as by the popular Open Source server Samba\. 35 27 .PP 36 The umount .cifs utility detaches the local directory37 \f Bmount-point\fR38 from the corresponding UNC name (exported network resource) and frees the associated kernel resources . It is possible to set the mode for umount.cifs to setuid root (or equivalently update the /etc/permissions file) to allow non-root users to umount shares to directories for which they have write permission. The umount.cifs utility is typically not needed if unmounts need only be performed by root users, or if user mounts and unmounts can rely on specifying explicit entries in /etc/fstab See28 The umount\.cifs utility detaches the local directory 29 \fImount\-point\fR 30 from the corresponding UNC name (exported network resource) and frees the associated kernel resources\. It is possible to set the mode for umount\.cifs to setuid root (or equivalently update the /etc/permissions file) to allow non\-root users to umount shares to directories for which they have write permission\. The umount\.cifs utility is typically not needed if unmounts need only be performed by root users, or if user mounts and unmounts can rely on specifying explicit entries in /etc/fstab See 39 31 .PP 40 32 \fBfstab\fR(5) 41 33 .SH "OPTIONS" 42 34 .PP 43 --verbose44 .RS 3n35 \-\-verbose 36 .RS 4 45 37 print additional debugging information 46 38 .RE 47 39 .PP 48 --no-mtab49 .RS 3n40 \-\-no\-mtab 41 .RS 4 50 42 Do not update the mtab even if unmount completes successfully (/proc/mounts will still display the correct information) 51 43 .RE 52 44 .SH "NOTES" 53 45 .PP 54 This command is normally intended to be installed setuid (since root users can already run unmount) . An alternative to using umount.cifs is to add specfic entries for the user mounts that you wish a particular user or users to mount and unmount to /etc/fstab46 This command is normally intended to be installed setuid (since root users can already run unmount)\. An alternative to using umount\.cifs is to add specfic entries for the user mounts that you wish a particular user or users to mount and unmount to /etc/fstab 55 47 .SH "CONFIGURATION" 56 48 .PP 57 The primary mechanism for making configuration changes and for reading debug information for the cifs vfs is via the Linux /proc filesystem . In the directory49 The primary mechanism for making configuration changes and for reading debug information for the cifs vfs is via the Linux /proc filesystem\. In the directory 58 50 \fI/proc/fs/cifs\fR 59 are various configuration files and pseudo files which can display debug information . For more information see the kernel file60 \fIfs/cifs/README\fR .51 are various configuration files and pseudo files which can display debug information\. For more information see the kernel file 52 \fIfs/cifs/README\fR\. 61 53 .SH "BUGS" 62 54 .PP 63 At this time umount .cifs does not lock the mount table using the same lock as the umount utility does, so do not attempt to do multiple unmounts from different processes (and in particular unmounts of a cifs mount and another type of filesystem mount at the same time).55 At this time umount\.cifs does not lock the mount table using the same lock as the umount utility does, so do not attempt to do multiple unmounts from different processes (and in particular unmounts of a cifs mount and another type of filesystem mount at the same time)\. 64 56 .PP 65 If the same mount point is mounted multiple times by cifs, umount .cifs will remove all of the matching entries from the mount table (although umount.cifs will actually only unmount the last one), rather than only removing the last matching entry in /etc/mtab. The pseudofile /proc/mounts will display correct information though, and the lack of an entry in /etc/mtab does not prevent subsequent unmounts.57 If the same mount point is mounted multiple times by cifs, umount\.cifs will remove all of the matching entries from the mount table (although umount\.cifs will actually only unmount the last one), rather than only removing the last matching entry in /etc/mtab\. The pseudofile /proc/mounts will display correct information though, and the lack of an entry in /etc/mtab does not prevent subsequent unmounts\. 66 58 .PP 67 Note that the typical response to a bug report is a suggestion to try the latest version first . So please try doing that first, and always include which versions you use of relevant software when reporting bugs (minimum: umount.cifs (try umount.cifs -V), kernel (see /proc/version) and server type you are trying to contact.59 Note that the typical response to a bug report is a suggestion to try the latest version first\. So please try doing that first, and always include which versions you use of relevant software when reporting bugs (minimum: umount\.cifs (try umount\.cifs \-V), kernel (see /proc/version) and server type you are trying to contact\. 68 60 .SH "VERSION" 69 61 .PP 70 This man page is correct for version 1 .34 of the cifs vfs filesystem (roughly Linux kernel 2.6.12).62 This man page is correct for version 1\.34 of the cifs vfs filesystem (roughly Linux kernel 2\.6\.12)\. 71 63 .SH "SEE ALSO" 72 64 .PP 73 Documentation/filesystems/cifs .txt and fs/cifs/README in the linux kernel source tree may contain additional options and information.65 Documentation/filesystems/cifs\.txt and fs/cifs/README in the linux kernel source tree may contain additional options and information\. 74 66 .PP 75 67 \fBmount.cifs\fR(8) … … 78 70 Steve French 79 71 .PP 80 The syntax was loosely based on the umount utility and the manpage was loosely based on that of mount .cifs.8. The man page was created by Steve French72 The syntax was loosely based on the umount utility and the manpage was loosely based on that of mount\.cifs\.8\. The man page was created by Steve French 81 73 .PP 82 74 The maintainer of the Linux cifs vfs and the userspace tool 83 \f Bumount.cifs\fR75 \fIumount\.cifs\fR 84 76 is 85 Steve French . The77 Steve French\. The 86 78 Linux CIFS Mailing list 87 is the preferred place to ask questions regarding these programs. 88 79 is the preferred place to ask questions regarding these programs\. -
branches/samba-3.0/docs/manpages/vfs_audit.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "VFS_AUDIT" 8 "" "" "" 1 .\" Title: vfs_audit 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "VFS_AUDIT" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 vfs_audit - record selected Samba VFS operations in the system log … … 28 20 This VFS module is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The 33 25 vfs_audit 34 26 VFS module records selected client operations to the system log using 35 \fBsyslog\fR(3) .27 \fBsyslog\fR(3)\. 36 28 .PP 37 29 The following Samba VFS operations are recorded: 38 .IP "" 3n30 .IP "" 4 39 31 connect 40 .IP "" 3n32 .IP "" 4 41 33 disconnect 42 .IP "" 3n34 .IP "" 4 43 35 opendir 44 .IP "" 3n36 .IP "" 4 45 37 mkdir 46 .IP "" 3n38 .IP "" 4 47 39 rmdir 48 .IP "" 3n40 .IP "" 4 49 41 open 50 .IP "" 3n42 .IP "" 4 51 43 close 52 .IP "" 3n44 .IP "" 4 53 45 rename 54 .IP "" 3n46 .IP "" 4 55 47 unlink 56 .IP "" 3n48 .IP "" 4 57 49 chmod 58 .IP "" 3n50 .IP "" 4 59 51 fchmod 60 .IP "" 3n52 .IP "" 4 61 53 chmod_acl 62 .IP "" 3n54 .IP "" 4 63 55 fchmod_acl 64 56 .PP 65 This module is stackable .57 This module is stackable\. 66 58 .SH "OPTIONS" 67 59 .PP 68 60 audit:facility = FACILITY 69 .RS 3n61 .RS 4 70 62 Log messages to the named 71 63 \fBsyslog\fR(3) 72 facility .64 facility\. 73 65 .RE 74 66 .PP 75 67 audit:priority = PRIORITY 76 .RS 3n68 .RS 4 77 69 Log messages with the named 78 70 \fBsyslog\fR(3) 79 priority .71 priority\. 80 72 .RE 81 73 .SH "EXAMPLES" 82 74 .PP 83 75 Log operations on all shares using the LOCAL1 facility and NOTICE priority: 84 76 .sp 77 .RS 4 85 78 .nf 86 87 79 \fI[global]\fR 88 vfs objects = audit 89 audit:facility = LOCAL1 90 audit:priority = NOTICE 91 80 \fIvfs objects = audit\fR 81 \fIaudit:facility = LOCAL1\fR 82 \fIaudit:priority = NOTICE\fR 92 83 .fi 84 .RE 93 85 .SH "VERSION" 94 86 .PP 95 This man page is correct for version 3 .0.25 of the Samba suite.87 This man page is correct for version 3\.0\.25 of the Samba suite\. 96 88 .SH "AUTHOR" 97 89 .PP 98 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 99 90 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. -
branches/samba-3.0/docs/manpages/vfs_cacheprime.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "VFS_CACHEPRIME" 8 "" "" "" 1 .\" Title: vfs_cacheprime 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "VFS_CACHEPRIME" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 vfs_cacheprime - prime the kernel file data cache … … 28 20 This VFS module is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The 33 25 vfs_cacheprime 34 VFS module reads chunks of file data near the range requested by clients in order to make sure the data is present in the kernel file data cache at the time when it is actually requested by clients .26 VFS module reads chunks of file data near the range requested by clients in order to make sure the data is present in the kernel file data cache at the time when it is actually requested by clients\. 35 27 .PP 36 28 The size of the disk read operations performed by 37 29 vfs_cacheprime 38 is determined by the cacheprime:rsize option . All disk read operations are aligned on boundaries that are a multiple of this size. Each range of the file data is primed at most once during the time the client has the file open.30 is determined by the cacheprime:rsize option\. All disk read operations are aligned on boundaries that are a multiple of this size\. Each range of the file data is primed at most once during the time the client has the file open\. 39 31 .PP 40 This module is stackable .32 This module is stackable\. 41 33 .SH "OPTIONS" 42 34 .PP 43 35 cacheprime:rsize = BYTES 44 .RS 3n45 The number of bytes with which to prime the kernel data cache .36 .RS 4 37 The number of bytes with which to prime the kernel data cache\. 46 38 .sp 47 39 The following suffixes may be applied to BYTES: 48 .RS 3n 49 .TP 3n 50 \(bu 40 .sp 41 .RS 4 42 .ie n \{\ 43 \h'-04'\(bu\h'+03'\c 44 .\} 45 .el \{\ 46 .sp -1 47 .IP \(bu 2.3 48 .\} 51 49 K 52 - BYTES is a number of kilobytes 53 .TP 3n 54 \(bu 50 \- BYTES is a number of kilobytes 51 .RE 52 .sp 53 .RS 4 54 .ie n \{\ 55 \h'-04'\(bu\h'+03'\c 56 .\} 57 .el \{\ 58 .sp -1 59 .IP \(bu 2.3 60 .\} 55 61 M 56 - BYTES is a number of megabytes 57 .TP 3n 58 \(bu 62 \- BYTES is a number of megabytes 63 .RE 64 .sp 65 .RS 4 66 .ie n \{\ 67 \h'-04'\(bu\h'+03'\c 68 .\} 69 .el \{\ 70 .sp -1 71 .IP \(bu 2.3 72 .\} 59 73 G 60 - BYTES is a number of gigabytes 74 \- BYTES is a number of gigabytes 75 .sp 61 76 .RE 62 77 .RE … … 64 79 .PP 65 80 For a hypothetical disk array, it is necessary to ensure that all read operations are of size 1 megabyte (1048576 bytes), and aligned on 1 megabyte boundaries: 66 81 .sp 82 .RS 4 67 83 .nf 68 69 84 \fI[hypothetical]\fR 70 vfs objects = cacheprime 71 cacheprime:rsize = 1M 72 85 \fIvfs objects = cacheprime\fR 86 \fIcacheprime:rsize = 1M\fR 73 87 .fi 88 .RE 74 89 .SH "CAVEATS" 75 90 .PP 76 91 cacheprime 77 is not a a substitute for a general -purpose readahead mechanism. It is intended for use only in very specific environments where disk operations must be aligned and sized to known values (as much as that is possible).92 is not a a substitute for a general\-purpose readahead mechanism\. It is intended for use only in very specific environments where disk operations must be aligned and sized to known values (as much as that is possible)\. 78 93 .SH "VERSION" 79 94 .PP 80 This man page is correct for version 3 .0.25 of the Samba suite.95 This man page is correct for version 3\.0\.25 of the Samba suite\. 81 96 .SH "AUTHOR" 82 97 .PP 83 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 84 98 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. -
branches/samba-3.0/docs/manpages/vfs_cap.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "VFS_CAP" 8 "" "" "" 1 .\" Title: vfs_cap 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "VFS_CAP" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 vfs_cap - CAP encode filenames … … 28 20 This VFS module is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 CAP (Columbia Appletalk Protocol) encoding is a technique for representing non -ASCII filenames in ASCII. The24 CAP (Columbia Appletalk Protocol) encoding is a technique for representing non\-ASCII filenames in ASCII\. The 33 25 vfs_cap 34 VFS module translates filenames to and from CAP format, allowing users to name files in their native encoding .26 VFS module translates filenames to and from CAP format, allowing users to name files in their native encoding\. 35 27 .PP 36 CAP encoding is most commonly used in Japanese language environments .28 CAP encoding is most commonly used in Japanese language environments\. 37 29 .PP 38 This module is stackable .30 This module is stackable\. 39 31 .SH "EXAMPLES" 40 32 .PP 41 33 On a system using GNU libiconv, use CAP encoding to support users in the Shift_JIS locale: 42 34 .sp 35 .RS 4 43 36 .nf 44 45 37 \fI[global]\fR 46 dos charset = CP932 47 dos charset = CP932 48 vfs objects = cap 49 38 \fIdos charset = CP932\fR 39 \fIdos charset = CP932\fR 40 \fIvfs objects = cap\fR 50 41 .fi 42 .RE 51 43 .SH "VERSION" 52 44 .PP 53 This man page is correct for version 3 .0.25 of the Samba suite.45 This man page is correct for version 3\.0\.25 of the Samba suite\. 54 46 .SH "AUTHOR" 55 47 .PP 56 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 57 48 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. -
branches/samba-3.0/docs/manpages/vfs_catia.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "VFS_CATIA" 8 "" "" "" 1 .\" Title: vfs_catia 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "VFS_CATIA" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 vfs_catia - translate illegal characters in Catia filenames … … 28 20 This VFS module is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 The Catia CAD package commonly creates filenames that use characters that are illegal in CIFS filenames . The24 The Catia CAD package commonly creates filenames that use characters that are illegal in CIFS filenames\. The 33 25 vfs_catia 34 VFS module implements a fixed character mapping so that these files can be shared with CIFS clients .26 VFS module implements a fixed character mapping so that these files can be shared with CIFS clients\. 35 27 .PP 36 This module is stackable .28 This module is stackable\. 37 29 .SH "EXAMPLES" 38 30 .PP 39 31 Map Catia filenames on the [CAD] share: 40 32 .sp 33 .RS 4 41 34 .nf 42 43 35 \fI[CAD]\fR 44 path = /data/cad 45 vfs objects = catia 46 36 \fIpath = /data/cad\fR 37 \fIvfs objects = catia\fR 47 38 .fi 39 .RE 48 40 .SH "VERSION" 49 41 .PP 50 This man page is correct for version 3 .0.25 of the Samba suite.42 This man page is correct for version 3\.0\.25 of the Samba suite\. 51 43 .SH "AUTHOR" 52 44 .PP 53 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 54 45 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. -
branches/samba-3.0/docs/manpages/vfs_commit.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "VFS_COMMIT" 8 "" "" "" 1 .\" Title: vfs_commit 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "VFS_COMMIT" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 vfs_commit - flush dirty data at specified intervals … … 28 20 This VFS module is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The 33 25 vfs_commit 34 VFS module keeps track of the amount of data written to a file and synchronizes it to disk when a specified amount accumulates .26 VFS module keeps track of the amount of data written to a file and synchronizes it to disk when a specified amount accumulates\. 35 27 .PP 36 28 vfs_commit 37 is useful in two circumstances . First, if you have very precious data, the impact of unexpected power loss can be minimized by a small commit:dthresh value. Secondly, write performance can be improved on some systems by flushing file data early and at regular intervals.29 is useful in two circumstances\. First, if you have very precious data, the impact of unexpected power loss can be minimized by a small commit:dthresh value\. Secondly, write performance can be improved on some systems by flushing file data early and at regular intervals\. 38 30 .PP 39 This module is stackable .31 This module is stackable\. 40 32 .SH "OPTIONS" 41 33 .PP 42 34 commit:dthresh = BYTES 43 .RS 3n44 Synchronize file data each time the specified number of bytes has been written .35 .RS 4 36 Synchronize file data each time the specified number of bytes has been written\. 45 37 .sp 46 38 The following suffixes may be applied to BYTES: 47 .RS 3n 48 .TP 3n 49 \(bu 39 .sp 40 .RS 4 41 .ie n \{\ 42 \h'-04'\(bu\h'+03'\c 43 .\} 44 .el \{\ 45 .sp -1 46 .IP \(bu 2.3 47 .\} 50 48 K 51 - BYTES is a number of kilobytes 52 .TP 3n 53 \(bu 49 \- BYTES is a number of kilobytes 50 .RE 51 .sp 52 .RS 4 53 .ie n \{\ 54 \h'-04'\(bu\h'+03'\c 55 .\} 56 .el \{\ 57 .sp -1 58 .IP \(bu 2.3 59 .\} 54 60 M 55 - BYTES is a number of megabytes 56 .TP 3n 57 \(bu 61 \- BYTES is a number of megabytes 62 .RE 63 .sp 64 .RS 4 65 .ie n \{\ 66 \h'-04'\(bu\h'+03'\c 67 .\} 68 .el \{\ 69 .sp -1 70 .IP \(bu 2.3 71 .\} 58 72 G 59 - BYTES is a number of gigabytes 73 \- BYTES is a number of gigabytes 74 .sp 60 75 .RE 61 76 .RE … … 63 78 .PP 64 79 Synchronize the file data on the [precious] share after every 512 kilobytes (524288 bytes) of data is written: 65 80 .sp 81 .RS 4 66 82 .nf 67 68 83 \fI[precious]\fR 69 path = /data/precious 70 vfs objects = commit 71 commit:dthresh = 512K 72 84 \fIpath = /data/precious\fR 85 \fIvfs objects = commit\fR 86 \fIcommit:dthresh = 512K\fR 73 87 .fi 88 .RE 74 89 .SH "CAVEATS" 75 90 .PP 76 91 On some systems, the data synchronization performed by 77 92 commit 78 may reduce performance .93 may reduce performance\. 79 94 .SH "VERSION" 80 95 .PP 81 This man page is correct for version 3 .0.25 of the Samba suite.96 This man page is correct for version 3\.0\.25 of the Samba suite\. 82 97 .SH "AUTHOR" 83 98 .PP 84 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 85 99 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. -
branches/samba-3.0/docs/manpages/vfs_default_quota.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "VFS_DEFAULT_QUOTA" 8 "" "" "" 1 .\" Title: vfs_default_quota 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "VFS_DEFAULT_QUOTA" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 vfs_default_quota - store default quota records for Windows clients … … 28 20 This VFS module is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 Many common quota implementations only store quotas for users and groups, but do not store a default quota . The24 Many common quota implementations only store quotas for users and groups, but do not store a default quota\. The 33 25 vfs_default_quota 34 module allows Samba to store default quota values which can be examined using the Windows Explorer interface .26 module allows Samba to store default quota values which can be examined using the Windows Explorer interface\. 35 27 .PP 36 By default, Samba returns NO_LIMIT the default quota and refuses to update them .28 By default, Samba returns NO_LIMIT the default quota and refuses to update them\. 37 29 vfs_default_quota 38 maps the default quota to the quota record of a user . By default the root user is taken because quota limits for root are typically not enforced.30 maps the default quota to the quota record of a user\. By default the root user is taken because quota limits for root are typically not enforced\. 39 31 .PP 40 This module is stackable .32 This module is stackable\. 41 33 .SH "OPTIONS" 42 34 .PP 43 35 default_quota:uid = UID 44 .RS 3n45 UID specifies the user ID of the quota record where the default user quota values are stored .36 .RS 4 37 UID specifies the user ID of the quota record where the default user quota values are stored\. 46 38 .RE 47 39 .PP 48 40 default_quota:gid = GID 49 .RS 3n50 GID specifies the group ID of the quota record where the default group quota values are stored .41 .RS 4 42 GID specifies the group ID of the quota record where the default group quota values are stored\. 51 43 .RE 52 44 .PP 53 45 default_quota:uid nolimit = BOOL 54 .RS 3n55 If this parameter is True, then the user whose quota record is storing the default user quota will be reported as having a quota of NO_LIMIT . Otherwise, the stored values will be reported.46 .RS 4 47 If this parameter is True, then the user whose quota record is storing the default user quota will be reported as having a quota of NO_LIMIT\. Otherwise, the stored values will be reported\. 56 48 .RE 57 49 .PP 58 50 default_quota:gid nolimit = BOOL 59 .RS 3n60 If this parameter is True, then the group whose quota record is storing the default group quota will be reported as having a quota of NO_LIMIT . Otherwise, the stored values will be reported.51 .RS 4 52 If this parameter is True, then the group whose quota record is storing the default group quota will be reported as having a quota of NO_LIMIT\. Otherwise, the stored values will be reported\. 61 53 .RE 62 54 .SH "EXAMPLES" 63 55 .PP 64 56 Store the default quota record in the quota record for the user with ID 65535 and report that user as having no quota limits: 65 57 .sp 58 .RS 4 66 59 .nf 67 68 60 \fI[global]\fR 69 vfs objects = default_quota 70 default_quota:uid = 65535 71 default_quota:uid nolimit = yes 72 61 \fIvfs objects = default_quota\fR 62 \fIdefault_quota:uid = 65535\fR 63 \fIdefault_quota:uid nolimit = yes\fR 73 64 .fi 65 .RE 74 66 .SH "VERSION" 75 67 .PP 76 This man page is correct for version 3 .0.25 of the Samba suite.68 This man page is correct for version 3\.0\.25 of the Samba suite\. 77 69 .SH "AUTHOR" 78 70 .PP 79 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 80 71 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. -
branches/samba-3.0/docs/manpages/vfs_extd_audit.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "VFS_EXTD_AUDIT" 8 "" "" "" 1 .\" Title: vfs_extd_audit 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "VFS_EXTD_AUDIT" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 vfs_extd_audit - record selected Samba VFS operations … … 28 20 This VFS module is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The … … 35 27 \fBsmbd\fR(8) 36 28 log and system log (using 37 \fBsyslog\fR(3)) .29 \fBsyslog\fR(3))\. 38 30 .PP 39 31 Other than logging to the … … 42 34 vfs_extd_audit 43 35 is identical to 44 \fBvfs_audit\fR(8) .36 \fBvfs_audit\fR(8)\. 45 37 .PP 46 This module is stackable .38 This module is stackable\. 47 39 .SH "VERSION" 48 40 .PP 49 This man page is correct for version 3 .0.25 of the Samba suite.41 This man page is correct for version 3\.0\.25 of the Samba suite\. 50 42 .SH "AUTHOR" 51 43 .PP 52 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 53 44 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. -
branches/samba-3.0/docs/manpages/vfs_fake_perms.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "VFS_FAKE_PERMS" 8 "" "" "" 1 .\" Title: vfs_fake_perms 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "VFS_FAKE_PERMS" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 vfs_fake_perms - enable read only Roaming Profiles … … 28 20 This VFS module is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The 33 25 vfs_fake_perms 34 VFS module was created to allow Roaming Profile files and directories to be set (on the Samba server under UNIX) as read only . This module will, if installed on the Profiles share, report to the client that the Profile files and directories are writeable. This satisfies the client even though the files will never be overwritten as the client logs out or shuts down.26 VFS module was created to allow Roaming Profile files and directories to be set (on the Samba server under UNIX) as read only\. This module will, if installed on the Profiles share, report to the client that the Profile files and directories are writeable\. This satisfies the client even though the files will never be overwritten as the client logs out or shuts down\. 35 27 .PP 36 This module is stackable .28 This module is stackable\. 37 29 .SH "EXAMPLES" 38 30 .sp 31 .RS 4 39 32 .nf 40 41 33 \fI[Profiles]\fR 42 path = /profiles 43 vfs objects = fake_perms 44 34 \fIpath = /profiles\fR 35 \fIvfs objects = fake_perms\fR 45 36 .fi 37 .RE 46 38 .SH "VERSION" 47 39 .PP 48 This man page is correct for version 3 .0.25 of the Samba suite.40 This man page is correct for version 3\.0\.25 of the Samba suite\. 49 41 .SH "AUTHOR" 50 42 .PP 51 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 52 43 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. -
branches/samba-3.0/docs/manpages/vfs_full_audit.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "VFS_FULL_AUDIT" 8 "" "" "" 1 .\" Title: vfs_full_audit 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "VFS_FULL_AUDIT" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 vfs_full_audit - record Samba VFS operations in the system log … … 28 20 This VFS module is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The 33 25 vfs_full_audit 34 26 VFS module records selected client operations to the system log using 35 \fBsyslog\fR(3) .27 \fBsyslog\fR(3)\. 36 28 .PP 37 29 vfs_full_audit 38 30 is able to record the complete set of Samba VFS operations: 39 .IP "" 3n31 .IP "" 4 40 32 aio_cancel 41 .IP "" 3n33 .IP "" 4 42 34 aio_error 43 .IP "" 3n35 .IP "" 4 44 36 aio_fsync 45 .IP "" 3n37 .IP "" 4 46 38 aio_read 47 .IP "" 3n39 .IP "" 4 48 40 aio_return 49 .IP "" 3n41 .IP "" 4 50 42 aio_suspend 51 .IP "" 3n43 .IP "" 4 52 44 aio_write 53 .IP "" 3n45 .IP "" 4 54 46 chdir 55 .IP "" 3n47 .IP "" 4 56 48 chflags 57 .IP "" 3n49 .IP "" 4 58 50 chmod 59 .IP "" 3n51 .IP "" 4 60 52 chmod_acl 61 .IP "" 3n53 .IP "" 4 62 54 chown 63 .IP "" 3n55 .IP "" 4 64 56 close 65 .IP "" 3n57 .IP "" 4 66 58 closedir 67 .IP "" 3n59 .IP "" 4 68 60 connect 69 .IP "" 3n61 .IP "" 4 70 62 disconnect 71 .IP "" 3n63 .IP "" 4 72 64 disk_free 73 .IP "" 3n65 .IP "" 4 74 66 fchmod 75 .IP "" 3n67 .IP "" 4 76 68 fchmod_acl 77 .IP "" 3n69 .IP "" 4 78 70 fchown 79 .IP "" 3n71 .IP "" 4 80 72 fget_nt_acl 81 .IP "" 3n73 .IP "" 4 82 74 fgetxattr 83 .IP "" 3n75 .IP "" 4 84 76 flistxattr 85 .IP "" 3n77 .IP "" 4 86 78 fremovexattr 87 .IP "" 3n79 .IP "" 4 88 80 fset_nt_acl 89 .IP "" 3n81 .IP "" 4 90 82 fsetxattr 91 .IP "" 3n83 .IP "" 4 92 84 fstat 93 .IP "" 3n85 .IP "" 4 94 86 fsync 95 .IP "" 3n87 .IP "" 4 96 88 ftruncate 97 .IP "" 3n89 .IP "" 4 98 90 get_nt_acl 99 .IP "" 3n91 .IP "" 4 100 92 get_quota 101 .IP "" 3n93 .IP "" 4 102 94 get_shadow_copy_data 103 .IP "" 3n95 .IP "" 4 104 96 getlock 105 .IP "" 3n97 .IP "" 4 106 98 getwd 107 .IP "" 3n99 .IP "" 4 108 100 getxattr 109 .IP "" 3n101 .IP "" 4 110 102 kernel_flock 111 .IP "" 3n103 .IP "" 4 112 104 lgetxattr 113 .IP "" 3n105 .IP "" 4 114 106 link 115 .IP "" 3n107 .IP "" 4 116 108 linux_setlease 117 .IP "" 3n109 .IP "" 4 118 110 listxattr 119 .IP "" 3n111 .IP "" 4 120 112 llistxattr 121 .IP "" 3n113 .IP "" 4 122 114 lock 123 .IP "" 3n115 .IP "" 4 124 116 lremovexattr 125 .IP "" 3n117 .IP "" 4 126 118 lseek 127 .IP "" 3n119 .IP "" 4 128 120 lsetxattr 129 .IP "" 3n121 .IP "" 4 130 122 lstat 131 .IP "" 3n123 .IP "" 4 132 124 mkdir 133 .IP "" 3n125 .IP "" 4 134 126 mknod 135 .IP "" 3n127 .IP "" 4 136 128 open 137 .IP "" 3n129 .IP "" 4 138 130 opendir 139 .IP "" 3n131 .IP "" 4 140 132 pread 141 .IP "" 3n133 .IP "" 4 142 134 pwrite 143 .IP "" 3n135 .IP "" 4 144 136 read 145 .IP "" 3n137 .IP "" 4 146 138 readdir 147 .IP "" 3n139 .IP "" 4 148 140 readlink 149 .IP "" 3n141 .IP "" 4 150 142 realpath 151 .IP "" 3n143 .IP "" 4 152 144 removexattr 153 .IP "" 3n145 .IP "" 4 154 146 rename 155 .IP "" 3n147 .IP "" 4 156 148 rewinddir 157 .IP "" 3n149 .IP "" 4 158 150 rmdir 159 .IP "" 3n151 .IP "" 4 160 152 seekdir 161 .IP "" 3n153 .IP "" 4 162 154 sendfile 163 .IP "" 3n155 .IP "" 4 164 156 set_nt_acl 165 .IP "" 3n157 .IP "" 4 166 158 set_quota 167 .IP "" 3n159 .IP "" 4 168 160 setxattr 169 .IP "" 3n161 .IP "" 4 170 162 stat 171 .IP "" 3n163 .IP "" 4 172 164 statvfs 173 .IP "" 3n165 .IP "" 4 174 166 symlink 175 .IP "" 3n167 .IP "" 4 176 168 sys_acl_add_perm 177 .IP "" 3n169 .IP "" 4 178 170 sys_acl_clear_perms 179 .IP "" 3n171 .IP "" 4 180 172 sys_acl_create_entry 181 .IP "" 3n173 .IP "" 4 182 174 sys_acl_delete_def_file 183 .IP "" 3n175 .IP "" 4 184 176 sys_acl_free_acl 185 .IP "" 3n177 .IP "" 4 186 178 sys_acl_free_qualifier 187 .IP "" 3n179 .IP "" 4 188 180 sys_acl_free_text 189 .IP "" 3n181 .IP "" 4 190 182 sys_acl_get_entry 191 .IP "" 3n183 .IP "" 4 192 184 sys_acl_get_fd 193 .IP "" 3n185 .IP "" 4 194 186 sys_acl_get_file 195 .IP "" 3n187 .IP "" 4 196 188 sys_acl_get_perm 197 .IP "" 3n189 .IP "" 4 198 190 sys_acl_get_permset 199 .IP "" 3n191 .IP "" 4 200 192 sys_acl_get_qualifier 201 .IP "" 3n193 .IP "" 4 202 194 sys_acl_get_tag_type 203 .IP "" 3n195 .IP "" 4 204 196 sys_acl_init 205 .IP "" 3n197 .IP "" 4 206 198 sys_acl_set_fd 207 .IP "" 3n199 .IP "" 4 208 200 sys_acl_set_file 209 .IP "" 3n201 .IP "" 4 210 202 sys_acl_set_permset 211 .IP "" 3n203 .IP "" 4 212 204 sys_acl_set_qualifier 213 .IP "" 3n205 .IP "" 4 214 206 sys_acl_set_tag_type 215 .IP "" 3n207 .IP "" 4 216 208 sys_acl_to_text 217 .IP "" 3n209 .IP "" 4 218 210 sys_acl_valid 219 .IP "" 3n211 .IP "" 4 220 212 telldir 221 .IP "" 3n213 .IP "" 4 222 214 unlink 223 .IP "" 3n215 .IP "" 4 224 216 utime 225 .IP "" 3n217 .IP "" 4 226 218 write 227 219 .PP 228 220 In addition to these operations, 229 221 vfs_full_audit 230 recognizes the special operation names "all" and "none ", which refer to all the VFS operations and none of the VFS operations respectively .222 recognizes the special operation names "all" and "none ", which refer to all the VFS operations and none of the VFS operations respectively\. 231 223 .PP 232 224 vfs_full_audit 233 records operations in fixed format consisting of fields separated by '|' characters. The format is: 234 225 records operations in fixed format consisting of fields separated by \'|\' characters\. The format is: 226 .sp 227 .RS 4 235 228 .nf 236 237 229 smbd_audit: PREFIX|OPERATION|RESULT|FILE 238 230 239 231 .fi 232 .RE 240 233 .PP 241 234 The record fields are: 242 .TP 3n 243 \(bu 235 .sp 236 .RS 4 237 .ie n \{\ 238 \h'-04'\(bu\h'+03'\c 239 .\} 240 .el \{\ 241 .sp -1 242 .IP \(bu 2.3 243 .\} 244 244 PREFIX 245 - the result of the full_audit:prefix string after variable substitutions 246 .TP 3n 247 \(bu 245 \- the result of the full_audit:prefix string after variable substitutions 246 .RE 247 .sp 248 .RS 4 249 .ie n \{\ 250 \h'-04'\(bu\h'+03'\c 251 .\} 252 .el \{\ 253 .sp -1 254 .IP \(bu 2.3 255 .\} 248 256 OPERATION 249 - the name of the VFS operation 250 .TP 3n 251 \(bu 257 \- the name of the VFS operation 258 .RE 259 .sp 260 .RS 4 261 .ie n \{\ 262 \h'-04'\(bu\h'+03'\c 263 .\} 264 .el \{\ 265 .sp -1 266 .IP \(bu 2.3 267 .\} 252 268 RESULT 253 - whether the operation succeeded or failed 254 .TP 3n 255 \(bu 269 \- whether the operation succeeded or failed 270 .RE 271 .sp 272 .RS 4 273 .ie n \{\ 274 \h'-04'\(bu\h'+03'\c 275 .\} 276 .el \{\ 277 .sp -1 278 .IP \(bu 2.3 279 .\} 256 280 FILE 257 - the name of the file or directory the operation was performed on 258 .PP 259 This module is stackable. 281 \- the name of the file or directory the operation was performed on 282 .sp 283 .RE 284 .PP 285 This module is stackable\. 260 286 .SH "OPTIONS" 261 287 .PP 262 288 vfs_full_audit:prefix = STRING 263 .RS 3n264 Prepend audit messages with STRING . STRING is processed for standard substitution variables listed in265 \fBsmb.conf\fR(5) . The default prefix is "%u|%I".289 .RS 4 290 Prepend audit messages with STRING\. STRING is processed for standard substitution variables listed in 291 \fBsmb.conf\fR(5)\. The default prefix is "%u|%I"\. 266 292 .RE 267 293 .PP 268 294 vfs_full_audit:success = LIST 269 .RS 3n270 LIST is a list of VFS operations that should be recorded if they succeed . Operations are specified using the names listed above.295 .RS 4 296 LIST is a list of VFS operations that should be recorded if they succeed\. Operations are specified using the names listed above\. 271 297 .RE 272 298 .PP 273 299 vfs_full_audit:failure = LIST 274 .RS 3n275 LIST is a list of VFS operations that should be recorded if they failed . Operations are specified using the names listed above.300 .RS 4 301 LIST is a list of VFS operations that should be recorded if they failed\. Operations are specified using the names listed above\. 276 302 .RE 277 303 .PP 278 304 full_audit:facility = FACILITY 279 .RS 3n305 .RS 4 280 306 Log messages to the named 281 307 \fBsyslog\fR(3) 282 facility .308 facility\. 283 309 .RE 284 310 .PP 285 311 full_audit:priority = PRIORITY 286 .RS 3n312 .RS 4 287 313 Log messages with the named 288 314 \fBsyslog\fR(3) 289 priority .315 priority\. 290 316 .RE 291 317 .SH "EXAMPLES" 292 318 .PP 293 319 Log file and directory open operations on the [records] share using the LOCAL7 facility and ALERT priority, including the username and IP address: 294 320 .sp 321 .RS 4 295 322 .nf 296 297 323 \fI[records]\fR 298 path = /data/records 299 vfs objects = full_audit 300 full_audit:prefix = %u|%I 301 full_audit:success = open opendir 302 full_audit:failure = all 303 full_audit:facility = LOCAL7 304 full_audit:priority = ALERT 305 324 \fIpath = /data/records\fR 325 \fIvfs objects = full_audit\fR 326 \fIfull_audit:prefix = %u|%I\fR 327 \fIfull_audit:success = open opendir\fR 328 \fIfull_audit:failure = all\fR 329 \fIfull_audit:facility = LOCAL7\fR 330 \fIfull_audit:priority = ALERT\fR 306 331 .fi 332 .RE 307 333 .SH "VERSION" 308 334 .PP 309 This man page is correct for version 3 .0.25 of the Samba suite.335 This man page is correct for version 3\.0\.25 of the Samba suite\. 310 336 .SH "AUTHOR" 311 337 .PP 312 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 313 338 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. -
branches/samba-3.0/docs/manpages/vfs_netatalk.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "VFS_NETATALK" 8 "" "" "" 1 .\" Title: vfs_netatalk 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "VFS_NETATALK" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 vfs_netatalk - hide .AppleDouble files from CIFS clients … … 28 20 This VFS module is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The 33 25 vfs_netatalk 34 VFS module dynamically hides .AppleDouble files, preventing spurious errors on some CIFS clients. .AppleDouble files may be created by historic implementations of AFP (Apple Filing Protocol) on servers.26 VFS module dynamically hides \.AppleDouble files, preventing spurious errors on some CIFS clients\. \.AppleDouble files may be created by historic implementations of AFP (Apple Filing Protocol) on servers\. 35 27 .PP 36 This module is stackable .28 This module is stackable\. 37 29 .SH "EXAMPLES" 38 30 .PP 39 Hide .AppleDouble files on the [data] share: 40 31 Hide \.AppleDouble files on the [data] share: 32 .sp 33 .RS 4 41 34 .nf 42 43 35 \fI[data]\fR 44 vfs objects = netatalk 45 36 \fIvfs objects = netatalk\fR 46 37 .fi 38 .RE 47 39 .SH "CAVEATS" 48 40 .PP 49 This module is largely historic and unlikely to be of use in modern networks since current Apple systems are able to mount CIFS shares natively .41 This module is largely historic and unlikely to be of use in modern networks since current Apple systems are able to mount CIFS shares natively\. 50 42 .SH "VERSION" 51 43 .PP 52 This man page is correct for version 3 .0.25 of the Samba suite.44 This man page is correct for version 3\.0\.25 of the Samba suite\. 53 45 .SH "AUTHOR" 54 46 .PP 55 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 56 47 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. -
branches/samba-3.0/docs/manpages/vfs_prealloc.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "VFS_PREALLOC" 8 "" "" "" 1 .\" Title: vfs_prealloc 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "VFS_PREALLOC" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 vfs_prealloc - preallocate matching files to a predetermined size … … 28 20 This VFS module is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The 33 25 vfs_prealloc 34 VFS module preallocates files to a specified size each time a new file is created . This is useful in environments where files are of a predetermined size will be written to a disk subsystem where extending file allocations is expensive.26 VFS module preallocates files to a specified size each time a new file is created\. This is useful in environments where files are of a predetermined size will be written to a disk subsystem where extending file allocations is expensive\. 35 27 .PP 36 This module is stackable .28 This module is stackable\. 37 29 .SH "OPTIONS" 38 30 .PP 39 31 prealloc:EXT = BYTES 40 .RS 3n41 Preallocate all files with the extension EXT to the size specified by BYTES .32 .RS 4 33 Preallocate all files with the extension EXT to the size specified by BYTES\. 42 34 .sp 43 35 The following suffixes may be applied to BYTES: 44 .RS 3n 45 .TP 3n 46 \(bu 36 .sp 37 .RS 4 38 .ie n \{\ 39 \h'-04'\(bu\h'+03'\c 40 .\} 41 .el \{\ 42 .sp -1 43 .IP \(bu 2.3 44 .\} 47 45 K 48 - BYTES is a number of kilobytes 49 .TP 3n 50 \(bu 46 \- BYTES is a number of kilobytes 47 .RE 48 .sp 49 .RS 4 50 .ie n \{\ 51 \h'-04'\(bu\h'+03'\c 52 .\} 53 .el \{\ 54 .sp -1 55 .IP \(bu 2.3 56 .\} 51 57 M 52 - BYTES is a number of megabytes 53 .TP 3n 54 \(bu 58 \- BYTES is a number of megabytes 59 .RE 60 .sp 61 .RS 4 62 .ie n \{\ 63 \h'-04'\(bu\h'+03'\c 64 .\} 65 .el \{\ 66 .sp -1 67 .IP \(bu 2.3 68 .\} 55 69 G 56 - BYTES is a number of gigabytes 70 \- BYTES is a number of gigabytes 71 .sp 57 72 .RE 58 73 .RE … … 60 75 .PP 61 76 A process writes TIFF files to a Samba share, and the is known these files will almost always be around 4 megabytes (4194304 bytes): 62 77 .sp 78 .RS 4 63 79 .nf 64 65 80 \fI[frames]\fR 66 path = /data/frames 67 vfs objects = prealloc 68 prealloc:tiff = 4M 69 81 \fIpath = /data/frames\fR 82 \fIvfs objects = prealloc\fR 83 \fIprealloc:tiff = 4M\fR 70 84 .fi 85 .RE 71 86 .SH "CAVEATS" 72 87 .PP 73 88 vfs_prealloc 74 is not supported on all platforms and filesystems . Currently only XFS filesystems on Linux and IRIX are supported.89 is not supported on all platforms and filesystems\. Currently only XFS filesystems on Linux and IRIX are supported\. 75 90 .SH "VERSION" 76 91 .PP 77 This man page is correct for version 3 .0.25 of the Samba suite.92 This man page is correct for version 3\.0\.25 of the Samba suite\. 78 93 .SH "AUTHOR" 79 94 .PP 80 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 81 95 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. -
branches/samba-3.0/docs/manpages/vfs_readonly.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "VFS_READONLY" 8 "" "" "" 1 .\" Title: vfs_readonly 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "VFS_READONLY" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 vfs_readonly - make a Samba share read only for a specified time period … … 28 20 This VFS module is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The 33 25 vfs_readonly 34 VFS module marks a share as read only for all clients connecting within the configured time period . Clients connecting during this time will be denied write access to all files in the share, irrespective of ther actual access privileges.26 VFS module marks a share as read only for all clients connecting within the configured time period\. Clients connecting during this time will be denied write access to all files in the share, irrespective of ther actual access privileges\. 35 27 .PP 36 This module is stackable .28 This module is stackable\. 37 29 .SH "OPTIONS" 38 30 .PP 39 31 readonly:period = BEGIN, END 40 .RS 3n41 Only mark the share as read only if the client connection was made between the times marked by the BEGIN and END date specifiers . The syntax of these date specifiers is the same as that accepted by the-d option of GNU42 \fBdate\fR(1) .32 .RS 4 33 Only mark the share as read only if the client connection was made between the times marked by the BEGIN and END date specifiers\. The syntax of these date specifiers is the same as that accepted by the \-d option of GNU 34 \fBdate\fR(1)\. 43 35 .RE 44 36 .SH "EXAMPLES" 45 37 .PP 46 38 Mark all shares read only: 47 39 .sp 40 .RS 4 48 41 .nf 49 50 42 \fI[global]\fR 51 vfs objects = readonly 52 43 \fIvfs objects = readonly\fR 53 44 .fi 45 .RE 54 46 .PP 55 47 Mark the [backup] share as read only during business hours: 56 48 .sp 49 .RS 4 57 50 .nf 58 59 51 \fI[backup]\fR 60 path = /readonly 61 vfs objects = readonly 62 readonly:period = readonly:period = "today 9:00","today 17:00" 63 52 \fIpath = /readonly\fR 53 \fIvfs objects = readonly\fR 54 \fIreadonly:period = readonly:period = "today 9:00","today 17:00"\fR 64 55 .fi 56 .RE 65 57 .SH "VERSION" 66 58 .PP 67 This man page is correct for version 3 .0.25 of the Samba suite.59 This man page is correct for version 3\.0\.25 of the Samba suite\. 68 60 .SH "AUTHOR" 69 61 .PP 70 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 71 62 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. -
branches/samba-3.0/docs/manpages/vfs_recycle.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "VFS_RECYCLE" 8 "" "" "" 1 .\" Title: vfs_recycle 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "VFS_RECYCLE" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 vfs_recycle - Samba VFS recycle bin … … 28 20 This VFS module is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The 33 25 vfs_recycle 34 intercepts file deletion requests and moves the affected files to a temporary repository rather than deleting them immediately . This gives the same effect as the Recycle Bin on Windows computers.26 intercepts file deletion requests and moves the affected files to a temporary repository rather than deleting them immediately\. This gives the same effect as the Recycle Bin on Windows computers\. 35 27 .PP 36 The Recycle Bin will not appear in Windows Explorer views of the network file system (share) nor on any mapped drive . Instead, a directory called .recycle will be automatically created when the first file is deleted and recycle:repository is not configured. If recycle:repository is configured, the name of the created directory depends on recycle:repository. Users can recover files from the recycle bin. If the recycle:keeptree option has been specified, deleted files will be found in a path identical with that from which the file was deleted.28 The Recycle Bin will not appear in Windows Explorer views of the network file system (share) nor on any mapped drive\. Instead, a directory called \.recycle will be automatically created when the first file is deleted and recycle:repository is not configured\. If recycle:repository is configured, the name of the created directory depends on recycle:repository\. Users can recover files from the recycle bin\. If the recycle:keeptree option has been specified, deleted files will be found in a path identical with that from which the file was deleted\. 37 29 .PP 38 This module is stackable .30 This module is stackable\. 39 31 .SH "OPTIONS" 40 32 .PP 41 33 recycle:repository = PATH 42 .RS 3n43 Path of the directory where deleted files should be moved .34 .RS 4 35 Path of the directory where deleted files should be moved\. 44 36 .sp 45 If this option is not set, the default path .recycle is used.37 If this option is not set, the default path \.recycle is used\. 46 38 .RE 47 39 .PP 48 40 recycle:directory_mode = MODE 49 .RS 3n50 Set MODE to the octal mode the recycle repository should be created with . The recycle repository will be created when first file is deleted. If recycle:subdir_mode is not set, MODE also applies to subdirectories.41 .RS 4 42 Set MODE to the octal mode the recycle repository should be created with\. The recycle repository will be created when first file is deleted\. If recycle:subdir_mode is not set, MODE also applies to subdirectories\. 51 43 .sp 52 If this option is not set, the default mode 0700 is used .44 If this option is not set, the default mode 0700 is used\. 53 45 .RE 54 46 .PP 55 47 recycle:subdir_mode = MODE 56 .RS 3n57 Set MODE to the octal mode with which sub directories of the recycle repository should be created .48 .RS 4 49 Set MODE to the octal mode with which sub directories of the recycle repository should be created\. 58 50 .sp 59 If this option is not set, subdirectories will be created with the mode from recycle:directory_mode .51 If this option is not set, subdirectories will be created with the mode from recycle:directory_mode\. 60 52 .RE 61 53 .PP 62 54 recycle:keeptree = BOOL 63 .RS 3n64 Specifies whether the directory structure should be preserved or whether the files in a directory that is being deleted should be kept separately in the repository .55 .RS 4 56 Specifies whether the directory structure should be preserved or whether the files in a directory that is being deleted should be kept separately in the repository\. 65 57 .RE 66 58 .PP 67 59 recycle:versions = BOOL 68 .RS 3n69 If this option is True, two files with the same name that are deleted will both be kept in the repository . Newer deleted versions of a file will be called "Copy #x of filename".60 .RS 4 61 If this option is True, two files with the same name that are deleted will both be kept in the repository\. Newer deleted versions of a file will be called "Copy #x of filename"\. 70 62 .RE 71 63 .PP 72 64 recycle:touch = BOOL 73 .RS 3n74 Specifies whether a file 's access date should be updated when the file is moved to the repository.65 .RS 4 66 Specifies whether a file\'s access date should be updated when the file is moved to the repository\. 75 67 .RE 76 68 .PP 77 69 recycle:touch_mtime = BOOL 78 .RS 3n79 Specifies whether a file 's last modified date should be updated when the file is moved to the repository.70 .RS 4 71 Specifies whether a file\'s last modified date should be updated when the file is moved to the repository\. 80 72 .RE 81 73 .PP 82 74 recycle:minsize = BYTES 83 .RS 3n84 Files that are smaller than the number of bytes specified by this parameter will not be put into the repository .75 .RS 4 76 Files that are smaller than the number of bytes specified by this parameter will not be put into the repository\. 85 77 .RE 86 78 .PP 87 79 recycle:maxsize = BYTES 88 .RS 3n89 Files that are larger than the number of bytes specified by this parameter will not be put into the repository .80 .RS 4 81 Files that are larger than the number of bytes specified by this parameter will not be put into the repository\. 90 82 .RE 91 83 .PP 92 84 recycle:exclude = LIST 93 .RS 3n94 List of files that should not be put into the repository when deleted, but deleted in the normal way . Wildcards such as * and ? are supported.85 .RS 4 86 List of files that should not be put into the repository when deleted, but deleted in the normal way\. Wildcards such as * and ? are supported\. 95 87 .RE 96 88 .PP 97 89 recycle:exclude_dir = LIST 98 .RS 3n99 List of directories whose files should not be put into the repository when deleted, but deleted in the normal way . Wildcards such as * and ? are supported.90 .RS 4 91 List of directories whose files should not be put into the repository when deleted, but deleted in the normal way\. Wildcards such as * and ? are supported\. 100 92 .RE 101 93 .PP 102 94 recycle:noversions = LIST 103 .RS 3n104 Specifies a list of paths (wildcards such as * and ? are supported) for which no versioning should be used . Only useful when recycle:versions is enabled.95 .RS 4 96 Specifies a list of paths (wildcards such as * and ? are supported) for which no versioning should be used\. Only useful when recycle:versions is enabled\. 105 97 .RE 106 98 .SH "EXAMPLES" 107 99 .PP 108 100 Log operations on all shares using the LOCAL1 facility and NOTICE priority: 109 101 .sp 102 .RS 4 110 103 .nf 111 112 104 \fI[global]\fR 113 vfs objects = recycle 114 recycle:facility = LOCAL1 115 recycle:priority = NOTICE 116 105 \fIvfs objects = recycle\fR 106 \fIrecycle:facility = LOCAL1\fR 107 \fIrecycle:priority = NOTICE\fR 117 108 .fi 109 .RE 118 110 .SH "VERSION" 119 111 .PP 120 This man page is correct for version 3 .0.25 of the Samba suite.112 This man page is correct for version 3\.0\.25 of the Samba suite\. 121 113 .SH "AUTHOR" 122 114 .PP 123 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 124 115 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. -
branches/samba-3.0/docs/manpages/vfs_shadow_copy.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "VFS_SHADOW_COPY" 8 "" "" "" 1 .\" Title: vfs_shadow_copy 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "VFS_SHADOW_COPY" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 vfs_shadow_copy - Make a Samba share read only for a specified time period … … 28 20 This VFS module is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The 33 25 vfs_shadow_copy 34 VFS module functionality that is similar to Microsoft Shadow Copy services . When setup properly, this module allows Microsoft Shadow Copy clients to browse "shadow copies" on Samba shares.26 VFS module functionality that is similar to Microsoft Shadow Copy services\. When setup properly, this module allows Microsoft Shadow Copy clients to browse "shadow copies" on Samba shares\. 35 27 .PP 36 This module is stackable .28 This module is stackable\. 37 29 .SH "CONFIGURATION" 38 30 .PP 39 31 vfs_shadow_copy 40 relies on a filesystem snapshot implementation . Many common filesystems have native support for this.32 relies on a filesystem snapshot implementation\. Many common filesystems have native support for this\. 41 33 .PP 42 34 Filesystem snapshots must be mounted on specially named directories in order to be recognized by 43 vfs_shadow_copy . The snapshot mount points must be immediate children of a the directory being shared.35 vfs_shadow_copy\. The snapshot mount points must be immediate children of a the directory being shared\. 44 36 .PP 45 The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss, where: 46 .TP 3n 47 \(bu 37 The snapshot naming convention is @GMT\-YYYY\.MM\.DD\-hh\.mm\.ss, where: 38 .sp 39 .RS 4 40 .ie n \{\ 41 \h'-04'\(bu\h'+03'\c 42 .\} 43 .el \{\ 44 .sp -1 45 .IP \(bu 2.3 46 .\} 48 47 YYYY 49 48 is the 4 digit year 50 .TP 3n 51 \(bu 49 .RE 50 .sp 51 .RS 4 52 .ie n \{\ 53 \h'-04'\(bu\h'+03'\c 54 .\} 55 .el \{\ 56 .sp -1 57 .IP \(bu 2.3 58 .\} 52 59 MM 53 60 is the 2 digit month 54 .TP 3n 55 \(bu 61 .RE 62 .sp 63 .RS 4 64 .ie n \{\ 65 \h'-04'\(bu\h'+03'\c 66 .\} 67 .el \{\ 68 .sp -1 69 .IP \(bu 2.3 70 .\} 56 71 DD 57 72 is the 2 digit day 58 .TP 3n 59 \(bu 73 .RE 74 .sp 75 .RS 4 76 .ie n \{\ 77 \h'-04'\(bu\h'+03'\c 78 .\} 79 .el \{\ 80 .sp -1 81 .IP \(bu 2.3 82 .\} 60 83 hh 61 84 is the 2 digit hour 62 .TP 3n 63 \(bu 85 .RE 86 .sp 87 .RS 4 88 .ie n \{\ 89 \h'-04'\(bu\h'+03'\c 90 .\} 91 .el \{\ 92 .sp -1 93 .IP \(bu 2.3 94 .\} 64 95 mm 65 96 is the 2 digit minute 66 .TP 3n 67 \(bu 97 .RE 98 .sp 99 .RS 4 100 .ie n \{\ 101 \h'-04'\(bu\h'+03'\c 102 .\} 103 .el \{\ 104 .sp -1 105 .IP \(bu 2.3 106 .\} 68 107 ss 69 is the 2 digit second .108 is the 2 digit second\. 70 109 .sp 71 110 .RE 72 73 111 .PP 74 112 The … … 77 115 \fBdate\fR(1) 78 116 command: 79 80 117 .sp 81 118 .RS 4 82 119 .nf 83 84 TZ=GMT date +@GMT-%Y.%m.%d-%H.%M.%S 120 TZ=GMT date +@GMT\-%Y\.%m\.%d\-%H\.%M\.%S 85 121 86 122 .fi 87 123 .RE 88 124 .SH "EXAMPLES" 89 125 .PP 90 126 Add shadow copy support to user home directories: 91 127 .sp 128 .RS 4 92 129 .nf 93 94 130 \fI[homes]\fR 95 vfs objects = shadow_copy 96 131 \fIvfs objects = shadow_copy\fR 97 132 .fi 133 .RE 98 134 .SH "CAVEATS" 99 135 .PP 100 This is not a backup, archival, or version control solution .136 This is not a backup, archival, or version control solution\. 101 137 .PP 102 138 With Samba or Windows servers, 103 139 vfs_shadow_copy 104 is designed to be an end -user tool only. It does not replace or enhance your backup and archival solutions and should in no way be considered as such. Additionally, if you need version control, implement a version control system.140 is designed to be an end\-user tool only\. It does not replace or enhance your backup and archival solutions and should in no way be considered as such\. Additionally, if you need version control, implement a version control system\. 105 141 .SH "VERSION" 106 142 .PP 107 This man page is correct for version 3 .0.25 of the Samba suite.143 This man page is correct for version 3\.0\.25 of the Samba suite\. 108 144 .SH "AUTHOR" 109 145 .PP 110 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 111 146 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. -
branches/samba-3.0/docs/manpages/vfstest.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "VFSTEST" 1 "" "" "" 1 .\" Title: vfstest 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "VFSTEST" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 vfstest - tool for testing samba VFS modules 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 vfstest [ -d debuglevel] [-c command] [-l logdir] [-h]17 vfstest [\-d\ debuglevel] [\-c\ command] [\-l\ logdir] [\-h] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 vfstest 33 is a small command line utility that has the ability to test dso samba VFS modules . It gives the user the ability to call the various VFS functions manually and supports cascaded VFS modules.25 is a small command line utility that has the ability to test dso samba VFS modules\. It gives the user the ability to call the various VFS functions manually and supports cascaded VFS modules\. 34 26 .SH "OPTIONS" 35 27 .PP 36 -c|--command=command 37 .RS 3n 38 Execute the specified (colon-separated) commands. See below for the commands that are available. 39 .RE 40 .PP 41 -h|--help 42 .RS 3n 43 Print a summary of command line options. 44 .RE 45 .PP 46 -l|--logfile=logbasename 47 .RS 3n 48 File name for log/debug files. The extension 49 \fB'.client'\fR 50 will be appended. The log file is never removed by the client. 51 .RE 52 .PP 53 -V 54 .RS 3n 55 Prints the program version number. 56 .RE 57 .PP 58 -s <configuration file> 59 .RS 3n 60 The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See 61 \fIsmb.conf\fR 62 for more information. The default configuration file name is determined at compile time. 63 .RE 64 .PP 65 -d|--debuglevel=level 66 .RS 3n 28 \-c|\-\-command=command 29 .RS 4 30 Execute the specified (colon\-separated) commands\. See below for the commands that are available\. 31 .RE 32 .PP 33 \-h|\-\-help 34 .RS 4 35 Print a summary of command line options\. 36 .RE 37 .PP 38 \-l|\-\-logfile=logbasename 39 .RS 4 40 File name for log/debug files\. The extension 41 \fB\'\.client\'\fR 42 will be appended\. The log file is never removed by the client\. 43 .RE 44 .PP 45 \-d|\-\-debuglevel=level 46 .RS 4 67 47 \fIlevel\fR 68 is an integer from 0 to 10 . The default value if this parameter is not specified is zero.69 .sp 70 The higher this value, the more detail will be logged to the log files about the activities of the server . At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out.71 .sp 72 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem . Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic.48 is an integer from 0 to 10\. The default value if this parameter is not specified is 0\. 49 .sp 50 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 51 .sp 52 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 73 53 .sp 74 54 Note that specifying this parameter here will override the 75 55 \fIlog level\fR 76 56 parameter in the 77 \fIsmb.conf\fR 78 file. 79 .RE 80 .PP 81 -l|--logfile=logdirectory 82 .RS 3n 83 Base directory name for log/debug files. The extension 84 \fB".progname"\fR 85 will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client. 57 \fIsmb\.conf\fR 58 file\. 59 .RE 60 .PP 61 \-V 62 .RS 4 63 Prints the program version number\. 64 .RE 65 .PP 66 \-s <configuration file> 67 .RS 4 68 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 69 \fIsmb\.conf\fR 70 for more information\. The default configuration file name is determined at compile time\. 71 .RE 72 .PP 73 \-l|\-\-log\-basename=logdirectory 74 .RS 4 75 Base directory name for log/debug files\. The extension 76 \fB"\.progname"\fR 77 will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\. 86 78 .RE 87 79 .SH "COMMANDS" 88 80 .PP 89 \fBVFS COMMANDS\fR 90 .TP 3n 91 \(bu 92 load <module.so> 93 - Load specified VFS module 94 .TP 3n 95 \(bu 81 \fIVFS COMMANDS\fR 82 .sp 83 .RS 4 84 .ie n \{\ 85 \h'-04'\(bu\h'+03'\c 86 .\} 87 .el \{\ 88 .sp -1 89 .IP \(bu 2.3 90 .\} 91 load <module\.so> 92 \- Load specified VFS module 93 .RE 94 .sp 95 .RS 4 96 .ie n \{\ 97 \h'-04'\(bu\h'+03'\c 98 .\} 99 .el \{\ 100 .sp -1 101 .IP \(bu 2.3 102 .\} 96 103 populate <char> <size> 97 - Populate a data buffer with the specified data 98 .TP 3n 99 \(bu 104 \- Populate a data buffer with the specified data 105 .RE 106 .sp 107 .RS 4 108 .ie n \{\ 109 \h'-04'\(bu\h'+03'\c 110 .\} 111 .el \{\ 112 .sp -1 113 .IP \(bu 2.3 114 .\} 100 115 showdata [<offset> <len>] 101 - Show data currently in data buffer 102 .TP 3n 103 \(bu 116 \- Show data currently in data buffer 117 .RE 118 .sp 119 .RS 4 120 .ie n \{\ 121 \h'-04'\(bu\h'+03'\c 122 .\} 123 .el \{\ 124 .sp -1 125 .IP \(bu 2.3 126 .\} 104 127 connect 105 - VFS connect() 106 .TP 3n 107 \(bu 128 \- VFS connect() 129 .RE 130 .sp 131 .RS 4 132 .ie n \{\ 133 \h'-04'\(bu\h'+03'\c 134 .\} 135 .el \{\ 136 .sp -1 137 .IP \(bu 2.3 138 .\} 108 139 disconnect 109 - VFS disconnect() 110 .TP 3n 111 \(bu 140 \- VFS disconnect() 141 .RE 142 .sp 143 .RS 4 144 .ie n \{\ 145 \h'-04'\(bu\h'+03'\c 146 .\} 147 .el \{\ 148 .sp -1 149 .IP \(bu 2.3 150 .\} 112 151 disk_free 113 - VFS disk_free() 114 .TP 3n 115 \(bu 152 \- VFS disk_free() 153 .RE 154 .sp 155 .RS 4 156 .ie n \{\ 157 \h'-04'\(bu\h'+03'\c 158 .\} 159 .el \{\ 160 .sp -1 161 .IP \(bu 2.3 162 .\} 116 163 opendir 117 - VFS opendir() 118 .TP 3n 119 \(bu 164 \- VFS opendir() 165 .RE 166 .sp 167 .RS 4 168 .ie n \{\ 169 \h'-04'\(bu\h'+03'\c 170 .\} 171 .el \{\ 172 .sp -1 173 .IP \(bu 2.3 174 .\} 120 175 readdir 121 - VFS readdir() 122 .TP 3n 123 \(bu 176 \- VFS readdir() 177 .RE 178 .sp 179 .RS 4 180 .ie n \{\ 181 \h'-04'\(bu\h'+03'\c 182 .\} 183 .el \{\ 184 .sp -1 185 .IP \(bu 2.3 186 .\} 124 187 mkdir 125 - VFS mkdir() 126 .TP 3n 127 \(bu 188 \- VFS mkdir() 189 .RE 190 .sp 191 .RS 4 192 .ie n \{\ 193 \h'-04'\(bu\h'+03'\c 194 .\} 195 .el \{\ 196 .sp -1 197 .IP \(bu 2.3 198 .\} 128 199 rmdir 129 - VFS rmdir() 130 .TP 3n 131 \(bu 200 \- VFS rmdir() 201 .RE 202 .sp 203 .RS 4 204 .ie n \{\ 205 \h'-04'\(bu\h'+03'\c 206 .\} 207 .el \{\ 208 .sp -1 209 .IP \(bu 2.3 210 .\} 132 211 closedir 133 - VFS closedir() 134 .TP 3n 135 \(bu 212 \- VFS closedir() 213 .RE 214 .sp 215 .RS 4 216 .ie n \{\ 217 \h'-04'\(bu\h'+03'\c 218 .\} 219 .el \{\ 220 .sp -1 221 .IP \(bu 2.3 222 .\} 136 223 open 137 - VFS open() 138 .TP 3n 139 \(bu 224 \- VFS open() 225 .RE 226 .sp 227 .RS 4 228 .ie n \{\ 229 \h'-04'\(bu\h'+03'\c 230 .\} 231 .el \{\ 232 .sp -1 233 .IP \(bu 2.3 234 .\} 140 235 close 141 - VFS close() 142 .TP 3n 143 \(bu 236 \- VFS close() 237 .RE 238 .sp 239 .RS 4 240 .ie n \{\ 241 \h'-04'\(bu\h'+03'\c 242 .\} 243 .el \{\ 244 .sp -1 245 .IP \(bu 2.3 246 .\} 144 247 read 145 - VFS read() 146 .TP 3n 147 \(bu 248 \- VFS read() 249 .RE 250 .sp 251 .RS 4 252 .ie n \{\ 253 \h'-04'\(bu\h'+03'\c 254 .\} 255 .el \{\ 256 .sp -1 257 .IP \(bu 2.3 258 .\} 148 259 write 149 - VFS write() 150 .TP 3n 151 \(bu 260 \- VFS write() 261 .RE 262 .sp 263 .RS 4 264 .ie n \{\ 265 \h'-04'\(bu\h'+03'\c 266 .\} 267 .el \{\ 268 .sp -1 269 .IP \(bu 2.3 270 .\} 152 271 lseek 153 - VFS lseek() 154 .TP 3n 155 \(bu 272 \- VFS lseek() 273 .RE 274 .sp 275 .RS 4 276 .ie n \{\ 277 \h'-04'\(bu\h'+03'\c 278 .\} 279 .el \{\ 280 .sp -1 281 .IP \(bu 2.3 282 .\} 156 283 rename 157 - VFS rename() 158 .TP 3n 159 \(bu 284 \- VFS rename() 285 .RE 286 .sp 287 .RS 4 288 .ie n \{\ 289 \h'-04'\(bu\h'+03'\c 290 .\} 291 .el \{\ 292 .sp -1 293 .IP \(bu 2.3 294 .\} 160 295 fsync 161 - VFS fsync() 162 .TP 3n 163 \(bu 296 \- VFS fsync() 297 .RE 298 .sp 299 .RS 4 300 .ie n \{\ 301 \h'-04'\(bu\h'+03'\c 302 .\} 303 .el \{\ 304 .sp -1 305 .IP \(bu 2.3 306 .\} 164 307 stat 165 - VFS stat() 166 .TP 3n 167 \(bu 308 \- VFS stat() 309 .RE 310 .sp 311 .RS 4 312 .ie n \{\ 313 \h'-04'\(bu\h'+03'\c 314 .\} 315 .el \{\ 316 .sp -1 317 .IP \(bu 2.3 318 .\} 168 319 fstat 169 - VFS fstat() 170 .TP 3n 171 \(bu 320 \- VFS fstat() 321 .RE 322 .sp 323 .RS 4 324 .ie n \{\ 325 \h'-04'\(bu\h'+03'\c 326 .\} 327 .el \{\ 328 .sp -1 329 .IP \(bu 2.3 330 .\} 172 331 lstat 173 - VFS lstat() 174 .TP 3n 175 \(bu 332 \- VFS lstat() 333 .RE 334 .sp 335 .RS 4 336 .ie n \{\ 337 \h'-04'\(bu\h'+03'\c 338 .\} 339 .el \{\ 340 .sp -1 341 .IP \(bu 2.3 342 .\} 176 343 unlink 177 - VFS unlink() 178 .TP 3n 179 \(bu 344 \- VFS unlink() 345 .RE 346 .sp 347 .RS 4 348 .ie n \{\ 349 \h'-04'\(bu\h'+03'\c 350 .\} 351 .el \{\ 352 .sp -1 353 .IP \(bu 2.3 354 .\} 180 355 chmod 181 - VFS chmod() 182 .TP 3n 183 \(bu 356 \- VFS chmod() 357 .RE 358 .sp 359 .RS 4 360 .ie n \{\ 361 \h'-04'\(bu\h'+03'\c 362 .\} 363 .el \{\ 364 .sp -1 365 .IP \(bu 2.3 366 .\} 184 367 fchmod 185 - VFS fchmod() 186 .TP 3n 187 \(bu 368 \- VFS fchmod() 369 .RE 370 .sp 371 .RS 4 372 .ie n \{\ 373 \h'-04'\(bu\h'+03'\c 374 .\} 375 .el \{\ 376 .sp -1 377 .IP \(bu 2.3 378 .\} 188 379 chown 189 - VFS chown() 190 .TP 3n 191 \(bu 380 \- VFS chown() 381 .RE 382 .sp 383 .RS 4 384 .ie n \{\ 385 \h'-04'\(bu\h'+03'\c 386 .\} 387 .el \{\ 388 .sp -1 389 .IP \(bu 2.3 390 .\} 192 391 fchown 193 - VFS fchown() 194 .TP 3n 195 \(bu 392 \- VFS fchown() 393 .RE 394 .sp 395 .RS 4 396 .ie n \{\ 397 \h'-04'\(bu\h'+03'\c 398 .\} 399 .el \{\ 400 .sp -1 401 .IP \(bu 2.3 402 .\} 196 403 chdir 197 - VFS chdir() 198 .TP 3n 199 \(bu 404 \- VFS chdir() 405 .RE 406 .sp 407 .RS 4 408 .ie n \{\ 409 \h'-04'\(bu\h'+03'\c 410 .\} 411 .el \{\ 412 .sp -1 413 .IP \(bu 2.3 414 .\} 200 415 getwd 201 - VFS getwd() 202 .TP 3n 203 \(bu 416 \- VFS getwd() 417 .RE 418 .sp 419 .RS 4 420 .ie n \{\ 421 \h'-04'\(bu\h'+03'\c 422 .\} 423 .el \{\ 424 .sp -1 425 .IP \(bu 2.3 426 .\} 204 427 utime 205 - VFS utime() 206 .TP 3n 207 \(bu 428 \- VFS utime() 429 .RE 430 .sp 431 .RS 4 432 .ie n \{\ 433 \h'-04'\(bu\h'+03'\c 434 .\} 435 .el \{\ 436 .sp -1 437 .IP \(bu 2.3 438 .\} 208 439 ftruncate 209 - VFS ftruncate() 210 .TP 3n 211 \(bu 440 \- VFS ftruncate() 441 .RE 442 .sp 443 .RS 4 444 .ie n \{\ 445 \h'-04'\(bu\h'+03'\c 446 .\} 447 .el \{\ 448 .sp -1 449 .IP \(bu 2.3 450 .\} 212 451 lock 213 - VFS lock() 214 .TP 3n 215 \(bu 452 \- VFS lock() 453 .RE 454 .sp 455 .RS 4 456 .ie n \{\ 457 \h'-04'\(bu\h'+03'\c 458 .\} 459 .el \{\ 460 .sp -1 461 .IP \(bu 2.3 462 .\} 216 463 symlink 217 - VFS symlink() 218 .TP 3n 219 \(bu 464 \- VFS symlink() 465 .RE 466 .sp 467 .RS 4 468 .ie n \{\ 469 \h'-04'\(bu\h'+03'\c 470 .\} 471 .el \{\ 472 .sp -1 473 .IP \(bu 2.3 474 .\} 220 475 readlink 221 - VFS readlink() 222 .TP 3n 223 \(bu 476 \- VFS readlink() 477 .RE 478 .sp 479 .RS 4 480 .ie n \{\ 481 \h'-04'\(bu\h'+03'\c 482 .\} 483 .el \{\ 484 .sp -1 485 .IP \(bu 2.3 486 .\} 224 487 link 225 - VFS link() 226 .TP 3n 227 \(bu 488 \- VFS link() 489 .RE 490 .sp 491 .RS 4 492 .ie n \{\ 493 \h'-04'\(bu\h'+03'\c 494 .\} 495 .el \{\ 496 .sp -1 497 .IP \(bu 2.3 498 .\} 228 499 mknod 229 - VFS mknod() 230 .TP 3n 231 \(bu 500 \- VFS mknod() 501 .RE 502 .sp 503 .RS 4 504 .ie n \{\ 505 \h'-04'\(bu\h'+03'\c 506 .\} 507 .el \{\ 508 .sp -1 509 .IP \(bu 2.3 510 .\} 232 511 realpath 233 - VFS realpath() 234 .PP 235 \fBGENERAL COMMANDS\fR 236 .TP 3n 237 \(bu 238 conf <smb.conf> 239 - Load a different configuration file 240 .TP 3n 241 \(bu 512 \- VFS realpath() 513 .sp 514 .RE 515 .PP 516 \fIGENERAL COMMANDS\fR 517 .sp 518 .RS 4 519 .ie n \{\ 520 \h'-04'\(bu\h'+03'\c 521 .\} 522 .el \{\ 523 .sp -1 524 .IP \(bu 2.3 525 .\} 526 conf <smb\.conf> 527 \- Load a different configuration file 528 .RE 529 .sp 530 .RS 4 531 .ie n \{\ 532 \h'-04'\(bu\h'+03'\c 533 .\} 534 .el \{\ 535 .sp -1 536 .IP \(bu 2.3 537 .\} 242 538 help [<command>] 243 - Get list of commands or info about specified command 244 .TP 3n 245 \(bu 539 \- Get list of commands or info about specified command 540 .RE 541 .sp 542 .RS 4 543 .ie n \{\ 544 \h'-04'\(bu\h'+03'\c 545 .\} 546 .el \{\ 547 .sp -1 548 .IP \(bu 2.3 549 .\} 246 550 debuglevel <level> 247 - Set debug level 248 .TP 3n 249 \(bu 551 \- Set debug level 552 .RE 553 .sp 554 .RS 4 555 .ie n \{\ 556 \h'-04'\(bu\h'+03'\c 557 .\} 558 .el \{\ 559 .sp -1 560 .IP \(bu 2.3 561 .\} 250 562 freemem 251 - Free memory currently in use 252 .TP 3n 253 \(bu 563 \- Free memory currently in use 564 .RE 565 .sp 566 .RS 4 567 .ie n \{\ 568 \h'-04'\(bu\h'+03'\c 569 .\} 570 .el \{\ 571 .sp -1 572 .IP \(bu 2.3 573 .\} 254 574 exit 255 - Exit vfstest575 \- Exit vfstest 256 576 .SH "VERSION" 257 577 .PP 258 This man page is correct for version 3 .0 of the Samba suite.578 This man page is correct for version 3\.0 of the Samba suite\. 259 579 .SH "AUTHOR" 260 580 .PP 261 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 262 .PP 263 The vfstest man page was written by Jelmer Vernooij. 264 581 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 582 .PP 583 The vfstest man page was written by Jelmer Vernooij\. -
branches/samba-3.0/docs/manpages/wbinfo.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "WBINFO" 1 "" "" "" 1 .\" Title: wbinfo 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "WBINFO" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 wbinfo - Query information from winbind daemon 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 wbinfo [ -a user%password] [--all-domains] [--allocate-gid] [--allocate-uid] [-D domain] [--domain domain] [-g] [--getdcname domain] [--get-auth-user] [-G gid] [-h] [-i user] [-I ip] [-K user%password] [-m] [-n name] [-N netbios-name] [--own-domain] [-p] [-r user] [-s sid] [--separator] [--sequence] [--set-auth-user user%password] [-S sid] [-t] [-u] [--user-domgroups sid] [--user-sids sid] [-U uid] [-V] [-Y sid]17 wbinfo [\-a\ user%password] [\-\-all\-domains] [\-\-allocate\-gid] [\-\-allocate\-uid] [\-D\ domain] [\-\-domain\ domain] [\-g] [\-\-getdcname\ domain] [\-\-get\-auth\-user] [\-G\ gid] [\-h] [\-i\ user] [\-I\ ip] [\-K\ user%password] [\-m] [\-n\ name] [\-N\ netbios\-name] [\-\-own\-domain] [\-p] [\-r\ user] [\-s\ sid] [\-\-separator] [\-\-sequence] [\-\-set\-auth\-user\ user%password] [\-S\ sid] [\-t] [\-u] [\-\-uid\-info\ uid] [\-\-user\-domgroups\ sid] [\-\-user\-sids\ sid] [\-U\ uid] [\-V] [\-Y\ sid] [\-\-verbose] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The … … 34 26 program queries and returns information created and used by the 35 27 \fBwinbindd\fR(8) 36 daemon .28 daemon\. 37 29 .PP 38 30 The … … 40 32 daemon must be configured and running for the 41 33 wbinfo 42 program to be able to return information .34 program to be able to return information\. 43 35 .SH "OPTIONS" 44 36 .PP 45 -a|--authenticate username%password46 .RS 3n47 Attempt to authenticate a user via winbindd . This checks both authenticaion methods and reports its results.37 \-a|\-\-authenticate username%password 38 .RS 4 39 Attempt to authenticate a user via winbindd\. This checks both authenticaion methods and reports its results\. 48 40 .sp 49 41 .it 1 an-trap … … 51 43 .nr an-break-flag 1 52 44 .br 53 \fBNote\fR 54 Do not be tempted to use this functionality for authentication in third -party applications. Instead use55 \fBntlm_auth\fR(1) .56 .RE 57 .PP 58 --allocate-gid59 .RS 3n45 Note 46 Do not be tempted to use this functionality for authentication in third\-party applications\. Instead use 47 \fBntlm_auth\fR(1)\. 48 .RE 49 .PP 50 \-\-allocate\-gid 51 .RS 4 60 52 Get a new GID out of idmap 61 53 .RE 62 54 .PP 63 --allocate-uid64 .RS 3n55 \-\-allocate\-uid 56 .RS 4 65 57 Get a new UID out of idmap 66 58 .RE 67 59 .PP 68 --all-domains69 .RS 3n70 List all domains (trusted and own domain) .71 .RE 72 .PP 73 --domain name74 .RS 3n75 This parameter sets the domain on which any specified operations will performed . If special domain name '.' is used to represent the current domain to which winbindd belongs. Currently only the76 \fB --sequence\fR,77 \fB -u\fR, and78 \fB -g\fR79 options honor this parameter .80 .RE 81 .PP 82 -D|--domain-info domain83 .RS 3n84 Show most of the info we have about the domain .85 .RE 86 .PP 87 -g|--domain-groups88 .RS 3n60 \-\-all\-domains 61 .RS 4 62 List all domains (trusted and own domain)\. 63 .RE 64 .PP 65 \-\-domain name 66 .RS 4 67 This parameter sets the domain on which any specified operations will performed\. If special domain name \'\.\' is used to represent the current domain to which winbindd belongs\. Currently only the 68 \fB\-\-sequence\fR, 69 \fB\-u\fR, and 70 \fB\-g\fR 71 options honor this parameter\. 72 .RE 73 .PP 74 \-D|\-\-domain\-info domain 75 .RS 4 76 Show most of the info we have about the domain\. 77 .RE 78 .PP 79 \-g|\-\-domain\-groups 80 .RS 4 89 81 This option will list all groups available in the Windows NT domain for which the 90 82 \fBsamba\fR(7) 91 daemon is operating in . Groups in all trusted domains will also be listed. Note that this operation does not assign group ids to any groups that have not already been seen by92 \fBwinbindd\fR(8) .93 .RE 94 .PP 95 --get-auth-user96 .RS 3n97 Print username and password used by winbindd during session setup to a domain controller . Username and password can be set using98 \fB --set-auth-user\fR. Only available for root.99 .RE 100 .PP 101 --getdcname domain102 .RS 3n103 Get the DC name for the specified domain .104 .RE 105 .PP 106 -G|--gid-to-sid gid107 .RS 3n108 Try to convert a UNIX group id to a Windows NT SID . If the gid specified does not refer to one within the idmap gid range then the operation will fail.109 .RE 110 .PP 111 -i|--user-info user112 .RS 3n113 Get user info .114 .RE 115 .PP 116 -I|--WINS-by-ip ip117 .RS 3n118 The 119 \fI -I\fR83 daemon is operating in\. Groups in all trusted domains will also be listed\. Note that this operation does not assign group ids to any groups that have not already been seen by 84 \fBwinbindd\fR(8)\. 85 .RE 86 .PP 87 \-\-get\-auth\-user 88 .RS 4 89 Print username and password used by winbindd during session setup to a domain controller\. Username and password can be set using 90 \fB\-\-set\-auth\-user\fR\. Only available for root\. 91 .RE 92 .PP 93 \-\-getdcname domain 94 .RS 4 95 Get the DC name for the specified domain\. 96 .RE 97 .PP 98 \-G|\-\-gid\-to\-sid gid 99 .RS 4 100 Try to convert a UNIX group id to a Windows NT SID\. If the gid specified does not refer to one within the idmap gid range then the operation will fail\. 101 .RE 102 .PP 103 \-i|\-\-user\-info user 104 .RS 4 105 Get user info\. 106 .RE 107 .PP 108 \-I|\-\-WINS\-by\-ip ip 109 .RS 4 110 The 111 \fI\-I\fR 120 112 option queries 121 113 \fBwinbindd\fR(8) 122 114 to send a node status request to get the NetBIOS name associated with the IP address specified by the 123 115 \fIip\fR 124 parameter .125 .RE 126 .PP 127 -K|--krb5auth username%password128 .RS 3n129 Attempt to authenticate a user via Kerberos .130 .RE 131 .PP 132 -m|--trusted-domains133 .RS 3n116 parameter\. 117 .RE 118 .PP 119 \-K|\-\-krb5auth username%password 120 .RS 4 121 Attempt to authenticate a user via Kerberos\. 122 .RE 123 .PP 124 \-m|\-\-trusted\-domains 125 .RS 4 134 126 Produce a list of domains trusted by the Windows NT server 135 127 \fBwinbindd\fR(8) 136 contacts when resolving names . This list does not include the Windows NT domain the server is a Primary Domain Controller for.137 .RE 138 .PP 139 -n|--name-to-sid name140 .RS 3n141 The 142 \fI -n\fR128 contacts when resolving names\. This list does not include the Windows NT domain the server is a Primary Domain Controller for\. 129 .RE 130 .PP 131 \-n|\-\-name\-to\-sid name 132 .RS 4 133 The 134 \fI\-n\fR 143 135 option queries 144 136 \fBwinbindd\fR(8) 145 for the SID associated with the name specified . Domain names can be specified before the user name by using the winbind separator character. For example CWDOM1/Administrator refers to the Administrator user in the domain CWDOM1. If no domain is specified then the domain used is the one specified in the137 for the SID associated with the name specified\. Domain names can be specified before the user name by using the winbind separator character\. For example CWDOM1/Administrator refers to the Administrator user in the domain CWDOM1\. If no domain is specified then the domain used is the one specified in the 146 138 \fBsmb.conf\fR(5) 147 139 \fIworkgroup \fR 148 parameter .149 .RE 150 .PP 151 -N|--WINS-by-name name152 .RS 3n153 The 154 \fI -N\fR140 parameter\. 141 .RE 142 .PP 143 \-N|\-\-WINS\-by\-name name 144 .RS 4 145 The 146 \fI\-N\fR 155 147 option queries 156 148 \fBwinbindd\fR(8) 157 149 to query the WINS server for the IP address associated with the NetBIOS name specified by the 158 150 \fIname\fR 159 parameter .160 .RE 161 .PP 162 --own-domain163 .RS 3n164 List own domain .165 .RE 166 .PP 167 -p|--ping168 .RS 3n169 Check whether winbindd is still alive . Prints out either 'succeeded' or 'failed'.170 .RE 171 .PP 172 -r|--user-groups username173 .RS 3n174 Try to obtain the list of UNIX group ids to which the user belongs . This only works for users defined on a Domain Controller.175 .RE 176 .PP 177 -s|--sid-to-name sid178 .RS 3n151 parameter\. 152 .RE 153 .PP 154 \-\-own\-domain 155 .RS 4 156 List own domain\. 157 .RE 158 .PP 159 \-p|\-\-ping 160 .RS 4 161 Check whether winbindd is still alive\. Prints out either \'succeeded\' or \'failed\'\. 162 .RE 163 .PP 164 \-r|\-\-user\-groups username 165 .RS 4 166 Try to obtain the list of UNIX group ids to which the user belongs\. This only works for users defined on a Domain Controller\. 167 .RE 168 .PP 169 \-s|\-\-sid\-to\-name sid 170 .RS 4 179 171 Use 180 \fI -s\fR181 to resolve a SID to a name . This is the inverse of the182 \fI -n \fR183 option above . SIDs must be specified as ASCII strings in the traditional Microsoft format. For example, S-1-5-21-1455342024-3071081365-2475485837-500.184 .RE 185 .PP 186 --separator187 .RS 3n188 Get the active winbind separator .189 .RE 190 .PP 191 --sequence192 .RS 3n172 \fI\-s\fR 173 to resolve a SID to a name\. This is the inverse of the 174 \fI\-n \fR 175 option above\. SIDs must be specified as ASCII strings in the traditional Microsoft format\. For example, S\-1\-5\-21\-1455342024\-3071081365\-2475485837\-500\. 176 .RE 177 .PP 178 \-\-separator 179 .RS 4 180 Get the active winbind separator\. 181 .RE 182 .PP 183 \-\-sequence 184 .RS 4 193 185 Show sequence numbers of all known domains 194 186 .RE 195 187 .PP 196 --set-auth-user username%password197 .RS 3n198 Store username and password used by winbindd during session setup to a domain controller . This enables winbindd to operate in a Windows 2000 domain with Restrict Anonymous turned on (a.k.a. Permissions compatiable with Windows 2000 servers only).199 .RE 200 .PP 201 -S|--sid-to-uid sid202 .RS 3n203 Convert a SID to a UNIX user id . If the SID does not correspond to a UNIX user mapped by204 \fBwinbindd\fR(8) 205 then the operation will fail .206 .RE 207 .PP 208 -t|--check-secret209 .RS 3n210 Verify that the workstation trust account created when the Samba server is added to the Windows NT domain is working .211 .RE 212 .PP 213 -u|--domain-users214 .RS 3n188 \-\-set\-auth\-user username%password 189 .RS 4 190 Store username and password used by winbindd during session setup to a domain controller\. This enables winbindd to operate in a Windows 2000 domain with Restrict Anonymous turned on (a\.k\.a\. Permissions compatible with Windows 2000 servers only)\. 191 .RE 192 .PP 193 \-S|\-\-sid\-to\-uid sid 194 .RS 4 195 Convert a SID to a UNIX user id\. If the SID does not correspond to a UNIX user mapped by 196 \fBwinbindd\fR(8) 197 then the operation will fail\. 198 .RE 199 .PP 200 \-t|\-\-check\-secret 201 .RS 4 202 Verify that the workstation trust account created when the Samba server is added to the Windows NT domain is working\. 203 .RE 204 .PP 205 \-u|\-\-domain\-users 206 .RS 4 215 207 This option will list all users available in the Windows NT domain for which the 216 208 \fBwinbindd\fR(8) 217 daemon is operating in. Users in all trusted domains will also be listed. Note that this operation does not assign user ids to any users that have not already been seen by 218 \fBwinbindd\fR(8) 219 . 220 .RE 221 .PP 222 --user-domgroups SID 223 .RS 3n 224 Get user domain groups. 225 .RE 226 .PP 227 --user-sids SID 228 .RS 3n 229 Get user group SIDs for user. 230 .RE 231 .PP 232 -U|--uid-to-sid uid 233 .RS 3n 234 Try to convert a UNIX user id to a Windows NT SID. If the uid specified does not refer to one within the idmap uid range then the operation will fail. 235 .RE 236 .PP 237 -Y|--sid-to-gid sid 238 .RS 3n 239 Convert a SID to a UNIX group id. If the SID does not correspond to a UNIX group mapped by 240 \fBwinbindd\fR(8) 241 then the operation will fail. 242 .RE 243 .PP 244 -V 245 .RS 3n 246 Prints the program version number. 247 .RE 248 .PP 249 -h|--help 250 .RS 3n 251 Print a summary of command line options. 209 daemon is operating in\. Users in all trusted domains will also be listed\. Note that this operation does not assign user ids to any users that have not already been seen by 210 \fBwinbindd\fR(8) 211 \. 212 .RE 213 .PP 214 \-\-uid\-info UID 215 .RS 4 216 Get user info for the user conencted to user id UID\. 217 .RE 218 .PP 219 \-\-user\-domgroups SID 220 .RS 4 221 Get user domain groups\. 222 .RE 223 .PP 224 \-\-user\-sids SID 225 .RS 4 226 Get user group SIDs for user\. 227 .RE 228 .PP 229 \-U|\-\-uid\-to\-sid uid 230 .RS 4 231 Try to convert a UNIX user id to a Windows NT SID\. If the uid specified does not refer to one within the idmap uid range then the operation will fail\. 232 .RE 233 .PP 234 \-\-verbose 235 .RS 4 236 Print additional information about the query results\. 237 .RE 238 .PP 239 \-Y|\-\-sid\-to\-gid sid 240 .RS 4 241 Convert a SID to a UNIX group id\. If the SID does not correspond to a UNIX group mapped by 242 \fBwinbindd\fR(8) 243 then the operation will fail\. 244 .RE 245 .PP 246 \-V 247 .RS 4 248 Prints the program version number\. 249 .RE 250 .PP 251 \-h|\-\-help 252 .RS 4 253 Print a summary of command line options\. 252 254 .RE 253 255 .SH "EXIT STATUS" 254 256 .PP 255 The wbinfo program returns 0 if the operation succeeded, or 1 if the operation failed . If the257 The wbinfo program returns 0 if the operation succeeded, or 1 if the operation failed\. If the 256 258 \fBwinbindd\fR(8) 257 259 daemon is not working 258 260 wbinfo 259 will always return failure .261 will always return failure\. 260 262 .SH "VERSION" 261 263 .PP 262 This man page is correct for version 3 .0 of the Samba suite.264 This man page is correct for version 3\.0 of the Samba suite\. 263 265 .SH "SEE ALSO" 264 266 .PP … … 268 270 .SH "AUTHOR" 269 271 .PP 270 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.272 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 271 273 .PP 272 274 wbinfo 273 275 and 274 276 winbindd 275 were written by Tim Potter. 276 .PP 277 The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 278 277 were written by Tim Potter\. 278 .PP 279 The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\. -
branches/samba-3.0/docs/manpages/winbindd.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "WINBINDD" 8 "" "" "" 1 .\" Title: winbindd 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "WINBINDD" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 winbindd - Name Service Switch daemon for resolving names from NT servers 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 winbindd [ -F] [-S] [-i] [-Y] [-d <debug level>] [-s <smb config file>] [-n]17 winbindd [\-D] [\-F] [\-S] [\-i] [\-Y] [\-d\ <debug\ level>] [\-s\ <smb\ config\ file>] [\-n] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This program is part of the 29 21 \fBsamba\fR(7) 30 suite .31 .PP 32 winbindd 33 is a daemon that provides a number of services to the Name Service Switch capability found in most modern C libraries, to arbit ary applications via PAM and22 suite\. 23 .PP 24 winbindd 25 is a daemon that provides a number of services to the Name Service Switch capability found in most modern C libraries, to arbitrary applications via PAM and 34 26 ntlm_auth 35 and to Samba itself .27 and to Samba itself\. 36 28 .PP 37 29 Even if winbind is not used for nsswitch, it still provides a service to … … 39 31 ntlm_auth 40 32 and the 41 pam_winbind.so 42 PAM module, by managing connections to domain controllers. In this configuraiton the 43 idmap uid and 44 idmap gid parameters are not required. (This is known as `netlogon proxy only mode'.) 45 .PP 46 The Name Service Switch allows user and system information to be obtained from different databases services such as NIS or DNS. The exact behaviour can be configured throught the 47 \fI/etc/nsswitch.conf\fR 48 file. Users and groups are allocated as they are resolved to a range of user and group ids specified by the administrator of the Samba system. 33 pam_winbind\.so 34 PAM module, by managing connections to domain controllers\. In this configuraiton the 35 \fIidmap uid\fR 36 and 37 \fIidmap gid\fR 38 parameters are not required\. (This is known as `netlogon proxy only mode\'\.) 39 .PP 40 The Name Service Switch allows user and system information to be obtained from different databases services such as NIS or DNS\. The exact behaviour can be configured throught the 41 \fI/etc/nsswitch\.conf\fR 42 file\. Users and groups are allocated as they are resolved to a range of user and group ids specified by the administrator of the Samba system\. 49 43 .PP 50 44 The service provided by 51 45 winbindd 52 is called `winbind ' and can be used to resolve user and group information from a Windows NT server. The service can also provide authentication services via an associated PAM module.46 is called `winbind\' and can be used to resolve user and group information from a Windows NT server\. The service can also provide authentication services via an associated PAM module\. 53 47 .PP 54 48 The … … 59 53 and 60 54 \fIpassword\fR 61 module -types. It should be noted that the55 module\-types\. It should be noted that the 62 56 \fIaccount\fR 63 module simply performs a getpwnam() to verify that the system can obtain a uid for the user, as the domain controller has already performed access control . If the57 module simply performs a getpwnam() to verify that the system can obtain a uid for the user, as the domain controller has already performed access control\. If the 64 58 \fIlibnss_winbind\fR 65 library has been correctly installed, or an alternate source of names configured, this should always succeed .59 library has been correctly installed, or an alternate source of names configured, this should always succeed\. 66 60 .PP 67 61 The following nsswitch databases are implemented by the winbindd service: 68 62 .PP 63 \-D 64 .RS 4 65 If specified, this parameter causes the server to operate as a daemon\. That is, it detaches itself and runs in the background on the appropriate port\. This switch is assumed if 66 winbindd 67 is executed on the command line of a shell\. 68 .RE 69 .PP 69 70 hosts 70 .RS 3n71 This feature is only available on IRIX . User information traditionally stored in the71 .RS 4 72 This feature is only available on IRIX\. User information traditionally stored in the 72 73 \fIhosts(5)\fR 73 74 file and used by 74 75 gethostbyname(3) 75 functions . Names are resolved through the WINS server or by broadcast.76 functions\. Names are resolved through the WINS server or by broadcast\. 76 77 .RE 77 78 .PP 78 79 passwd 79 .RS 3n80 .RS 4 80 81 User information traditionally stored in the 81 82 \fIpasswd(5)\fR 82 83 file and used by 83 84 getpwent(3) 84 functions .85 functions\. 85 86 .RE 86 87 .PP 87 88 group 88 .RS 3n89 .RS 4 89 90 Group information traditionally stored in the 90 91 \fIgroup(5)\fR 91 92 file and used by 92 93 getgrent(3) 93 functions .94 functions\. 94 95 .RE 95 96 .PP 96 97 For example, the following simple configuration in the 97 \fI/etc/nsswitch .conf\fR98 \fI/etc/nsswitch\.conf\fR 98 99 file can be used to initially resolve user and group information from 99 100 \fI/etc/passwd \fR 100 101 and 101 102 \fI/etc/group\fR 102 and then from the Windows NT server. 103 104 .sp 105 103 and then from the Windows NT server\. 104 .sp 105 .RS 4 106 106 .nf 107 108 107 passwd: files winbind 109 108 group: files winbind 110 ## only available on IRIX; Linux users should us libnss_wins .so109 ## only available on IRIX; Linux users should us libnss_wins\.so 111 110 hosts: files dns winbind 112 113 111 .fi 114 112 .RE 115 113 .PP 116 114 The following simple configuration in the 117 \fI/etc/nsswitch .conf\fR115 \fI/etc/nsswitch\.conf\fR 118 116 file can be used to initially resolve hostnames from 119 117 \fI/etc/hosts\fR 120 and then from the WINS server. 121 118 and then from the WINS server\. 119 .sp 120 .RS 4 122 121 .nf 123 124 122 hosts: files wins 125 126 123 .fi 124 .RE 127 125 .SH "OPTIONS" 128 126 .PP 129 -F130 .RS 3n127 \-F 128 .RS 4 131 129 If specified, this parameter causes the main 132 130 winbindd 133 process to not daemonize, i .e. double-fork and disassociate with the terminal. Child processes are still created as normal to service each connection request, but the main process does not exit. This operation mode is suitable for running131 process to not daemonize, i\.e\. double\-fork and disassociate with the terminal\. Child processes are still created as normal to service each connection request, but the main process does not exit\. This operation mode is suitable for running 134 132 winbindd 135 133 under process supervisors such as … … 137 135 and 138 136 svscan 139 from Daniel J . Bernstein's137 from Daniel J\. Bernstein\'s 140 138 daemontools 141 package, or the AIX process monitor .142 .RE 143 .PP 144 -S145 .RS 3n139 package, or the AIX process monitor\. 140 .RE 141 .PP 142 \-S 143 .RS 4 146 144 If specified, this parameter causes 147 145 winbindd 148 to log to standard output rather than a file. 149 .RE 150 .PP 151 -V 152 .RS 3n 153 Prints the program version number. 154 .RE 155 .PP 156 -s <configuration file> 157 .RS 3n 158 The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See 159 \fIsmb.conf\fR 160 for more information. The default configuration file name is determined at compile time. 161 .RE 162 .PP 163 -d|--debuglevel=level 164 .RS 3n 146 to log to standard output rather than a file\. 147 .RE 148 .PP 149 \-d|\-\-debuglevel=level 150 .RS 4 165 151 \fIlevel\fR 166 is an integer from 0 to 10 . The default value if this parameter is not specified is zero.167 .sp 168 The higher this value, the more detail will be logged to the log files about the activities of the server . At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out.169 .sp 170 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem . Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic.152 is an integer from 0 to 10\. The default value if this parameter is not specified is 0\. 153 .sp 154 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 155 .sp 156 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\. 171 157 .sp 172 158 Note that specifying this parameter here will override the 173 159 \fIlog level\fR 174 160 parameter in the 175 \fIsmb.conf\fR 176 file. 177 .RE 178 .PP 179 -l|--logfile=logdirectory 180 .RS 3n 181 Base directory name for log/debug files. The extension 182 \fB".progname"\fR 183 will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client. 184 .RE 185 .PP 186 -h|--help 187 .RS 3n 188 Print a summary of command line options. 189 .RE 190 .PP 191 -i 192 .RS 3n 161 \fIsmb\.conf\fR 162 file\. 163 .RE 164 .PP 165 \-V 166 .RS 4 167 Prints the program version number\. 168 .RE 169 .PP 170 \-s <configuration file> 171 .RS 4 172 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 173 \fIsmb\.conf\fR 174 for more information\. The default configuration file name is determined at compile time\. 175 .RE 176 .PP 177 \-l|\-\-log\-basename=logdirectory 178 .RS 4 179 Base directory name for log/debug files\. The extension 180 \fB"\.progname"\fR 181 will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\. 182 .RE 183 .PP 184 \-h|\-\-help 185 .RS 4 186 Print a summary of command line options\. 187 .RE 188 .PP 189 \-i 190 .RS 4 193 191 Tells 194 192 winbindd 195 to not become a daemon and detach from the current terminal . This option is used by developers when interactive debugging of196 winbindd 197 is required .193 to not become a daemon and detach from the current terminal\. This option is used by developers when interactive debugging of 194 winbindd 195 is required\. 198 196 winbindd 199 197 also logs to standard output, as if the 200 -S201 parameter had been given .202 .RE 203 .PP 204 -n205 .RS 3n206 Disable caching . This means winbindd will always have to wait for a response from the domain controller before it can respond to a client and this thus makes things slower. The results will however be more accurate, since results from the cache might not be up-to-date. This might also temporarily hang winbindd if the DC doesn't respond.207 .RE 208 .PP 209 -Y210 .RS 3n211 Single daemon mode . This means winbindd will run as a single process (the mode of operation in Samba 2.2). Winbindd's default behavior is to launch a child process that is responsible for updating expired cache entries.198 \-S 199 parameter had been given\. 200 .RE 201 .PP 202 \-n 203 .RS 4 204 Disable caching\. This means winbindd will always have to wait for a response from the domain controller before it can respond to a client and this thus makes things slower\. The results will however be more accurate, since results from the cache might not be up\-to\-date\. This might also temporarily hang winbindd if the DC doesn\'t respond\. 205 .RE 206 .PP 207 \-Y 208 .RS 4 209 Single daemon mode\. This means winbindd will run as a single process (the mode of operation in Samba 2\.2)\. Winbindd\'s default behavior is to launch a child process that is responsible for updating expired cache entries\. 212 210 .RE 213 211 .SH "NAME AND ID RESOLUTION" 214 212 .PP 215 Users and groups on a Windows NT server are assigned a security id (SID) which is globally unique when the user or group is created . To convert the Windows NT user or group into a unix user or group, a mapping between SIDs and unix user and group ids is required. This is one of the jobs that216 winbindd 217 performs .218 .PP 219 As winbindd users and groups are resolved from a server, user and group ids are allocated from a specified range . This is done on a first come, first served basis, although all existing users and groups will be mapped as soon as a client performs a user or group enumeration command. The allocated unix ids are stored in a database and will be remembered.220 .PP 221 WARNING: The SID to unix id database is the only location where the user and group mappings are stored by winbindd . If this store is deleted or corrupted, there is no way for winbindd to determine which user and group ids correspond to Windows NT user and group rids.213 Users and groups on a Windows NT server are assigned a security id (SID) which is globally unique when the user or group is created\. To convert the Windows NT user or group into a unix user or group, a mapping between SIDs and unix user and group ids is required\. This is one of the jobs that 214 winbindd 215 performs\. 216 .PP 217 As winbindd users and groups are resolved from a server, user and group ids are allocated from a specified range\. This is done on a first come, first served basis, although all existing users and groups will be mapped as soon as a client performs a user or group enumeration command\. The allocated unix ids are stored in a database and will be remembered\. 218 .PP 219 WARNING: The SID to unix id database is the only location where the user and group mappings are stored by winbindd\. If this store is deleted or corrupted, there is no way for winbindd to determine which user and group ids correspond to Windows NT user and group rids\. 222 220 .PP 223 221 See the 224 222 \fIidmap domains\fR 225 223 or the old 226 224 \fIidmap backend\fR 227 225 parameters in 228 \fIsmb .conf\fR229 for options for sharing this database, such as via LDAP .226 \fIsmb\.conf\fR 227 for options for sharing this database, such as via LDAP\. 230 228 .SH "CONFIGURATION" 231 229 .PP … … 234 232 daemon is done through configuration parameters in the 235 233 \fBsmb.conf\fR(5) 236 file. All parameters should be specified in the [global] section of smb.conf. 237 .TP 3n 238 \(bu 239 240 winbind separator 241 .TP 3n 242 \(bu 243 244 idmap uid 245 .TP 3n 246 \(bu 247 248 idmap gid 249 .TP 3n 250 \(bu 251 252 idmap backend 253 .TP 3n 254 \(bu 255 256 winbind cache time 257 .TP 3n 258 \(bu 259 260 winbind enum users 261 .TP 3n 262 \(bu 263 264 winbind enum groups 265 .TP 3n 266 \(bu 267 268 template homedir 269 .TP 3n 270 \(bu 271 272 template shell 273 .TP 3n 274 \(bu 275 276 winbind use default domain 277 .TP 3n 278 \(bu 279 280 winbind: rpc only Setting this parameter forces winbindd to use RPC instead of LDAP to retrieve information from Domain Controllers. 234 file\. All parameters should be specified in the [global] section of smb\.conf\. 235 .sp 236 .RS 4 237 .ie n \{\ 238 \h'-04'\(bu\h'+03'\c 239 .\} 240 .el \{\ 241 .sp -1 242 .IP \(bu 2.3 243 .\} 244 245 \fIwinbind separator\fR 246 .RE 247 .sp 248 .RS 4 249 .ie n \{\ 250 \h'-04'\(bu\h'+03'\c 251 .\} 252 .el \{\ 253 .sp -1 254 .IP \(bu 2.3 255 .\} 256 257 \fIidmap uid\fR 258 .RE 259 .sp 260 .RS 4 261 .ie n \{\ 262 \h'-04'\(bu\h'+03'\c 263 .\} 264 .el \{\ 265 .sp -1 266 .IP \(bu 2.3 267 .\} 268 269 \fIidmap gid\fR 270 .RE 271 .sp 272 .RS 4 273 .ie n \{\ 274 \h'-04'\(bu\h'+03'\c 275 .\} 276 .el \{\ 277 .sp -1 278 .IP \(bu 2.3 279 .\} 280 281 \fIidmap backend\fR 282 .RE 283 .sp 284 .RS 4 285 .ie n \{\ 286 \h'-04'\(bu\h'+03'\c 287 .\} 288 .el \{\ 289 .sp -1 290 .IP \(bu 2.3 291 .\} 292 293 \fIwinbind cache time\fR 294 .RE 295 .sp 296 .RS 4 297 .ie n \{\ 298 \h'-04'\(bu\h'+03'\c 299 .\} 300 .el \{\ 301 .sp -1 302 .IP \(bu 2.3 303 .\} 304 305 \fIwinbind enum users\fR 306 .RE 307 .sp 308 .RS 4 309 .ie n \{\ 310 \h'-04'\(bu\h'+03'\c 311 .\} 312 .el \{\ 313 .sp -1 314 .IP \(bu 2.3 315 .\} 316 317 \fIwinbind enum groups\fR 318 .RE 319 .sp 320 .RS 4 321 .ie n \{\ 322 \h'-04'\(bu\h'+03'\c 323 .\} 324 .el \{\ 325 .sp -1 326 .IP \(bu 2.3 327 .\} 328 329 \fItemplate homedir\fR 330 .RE 331 .sp 332 .RS 4 333 .ie n \{\ 334 \h'-04'\(bu\h'+03'\c 335 .\} 336 .el \{\ 337 .sp -1 338 .IP \(bu 2.3 339 .\} 340 341 \fItemplate shell\fR 342 .RE 343 .sp 344 .RS 4 345 .ie n \{\ 346 \h'-04'\(bu\h'+03'\c 347 .\} 348 .el \{\ 349 .sp -1 350 .IP \(bu 2.3 351 .\} 352 353 \fIwinbind use default domain\fR 354 .RE 355 .sp 356 .RS 4 357 .ie n \{\ 358 \h'-04'\(bu\h'+03'\c 359 .\} 360 .el \{\ 361 .sp -1 362 .IP \(bu 2.3 363 .\} 364 365 \fIwinbind: rpc only\fR 366 Setting this parameter forces winbindd to use RPC instead of LDAP to retrieve information from Domain Controllers\. 281 367 .SH "EXAMPLE SETUP" 282 368 .PP 283 To setup winbindd for user and group lookups plus authentication from a domain controller use something like the following setup . This was tested on an early Red Hat Linux box.369 To setup winbindd for user and group lookups plus authentication from a domain controller use something like the following setup\. This was tested on an early Red Hat Linux box\. 284 370 .PP 285 371 In 286 \fI/etc/nsswitch .conf\fR372 \fI/etc/nsswitch\.conf\fR 287 373 put the following: 288 289 .sp 290 374 .sp 375 .RS 4 291 376 .nf 292 293 377 passwd: files winbind 294 378 group: files winbind 295 296 379 .fi 297 380 .RE 298 381 .PP 299 382 In 300 \fI/etc/pam .d/*\fR383 \fI/etc/pam\.d/*\fR 301 384 replace the 302 385 \fI auth\fR 303 386 lines with something like this: 304 305 .sp 306 387 .sp 388 .RS 4 307 389 .nf 308 309 auth required /lib/security/pam_securetty.so 310 auth required /lib/security/pam_nologin.so 311 auth sufficient /lib/security/pam_winbind.so 312 auth required /lib/security/pam_unix.so \ 390 auth required /lib/security/pam_securetty\.so 391 auth required /lib/security/pam_nologin\.so 392 auth sufficient /lib/security/pam_winbind\.so 393 auth required /lib/security/pam_unix\.so \e 313 394 use_first_pass shadow nullok 314 315 395 .fi 316 396 .RE 397 .sp 317 398 .sp 318 399 .it 1 an-trap … … 320 401 .nr an-break-flag 1 321 402 .br 322 \fBNote\fR 323 .PP 324 The PAM module pam_unix has recently replaced the module pam_pwdb . Some Linux systems use the module pam_unix2 in place of pam_unix.403 Note 404 .PP 405 The PAM module pam_unix has recently replaced the module pam_pwdb\. Some Linux systems use the module pam_unix2 in place of pam_unix\. 325 406 .PP 326 407 Note in particular the use of the … … 328 409 keyword and the 329 410 \fIuse_first_pass\fR 330 keyword .411 keyword\. 331 412 .PP 332 413 Now replace the account lines with this: 333 414 .PP 334 account required /lib/security/pam_winbind .so335 .PP 336 The next step is to join the domain . To do that use the415 account required /lib/security/pam_winbind\.so 416 .PP 417 The next step is to join the domain\. To do that use the 337 418 net 338 419 program like this: 339 420 .PP 340 net join -S PDC-U Administrator421 net join \-S PDC \-U Administrator 341 422 .PP 342 423 The username after the 343 \fI -U\fR344 can be any Domain user that has administrator privileges on the machine . Substitute the name or IP of your PDC for "PDC".424 \fI\-U\fR 425 can be any Domain user that has administrator privileges on the machine\. Substitute the name or IP of your PDC for "PDC"\. 345 426 .PP 346 427 Next copy 347 \fIlibnss_winbind .so\fR428 \fIlibnss_winbind\.so\fR 348 429 to 349 430 \fI/lib\fR 350 431 and 351 \fIpam_winbind .so \fR432 \fIpam_winbind\.so \fR 352 433 to 353 \fI/lib/security\fR . A symbolic link needs to be made from354 \fI/lib/libnss_winbind .so\fR434 \fI/lib/security\fR\. A symbolic link needs to be made from 435 \fI/lib/libnss_winbind\.so\fR 355 436 to 356 \fI/lib/libnss_winbind .so.2\fR. If you are using an older version of glibc then the target of the link should be357 \fI/lib/libnss_winbind .so.1\fR.437 \fI/lib/libnss_winbind\.so\.2\fR\. If you are using an older version of glibc then the target of the link should be 438 \fI/lib/libnss_winbind\.so\.1\fR\. 358 439 .PP 359 440 Finally, setup a 360 441 \fBsmb.conf\fR(5) 361 442 containing directives like the following: 362 363 .sp 364 443 .sp 444 .RS 4 365 445 .nf 366 367 446 [global] 368 447 winbind separator = + … … 370 449 template shell = /bin/bash 371 450 template homedir = /home/%D/%U 372 idmap uid = 10000 -20000373 idmap gid = 10000 -20000451 idmap uid = 10000\-20000 452 idmap gid = 10000\-20000 374 453 workgroup = DOMAIN 375 454 security = domain 376 455 password server = * 377 378 456 .fi 379 380 .PP 381 Now start winbindd and you should find that your user and group database is expanded to include your NT users and groups, and that you can login to your unix box as a domain user, using the DOMAIN+user syntax for the username . You may wish to use the commands457 .RE 458 .PP 459 Now start winbindd and you should find that your user and group database is expanded to include your NT users and groups, and that you can login to your unix box as a domain user, using the DOMAIN+user syntax for the username\. You may wish to use the commands 382 460 getent passwd 383 461 and 384 462 getent group 385 to confirm the correct operation of winbindd .463 to confirm the correct operation of winbindd\. 386 464 .SH "NOTES" 387 465 .PP … … 392 470 must be running on the local machine for 393 471 winbindd 394 to work .395 .PP 396 PAM is really easy to misconfigure . Make sure you know what you are doing when modifying PAM configuration files. It is possible to set up PAM such that you can no longer log into your system.472 to work\. 473 .PP 474 PAM is really easy to misconfigure\. Make sure you know what you are doing when modifying PAM configuration files\. It is possible to set up PAM such that you can no longer log into your system\. 397 475 .PP 398 476 If more than one UNIX machine is running 399 winbindd, then in general the user and groups ids allocated by winbindd will not be the same . The user and group ids will only be valid for the local machine, unless a shared400 401 is configured .402 .PP 403 If the the Windows NT SID to UNIX user and group id mapping file is damaged or destroyed then the mappings will be lost .477 winbindd, then in general the user and groups ids allocated by winbindd will not be the same\. The user and group ids will only be valid for the local machine, unless a shared 478 \fIidmap backend\fR 479 is configured\. 480 .PP 481 If the the Windows NT SID to UNIX user and group id mapping file is damaged or destroyed then the mappings will be lost\. 404 482 .SH "SIGNALS" 405 483 .PP 406 484 The following signals can be used to manipulate the 407 485 winbindd 408 daemon .486 daemon\. 409 487 .PP 410 488 SIGHUP 411 .RS 3n489 .RS 4 412 490 Reload the 413 491 \fBsmb.conf\fR(5) 414 file and apply any parameter changes to the running version of winbindd . This signal also clears any cached user and group information. The list of other domains trusted by winbindd is also reloaded.492 file and apply any parameter changes to the running version of winbindd\. This signal also clears any cached user and group information\. The list of other domains trusted by winbindd is also reloaded\. 415 493 .RE 416 494 .PP 417 495 SIGUSR2 418 .RS 3n496 .RS 4 419 497 The SIGUSR2 signal will cause 420 498 winbindd 421 to write status information to the winbind log file .422 .sp 423 Log files are stored in the filename specified by the log file parameter .499 to write status information to the winbind log file\. 500 .sp 501 Log files are stored in the filename specified by the log file parameter\. 424 502 .RE 425 503 .SH "FILES" 426 504 .PP 427 \fI/etc/nsswitch .conf(5)\fR428 .RS 3n429 Name service switch configuration file .430 .RE 431 .PP 432 /tmp/ .winbindd/pipe433 .RS 3n505 \fI/etc/nsswitch\.conf(5)\fR 506 .RS 4 507 Name service switch configuration file\. 508 .RE 509 .PP 510 /tmp/\.winbindd/pipe 511 .RS 4 434 512 The UNIX pipe over which clients communicate with the 435 513 winbindd 436 program . For security reasons, the winbind client will only attempt to connect to the winbindd daemon if both the437 \fI/tmp/ .winbindd\fR514 program\. For security reasons, the winbind client will only attempt to connect to the winbindd daemon if both the 515 \fI/tmp/\.winbindd\fR 438 516 directory and 439 \fI/tmp/ .winbindd/pipe\fR440 file are owned by root .517 \fI/tmp/\.winbindd/pipe\fR 518 file are owned by root\. 441 519 .RE 442 520 .PP 443 521 $LOCKDIR/winbindd_privileged/pipe 444 .RS 3n445 The UNIX pipe over which 'privileged' clients communicate with the446 winbindd 447 program . For security reasons, access to some winbindd functions- like those needed by the522 .RS 4 523 The UNIX pipe over which \'privileged\' clients communicate with the 524 winbindd 525 program\. For security reasons, access to some winbindd functions \- like those needed by the 448 526 ntlm_auth 449 utility - is restricted. By default, only users in the 'root' group will get this access, however the administrator may change the group permissions on $LOCKDIR/winbindd_privileged to allow programs like 'squid' to use ntlm_auth. Note that the winbind client will only attempt to connect to the winbindd daemon if both the527 utility \- is restricted\. By default, only users in the \'root\' group will get this access, however the administrator may change the group permissions on $LOCKDIR/winbindd_privileged to allow programs like \'squid\' to use ntlm_auth\. Note that the winbind client will only attempt to connect to the winbindd daemon if both the 450 528 \fI$LOCKDIR/winbindd_privileged\fR 451 529 directory and 452 530 \fI$LOCKDIR/winbindd_privileged/pipe\fR 453 file are owned by root .454 .RE 455 .PP 456 /lib/libnss_winbind .so.X457 .RS 3n458 Implementation of name service switch library .459 .RE 460 .PP 461 $LOCKDIR/winbindd_idmap .tdb462 .RS 3n463 Storage for the Windows NT rid to UNIX user/group id mapping . The lock directory is specified when Samba is initially compiled using the464 \fI --with-lockdir\fR465 option . This directory is by default466 \fI/usr/local/samba/var/locks \fR .467 .RE 468 .PP 469 $LOCKDIR/winbindd_cache .tdb470 .RS 3n471 Storage for cached user and group information .531 file are owned by root\. 532 .RE 533 .PP 534 /lib/libnss_winbind\.so\.X 535 .RS 4 536 Implementation of name service switch library\. 537 .RE 538 .PP 539 $LOCKDIR/winbindd_idmap\.tdb 540 .RS 4 541 Storage for the Windows NT rid to UNIX user/group id mapping\. The lock directory is specified when Samba is initially compiled using the 542 \fI\-\-with\-lockdir\fR 543 option\. This directory is by default 544 \fI/usr/local/samba/var/locks \fR\. 545 .RE 546 .PP 547 $LOCKDIR/winbindd_cache\.tdb 548 .RS 4 549 Storage for cached user and group information\. 472 550 .RE 473 551 .SH "VERSION" 474 552 .PP 475 This man page is correct for version 3 .0 of the Samba suite.553 This man page is correct for version 3\.0 of the Samba suite\. 476 554 .SH "SEE ALSO" 477 555 .PP 478 \fInsswitch .conf(5)\fR,556 \fInsswitch\.conf(5)\fR, 479 557 \fBsamba\fR(7), 480 558 \fBwbinfo\fR(1), … … 484 562 .SH "AUTHOR" 485 563 .PP 486 The original Samba software and related utilities were created by Andrew Tridgell . Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.564 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 487 565 .PP 488 566 wbinfo 489 567 and 490 568 winbindd 491 were written by Tim Potter. 492 .PP 493 The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 494 569 were written by Tim Potter\. 570 .PP 571 The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\.
Note:
See TracChangeset
for help on using the changeset viewer.