Docs: clarify bits/bytes on delay pools

diff --git a/src/cf.data.pre b/src/cf.data.pre
index 478f126f32c3338f03deb76ef1c957860dffba7a..3d860a9281d9ef7791ca1472e507320079cb5a38 100644 (file)
--- a/src/cf.data.pre
+++ b/src/cf.data.pre
@@ -4876,6 +4876,11 @@ DOC_START
                class 5         Requests are grouped according their tag (see
                                external_acl's tag= reply).
 
+
+       Each pool also requires a delay_parameters directive to configure the pool size
+       and speed limits used whenever the pool is applied to a request. Along with
+       a set of delay_access directives to determine when it is used.
+
        NOTE: If an IP address is a.b.c.d
                -> bits 25 through 32 are "d"
                -> bits 17 through 24 are "c"
@@ -4917,27 +4922,29 @@ LOC: Config.Delay
 DOC_START
        This defines the parameters for a delay pool.  Each delay pool has
        a number of "buckets" associated with it, as explained in the
-       description of delay_class.  For a class 1 delay pool, the syntax is:
+       description of delay_class.
 
-delay_parameters pool aggregate
+       For a class 1 delay pool, the syntax is:
+               delay_pools pool 1
+               delay_parameters pool aggregate
 
        For a class 2 delay pool:
-
-delay_parameters pool aggregate individual
+               delay_pools pool 2
+               delay_parameters pool aggregate individual
 
        For a class 3 delay pool:
-
-delay_parameters pool aggregate network individual
+               delay_pools pool 3
+               delay_parameters pool aggregate network individual
 
        For a class 4 delay pool:
-
-delay_parameters pool aggregate network individual user
+               delay_pools pool 4
+               delay_parameters pool aggregate network individual user
 
        For a class 5 delay pool:
+               delay_pools pool 5
+               delay_parameters pool tagrate
 
-delay_parameters pool tagrate
-
-       The variables here are:
+       The option variables are:
 
                pool            a pool number - ie, a number between 1 and the
                                number specified in delay_pools as used in
@@ -4963,30 +4970,39 @@ delay_parameters pool tagrate
        quoted in bits) per second placed into the bucket, and maximum is the
        maximum number of bytes which can be in the bucket at any time.
 
+       There must be one delay_parameters line for each delay pool.
+
+
        For example, if delay pool number 1 is a class 2 delay pool as in the
-       above example, and is being used to strictly limit each host to 64kbps
+       above example, and is being used to strictly limit each host to 64Kbit/sec
        (plus overheads), with no overall limit, the line is:
 
-delay_parameters 1 -1/-1 8000/8000
+               delay_parameters 1 -1/-1 8000/8000
+
+       Note that 8 x 8000 KByte/sec -> 64Kbit/sec.
 
        Note that the figure -1 is used to represent "unlimited".
 
+
        And, if delay pool number 2 is a class 3 delay pool as in the above
-       example, and you want to limit it to a total of 256kbps (strict limit)
-       with each 8-bit network permitted 64kbps (strict limit) and each
-       individual host permitted 4800bps with a bucket maximum size of 64kb
+       example, and you want to limit it to a total of 256Kbit/sec (strict limit)
+       with each 8-bit network permitted 64Kbit/sec (strict limit) and each
+       individual host permitted 4800bit/sec with a bucket maximum size of 64Kbits
        to permit a decent web page to be downloaded at a decent speed
        (if the network is not being limited due to overuse) but slow down
        large downloads more significantly:
 
-delay_parameters 2 32000/32000 8000/8000 600/8000
+               delay_parameters 2 32000/32000 8000/8000 600/8000
+
+       Note that 8 x 32000 KByte/sec -> 256Kbit/sec.
+                 8 x  8000 KByte/sec ->  64Kbit/sec.
+                 8 x   600 Byte/sec  -> 4800bit/sec.
 
-       There must be one delay_parameters line for each delay pool.
 
        Finally, for a class 4 delay pool as in the example - each user will
-       be limited to 128Kb no matter how many workstations they are logged into.:
+       be limited to 128Kbits/sec no matter how many workstations they are logged into.:
 
-delay_parameters 4 32000/32000 8000/8000 600/64000 16000/16000
+               delay_parameters 4 32000/32000 8000/8000 600/64000 16000/16000
 DOC_END
 
 NAME: delay_initial_bucket_level