Mercurial > libpst

comparison xml/libpst.in @ 20:1acd3231c3a4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
switch to automake/autoconf
author carl
date Sun, 19 Feb 2006 20:19:38 -0800
parents c508ee15dfca
children e5418051878c
comparison
equal deleted inserted replaced
19:1246d317a05b 20:1acd3231c3a4
19 <refentrytitle>readpst</refentrytitle> 19 <refentrytitle>readpst</refentrytitle>
20 <manvolnum>1</manvolnum> 20 <manvolnum>1</manvolnum>
21 <refmiscinfo>readpst @VERSION@</refmiscinfo> 21 <refmiscinfo>readpst @VERSION@</refmiscinfo>
22 </refmeta> 22 </refmeta>
23 23
24 <refnamediv id='name.1'> 24 <refnamediv id='readpst.name.1'>
25 <refname>readpst</refname> 25 <refname>readpst</refname>
26 <refpurpose>convert PST (MS Outlook Personal Folders) files to mbox format</refpurpose> 26 <refpurpose>convert PST (MS Outlook Personal Folders) files to mbox format</refpurpose>
27 </refnamediv> 27 </refnamediv>
28 28
29 <refsect1 id='description.1'> 29 <refsynopsisdiv id='readpst.synopsis.1'>
30 <title>Description</title>
31 <para>This manual page briefly documents the <command>readpst</command> command.</para>
32 <para>
33 <command>readpst</command> is a program that can read an Outlook PST (Personal Folders) file
34 and convert it into an mbox file, a format suitable for KMail, a recursive mbox
35 structure, or separate emails.
36 </para>
37 </refsect1>
38
39 <refsynopsisdiv id='synopsis.1'>
40 <title>Synopsis</title> 30 <title>Synopsis</title>
41 <cmdsynopsis> 31 <cmdsynopsis>
42 <command>readpst</command> 32 <command>readpst</command>
43 <arg><option>-c <replaceable class="parameter">format</replaceable></option></arg> 33 <arg><option>-c <replaceable class="parameter">format</replaceable></option></arg>
44 <arg><option>-d <replaceable class="parameter">debug-file</replaceable></option></arg> 34 <arg><option>-d <replaceable class="parameter">debug-file</replaceable></option></arg>
52 <arg><option>-w</option></arg> 42 <arg><option>-w</option></arg>
53 <arg>files...</arg> 43 <arg>files...</arg>
54 </cmdsynopsis> 44 </cmdsynopsis>
55 </refsynopsisdiv> 45 </refsynopsisdiv>
56 46
57 <refsect1 id='options.1'> 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'>
58 <title>Options</title> 57 <title>Options</title>
59 <variablelist> 58 <variablelist>
60 <varlistentry> 59 <varlistentry>
61 <term>-c <replaceable class="parameter">format</replaceable></term> 60 <term>-c <replaceable class="parameter">format</replaceable></term>
62 <listitem><para> 61 <listitem><para>
81 <listitem><para> 80 <listitem><para>
82 Changes the output format to KMail. 81 Changes the output format to KMail.
83 </para></listitem> 82 </para></listitem>
84 </varlistentry> 83 </varlistentry>
85 <varlistentry> 84 <varlistentry>
86 <term>-o <replaceable class="parameter">output-directory</term> 85 <term>-o <replaceable class="parameter">output-directory</replaceable></term>
87 <listitem><para> 86 <listitem><para>
88 Specifies the output directory. The directory must already exist, and 87 Specifies the output directory. The directory must already exist, and
89 is entered after the PST file is opened, but before any processing of 88 is entered after the PST file is opened, but before any processing of
90 files commences. 89 files commences.
91 </para></listitem> 90 </para></listitem>
107 </para></listitem> 106 </para></listitem>
108 </varlistentry> 107 </varlistentry>
109 <varlistentry> 108 <varlistentry>
110 <term>-S</term> 109 <term>-S</term>
111 <listitem><para> 110 <listitem><para>
112 Output messages into seperate files. This will create folders as 111 Output messages into separate files. This will create folders as
113 named in the PST file, and will put each email in its own file. These 112 named in the PST file, and will put each email in its own file. These
114 files will be numbered from 000000000 increasing in intervals of 1 (ie 113 files will be numbered from 000000000 increasing in intervals of 1 (ie
115 000000000, 000000001, 0000000002). Any attachments are saved alongside 114 000000000, 000000001, 0000000002). Any attachments are saved alongside
116 each email as 000000000-attach0, or with the name of the attachment if 115 each email as 000000000-attach0, or with the name of the attachment if
117 one is present. 116 one is present.
124 </para></listitem> 123 </para></listitem>
125 </varlistentry> 124 </varlistentry>
126 <varlistentry> 125 <varlistentry>
127 <term>-w</term> 126 <term>-w</term>
128 <listitem><para> 127 <listitem><para>
129 Overwrite any previous output files. <B>Beware</B>: When used with the -S 128 Overwrite any previous output files. Beware: When used with the -S
130 switch, this will remove all files from the target folder before 129 switch, this will remove all files from the target folder before
131 writing. This is to keep the count of emails and attachments correct. 130 writing. This is to keep the count of emails and attachments correct.
132 </para></listitem> 131 </para></listitem>
133 </varlistentry> 132 </varlistentry>
134 </variablelist> 133 </variablelist>
135 </refsect1> 134 </refsect1>
136 135
137 <refsect1 id='also.1'> 136 <refsect1 id='readpst.also.1'>
138 <title>See Also</title> 137 <title>See Also</title>
139 <para> 138 <para>
140 <citerefentry><refentrytitle>readpstlog</refentrytitle><para> 139 <citerefentry><refentrytitle>readpstlog</refentrytitle></citerefentry>
141 </para> 140 </para>
142 </refsect1> 141 </refsect1>
143 142
144 <refsect1 id='author.1'> 143 <refsect1 id='readpst.author.1'>
145 <title>Author</title> 144 <title>Author</title>
146 <para> 145 <para>
147 This manual page was originally written by Dave Smith 146 This manual page was originally written by Dave Smith
148 &lt;dave.s@earthcorp.com&gt;, and updated by Joe Nahmias &lt;joe@nahmias.net&gt; 147 &lt;dave.s@earthcorp.com&gt;, and updated by Joe Nahmias &lt;joe@nahmias.net&gt;
149 for the Debian GNU/Linux system (but may be used by others). It was 148 for the Debian GNU/Linux system (but may be used by others). It was
150 subsequently updated by Brad Hards &ltbradh@frogmouth.net&gt;, and converted to 149 subsequently updated by Brad Hards &lt;bradh@frogmouth.net&gt;, and converted to
151 xml format by Carl Byington &lt;carl@five-ten-sg.com&gt;. 150 xml format by Carl Byington &lt;carl@five-ten-sg.com&gt;.
152 </para> 151 </para>
153 </refsect1> 152 </refsect1>
154 153
155 <refsect1 id='copyright.1'> 154 <refsect1 id='readpst.copyright.1'>
156 <title>Copyright</title> 155 <title>Copyright</title>
157 <para> 156 <para>
158 Copyright (C) 2002 by David Smith &lt;dave.s@earthcorp.com&gt;. 157 Copyright (C) 2002 by David Smith &lt;dave.s@earthcorp.com&gt;.
159 XML version Copyright (C) 2005 by 510 Software Group &lt;carl@five-ten-sg.com&gt;. 158 XML version Copyright (C) 2005 by 510 Software Group &lt;carl@five-ten-sg.com&gt;.
160 </para> 159 </para>
169 with this program; see the file COPYING. If not, please write to the 168 with this program; see the file COPYING. If not, please write to the
170 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 169 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
171 </para> 170 </para>
172 </refsect1> 171 </refsect1>
173 172
174 <refsect1 id='version.1'> 173 <refsect1 id='readpst.version.1'>
175 <title>CVS Version</title> 174 <title>CVS Version</title>
176 <para> 175 <para>
177 $Id$ 176 $Id$
178 </para> 177 </para>
179 </refsect1> 178 </refsect1>
189 <refentrytitle>readpstlog</refentrytitle> 188 <refentrytitle>readpstlog</refentrytitle>
190 <manvolnum>1</manvolnum> 189 <manvolnum>1</manvolnum>
191 <refmiscinfo>readpstlog @VERSION@</refmiscinfo> 190 <refmiscinfo>readpstlog @VERSION@</refmiscinfo>
192 </refmeta> 191 </refmeta>
193 192
194 <refnamediv id='name.1'> 193 <refnamediv id='readpstlog.name.1'>
195 <refname>readpstlog</refname> 194 <refname>readpstlog</refname>
196 <refpurpose>convert a readpst logfile to text format</refpurpose> 195 <refpurpose>convert a readpst logfile to text format</refpurpose>
197 </refnamediv> 196 </refnamediv>
198 197
199 <refsect1 id='description.1'> 198 <refsynopsisdiv id='readpstlog.synopsis.1'>
200 <title>Description</title>
201 <para>This manual page briefly documents the <command>readpstlog</command> command.</para>
202 <para>
203 <command>readpstlog</command>
204 is a program that reads the binary logfile generated
205 by <command>readpst</command>, and outputs it in a more desirable format (i.e. text).
206 </para>
207 </refsect1>
208
209 <refsynopsisdiv id='synopsis.1'>
210 <title>Synopsis</title> 199 <title>Synopsis</title>
211 <cmdsynopsis> 200 <cmdsynopsis>
212 <command>readpst</command> 201 <command>readpst</command>
213 <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg> 202 <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg>
214 <arg><option>-t <replaceable class="parameter">include-types</replaceable></option></arg> 203 <arg><option>-t <replaceable class="parameter">include-types</replaceable></option></arg>
215 <arg><option>-x <replaceable class="parameter">exclude-types</replaceable></option></arg> 204 <arg><option>-x <replaceable class="parameter">exclude-types</replaceable></option></arg>
216 <arg>logfile</arg> 205 <arg>logfile</arg>
217 </cmdsynopsis> 206 </cmdsynopsis>
218 </refsynopsisdiv> 207 </refsynopsisdiv>
219 208
220 <refsect1 id='options.1'> 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'>
221 <title>Options</title> 220 <title>Options</title>
222 <variablelist> 221 <variablelist>
223 <varlistentry> 222 <varlistentry>
224 <term>-f <replaceable class="parameter">format</replaceable></term> 223 <term>-f <replaceable class="parameter">format</replaceable></term>
225 <listitem><para> 224 <listitem><para>
242 </para></listitem> 241 </para></listitem>
243 </varlistentry> 242 </varlistentry>
244 </variablelist> 243 </variablelist>
245 </refsect1> 244 </refsect1>
246 245
247 <refsect1 id='message.types.1'> 246 <refsect1 id='readpstlog.message.types.1'>
248 <title>Message Types</title> 247 <title>Message Types</title>
249 <para> 248 <para>
250 <command>readpstlog</command> understands the following types of log messages: 249 <command>readpstlog</command> understands the following types of log messages:
251 </para> 250 </para>
252 <variablelist> 251 <variablelist>
253 <listitem><para> 252 <varlistentry>
254 1 File accesses 253 <term>1</term>
255 </para></listitem> 254 <listitem><para>
256 <listitem><para> 255 File accesses
257 2 Index accesses 256 </para></listitem>
258 </para></listitem> 257 </varlistentry>
259 <listitem><para> 258 <varlistentry>
260 3 New email found 259 <term>2</term>
261 </para></listitem> 260 <listitem><para>
262 <listitem><para> 261 Index accesses
263 4 Warnings 262 </para></listitem>
264 </para></listitem> 263 </varlistentry>
265 <listitem><para> 264 <varlistentry>
266 5 Read accesses 265 <term>3</term>
267 </para></listitem> 266 <listitem><para>
268 <listitem><para> 267 New email found
269 6 Informational messages 268 </para></listitem>
270 </para></listitem> 269 </varlistentry>
271 <listitem><para> 270 <varlistentry>
272 7 Main function calls 271 <term>4</term>
273 </para></listitem> 272 <listitem><para>
274 <listitem><para> 273 Warnings
275 8 Decrypting calls 274 </para></listitem>
276 </para></listitem> 275 </varlistentry>
277 <listitem><para> 276 <varlistentry>
278 10 Function calls 277 <term>5</term>
279 </para></listitem> 278 <listitem><para>
280 <listitem><para> 279 Read accesses
281 11 HexDump calls 280 </para></listitem>
282 </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>
283 </variablelist> 312 </variablelist>
284 </refsect1> 313 </refsect1>
285 314
286 <refsect1 id='author.1'> 315 <refsect1 id='readpstlog.author.1'>
287 <title>Author</title> 316 <title>Author</title>
288 <para> 317 <para>
289 This manual page was written by Joe Nahmias &lt;joe@nahmias.net&gt; 318 This manual page was written by Joe Nahmias &lt;joe@nahmias.net&gt;
290 for the Debian GNU/Linux system (but may be used by others). It was 319 for the Debian GNU/Linux system (but may be used by others). It was
291 converted to xml format by Carl Byington &lt;carl@five-ten-sg.com&gt;. 320 converted to xml format by Carl Byington &lt;carl@five-ten-sg.com&gt;.
292 </para> 321 </para>
293 </refsect1> 322 </refsect1>
294 323
295 <refsect1 id='copyright.1'> 324 <refsect1 id='readpstlog.copyright.1'>
296 <title>Copyright</title> 325 <title>Copyright</title>
297 <para> 326 <para>
298 Copyright (C) 2002 by David Smith &lt;dave.s@earthcorp.com&gt;. 327 Copyright (C) 2002 by David Smith &lt;dave.s@earthcorp.com&gt;.
299 XML version Copyright (C) 2005 by 510 Software Group &lt;carl@five-ten-sg.com&gt;. 328 XML version Copyright (C) 2005 by 510 Software Group &lt;carl@five-ten-sg.com&gt;.
300 </para> 329 </para>
309 with this program; see the file COPYING. If not, please write to the 338 with this program; see the file COPYING. If not, please write to the
310 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 339 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
311 </para> 340 </para>
312 </refsect1> 341 </refsect1>
313 342
314 <refsect1 id='version.1'> 343 <refsect1 id='readpstlog.version.1'>
315 <title>CVS Version</title> 344 <title>CVS Version</title>
316 <para> 345 <para>
317 $Id$ 346 $Id$
318 </para> 347 </para>
319 </refsect1> 348 </refsect1>