doc/man/rnews.1

   1 .\" $Revision: 5909 $
   2 .TH RNEWS 1
   3 .SH NAME
   4 rnews \- receive news from a UUCP connection
   5 .SH SYNOPSIS
   6 .B rnews
   7 [
   8 .BI \-h " host"
   9 ]
  10 [
  11 .B \-N
  12 ]
  13 [
  14 .BI \-P " port"
  15 ]
  16 [
  17 .BI \-r " remote"
  18 ]
  19 [
  20 .BI \-S " remote"
  21 ]
  22 [
  23 .B \-U
  24 ]
  25 [
  26 .B \-v
  27 ]
  28 [
  29 .I input
  30 ]
  31 .SH DESCRIPTION
  32 .I Rnews
  33 reads messages typically queued by a UUCP newsfeed and
  34 sends them to the InterNetNews server (either ``localhost'', or the
  35 value defined by the variable
  36 .IR <nnrpdposthost\ in\ inn.conf> .
  37 .PP
  38 The message is read from the specified input file, or standard input
  39 if no input is named.
  40 .PP
  41 When sent over UUCP, Usenet articles are typically joined in a single
  42 batch to reduce the UUCP overhead.
  43 Batches can also be compressed, to reduce the communication time.
  44 If a message does not start with a number sign (``#'') and an exclamation
  45 point, then the entire input is taken as a single news article.
  46 If it does start with with those two characters, then the first line is
  47 read and interpreted as a batch command.
  48 .PP
  49 If the command is ``#! rnews nnn'' where
  50 .I nnn
  51 is a number, then the next
  52 .I nnn
  53 bytes (starting with the next line) are read as a news article.
  54 .PP
  55 If the command is ``#! cunbatch'' then the rest of input is fed to the
  56 .IR compress (1)
  57 program with the ``\-d'' flag to uncompress it, and
  58 the output of this pipe is read as
  59 .IR rnews 's
  60 input.
  61 This is for historical compatibility \(em there is no program named
  62 .IR cunbatch .
  63 A compressed batch will start with a ``#! cunbatch'' line, then contain a
  64 series of articles separated by ``#! rnews nnn'' lines.
  65 If
  66 .I <DO_RNEWSPROGS in include/config.h>
  67 is defined and the command is any other word, then
  68 .I rnews
  69 will try to execute a program with that name in the directory
  70 .IR <pathbin\ in\ inn.conf>/bin/rnews.libexec .
  71
  72 The batch will be fed into the program's standard input, and the
  73 standard output will be read back as input into
  74 .IR rnews .
  75 If
  76 .I <DO_RNEWS_SAVE_BAD in include/config.h>
  77 is defined and
  78 .I rnews
  79 detects any problems with an article such as a missing header, or
  80 an unintelligible reply from the server, it will save a copy of the article
  81 in the
  82 .I <pathincoming in inn.conf>/bad
  83 directory.
  84 .SH OPTIONS
  85 .TP
  86 .B \-h
  87 If the ``\fB\-h\fP'' flag is given, then
  88 .I rnews
  89 will log the Message-ID and host via
  90 .IR syslog (3)
  91 for each article offered to the server.
  92 Logging will only be done if the value is not an empty string.
  93 If ``\fB\-h\fP'' is not set, the environment variable
  94 .I <_ENV_UUCPHOST in include/paths.h>
  95 (typically
  96 .IR $UU_MACHINE )
  97 will be examined for a similar string.
  98 .TP
  99 .B \-N
 100 Normally, if unpacking the input fails it is re-spooled to
 101 .I <pathincoming in inn.conf>
 102 for another attempt later.  If the ``\fB\-N\fP'' flag is used then no such
 103 re-spooling is done and rnews exits with status value ``9'' to indicate
 104 this.
 105 .TP
 106 .B \-P
 107 If the ``\fB\-P\fP'' flag is used, then the articles will be sent to the
 108 specified port on the remote host.
 109 .TP
 110 .B \-r
 111 If the ``\fB\-r\fP'' flag is used, then the articles will be sent to the
 112 named remote host instead of the default host.
 113 .TP
 114 .B \-S
 115 \&``\fB\-S\fP'' flag is equivalent to ``\fB\-r\fP'' flag.
 116 .TP
 117 .B \-U
 118 If the server is not available, the message is spooled into a new file
 119 created in the
 120 .I <pathincoming in inn.conf>
 121 directory.
 122 The ``\fB\-U\fP'' flag may be used to send all spooled messages to the
 123 server once it becomes available again, and can be invoked regularly
 124 by
 125 .IR cron (8).
 126 .TP
 127 .B \-v
 128 If the ``\fB\-v\fP'' flag is used, it will print a notice of all errors on the
 129 standard error, naming the input file (if known) and printing the first
 130 few characters of the input.
 131 Errors are always logged through
 132 .IR syslog (3).
 133 .SH BUGS
 134 .I Rnews
 135 cannot process articles that have embedded ``\e0'' characters in them.
 136 .SH HISTORY
 137 Written by Rich $alz <rsalz@uunet.uu.net> for InterNetNews.
 138 .de R$
 139 This is revision \\$3, dated \\$4.
 140 ..
 141 .R$ $Id: rnews.1 5909 2002-12-03 05:17:18Z vinocur $
 142 .SH "SEE ALSO"
 143 inn.conf(5),
 144 innd(8).