comparison man/readpstlog.1 @ 19:1246d317a05b

switch to automake/autoconf
author carl
date Sun, 19 Feb 2006 20:19:38 -0800
parents c508ee15dfca
children
comparison
equal deleted inserted replaced
18:69ab1d8b3293 19:1246d317a05b
1 .\" Hey, EMACS: -*- nroff -*- 1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .\" First parameter, NAME, should be all caps 2 .de Sh \" Subsection
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection 3 .br
4 .\" other parameters are allowed: see man(7), man(1) 4 .if t .Sp
5 .TH READPSTLOG 1 "February 24, 2004" 5 .ne 5
6 .\" Please adjust this date whenever revising the manpage. 6 .PP
7 .\" 7 \fB\\$1\fR
8 .\" Some roff macros, for reference: 8 .PP
9 .\" .nh disable hyphenation 9 ..
10 .\" .hy enable hyphenation 10 .de Sp \" Vertical space (when we can't use .PP)
11 .\" .ad l left justify 11 .if t .sp .5v
12 .\" .ad b justify to both left and right margins 12 .if n .sp
13 .\" .nf disable filling 13 ..
14 .\" .fi enable filling 14 .de Ip \" List item
15 .\" .br insert line break 15 .br
16 .\" .sp <n> insert n+1 empty lines 16 .ie \\n(.$>=3 .ne \\$3
17 .\" for manpage-specific macros, see man(7) 17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "READPSTLOG" 1 "2006-02-19" "" ""
18 .SH NAME 21 .SH NAME
19 readpstlog \- convert a readpst logfile to text format 22 readpstlog \- convert a readpst logfile to text format
20 .SH SYNOPSIS 23 .SH "SYNOPSIS"
21 .B readpstlog 24 .ad l
22 .RI [ options ] " logfile" 25 .hy 0
23 .SH DESCRIPTION 26 .HP 8
24 This manual page documents briefly the 27 \fBreadpst\fR [\fB\-f\ \fIformat\fR\fR] [\fB\-t\ \fIinclude\-types\fR\fR] [\fB\-x\ \fIexclude\-types\fR\fR] [logfile]
25 .B readpstlog 28 .ad
26 command. 29 .hy
30
31 .SH "DESCRIPTION"
32
27 .PP 33 .PP
28 .\" TeX users may be more comfortable with the \fB<whatever>\fP and 34 This manual page briefly documents the \fBreadpstlog\fR command\&.
29 .\" \fI<whatever>\fP escape sequences to invode bold face and italics, 35
30 .\" respectively. 36 .PP
31 \fBreadpstlog\fP is a program that reads the \fIbinary\fP logfile generated 37 \fBreadpstlog\fR is a program that reads the binary logfile generated by \fBreadpst\fR, and outputs it in a more desirable format (i\&.e\&. text)\&.
32 by \fBreadpst\fP, and outputs it in a more desirable format (i.e. text). 38
33 .SH OPTIONS 39 .SH "OPTIONS"
34 This program follows the usual GNU command line syntax. 40
35 A summary of options is included below.
36 .TP 41 .TP
37 .BR \-f " \fIformat\fP" 42 \-f \fIformat\fR
38 Sets the format of the text log output. Currently, the only valid output 43 Sets the format of the text log output\&. Currently, the only valid output format is T, for text; anything else gives the default\&.
39 format is \fBT\fP, for text; anything else gives the default. 44
40 .TP 45 .TP
41 .BR \-t " \fItypes\fP" 46 \-t \fIinclude\-types\fR
42 Tells \fBreadpstlog\fP to print only the specified types of log messages. 47 Print only the specified types of log messages\&. Types are specified in a comma\-delimited list (e\&.g\&. 3,10,5,6)\&.
43 Types are specified in a comma\-delimited list (e.g. 3,10,5,6). 48
44 .TP 49 .TP
45 .BR \-x " \fItypes\fP" 50 \-x \fIexclude\-types\fR
46 Tells \fBreadpstlog\fP to exclude the specified types of log messages. 51 Exclude the specified types of log messages\&. Types are specified in a comma\-delimited list (e\&.g\&. 3,10,5,6)\&.
47 Types are specified in a comma\-delimited list (e.g. 3,10,5,6). 52
48 .SH LOG MESSAGE TYPES 53 .SH "MESSAGE TYPES"
54
49 .PP 55 .PP
50 \fBreadpstlog\fP understands the following types of log messages: 56 \fBreadpstlog\fR understands the following types of log messages:
51 .RS 15 57
52 .TP 58 .TP
53 .B 1 59 1
54 File accesses 60 File accesses
61
55 .TP 62 .TP
56 .B 2 63 2
57 Index accesses 64 Index accesses
65
58 .TP 66 .TP
59 .B 3 67 3
60 New email found 68 New email found
69
61 .TP 70 .TP
62 .B 4 71 4
63 Warnings 72 Warnings
73
64 .TP 74 .TP
65 .B 5 75 5
66 Read accesses 76 Read accesses
77
67 .TP 78 .TP
68 .B 6 79 6
69 Informational messages 80 Informational messages
81
70 .TP 82 .TP
71 .B 7 83 7
72 Main function calls 84 Main function calls
85
73 .TP 86 .TP
74 .B 8 87 8
75 Decrypting calls 88 Decrypting calls
89
76 .TP 90 .TP
77 .B 10 91 10
78 Function calls 92 Function calls
93
79 .TP 94 .TP
80 .B 11 95 11
81 HexDump calls 96 HexDump calls
82 .RE 97
83 .SH SEE ALSO 98 .SH "AUTHOR"
84 .BR readpst (1) 99
85 .SH AUTHOR 100 .PP
86 This manual page was written by Joe Nahmias <joe@nahmias.net> for the Debian 101 This manual page was written by Joe Nahmias <joe@nahmias\&.net> for the Debian GNU/Linux system (but may be used by others)\&. It was converted to xml format by Carl Byington <carl@five\-ten\-sg\&.com>\&.
87 GNU/Linux system (but may be used by others). 102
103 .SH "COPYRIGHT"
104
105 .PP
106 Copyright (C) 2002 by David Smith <dave\&.s@earthcorp\&.com>\&. XML version Copyright (C) 2005 by 510 Software Group <carl@five\-ten\-sg\&.com>\&.
107
108 .PP
109 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version\&.
110
111 .PP
112 You should have received a copy of the GNU General Public License along with this program; see the file COPYING\&. If not, please write to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA\&.
113
114 .SH "CVS VERSION"
115
116 .PP
117 $Id$
118