annotate readpstlog.1 @ 3:fac01758bd41

Initial revision
author carl
date Thu, 23 Dec 2004 11:17:37 -0800
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
fac01758bd41 Initial revision
carl
parents:
diff changeset
1 .\" Hey, EMACS: -*- nroff -*-
fac01758bd41 Initial revision
carl
parents:
diff changeset
2 .\" First parameter, NAME, should be all caps
fac01758bd41 Initial revision
carl
parents:
diff changeset
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
fac01758bd41 Initial revision
carl
parents:
diff changeset
4 .\" other parameters are allowed: see man(7), man(1)
fac01758bd41 Initial revision
carl
parents:
diff changeset
5 .TH READPSTLOG 1 "February 24, 2004"
fac01758bd41 Initial revision
carl
parents:
diff changeset
6 .\" Please adjust this date whenever revising the manpage.
fac01758bd41 Initial revision
carl
parents:
diff changeset
7 .\"
fac01758bd41 Initial revision
carl
parents:
diff changeset
8 .\" Some roff macros, for reference:
fac01758bd41 Initial revision
carl
parents:
diff changeset
9 .\" .nh disable hyphenation
fac01758bd41 Initial revision
carl
parents:
diff changeset
10 .\" .hy enable hyphenation
fac01758bd41 Initial revision
carl
parents:
diff changeset
11 .\" .ad l left justify
fac01758bd41 Initial revision
carl
parents:
diff changeset
12 .\" .ad b justify to both left and right margins
fac01758bd41 Initial revision
carl
parents:
diff changeset
13 .\" .nf disable filling
fac01758bd41 Initial revision
carl
parents:
diff changeset
14 .\" .fi enable filling
fac01758bd41 Initial revision
carl
parents:
diff changeset
15 .\" .br insert line break
fac01758bd41 Initial revision
carl
parents:
diff changeset
16 .\" .sp <n> insert n+1 empty lines
fac01758bd41 Initial revision
carl
parents:
diff changeset
17 .\" for manpage-specific macros, see man(7)
fac01758bd41 Initial revision
carl
parents:
diff changeset
18 .SH NAME
fac01758bd41 Initial revision
carl
parents:
diff changeset
19 readpstlog \- convert a readpst logfile to text format
fac01758bd41 Initial revision
carl
parents:
diff changeset
20 .SH SYNOPSIS
fac01758bd41 Initial revision
carl
parents:
diff changeset
21 .B readpstlog
fac01758bd41 Initial revision
carl
parents:
diff changeset
22 .RI [ options ] " logfile"
fac01758bd41 Initial revision
carl
parents:
diff changeset
23 .SH DESCRIPTION
fac01758bd41 Initial revision
carl
parents:
diff changeset
24 This manual page documents briefly the
fac01758bd41 Initial revision
carl
parents:
diff changeset
25 .B readpstlog
fac01758bd41 Initial revision
carl
parents:
diff changeset
26 command.
fac01758bd41 Initial revision
carl
parents:
diff changeset
27 .PP
fac01758bd41 Initial revision
carl
parents:
diff changeset
28 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
fac01758bd41 Initial revision
carl
parents:
diff changeset
29 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
fac01758bd41 Initial revision
carl
parents:
diff changeset
30 .\" respectively.
fac01758bd41 Initial revision
carl
parents:
diff changeset
31 \fBreadpstlog\fP is a program that reads the \fIbinary\fP logfile generated
fac01758bd41 Initial revision
carl
parents:
diff changeset
32 by \fBreadpst\fP, and outputs it in a more desirable format (i.e. text).
fac01758bd41 Initial revision
carl
parents:
diff changeset
33 .SH OPTIONS
fac01758bd41 Initial revision
carl
parents:
diff changeset
34 This program follows the usual GNU command line syntax.
fac01758bd41 Initial revision
carl
parents:
diff changeset
35 A summary of options is included below.
fac01758bd41 Initial revision
carl
parents:
diff changeset
36 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
37 .BR \-f " \fIformat\fP"
fac01758bd41 Initial revision
carl
parents:
diff changeset
38 Sets the format of the text log output. Currently, the only valid output
fac01758bd41 Initial revision
carl
parents:
diff changeset
39 format is \fBT\fP, for text; anything else gives the default.
fac01758bd41 Initial revision
carl
parents:
diff changeset
40 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
41 .BR \-t " \fItypes\fP"
fac01758bd41 Initial revision
carl
parents:
diff changeset
42 Tells \fBreadpstlog\fP to print only the specified types of log messages.
fac01758bd41 Initial revision
carl
parents:
diff changeset
43 Types are specified in a comma\-delimited list (e.g. 3,10,5,6).
fac01758bd41 Initial revision
carl
parents:
diff changeset
44 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
45 .BR \-x " \fItypes\fP"
fac01758bd41 Initial revision
carl
parents:
diff changeset
46 Tells \fBreadpstlog\fP to exclude the specified types of log messages.
fac01758bd41 Initial revision
carl
parents:
diff changeset
47 Types are specified in a comma\-delimited list (e.g. 3,10,5,6).
fac01758bd41 Initial revision
carl
parents:
diff changeset
48 .SH LOG MESSAGE TYPES
fac01758bd41 Initial revision
carl
parents:
diff changeset
49 .PP
fac01758bd41 Initial revision
carl
parents:
diff changeset
50 \fBreadpstlog\fP understands the following types of log messages:
fac01758bd41 Initial revision
carl
parents:
diff changeset
51 .RS 15
fac01758bd41 Initial revision
carl
parents:
diff changeset
52 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
53 .B 1
fac01758bd41 Initial revision
carl
parents:
diff changeset
54 File accesses
fac01758bd41 Initial revision
carl
parents:
diff changeset
55 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
56 .B 2
fac01758bd41 Initial revision
carl
parents:
diff changeset
57 Index accesses
fac01758bd41 Initial revision
carl
parents:
diff changeset
58 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
59 .B 3
fac01758bd41 Initial revision
carl
parents:
diff changeset
60 New email found
fac01758bd41 Initial revision
carl
parents:
diff changeset
61 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
62 .B 4
fac01758bd41 Initial revision
carl
parents:
diff changeset
63 Warnings
fac01758bd41 Initial revision
carl
parents:
diff changeset
64 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
65 .B 5
fac01758bd41 Initial revision
carl
parents:
diff changeset
66 Read accesses
fac01758bd41 Initial revision
carl
parents:
diff changeset
67 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
68 .B 6
fac01758bd41 Initial revision
carl
parents:
diff changeset
69 Informational messages
fac01758bd41 Initial revision
carl
parents:
diff changeset
70 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
71 .B 7
fac01758bd41 Initial revision
carl
parents:
diff changeset
72 Main function calls
fac01758bd41 Initial revision
carl
parents:
diff changeset
73 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
74 .B 8
fac01758bd41 Initial revision
carl
parents:
diff changeset
75 Decrypting calls
fac01758bd41 Initial revision
carl
parents:
diff changeset
76 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
77 .B 10
fac01758bd41 Initial revision
carl
parents:
diff changeset
78 Function calls
fac01758bd41 Initial revision
carl
parents:
diff changeset
79 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
80 .B 11
fac01758bd41 Initial revision
carl
parents:
diff changeset
81 HexDump calls
fac01758bd41 Initial revision
carl
parents:
diff changeset
82 .RE
fac01758bd41 Initial revision
carl
parents:
diff changeset
83 .SH SEE ALSO
fac01758bd41 Initial revision
carl
parents:
diff changeset
84 .BR readpst (1)
fac01758bd41 Initial revision
carl
parents:
diff changeset
85 .SH AUTHOR
fac01758bd41 Initial revision
carl
parents:
diff changeset
86 This manual page was written by Joe Nahmias <joe@nahmias.net> for the Debian
fac01758bd41 Initial revision
carl
parents:
diff changeset
87 GNU/Linux system (but may be used by others).