INN commit: branches/2.5/doc/pod (innfeed.conf.pod)

[INN Commit]

    Date: Sunday, July 17, 2011 @ 11:54:40
  Author: iulius
Revision: 9269

innfeed.conf:  fix documentation wrt. floating-point and optional values

Move bindaddress and bindaddress6 to the (newly created) optional section.

dynamic-backlog-low and dynamic-backlog-high expect floating-point values,
and not integer values.

All of the special keys for imapfeed are not required.

Thanks to Florian Schlichting for the main part of this patch.

Modified:
  branches/2.5/doc/pod/innfeed.conf.pod

------------------+
 innfeed.conf.pod |   72 +++++++++++++++++++++++++++++------------------------
 1 file changed, 40 insertions(+), 32 deletions(-)

Modified: innfeed.conf.pod
===================================================================
--- innfeed.conf.pod	2011-07-17 18:54:13 UTC (rev 9268)
+++ innfeed.conf.pod	2011-07-17 18:54:40 UTC (rev 9269)
@@ -314,6 +314,8 @@
 an article for an unspecified peer), it will add the peer site using the
 parameters specified at global scope.
 
+=head2 Required keys
+
 =over 4
 
 =item I<article-timeout>
@@ -409,7 +411,7 @@
 
 =item I<dynamic-backlog-low>
 
-This key requires an integer value between 0 and 100.  It represents (as
+This key requires a floating-point value between 0 and 100.  It represents (as
 a percentage) the low water mark for the host queue.  If the host queue
 falls below this level while using I<dynamic-method> 2 or 3, and if 2 or
 more connections are open, B<innfeed> will attempt to drop connections to
@@ -419,7 +421,7 @@
 
 =item I<dynamic-backlog-high>
 
-This key requires an integer value between 0 and 100.  It represents
+This key requires a floating-point value between 0 and 100.  It represents
 (as a percentage) the high water mark for the host queue.  If the host
 queue rises above this level while using I<dynamic-method> 2 or 3, and
 if less than I<max-connections> are open to the host, B<innfeed> will
@@ -486,29 +488,6 @@
 in a slower response to changing percentages of articles accepted; a lower
 number will result in a faster response.
 
-=item I<bindaddress>
-
-This key requires a string value.  It specifies which outgoing IPv4 address
-B<innfeed> should bind the local end of its connection to.  It must be an
-IPv4 address in dotted-quad format (nnn.nnn.nnn.nnn), C<any>, or C<none>.
-If not set or set to C<any>, B<innfeed> defaults to letting the kernel
-choose this address.  If set to C<none>, B<innfeed> will not use IPv4 for
-outgoing connections to peers in this scope (i.e. it forces IPv6).
-
-If not set in F<innfeed.conf>, B<innfeed> defaults to the value of
-I<sourceaddress> from F<inn.conf> (which by default is unset).
-
-=item I<bindaddress6>
-
-This key requires a string value.  It behaves like I<bindaddress> except
-for outgoing IPv6 connections.  It must be in numeric IPv6 format (note
-that a value containing colons must be enclosed in double quotes), C<any>,
-or C<none>.  If set to C<none>, B<innfeed> will not use IPv6 for outgoing
-connections to peers in this scope.
-
-If not set in F<innfeed.conf>, B<innfeed> defaults to the value of
-I<sourceaddress6> from F<inn.conf> (which by default is unset).
-
 =item I<port-number>
 
 This key requires a positive integer value.  It defines the TCP/IP port
@@ -596,6 +575,37 @@
 in-order delivery, so setting this to true when I<initial-connections>
 or I<max-connections> is more than 1 is inconsistent.
 
+=back
+
+=head2 Optional keys
+
+The following keys are optional:
+
+=over 4
+
+=item I<bindaddress>
+
+This key requires a string value.  It specifies which outgoing IPv4 address
+B<innfeed> should bind the local end of its connection to.  It must be an
+IPv4 address in dotted-quad format (nnn.nnn.nnn.nnn), C<any>, or C<none>.
+If not set or set to C<any>, B<innfeed> defaults to letting the kernel
+choose this address.  If set to C<none>, B<innfeed> will not use IPv4 for
+outgoing connections to peers in this scope (i.e. it forces IPv6).
+
+If not set in F<innfeed.conf>, B<innfeed> defaults to the value of
+I<sourceaddress> from F<inn.conf> (which by default is unset).
+
+=item I<bindaddress6>
+
+This key requires a string value.  It behaves like I<bindaddress> except
+for outgoing IPv6 connections.  It must be in numeric IPv6 format (note
+that a value containing colons must be enclosed in double quotes), C<any>,
+or C<none>.  If set to C<none>, B<innfeed> will not use IPv6 for outgoing
+connections to peers in this scope.
+
+If not set in F<innfeed.conf>, B<innfeed> defaults to the value of
+I<sourceaddress6> from F<inn.conf> (which by default is unset).
+
 =item I<username>
 
 This key requires a string value.  If the value is defined, then B<innfeed>
@@ -607,15 +617,15 @@
 This key requires a string value.  The value is the password used for
 AUTHINFO PASS.  I<username> must also be defined, if this key is defined.
 
-=item Special keys for B<imapfeed>
+=back
 
+=head2 Special keys for B<imapfeed>
+
 The following keys are used with B<imapfeed> to authenticate to a remote
-host.  They are optional.
+host.  Several parameters may be included:
 
-Several parameters must be included:
+=over 4
 
-=over 2
-
 =item I<deliver-authname>
 
 The authname is who you want to authenticate as.
@@ -649,8 +659,6 @@
 
 =back
 
-=back
-
 =head1 PEER VALUES
 
 As previously explained, the peer definitions can contain redefinitions