INN commit: trunk (5 files)

INN Commit Russ_Allbery at isc.org
Sat Nov 22 19:49:39 UTC 2008


    Date: Saturday, November 22, 2008 @ 11:49:38
  Author: iulius
Revision: 8187

Convert into POD the incoming.conf man page.
Add the ignore: parameter and fix a few mistakes.

Added:
  trunk/doc/pod/incoming.conf.pod
Modified:
  trunk/MANIFEST
  trunk/doc/man/	(properties)
  trunk/doc/pod/Makefile
Deleted:
  trunk/doc/man/incoming.conf.5

---------------------------+
 MANIFEST                  |    1 
 doc/man/incoming.conf.5   |  190 --------------------------------------------
 doc/pod/Makefile          |    4 
 doc/pod/incoming.conf.pod |  188 +++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 192 insertions(+), 191 deletions(-)

Modified: MANIFEST
===================================================================
--- MANIFEST	2008-11-22 19:48:21 UTC (rev 8186)
+++ MANIFEST	2008-11-22 19:49:38 UTC (rev 8187)
@@ -282,6 +282,7 @@
 doc/pod/hook-perl.pod                 Master file for doc/hook-perl
 doc/pod/hook-python.pod               Master file for doc/hook-python
 doc/pod/ident.pod                     Master file for ident.8
+doc/pod/incoming.conf.pod             Master file for incoming.conf.5
 doc/pod/inews.pod                     Master file for inews.1
 doc/pod/inn.conf.pod                  Master file for inn.conf.5
 doc/pod/innbind.pod                   Master file for innbind.8


Property changes on: trunk/doc/man
___________________________________________________________________
Modified: svn:ignore
   - active.5
active.times.5
actsync.8
archive.8
auth_krb5.8
auth_smb.8
batcher.8
buffchan.8
buffindexed.conf.5
ckpasswd.8
control.ctl.5
convdate.1
ctlinnd.8
cycbuff.conf.5
distrib.pats.5
distributions.5
docheckgroups.8
domain.8
expire.ctl.5
expireover.8
fastrm.1
getlist.1
grephistory.1
ident.8
inews.1
inn.conf.5
INN__Config.3pm
innbind.8
innconfval.1
innd.8
inndf.8
innmail.1
innupgrade.8
libauth.3
libinnhist.3
list.3
mailpost.8
makehistory.8
moderators.5
motd.news.5
newsfeeds.5
news.daily.8
newslog.5
newsgroups.5
ninpaths.8
nnrpd.8
ovdb.5
ovdb_init.8
ovdb_monitor.8
ovdb_server.8
ovdb_stat.8
overchan.8
passwd.nntp.5
perl-nocem.8
pgpverify.1
pullnews.1
qio.3
radius.8
radius.conf.5
rc.news.8
readers.conf.5
rnews.1
sasl.conf.5
scanlogs.8
send-uucp.8
sendinpaths.8
shlock.1
simpleftp.1
sm.1
storage.conf.5
subscriptions.5
tally.control.8
tdx-util.8
tinyleaf.8
tst.3
uwildmat.3

   + active.5
active.times.5
actsync.8
archive.8
auth_krb5.8
auth_smb.8
batcher.8
buffchan.8
buffindexed.conf.5
ckpasswd.8
control.ctl.5
convdate.1
ctlinnd.8
cycbuff.conf.5
distrib.pats.5
distributions.5
docheckgroups.8
domain.8
expire.ctl.5
expireover.8
fastrm.1
getlist.1
grephistory.1
ident.8
incoming.conf.5
inews.1
inn.conf.5
INN__Config.3pm
innbind.8
innconfval.1
innd.8
inndf.8
innmail.1
innupgrade.8
libauth.3
libinnhist.3
list.3
mailpost.8
makehistory.8
moderators.5
motd.news.5
newsfeeds.5
news.daily.8
newslog.5
newsgroups.5
ninpaths.8
nnrpd.8
ovdb.5
ovdb_init.8
ovdb_monitor.8
ovdb_server.8
ovdb_stat.8
overchan.8
passwd.nntp.5
perl-nocem.8
pgpverify.1
pullnews.1
qio.3
radius.8
radius.conf.5
rc.news.8
readers.conf.5
rnews.1
sasl.conf.5
scanlogs.8
send-uucp.8
sendinpaths.8
shlock.1
simpleftp.1
sm.1
storage.conf.5
subscriptions.5
tally.control.8
tdx-util.8
tinyleaf.8
tst.3
uwildmat.3


Deleted: doc/man/incoming.conf.5
===================================================================
--- doc/man/incoming.conf.5	2008-11-22 19:48:21 UTC (rev 8186)
+++ doc/man/incoming.conf.5	2008-11-22 19:49:38 UTC (rev 8187)
@@ -1,190 +0,0 @@
-.\" $Revision$
-.TH INCOMING.CONF 5
-.SH NAME
-incoming.conf \- names and addresses that feed us news
-.SH DESCRIPTION
-The file
-.I <pathetc in inn.conf>/incoming.conf
-consists of three types of entries: key/value, peer and group.
-Comments are from the hash character ``#'' to the end of the line.
-Blank lines are ignored.  All key/value entries within each type
-must not be duplicated.
-.PP
-Key/value entries are a keyword immediately followed by a colon, at least
-one blank and a value.  For example:
-.PP
-.RS
-.nf
-       max-connections: 10
-.fi
-.RE
-.PP
-A legal key does not contains blanks, colons, nor ``#''.
-There are 3 different types of values:  integers, booleans, and strings.
-Integers are as to be expected. A boolean value is either ``true'' or
-``false'' (case is significant). A string value is any other sequence of
-characters. If the string needs to contain whitespace, then it must be
-quoted with double quotes.
-.PP
-Peer entries look like:
-.PP
-.RS
-.nf
-        peer <name> {
-             # body
-        }
-.fi
-.RE
-.PP
-The word ``peer'' is required. ``<name>''is a label for this peer.
-The ``<name>'' is any string valid as a key. The body of a peer entry
-contains some number of key/value entries.
-.PP
-Group entries look like:
-.PP
-.RS
-.nf
-        group <name> {
-             # body
-        }
-.fi
-.RE
-.PP
-The word ``group'' is required. The ``<name>'' is any string valid as a
-key. The body of a group entry contains any number of the three types of
-entries. So key/value pairs can be defined inside a group, and peers can
-be nested inside a group, and other groups can be nested inside a group.
-.PP
-Key/value entries that are defined outside of all peer and group entries
-are said to be at ``global scope''. Global key/value entries act as
-defaults for peers. When
-.IR innd (8)
-looks for a specific value in a peer entry
-(for example, the maximum number of connections to allow), if the value
-is not defined in the peer entry, then the enclosing groups are examined
-for the entry (starting at the closest enclosing group). If there are no
-enclosing groups, or the enclosing groups don't define the key/value,
-then the value at global scope is used.
-.PP
-A small example could be:
-.PP
-.RS
-.nf
-# Global value applied to all peers that have
-# no value of their own.
-max-connections: 5
-
-# A peer definition.
-peer uunet {
-     hostname: usenet1.uu.net
-}
-
-peer vixie {
-     hostname: gw.home.vix.com
-     max-connections: 10 # override global value.
-}
-
-# A group of two peers who can open more
-# connections than normal
-group fast-sites {
-     max-connections: 15
-
-     # Another peer. The ``max-connections'' value from the
-     # ``fast-sites'' group scope is used. The ``hostname'' value
-     # defaults to the peer's name.
-     peer data.ramona.vix.com {
-     }
-
-     peer bb.home.vix.com {
-         hostname: bb.home.vix.com
-         max-connections: 20 # he can really cook.
-    }
-}
-.fi
-.RE
-.PP
-Given the above configuration file, the defined peers would have the
-following values for the ``max-connections'' key.
-.PP
-.RS
-.nf
-        uunet                  5
-        vixie                 10
-        data.ramona.vix.com   15
-        bb.home.vix.com       20
-.fi
-.RE
-.PP
-Ten keys are allowed:
-.TP
-.BI hostname:
-This key requires a string value. It is a list of hostnames separated by a
-comma. A hostname is the host's FQDN, or the dotted quad ip-address of the
-peer. If this key is not present in a peer block, the hostname defaults to
-the label of the peer.
-.TP
-.BI streaming:
-This key requires a boolean value. It defines whether streaming commands
-are allowed from this peer. (default=true)
-.TP
-.BI max-connections:
-This key requires a positive integer value. It defines the maximum number
-of connections allowed. A value of zero specifies an unlimited number
-of maximum connections (``unlimited'' or ``none'' can be used as synonym).
-(default=0)
-.TP
-.BI hold-time:
-This key requires a positive integer value. It defines the hold time before
-closing, if the connection is over max-connections. A value of zero
-specifies immediate close. (default=0)
-.TP
-.BI password:
-This key requires a string value. It is used if you wish to require a peer
-to supply a password. (default=no password)
-.TP
-.BI identd:
-This key requires a string value. It is used if you wish to require a peer's
-user name retrieved through identd match the specified string. Note that
-currently
-.IR innd (8)
-does not implement any timeout in identd callbacks, so enabling this
-option may cause innd to hang if the remote peer does not respond to ident
-callbacks in a reasonable timeframe (default=no identd)
-.TP
-.BI patterns:
-This key requires a string value. It is a list of
-.IR newsfeeds (5)-style
-list of newsgroups which are to be accepted from this host. (default="*")
-.TP
-.BI email:
-This key requires a string value. Reserved for future use. (default=empty)
-.TP
-.BI comment:
-This key requires a string value. Reserved for future use. (default=empty)
-.TP
-.BI skip:
-This key requires a boolean value. Setting this entry causes this peer
-to be skipped. (default=false)
-.TP
-.BI noresendid:
-This key requires a boolean value. It defines whether
-.IR innd (8)
-should send
-``431 RESENDID'' responses if a message is offered that is being received
-from another peer. This can be useful for peers that resend messages
-right away, as innfeed does. (default=false)
-.TP
-.BI nolist:
-This key requires a boolean value. It defines whether a peer is allowed to
-issue list command. (default=false)
-.SH HISTORY
-Written by Fabien Tassin <fta at sofaraway.org> for InterNetNews.
-.de R$
-This is revision \\$3, dated \\$4.
-..
-.R$ $Id$
-.SH "SEE ALSO"
-inn.conf(5),
-innd(8),
-newsfeeds(5),
-uwildmat(3).

Modified: doc/pod/Makefile
===================================================================
--- doc/pod/Makefile	2008-11-22 19:48:21 UTC (rev 8186)
+++ doc/pod/Makefile	2008-11-22 19:49:38 UTC (rev 8187)
@@ -20,7 +20,8 @@
 
 MAN5	= ../man/active.5 ../man/active.times.5 ../man/buffindexed.conf.5 \
 	../man/control.ctl.5 ../man/cycbuff.conf.5 ../man/distrib.pats.5 \
-	../man/distributions.5 ../man/expire.ctl.5 ../man/inn.conf.5 ../man/moderators.5 \
+	../man/distributions.5 ../man/expire.ctl.5 ../man/incoming.conf.5 \
+	../man/inn.conf.5 ../man/moderators.5 \
 	../man/motd.news.5 ../man/newsfeeds.5 ../man/newsgroups.5 \
 	../man/newslog.5 ../man/ovdb.5 \
 	../man/passwd.nntp.5 ../man/radius.conf.5 ../man/readers.conf.5 \
@@ -85,6 +86,7 @@
 ../man/distrib.pats.5:	distrib.pats.pod	; $(POD2MAN) -s 5 $? > $@
 ../man/distributions.5:	distributions.pod	; $(POD2MAN) -s 5 $? > $@
 ../man/expire.ctl.5:	expire.ctl.pod		; $(POD2MAN) -s 5 $? > $@
+../man/incoming.conf.5:	incoming.conf.pod	; $(POD2MAN) -s 5 $? > $@
 ../man/inn.conf.5:	inn.conf.pod		; $(POD2MAN) -s 5 $? > $@
 ../man/moderators.5:	moderators.pod		; $(POD2MAN) -s 5 $? > $@
 ../man/motd.news.5:	motd.news.pod		; $(POD2MAN) -s 5 $? > $@

Added: doc/pod/incoming.conf.pod
===================================================================
--- doc/pod/incoming.conf.pod	                        (rev 0)
+++ doc/pod/incoming.conf.pod	2008-11-22 19:49:38 UTC (rev 8187)
@@ -0,0 +1,188 @@
+=head1 NAME
+
+incoming.conf - Names and addresses that feed us news
+
+=head1 DESCRIPTION
+
+The file I<pathetc>/incoming.conf consists of three types of entries:
+key/value, peer and group.  Comments are from the hash character C<#> to the
+end of the line.  Blank lines are ignored.  All key/value entries within each
+type must not be duplicated.  Key/value entries are a keyword immediately
+followed by a colon, at least one blank and a value.  For example:
+
+    max-connections: 10
+
+A legal key does not contains blanks, colons, nor C<#>. There are three
+different types of values:  integers, booleans, and strings.  Integers are
+as to be expected.  A boolean value is either C<true> or C<false>
+(case is significant).  A string value is any other sequence of characters.
+If the string needs to contain whitespace, then it must be quoted
+with double quotes.
+
+Peer entries look like:
+
+    peer <name> {
+        # body
+    }
+
+The word C<peer> is required.  <name> is a label for this peer.  It is any
+string valid as a key.  The body of a peer entry contains some number of
+key/value entries.
+
+Group entries look like:
+
+    group <name> {
+        # body
+    }
+
+The word C<group> is required.  <name> is any string valid as a key.  The body
+of a group entry contains any number of the three types of entries.  So key/value
+pairs can be defined inside a group, and peers can be nested inside a group,
+and other groups can be nested inside a group.  Key/value entries that are
+defined outside of all peer and group entries are said to be at global
+scope.  Global key/value entries act as defaults for peers.  When B<innd> looks
+for a specific value in a peer entry (for example, the maximum number of
+connections to allow), if the value is not defined in the peer entry, then
+the enclosing groups are examined for the entry (starting at the closest
+enclosing group).  If there are no enclosing groups, or the enclosing groups
+don't define the key/value, then the value at global scope is used.  A small
+example could be:
+
+    # Global value applied to all peers that have no value of their own.
+    max-connections: 5
+
+    # A peer definition.
+    peer uunet {
+        hostname: usenet1.uu.net
+    }
+
+    peer vixie {
+        hostname: gw.home.vix.com
+        max-connections: 10        # Override global value.
+    }
+
+    # A group of two peers which can open more connections than normal.
+    group fast-sites {
+        max-connections: 15
+
+        # Another peer.  The max-connections: value from the
+        # fast-sites group scope is used.
+        peer data.ramona.vix.com {
+            hostname: data.ramona.vix.com
+        }
+
+        peer bb.home.vix.com {
+            hostname: bb.home.vix.com
+            max-connections: 20    # He can really cook.
+       }
+    }
+
+Given the above configuration file, the defined peers would have the
+following values for the I<max-connections> key.
+
+    uunet                  5
+    vixie                 10
+    data.ramona.vix.com   15
+    bb.home.vix.com       20
+
+=head1 PARAMETERS
+
+The following keys are allowed:
+
+=over 4
+
+=item I<comment>
+
+This key requires a string value.  Reserved for future use.  The default
+is an empty string.
+
+=item I<email>
+
+This key requires a string value.  Reserved for future use.  The default
+is an empty string.
+
+=item I<hold-time>
+
+This key requires a positive integer value.  It defines the hold time
+before closing, if the connection is over I<max-connections>.  A value
+of zero specifies immediate close.  The default is C<0>.
+
+=item I<hostname>
+
+This key requires a string value.  It is a list of hostnames separated
+by a comma.  A hostname is the host's fully qualified domain name, or
+the dotted quad IP address of the peer.  If this key is not present in
+a peer block, the hostname defaults to the label of the peer.
+
+=item I<identd>
+
+This key requires a string value.  It is used if you wish to require
+a peer's user name retrieved through B<identd> match the specified string.
+Note that currently B<innd> does not implement any timeout in B<identd>
+callbacks, so enabling this option may cause B<innd> to hang if the remote
+peer does not respond to B<ident> callbacks in a reasonable timeframe.
+The default is an empty string, that is to say no B<identd>.
+
+=item I<ignore>
+
+This key requires a boolean value.  Setting this entry causes B<innd> to
+refuse every article sent via CHECK or IHAVE by this peer.  The default
+is false.
+
+=item I<max-connections>
+
+This key requires a positive integer value.  It defines the maximum
+number of connections allowed.  A value of zero specifies an unlimited
+number of maximum connections (C<unlimited> or C<none> can be used
+as synonyms).  The default is C<0>.
+
+=item I<nolist>
+
+This key requires a boolean value.  It defines whether a peer is
+allowed to issue list command.  The default is false, that is to say
+it can.
+
+=item I<noresendid>
+
+This key requires a boolean value.  It defines whether B<innd> should send
+C<431> (response to CHECK, in streaming mode) or C<436> (response to IHAVE
+in non-streaming mode) responses instead of C<438> (response to CHECK)
+or C<435> (response to IHAVE) if a message is offered that is already
+received from another peer.  This can be useful for peers that resend
+messages right away, as innfeed does.  The default is false:  the peer
+receives C<431> and C<436> codes so that it resends the article later.
+
+=item I<password>
+
+This key requires a string value.  It is used if you wish to require
+a peer to supply a password via AUTHINFO USER/PASS.  The default is
+an empty string, that it to say no password.
+
+=item I<patterns>
+
+This key requires a string value.  It is a list of newsfeeds(5)-style
+list of newsgroups which are to be accepted from this host.  The default
+is the string C<*>, that is to say all groups are accepted.
+
+=item I<skip>
+
+This key requires a boolean value.  Setting this entry causes this
+peer to be skipped.  The default is false.
+
+=item I<streaming>
+
+This key requires a boolean value.  It defines whether streaming commands
+(CHECK and TAKETHIS) are allowed from this peer.  The default is true.
+
+=back
+
+=head1 HISTORY
+
+Written by Fabien Tassin <fta at sofaraway.org> for InterNetNews.  Converted to
+POD by Julien Elie <julien at trigofacile.com>.
+
+$Id$
+
+=head1 SEE ALSO
+
+inn.conf(5), innd(8), newsfeeds(5), uwildmat(3).


Property changes on: trunk/doc/pod/incoming.conf.pod
___________________________________________________________________
Added: svn:keywords
   + Author Date Id Revision
Added: svn:eol-style
   + native




More information about the inn-committers mailing list