Mercurial > libpst

comparison xml/libpst.in @ 202:2f38c4ce606f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
remove readpstlog, switch to plain ascii debug log files
author Carl Byington <carl@five-ten-sg.com>
date Mon, 18 May 2009 15:55:05 -0700
parents 3850a3b11745
children 268458c79e9b
comparison
equal deleted inserted replaced
201:3850a3b11745 202:2f38c4ce606f
127 </para></listitem> 127 </para></listitem>
128 </varlistentry> 128 </varlistentry>
129 <varlistentry> 129 <varlistentry>
130 <term>-d <replaceable class="parameter">debug-file</replaceable></term> 130 <term>-d <replaceable class="parameter">debug-file</replaceable></term>
131 <listitem><para> 131 <listitem><para>
132 Specify name of debug log file. The 132 Specify name of debug log file. The log file is now an ascii file,
133 log file is not an ascii file, it is a binary file readable 133 instead of the binary file used in previous versions.
134 by <command>readpstlog</command>.
135 </para></listitem> 134 </para></listitem>
136 </varlistentry> 135 </varlistentry>
137 <varlistentry> 136 <varlistentry>
138 <term>-h</term> 137 <term>-h</term>
139 <listitem><para> 138 <listitem><para>
184 switch, this will remove all files from the target folder before 183 switch, this will remove all files from the target folder before
185 writing. This is to keep the count of emails and attachments correct. 184 writing. This is to keep the count of emails and attachments correct.
186 </para></listitem> 185 </para></listitem>
187 </varlistentry> 186 </varlistentry>
188 </variablelist> 187 </variablelist>
189 </refsect1>
190
191 <refsect1 id='readpst.also.1'>
192 <title>See Also</title>
193 <para>
194 <citerefentry><refentrytitle>readpstlog</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>
195 </para>
196 </refsect1> 188 </refsect1>
197 189
198 <refsect1 id='readpst.author.1'> 190 <refsect1 id='readpst.author.1'>
199 <title>Author</title> 191 <title>Author</title>
200 <para> 192 <para>
271 </para></listitem> 263 </para></listitem>
272 </varlistentry> 264 </varlistentry>
273 <varlistentry> 265 <varlistentry>
274 <term>-d <replaceable class="parameter">debug-file</replaceable></term> 266 <term>-d <replaceable class="parameter">debug-file</replaceable></term>
275 <listitem><para> 267 <listitem><para>
276 Specify name of debug log file. The 268 Specify name of debug log file. The log file is now an ascii file,
277 log file is not an ascii file, it is a binary file readable 269 instead of the binary file used in previous versions.
278 by <command>readpstlog</command>.
279 </para></listitem> 270 </para></listitem>
280 </varlistentry> 271 </varlistentry>
281 <varlistentry> 272 <varlistentry>
282 <term>-h</term> 273 <term>-h</term>
283 <listitem><para> 274 <listitem><para>
293 PST (Personal Folders) file and produce a simple listing of the 284 PST (Personal Folders) file and produce a simple listing of the
294 data (contacts, email subjects, etc). 285 data (contacts, email subjects, etc).
295 </para> 286 </para>
296 </refsect1> 287 </refsect1>
297 288
298 <refsect1 id='lspst.also.1'>
299 <title>See Also</title>
300 <para>
301 <citerefentry><refentrytitle>readpstlog</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>
302 </para>
303 </refsect1>
304
305 <refsect1 id='lspst.author.1'> 289 <refsect1 id='lspst.author.1'>
306 <title>Author</title> 290 <title>Author</title>
307 <para> 291 <para>
308 lspst was written by Joe Nahmias &lt;joe@nahmias.net&gt; based on readpst. 292 lspst was written by Joe Nahmias &lt;joe@nahmias.net&gt; based on readpst.
309 This man page was written by 510 Software Group &lt;carl@five-ten-sg.com&gt;. 293 This man page was written by 510 Software Group &lt;carl@five-ten-sg.com&gt;.
327 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 311 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
328 </para> 312 </para>
329 </refsect1> 313 </refsect1>
330 314
331 <refsect1 id='lspst.version.1'> 315 <refsect1 id='lspst.version.1'>
332 <title>Version</title>
333 <para>
334 @VERSION@
335 </para>
336 </refsect1>
337 </refentry>
338
339
340 <refentry id="readpstlog.1">
341 <refentryinfo>
342 <date>2009-05-16</date>
343 </refentryinfo>
344
345 <refmeta>
346 <refentrytitle>readpstlog</refentrytitle>
347 <manvolnum>1</manvolnum>
348 <refmiscinfo>readpstlog @VERSION@</refmiscinfo>
349 </refmeta>
350
351 <refnamediv id='readpstlog.name.1'>
352 <refname>readpstlog</refname>
353 <refpurpose>convert a <command>readpst</command> logfile to text format</refpurpose>
354 </refnamediv>
355
356 <refsynopsisdiv id='readpstlog.synopsis.1'>
357 <title>Synopsis</title>
358 <cmdsynopsis>
359 <command>readpstlog</command>
360 <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg>
361 <arg><option>-t <replaceable class="parameter">include-types</replaceable></option></arg>
362 <arg><option>-x <replaceable class="parameter">exclude-types</replaceable></option></arg>
363 <arg choice='plain'>logfile</arg>
364 </cmdsynopsis>
365 </refsynopsisdiv>
366
367 <refsect1 id='readpstlog.description.1'>
368 <title>Description</title>
369 <para><command>readpstlog</command>
370 is a program that converts the binary logfile generated
371 by <command>readpst</command> to a more desirable text format.
372 </para>
373 </refsect1>
374
375 <refsect1 id='readpstlog.options.1'>
376 <title>Options</title>
377 <variablelist>
378 <varlistentry>
379 <term>-f <replaceable class="parameter">format</replaceable></term>
380 <listitem><para>
381 Sets the format of the text log output. Currently, the only valid output
382 formats are T, for single line text, D for the default default multi line
383 format, and I for an indented style with single line text.
384 </para></listitem>
385 </varlistentry>
386 <varlistentry>
387 <term>-t <replaceable class="parameter">include-types</replaceable></term>
388 <listitem><para>
389 Print only the specified types of log messages.
390 Types are specified in a comma-delimited list (e.g. 3,10,5,6).
391 </para></listitem>
392 </varlistentry>
393 <varlistentry>
394 <term>-x <replaceable class="parameter">exclude-types</replaceable></term>
395 <listitem><para>
396 Exclude the specified types of log messages.
397 Types are specified in a comma-delimited list (e.g. 3,10,5,6).
398 </para></listitem>
399 </varlistentry>
400 </variablelist>
401 </refsect1>
402
403 <refsect1 id='readpstlog.message.types.1'>
404 <title>Message Types</title>
405 <para><command>readpstlog</command> understands the following types of log
406 messages:
407 </para>
408 <variablelist>
409 <varlistentry>
410 <term>1</term>
411 <listitem><para>
412 File accesses
413 </para></listitem>
414 </varlistentry>
415 <varlistentry>
416 <term>2</term>
417 <listitem><para>
418 Index accesses
419 </para></listitem>
420 </varlistentry>
421 <varlistentry>
422 <term>3</term>
423 <listitem><para>
424 New email found
425 </para></listitem>
426 </varlistentry>
427 <varlistentry>
428 <term>4</term>
429 <listitem><para>
430 Warnings
431 </para></listitem>
432 </varlistentry>
433 <varlistentry>
434 <term>5</term>
435 <listitem><para>
436 Read accesses
437 </para></listitem>
438 </varlistentry>
439 <varlistentry>
440 <term>6</term>
441 <listitem><para>
442 Informational messages
443 </para></listitem>
444 </varlistentry>
445 <varlistentry>
446 <term>7</term>
447 <listitem><para>
448 Main function calls
449 </para></listitem>
450 </varlistentry>
451 <varlistentry>
452 <term>8</term>
453 <listitem><para>
454 Decrypting calls
455 </para></listitem>
456 </varlistentry>
457 <varlistentry>
458 <term>9</term>
459 <listitem><para>
460 Function entries
461 </para></listitem>
462 </varlistentry>
463 <varlistentry>
464 <term>10</term>
465 <listitem><para>
466 Function exits
467 </para></listitem>
468 </varlistentry>
469 <varlistentry>
470 <term>11</term>
471 <listitem><para>
472 HexDump calls
473 </para></listitem>
474 </varlistentry>
475 </variablelist>
476 </refsect1>
477
478 <refsect1 id='readpstlog.author.1'>
479 <title>Author</title>
480 <para>
481 This manual page was written by Joe Nahmias &lt;joe@nahmias.net&gt;
482 for the Debian GNU/Linux system (but may be used by others). It was
483 converted to xml format by Carl Byington &lt;carl@five-ten-sg.com&gt;.
484 </para>
485 </refsect1>
486
487 <refsect1 id='readpstlog.copyright.1'>
488 <title>Copyright</title>
489 <para>
490 Copyright (C) 2002 by David Smith &lt;dave.s@earthcorp.com&gt;.
491 XML version Copyright (C) 2008 by 510 Software Group &lt;carl@five-ten-sg.com&gt;.
492 </para>
493 <para>
494 This program is free software; you can redistribute it and/or modify it
495 under the terms of the GNU General Public License as published by the
496 Free Software Foundation; either version 2, or (at your option) any
497 later version.
498 </para>
499 <para>
500 You should have received a copy of the GNU General Public License along
501 with this program; see the file COPYING. If not, please write to the
502 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
503 </para>
504 </refsect1>
505
506 <refsect1 id='readpstlog.version.1'>
507 <title>Version</title> 316 <title>Version</title>
508 <para> 317 <para>
509 @VERSION@ 318 @VERSION@
510 </para> 319 </para>
511 </refsect1> 320 </refsect1>