INN commit: branches/2.5 (6 files)

INN Commit rra at isc.org
Sun Nov 1 19:54:31 UTC 2009


    Date: Sunday, November 1, 2009 @ 11:54:31
  Author: iulius
Revision: 8703

Convert the documentation for innxmit into POD.

Added:
  branches/2.5/doc/pod/innxmit.pod
    (from rev 8699, trunk/doc/pod/innxmit.pod)
Modified:
  branches/2.5/MANIFEST
  branches/2.5/backends/innxmit.c
  branches/2.5/doc/man/	(properties)
  branches/2.5/doc/pod/Makefile
Deleted:
  branches/2.5/doc/man/innxmit.8

---------------------+
 MANIFEST            |    2 
 backends/innxmit.c  |    8 +-
 doc/man/innxmit.8   |  191 --------------------------------------------------
 doc/pod/Makefile    |    5 +
 doc/pod/innxmit.pod |  132 ++++++++++++++++++++++++++++++++++
 5 files changed, 142 insertions(+), 196 deletions(-)

Modified: MANIFEST
===================================================================
--- MANIFEST	2009-11-01 19:53:00 UTC (rev 8702)
+++ MANIFEST	2009-11-01 19:54:31 UTC (rev 8703)
@@ -241,6 +241,7 @@
 doc/pod/control.ctl.pod               Master file for control.ctl.5
 doc/pod/convdate.pod                  Master file for convdate.1
 doc/pod/ctlinnd.pod                   Master file for ctlinnd.8
+doc/pod/cvtbatch.pod                  Master file for cvtbatch.8
 doc/pod/cycbuff.conf.pod              Master file for cycbuff.conf.5
 doc/pod/distrib.pats.pod              Master file for distrib.pats.5
 doc/pod/distributions.pod             Master file for distributions.5
@@ -267,6 +268,7 @@
 doc/pod/inndf.pod                     Master file for inndf.8
 doc/pod/innmail.pod                   Master file for innmail.1
 doc/pod/innupgrade.pod                Master file for innupgrade.8
+doc/pod/innxmit.pod                   Master file for innxmit.8
 doc/pod/install.pod                   Master file for INSTALL
 doc/pod/libauth.pod                   Master file for libauth.3
 doc/pod/libinnhist.pod                Master file for libinnhist.3

Modified: backends/innxmit.c
===================================================================
--- backends/innxmit.c	2009-11-01 19:53:00 UTC (rev 8702)
+++ backends/innxmit.c	2009-11-01 19:54:31 UTC (rev 8703)
@@ -1006,14 +1006,11 @@
     umask(NEWSUMASK);
 
     /* Parse JCL. */
-    while ((i = getopt(ac, av, "lacdHprst:T:vP:")) != EOF)
+    while ((i = getopt(ac, av, "acdHlpP:rst:T:v")) != EOF)
 	switch (i) {
 	default:
 	    Usage();
 	    /* NOTREACHED */
-	case 'P':
-	    port = atoi(optarg);
-	    break;
 	case 'a':
 	    AlwaysRewrite = true;
 	    break;
@@ -1033,6 +1030,9 @@
 	    AlwaysRewrite = true;
 	    Purging = true;
 	    break;
+        case 'P':
+            port = atoi(optarg);
+            break;
 	case 'r':
 	    DoRequeue = false;
 	    break;


Property changes on: branches/2.5/doc/man
___________________________________________________________________
Modified: svn:ignore
   - active.5
active.times.5
actsync.8
archive.8
auth_krb5.8
batcher.8
buffchan.8
buffindexed.conf.5
ckpasswd.8
cnfsheadconf.8
cnfsstat.8
control.ctl.5
convdate.1
ctlinnd.8
cycbuff.conf.5
distrib.pats.5
distributions.5
docheckgroups.8
domain.8
expire.ctl.5
expire.8
expireover.8
expirerm.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
makedbz.8
makehistory.8
mod-active.8
moderators.5
motd.news.5
newsfeeds.5
news.daily.8
news2mail.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
prunehistory.8
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
batcher.8
buffchan.8
buffindexed.conf.5
ckpasswd.8
cnfsheadconf.8
cnfsstat.8
control.ctl.5
convdate.1
ctlinnd.8
cvtbatch.8
cycbuff.conf.5
distrib.pats.5
distributions.5
docheckgroups.8
domain.8
expire.ctl.5
expire.8
expireover.8
expirerm.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
innxmit.8
libauth.3
libinnhist.3
list.3
mailpost.8
makedbz.8
makehistory.8
mod-active.8
moderators.5
motd.news.5
newsfeeds.5
news.daily.8
news2mail.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
prunehistory.8
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/innxmit.8
===================================================================
--- doc/man/innxmit.8	2009-11-01 19:53:00 UTC (rev 8702)
+++ doc/man/innxmit.8	2009-11-01 19:54:31 UTC (rev 8703)
@@ -1,191 +0,0 @@
-.\" $Revision$
-.TH INNXMIT 8
-.SH NAME
-innxmit \- send Usenet articles to a remote NNTP server
-.SH SYNOPSIS
-.I innxmit
-[
-.B \-a
-]
-[
-.B \-c
-]
-[
-.B \-d
-]
-[
-.B \-H
-]
-[
-.B \-l
-]
-[
-.BI \-P " portnum"
-]
-[
-.B \-p
-]
-[
-.B \-r
-]
-[
-.B \-s
-]
-[
-.BI \-T " timeout"
-]
-[
-.BI \-t " timeout"
-]
-.I host
-.I file
-.SH DESCRIPTION
-.I Innxmit
-connects to the NNTP server at the specified
-.I host
-(validating itself via
-.IR passwd.nntp
-if possible) 
-and sends it the articles specified in the batchfile named
-.IR file .
-It is normally invoked by a script run out of
-.IR cron (8)
-that uses
-.IR shlock (1)
-to lock the host name, followed by a
-.IR ctlinnd (8)
-command to flush the batchfile.
-.PP
-If the
-.I file
-is not an absolute pathname, it is taken relative to the
-.I <pathoutgoing in inn.conf>
-directory.
-It is normally written by specifying the ``Wnm'' flags in the
-.I newsfeeds
-file.
-Each line in the batchfile should be in one of the following formats:
-.PP
-.RS
-.nf
-token Message-ID
-token
-.fi
-.RE
-.PP
-The
-.I token
-field names the article to be sent.
-If the
-.I Message-ID
-field is not specified, it will be obtained by scanning the article.
-The
-.I token
-and
-.I Message-Id
-fields are separated by a space.
-.PP
-If a communication error such as a
-.IR write (2)
-failure occurs,
-.I innxmit
-will stop sending and rewrite the batchfile to contain the current
-article and any other unsent articles.
-.SH OPTIONS
-.TP
-.B \-a
-If all articles were sent successfully,
-.I innxmit
-will remove the batchfile; otherwise it will rewrite it to contain the
-list of unsent articles.
-If no articles were sent or rejected, the file is left untouched.
-This can cause the batchfile to grow excessively large if many articles
-have been expired and there are communication problems.
-To always rewrite the batchfile, use the ``\fB\-a\fP'' flag.
-.TP
-.B \-c
-In streaming mode, a check of each message ID is still made to avoid sending
-articles already on the server.
-The ``\fB\-c\fP'' flag will, if streaming mode is supported,
-result in sending articles without checking.
-This results in slightly greater throughput and may be appropriate when
-it is known that the site could not already have the articles such as in
-the case of a "leaf" site.
-.TP
-.B \-d
-Use the ``\fB\-d\fP'' flag to print debugging information on standard error.
-This will show the protocol transactions between
-.I innxmit
-and the NNTP server on the remote host.
-.TP
-.B \-H
-If the ``\fB\-H\fP'' flag is given, then only headers are sent to
-.I host
-for all articles except control messages.
-And Bytes: header is also included even if it does not exist in the original
-article.  ``\fB\-H\fP'' flag is useful for diablo reader.
-.TP
-.B \-l
-The ``\fB\-l\fP'' flag is used to turn on logging of reasons the remote gives
-for rejecting an article.
-.TP
-.B \-P portnum
-To specify a port number other than the default, use the ``\fB\-P\fP'' flag.
-.TP
-.B \-p
-If the ``\fB\-p\fP'' flag is given, then no connection is made and the batchfile
-is purged of entries that refer to files that no longer exist.
-This implies the ``\fB\-a\fP'' flag.
-.TP
-.B \-r
-If the remote server sends an unexpected reply code,
-.I innxmit
-will requeue the article and proceed.
-Use the ``\fB\-r\fP'' flag if the article should not be requeued.
-.TP
-.B \-s
-.I Innxmit
-will attempt to negotiate a streaming mode extension of the NNTP
-protocol with the server at connect time.
-If successful it will use a slightly different protocol that enhances
-throughput.
-If the server does not recognize the streaming mode negotiation
-.I innxmit
-will revert to normal NNTP transfer mode.
-Use the ``\fB\-s\fP'' flag to disable the attempt to negotiate the streaming
-mode extension.
-.TP
-.B \-T seconds
-To specify the total amount of time that should be allowed for article
-transfers, use the ``\fB\-T\fP'' flag.
-The default is to wait until an I/O error occurs, or all the articles have
-been transferred.
-If the ``\fB\-T\fP'' flag is used, the time is checked just before each
-article is started; it will not abort a transfer that is in progress.
-.TP
-.B \-t seconds
-.I Innxmit
-normally blocks until the connection is made.
-To specify a timeout on how long to try to make the connection, use 
-the ``\fB\-t\fP''
-flag.
-.TP
-.B \-v
-Upon exit,
-.I innxmit
-reports transfer and CPU usage statistics via
-.IR syslog (3).
-If the ``\fB\-v\fP'' flag is used, they will also be printed on the standard
-output.
-.SH HISTORY
-Written by Rich $alz <rsalz at uunet.uu.net> for InterNetNews.
-.de R$
-This is revision \\$3, dated \\$4.
-..
-.R$ $Id$
-.SH "SEE ALSO"
-ctlinnd(8),
-inn.conf(5),
-innd(8),
-newsfeeds(5),
-shlock(1).

Modified: doc/pod/Makefile
===================================================================
--- doc/pod/Makefile	2009-11-01 19:53:00 UTC (rev 8702)
+++ doc/pod/Makefile	2009-11-01 19:54:31 UTC (rev 8703)
@@ -30,9 +30,10 @@
 MAN8	= ../man/actsync.8 ../man/archive.8 ../man/auth_krb5.8 \
 	../man/batcher.8 ../man/buffchan.8 \
 	../man/ckpasswd.8 ../man/cnfsheadconf.8 ../man/cnfsstat.8 \
-	../man/ctlinnd.8 ../man/docheckgroups.8 \
+	../man/ctlinnd.8 ../man/cvtbatch.8 ../man/docheckgroups.8 \
 	../man/domain.8 ../man/expire.8 ../man/expireover.8 \
 	../man/expirerm.8 ../man/ident.8 ../man/innd.8 ../man/inndf.8 \
+	../man/innxmit.8 \
 	../man/nnrpd.8 ../man/innbind.8 ../man/innupgrade.8 \
 	../man/makedbz.8 ../man/makehistory.8 ../man/mod-active.8 \
 	../man/news.daily.8 ../man/news2mail.8 ../man/ninpaths.8 \
@@ -112,6 +113,7 @@
 ../man/cnfsheadconf.8:	cnfsheadconf.pod	; $(POD2MAN) -s 8 $? > $@
 ../man/cnfsstat.8:	cnfsstat.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/ctlinnd.8:	ctlinnd.pod		; $(POD2MAN) -s 8 $? > $@
+../man/cvtbatch.8:	cvtbatch.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/docheckgroups.8:	docheckgroups.pod	; $(POD2MAN) -s 8 $? > $@
 ../man/domain.8:	domain.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/expire.8:	expire.pod		; $(POD2MAN) -s 8 $? > $@
@@ -122,6 +124,7 @@
 ../man/innd.8:		innd.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/inndf.8:		inndf.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/innupgrade.8:	innupgrade.pod		; $(POD2MAN) -s 8 $? > $@
+../man/innxmit.8:	innxmit.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/makedbz.8:	makedbz.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/makehistory.8:	makehistory.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/mod-active.8:	mod-active.pod		; $(POD2MAN) -s 8 $? > $@

Copied: branches/2.5/doc/pod/innxmit.pod (from rev 8699, trunk/doc/pod/innxmit.pod)
===================================================================
--- doc/pod/innxmit.pod	                        (rev 0)
+++ doc/pod/innxmit.pod	2009-11-01 19:54:31 UTC (rev 8703)
@@ -0,0 +1,132 @@
+=head1 NAME
+
+innxmit - Send Usenet articles to a remote NNTP server
+
+=head1 SYNOPSIS
+
+B<innxmit> [B<-acdHlprsv>] [B<-P> I<portnum>] [B<-T> I<seconds>]
+[B<-t> I<seconds>] I<host> I<file>
+
+=head1 DESCRIPTION
+
+B<innxmit> connects to the NNTP server at the specified I<host>
+(validating itself via F<passwd.nntp> if possible) and sends it the
+articles specified in the batch file named I<file>.  It is normally
+invoked by a script run out of cron(8) that uses B<shlock> to lock the
+host name, followed by a B<ctlinnd> command to flush the batch file.
+If I<file> is not an absolute path name, it is taken relative to the
+directory specified by the I<pathoutgoing> parameter in F<inn.conf>.
+It is normally written by specifying the C<Wnm> flags in the F<newsfeeds>
+file.  Each line in the batch file should be in one of the following
+formats:
+
+    article Message-ID
+    article
+
+The first field is either the storage API token of an article or the
+name of a file holding an article.  If it is not an absolute pathname
+or a storage API token, it is taken to be a file name relative to
+I<patharticles> in F<inn.conf>. If the second field is not specified,
+the message-ID will be obtained by scanning the article.  The two fields,
+if present, are separated by a space.  If a communication error such
+as a write(2) failure occurs, B<innxmit> will stop sending and rewrite
+the batch file to contain the current article and any other unsent
+articles.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-a>
+
+If all articles were sent successfully, B<innxmit> will remove the
+batch file; otherwise it will rewrite it to contain the list of unsent articles.
+If no articles were sent or rejected, the file is left untouched.  This can
+cause the batch file to grow excessively large if many articles have been
+expired and there are communication problems.  To always rewrite the batch file,
+use the B<-a> flag.
+
+=item B<-c>
+
+In streaming mode, a check of each message-ID is still made to avoid sending
+articles already on the server.  The B<-c> flag will, if streaming mode
+is supported, result in sending articles without checking.  This results
+in slightly greater throughput and may be appropriate when it is known
+that the site could not already have the articles such as in the case of
+a "leaf" site.
+
+=item B<-d>
+
+Use the B<-d> flag to print debugging information on standard error.  This
+will show the protocol transactions between B<innxmit> and the NNTP server
+on the remote host.
+
+=item B<-H>
+
+If the B<-H> flag is given, then only headers are sent to I<host> for all
+articles except control messages.  And the Bytes: header is also included
+even if it does not exist in the original article.  The B<-H> flag is useful
+for Diablo reader.
+
+=item B<-l>
+
+The B<-l> flag is used to turn on logging of reasons the remote gives
+for rejecting an article.
+
+=item B<-P> I<portnum>
+
+To specify a port number other than the default, use the B<-P> flag.
+
+=item B<-p>
+
+If the B<-p> flag is given, then no connection is made and the batchfile
+is purged of entries that refer to files that no longer exist.  This
+implies the B<-a> flag.
+
+=item B<-r>
+
+If the remote server sends an unexpected reply code, B<innxmit> will
+requeue the article and proceed.  Use the B<-r> flag if the article
+should not be requeued.
+
+=item B<-s>
+
+B<innxmit> will attempt to negotiate a streaming mode extension of the NNTP
+protocol with the server at connect time.  If successful, it will use a slightly
+different protocol that enhances throughput.  If the server does not recognize
+the streaming mode negotiation, B<innxmit> will revert to normal NNTP transfer
+mode.  Use the B<-s> flag to disable the attempt to negotiate the streaming mode
+extension.
+
+=item B<-T> I<seconds>
+
+To specify the total amount of time that should be allowed for article transfers,
+use the B<-T> flag.  The default is to wait until an I/O error occurs, or all
+the articles have been transferred.  If the B<-T> flag is used, the time is
+checked just before each article is started; it will not abort a transfer
+that is in progress.
+
+=item B<-t> I<seconds>
+
+B<innxmit> normally blocks until the connection is made.  To specify a timeout
+on how long to try to make the connection, use  the B<-t> flag.
+
+=item B<-v>
+
+Upon exit, B<innxmit> reports transfer and CPU usage statistics via syslog.
+If the B<-v> flag is used, they will also be printed on the standard output.
+
+=back
+
+=head1 HISTORY
+
+Written by Rich $alz <rsalz at uunet.uu.net> for InterNetNews. Converted to POD
+by Julien Elie.
+
+$Id$
+
+=head1 SEE ALSO
+
+ctlinnd(8), inn.conf(5), innd(8), newsfeeds(5), shlock(1).
+
+=cut




More information about the inn-committers mailing list