annotate man/readpst.1 @ 17:ec7e344e0dfb

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