chiark / gitweb /
wip manpage
[inn-innduct.git] / doc / man / overchan.8
1 .\" $Revision: 5909 $
2 .TH OVERCHAN 8
3 .SH NAME
4 overchan \- update the news overview database
5 .SH SYNOPSIS
6 .B overchan
7 [
8 .BR file \ ...
9 ]
10 .SH DESCRIPTION
11 .I Overchan
12 reads article data from
13 .I files
14 or standard input if none are specified.
15 (A single dash in the file list means to read standard input.)
16 It uses this information to update the news overview database.
17 .I Overchan
18 was originally designed to be used by InterNetNews or the C News ``mkov'' packages
19 to update the database as the articles come in.
20 For current INN, the database is stored in a selected overview method.
21 This can be done within
22 .IR innd (8)
23 itself, but
24 .IR overchan (8)
25 can be used instead, if
26 .I <useoverchan in inn.conf>
27 is ``true'' and appropriate setup is done in
28 .IR newsfeeds ,
29 for example:
30 .PP
31 .RS
32 overview!:*:Tc,WnteO:<pathbin in inn.conf>/overchan
33 .RE
34 .PP
35 .I Overchan
36 input data consists of a line of text, separated into four parts by a space.
37 The first part is a token for the article.
38 The second part is time when the article was received.
39 The third part is time when the article will be expired (which represents
40 the Expires header).
41 The fourth part is the data to be stored.
42 .PP
43 The data in the overview files should be expired by running
44 .IR expireover (8).
45 This is normally done by adding the ``expireover'' flag to the
46 .IR news.daily (8)
47 invocation.
48 .PP
49 .SH HISTORY
50 Written by Rob Robertson <rob@violet.berkeley.edu>
51 and Rich $alz <rsalz@uunet.uu.net> for InterNetNews.
52 .de R$
53 This is revision \\$3, dated \\$4.
54 ..
55 .R$ $Id: overchan.8 5909 2002-12-03 05:17:18Z vinocur $
56 .SH "SEE ALSO"
57 expireover(8),
58 inn.conf(5),
59 news.daily(8),
60 newsfeeds(5).