merge sendfile entry from SAMBA_2_2 and fix typo

(This used to be commit 068d7ab14c0f6f83b61e6fe1724ef00ca2e0e590)

1 files changed, 110 insertions, 79 deletions

diff --git a/docs/manpages/smb.conf.5 b/docs/manpages/smb.conf.5
index 0fcf0179b8..dc2adaba47 100644
--- a/docs/manpages/smb.conf.5
+++ b/docs/manpages/smb.conf.5
@@ -3,7 +3,7 @@
 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 .\" Please send any bug reports, improvements, comments, patches, 
 .\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "SMB.CONF" "5" "03 oktober 2002" "" ""
+.TH "SMB.CONF" "5" "03 October 2002" "" ""
 .SH NAME
 smb.conf \- The configuration file for the Samba suite
 .SH "SYNOPSIS"
@@ -95,7 +95,7 @@ The share is accessed via the share name "foo":
 .nf
 	 	[foo]
  		path = /home/bar
- 		writeable = true
+ 		read only = no
 	
 	
 .fi
@@ -110,9 +110,9 @@ elsewhere):
 .nf
 	 	[aprinter]
  		path = /usr/spool/public
- 		writeable = false
- 		printable = true
- 		guest ok = true
+ 		read only = yes
+ 		printable = yes
+ 		guest ok = yes
 	
 	
 .fi
@@ -173,7 +173,7 @@ section:
 
 .nf
 			 	[homes]
- 			writeable = yes
+ 			read only = no
 		
 		
 .fi
@@ -991,6 +991,12 @@ each parameter for details.  Note that some are synonyms.
 \fIuse mmap\fR
 .TP 0.2i
 \(bu
+\fIuse rhosts\fR
+.TP 0.2i
+\(bu
+\fIuse sendfile\fR
+.TP 0.2i
+\(bu
 \fIusername level\fR
 .TP 0.2i
 \(bu
@@ -1804,7 +1810,7 @@ cannot be immediately satisfied, Samba 2.2 will internally
 queue the lock request, and periodically attempt to obtain 
 the lock until the timeout period expires.
 
-If this parameter is set to false, then 
+If this parameter is set to no, then 
 Samba 2.2 will behave as previous versions of Samba would and 
 will fail the lock request immediately if the lock range 
 cannot be obtained.
@@ -1836,7 +1842,7 @@ See the \fI  browseable\fR.
 \fBbrowse list (G)\fR
 This controls whether   \fBsmbd(8)\fR will serve a browse list to 
 a client doing a \fBNetServerEnum\fR call. Normally 
-set to true. You should never need to change 
+set to yes. You should never need to change 
 this.
 
 Default: \fBbrowse list = yes\fR
@@ -2263,11 +2269,11 @@ Example: \fBdelete user from group script = /usr/sbin/deluser %u %g\fR
 This option is used when Samba is attempting to 
 delete a directory that contains one or more vetoed directories 
 (see the \fIveto files\fR
-option).  If this option is set to false (the default) then if a vetoed 
+option).  If this option is set to no (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.
 
-If this option is set to true, then Samba 
+If this option is set to yes, 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 
@@ -2476,7 +2482,7 @@ See also the parameter \fI  wins support\fR.
 Default: \fBdns proxy = yes\fR
 .TP
 \fBdomain logons (G)\fR
-If set to true, the Samba server will serve 
+If set to yes, the Samba server will serve 
 Windows 95/98 Domain logons for the   \fIworkgroup\fR it is in. Samba 2.2 also 
 has limited capability to act as a domain controller for Windows 
 NT 4 Domains.  For more details on setting up this feature see 
@@ -2583,7 +2589,7 @@ 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 \fBsmbd\fR is acting 
-on behalf of is not the file owner. Setting this option to   true allows DOS semantics and smbd will change the file 
+on behalf of is not the file owner. Setting this option to   yes allows DOS semantics and smbd will change the file 
 timestamp as DOS requires.
 
 Default: \fBdos filetimes = no\fR
@@ -2904,7 +2910,7 @@ 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 \fIwide links\fR
-parameter is set to false.
+parameter is set to no.
 
 Default: \fBgetwd cache = yes\fR
 .TP
@@ -3021,7 +3027,7 @@ Default: \fBhide special files = no\fR
 .TP
 \fBhomedir map (G)\fR
 If\fInis homedir
-\fR is true, and \fBsmbd(8)\fR is also acting 
+\fR is yes, and \fBsmbd(8)\fR is also acting 
 as a Win95/98 \fIlogon server\fR 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 
@@ -3462,7 +3468,7 @@ Currently, if \fIkernel
 oplocks\fR are supported then level2 oplocks are 
 not granted (even if this parameter is set to yes). 
 Note also, the \fIoplocks\fR
-parameter must be set to true on this share in order for 
+parameter must be set to yes on this share in order for 
 this parameter to have any effect.
 
 See also the \fIoplocks\fR
@@ -3475,10 +3481,10 @@ Default: \fBlevel2 oplocks = yes\fR
 This parameter determines if   \fBnmbd(8)\fR 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, true, false, or
+values, yes, no, or
 auto. The default is auto.  
-If set to false Samba will never produce these 
-broadcasts. If set to true Samba will produce 
+If set to no Samba will never produce these 
+broadcasts. If set to yes Samba will produce 
 Lanman announce broadcasts at a frequency set by the parameter 
 \fIlm interval\fR. If set to auto 
 Samba will not send Lanman announce broadcasts by default but will 
@@ -3518,13 +3524,13 @@ Default: \fBload printers = yes\fR
 .TP
 \fBlocal master (G)\fR
 This option allows \fB  nmbd(8)\fR to try and become a local master browser 
-on a subnet. If set to false then \fB  nmbd\fR will not attempt to become a local master browser 
+on a subnet. If set to no then \fB  nmbd\fR 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 true. Setting this value to true doesn't
+default this value is set to yes. Setting this value to yes doesn't
 mean that Samba will \fBbecome\fR the local master 
 browser on a subnet, just that \fBnmbd\fR will \fB  participate\fR in elections for local master browser.
 
-Setting this value to false will cause \fBnmbd\fR
+Setting this value to no will cause \fBnmbd\fR
 \fBnever\fR to become a local master browser.
 
 Default: \fBlocal master = yes\fR
@@ -4931,7 +4937,7 @@ is a full stop ".",  then no string is sent. Similarly,
 if the expect string is a full stop then no string is expected.
 
 If the \fIpam
-password change\fR parameter is set to true, the chat pairs
+password change\fR parameter is set to yes, 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.
 
@@ -4979,7 +4985,7 @@ of mixed case chars and digits. This can pose a problem as some clients
 it.
 
 \fBNote\fR that if the \fIunix 
-password sync\fR parameter is set to true
+password sync\fR parameter is set to yes
 then this program is called \fBAS ROOT\fR 
 before the SMB password in the smbpasswd(5)
  file is changed. If this UNIX password change fails, then 
@@ -4990,7 +4996,7 @@ If the \fIunix password sync\fR parameter
 is set this parameter \fBMUST USE ABSOLUTE PATHS\fR 
 for \fBALL\fR programs called, and must be examined 
 for security implications. Note that by default \fIunix 
-password sync\fR is set to false.
+password sync\fR is set to no.
 
 See also \fIunix 
 password sync\fR.
@@ -5229,7 +5235,7 @@ Default: \fBpreexec close = no\fR
 This boolean parameter controls if nmbd(8) is a preferred master browser 
 for its workgroup.
 
-If this is set to true, on startup, \fBnmbd\fR 
+If this is set to yes, on startup, \fBnmbd\fR 
 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 \fB\fI  domain master\fB = yes\fR, so that \fB  nmbd\fR can guarantee becoming a domain master.
@@ -5368,7 +5374,7 @@ specified for the service.
 
 Note that a printable service will ALWAYS allow writing 
 to the service path (user privileges permitting) via the spooling 
-of print data. The \fIwriteable
+of print data. The \fIread only
 \fR parameter controls only non-printing access to 
 the resource.
 
@@ -5628,7 +5634,7 @@ Default: \fBread bmpx = no\fR
 \fBread list (S)\fR
 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 \fIwriteable\fR
+they will not be given write access, no matter what the \fIread only\fR
 option is set to. The list can include group names using the 
 syntax described in the \fI  invalid users\fR parameter.
 
@@ -5640,7 +5646,17 @@ Default: \fBread list = <empty string>\fR
 Example: \fBread list = mary, @students\fR
 .TP
 \fBread only (S)\fR
-Note that this is an inverted synonym for \fIwriteable\fR.
+An inverted synonym is   \fIwriteable\fR.
+
+If this parameter is yes, then users 
+of a service may not create or modify files in the service's 
+directory.
+
+Note that a printable service (\fBprintable = yes\fR)
+will \fBALWAYS\fR allow writing to the directory 
+(user privileges permitting), but only via spooling operations.
+
+Default: \fBread only = yes\fR
 .TP
 \fBread raw (G)\fR
 This parameter controls whether or not the server 
@@ -5754,10 +5770,10 @@ Default: \fBremote browse sync = <empty string>
 \fR
 .TP
 \fBrestrict anonymous (G)\fR
-This is a boolean parameter.  If it is true, then 
+This is a boolean parameter.  If it is yes, then 
 anonymous access to the server will be restricted, namely in the 
 case where the server is expecting the client to send a username, 
-but it doesn't.  Setting it to true will force these anonymous 
+but it doesn't.  Setting it to yes will force these anonymous 
 connections to be denied, and the client will be required to always 
 supply a username and password when connecting. Use of this parameter 
 is only recommended for homogeneous NT client environments.
@@ -5767,7 +5783,7 @@ on the username (%U, %G, etc) consistent.  NT 4.0
 likes to use anonymous connections when refreshing the share list, 
 and this is a way to work around that.
 
-When restrict anonymous is true, all anonymous connections 
+When restrict anonymous is yes, all anonymous connections 
 are denied no matter what they are for.  This can effect the ability 
 of a machine to access the Samba Primary Domain Controller to revalidate 
 its machine account after someone else has logged on the client 
@@ -6015,7 +6031,7 @@ parameter.
 
 This mode will only work correctly if smbpasswd(8) has been used to add this 
 machine into a Windows NT Domain. It expects the \fIencrypted passwords\fR
-parameter to be set to true. In this 
+parameter to be set to yes. 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.
@@ -6447,10 +6463,10 @@ Default: \fBstrip dot = no\fR
 \fBsync always (S)\fR
 This is a boolean parameter that controls 
 whether writes will always be written to stable storage before 
-the write call returns. If this is false then the server will be 
+the write call returns. If this is no 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 true then every write will be followed by a \fBfsync()
+If this is yes then every write will be followed by a \fBfsync()
 \fR call to ensure the data is written to disk. Note that 
 the \fIstrict sync\fR parameter must be set to
 yes in order for this parameter to have 
@@ -6562,7 +6578,7 @@ Default: \fBunix extensions = no\fR
 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 true the program specified in the \fIpasswd
+If this is set to yes the program specified in the \fIpasswd
 program\fRparameter is called \fBAS ROOT\fR - 
 to allow the new UNIX password to be set without access to the 
 old UNIX password (as the SMB password change code has no 
@@ -6635,13 +6651,27 @@ Default: \fBuse client driver = no\fR
 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 false by
+coherent cache, and so this parameter is set to no 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.
 
 Default: \fBuse mmap = yes\fR
 .TP
+\fBuse rhosts (G)\fR
+If this global parameter is yes, it specifies 
+that the UNIX user's \fI.rhosts\fR file in their home directory 
+will be read to find the names of hosts and users who will be allowed 
+access without specifying a password.
+
+\fBNOTE:\fR The use of \fIuse rhosts
+\fR can be a major security hole. This is because you are 
+trusting the PC to supply the correct username. It is very easy to 
+get a PC to supply a false username. I recommend that the \fI  use rhosts\fR option be only used if you really know what 
+you are doing.
+
+Default: \fBuse rhosts = no\fR
+.TP
 \fBuser (S)\fR
 Synonym for \fI  username\fR.
 .TP
@@ -6752,26 +6782,26 @@ on the left. Processing then continues with the next line.
 If any line begins with a '#' or a ';' then it is 
 ignored
 
-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 
+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.
 
-For example to map from the name admin 
+For example to map from the name admin
 or administrator to the UNIX name   root you would use:
 
 \fBroot = admin administrator\fR
 
-Or to map anyone in the UNIX group system 
+Or to map anyone in the UNIX group system
 to the UNIX name sys you would use:
 
 \fBsys = @system\fR
 
-You can have as many mappings as you like in a username 
+You can have as many mappings as you like in a username
 map file.
 
-If your system supports the NIS NETGROUP option then 
+If your system supports the NIS NETGROUP option then
 the netgroup database is checked before the \fI/etc/group
 \fR database for matching groups.
 
@@ -6780,12 +6810,12 @@ by using double quotes around the name. For example:
 
 \fBtridge = "Andrew Tridgell"\fR
 
-would map the windows username "Andrew Tridgell" to the 
+would map the windows username "Andrew Tridgell" to the
 unix username "tridge".
 
-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 
+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.
 
 
@@ -6795,18 +6825,18 @@ that line.
 		
 .fi
 
-Note that the remapping is applied to all occurrences 
-of usernames. Thus if you connect to \\\\server\\fred and   fred is remapped to mary then you 
-will actually be connecting to \\\\server\\mary and will need to 
-supply a password suitable for mary not 
-fred. The only exception to this is the 
-username passed to the \fI  password server\fR (if you have one). The password 
-server will receive whatever username the client supplies without 
+Note that the remapping is applied to all occurrences
+of usernames. Thus if you connect to \\\\server\\fred and   fred is remapped to mary then you
+will actually be connecting to \\\\server\\mary and will need to
+supply a password suitable for mary not
+fred. The only exception to this is the
+username passed to the \fI  password server\fR (if you have one). The password
+server will receive whatever username the client supplies without
 modification.
 
-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 
+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.
 
 Default: \fBno username map\fR
@@ -6814,9 +6844,20 @@ Default: \fBno username map\fR
 Example: \fBusername map = /usr/local/samba/lib/users.map
 \fR
 .TP
+\fBuse sendfile (S)\fR
+If this parameter is yes, and Samba
+was built with the --with-sendfile-support option, and the underlying operating
+system supports sendfile system call, 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. This is off by default as it's effects are unknown
+as yet.
+
+Default: \fBuse sendfile = no\fR
+.TP
 \fButmp (G)\fR
-This boolean parameter is only available if 
-Samba has been configured and compiled  with the option \fB  --with-utmp\fR. If set to true then Samba will attempt
+This boolean parameter is only available if
+Samba has been configured and compiled  with the option \fB  --with-utmp\fR. If set to yes 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.
@@ -7010,7 +7051,7 @@ necessary to suppress the enumeration of users through the
 \fBgetpwent()\fR and
 \fBendpwent()\fR group of system calls.  If
 the \fIwinbind enum users\fR parameter is
-false, calls to the \fBgetpwent\fR system call
+no, calls to the \fBgetpwent\fR system call
 will not return any data. 
 
 \fBWarning:\fR Turning off user
@@ -7029,7 +7070,7 @@ necessary to suppress the enumeration of groups through the
 \fBgetgrent()\fR and
 \fBendgrent()\fR group of system calls.  If
 the \fIwinbind enum groups\fR parameter is
-false, calls to the \fBgetgrent()\fR system
+no, calls to the \fBgetgrent()\fR system
 call will not return any data. 
 
 \fBWarning:\fR Turning off group
@@ -7083,10 +7124,10 @@ 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.
 
-Default: \fBwinbind use default domain = <falseg> 
+Default: \fBwinbind use default domain = <no> 
 \fR
 
-Example: \fBwinbind use default domain = true\fR
+Example: \fBwinbind use default domain = yes\fR
 .TP
 \fBwins hook (G)\fR
 When Samba is running as a WINS server this 
@@ -7163,9 +7204,9 @@ Example: \fBwins server = 192.9.200.1\fR
 \fBwins support (G)\fR
 This boolean controls if the    
 nmbd(8) process in Samba will act as a WINS server. You should 
-not set this to true unless you have a multi-subnetted network and 
+not set this to yes unless you have a multi-subnetted network and 
 you wish a particular \fBnmbd\fR to be your WINS server. 
-Note that you should \fBNEVER\fR set this to true
+Note that you should \fBNEVER\fR set this to yes
 on more than one machine in your network.
 
 Default: \fBwins support = no\fR
@@ -7212,7 +7253,7 @@ for a 256k cache size per file.
 \fBwrite list (S)\fR
 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 \fIwriteable\fR
+they will be given write access, no matter what the \fIread only\fR
 option is set to. The list can include group names using the 
 @group syntax.
 
@@ -7240,7 +7281,7 @@ Default: \fBwins partners = \fR
 Example: \fBwins partners = 192.168.0.1 172.16.1.2\fR
 .TP
 \fBwrite ok (S)\fR
-Synonym for \fI  writeable\fR.
+Inverted synonym for \fI  read only\fR.
 .TP
 \fBwrite raw (G)\fR
 This parameter controls whether or not the server 
@@ -7250,17 +7291,7 @@ You should never need to change this parameter.
 Default: \fBwrite raw = yes\fR
 .TP
 \fBwriteable (S)\fR
-An inverted synonym is   \fIread only\fR.
-
-If this parameter is no, then users 
-of a service may not create or modify files in the service's 
-directory.
-
-Note that a printable service (\fBprintable = yes\fR)
-will \fBALWAYS\fR allow writing to the directory 
-(user privileges permitting), but only via spooling operations.
-
-Default: \fBwriteable = no\fR
+Inverted synonym for \fI  read only\fR.
 .SH "WARNINGS"
 .PP
 Although the configuration file permits service names