summaryrefslogtreecommitdiff
path: root/docs/smbdotconf/locking
diff options
context:
space:
mode:
authorJohn Terpstra <jht@samba.org>2005-08-25 16:49:40 +0000
committerGerald W. Carter <jerry@samba.org>2008-04-23 08:47:06 -0500
commit6c2e58987bcb3b5fe527f7f6743c549ed6c0c877 (patch)
tree700bab687907526be31f9dcadc1e826845562a7b /docs/smbdotconf/locking
parentcf596ff9a0e5e191cfdc5f219e57844ad35ba7a2 (diff)
downloadsamba-6c2e58987bcb3b5fe527f7f6743c549ed6c0c877.tar.gz
samba-6c2e58987bcb3b5fe527f7f6743c549ed6c0c877.tar.bz2
samba-6c2e58987bcb3b5fe527f7f6743c549ed6c0c877.zip
Formatting and other fixes to man pages.
(This used to be commit 411025ed0d6ba37ff00f4afc8ccdc9dae94b62e0)
Diffstat (limited to 'docs/smbdotconf/locking')
-rw-r--r--docs/smbdotconf/locking/cscpolicy.xml18
-rw-r--r--docs/smbdotconf/locking/lockspincount.xml2
-rw-r--r--docs/smbdotconf/locking/oplockbreakwaittime.xml22
-rw-r--r--docs/smbdotconf/locking/oplockcontentionlimit.xml25
-rw-r--r--docs/smbdotconf/locking/oplocks.xml16
-rw-r--r--docs/smbdotconf/locking/posixlocking.xml15
-rw-r--r--docs/smbdotconf/locking/strictlocking.xml25
7 files changed, 68 insertions, 55 deletions
diff --git a/docs/smbdotconf/locking/cscpolicy.xml b/docs/smbdotconf/locking/cscpolicy.xml
index 5dd76569fa..6131e1269f 100644
--- a/docs/smbdotconf/locking/cscpolicy.xml
+++ b/docs/smbdotconf/locking/cscpolicy.xml
@@ -3,15 +3,19 @@
type="enum"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
- <para>This stands for <emphasis>client-side caching
- policy</emphasis>, and specifies how clients capable of offline
- caching will cache the files in the share. The valid values
- are: manual, documents, programs, disable.</para>
+ <para>
+ This stands for <emphasis>client-side caching policy</emphasis>, and specifies how clients capable of offline
+ caching will cache the files in the share. The valid values are: manual, documents, programs, disable.
+ </para>
- <para>These values correspond to those used on Windows servers.</para>
+ <para>
+ These values correspond to those used on Windows servers.
+ </para>
- <para>For example, shares containing roaming profiles can have
- offline caching disabled using <smbconfoption name="csc policy">disable</smbconfoption>.</para>
+ <para>
+ For example, shares containing roaming profiles can have offline caching disabled using
+ <smbconfoption name="csc policy">disable</smbconfoption>.
+ </para>
</description>
<value type="default">manual</value>
<value type="example">programs</value>
diff --git a/docs/smbdotconf/locking/lockspincount.xml b/docs/smbdotconf/locking/lockspincount.xml
index e7fb75a75f..92fee8806e 100644
--- a/docs/smbdotconf/locking/lockspincount.xml
+++ b/docs/smbdotconf/locking/lockspincount.xml
@@ -11,7 +11,7 @@
in case the lock could later be acquired. This behavior
is used to support PC database formats such as MS Access
and FoxPro.
-</para>
+ </para>
</description>
<value type="default">3</value>
</samba:parameter>
diff --git a/docs/smbdotconf/locking/oplockbreakwaittime.xml b/docs/smbdotconf/locking/oplockbreakwaittime.xml
index cd78f1a86d..bede040840 100644
--- a/docs/smbdotconf/locking/oplockbreakwaittime.xml
+++ b/docs/smbdotconf/locking/oplockbreakwaittime.xml
@@ -3,16 +3,16 @@
type="integer"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
- <para>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.</para>
+ <para>
+ 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.
+ </para>
- <warning><para>DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND
- UNDERSTOOD THE SAMBA OPLOCK CODE.</para></warning>
- </description>
- <value type="default">0</value>
+ <warning><para>
+ DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE.
+ </para></warning>
+</description>
+<value type="default">0</value>
</samba:parameter>
diff --git a/docs/smbdotconf/locking/oplockcontentionlimit.xml b/docs/smbdotconf/locking/oplockcontentionlimit.xml
index fec5809cb4..3ee3c45eb3 100644
--- a/docs/smbdotconf/locking/oplockcontentionlimit.xml
+++ b/docs/smbdotconf/locking/oplockcontentionlimit.xml
@@ -3,20 +3,23 @@
type="integer"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
- <para>This is a <emphasis>very</emphasis> advanced
- <citerefentry><refentrytitle>smbd</refentrytitle>
- <manvolnum>8</manvolnum></citerefentry> tuning option to
- improve the efficiency of the granting of oplocks under multiple
- client contention for the same file.</para>
+ <para>
+ This is a <emphasis>very</emphasis> advanced <citerefentry><refentrytitle>smbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> tuning option to improve the efficiency of the
+ granting of oplocks under multiple client contention for the same file.
+ </para>
- <para>In brief it specifies a number, which causes <citerefentry><refentrytitle>smbd</refentrytitle>
- <manvolnum>8</manvolnum></citerefentry>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
+ <para>
+ In brief it specifies a number, which causes <citerefentry><refentrytitle>smbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry>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 <command moreinfo="none">smbd</command> to behave in a similar
- way to Windows NT.</para>
+ way to Windows NT.
+ </para>
-<warning><para>DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
- AND UNDERSTOOD THE SAMBA OPLOCK CODE.</para></warning>
+ <warning><para>
+ DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE.
+ </para></warning>
</description>
<value type="default">2</value>
diff --git a/docs/smbdotconf/locking/oplocks.xml b/docs/smbdotconf/locking/oplocks.xml
index 3ce70a7883..0c6c26927c 100644
--- a/docs/smbdotconf/locking/oplocks.xml
+++ b/docs/smbdotconf/locking/oplocks.xml
@@ -3,22 +3,26 @@
type="boolean"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
- <para>This boolean option tells <command moreinfo="none">smbd</command> whether to
+ <para>
+ This boolean option tells <command moreinfo="none">smbd</command> 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
- <filename moreinfo="none">Speed.txt</filename> in the Samba <filename moreinfo="none">docs/</filename>
- directory.</para>
+ <filename moreinfo="none">Speed.txt</filename> in the Samba
+ <filename moreinfo="none">docs/</filename> directory.
+ </para>
- <para>Oplocks may be selectively turned off on certain files with a
- share. See the <smbconfoption name="veto oplock files"/> parameter. On some systems
+ <para>
+ Oplocks may be selectively turned off on certain files with a share. See
+ the <smbconfoption name="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
- <parameter moreinfo="none">kernel oplocks</parameter> parameter for details.</para>
+ <smbconfoption name="kernel oplocks"/> parameter for details.
+ </para>
</description>
<related>kernel oplocks</related>
diff --git a/docs/smbdotconf/locking/posixlocking.xml b/docs/smbdotconf/locking/posixlocking.xml
index badb1d1750..e5a89f59aa 100644
--- a/docs/smbdotconf/locking/posixlocking.xml
+++ b/docs/smbdotconf/locking/posixlocking.xml
@@ -3,14 +3,13 @@
context="S"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
- <para>The <citerefentry><refentrytitle>smbd</refentrytitle>
- <manvolnum>8</manvolnum></citerefentry>
- 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.</para>
+ <para>
+ The <citerefentry><refentrytitle>smbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry>
+ 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.
+ </para>
</description>
<value type="default">yes</value>
</samba:parameter>
diff --git a/docs/smbdotconf/locking/strictlocking.xml b/docs/smbdotconf/locking/strictlocking.xml
index 6ccca332da..0394e24b28 100644
--- a/docs/smbdotconf/locking/strictlocking.xml
+++ b/docs/smbdotconf/locking/strictlocking.xml
@@ -3,17 +3,20 @@
type="boolean"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
- <para>This is a boolean that controls the handling of
- file locking in the server. When this is set to <constant>yes</constant>,
- 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.</para>
+ <para>
+ This is a boolean that controls the handling of file locking in the server. When this is set to <constant>yes</constant>,
+ 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.
+ </para>
- <para>When strict locking is disabled, the server performs file
- lock checks only when the client explicitly asks for them.</para>
+ <para>
+ When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them.
+ </para>
- <para>Well-behaved clients always ask for lock checks when it
- is important. So in the vast majority of cases, <command moreinfo="none">strict
- locking = no</command> is acceptable.</para>
- </description>
- <value type="default">yes</value>
+ <para>
+ Well-behaved clients always ask for lock checks when it is important. So in the vast majority of cases,
+ <command moreinfo="none">strict locking = no</command> is acceptable.
+ </para>
+</description>
+<value type="default">yes</value>
</samba:parameter>