From d90a4ea71a17f22b9d65462189d6e074b4fa9e6e Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Fri, 11 Apr 2003 15:01:39 +0000 Subject: Finish conversion of Locking options (This used to be commit 9613c217786147c9deda9770887dc069659b1deb) --- docs/docbook/smbdotconf/locking/blockinglocks.xml | 39 ++++++------- docs/docbook/smbdotconf/locking/cscpolicy.xml | 32 ++++++----- docs/docbook/smbdotconf/locking/fakeoplocks.xml | 50 ++++++++-------- docs/docbook/smbdotconf/locking/kerneloplocks.xml | 43 +++++++------- docs/docbook/smbdotconf/locking/level2oplocks.xml | 66 +++++++++++----------- docs/docbook/smbdotconf/locking/locking.xml | 42 +++++++------- docs/docbook/smbdotconf/locking/lockspincount.xml | 30 +++++----- docs/docbook/smbdotconf/locking/lockspintime.xml | 21 +++---- .../smbdotconf/locking/oplockbreakwaittime.xml | 30 +++++----- .../smbdotconf/locking/oplockcontentionlimit.xml | 35 ++++++------ docs/docbook/smbdotconf/locking/oplocks.xml | 50 ++++++++-------- docs/docbook/smbdotconf/locking/posixlocking.xml | 28 ++++----- docs/docbook/smbdotconf/locking/sharemodes.xml | 44 ++++++++------- docs/docbook/smbdotconf/locking/strictlocking.xml | 30 +++++----- 14 files changed, 285 insertions(+), 255 deletions(-) (limited to 'docs/docbook') diff --git a/docs/docbook/smbdotconf/locking/blockinglocks.xml b/docs/docbook/smbdotconf/locking/blockinglocks.xml index ea5e90b5cd..f11d92f4f5 100644 --- a/docs/docbook/smbdotconf/locking/blockinglocks.xml +++ b/docs/docbook/smbdotconf/locking/blockinglocks.xml @@ -1,22 +1,23 @@ - - blocking locks (S) - This parameter controls the behavior - of smbd - 8 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. + + + This parameter controls the behavior + of smbd + 8 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. - 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. + 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. - If this parameter is set to no, then - samba will behave as previous versions of Samba would and - will fail the lock request immediately if the lock range - cannot be obtained. + If this parameter is set to no, then + samba will behave as previous versions of Samba would and + will fail the lock request immediately if the lock range + cannot be obtained. - Default: blocking locks = yes - - - + Default: blocking locks = yes + + diff --git a/docs/docbook/smbdotconf/locking/cscpolicy.xml b/docs/docbook/smbdotconf/locking/cscpolicy.xml index e5139bc4f3..7567ed9286 100644 --- a/docs/docbook/smbdotconf/locking/cscpolicy.xml +++ b/docs/docbook/smbdotconf/locking/cscpolicy.xml @@ -1,18 +1,20 @@ - - csc policy (S) - This stands for client-side caching - policy, and specifies how clients capable of offline - caching will cache the files in the share. The valid values - are: manual, documents, programs, disable. + + + This stands for client-side caching + policy, and specifies how clients capable of offline + caching will cache the files in the share. The valid values + are: manual, documents, programs, disable. - These values correspond to those used on Windows - servers. + These values correspond to those used on Windows servers. - For example, shares containing roaming profiles can have - offline caching disabled using csc policy = disable - . + For example, shares containing roaming profiles can have + offline caching disabled using csc policy = disable. - Default: csc policy = manual - Example: csc policy = programs - - + Default: csc policy = manual + + Example: csc policy = programs + + diff --git a/docs/docbook/smbdotconf/locking/fakeoplocks.xml b/docs/docbook/smbdotconf/locking/fakeoplocks.xml index 16887726c0..b7deac68ba 100644 --- a/docs/docbook/smbdotconf/locking/fakeoplocks.xml +++ b/docs/docbook/smbdotconf/locking/fakeoplocks.xml @@ -1,27 +1,31 @@ - - fake oplocks (S) - 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. - + + + 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. + - When you set fake oplocks = yes, smbd(8) will - always grant oplock requests no matter how many clients are using - the file. + When you set fake oplocks = yes, + smbd8 will + always grant oplock requests no matter how many clients are using the file. - It is generally much better to use the real oplocks support rather - than this parameter. + It is generally much better to use the real + oplocks support rather + than this parameter. - 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! + 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! - Default: fake oplocks = no - + Default: fake oplocks = no + + diff --git a/docs/docbook/smbdotconf/locking/kerneloplocks.xml b/docs/docbook/smbdotconf/locking/kerneloplocks.xml index 98513fdd1e..f155fddc8f 100644 --- a/docs/docbook/smbdotconf/locking/kerneloplocks.xml +++ b/docs/docbook/smbdotconf/locking/kerneloplocks.xml @@ -1,24 +1,27 @@ - - kernel oplocks (G) - For UNIXes that support kernel based oplocks - (currently only IRIX and the Linux 2.4 kernel), this parameter - allows the use of them to be turned on or off. + + + For UNIXes that support kernel based + oplocks + (currently only IRIX and the Linux 2.4 kernel), this parameter + allows the use of them to be turned on or off. - Kernel oplocks support allows Samba oplocks - to be broken whenever a local UNIX process or NFS operation - accesses a file that smbd - 8 has oplocked. This allows complete - data consistency between SMB/CIFS, NFS and local file access (and is - a very cool feature :-). + Kernel oplocks support allows Samba oplocks + to be broken whenever a local UNIX process or NFS operation + accesses a file that smbd + 8 has oplocked. This allows complete + data consistency between SMB/CIFS, NFS and local file access (and is + a very cool feature :-). - This parameter defaults to on, 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. + This parameter defaults to on, 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. - See also the oplocks - and level2 oplocks - parameters. + See also the oplocks + and level2 oplocks + parameters. - Default: kernel oplocks = yes - - + Default: kernel oplocks = yes + + diff --git a/docs/docbook/smbdotconf/locking/level2oplocks.xml b/docs/docbook/smbdotconf/locking/level2oplocks.xml index adae6d268f..c2c090b1a8 100644 --- a/docs/docbook/smbdotconf/locking/level2oplocks.xml +++ b/docs/docbook/smbdotconf/locking/level2oplocks.xml @@ -1,39 +1,41 @@ - - level2 oplocks (S) - This parameter controls whether Samba supports - level2 (read-only) oplocks on a share. + + + This parameter controls whether Samba supports + level2 (read-only) oplocks on a share. - 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). + 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). - 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. + 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. - It is recommended that this parameter be turned on - to speed access to shared executables. + It is recommended that this parameter be turned on to + speed access to shared executables. - For more discussions on level2 oplocks see the CIFS spec. + For more discussions on level2 oplocks see the CIFS spec. - Currently, if kernel - oplocks are supported then level2 oplocks are - not granted (even if this parameter is set to yes). - Note also, the oplocks - parameter must be set to yes on this share in order for - this parameter to have any effect. + Currently, if kernel + oplocks are supported then level2 oplocks are + not granted (even if this parameter is set to yes). + Note also, the oplocks + parameter must be set to yes on this share in order for + this parameter to have any effect. - See also the oplocks - and kernel oplocks - parameters. + See also the oplocks + and kernel oplocks + parameters. - Default: level2 oplocks = yes - - + Default: level2 oplocks = yes + + diff --git a/docs/docbook/smbdotconf/locking/locking.xml b/docs/docbook/smbdotconf/locking/locking.xml index aa27027a11..8526224316 100644 --- a/docs/docbook/smbdotconf/locking/locking.xml +++ b/docs/docbook/smbdotconf/locking/locking.xml @@ -1,25 +1,27 @@ - - locking (S) - This controls whether or not locking will be - performed by the server in response to lock requests from the - client. + + + This controls whether or not locking will be + performed by the server in response to lock requests from the + client. - If 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. + If 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. - If locking = yes, real locking will be performed - by the server. + If locking = yes, real locking will be performed + by the server. - This option may be useful for read-only - filesystems which may not need locking (such as - CDROM drives), although setting this parameter of no - is not really recommended even in this case. + This option may be useful for read-only + filesystems which may not need locking (such as + CDROM drives), although setting this parameter of no + is not really recommended even in this case. - 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. + 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. - Default: locking = yes - - + Default: locking = yes + + diff --git a/docs/docbook/smbdotconf/locking/lockspincount.xml b/docs/docbook/smbdotconf/locking/lockspincount.xml index 1ee1aab4d4..d308f5d845 100644 --- a/docs/docbook/smbdotconf/locking/lockspincount.xml +++ b/docs/docbook/smbdotconf/locking/lockspincount.xml @@ -1,15 +1,17 @@ - - lock spin count (G) - This parameter controls the number of times - that smbd should attempt to gain a byte range lock on the - behalf of a client request. Experiments have shown that - Windows 2k servers do not reply with a failure if the lock - could not be immediately granted, but try a few more times - in case the lock could later be aquired. This behavior - is used to support PC database formats such as MS Access - and FoxPro. - + + + This parameter controls the number of times + that smbd should attempt to gain a byte range lock on the + behalf of a client request. Experiments have shown that + Windows 2k servers do not reply with a failure if the lock + could not be immediately granted, but try a few more times + in case the lock could later be aquired. This behavior + is used to support PC database formats such as MS Access + and FoxPro. + - Default: lock spin count = 2 - - + Default: lock spin count = 2 + + diff --git a/docs/docbook/smbdotconf/locking/lockspintime.xml b/docs/docbook/smbdotconf/locking/lockspintime.xml index 4d3ea1bdc4..460b2827b4 100644 --- a/docs/docbook/smbdotconf/locking/lockspintime.xml +++ b/docs/docbook/smbdotconf/locking/lockspintime.xml @@ -1,11 +1,12 @@ - - lock spin time (G) - The time in microseconds that smbd should - pause before attempting to gain a failed lock. See - lock spin - count for more details. - + + + The time in microseconds that smbd should + pause before attempting to gain a failed lock. See + lock spin + count for more details. - Default: lock spin time = 10 - - + Default: lock spin time = 10 + + diff --git a/docs/docbook/smbdotconf/locking/oplockbreakwaittime.xml b/docs/docbook/smbdotconf/locking/oplockbreakwaittime.xml index 5e08200a33..0dc130eab3 100644 --- a/docs/docbook/smbdotconf/locking/oplockbreakwaittime.xml +++ b/docs/docbook/smbdotconf/locking/oplockbreakwaittime.xml @@ -1,16 +1,18 @@ - - oplock break wait time (G) - 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. + + + 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. - DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ - AND UNDERSTOOD THE SAMBA OPLOCK CODE. + DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND + UNDERSTOOD THE SAMBA OPLOCK CODE. - Default: oplock break wait time = 0 - - + Default: oplock break wait time = 0 + + diff --git a/docs/docbook/smbdotconf/locking/oplockcontentionlimit.xml b/docs/docbook/smbdotconf/locking/oplockcontentionlimit.xml index fd3b45d0b1..1b24e5cdec 100644 --- a/docs/docbook/smbdotconf/locking/oplockcontentionlimit.xml +++ b/docs/docbook/smbdotconf/locking/oplockcontentionlimit.xml @@ -1,19 +1,22 @@ - - oplock contention limit (S) - This is a very advanced - smbd(8) tuning option to - improve the efficiency of the granting of oplocks under multiple - client contention for the same file. + + + This is a very advanced + smbd + 8 tuning option to + improve the efficiency of the granting of oplocks under multiple + client contention for the same file. - In brief it specifies a number, which causes smbd - 8not 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 smbd to behave in a similar - way to Windows NT. + In brief it specifies a number, which causes smbd + 8not 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 smbd to behave in a similar + way to Windows NT. - DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ - AND UNDERSTOOD THE SAMBA OPLOCK CODE. + DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ + AND UNDERSTOOD THE SAMBA OPLOCK CODE. - Default: oplock contention limit = 2 - - + Default: oplock contention limit = 2 + + diff --git a/docs/docbook/smbdotconf/locking/oplocks.xml b/docs/docbook/smbdotconf/locking/oplocks.xml index 071786f35c..0ba53ba765 100644 --- a/docs/docbook/smbdotconf/locking/oplocks.xml +++ b/docs/docbook/smbdotconf/locking/oplocks.xml @@ -1,27 +1,29 @@ - - oplocks (S) - This boolean option tells smbd 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 - Speed.txt in the Samba docs/ - directory. + + + This boolean option tells smbd 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 + Speed.txt in the Samba docs/ + directory. - Oplocks may be selectively turned off on certain files with a - share. See the - 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 - kernel oplocks parameter for details. + Oplocks may be selectively turned off on certain files with a + share. See the + 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 + kernel oplocks parameter for details. - See also the kernel - oplocks and - level2 oplocks parameters. + See also the kernel + oplocks and + level2 oplocks parameters. - Default: oplocks = yes - - + Default: oplocks = yes + + diff --git a/docs/docbook/smbdotconf/locking/posixlocking.xml b/docs/docbook/smbdotconf/locking/posixlocking.xml index 4f2e2d215b..c81bdcff38 100644 --- a/docs/docbook/smbdotconf/locking/posixlocking.xml +++ b/docs/docbook/smbdotconf/locking/posixlocking.xml @@ -1,14 +1,16 @@ - - posix locking (S) - The smbd - 8 - 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. + + + The smbd + 8 + 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. - Default: posix locking = yes - - + Default: posix locking = yes + + diff --git a/docs/docbook/smbdotconf/locking/sharemodes.xml b/docs/docbook/smbdotconf/locking/sharemodes.xml index c789ed0fb2..529ec44106 100644 --- a/docs/docbook/smbdotconf/locking/sharemodes.xml +++ b/docs/docbook/smbdotconf/locking/sharemodes.xml @@ -1,26 +1,28 @@ - - share modes (S) - This enables or disables the honoring of - the share modes during a file open. These - modes are used by clients to gain exclusive read or write access - to a file. + + + This enables or disables the honoring of + the share modes during a file open. These + modes are used by clients to gain exclusive read or write access + to a file. - 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). + 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). - The share modes that are enabled by this option are - DENY_DOS, DENY_ALL, - DENY_READ, DENY_WRITE, - DENY_NONE and DENY_FCB. - + The share modes that are enabled by this option are + DENY_DOS, DENY_ALL, + DENY_READ, DENY_WRITE, + DENY_NONE and DENY_FCB. + - This option gives full share compatibility and enabled - by default. + This option gives full share compatibility and enabled + by default. - You should NEVER turn this parameter - off as many Windows applications will break if you do so. + You should NEVER turn this parameter + off as many Windows applications will break if you do so. - Default: share modes = yes - - + Default: share modes = yes + + diff --git a/docs/docbook/smbdotconf/locking/strictlocking.xml b/docs/docbook/smbdotconf/locking/strictlocking.xml index b67ae47736..34c1c7fe5e 100644 --- a/docs/docbook/smbdotconf/locking/strictlocking.xml +++ b/docs/docbook/smbdotconf/locking/strictlocking.xml @@ -1,17 +1,19 @@ - - strict locking (S) - This is a boolean that controls the handling of - file locking in the server. When this is set to yes - 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. + + + This is a boolean that controls the handling of + file locking in the server. When this is set to yes + 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. - When strict locking is no the server does file - lock checks only when the client explicitly asks for them. + When strict locking is no the server does file + lock checks only when the client explicitly asks for them. - Well-behaved clients always ask for lock checks when it - is important, so in the vast majority of cases strict - locking = no is preferable. + Well-behaved clients always ask for lock checks when it + is important, so in the vast majority of cases strict + locking = no is preferable. - Default: strict locking = no - - + Default: strict locking = no + + -- cgit