Troy Denkinger

NAME - script to interface to hand history parsing and display modules

SYNOPSIS --history <path> [--output <type>] [--testfile <path>] [--results <hidden|show>] [--showstacks] [--help] [--verbose]
--history, -h <path>

Hand history file to be parsed. This file should contain a single hand. Required.

--output, -o <path>

Output type requested. These modules are flexible enough to allow output to many different formats. For instance, an output format for the Two Plus Two message boards is included; this output module formats the hand to take into account particular features of that mesage board. Other output formats may be provided and those are documented in the module. If this argument is not present, a data dump of the hand will be returned. Optional.

--testfile, -t <path>

A sample file to compare to the returned data from an output module. This file functions as a control when building new output modules. It is assumed that this test file will be what you are hoping to get from the output module. When this option is used, the output from the specified output module will be compared to this file. If the data are identical a success message will be printed. If they are not identical, a failure message will be printed. Optional.

--results, -r <hidden|show>

If this parameter is not present, no results will be shown. If this parameter is present with a value of "hidden" the results will be included in the results but the output color will be HTML white. If this parameter is present with a value of "show" then results will be included in HTML black.

--showstacks, -s

Include starting tacks in the output.


This message.

--verbose, -v

Not implemented.


This script is a simple reference implementation of how to interface to the hand parsing and hand display modules. This script can be used as-is or as the starting point for a new implementation such as a CGI script, etc.


Troy Denkinger (


Version 1.0


Copyright (c) 2005 by Troy Denkinger, all rights reserved. This is free software; you can redistribute it and/or modify it under the same terms as Perl itself.