comparison readpstlog.1 @ 3:fac01758bd41

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