changeset 19:1246d317a05b

switch to automake/autoconf
author carl
date Sun, 19 Feb 2006 20:19:38 -0800
parents 69ab1d8b3293
children 1acd3231c3a4
files man/readpst.1 man/readpstlog.1
diffstat 2 files changed, 201 insertions(+), 151 deletions(-) [+]
line wrap: on
line diff
--- a/man/readpst.1	Sun Feb 19 19:51:50 2006 -0800
+++ b/man/readpst.1	Sun Feb 19 20:19:38 2006 -0800
@@ -1,87 +1,106 @@
-.\"                                      Hey, EMACS: -*- nroff -*-
-.\" First parameter, NAME, should be all caps
-.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
-.\" other parameters are allowed: see man(7), man(1)
-.TH READPST 1 "15 January 2005"
-.\" Please adjust this date whenever revising the manpage.
-.\"
-.\" Some roff macros, for reference:
-.\" .nh        disable hyphenation
-.\" .hy        enable hyphenation
-.\" .ad l      left justify
-.\" .ad b      justify to both left and right margins
-.\" .nf        disable filling
-.\" .fi        enable filling
-.\" .br        insert line break
-.\" .sp <n>    insert n+1 empty lines
-.\" for manpage-specific macros, see man(7)
+.\"Generated by db2man.xsl. Don't modify this, modify the source.
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "READPST" 1 "2006-02-19" "" ""
 .SH NAME
 readpst \- convert PST (MS Outlook Personal Folders) files to mbox format
-.SH SYNOPSIS
-.B readpst
-.RI [ options ] " files" ...
-.SH DESCRIPTION
-This manual page documents briefly the
-.B readpst
-command.
+.SH "SYNOPSIS"
+.ad l
+.hy 0
+.HP 8
+\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\&.\&.\&.]
+.ad
+.hy
+
+.SH "DESCRIPTION"
+
+.PP
+This manual page briefly documents the \fBreadpst\fR command\&.
+
 .PP
-.\" TeX users may be more comfortable with the \fB<whatever>\fP and
-.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
-.\" respectively.
-\fBreadpst\fP 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 seperate emails.
-.SH OPTIONS
-A summary of options is included below.
+ \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\&.
+
+.SH "OPTIONS"
+
+.TP
+\-c \fIformat\fR
+Set the Contact output mode\&. Use \-cv for vcard format or \-cl for an email list\&.
+
 .TP
-.B \-c
-Set the Contact output mode. Use -cv for vcard format or -cl for
-an email list
+\-d \fIdebug\-file\fR
+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\&.
+
+.TP
+\-h
+Show summary of options\&.
+
 .TP
-.B \-d
-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\fP.
+\-k
+Changes the output format to KMail\&.
+
 .TP
-.B \-h
-Show summary of options. Subsequent options are then ignored.
-.TP
-.B \-k
-Changes the output format to KMail.
+\-o \fIoutput\-directory\fR
+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\&.
+
 .TP
-.B \-o
-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.
+\-q
+Changes to silent mode\&. No feedback is printed to the screen, except for error messages\&.
+
+.TP
+\-r
+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\&.
+
 .TP
-.B \-q
-Changes to silent mode. No feedback is printed to the screen, except
-for error messages.
+\-S
+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\&.
+
 .TP
-.B \-r
-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.
+\-V
+Show version of program\&. Subsequent options are then ignored\&.
+
 .TP
-.B \-S
-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.
-.TP
-.B \-V
-Show version of program. Subsequent options are then ignored.
-.TP
-.B \-w
-Overwrite any previous output files. \fBBeware\fP: 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.
-.SH SEE ALSO
-.BR readpstlog (1)
-.SH AUTHORS
-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>.
+\-w
+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\&.
+
+.SH "SEE ALSO"
+
+.PP
+ \fBreadpstlog\fR() 
+
+.SH "AUTHOR"
+
+.PP
+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>\&.
+
+.SH "COPYRIGHT"
+
+.PP
+Copyright (C) 2002 by David Smith <dave\&.s@earthcorp\&.com>\&. XML version Copyright (C) 2005 by 510 Software Group <carl@five\-ten\-sg\&.com>\&.
+
+.PP
+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\&.
+
+.PP
+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\&.
+
+.SH "CVS VERSION"
+
+.PP
+$Id$
+
--- a/man/readpstlog.1	Sun Feb 19 19:51:50 2006 -0800
+++ b/man/readpstlog.1	Sun Feb 19 20:19:38 2006 -0800
@@ -1,87 +1,118 @@
-.\"                                      Hey, EMACS: -*- nroff -*-
-.\" First parameter, NAME, should be all caps
-.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
-.\" other parameters are allowed: see man(7), man(1)
-.TH READPSTLOG 1 "February 24, 2004"
-.\" Please adjust this date whenever revising the manpage.
-.\"
-.\" Some roff macros, for reference:
-.\" .nh        disable hyphenation
-.\" .hy        enable hyphenation
-.\" .ad l      left justify
-.\" .ad b      justify to both left and right margins
-.\" .nf        disable filling
-.\" .fi        enable filling
-.\" .br        insert line break
-.\" .sp <n>    insert n+1 empty lines
-.\" for manpage-specific macros, see man(7)
+.\"Generated by db2man.xsl. Don't modify this, modify the source.
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "READPSTLOG" 1 "2006-02-19" "" ""
 .SH NAME
 readpstlog \- convert a readpst logfile to text format
-.SH SYNOPSIS
-.B readpstlog
-.RI [ options ] " logfile"
-.SH DESCRIPTION
-This manual page documents briefly the
-.B readpstlog
-command.
+.SH "SYNOPSIS"
+.ad l
+.hy 0
+.HP 8
+\fBreadpst\fR [\fB\-f\ \fIformat\fR\fR] [\fB\-t\ \fIinclude\-types\fR\fR] [\fB\-x\ \fIexclude\-types\fR\fR] [logfile]
+.ad
+.hy
+
+.SH "DESCRIPTION"
+
+.PP
+This manual page briefly documents the \fBreadpstlog\fR command\&.
+
 .PP
-.\" TeX users may be more comfortable with the \fB<whatever>\fP and
-.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
-.\" respectively.
-\fBreadpstlog\fP is a program that reads the \fIbinary\fP logfile generated
-by \fBreadpst\fP, and outputs it in a more desirable format (i.e. text).
-.SH OPTIONS
-This program follows the usual GNU command line syntax.
-A summary of options is included below.
+ \fBreadpstlog\fR is a program that reads the binary logfile generated by \fBreadpst\fR, and outputs it in a more desirable format (i\&.e\&. text)\&.
+
+.SH "OPTIONS"
+
+.TP
+\-f \fIformat\fR
+Sets the format of the text log output\&. Currently, the only valid output format is T, for text; anything else gives the default\&.
+
+.TP
+\-t \fIinclude\-types\fR
+Print only the specified types of log messages\&. Types are specified in a comma\-delimited list (e\&.g\&. 3,10,5,6)\&.
+
 .TP
-.BR \-f " \fIformat\fP"
-Sets the format of the text log output.  Currently, the only valid output
-format is \fBT\fP, for text; anything else gives the default.
-.TP
-.BR \-t " \fItypes\fP"
-Tells \fBreadpstlog\fP to print only the specified types of log messages.
-Types are specified in a comma\-delimited list (e.g. 3,10,5,6).
+\-x \fIexclude\-types\fR
+Exclude the specified types of log messages\&. Types are specified in a comma\-delimited list (e\&.g\&. 3,10,5,6)\&.
+
+.SH "MESSAGE TYPES"
+
+.PP
+ \fBreadpstlog\fR understands the following types of log messages:
+
 .TP
-.BR \-x " \fItypes\fP"
-Tells \fBreadpstlog\fP to exclude the specified types of log messages.
-Types are specified in a comma\-delimited list (e.g. 3,10,5,6).
-.SH LOG MESSAGE TYPES
-.PP
-\fBreadpstlog\fP understands the following types of log messages:
-.RS 15
+1
+File accesses
+
+.TP
+2
+Index accesses
+
+.TP
+3
+New email found
+
 .TP
-.B 1
-File accesses
+4
+Warnings
+
 .TP
-.B 2
-Index accesses
+5
+Read accesses
+
 .TP
-.B 3
-New email found
+6
+Informational messages
+
 .TP
-.B 4
-Warnings
+7
+Main function calls
+
 .TP
-.B 5
-Read accesses
+8
+Decrypting calls
+
 .TP
-.B 6
-Informational messages
+10
+Function calls
+
 .TP
-.B 7
-Main function calls
-.TP
-.B 8
-Decrypting calls
-.TP
-.B 10
-Function calls
-.TP
-.B 11
+11
 HexDump calls
-.RE
-.SH SEE ALSO
-.BR readpst (1)
-.SH AUTHOR
-This manual page was written by Joe Nahmias <joe@nahmias.net> for the Debian
-GNU/Linux system (but may be used by others).
+
+.SH "AUTHOR"
+
+.PP
+This manual page was written by Joe Nahmias <joe@nahmias\&.net> for the Debian GNU/Linux system (but may be used by others)\&. It was converted to xml format by Carl Byington <carl@five\-ten\-sg\&.com>\&.
+
+.SH "COPYRIGHT"
+
+.PP
+Copyright (C) 2002 by David Smith <dave\&.s@earthcorp\&.com>\&. XML version Copyright (C) 2005 by 510 Software Group <carl@five\-ten\-sg\&.com>\&.
+
+.PP
+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\&.
+
+.PP
+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\&.
+
+.SH "CVS VERSION"
+
+.PP
+$Id$
+