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