Mercurial > libpst

comparison xml/libpst.in @ 16:c508ee15dfca

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