chiark / gitweb /
debugging for thing that crashed
[innduct.git] / doc / man / inews.1
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "INEWS 1"
132 .TH INEWS 1 "2008-04-06" "INN 2.4.5" "InterNetNews Documentation"
133 .SH "NAME"
134 inews \- Post a Usenet article to the local news server
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 \&\fBinews\fR [\fB\-ADhNORSVW\fR] [\fB\-acdeFfnortwx\fR \fIvalue\fR] [\fB\-p\fR \fIport\fR] [\fIfile\fR]
138 .SH "DESCRIPTION"
139 .IX Header "DESCRIPTION"
140 \&\fBinews\fR reads a Usenet news article, perhaps with headers, from \fIfile\fR
141 or standard input if no file is given.  It adds some headers and performs
142 some consistency checks.  If the article does not meet those checks, the
143 article is rejected.  If it passes the checks, \fBinews\fR sends the article
144 to the local news server as specified in \fIinn.conf\fR.
145 .PP
146 By default, if a file named \fI.signature\fR exists in the home directory of
147 the posting user, it is appended to the post, preceeded by a line that
148 contains only \f(CW\*(C`\-\- \*(C'\fR.  Signatures are not allowed to be more than four
149 lines long.
150 .PP
151 Cancel messages can only be posted with \fBinews\fR if the sender of the
152 cancel message matches the sender of the original message being
153 cancelled.  The same check is also applied to Supersedes.  Sender in this
154 case means the contents of the Sender header if present, otherwise the
155 From header.
156 .PP
157 Control messages other than cancel messages are only allowed if \fBinews\fR
158 is being run by the news user or by a user in the news group and if the
159 control message is recognized.  If the article contains a Distribution
160 header with a distribution that matches one of the bad distribution
161 patterns in \fIinn/options.h\fR (anything containing a period by default),
162 the message will be rejected.  The message will also be rejected if
163 \&\fIcheckincludedtext\fR is true in \fIinn.conf\fR, it contains more quoted text
164 than original text, and it is over 40 lines long.
165 .PP
166 If not provided, the Path header of an article is constructed as follows:
167 The basic Path header will be \*(L"not\-for\-mail\*(R".  If \fIpathhost\fR is specified
168 in \fIinn.conf\fR, it will be added to the beginning Path.  Otherwise, if
169 \&\fIserver\fR is specified, the full domain of the local host will be added to
170 the beginning of the Path.  Then, if \fB\-x\fR was given, its value will be
171 added to the beginning of the Path.
172 .PP
173 If posting fails, a copy of the failed post will be saved in a file named
174 \&\fIdead.article\fR in the home directory of the user running \fBinews\fR.
175 \&\fBinews\fR exits with a non-zero status if posting failed or with a zero
176 status if posting was successful.
177 .SH "OPTIONS"
178 .IX Header "OPTIONS"
179 Most of the options to \fBinews\fR take a single value and set the
180 corresponding header in the message that is posted.  If the value is more
181 than one word or contains any shell metacharacters, it must be quoted to
182 protect it from the shell.  Here are all the options that set header
183 fields and the corresponding header:
184 .PP
185 .Vb 12
186 \&    \-a  Approved
187 \&    \-c  Control
188 \&    \-d  Distribution
189 \&    \-e  Expires
190 \&    \-F  References
191 \&    \-f  From
192 \&    \-n  Newsgroups
193 \&    \-o  Organization
194 \&    \-r  Reply\-To
195 \&    \-t  Subject
196 \&    \-w  Followup\-To
197 \&    \-x  Path prefix
198 .Ve
199 .PP
200 The \fB\-x\fR argument will be added to the beginning of the normal Path
201 header; it will not replace it.
202 .IP "\fB\-A\fR, \fB\-V\fR, \fB\-W\fR" 4
203 .IX Item "-A, -V, -W"
204 Accepted for compatibility with C News.  These options have no affect.
205 .IP "\fB\-D\fR, \fB\-N\fR" 4
206 .IX Item "-D, -N"
207 Perform the consistency checks and add headers where appropriate, but then
208 print the article to standard output rather than sending it to the server.
209 \&\fB\-N\fR is accepted as as synonym for compatibility with C News.
210 .IP "\fB\-h\fR" 4
211 .IX Item "-h"
212 Normally, this flag should always be given.  It indicates that the article
213 consists of headers, a blank line, and then the message body.  If it is
214 omitted, the input is taken to be just the body of the message, and any
215 desired headers have to be specified with command-line options as
216 described above.
217 .IP "\fB\-O\fR" 4
218 .IX Item "-O"
219 By default, an Organization header will be added if none is present in the
220 article.  To prevent adding the default (from \fIorganization\fR in
221 \&\fIinn.conf\fR), use this flag.
222 .IP "\fB\-p\fR \fIport\fR" 4
223 .IX Item "-p port"
224 Connect to the specified port on the server rather than to the default
225 (port 119).
226 .IP "\fB\-R\fR" 4
227 .IX Item "-R"
228 Reject all control messages.
229 .IP "\fB\-S\fR" 4
230 .IX Item "-S"
231 Do not attempt to append \fI~/.signature\fR to the message, even if it
232 exists.
233 .SH "NOTES"
234 .IX Header "NOTES"
235 If the \s-1NNTP\s0 server requests authentication, \fBinews\fR will try to read
236 \&\fIpasswd.nntp\fR to get the username and password to use and will therefore
237 need read access to that file.  This is typically done by making that file
238 group-readable and adding all users who should be able to use \fBinews\fR to
239 post to that server to the appropriate group.
240 .PP
241 \&\fBinews\fR used to do even more than it does now, and all of the remaining
242 checks that are not dependent on the user running \fBinews\fR should probably
243 be removed in favor of letting the news server handle them.
244 .PP
245 Since \s-1INN\s0's \fBinews\fR uses \fIinn.conf\fR and some other corners of an \s-1INN\s0
246 installation, it's not very appropriate as a general stand-alone \fBinews\fR
247 program for general use on a system that's not running a news server.
248 Other, more suitable versions of \fBinews\fR are available as part of various
249 Unix news clients or by themselves.
250 .SH "HISTORY"
251 .IX Header "HISTORY"
252 Written by Rich \f(CW$alz\fR <rsalz@uunet.uu.net> for InterNetNews.  Rewritten in
253 \&\s-1POD\s0 by Russ Allbery <rra@stanford.edu>.
254 .SH "SEE ALSO"
255 .IX Header "SEE ALSO"
256 \&\fIinn.conf\fR\|(5), \fIrnews\fR\|(1)