annotate xml/libpst.in @ 21:e5418051878c

switch to automake/autoconf
author carl
date Sun, 19 Feb 2006 21:27:03 -0800
parents 1acd3231c3a4
children f4643b609bdf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
1 <reference>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
2 <title>@PACKAGE@ Utilities - Version @VERSION@</title>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
3 <partintro>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
4 <title>Packages</title>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
5 <para>The various source and binary packages are available at <ulink
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
6 url="http://www.five-ten-sg.com/@PACKAGE@/packages/">http://www.five-ten-sg.com/@PACKAGE@/packages/</ulink>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
7 The most recent documentation is available at <ulink
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
8 url="http://www.five-ten-sg.com/@PACKAGE@/">http://www.five-ten-sg.com/@PACKAGE@/</ulink>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
9 </para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
10
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
11 </partintro>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
12
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
13 <refentry id="readpst.1">
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
14 <refentryinfo>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
15 <date>2006-02-19</date>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
16 </refentryinfo>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
17
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
18 <refmeta>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
19 <refentrytitle>readpst</refentrytitle>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
20 <manvolnum>1</manvolnum>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
21 <refmiscinfo>readpst @VERSION@</refmiscinfo>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
22 </refmeta>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
23
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
24 <refnamediv id='readpst.name.1'>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
25 <refname>readpst</refname>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
26 <refpurpose>convert PST (MS Outlook Personal Folders) files to mbox format</refpurpose>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
27 </refnamediv>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
28
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
29 <refsynopsisdiv id='readpst.synopsis.1'>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
30 <title>Synopsis</title>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
31 <cmdsynopsis>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
32 <command>readpst</command>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
33 <arg><option>-c <replaceable class="parameter">format</replaceable></option></arg>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
34 <arg><option>-d <replaceable class="parameter">debug-file</replaceable></option></arg>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
35 <arg><option>-h</option></arg>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
36 <arg><option>-k</option></arg>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
37 <arg><option>-o <replaceable class="parameter">output-directory</replaceable></option></arg>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
38 <arg><option>-q</option></arg>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
39 <arg><option>-r</option></arg>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
40 <arg><option>-S</option></arg>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
41 <arg><option>-V</option></arg>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
42 <arg><option>-w</option></arg>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
43 <arg>files...</arg>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
44 </cmdsynopsis>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
45 </refsynopsisdiv>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
46
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
47 <refsect1 id='readpst.description.1'>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
48 <title>Description</title>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
49 <para>This manual page briefly documents the <command>readpst</command> command.</para>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
50 <para><command>readpst</command> is a program that can read an Outlook PST (Personal Folders) file
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
51 and convert it into an mbox file, a format suitable for KMail, a recursive mbox
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
52 structure, or separate emails.
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
53 </para>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
54 </refsect1>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
55
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
56 <refsect1 id='readpst.options.1'>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
57 <title>Options</title>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
58 <variablelist>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
59 <varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
60 <term>-c <replaceable class="parameter">format</replaceable></term>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
61 <listitem><para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
62 Set the Contact output mode. Use -cv for vcard format or -cl for an email list.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
63 </para></listitem>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
64 </varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
65 <varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
66 <term>-d <replaceable class="parameter">debug-file</replaceable></term>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
67 <listitem><para>
21
e5418051878c switch to automake/autoconf
carl
parents: 20
diff changeset
68 Specify name of debug log file. Defaults to "readpst.log". The log
e5418051878c switch to automake/autoconf
carl
parents: 20
diff changeset
69 file is not an ascii file, it is a binary file readable by <command>readpstlog</command>.
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
70 </para></listitem>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
71 </varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
72 <varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
73 <term>-h</term>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
74 <listitem><para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
75 Show summary of options.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
76 </para></listitem>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
77 </varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
78 <varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
79 <term>-k</term>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
80 <listitem><para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
81 Changes the output format to KMail.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
82 </para></listitem>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
83 </varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
84 <varlistentry>
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
85 <term>-o <replaceable class="parameter">output-directory</replaceable></term>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
86 <listitem><para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
87 Specifies the output directory. The directory must already exist, and
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
88 is entered after the PST file is opened, but before any processing of
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
89 files commences.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
90 </para></listitem>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
91 </varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
92 <varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
93 <term>-q</term>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
94 <listitem><para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
95 Changes to silent mode. No feedback is printed to the screen, except
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
96 for error messages.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
97 </para></listitem>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
98 </varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
99 <varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
100 <term>-r</term>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
101 <listitem><para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
102 Changes the output format to Recursive. This will create folders as
21
e5418051878c switch to automake/autoconf
carl
parents: 20
diff changeset
103 named in the PST file, and will put all emails in a file called "mbox"
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
104 inside each folder. These files are then compatible with all
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
105 mbox-compatible email clients.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
106 </para></listitem>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
107 </varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
108 <varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
109 <term>-S</term>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
110 <listitem><para>
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
111 Output messages into separate files. This will create folders as
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
112 named in the PST file, and will put each email in its own file. These
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
113 files will be numbered from 000000000 increasing in intervals of 1 (ie
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
114 000000000, 000000001, 0000000002). Any attachments are saved alongside
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
115 each email as 000000000-attach0, or with the name of the attachment if
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
116 one is present.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
117 </para></listitem>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
118 </varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
119 <varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
120 <term>-V</term>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
121 <listitem><para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
122 Show version of program. Subsequent options are then ignored.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
123 </para></listitem>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
124 </varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
125 <varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
126 <term>-w</term>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
127 <listitem><para>
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
128 Overwrite any previous output files. Beware: When used with the -S
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
129 switch, this will remove all files from the target folder before
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
130 writing. This is to keep the count of emails and attachments correct.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
131 </para></listitem>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
132 </varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
133 </variablelist>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
134 </refsect1>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
135
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
136 <refsect1 id='readpst.also.1'>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
137 <title>See Also</title>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
138 <para>
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
139 <citerefentry><refentrytitle>readpstlog</refentrytitle></citerefentry>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
140 </para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
141 </refsect1>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
142
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
143 <refsect1 id='readpst.author.1'>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
144 <title>Author</title>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
145 <para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
146 This manual page was originally written by Dave Smith
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
147 &lt;dave.s@earthcorp.com&gt;, and updated by Joe Nahmias &lt;joe@nahmias.net&gt;
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
148 for the Debian GNU/Linux system (but may be used by others). It was
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
149 subsequently updated by Brad Hards &lt;bradh@frogmouth.net&gt;, and converted to
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
150 xml format by Carl Byington &lt;carl@five-ten-sg.com&gt;.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
151 </para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
152 </refsect1>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
153
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
154 <refsect1 id='readpst.copyright.1'>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
155 <title>Copyright</title>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
156 <para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
157 Copyright (C) 2002 by David Smith &lt;dave.s@earthcorp.com&gt;.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
158 XML version Copyright (C) 2005 by 510 Software Group &lt;carl@five-ten-sg.com&gt;.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
159 </para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
160 <para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
161 This program is free software; you can redistribute it and/or modify it
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
162 under the terms of the GNU General Public License as published by the
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
163 Free Software Foundation; either version 2, or (at your option) any
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
164 later version.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
165 </para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
166 <para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
167 You should have received a copy of the GNU General Public License along
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
168 with this program; see the file COPYING. If not, please write to the
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
169 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
170 </para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
171 </refsect1>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
172
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
173 <refsect1 id='readpst.version.1'>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
174 <title>CVS Version</title>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
175 <para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
176 $Id$
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
177 </para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
178 </refsect1>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
179 </refentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
180
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
181
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
182 <refentry id="readpstlog.1">
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
183 <refentryinfo>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
184 <date>2006-02-19</date>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
185 </refentryinfo>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
186
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
187 <refmeta>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
188 <refentrytitle>readpstlog</refentrytitle>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
189 <manvolnum>1</manvolnum>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
190 <refmiscinfo>readpstlog @VERSION@</refmiscinfo>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
191 </refmeta>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
192
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
193 <refnamediv id='readpstlog.name.1'>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
194 <refname>readpstlog</refname>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
195 <refpurpose>convert a readpst logfile to text format</refpurpose>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
196 </refnamediv>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
197
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
198 <refsynopsisdiv id='readpstlog.synopsis.1'>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
199 <title>Synopsis</title>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
200 <cmdsynopsis>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
201 <command>readpst</command>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
202 <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
203 <arg><option>-t <replaceable class="parameter">include-types</replaceable></option></arg>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
204 <arg><option>-x <replaceable class="parameter">exclude-types</replaceable></option></arg>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
205 <arg>logfile</arg>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
206 </cmdsynopsis>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
207 </refsynopsisdiv>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
208
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
209 <refsect1 id='readpstlog.description.1'>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
210 <title>Description</title>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
211 <para>This manual page briefly documents the <command>readpstlog</command> command.</para>
21
e5418051878c switch to automake/autoconf
carl
parents: 20
diff changeset
212 <para><command>readpstlog</command>
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
213 is a program that reads the binary logfile generated
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
214 by <command>readpst</command>, and outputs it in a more desirable format (i.e. text).
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
215 </para>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
216 </refsect1>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
217
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
218 <refsect1 id='readpstlog.options.1'>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
219 <title>Options</title>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
220 <variablelist>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
221 <varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
222 <term>-f <replaceable class="parameter">format</replaceable></term>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
223 <listitem><para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
224 Sets the format of the text log output. Currently, the only valid output
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
225 format is T, for text; anything else gives the default.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
226 </para></listitem>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
227 </varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
228 <varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
229 <term>-t <replaceable class="parameter">include-types</replaceable></term>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
230 <listitem><para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
231 Print only the specified types of log messages.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
232 Types are specified in a comma-delimited list (e.g. 3,10,5,6).
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
233 </para></listitem>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
234 </varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
235 <varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
236 <term>-x <replaceable class="parameter">exclude-types</replaceable></term>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
237 <listitem><para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
238 Exclude the specified types of log messages.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
239 Types are specified in a comma-delimited list (e.g. 3,10,5,6).
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
240 </para></listitem>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
241 </varlistentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
242 </variablelist>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
243 </refsect1>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
244
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
245 <refsect1 id='readpstlog.message.types.1'>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
246 <title>Message Types</title>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
247 <para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
248 <command>readpstlog</command> understands the following types of log messages:
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
249 </para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
250 <variablelist>
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
251 <varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
252 <term>1</term>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
253 <listitem><para>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
254 File accesses
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
255 </para></listitem>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
256 </varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
257 <varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
258 <term>2</term>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
259 <listitem><para>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
260 Index accesses
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
261 </para></listitem>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
262 </varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
263 <varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
264 <term>3</term>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
265 <listitem><para>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
266 New email found
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
267 </para></listitem>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
268 </varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
269 <varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
270 <term>4</term>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
271 <listitem><para>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
272 Warnings
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
273 </para></listitem>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
274 </varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
275 <varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
276 <term>5</term>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
277 <listitem><para>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
278 Read accesses
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
279 </para></listitem>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
280 </varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
281 <varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
282 <term>6</term>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
283 <listitem><para>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
284 Informational messages
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
285 </para></listitem>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
286 </varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
287 <varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
288 <term>7</term>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
289 <listitem><para>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
290 Main function calls
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
291 </para></listitem>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
292 </varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
293 <varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
294 <term>8</term>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
295 <listitem><para>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
296 Decrypting calls
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
297 </para></listitem>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
298 </varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
299 <varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
300 <term>10</term>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
301 <listitem><para>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
302 Function calls
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
303 </para></listitem>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
304 </varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
305 <varlistentry>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
306 <term>11</term>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
307 <listitem><para>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
308 HexDump calls
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
309 </para></listitem>
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
310 </varlistentry>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
311 </variablelist>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
312 </refsect1>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
313
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
314 <refsect1 id='readpstlog.author.1'>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
315 <title>Author</title>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
316 <para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
317 This manual page was written by Joe Nahmias &lt;joe@nahmias.net&gt;
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
318 for the Debian GNU/Linux system (but may be used by others). It was
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
319 converted to xml format by Carl Byington &lt;carl@five-ten-sg.com&gt;.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
320 </para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
321 </refsect1>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
322
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
323 <refsect1 id='readpstlog.copyright.1'>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
324 <title>Copyright</title>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
325 <para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
326 Copyright (C) 2002 by David Smith &lt;dave.s@earthcorp.com&gt;.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
327 XML version Copyright (C) 2005 by 510 Software Group &lt;carl@five-ten-sg.com&gt;.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
328 </para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
329 <para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
330 This program is free software; you can redistribute it and/or modify it
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
331 under the terms of the GNU General Public License as published by the
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
332 Free Software Foundation; either version 2, or (at your option) any
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
333 later version.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
334 </para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
335 <para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
336 You should have received a copy of the GNU General Public License along
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
337 with this program; see the file COPYING. If not, please write to the
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
338 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
339 </para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
340 </refsect1>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
341
20
1acd3231c3a4 switch to automake/autoconf
carl
parents: 16
diff changeset
342 <refsect1 id='readpstlog.version.1'>
16
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
343 <title>CVS Version</title>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
344 <para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
345 $Id$
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
346 </para>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
347 </refsect1>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
348 </refentry>
c508ee15dfca switch to automake/autoconf
carl
parents:
diff changeset
349 </reference>