chiark / gitweb /
debugging for thing that crashed
[innduct.git] / doc / pod / grephistory.pod
1 =head1 NAME
2
3 grephistory - Query the INN history database
4
5 =head1 SYNOPSIS
6
7 B<grephistory> [B<-eilnqsv>] [B<-f> I<db>] [I<message-id>]
8
9 =head1 DESCRIPTION
10
11 B<grephistory> queries the INN history database for information about the
12 specified message ID.  If no flags are given, the program prints the
13 storage API token of the corresponding article, or C</dev/null> if the
14 article is listed in the history database but not stored on the server.
15 If the message ID cannot be found in the database, B<grephistory> will
16 print C<grephistory: not found> and exit with a non-zero status.
17
18 Be sure to escape any special characters in the message ID from the shell.
19 Single quotes are recommended for this purpose since many message IDs
20 contain dollar signs.
21
22 =head1 OPTIONS
23
24 =over 4
25
26 =item B<-e>
27
28 Only print the storage token if the article is stored on the system.  (In
29 other words, suppress the C</dev/null> or C<not found> output for missing
30 or remembered articles.)
31
32 =item B<-f> I<db>
33
34 Query the history database I<db> rather than the default history database.
35
36 =item B<-i>
37
38 Rather than expecting a message ID on the command line, B<grephistory>
39 will read a list of message IDs on standard input, one per line.  Leading
40 and trailing whitespace is ignored, as are any malformed lines.  It will
41 print out standard output those message IDs which are not found in the
42 history database.  This is used when processing C<ihave> control messages.
43
44 =item B<-l>
45
46 Display the entire line from the history database, rather than just the
47 storage API token.
48
49 =item B<-n>
50
51 If the message ID is present in the history database but has no storage
52 API token, print C</dev/null> and exit successfully.  This can happen if
53 an article has been cancelled or expired, but history information has
54 still been retained.  This is the default behavior.
55
56 =item B<-q>
57
58 Don't print any message, but still exit with the appropriate status.
59
60 =item B<-s>
61
62 Rather than expecting a message ID on the command line, B<grephistory>
63 will read a list of message IDs on standard input, one per line.  Leading
64 and trailing whitespace is ignored, as are any malformed lines.  It will
65 print on standard output the storage API tokens for any articles that are
66 still available, one per line.  This flag is used when processing
67 C<sendme> control messages.
68
69 =item B<-v>
70
71 Print out the hash of the message ID for diagnostic purposes, as well as
72 any other requested information.  This flag is not useful with B<-s>.
73
74 =head1 HISTORY
75
76 Written by Rich $alz <rsalz@uunet.uu.net> for InterNetNews.  Rewritten in
77 POD by Russ Allbery <rra@stanford.edu>.
78
79 $Id: grephistory.pod 7045 2004-12-19 19:37:45Z rra $
80
81 =head1 SEE ALSO
82
83 history(5), inn.conf(5)
84
85 =cut