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