chiark / gitweb /
option for no inotify; manpage fix
[innduct.git] / doc / man / grephistory.1
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "GREPHISTORY 1"
132 .TH GREPHISTORY 1 "2008-04-06" "INN 2.4.5" "InterNetNews Documentation"
133 .SH "NAME"
134 grephistory \- Query the INN history database
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 \&\fBgrephistory\fR [\fB\-eilnqsv\fR] [\fB\-f\fR \fIdb\fR] [\fImessage-id\fR]
138 .SH "DESCRIPTION"
139 .IX Header "DESCRIPTION"
140 \&\fBgrephistory\fR queries the \s-1INN\s0 history database for information about the
141 specified message \s-1ID\s0.  If no flags are given, the program prints the
142 storage \s-1API\s0 token of the corresponding article, or \f(CW\*(C`/dev/null\*(C'\fR if the
143 article is listed in the history database but not stored on the server.
144 If the message \s-1ID\s0 cannot be found in the database, \fBgrephistory\fR will
145 print \f(CW\*(C`grephistory: not found\*(C'\fR and exit with a non-zero status.
146 .PP
147 Be sure to escape any special characters in the message \s-1ID\s0 from the shell.
148 Single quotes are recommended for this purpose since many message IDs
149 contain dollar signs.
150 .SH "OPTIONS"
151 .IX Header "OPTIONS"
152 .IP "\fB\-e\fR" 4
153 .IX Item "-e"
154 Only print the storage token if the article is stored on the system.  (In
155 other words, suppress the \f(CW\*(C`/dev/null\*(C'\fR or \f(CW\*(C`not found\*(C'\fR output for missing
156 or remembered articles.)
157 .IP "\fB\-f\fR \fIdb\fR" 4
158 .IX Item "-f db"
159 Query the history database \fIdb\fR rather than the default history database.
160 .IP "\fB\-i\fR" 4
161 .IX Item "-i"
162 Rather than expecting a message \s-1ID\s0 on the command line, \fBgrephistory\fR
163 will read a list of message IDs on standard input, one per line.  Leading
164 and trailing whitespace is ignored, as are any malformed lines.  It will
165 print out standard output those message IDs which are not found in the
166 history database.  This is used when processing \f(CW\*(C`ihave\*(C'\fR control messages.
167 .IP "\fB\-l\fR" 4
168 .IX Item "-l"
169 Display the entire line from the history database, rather than just the
170 storage \s-1API\s0 token.
171 .IP "\fB\-n\fR" 4
172 .IX Item "-n"
173 If the message \s-1ID\s0 is present in the history database but has no storage
174 \&\s-1API\s0 token, print \f(CW\*(C`/dev/null\*(C'\fR and exit successfully.  This can happen if
175 an article has been cancelled or expired, but history information has
176 still been retained.  This is the default behavior.
177 .IP "\fB\-q\fR" 4
178 .IX Item "-q"
179 Don't print any message, but still exit with the appropriate status.
180 .IP "\fB\-s\fR" 4
181 .IX Item "-s"
182 Rather than expecting a message \s-1ID\s0 on the command line, \fBgrephistory\fR
183 will read a list of message IDs on standard input, one per line.  Leading
184 and trailing whitespace is ignored, as are any malformed lines.  It will
185 print on standard output the storage \s-1API\s0 tokens for any articles that are
186 still available, one per line.  This flag is used when processing
187 \&\f(CW\*(C`sendme\*(C'\fR control messages.
188 .IP "\fB\-v\fR" 4
189 .IX Item "-v"
190 Print out the hash of the message \s-1ID\s0 for diagnostic purposes, as well as
191 any other requested information.  This flag is not useful with \fB\-s\fR.
192 .SH "HISTORY"
193 .IX Header "HISTORY"
194 Written by Rich \f(CW$alz\fR <rsalz@uunet.uu.net> for InterNetNews.  Rewritten in
195 \&\s-1POD\s0 by Russ Allbery <rra@stanford.edu>.
196 .Sp
197 $Id: grephistory.1 7880 2008-06-16 20:37:13Z iulius $
198 .SH "SEE ALSO"
199 .IX Header "SEE ALSO"
200 \&\fIhistory\fR\|(5), \fIinn.conf\fR\|(5)