annotate xml/libpst.in @ 16:c508ee15dfca

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