chiark / gitweb /
debugging for thing that crashed
[innduct.git] / doc / man / newslog.5
1 .TH NEWSLOG 5
2 .SH NAME
3 newslog \- description of Usenet log files
4 .SH DESCRIPTION
5 Most log files created by Usenet programs reside in the
6 .I <pathlog in inn.conf>
7 directory and have a ``.log'' extension.
8 Several versions are usually kept with an additional extension such as ``.1'',
9 ``.2'', etc. \(em the higher the number, the older the log.
10 The older versions may be compressed and thus may have a ``.1.gz'',
11 ``.2.gz'', etc. extension.
12 .PP
13 The
14 .I scanlogs
15 script and related utilities (see
16 .IR scanlogs (8))
17 are responsible for rotating and compressing these files.
18 .PP
19 Some log files always have data, others only have data if there is a
20 problem, and others are only created if a particular program is used
21 or configuration parameter is set.
22 The
23 .I innstat
24 script (see
25 .IR innstat (8))
26 monitors the size of all log files.
27 .PP
28 The following files will only accumulate data under the direction of
29 .IR control.ctl (5):
30 .sp 1
31 .RS
32 control.log
33 miscctl.log
34 newgroup.log
35 rmgroup.log
36 unwanted.log
37 .RE
38 .sp 1
39 In order to create these files, the ``message'' and ``action'' fields of
40 .I control.ctl
41 should be chosen from the following table:
42 .sp 1
43 .RS
44 .nf
45 .ta \w'newgroup    'u +\w'doit=newgroup  'u
46 Message Action  Meaning
47 all     log=miscctl     Log all messages by default
48 default log=miscctl     Log unknown messages
49 newgroup        doit=newgroup   Create group and log message
50 newgroup        log=newgroup    Log message
51 rmgroup doit=rmgroup    Remove group and log message
52 rmgroup log=rmgroup     Log message
53 ``other''       doit=miscctl    log and process the message
54 ``other''       log=miscctl     Log message
55 .fi
56 .RE
57 .sp 1
58 Here, ``other'' refers to any other control message such as:
59 .sp 1
60 .RS
61 .nf
62 checkgroups
63 ihave
64 sendme
65 sendsys
66 senduuname
67 version
68 .fi
69 .RE
70 .PP
71 The following is a list of log files:
72 .TP
73 .I control.log
74 This file maintains a count of the number of newgroup and rmgroup control
75 messages seen for each newsgroup.
76 The count is of the number of control messages with the indicated
77 arguments, regardless if they were actually processed.
78 All control arguments, including invalid ones, are counted.
79 This file is updated by
80 .IR tally.control ,
81 which is invoked by
82 .I scanlogs
83 if either the newgroup or rmgroup logs exist.
84 This file is not rotated.
85 .TP
86 .I errlog
87 This file contains the standard output and standard error of any program
88 spawned by
89 .IR innd (8),
90 such as channel feeds configured in
91 .IR newsfeeds .
92 This file should normally be empty.
93 .I Scanlogs
94 will print the entire contents of this log file if it is non-empty.
95 .TP
96 .I expire.log
97 By default, when
98 .I news.daily
99 is going to expire old news articles, it writes the date to this file,
100 followed by any output from
101 .IR expire (8)
102 and the ending date.
103 All lines but the first are indented four spaces.
104 .TP
105 .I miscctl.log
106 When
107 .I control.ctl
108 is configured as described above, all control messages except newgroup
109 and rmgroup are appended to this file by
110 .IR writelog .
111 There will be a summary line describing the message and the action
112 taken, followed by the article indented by four spaces, and a blank line.
113 .TP
114 .I newgroup.log
115 When
116 .I control.ctl
117 is configured as described above, all newgroup messages are appended
118 to this file using the same format as for
119 .IR miscctl.log .
120 .TP
121 .I news
122 This file logs articles received by
123 .IR innd .
124 .I Scanlogs
125 summarizes the rejected articles reported in this file.
126 .TP
127 .I news.crit
128 All critical error messages issued by
129 .I innd
130 are appended to this file via
131 .IR syslog (3).
132 This log file should be empty.
133 .I Scanlogs
134 will print the entire contents of this log file if it is non-empty.
135 You should have the following line in your system
136 .I syslog.conf
137 file, using a tab character for the delimiter:
138 .sp 1
139 .RS
140 .RS
141 news.crit  <pathlog in inn.conf>/news.crit
142 .RE
143 .RE
144 .sp 1
145 (A typical entry is shown; it should agree with
146 .I <pathlog in inn.conf>.)
147 .TP
148 .I news.err
149 All major error messages issued by
150 .I innd
151 are appended to this file via
152 .IR syslog (3).
153 This log file should be empty.
154 .I Scanlogs
155 will print the entire contents of this log file if it is non-empty.
156 You should have the following line in your system
157 .I syslog.conf
158 file, using a tab character for the delimiter:
159 .sp 1
160 .RS
161 .RS
162 news.err  <pathlog in inn.conf>/news.err
163 .RE
164 .RE
165 .sp 1
166 (A typical entry is shown; it should agree with
167 .I <pathlog in inn.conf>.)
168 .TP
169 .I news.notice
170 All standard error messages and status messages issued by
171 .I innd
172 are appended to this file via
173 .IR syslog (3).
174 .I Scanlogs
175 uses the
176 .IR perl (1)
177 script
178 .IR innreport (8)
179 to summarize this file.
180 You should have the following line in your system
181 .I syslog.conf
182 file, using a tab character for the delimiter:
183 .sp 1
184 .RS
185 .RS
186 news.notice  <pathlog in inn.conf>/news.notice
187 .RE
188 .RE
189 (A typical entry is shown; it should agree with
190 .I <pathlog in inn.conf>.)
191 .TP
192 .I nntpsend.log
193 The
194 .IR nntpsend (8)
195 programs appends all status messages to this file.
196 .TP
197 .I rmgroup.log
198 When
199 .I control.ctl
200 is configured as described above, all rmgroup messages are appended to this
201 file using the same format as for
202 .IR miscctl.log .
203 .TP
204 .I unwanted.log
205 This log maintains a count of the number of articles that were rejected
206 because they were posted to newsgroups that do not exist at the local site.
207 This file is updated by
208 .I tally.unwanted
209 and maintained in reverse numeric order (the most popular rejected group
210 first).
211 This file is not rotated.
212 .SH HISTORY
213 Written by Landon Curt Noll <chongo@toad.com> and Rich $alz
214 <rsalz@uunet.uu.net> for InterNetNews.
215 .de R$
216 This is revision \\$3, dated \\$4.
217 ..
218 .R$ $Id: newslog.5 6398 2003-07-12 19:15:50Z rra $
219 .SH "SEE ALSO"
220 control.ctl(5),
221 ctlinnd(8),
222 expire(8),
223 inn.conf(5),
224 innd(8),
225 news.daily(8),
226 nntpsend(8),
227 syslog.conf(5).