Reformat source files, move 'default' info into body text.
authorJohn Terpstra <jht@samba.org>
Fri, 9 Dec 2005 03:47:05 +0000 (03:47 +0000)
committerGerald W. Carter <jerry@samba.org>
Wed, 23 Apr 2008 14:01:15 +0000 (09:01 -0500)
docs/smbdotconf/misc/dfreecachetime.xml
docs/smbdotconf/misc/dfreecommand.xml

index 4c03861cf9caf718be9c19a3a71937dd05e27176..2a8805e9488a8c9db16d4d0cd3832e15b2023140 100644 (file)
@@ -5,22 +5,23 @@
                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
 <description>
 
-       <para>The <parameter moreinfo="none">dfree cache time</parameter>
-       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 &quot;Abort Retry
-       Ignore&quot; at the end of each directory listing.</para>
+       <para>
+       The <parameter moreinfo="none">dfree cache time</parameter> 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 &quot;Abort Retry Ignore&quot; at the
+       end of each directory listing.
+       </para>
+
+       <para>
+       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 <smbconfoption name="dfree command"/> scripts increasing the load.
+       </para>
 
-       <para>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 <smbconfoption name="dfree command"/> scripts increasing the load.
+       <para>
+       By default this parameter is zero, meaning no caching will be done.
        </para>
 
 </description>
-<value type="default"><comment>By default this parameter is zero, meaning no caching
-               will be done.</comment></value>
 <value type="example">dfree cache time = 60</value>
 </samba:parameter>
index 7f8dda1a7eee8bd3ae19e57f1b2ce50f7ac3de84..d7fb675f2794f3f00389f78914866500aec8360a 100644 (file)
@@ -6,45 +6,39 @@
 <description>
 
        <para>
-       The <parameter moreinfo="none">dfree command</parameter> 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 &quot;Abort Retry
-       Ignore&quot; at the end of each directory listing.
+       The <parameter moreinfo="none">dfree command</parameter> 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 &quot;Abort Retry Ignore&quot;
+       at the end of each directory listing.
        </para>
 
        <para>
-       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.
+       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.
        </para>
 
        <para>
-       In Samba version 3.0.21 this parameter has been changed to be
-       a per-share parameter, and in addition the parameter
-       <smbconfoption name="dfree cache time"/> was added
-       to allow the output of this script to be cached for systems under
-       heavy load.
+       In Samba version 3.0.21 this parameter has been changed to be a per-share parameter, and in addition the
+       parameter <smbconfoption name="dfree cache time"/> was added to allow the output of this script to be cached
+       for systems under heavy load.
        </para>
 
        <para>
-       The external program will be passed a single parameter indicating 
-       a directory in the filesystem being queried. This will typically consist
-       of the string <filename moreinfo="none">./</filename>. 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.
+       The external program will be passed a single parameter indicating a directory in the filesystem being queried.
+       This will typically consist of the string <filename moreinfo="none">./</filename>. 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.
        </para>
 
        <para>
-       Note: Your script should <emphasis>NOT</emphasis> be setuid or 
-       setgid and should be owned by (and writeable only by) root!
+       Note: Your script should <emphasis>NOT</emphasis> be setuid or setgid and should be owned by (and writeable
+       only by) root!
        </para>
 
-       <para>Where the script dfree (which must be made executable) could be:
+       <para>
+       Where the script dfree (which must be made executable) could be:
 <programlisting format="linespecific"> 
 #!/bin/sh
 df $1 | tail -1 | awk '{print $2&quot; &quot;$4}'
@@ -57,8 +51,10 @@ df $1 | tail -1 | awk '{print $2&quot; &quot;$4}'
        Note that you may have to replace the command names with full path names on some systems.
        </para>
 
+       <para>
+       By default internal routines for determining the disk capacity and remaining space will be used.
+       </para>
+
 </description>
-<value type="default"><comment>By default internal routines for 
-               determining the disk capacity and remaining space will be used.</comment></value>
 <value type="example">/usr/local/samba/bin/dfree</value>
 </samba:parameter>