Mercurial > libpst
diff xml/libpst.in @ 16:c508ee15dfca
switch to automake/autoconf
| author | carl |
|---|---|
| date | Sun, 19 Feb 2006 18:47:46 -0800 |
| parents | |
| children | 1acd3231c3a4 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/xml/libpst.in Sun Feb 19 18:47:46 2006 -0800 @@ -0,0 +1,321 @@ +<reference> + <title>@PACKAGE@ Utilities - Version @VERSION@</title> + <partintro> + <title>Packages</title> + <para>The various source and binary packages are available at <ulink + url="http://www.five-ten-sg.com/@PACKAGE@/packages/">http://www.five-ten-sg.com/@PACKAGE@/packages/</ulink> + The most recent documentation is available at <ulink + url="http://www.five-ten-sg.com/@PACKAGE@/">http://www.five-ten-sg.com/@PACKAGE@/</ulink> + </para> + + </partintro> + + <refentry id="readpst.1"> + <refentryinfo> + <date>2006-02-19</date> + </refentryinfo> + + <refmeta> + <refentrytitle>readpst</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo>readpst @VERSION@</refmiscinfo> + </refmeta> + + <refnamediv id='name.1'> + <refname>readpst</refname> + <refpurpose>convert PST (MS Outlook Personal Folders) files to mbox format</refpurpose> + </refnamediv> + + <refsect1 id='description.1'> + <title>Description</title> + <para>This manual page briefly documents the <command>readpst</command> command.</para> + <para> + <command>readpst</command> 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. + </para> + </refsect1> + + <refsynopsisdiv id='synopsis.1'> + <title>Synopsis</title> + <cmdsynopsis> + <command>readpst</command> + <arg><option>-c <replaceable class="parameter">format</replaceable></option></arg> + <arg><option>-d <replaceable class="parameter">debug-file</replaceable></option></arg> + <arg><option>-h</option></arg> + <arg><option>-k</option></arg> + <arg><option>-o <replaceable class="parameter">output-directory</replaceable></option></arg> + <arg><option>-q</option></arg> + <arg><option>-r</option></arg> + <arg><option>-S</option></arg> + <arg><option>-V</option></arg> + <arg><option>-w</option></arg> + <arg>files...</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='options.1'> + <title>Options</title> + <variablelist> + <varlistentry> + <term>-c <replaceable class="parameter">format</replaceable></term> + <listitem><para> + Set the Contact output mode. Use -cv for vcard format or -cl for an email list. + </para></listitem> + </varlistentry> + <varlistentry> + <term>-d <replaceable class="parameter">debug-file</replaceable></term> + <listitem><para> + 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 <command>readpstlog</command>. + </para></listitem> + </varlistentry> + <varlistentry> + <term>-h</term> + <listitem><para> + Show summary of options. + </para></listitem> + </varlistentry> + <varlistentry> + <term>-k</term> + <listitem><para> + Changes the output format to KMail. + </para></listitem> + </varlistentry> + <varlistentry> + <term>-o <replaceable class="parameter">output-directory</term> + <listitem><para> + 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. + </para></listitem> + </varlistentry> + <varlistentry> + <term>-q</term> + <listitem><para> + Changes to silent mode. No feedback is printed to the screen, except + for error messages. + </para></listitem> + </varlistentry> + <varlistentry> + <term>-r</term> + <listitem><para> + 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. + </para></listitem> + </varlistentry> + <varlistentry> + <term>-S</term> + <listitem><para> + 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. + </para></listitem> + </varlistentry> + <varlistentry> + <term>-V</term> + <listitem><para> + Show version of program. Subsequent options are then ignored. + </para></listitem> + </varlistentry> + <varlistentry> + <term>-w</term> + <listitem><para> + Overwrite any previous output files. <B>Beware</B>: 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. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id='also.1'> + <title>See Also</title> + <para> + <citerefentry><refentrytitle>readpstlog</refentrytitle><para> + </para> + </refsect1> + + <refsect1 id='author.1'> + <title>Author</title> + <para> + 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>. + </para> + </refsect1> + + <refsect1 id='copyright.1'> + <title>Copyright</title> + <para> + Copyright (C) 2002 by David Smith <dave.s@earthcorp.com>. + XML version Copyright (C) 2005 by 510 Software Group <carl@five-ten-sg.com>. + </para> + <para> + 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. + </para> + <para> + 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. + </para> + </refsect1> + + <refsect1 id='version.1'> + <title>CVS Version</title> + <para> + $Id$ + </para> + </refsect1> + </refentry> + + + <refentry id="readpstlog.1"> + <refentryinfo> + <date>2006-02-19</date> + </refentryinfo> + + <refmeta> + <refentrytitle>readpstlog</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo>readpstlog @VERSION@</refmiscinfo> + </refmeta> + + <refnamediv id='name.1'> + <refname>readpstlog</refname> + <refpurpose>convert a readpst logfile to text format</refpurpose> + </refnamediv> + + <refsect1 id='description.1'> + <title>Description</title> + <para>This manual page briefly documents the <command>readpstlog</command> command.</para> + <para> + <command>readpstlog</command> + is a program that reads the binary logfile generated + by <command>readpst</command>, and outputs it in a more desirable format (i.e. text). + </para> + </refsect1> + + <refsynopsisdiv id='synopsis.1'> + <title>Synopsis</title> + <cmdsynopsis> + <command>readpst</command> + <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg> + <arg><option>-t <replaceable class="parameter">include-types</replaceable></option></arg> + <arg><option>-x <replaceable class="parameter">exclude-types</replaceable></option></arg> + <arg>logfile</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='options.1'> + <title>Options</title> + <variablelist> + <varlistentry> + <term>-f <replaceable class="parameter">format</replaceable></term> + <listitem><para> + Sets the format of the text log output. Currently, the only valid output + format is T, for text; anything else gives the default. + </para></listitem> + </varlistentry> + <varlistentry> + <term>-t <replaceable class="parameter">include-types</replaceable></term> + <listitem><para> + Print only the specified types of log messages. + Types are specified in a comma-delimited list (e.g. 3,10,5,6). + </para></listitem> + </varlistentry> + <varlistentry> + <term>-x <replaceable class="parameter">exclude-types</replaceable></term> + <listitem><para> + Exclude the specified types of log messages. + Types are specified in a comma-delimited list (e.g. 3,10,5,6). + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id='message.types.1'> + <title>Message Types</title> + <para> + <command>readpstlog</command> understands the following types of log messages: + </para> + <variablelist> + <listitem><para> + 1 File accesses + </para></listitem> + <listitem><para> + 2 Index accesses + </para></listitem> + <listitem><para> + 3 New email found + </para></listitem> + <listitem><para> + 4 Warnings + </para></listitem> + <listitem><para> + 5 Read accesses + </para></listitem> + <listitem><para> + 6 Informational messages + </para></listitem> + <listitem><para> + 7 Main function calls + </para></listitem> + <listitem><para> + 8 Decrypting calls + </para></listitem> + <listitem><para> + 10 Function calls + </para></listitem> + <listitem><para> + 11 HexDump calls + </para></listitem> + </variablelist> + </refsect1> + + <refsect1 id='author.1'> + <title>Author</title> + <para> + 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>. + </para> + </refsect1> + + <refsect1 id='copyright.1'> + <title>Copyright</title> + <para> + Copyright (C) 2002 by David Smith <dave.s@earthcorp.com>. + XML version Copyright (C) 2005 by 510 Software Group <carl@five-ten-sg.com>. + </para> + <para> + 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. + </para> + <para> + 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. + </para> + </refsect1> + + <refsect1 id='version.1'> + <title>CVS Version</title> + <para> + $Id$ + </para> + </refsect1> + </refentry> +</reference>