chiark / gitweb /
wip manpage
[inn-innduct.git] / doc / man / prunehistory.8
1 .\" $Revision: 5909 $
2 .TH PRUNEHISTORY 8
3 .SH NAME
4 prunehistory \- remove tokens from Usenet history file
5 .SH SYNOPSIS
6 .B prunehistory
7 [
8 .BI \-f " filename"
9 ]
10 [
11 .B \-p
12 ]
13 .SH DESCRIPTION
14 .I Prunehistory
15 modifies a
16 .IR history (5)-format
17 text file to ``remove'' a set of tokens from it.
18 The tokens are removed by overwriting them with spaces, so that the
19 size and position of any following entries does not change.  This has an
20 effect similar to expiring the article, in that it is still mentioned in
21 the history database but cannot be retrieved.
22 .PP
23 .I Prunehistory
24 reads the standard input.
25 The input is taken as a set of lines.
26 Blank lines and lines starting with a number sign (``#'') are ignored.
27 All other lines are should consist of a Message-ID followed by zero or
28 more other fields (which are ignored).
29 .PP
30 The Message-ID is used as the
31 .IR dbz (3)
32 key to get an offset into the text file.
33 .PP
34 Since
35 .IR innd (8)
36 only appends
37 to the text file,
38 .I prunehistory
39 does not need to have any interaction with it.
40 .SH OPTIONS
41 .TP
42 .B \-p
43 .I Prunehistory
44 will normally complain about lines that do not follow the correct format.
45 If the ``\-p'' flag is used, then the program will silently print any
46 invalid lines on its standard output.
47 (Blank lines and comment lines are also passed through.)
48 This can be useful when
49 .I prunehistory
50 is used as a filter for other programs such as
51 .IR reap .
52 .TP
53 .BI \-f " filename"
54 The default name of the history file is
55 .IR <pathdb\ in\ inn.conf>/history ;
56 to specify a different name, use the ``\-f'' flag.
57 .SH HISTORY
58 Written by Rich $alz <rsalz@uunet.uu.net> for InterNetNews.
59 .de R$
60 This is revision \\$3, dated \\$4.
61 ..
62 .R$ $Id: prunehistory.8 5909 2002-12-03 05:17:18Z vinocur $
63 .SH "SEE ALSO"
64 dbz(3),
65 history(5),
66 inn.conf(5),
67 innd(8).