chiark / gitweb /
wip manpage
[inn-innduct.git] / doc / man / history.5
1 .\" $Revision: 3782 $
2 .TH HISTORY 5
3 .SH NAME
4 history \- record of current and recently expired Usenet articles
5 .SH DESCRIPTION
6 The file
7 .I <pathdb in inn.conf>/history
8 keeps a record of all articles currently stored in the news system,
9 as well as those that have been received but since expired.
10 In a typical production environment, this file will be many megabytes.
11 .PP
12 The file consists of text lines.
13 Each line corresponds to one article.
14 The file is normally kept sorted in the order in which articles are
15 received, although this is not a requirement.
16 .IR Innd (8)
17 appends a new line each time it files an article, and
18 .IR expire (8)
19 builds a new version of the file by removing old articles and purging
20 old entries.
21 .PP
22 Each line consists of two or three fields separated by a tab, shown below
23 as
24 .IR \et :
25 .RS
26 .nf
27 [Hash]         \et   date
28 [Hash]         \et   date   \et   token
29 .fi
30 .RE
31 .PP
32 The
33 .I Hash
34 field is the ASCII representation of the hash of the Message-ID header.  
35 This is directly used for the key of the
36 .IR dbz (3).
37 .PP
38 The
39 .I date
40 field consists of three sub-fields separated by a tilde.
41 All sub-fields are the text representation of the number of seconds since
42 the epoch \(em
43 .IR i.e. ,
44 a
45 .IR time_t ;
46 see
47 .IR gettimeofday (2).
48 The first sub-field is the article's arrival date.
49 If copies of the article are still present then the second sub-field is
50 either the value of the article's Expires header, or a hyphen if no
51 expiration date was specified.
52 If an article has been expired then the second sub-field will be a hyphen.
53 The third sub-field is the value of the article's Date header, recording
54 when the article was posted.
55 .PP
56 The
57 .I token
58 field is a token of the article.
59 This field is empty if the article has been expired.
60 .PP
61 For example, an article whose Message-ID was
62 <7q2saq$sal$1@isrv4.pa.vix.com>, posted on 26 Aug 1999 08:02:34 GMT and
63 recieved at 26 Aug 1999 08:06:54 GMT, could have a
64 history line (broken into three lines for display) like the
65 following:
66 .RS
67 .nf
68 [E6184A5BC2898A35A3140B149DE91D5C]  \et
69     935678987~-~935678821  \et
70     @030154574F00000000000007CE3B000004BA@
71 .fi
72 .RE
73 .PP
74 In addition to the text file, there is a
75 .IR dbz (3)
76 database associated with the file that uses the Message-ID field as a key
77 to determine the offset in the text file where the associated line begins.
78 For historical reasons, the key includes the trailing \e0 byte
79 (which is not stored in the text file).
80 .SH HISTORY
81 Written by Rich $alz <rsalz@uunet.uu.net> for InterNetNews.
82 .de R$
83 This is revision \\$3, dated \\$4.
84 ..
85 .R$ $Id: history.5 3782 2000-08-17 13:30:18Z kondou $
86 .SH "SEE ALSO"
87 dbz(3),
88 expire(8),
89 inn.conf(5),
90 innd(8),
91 makehistory(8).