Mercurial > libpst

comparison man/readpst.1 @ 19:1246d317a05b

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
comparison
equal deleted inserted replaced
18:69ab1d8b3293 19:1246d317a05b
1 .\" Hey, EMACS: -*- nroff -*- 1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .\" First parameter, NAME, should be all caps 2 .de Sh \" Subsection
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection 3 .br
4 .\" other parameters are allowed: see man(7), man(1) 4 .if t .Sp
5 .TH READPST 1 "15 January 2005" 5 .ne 5
6 .\" Please adjust this date whenever revising the manpage. 6 .PP
7 .\" 7 \fB\\$1\fR
8 .\" Some roff macros, for reference: 8 .PP
9 .\" .nh disable hyphenation 9 ..
10 .\" .hy enable hyphenation 10 .de Sp \" Vertical space (when we can't use .PP)
11 .\" .ad l left justify 11 .if t .sp .5v
12 .\" .ad b justify to both left and right margins 12 .if n .sp
13 .\" .nf disable filling 13 ..
14 .\" .fi enable filling 14 .de Ip \" List item
15 .\" .br insert line break 15 .br
16 .\" .sp <n> insert n+1 empty lines 16 .ie \\n(.$>=3 .ne \\$3
17 .\" for manpage-specific macros, see man(7) 17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "READPST" 1 "2006-02-19" "" ""
18 .SH NAME 21 .SH NAME
19 readpst \- convert PST (MS Outlook Personal Folders) files to mbox format 22 readpst \- convert PST (MS Outlook Personal Folders) files to mbox format
20 .SH SYNOPSIS 23 .SH "SYNOPSIS"
21 .B readpst 24 .ad l
22 .RI [ options ] " files" ... 25 .hy 0
23 .SH DESCRIPTION 26 .HP 8
24 This manual page documents briefly the 27 \fBreadpst\fR [\fB\-c\ \fIformat\fR\fR] [\fB\-d\ \fIdebug\-file\fR\fR] [\fB\-h\fR] [\fB\-k\fR] [\fB\-o\ \fIoutput\-directory\fR\fR] [\fB\-q\fR] [\fB\-r\fR] [\fB\-S\fR] [\fB\-V\fR] [\fB\-w\fR] [files\&.\&.\&.]
25 .B readpst 28 .ad
26 command. 29 .hy
30
31 .SH "DESCRIPTION"
32
27 .PP 33 .PP
28 .\" TeX users may be more comfortable with the \fB<whatever>\fP and 34 This manual page briefly documents the \fBreadpst\fR command\&.
29 .\" \fI<whatever>\fP escape sequences to invode bold face and italics, 35
30 .\" respectively. 36 .PP
31 \fBreadpst\fP is a program that can read an Outlook PST (Personal Folders) file 37 \fBreadpst\fR is a program that can read an Outlook PST (Personal Folders) file and convert it into an mbox file, a format suitable for KMail, a recursive mbox structure, or separate emails\&.
32 and convert it into an mbox file, a format suitable for KMail, a recursive mbox 38
33 structure, or seperate emails. 39 .SH "OPTIONS"
34 .SH OPTIONS 40
35 A summary of options is included below.
36 .TP 41 .TP
37 .B \-c 42 \-c \fIformat\fR
38 Set the Contact output mode. Use -cv for vcard format or -cl for 43 Set the Contact output mode\&. Use \-cv for vcard format or \-cl for an email list\&.
39 an email list 44
40 .TP 45 .TP
41 .B \-d 46 \-d \fIdebug\-file\fR
42 Specify name of debug log file. Defaults to "readpst.log". The log 47 Specify name of debug log file\&. Defaults to "readpst\&.log"\&. The log file isn't an ascii file, it is a binary file readable by \fBreadpstlog\fR\&.
43 file isn\'t an ascii file, it is a binary file readable by \fBreadpstlog\fP. 48
44 .TP 49 .TP
45 .B \-h 50 \-h
46 Show summary of options. Subsequent options are then ignored. 51 Show summary of options\&.
52
47 .TP 53 .TP
48 .B \-k 54 \-k
49 Changes the output format to KMail. 55 Changes the output format to KMail\&.
56
50 .TP 57 .TP
51 .B \-o 58 \-o \fIoutput\-directory\fR
52 Specifies the output directory. The directory must already exist, and 59 Specifies the output directory\&. The directory must already exist, and is entered after the PST file is opened, but before any processing of files commences\&.
53 is entered after the PST file is opened, but before any processing of 60
54 files commences.
55 .TP 61 .TP
56 .B \-q 62 \-q
57 Changes to silent mode. No feedback is printed to the screen, except 63 Changes to silent mode\&. No feedback is printed to the screen, except for error messages\&.
58 for error messages. 64
59 .TP 65 .TP
60 .B \-r 66 \-r
61 Changes the output format to Recursive. This will create folders as 67 Changes the output format to Recursive\&. This will create folders as named in the PST file, and will put all emails in a file called "mbox" inside each folder\&. These files are then compatible with all mbox\-compatible email clients\&.
62 named in the PST file, and will put all emails in a file called "mbox" 68
63 inside each folder. These files are then compatible with all
64 mbox\-compatible email clients.
65 .TP 69 .TP
66 .B \-S 70 \-S
67 Output messages into seperate files. This will create folders as 71 Output messages into seperate files\&. This will create folders as named in the PST file, and will put each email in its own file\&. These files will be numbered from 000000000 increasing in intervals of 1 (ie 000000000, 000000001, 0000000002)\&. Any attachments are saved alongside each email as 000000000\-attach0, or with the name of the attachment if one is present\&.
68 named in the PST file, and will put each email in its own file. These 72
69 files will be numbered from 000000000 increasing in intervals of 1 (ie
70 000000000, 000000001, 0000000002). Any attachments are saved alongside
71 each email as 000000000\-attach0, or with the name of the attachment if
72 one is present.
73 .TP 73 .TP
74 .B \-V 74 \-V
75 Show version of program. Subsequent options are then ignored. 75 Show version of program\&. Subsequent options are then ignored\&.
76
76 .TP 77 .TP
77 .B \-w 78 \-w
78 Overwrite any previous output files. \fBBeware\fP: When used with the \-S 79 Overwrite any previous output files\&. Beware: When used with the \-S switch, this will remove all files from the target folder before writing\&. This is to keep the count of emails and attachments correct\&.
79 switch, this will remove all files from the target folder before 80
80 writing. This is to keep the count of emails and attachments correct. 81 .SH "SEE ALSO"
81 .SH SEE ALSO 82
82 .BR readpstlog (1) 83 .PP
83 .SH AUTHORS 84 \fBreadpstlog\fR()
84 This manual page was originally written by Dave Smith 85
85 <dave.s@earthcorp.com>, and updated by Joe Nahmias <joe@nahmias.net> 86 .SH "AUTHOR"
86 for the Debian GNU/Linux system (but may be used by others). It was 87
87 subsequently updated by Brad Hards <bradh@frogmouth.net>. 88 .PP
89 This manual page was originally written by Dave Smith <dave\&.s@earthcorp\&.com>, and updated by Joe Nahmias <joe@nahmias\&.net> for the Debian GNU/Linux system (but may be used by others)\&. It was subsequently updated by Brad Hards <bradh@frogmouth\&.net>, and converted to xml format by Carl Byington <carl@five\-ten\-sg\&.com>\&.
90
91 .SH "COPYRIGHT"
92
93 .PP
94 Copyright (C) 2002 by David Smith <dave\&.s@earthcorp\&.com>\&. XML version Copyright (C) 2005 by 510 Software Group <carl@five\-ten\-sg\&.com>\&.
95
96 .PP
97 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version\&.
98
99 .PP
100 You should have received a copy of the GNU General Public License along with this program; see the file COPYING\&. If not, please write to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA\&.
101
102 .SH "CVS VERSION"
103
104 .PP
105 $Id$
106