chiark / gitweb /
wip manpage
[inn-innduct.git] / doc / man / news.daily.8
1 .TH NEWS.DAILY 8
2 .SH NAME
3 news.daily \- do regular Usenet system administration
4 .SH SYNOPSIS
5 .B news.daily
6 [
7 .B keyword...
8 ]
9
10 .SH DESCRIPTION
11 .I News.daily
12 performs a number of important Usenet administrative functions.
13 This includes producing a status report, removing old news articles, 
14 processing log files, rotating the archived log files, renumbering the
15 active file, 
16 removing any old socket files found in the
17 .I <pathrun in inn.conf>
18 directory, and collecting the output.
19 .I "This program should be run under the news administrator's id, not as root."
20 .PP
21 By default, 
22 .I news.daily
23 performs all of its functions and mails the output to the news administrator,
24 .IR <USER\ specified\ with\ \-\-with\-news\-master\ at\ configure> .
25 By specifying ``keywords'' on the command line, it is possible to
26 modify the functions performed, as well as change the arguments given to
27 .IR expire (8)
28 and
29 .IR expireover (8).
30 .PP
31 .I News.daily
32 should be run once a day, typically out of
33 .IR cron (8).
34 It may be run more often, but such invocations should at least use the
35 \&``norotate'' keyword (or perhaps the \&``notdaily'' keyword) to
36 prevent the log files from being processed and rotated too fast.
37 .PP
38 The
39 .IR shlock (1)
40 program is used to prevent simultaneous executions.
41 .SH "KEYWORDS"
42 .PP
43 The following keywords may be used:
44 .TP
45 .I delayrm
46 This uses the ``\fB\-z\fP'' flag when invoking
47 .I expire
48 and
49 .IR expireover .
50 The names of articles to be removed are written to a temporary file, and
51 then renamed after expiration by calling
52 .IR expirerm (8).
53 .TP
54 .IR expctl= path
55 Specify the file to use as the
56 .IR expire.ctl (5)
57 file for
58 .IR expire .
59 .TP
60 .IR expdir= path
61 By default,
62 .I expire
63 builds the new
64 .IR history (5)
65 file and database in the same directory as the current files.
66 Using this keyword specifies a different local to build the new files
67 (by passing the ``\fB\-d\fP'' flag to
68 .IR expire ),
69 which will then be moved to the right location when finished.
70 .TP
71 .I nostat
72 This keyword disables the status report generated by
73 .I innstat
74 (see
75 .IR innstat (8)).
76 Without this keyword, the status report is the first function performed,
77 just prior to obtaining the
78 .I news.daily
79 lock.
80 .TP
81 .I notdaily
82 By default 
83 .I news.daily
84 expects to be run only once a day, and it does
85 various things (like rotating logs) that normally should only be done on
86 daily basis. Use this keyword any extra times
87 .I news.daily
88 is run in the
89 day and the normal logfile processing (and rotation) will not be done.
90 .TP
91 .I noexpire
92 By default,
93 .I expire
94 is invoked to remove old news articles.
95 Using this keyword disables this function.
96 .TP
97 .I noexpireover
98 By default,
99 .I expireover
100 is invoked to remove old overview database, if
101 .I enableoverview
102 is set in
103 .IR inn.conf .
104 Using this keyword disables this function.
105 .TP
106 .I noexplog
107 .I Expire
108 normally appends information to
109 .I <pathlog in inn.conf>/expire.log
110 (see
111 .IR newslog (5)).
112 Using this keyword causes the
113 .I expire
114 output to be handled as part of 
115 .IR news.daily 's
116 output.
117 It has no effect if the ``noexpire'' keyword is used.
118 .TP
119 .IR flags= "'args\ for\ expire'"
120 By default, 
121 .I expire
122 is invoked with argument ``\-v1''.
123 Using this keyword changes the arguments to those specified.
124 Be careful to use quotes if multiple arguments are needed.
125 This keyword has no effect if the ``noexpire'' keyword is used.
126 .TP
127 .I nologs
128 After expiration,
129 .IR scanlogs (8)
130 is invoked to process the log files.
131 Using this keyword disables all log processing functions.
132 .TP
133 .I norotate
134 By default, log processing includes rotating and cleaning out log files.
135 Using this keyword disables the rotating and cleaning aspect of the log
136 processing: the logs files are only scanned for information and no contents
137 are altered.
138 .IP
139 This keyword has no effect if the ``nologs'' keyword is used.
140 The ``norotate'' keyword is passed on to
141 .I scanlogs
142 if it is invoked.
143 .TP
144 .I norenumber
145 This keyword disables the
146 .IR ctlinnd (8)
147 renumber operation.
148 Normally, the low-water marks for all newsgroups (see
149 .IR active (5))
150 are reset.
151 .TP
152 .I norm
153 By default, any socket
154 .I ctlinnd
155 socket that has not been modified for two days will be removed.
156 Using this keyword disables this function.
157 .TP
158 .I nomail
159 .I News.daily
160 normally sends a mail message containing the results to the administrator.
161 Using this keyword causes this message to be sent to stdout and stderr instead.
162 Normally, all utilities invoked by the script have their stdout and stderr
163 redirected into a file.
164 If the file is empty, no message is sent.
165 .TP
166 .I expireover
167 The
168 .I expireover
169 program is called after expiration to purge the overview databases.
170 If no overview data is created, the ``expireover''
171 keyword is not needed.  This is the case that the server runs only for
172 feeder(no reader).
173 .TP
174 .IR expireoverflags= "'args\ for\ expireover'"
175 If the ``expireover'' keyword is used, this keyword may be used to specify
176 the flags to be passed to
177 .IR expireover .
178 If the ``delayrm'' keyword is used, then the default value is ``\-z''
179 and the list of deleted files; otherwise, the default value is ``\-s''.
180 .TP
181 .I /full/path
182 The program specified by the given path is executed just before any
183 expiration is done.
184 A typical use is to specify an alternate expiration program and use the
185 \&``noexpire'' keyword.
186 Multiple programs may be specified; they will be invoked in order.
187 .TP
188 .IR postexec= "'post executed program'"
189 The program specified by the given path is executed just after all
190 expiration is done.
191 Multiple programs may be specified; they will be invoked in order.
192 .TP
193 .I lowmark
194 If the ``lowmark'' keyword is used, 
195 .IR ctlinnd (8)
196 lowmark is used for renumbering
197 .IR active .
198 Normal
199 .IR ctlinnd (8)
200 renumber operation will take long time.  With ``lowmark'' keyword this will
201 take less time.
202 If the ``lowmark'' keyword is used,
203 \&``norenumber'' keyword is not needed, since
204 .I news.daily
205 specifies it implicitly.
206 .TP
207 .IR tmpdir= path
208 Sets the environment variable TMPDIR to the specified path.
209 Various parts of the expire process, such as sort, will then use this
210 path as the directory for temporary files.
211 .SH HISTORY
212 .I News.daily
213 and this manual page written by Landon Curt Noll <chongo@toad.com> and
214 Rich $alz <rsalz@uunet.uu.net>.
215 .de R$
216 This is revision \\$3, dated \\$4.
217 ..
218 .R$ $Id: news.daily.8 6398 2003-07-12 19:15:50Z rra $
219 .SH "SEE ALSO"
220 active(5),
221 ctlinnd(8), 
222 expire(8),
223 fastrm(8),
224 inn.conf(5),
225 newslog(5),
226 innwatch.ctl(5),
227 shlock(1).