readme.txt #1

JournalReader

This set of applications parse a checkpoint or journal file and offer an interface to act on this schema. 
There are several example applications available in this package:

=====================================================
journal.reader.JournalReader <filename> [action] [-z]
=====================================================

The JournalReader application reads a checkpoint, compressed or not, and applies the action on it.
By default, the action is to simply print out the checkpoint again in checkpoint format. The action 
applied in this case is journal.action.JournalAction.

Any other action can be provided by passing the class name of an action. This action needs to implement
journal.action.Action (see the source code).

One example of a more useful action is journal.action.JournalSplitter, which splits the checkpoint into
separate files for each database table.

A new addition is journal.action.HighAsciiFinderAction, which searches in the journal file/checkpoint in all
KEY and TEXT fields for high ascii characters, that would prevent the conversion of the Perforce Server
to Unicode.

============================================================
journal.reader.JournalComparer <file1> <file2> [linecounter]
============================================================

The JournalComparer application reads two checkpoints and compares them to each other. It will print out 
the differences between these checkpoints.

The linecounter, if set, will print out the linecounter for each file to stderr at the specified interval.