Mercurial > libpst

comparison xml/libpst.in @ 63:cfd6175f9334

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Start work on pst2dii to convert to Summation dii load file format.
author Carl Byington <carl@five-ten-sg.com>
date Sat, 23 Feb 2008 14:36:17 -0800
parents 97b7706bdda2
children 2c6040b6e8f8
comparison
equal deleted inserted replaced
62:ee4e0d00bc94 63:cfd6175f9334
27 </partintro> 27 </partintro>
28 28
29 29
30 <refentry id="readpst.1"> 30 <refentry id="readpst.1">
31 <refentryinfo> 31 <refentryinfo>
32 <date>2008-01-27</date> 32 <date>2008-02-23</date>
33 </refentryinfo> 33 </refentryinfo>
34 34
35 <refmeta> 35 <refmeta>
36 <refentrytitle>readpst</refentrytitle> 36 <refentrytitle>readpst</refentrytitle>
37 <manvolnum>1</manvolnum> 37 <manvolnum>1</manvolnum>
45 45
46 <refsynopsisdiv id='readpst.synopsis.1'> 46 <refsynopsisdiv id='readpst.synopsis.1'>
47 <title>Synopsis</title> 47 <title>Synopsis</title>
48 <cmdsynopsis> 48 <cmdsynopsis>
49 <command>readpst</command> 49 <command>readpst</command>
50 <arg><option>-C</option></arg>
51 <arg><option>-M</option></arg>
52 <arg><option>-S</option></arg>
53 <arg><option>-V</option></arg>
50 <arg><option>-b</option></arg> 54 <arg><option>-b</option></arg>
51 <arg><option>-C</option></arg>
52 <arg><option>-c <replaceable class="parameter">format</replaceable></option></arg> 55 <arg><option>-c <replaceable class="parameter">format</replaceable></option></arg>
53 <arg><option>-d <replaceable class="parameter">debug-file</replaceable></option></arg> 56 <arg><option>-d <replaceable class="parameter">debug-file</replaceable></option></arg>
54 <arg><option>-h</option></arg> 57 <arg><option>-h</option></arg>
55 <arg><option>-k</option></arg> 58 <arg><option>-k</option></arg>
56 <arg><option>-o <replaceable class="parameter">output-directory</replaceable></option></arg> 59 <arg><option>-o <replaceable class="parameter">output-directory</replaceable></option></arg>
57 <arg><option>-q</option></arg> 60 <arg><option>-q</option></arg>
58 <arg><option>-r</option></arg> 61 <arg><option>-r</option></arg>
59 <arg><option>-S</option></arg>
60 <arg><option>-M</option></arg>
61 <arg><option>-V</option></arg>
62 <arg><option>-w</option></arg> 62 <arg><option>-w</option></arg>
63 <arg choice='plain'>pstfile</arg> 63 <arg choice='plain'>pstfile</arg>
64 </cmdsynopsis> 64 </cmdsynopsis>
65 </refsynopsisdiv> 65 </refsynopsisdiv>
66 66
74 74
75 <refsect1 id='readpst.options.1'> 75 <refsect1 id='readpst.options.1'>
76 <title>Options</title> 76 <title>Options</title>
77 <variablelist> 77 <variablelist>
78 <varlistentry> 78 <varlistentry>
79 <term>-b</term>
80 <listitem><para>
81 Do not save the attachments for the RTF format of the email body.
82 </para></listitem>
83 </varlistentry>
84 <varlistentry>
85 <term>-C</term> 79 <term>-C</term>
86 <listitem><para> 80 <listitem><para>
87 Decrypt the entire pst file and dump it to stdout. 81 Decrypt the entire pst file and dump it to stdout.
88 </para></listitem> 82 </para></listitem>
89 </varlistentry> 83 </varlistentry>
90 <varlistentry> 84 <varlistentry>
91 <term>-c <replaceable class="parameter">format</replaceable></term> 85 <term>-M</term>
92 <listitem><para> 86 <listitem><para>
93 Set the Contact output mode. Use -cv for vcard format or -cl for an email list. 87 Output messages in MH format as separate files. This will create
94 </para></listitem> 88 folders as named in the PST file, and will put each email together with
95 </varlistentry> 89 any attachments into its own file. These files will be numbered from 1
96 <varlistentry> 90 to n with no leading zeros.
97 <term>-d <replaceable class="parameter">debug-file</replaceable></term>
98 <listitem><para>
99 Specify name of debug log file. The
100 log file is not an ascii file, it is a binary file readable
101 by <command>readpstlog</command>.
102 </para></listitem>
103 </varlistentry>
104 <varlistentry>
105 <term>-h</term>
106 <listitem><para>
107 Show summary of options and exit.
108 </para></listitem>
109 </varlistentry>
110 <varlistentry>
111 <term>-k</term>
112 <listitem><para>
113 Changes the output format to KMail.
114 </para></listitem>
115 </varlistentry>
116 <varlistentry>
117 <term>-o <replaceable class="parameter">output-directory</replaceable></term>
118 <listitem><para>
119 Specifies the output directory. The directory must already exist, and
120 is entered after the PST file is opened, but before any processing of
121 files commences.
122 </para></listitem>
123 </varlistentry>
124 <varlistentry>
125 <term>-q</term>
126 <listitem><para>
127 Changes to silent mode. No feedback is printed to the screen, except
128 for error messages.
129 </para></listitem>
130 </varlistentry>
131 <varlistentry>
132 <term>-r</term>
133 <listitem><para>
134 Changes the output format to Recursive. This will create folders as
135 named in the PST file, and will put all emails in a file called "mbox"
136 inside each folder. These files are then compatible with all
137 mbox-compatible email clients.
138 </para></listitem> 91 </para></listitem>
139 </varlistentry> 92 </varlistentry>
140 <varlistentry> 93 <varlistentry>
141 <term>-S</term> 94 <term>-S</term>
142 <listitem><para> 95 <listitem><para>
147 XXXXXXXXX-attach2 and so on, or with the name of the attachment if one 100 XXXXXXXXX-attach2 and so on, or with the name of the attachment if one
148 is present. 101 is present.
149 </para></listitem> 102 </para></listitem>
150 </varlistentry> 103 </varlistentry>
151 <varlistentry> 104 <varlistentry>
152 <term>-M</term>
153 <listitem><para>
154 Output messages in MH format as separate files. This will create
155 folders as named in the PST file, and will put each email together with
156 any attachments into its own file. These files will be numbered from 1
157 to n with no leading zeros.
158 </para></listitem>
159 </varlistentry>
160 <varlistentry>
161 <term>-V</term> 105 <term>-V</term>
162 <listitem><para> 106 <listitem><para>
163 Show program version and exit. 107 Show program version and exit.
108 </para></listitem>
109 </varlistentry>
110 <varlistentry>
111 <term>-b</term>
112 <listitem><para>
113 Do not save the attachments for the RTF format of the email body.
114 </para></listitem>
115 </varlistentry>
116 <varlistentry>
117 <term>-c <replaceable class="parameter">format</replaceable></term>
118 <listitem><para>
119 Set the Contact output mode. Use -cv for vcard format or -cl for an email list.
120 </para></listitem>
121 </varlistentry>
122 <varlistentry>
123 <term>-d <replaceable class="parameter">debug-file</replaceable></term>
124 <listitem><para>
125 Specify name of debug log file. The
126 log file is not an ascii file, it is a binary file readable
127 by <command>readpstlog</command>.
128 </para></listitem>
129 </varlistentry>
130 <varlistentry>
131 <term>-h</term>
132 <listitem><para>
133 Show summary of options and exit.
134 </para></listitem>
135 </varlistentry>
136 <varlistentry>
137 <term>-k</term>
138 <listitem><para>
139 Changes the output format to KMail.
140 </para></listitem>
141 </varlistentry>
142 <varlistentry>
143 <term>-o <replaceable class="parameter">output-directory</replaceable></term>
144 <listitem><para>
145 Specifies the output directory. The directory must already exist, and
146 is entered after the PST file is opened, but before any processing of
147 files commences.
148 </para></listitem>
149 </varlistentry>
150 <varlistentry>
151 <term>-q</term>
152 <listitem><para>
153 Changes to silent mode. No feedback is printed to the screen, except
154 for error messages.
155 </para></listitem>
156 </varlistentry>
157 <varlistentry>
158 <term>-r</term>
159 <listitem><para>
160 Changes the output format to Recursive. This will create folders as
161 named in the PST file, and will put all emails in a file called "mbox"
162 inside each folder. These files are then compatible with all
163 mbox-compatible email clients.
164 </para></listitem> 164 </para></listitem>
165 </varlistentry> 165 </varlistentry>
166 <varlistentry> 166 <varlistentry>
167 <term>-w</term> 167 <term>-w</term>
168 <listitem><para> 168 <listitem><para>
220 </refentry> 220 </refentry>
221 221
222 222
223 <refentry id="lspst.1"> 223 <refentry id="lspst.1">
224 <refentryinfo> 224 <refentryinfo>
225 <date>2008-01-27</date> 225 <date>2008-02-23</date>
226 </refentryinfo> 226 </refentryinfo>
227 227
228 <refmeta> 228 <refmeta>
229 <refentrytitle>lspst</refentrytitle> 229 <refentrytitle>lspst</refentrytitle>
230 <manvolnum>1</manvolnum> 230 <manvolnum>1</manvolnum>
238 238
239 <refsynopsisdiv id='lspst.synopsis.1'> 239 <refsynopsisdiv id='lspst.synopsis.1'>
240 <title>Synopsis</title> 240 <title>Synopsis</title>
241 <cmdsynopsis> 241 <cmdsynopsis>
242 <command>lspst</command> 242 <command>lspst</command>
243 <arg><option>-V</option></arg>
243 <arg><option>-d <replaceable class="parameter">debug-file</replaceable></option></arg> 244 <arg><option>-d <replaceable class="parameter">debug-file</replaceable></option></arg>
244 <arg><option>-h</option></arg> 245 <arg><option>-h</option></arg>
245 <arg><option>-V</option></arg>
246 <arg choice='plain'>pstfile</arg> 246 <arg choice='plain'>pstfile</arg>
247 </cmdsynopsis> 247 </cmdsynopsis>
248 </refsynopsisdiv> 248 </refsynopsisdiv>
249 249
250 <refsect1 id='lspst.options.1'> 250 <refsect1 id='lspst.options.1'>
251 <title>Options</title> 251 <title>Options</title>
252 <variablelist> 252 <variablelist>
253 <varlistentry> 253 <varlistentry>
254 <term>-V</term>
255 <listitem><para>
256 Show program version and exit.
257 </para></listitem>
258 </varlistentry>
259 <varlistentry>
254 <term>-d <replaceable class="parameter">debug-file</replaceable></term> 260 <term>-d <replaceable class="parameter">debug-file</replaceable></term>
255 <listitem><para> 261 <listitem><para>
256 Specify name of debug log file. The 262 Specify name of debug log file. The
257 log file is not an ascii file, it is a binary file readable 263 log file is not an ascii file, it is a binary file readable
258 by <command>readpstlog</command>. 264 by <command>readpstlog</command>.
260 </varlistentry> 266 </varlistentry>
261 <varlistentry> 267 <varlistentry>
262 <term>-h</term> 268 <term>-h</term>
263 <listitem><para> 269 <listitem><para>
264 Show summary of options and exit. 270 Show summary of options and exit.
265 </para></listitem>
266 </varlistentry>
267 <varlistentry>
268 <term>-V</term>
269 <listitem><para>
270 Show program version and exit.
271 </para></listitem> 271 </para></listitem>
272 </varlistentry> 272 </varlistentry>
273 </variablelist> 273 </variablelist>
274 </refsect1> 274 </refsect1>
275 275
323 </refentry> 323 </refentry>
324 324
325 325
326 <refentry id="readpstlog.1"> 326 <refentry id="readpstlog.1">
327 <refentryinfo> 327 <refentryinfo>
328 <date>2008-01-27</date> 328 <date>2008-02-23</date>
329 </refentryinfo> 329 </refentryinfo>
330 330
331 <refmeta> 331 <refmeta>
332 <refentrytitle>readpstlog</refentrytitle> 332 <refentrytitle>readpstlog</refentrytitle>
333 <manvolnum>1</manvolnum> 333 <manvolnum>1</manvolnum>
498 </refentry> 498 </refentry>
499 499
500 500
501 <refentry id="pst2ldif.1"> 501 <refentry id="pst2ldif.1">
502 <refentryinfo> 502 <refentryinfo>
503 <date>2008-01-27</date> 503 <date>2008-02-23</date>
504 </refentryinfo> 504 </refentryinfo>
505 505
506 <refmeta> 506 <refmeta>
507 <refentrytitle>pst2ldif</refentrytitle> 507 <refentrytitle>pst2ldif</refentrytitle>
508 <manvolnum>1</manvolnum> 508 <manvolnum>1</manvolnum>
516 516
517 <refsynopsisdiv id='pst2ldif.synopsis.1'> 517 <refsynopsisdiv id='pst2ldif.synopsis.1'>
518 <title>Synopsis</title> 518 <title>Synopsis</title>
519 <cmdsynopsis> 519 <cmdsynopsis>
520 <command>pst2ldif</command> 520 <command>pst2ldif</command>
521 <arg><option>-h</option></arg>
522 <arg><option>-V</option></arg> 521 <arg><option>-V</option></arg>
523 <arg><option>-b <replaceable class="parameter">ldap-base</replaceable></option></arg> 522 <arg><option>-b <replaceable class="parameter">ldap-base</replaceable></option></arg>
524 <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg> 523 <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
525 <arg><option>-d <replaceable class="parameter">debug-file</replaceable></option></arg> 524 <arg><option>-d <replaceable class="parameter">debug-file</replaceable></option></arg>
525 <arg><option>-h</option></arg>
526 <arg choice='plain'>pstfilename</arg> 526 <arg choice='plain'>pstfilename</arg>
527 </cmdsynopsis> 527 </cmdsynopsis>
528 </refsynopsisdiv> 528 </refsynopsisdiv>
529 529
530 <refsect1 id='pst2ldif.options.1'> 530 <refsect1 id='pst2ldif.options.1'>
531 <title>Options</title> 531 <title>Options</title>
532 <variablelist> 532 <variablelist>
533 <varlistentry> 533 <varlistentry>
534 <term>-h</term> 534 <term>-V</term>
535 <listitem><para>
536 Show summary of options. Subsequent options are then ignored.
537 </para></listitem>
538 </varlistentry>
539 <varlistentry>
540 <term>-V <replaceable class="parameter">include-types</replaceable></term>
541 <listitem><para> 535 <listitem><para>
542 Show program version. Subsequent options are then ignored. 536 Show program version. Subsequent options are then ignored.
543 </para></listitem> 537 </para></listitem>
544 </varlistentry> 538 </varlistentry>
545 <varlistentry> 539 <varlistentry>
561 <term>-d <replaceable class="parameter">debug-file</replaceable></term> 555 <term>-d <replaceable class="parameter">debug-file</replaceable></term>
562 <listitem><para> 556 <listitem><para>
563 Specify name of debug log file. The 557 Specify name of debug log file. The
564 log file is not an ascii file, it is a binary file readable 558 log file is not an ascii file, it is a binary file readable
565 by <command>readpstlog</command>. 559 by <command>readpstlog</command>.
560 </para></listitem>
561 </varlistentry>
562 <varlistentry>
563 <term>-h</term>
564 <listitem><para>
565 Show summary of options. Subsequent options are then ignored.
566 </para></listitem> 566 </para></listitem>
567 </varlistentry> 567 </varlistentry>
568 </variablelist> 568 </variablelist>
569 </refsect1> 569 </refsect1>
570 570
620 </para> 620 </para>
621 </refsect1> 621 </refsect1>
622 </refentry> 622 </refentry>
623 623
624 624
625 <refentry id="pst2dii.1">
626 <refentryinfo>
627 <date>2008-02-23</date>
628 </refentryinfo>
629
630 <refmeta>
631 <refentrytitle>pst2dii</refentrytitle>
632 <manvolnum>1</manvolnum>
633 <refmiscinfo>pst2dii @VERSION@</refmiscinfo>
634 </refmeta>
635
636 <refnamediv id='pst2dii.name.1'>
637 <refname>pst2dii</refname>
638 <refpurpose>extract email messages from a MS Outlook .pst file in DII load format</refpurpose>
639 </refnamediv>
640
641 <refsynopsisdiv id='pst2dii.synopsis.1'>
642 <title>Synopsis</title>
643 <cmdsynopsis>
644 <command>pst2dii</command>
645 <arg><option>-B <replaceable class="parameter">bates-prefix</replaceable></option></arg>
646 <arg><option>-O <replaceable class="parameter">dii-output-file</replaceable></option></arg>
647 <arg><option>-V</option></arg>
648 <arg><option>-b <replaceable class="parameter">bates-number</replaceable></option></arg>
649 <arg><option>-c <replaceable class="parameter">bates-color</replaceable></option></arg>
650 <arg><option>-d <replaceable class="parameter">debug-file</replaceable></option></arg>
651 <arg><option>-f <replaceable class="parameter">ttf-font-file</replaceable></option></arg>
652 <arg><option>-h</option></arg>
653 <arg><option>-o <replaceable class="parameter">output-directory</replaceable></option></arg>
654 <arg choice='plain'>pstfilename</arg>
655 </cmdsynopsis>
656 </refsynopsisdiv>
657
658 <refsect1 id='pst2dii.options.1'>
659 <title>Options</title>
660 <variablelist>
661 <varlistentry>
662 <term>-B <replaceable class="parameter">bates-prefix</replaceable></term>
663 <listitem><para>
664 Sets the bates prefix string. The bates sequence number is appended to
665 this string, and printed on each page.
666 </para></listitem>
667 </varlistentry>
668 <varlistentry>
669 <term>-O <replaceable class="parameter">dii-output-file</replaceable></term>
670 <listitem><para>
671 Name of the output DII load file.
672 </para></listitem>
673 </varlistentry>
674 <varlistentry>
675 <term>-V</term>
676 <listitem><para>
677 Show program version. Subsequent options are then ignored.
678 </para></listitem>
679 </varlistentry>
680 <varlistentry>
681 <term>-b <replaceable class="parameter">bates-number</replaceable></term>
682 <listitem><para>
683 Starting bates sequence number. The default is zero.
684 </para></listitem>
685 </varlistentry>
686 <varlistentry>
687 <term>-c <replaceable class="parameter">bates-color</replaceable></term>
688 <listitem><para>
689 Font color for the bates stamp on each page, specified as 6 hex digits
690 as rrggbb values. The default is ff0000 for bright red.
691 </para></listitem>
692 </varlistentry>
693 <varlistentry>
694 <term>-d <replaceable class="parameter">debug-file</replaceable></term>
695 <listitem><para>
696 Specify name of debug log file. The
697 log file is not an ascii file, it is a binary file readable
698 by <command>readpstlog</command>.
699 </para></listitem>
700 </varlistentry>
701 <varlistentry>
702 <term>-f <replaceable class="parameter">ttf-font-file</replaceable></term>
703 <listitem><para>
704 Specify name of a true type font file. This should be a fixed pitch font.
705 </para></listitem>
706 </varlistentry>
707 <varlistentry>
708 <term>-h</term>
709 <listitem><para>
710 Show summary of options. Subsequent options are then ignored.
711 </para></listitem>
712 </varlistentry>
713 <varlistentry>
714 <term>-o <replaceable class="parameter">output-directory</replaceable></term>
715 <listitem><para>
716 Specifies the output directory. The directory must already exist.
717 </para></listitem>
718 </varlistentry>
719 </variablelist>
720 </refsect1>
721
722 <refsect1 id='pst2dii.description.1'>
723 <title>Description</title>
724 <para><command>pst2dii</command>
725 reads the email messages from a MS Outlook .pst file
726 and produces a DII load file that may be used to import message
727 summaries into a Summation DII system. The DII output file contains
728 references to the image and attachment files in the output directory.
729 </para>
730 </refsect1>
731
732 <refsect1 id='pst2dii.copyright.1'>
733 <title>Copyright</title>
734 <para>
735 Copyright (C) 2008 by 510 Software Group &lt;carl@five-ten-sg.com&gt;
736 </para>
737 <para>
738 This program is free software; you can redistribute it and/or modify it
739 under the terms of the GNU General Public License as published by the
740 Free Software Foundation; either version 2, or (at your option) any
741 later version.
742 </para>
743 <para>
744 You should have received a copy of the GNU General Public License along
745 with this program; see the file COPYING. If not, please write to the
746 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
747 </para>
748 </refsect1>
749
750 <refsect1 id='pst2dii.version.1'>
751 <title>Version</title>
752 <para>
753 @VERSION@
754 </para>
755 </refsect1>
756 </refentry>
757
758
625 <refentry id="pst.5"> 759 <refentry id="pst.5">
626 <refentryinfo> 760 <refentryinfo>
627 <date>2008-01-27</date> 761 <date>2008-02-23</date>
628 </refentryinfo> 762 </refentryinfo>
629 763
630 <refmeta> 764 <refmeta>
631 <refentrytitle>outlook.pst</refentrytitle> 765 <refentrytitle>outlook.pst</refentrytitle>
632 <manvolnum>5</manvolnum> 766 <manvolnum>5</manvolnum>
1510 0058 My address in CC field 1644 0058 My address in CC field
1511 0059 Message addressed to me 1645 0059 Message addressed to me
1512 0063 Response requested 1646 0063 Response requested
1513 0064 Sender's Address access method (SMTP, EX) 1647 0064 Sender's Address access method (SMTP, EX)
1514 0065 Sender's Address 1648 0065 Sender's Address
1515 0070 Processed Subject (with Fwd:, Re, ... removed) 1649 0070 Conversation topic, processed subject (with Fwd:, Re, ... removed)
1516 0071 Date. Another date 1650 0071 Conversation index
1651 0072 Original display BCC
1652 0073 Original display CC
1653 0074 Original display TO
1517 0075 Recipient Address Access Method (SMTP, EX) 1654 0075 Recipient Address Access Method (SMTP, EX)
1518 0076 Recipient's Address 1655 0076 Recipient's Address
1519 0077 Second Recipient Access Method (SMTP, EX) 1656 0077 Second Recipient Access Method (SMTP, EX)
1520 0078 Second Recipient Address 1657 0078 Second Recipient Address
1521 007d Email Header. This is the header that was attached to the email 1658 007d Email Header. This is the header that was attached to the email