INN commit: branches/2.5 (10 files)

INN Commit rra at isc.org
Thu May 20 18:54:25 UTC 2010


    Date: Thursday, May 20, 2010 @ 11:54:25
  Author: iulius
Revision: 9060

Convert nntpsend and nntpsend.ctl documentation to POD.
Better nntpsend.ctl sample configuration file.

Fixes:
* The -a flag is given only when there is no size limit.
* The -d and -D flags were incorrectly described (reported
  by Matthew Vernon).
* The -S flag does not exist for nntpsend.
* When the -n flag is used, nntpsend does not sleep
  before spawning each innxmit child.
* In nntpsend.ctl documentation, trunc(1) does not exist;
  it is shrinkfile(1).

Added:
  branches/2.5/doc/pod/nntpsend.ctl.pod
    (from rev 9058, trunk/doc/pod/nntpsend.ctl.pod)
  branches/2.5/doc/pod/nntpsend.pod
    (from rev 9058, trunk/doc/pod/nntpsend.pod)
Modified:
  branches/2.5/CONTRIBUTORS
  branches/2.5/MANIFEST
  branches/2.5/backends/nntpsend.in
  branches/2.5/doc/man/	(properties)
  branches/2.5/doc/pod/Makefile
  branches/2.5/samples/nntpsend.ctl
Deleted:
  branches/2.5/doc/man/nntpsend.8
  branches/2.5/doc/man/nntpsend.ctl.5

--------------------------+
 CONTRIBUTORS             |    2 
 MANIFEST                 |    2 
 backends/nntpsend.in     |   56 ++++------
 doc/man/nntpsend.8       |  247 ---------------------------------------------
 doc/man/nntpsend.ctl.5   |   46 --------
 doc/pod/Makefile         |    9 +
 doc/pod/nntpsend.ctl.pod |   42 +++++++
 doc/pod/nntpsend.pod     |  124 ++++++++++++++++++++++
 samples/nntpsend.ctl     |   32 +++--
 9 files changed, 216 insertions(+), 344 deletions(-)

Modified: CONTRIBUTORS
===================================================================
--- CONTRIBUTORS	2010-05-20 18:53:46 UTC (rev 9059)
+++ CONTRIBUTORS	2010-05-20 18:54:25 UTC (rev 9060)
@@ -272,4 +272,4 @@
 Wolfgang M. Weyand, Berend Reitsma, William Kronert, Petr Novopashenniy,
 Steve Crook, John F. Morse, Tim Woodall, Jonathan Kamens, Kamil Jonca,
 S.P. Zeidler, Nix, Florian Schlichting, Torsten Jerzembeck, Harald Dunkel,
-Lars Magne Ingebrigtsen, Sam Varshavchik
+Lars Magne Ingebrigtsen, Sam Varshavchik, Matthew Vernon

Modified: MANIFEST
===================================================================
--- MANIFEST	2010-05-20 18:53:46 UTC (rev 9059)
+++ MANIFEST	2010-05-20 18:54:25 UTC (rev 9060)
@@ -285,6 +285,8 @@
 doc/pod/newslog.pod                   Master file for newslog.5
 doc/pod/ninpaths.pod                  Master file for ninpaths.8
 doc/pod/nnrpd.pod                     Master file for nnrpd.8
+doc/pod/nntpsend.ctl.pod              Master file for nntpsend.ctl.5
+doc/pod/nntpsend.pod                  Master file for nntpsend.8
 doc/pod/ovdb.pod                      Master file for ovdb.5
 doc/pod/ovdb_init.pod                 Master file for ovdb_init.8
 doc/pod/ovdb_monitor.pod              Master file for ovdb_monitor.8

Modified: backends/nntpsend.in
===================================================================
--- backends/nntpsend.in	2010-05-20 18:53:46 UTC (rev 9059)
+++ backends/nntpsend.in	2010-05-20 18:54:25 UTC (rev 9060)
@@ -1,23 +1,24 @@
 #! /bin/sh
 # fixscript will replace this line with code to load innshellvars
 
-##  $Revision$
+##  $Id$
 ##  Send news via NNTP by running several innxmit processes in the background.
 ##  Usage:
-##	nntpsend [-n][-p][-r][-s size][-S][-t timeout][-T limit][host fqdn]...
-##	-a		Always have innxmit rewrite the batchfile
-##	-d		debug mode, run innxmits with debug as well
-##	-D		same as -d except innxmits are not debugged
-##	-p		Run innxmit with -p to prune batch files
-##	-r		innxmit, don't requeue on unexpected error code
-##	-s size		limit the =n file to size bytes
+##	nntpsend [-acDdlNnpr] [-P portnum] [-s size] [-T limit] [-t timeout]
+##		 [-w delay] [host fqdn] ...
+##	-a		always have innxmit rewrite the batch file (if no size limit)
 ##	-c		disable message-ID checking in streaming mode
-##	-t timeout	innxmit timeout to make connection (def: 180)
-##	-T limit	innxmit connection transmit time limit (def: forever)
-##	-P portnum	port number to use
+##	-D		debug mode, send output to stdout
+##	-d		same as -d, and run innxmit with debug as well
 ##	-l		innxmit, log rejected articles
 ##	-N		innxmit, disable streaming mode
 ##	-n		do not lock for nntpsend, do not sleep between sets
+##	-P portnum	port number to use
+##	-p		run innxmit with -p to prune batch files
+##	-r		innxmit, don't requeue on unexpected error code
+##	-s size		limit the file to size bytes
+##	-T limit	innxmit connection transmit time limit (def: forever)
+##	-t timeout	innxmit timeout to make connection (def: 180)
 ##	-w delay	wait delay seconds just before innxmit
 ##	host fqdn	send to host and qualified domain (def: nntpsend.ctl)
 ##  If no "host fqdn" pairs appear on the command line, then ${CTLFILE}
@@ -34,10 +35,9 @@
 NO_LOG_FLAG=
 P_FLAG=
 R_FLAG=
-S_FLAG=
 C_FLAG=
 L_FLAG=
-S2_FLAG=
+S_FLAG=
 TRUNC_SIZE=
 T_FLAG=
 TIMELIMIT=
@@ -68,11 +68,8 @@
     X-r)
 	R_FLAG="-r"
 	;;
-    X-S)
-	S_FLAG="-S"
-	;;
     X-N)
-	S2_FLAG="-s"
+	S_FLAG="-s"
 	;;
     X-c)
 	C_FLAG="-c"
@@ -147,12 +144,12 @@
     ${MORETODO} && shift
 done
 
-## grab the lock if not -n
+##  Grab the lock if not -n.
 NNTPLOCK=${LOCKS}/LOCK.nntpsend
 if [ -z "${NOLOCK}" ]; then
     shlock -p $$ -f ${NNTPLOCK} || {
-	# nothing to do
-	exit 0
+        # Nothing to do.
+        exit 0
     }
 fi
 
@@ -234,7 +231,6 @@
     D_PARAM=
     R_PARAM=
     S_PARAM=
-    S2_PARAM=
     C_PARAM=
     PP_PARAM=
     L_PARAM=
@@ -262,11 +258,8 @@
 	X-r)
 	    R_PARAM="-r"
 	    ;;
-	X-S)
-	    S_PARAM="-S"
-	    ;;
 	X-s)
-	    S2_PARAM="-s"
+	    S_PARAM="-s"
 	    ;;
 	X-l)
 	    L_PARAM="-l"
@@ -359,11 +352,6 @@
     else
 	test -n "${S_PARAM}" && INNFLAGS="${INNFLAGS} ${S_PARAM}"
     fi
-    if [ -n "${S2_FLAG}" ]; then
-	INNFLAGS="${INNFLAGS} ${S2_FLAG}"
-    else
-	test -n "${S2_PARAM}" && INNFLAGS="${INNFLAGS} ${S2_PARAM}"
-    fi
     if [ -n "${T_FLAG}" ]; then
 	INNFLAGS="${INNFLAGS} ${T_FLAG}"
     else
@@ -399,7 +387,7 @@
 	    cat ${SITE}.work >>"${BATCHFILE}"
 	    rm -f ${SITE}.work
 	else
-	    # flush failed, continue if we have any batchfile to work on
+	    # flush failed, continue if we have any batch file to work on
 	    echo "${PROGNAME}: bad flush for ${HOST} via ${SITE}"
 	    if [ -f "${BATCHFILE}" ]; then
 		echo "${PROGNAME}: trying ${HOST} via ${SITE} anyway"
@@ -458,15 +446,15 @@
     ' &
 done
 
-## release the nntpsend lock and clean up before we wait on child processes
+##  Release the nntpsend lock and clean up before we wait on child processes.
 if [ -z "${NOLOCK}" ]; then
     rm -f ${NNTPLOCK}
 fi
 rm -f ${INPUT}
 
-## wait for child processes to finish
+##  Wait for child processes to finish.
 wait
 
-## all done
+##  All done.
 echo "${PROGNAME}: [${PARENTPID}] stop"
 exit 0


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
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

   + 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
nntpsend.8
nntpsend.ctl.5
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/nntpsend.8
===================================================================
--- doc/man/nntpsend.8	2010-05-20 18:53:46 UTC (rev 9059)
+++ doc/man/nntpsend.8	2010-05-20 18:54:25 UTC (rev 9060)
@@ -1,247 +0,0 @@
-.TH NNTPSEND 8
-.SH NAME
-nntpsend \- send Usenet articles to remote site
-.SH SYNOPSIS
-.B nntpsend
-[
-.B \-a
-]
-[
-.B \-c
-]
-[
-.B \-D
-]
-[
-.B \-d
-]
-[
-.B \-l
-]
-[
-.B \-N
-]
-[
-.B \-n
-]
-[
-.BI \-P " portnum"
-]
-[
-.B \-p
-]
-[
-.B \-r
-]
-[
-.B \-S
-]
-[
-.BI \-s " size"
-]
-[
-.BI \-T " timelimit"
-]
-[
-.BI \-t " timeout"
-]
-[
-.BI \-w " delay"
-]
-[
-.I sitename
-.I fqdn
-] ...
-.SH DESCRIPTION
-.I Nntpsend
-is a front-end that invokes
-.IR innxmit (1)
-to send Usenet articles to a remote NNTP site.
-.PP
-The sites to be fed may be specified by giving
-.I sitename
-.I fqdn
-pairs on the command line.
-If no such pairs are given,
-.I nntpsend
-defaults to the information given in the
-.I nntpsend.ctl
-config file.
-.PP
-The
-.I sitename
-should be the name of the site as specified in the
-.IR newsfeeds (5) 
-file.
-The 
-.I fqdn 
-should be the hostname or IP address of the remote site.
-.PP
-An
-.I innxmit
-is launched for sites with queued news.
-All
-.I innxmit
-processes are spawned in the background and the script waits for
-them all to finish before returning.
-Output is sent to the file
-.IR <pathlog\ in\ inn.conf>/nntpsend.log .
-In order to keep from overwhelming the local system, 
-.I nntpsend
-waits five seconds before spawning each child.
-.PP
-.I Nntpsend
-expects that the batchfile for a site is named
-.IR <pathoutgoing\ in\ inn.conf>/sitename .
-To prevent batchfile corruption,
-.IR shlock (1)
-is used to ``lock'' these files.
-.PP
-When
-.I sitename
-.I fqdn
-pairs are given on the command line, 
-any flags given on the command completely describe how
-.I innxmit
-and
-.I shrinkfile
-operate.
-When no such pairs are given on the command line, then
-the information found in
-.I nntpsend.ctl
-becomes the default flags for that site.
-Any flags given on the command line override the default flags
-for the site.
-.SH OPTIONS
-.TP
-.B "\-d \-D"
-The ``\-d'' flag causes
-.I nntpsend
-to send output to stdout rather than the log file
-.IR <pathlog\ in\ inn.conf>/nntpsend.log .
-The ``\-D'' flag does the same
-and it passes ``\-d'' to all
-.I innxmit
-invocations, which in turn causes
-.I innxmit
-to go into debug mode.
-.TP
-.B -n
-If the ``\-n'' flag is used, then
-.I nntpsend
-does not use
-.IR shlock (1)
-and does not lock batch files.
-.TP
-.B \-s size
-If the ``\-s'' flag is used, then
-.IR shrinkfile (1)
-will be invoked to perform a head truncation on the batchfile and the flag
-will be passed to it.
-.TP
-.B \-w delay
-If the ``\-w'' flag is used, then
-.I nntpsend
-waits for
-.I delay
-seconds after flushing the site before launching
-.IR innxmit .
-.TP
-.B "\-a \-c \-l \-N \-P \-p \-r \-S \-T \-t"
-The ``\fB\-a\fP'', ``\fB\-c\fP'', ``\fB\-l\fP'', ``\fB\-P\fP'', ``\fB\-p\fP'',
-``\fB\-r\fP'', \``\fB\-S\fP'', ``\fB\-T\fP'' and ``\fB\-t\fP''
-flags are passed on to the child
-.I innxmit
-program. The ``\-N'' flag is passed as ``\fB\-s\fP'' flag to the child
-.I innxmit
-program.
-See 
-.IR innxmit (8)
-for more details.
-Note that if the ``\-p'' flag is used then no connection is made and
-no articles are fed to the remote site.
-It is useful to have
-.IR cron (8)
-invoke
-.I nntpsend
-with this flag in case a site cannot be reached for an extended period of time.
-.SH EXAMPLES
-With the following
-.IR nntpsend.ctl (5)
-control file:
-.PP
-.RS
-.nf
-nsavax:erehwon.nsavax.gov::-S -t60
-group70:group70.org::
-walldrug:walldrug.com:4m-1m:-T1800 -t300
-kremvax:kremvax.cis:2m:
-.fi
-.RE
-.PP
-The command:
-.PP
-.RS
-nntpsend
-.PP
-.RE
-will result in the following:
-.PP
-.RS
-.nf
-Sitename        Truncation      Innxmit flags
-nsavax          (none)          \-a \-S \-t60
-group70         (none)          \-a \-t180
-walldrug        1m if >4m       \-a \-T1800 \-t300
-kremvax         2m              \-a \-t180
-.fi
-.RE
-.PP
-The command:
-.PP
-.RS
-nntpsend \-d \-T1200
-.RE
-.PP
-will result in the following:
-.PP
-.RS
-.nf
-Sitename        Truncation      Innxmit flags
-nsavax          (none)          \-a \-d \-S \-T1200 \-t60
-group70         (none)          \-a \-d \-T1200 \-t180
-walldrug        1m if >4m       \-a \-d \-T1200 \-t300
-kremvax         2m              \-a \-d \-T1200 \-t180
-.fi
-.RE
-.PP
-The command:
-.PP
-.RS
-nntpsend \-s 5m \-T1200 nsavax erehwon.nsavax.gov group70 group70.org
-.PP
-.RE
-will result in the following:
-.PP
-.RS
-.nf
-Sitename        Truncation      Innxmit flags
-nsavax          5m              \-a \-T1200 \-t180
-group70         5m              \-a \-T1200 \-t180
-.fi
-.RE
-.PP
-Remember that ``\-a'' is always given, and ``\-t'' defaults to 180.
-.SH HISTORY
-Written by Landon Curt Noll <chongo at toad.com>
-and Rich $alz <rsalz at uunet.uu.net> for InterNetNews.
-.de R$
-This is revision \\$3, dated \\$4.
-..
-.R$ $Id$
-.SH "SEE ALSO"
-inn.conf(5),
-innxmit(1), 
-newsfeeds(5),
-nntpsend.ctl(5),
-shrinkfile(1).

Deleted: doc/man/nntpsend.ctl.5
===================================================================
--- doc/man/nntpsend.ctl.5	2010-05-20 18:53:46 UTC (rev 9059)
+++ doc/man/nntpsend.ctl.5	2010-05-20 18:54:25 UTC (rev 9060)
@@ -1,46 +0,0 @@
-.TH NNTPSEND.CTL 5
-.SH NAME
-nntpsend.ctl \- list of sites to feed via nntpsend
-.SH DESCRIPTION
-The file
-.I <pathetc in inn.conf>/nntpsend.ctl
-specifies the default list of sites to be fed by
-.IR nntpsend (8).
-.PP
-Comments begin with a number sign (``#'') and continue through the end
-of the line.
-Blank lines and comments are ignored.
-All other lines should consist of four fields separated by a colon.
-.PP
-The first field is the name of the site as specified in the
-.I newsfeeds
-file.
-.PP
-The second field should be the hostname or IP address of the remote site.
-.PP
-The third field, if non-empty, specifies the default head truncation size of
-site's batchfile.
-If this field is empty, no truncation is performed.
-This field may be of the form ``\fRmaxsize-truncsize\fP'', in which case  it
-is passed to
-.I shrinkfile
-as ``\fR\-m maxsize \-s truncsize\fP''; otherwise it is of the form
-``\fRtruncsize\fP'', in which case it is passed as ``\fR\-s truncsize\fP''.
-.PP
-The fourth field specifies some default flags passed to
-.IR innxmit (8).
-The flag ``\-a'' is always given to
-.I innxmit
-and need not appear here.
-If no ``\-t timeout'' flag is given in this field or on the
-.I nntpsend
-command line, ``\-t\ 180'' will be given to
-.IR innxmit .
-.SH HISTORY
-Written by Landon Curt Noll <chongo at toad.com> for InterNetNews.
-.de R$
-This is revision \\$3, dated \\$4.
-..
-.R$ $Id$
-.SH "SEE ALSO"
-innxmit(8), newsfeeds(5), nntpsend(8), trunc(1).

Modified: doc/pod/Makefile
===================================================================
--- doc/pod/Makefile	2010-05-20 18:53:46 UTC (rev 9059)
+++ doc/pod/Makefile	2010-05-20 18:54:25 UTC (rev 9060)
@@ -23,7 +23,7 @@
 	../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/newslog.5 ../man/nntpsend.ctl.5 ../man/ovdb.5 \
 	../man/passwd.nntp.5 ../man/radius.conf.5 ../man/readers.conf.5 \
 	../man/storage.conf.5 ../man/subscriptions.5
 
@@ -32,11 +32,12 @@
 	../man/ckpasswd.8 ../man/cnfsheadconf.8 ../man/cnfsstat.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/expirerm.8 ../man/ident.8 \
+	../man/innbind.8 ../man/innd.8 ../man/inndf.8 ../man/innupgrade.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 \
+	../man/nnrpd.8 ../man/nntpsend.8 \
 	../man/ovdb_init.8 ../man/ovdb_monitor.8 ../man/ovdb_server.8 \
 	../man/ovdb_stat.8 ../man/overchan.8 \
         ../man/prunehistory.8 ../man/radius.8 \
@@ -97,6 +98,7 @@
 ../man/newsfeeds.5:	newsfeeds.pod		; $(POD2MAN) -s 5 $? > $@
 ../man/newsgroups.5:	newsgroups.pod		; $(POD2MAN) -s 5 $? > $@
 ../man/newslog.5:	newslog.pod		; $(POD2MAN) -s 5 $? > $@
+../man/nntpsend.ctl.5:	nntpsend.ctl.pod	; $(POD2MAN) -s 5 $? > $@
 ../man/ovdb.5:		ovdb.pod		; $(POD2MAN) -s 5 $? > $@
 ../man/passwd.nntp.5:	passwd.nntp.pod		; $(POD2MAN) -s 5 $? > $@
 ../man/radius.conf.5:	radius.conf.pod		; $(POD2MAN) -s 5 $? > $@
@@ -132,6 +134,7 @@
 ../man/news2mail.8:	news2mail.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/ninpaths.8:	ninpaths.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/nnrpd.8:		nnrpd.pod		; $(POD2MAN) -s 8 $? > $@
+../man/nntpsend.8:	nntpsend.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/ovdb_init.8:	ovdb_init.pod		; $(POD2MAN) -s 8 $? > $@
 ../man/ovdb_monitor.8:	ovdb_monitor.pod	; $(POD2MAN) -s 8 $? > $@
 ../man/ovdb_server.8:	ovdb_server.pod		; $(POD2MAN) -s 8 $? > $@

Copied: branches/2.5/doc/pod/nntpsend.ctl.pod (from rev 9058, trunk/doc/pod/nntpsend.ctl.pod)
===================================================================
--- doc/pod/nntpsend.ctl.pod	                        (rev 0)
+++ doc/pod/nntpsend.ctl.pod	2010-05-20 18:54:25 UTC (rev 9060)
@@ -0,0 +1,42 @@
+=head1 NAME
+
+nntpsend.ctl - List of sites to feed via nntpsend
+
+=head1 DESCRIPTION
+
+The file I<pathetc>/nntpsend.ctl specifies the default list of sites
+to be fed by B<nntpsend>.  Comments begin with a number sign (C<#>) and
+continue through the end of the line.  Blank lines and comments are ignored.
+All other lines should consist of four fields separated by a colon.
+
+The first field is the name of the site as specified in the F<newsfeeds>
+file.
+
+The second field should be the hostname or IP address of the remote site.
+
+The third field, if non-empty, specifies the default head truncation size
+of the batch file.  If this field is empty, no truncation is performed.
+This field may be of the form C<< I<maxsize>-I<truncsize> >>, in which
+case it is passed to B<shrinkfile> as C<< -m I<maxsize> -s I<truncsize>
+>>; otherwise it is of the form C<< I<truncsize> >>, in which case it is
+passed as C<< -s I<truncsize> >>.
+
+The fourth field specifies some default flags passed to B<innxmit>.  Note
+that the flag B<-a> is always given to B<innxmit> and need not appear here.
+If no B<-t> flag is given in this field or on the B<nntpsend> command line,
+C<-t 180> will be given to B<innxmit>.
+
+See nntpsend(8) for an example of F<nntpsend.ctl> config file.
+
+=head1 HISTORY
+
+Written by Landon Curt Noll <chongo at toad.com> for InterNetNews.  Converted to
+POD by Julien Elie.
+
+$Id$
+
+=head1 SEE ALSO
+
+innxmit(1), newsfeeds(5), nntpsend(8), shrinkfile(1).
+
+=cut

Copied: branches/2.5/doc/pod/nntpsend.pod (from rev 9058, trunk/doc/pod/nntpsend.pod)
===================================================================
--- doc/pod/nntpsend.pod	                        (rev 0)
+++ doc/pod/nntpsend.pod	2010-05-20 18:54:25 UTC (rev 9060)
@@ -0,0 +1,124 @@
+=head1 NAME
+
+nntpsend - Send Usenet articles to remote sites
+
+=head1 SYNOPSIS
+
+B<nntpsend> [B<-acDdlNnpr>] [B<-P> I<portnum>] [B<-s> I<size>]
+[B<-T> I<timelimit>] [B<-t> I<timeout>] [B<-w> I<delay>]
+[I<sitename> I<fqdn>] ...
+
+=head1 DESCRIPTION
+
+B<nntpsend> is a front-end that invokes B<innxmit> to send Usenet articles
+to a remote NNTP site.  The sites to be fed may be specified by giving
+I<sitename> I<fqdn> pairs on the command line.  If no such pairs are given,
+B<nntpsend> defaults to the information given in the F<nntpsend.ctl>
+config file.  The I<sitename> should be the name of the site as specified
+in the F<newsfeeds> file.  The I<fqdn> should be the hostname or IP address
+of the remote site.  An B<innxmit> is launched for sites with queued news.
+All B<innxmit> processes are spawned in the background and the script
+waits for them all to finish before returning.  Output is sent to the file
+F<nntpsend.log> in I<pathlog>.  In order to keep from overwhelming the
+local system, B<nntpsend> waits five seconds before spawning each child.
+
+B<nntpsend> expects that the batch file for a site is named I<sitename>
+in I<pathoutgoing>.  To prevent batch files corruption, B<shlock> is used to
+"lock" these files.  When I<sitename> I<fqdn> pairs are given on the command
+line, any flags given on the command completely describe how B<innxmit>
+and B<shrinkfile> operate.  When no such pairs are given on the command
+line, then the information found in F<nntpsend.ctl> becomes the default
+flags for that site.  Any flags given on the command line override the
+default flags for the site.
+
+=head1 OPTIONS
+
+=over 2
+
+=item B<-D>, B<-d>
+
+The B<-D> flag causes B<nntpsend> to send output to stdout rather than
+the log file F<nntpsend.log> in I<pathlog>.  The B<-d> flag does the same
+and it passes B<-d> to all B<innxmit> invocations, which in turn causes
+B<innxmit> to go into debug mode.
+
+=item B<-n>
+
+If the B<-n> flag is used, then B<nntpsend> does not use B<shlock> and
+does not lock batch files.  It also does not sleep before spawning each
+B<innxmit> child.
+
+=item B<-s> I<size>
+
+If the B<-s> flag is used, then B<shrinkfile> will be invoked to perform
+a head truncation of I<size> bytes on the batch file and the flag will be
+passed to it.
+
+=item B<-w> I<delay>
+
+If the B<-w> flag is used, then B<nntpsend> waits for I<delay> seconds
+after flushing the site before launching B<innxmit>.
+
+=item B<-a>, B<-c>, B<-l>, B<-N>, B<-P> I<portnum>, B<-p>, B<-r>, B<-T>
+I<timelimit>, B<-t> I<timeout>
+
+The B<-a>, B<-c>, B<-l>, B<-P> I<portnum>, B<-p>, B<-r>, B<-T> I<timelimit>
+and B<-t> I<timeout> flags are passed on to the child B<innxmit> program.
+The B<-N> flag is passed as B<-s> flag to the child B<innxmit> program.
+See innxmit(8) for more details.
+
+Note that if the B<-p> flag is used, then no connection is made and no
+articles are fed to the remote site.  It is useful to have cron(8) invoke
+B<nntpsend> with this flag in case a site cannot be reached for an extended
+period of time.
+
+=back
+
+=head1 EXAMPLES
+
+With the following F<nntpsend.ctl> config file:
+
+    nsavax:erehwon.nsavax.gov::-t60
+    group70:group70.org::
+    walldrug:walldrug.com:4m-1m:-T1800 -t300
+    kremvax:kremvax.cis:2m:
+
+the command C<nntpsend> will result in the following:
+
+    Sitename        Truncation      Innxmit flags
+    nsavax          (none)          -a -t60
+    group70         (none)          -a -t180
+    walldrug        1m if >4m       -T1800 -t300
+    kremvax         2m              -t180
+
+The command C<nntpsend -d -T1200> will result in the following:
+
+    Sitename        Truncation      Innxmit flags
+    nsavax          (none)          -a -d -T1200 -t60
+    group70         (none)          -a -d -T1200 -t180
+    walldrug        1m if >4m       -d -T1200 -t300
+    kremvax         2m              -d -T1200 -t180
+
+The command C<nntpsend -s 5m -T1200 nsavax erehwon.nsavax.gov group70
+group70.org> will result in the following:
+
+    Sitename        Truncation      Innxmit flags
+    nsavax          5m              -T1200 -t180
+    group70         5m              -T1200 -t180
+
+Remember that B<-a> is always given when there is no size limit, and B<-t>
+defaults to C<180>.
+
+=head1 HISTORY
+
+Written by Landon Curt Noll <chongo at toad.com> and Rich $alz
+<rsalz at uunet.uu.net> for InterNetNews.  Converted to POD by Julien Elie.
+
+$Id$
+
+=head1 SEE ALSO
+
+inn.conf(5), innxmit(1), newsfeeds(5), nntpsend.ctl(5), shlock(1),
+shrinkfile(1).
+
+=cut

Modified: samples/nntpsend.ctl
===================================================================
--- samples/nntpsend.ctl	2010-05-20 18:53:46 UTC (rev 9059)
+++ samples/nntpsend.ctl	2010-05-20 18:54:25 UTC (rev 9060)
@@ -1,15 +1,21 @@
-##  $Revision$
-##  Control file for nntpsend.
-## Format:
-##	site:fqdn:max_size:[<args...>]
-##	<site>		The name used in the newsfeeds file for this site;
-##			this determines the name of the batchfile, etc.
-##	<fqdn>		The fully-qualified domain name of the site,
-##			passed as the parameter to innxmit.
-##	<size>		Size to truncate batchfile if it gets too big;
-##			see shrinkfile(1).
-##	<args>		Other args to pass to innxmit
-##  Everything after the pound sign is ignored.
-#nsavax:erehwon.nsavax.gov::-S -t60
+##  $Id$
+##
+##  Sample nntpsend configuration file.
+##
+##  Format:
+##    site:fqdn:max_size:[<args...>]
+##      <site>        The name used in the newsfeeds file for this site;
+##                    this determines the name of the batch file.
+##      <fqdn>        The fully-qualified domain name of the site,
+##                    passed as the parameter to innxmit.
+##      <size>        Size to truncate batch file if it gets too big;
+##                    see shrinkfile(1).
+##      <args>        Other args to pass to innxmit.
+##
+##  Everything after the number sign (#) is ignored.
+##  See the nntpsend.ctl man page for more information.
+
+#nsavax:erehwon.nsavax.gov::-t60
+#group70:group70.org::
 #walldrug:walldrug.com:4m-1m:-T1800 -t300
 #kremvax:kremvax.cis:2m:




More information about the inn-committers mailing list