annotate readpst.1 @ 3:fac01758bd41

Initial revision
author carl
date Thu, 23 Dec 2004 11:17:37 -0800
parents
children 3f2fedec798c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
fac01758bd41 Initial revision
carl
parents:
diff changeset
1 .\" Hey, EMACS: -*- nroff -*-
fac01758bd41 Initial revision
carl
parents:
diff changeset
2 .\" First parameter, NAME, should be all caps
fac01758bd41 Initial revision
carl
parents:
diff changeset
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
fac01758bd41 Initial revision
carl
parents:
diff changeset
4 .\" other parameters are allowed: see man(7), man(1)
fac01758bd41 Initial revision
carl
parents:
diff changeset
5 .TH READPST 1 "February 24, 2004"
fac01758bd41 Initial revision
carl
parents:
diff changeset
6 .\" Please adjust this date whenever revising the manpage.
fac01758bd41 Initial revision
carl
parents:
diff changeset
7 .\"
fac01758bd41 Initial revision
carl
parents:
diff changeset
8 .\" Some roff macros, for reference:
fac01758bd41 Initial revision
carl
parents:
diff changeset
9 .\" .nh disable hyphenation
fac01758bd41 Initial revision
carl
parents:
diff changeset
10 .\" .hy enable hyphenation
fac01758bd41 Initial revision
carl
parents:
diff changeset
11 .\" .ad l left justify
fac01758bd41 Initial revision
carl
parents:
diff changeset
12 .\" .ad b justify to both left and right margins
fac01758bd41 Initial revision
carl
parents:
diff changeset
13 .\" .nf disable filling
fac01758bd41 Initial revision
carl
parents:
diff changeset
14 .\" .fi enable filling
fac01758bd41 Initial revision
carl
parents:
diff changeset
15 .\" .br insert line break
fac01758bd41 Initial revision
carl
parents:
diff changeset
16 .\" .sp <n> insert n+1 empty lines
fac01758bd41 Initial revision
carl
parents:
diff changeset
17 .\" for manpage-specific macros, see man(7)
fac01758bd41 Initial revision
carl
parents:
diff changeset
18 .SH NAME
fac01758bd41 Initial revision
carl
parents:
diff changeset
19 readpst \- convert PST (MS Outlook Personal Folders) files to mbox format
fac01758bd41 Initial revision
carl
parents:
diff changeset
20 .SH SYNOPSIS
fac01758bd41 Initial revision
carl
parents:
diff changeset
21 .B readpst
fac01758bd41 Initial revision
carl
parents:
diff changeset
22 .RI [ options ] " files" ...
fac01758bd41 Initial revision
carl
parents:
diff changeset
23 .SH DESCRIPTION
fac01758bd41 Initial revision
carl
parents:
diff changeset
24 This manual page documents briefly the
fac01758bd41 Initial revision
carl
parents:
diff changeset
25 .B readpst
fac01758bd41 Initial revision
carl
parents:
diff changeset
26 command.
fac01758bd41 Initial revision
carl
parents:
diff changeset
27 .PP
fac01758bd41 Initial revision
carl
parents:
diff changeset
28 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
fac01758bd41 Initial revision
carl
parents:
diff changeset
29 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
fac01758bd41 Initial revision
carl
parents:
diff changeset
30 .\" respectively.
fac01758bd41 Initial revision
carl
parents:
diff changeset
31 \fBreadpst\fP is a program that can read an Outlook PST (Personal Folders) file
fac01758bd41 Initial revision
carl
parents:
diff changeset
32 and convert it into an mbox file, a format suitable for KMail, a recursive mbox
fac01758bd41 Initial revision
carl
parents:
diff changeset
33 structure, or seperate emails.
fac01758bd41 Initial revision
carl
parents:
diff changeset
34 .SH OPTIONS
fac01758bd41 Initial revision
carl
parents:
diff changeset
35 A summary of options is included below.
fac01758bd41 Initial revision
carl
parents:
diff changeset
36 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
37 .B \-d
fac01758bd41 Initial revision
carl
parents:
diff changeset
38 Specify name of debug log file. Defaults to "readpst.log". The log
fac01758bd41 Initial revision
carl
parents:
diff changeset
39 file isn\'t an ascii file, it is a binary file readable by \fBreadpstlog\fP.
fac01758bd41 Initial revision
carl
parents:
diff changeset
40 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
41 .B \-h
fac01758bd41 Initial revision
carl
parents:
diff changeset
42 Show summary of options.
fac01758bd41 Initial revision
carl
parents:
diff changeset
43 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
44 .B \-k
fac01758bd41 Initial revision
carl
parents:
diff changeset
45 Changes the output format to KMail.
fac01758bd41 Initial revision
carl
parents:
diff changeset
46 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
47 .B \-o
fac01758bd41 Initial revision
carl
parents:
diff changeset
48 Specifies the output directory. The directory must already exist, and
fac01758bd41 Initial revision
carl
parents:
diff changeset
49 is entered after the PST file is opened, but before any processing of
fac01758bd41 Initial revision
carl
parents:
diff changeset
50 files commences.
fac01758bd41 Initial revision
carl
parents:
diff changeset
51 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
52 .B \-q
fac01758bd41 Initial revision
carl
parents:
diff changeset
53 Changes to silent mode. No feedback is printed to the screen, except
fac01758bd41 Initial revision
carl
parents:
diff changeset
54 for error messages.
fac01758bd41 Initial revision
carl
parents:
diff changeset
55 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
56 .B \-r
fac01758bd41 Initial revision
carl
parents:
diff changeset
57 Changes the output format to Recursive. This will create folders as
fac01758bd41 Initial revision
carl
parents:
diff changeset
58 named in the PST file, and will put all emails in a file called "mbox"
fac01758bd41 Initial revision
carl
parents:
diff changeset
59 inside each folder. These files are then compatible with all
fac01758bd41 Initial revision
carl
parents:
diff changeset
60 mbox\-compatible email clients.
fac01758bd41 Initial revision
carl
parents:
diff changeset
61 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
62 .B \-S
fac01758bd41 Initial revision
carl
parents:
diff changeset
63 Output messages into seperate files. This will create folders as
fac01758bd41 Initial revision
carl
parents:
diff changeset
64 named in the PST file, and will put each email in its own file. These
fac01758bd41 Initial revision
carl
parents:
diff changeset
65 files will be numbered from 000000000 increasing in intervals of 1 (ie
fac01758bd41 Initial revision
carl
parents:
diff changeset
66 000000000, 000000001, 0000000002). Any attachments are saved alongside
fac01758bd41 Initial revision
carl
parents:
diff changeset
67 each email as 000000000\-attach0, or with the name of the attachment if
fac01758bd41 Initial revision
carl
parents:
diff changeset
68 one is present.
fac01758bd41 Initial revision
carl
parents:
diff changeset
69 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
70 .B \-V
fac01758bd41 Initial revision
carl
parents:
diff changeset
71 Show version of program.
fac01758bd41 Initial revision
carl
parents:
diff changeset
72 .TP
fac01758bd41 Initial revision
carl
parents:
diff changeset
73 .B \-w
fac01758bd41 Initial revision
carl
parents:
diff changeset
74 Overwrite any previous output files. \fBBeware\fP: When used with the \-S
fac01758bd41 Initial revision
carl
parents:
diff changeset
75 switch, this will remove all files from the target folder before
fac01758bd41 Initial revision
carl
parents:
diff changeset
76 writing. This is to keep the count of emails and attachments correct.
fac01758bd41 Initial revision
carl
parents:
diff changeset
77 .SH SEE ALSO
fac01758bd41 Initial revision
carl
parents:
diff changeset
78 .BR readpstlog (1)
fac01758bd41 Initial revision
carl
parents:
diff changeset
79 .SH AUTHOR
fac01758bd41 Initial revision
carl
parents:
diff changeset
80 This manual page was written by Dave Smith <dave.s@earthcorp.com>, and updated
fac01758bd41 Initial revision
carl
parents:
diff changeset
81 by Joe Nahmias <joe@nahmias.net> for the Debian GNU/Linux system (but may be
fac01758bd41 Initial revision
carl
parents:
diff changeset
82 used by others).