`hp2ps'--heap profile to PostScript

USAGE: `hp2ps' [flags] [<file>[`.stat']]

The program `hp2ps' converts a heap profile as produced by the `-h<break-down>' runtime option into a PostScript graph of the heap profile. By convention, the file to be processed by `hp2ps' has a `.hp' extension. The PostScript output is written to <file>`.ps'. If <file> is omitted entirely, then the program behaves as a filter.

`hp2ps' is distributed in `ghc/utils/hp2ps'. It was originally developed by Dave Wakeling as part of the HBC/LML heap profiler.

The flags are:

`-d'

In order to make graphs more readable, `hp2ps' sorts the shaded bands for each identifier. The default sort ordering is for the bands with the largest area to be stacked on top of the smaller ones. The `-d' option causes rougher bands (those representing series of values with the largest standard deviations) to be stacked on top of smoother ones.

`-b'

Normally, `hp2ps' puts the title of the graph in a small box at the top of the page. However, if the JOB string is too long to fit in a small box (more than 35 characters), then `hp2ps' will choose to use a big box instead. The `-b' option forces `hp2ps' to use a big box.

`-e<float>[in|mm|pt]'

Generate encapsulated PostScript suitable for inclusion in LaTeX documents. Usually, the PostScript graph is drawn in landscape mode in an area 9 inches wide by 6 inches high, and `hp2ps' arranges for this area to be approximately centred on a sheet of a4 paper. This format is convenient of studying the graph in detail, but it is unsuitable for inclusion in LaTeX documents. The `-e' option causes the graph to be drawn in portrait mode, with float specifying the width in inches, millimetres or points (the default). The resulting PostScript file conforms to the Encapsulated PostScript (EPS) convention, and it can be included in a LaTeX document using Rokicki's dvi-to-PostScript converter `dvips'.

`-g'

Create output suitable for the `gs' PostScript previewer (or similar). In this case the graph is printed in portrait mode without scaling. The output is unsuitable for a laser printer.

`-l'

Normally a profile is limited to 20 bands with additional identifiers being grouped into an `OTHER' band. The `-l' flag removes this 20 band and limit, producing as many bands as necessary. No key is produced as it won't fit!. It is useful for creation time profiles with many bands.

`-m<int>'

Normally a profile is limited to 20 bands with additional identifiers being grouped into an `OTHER' band. The `-m' flag specifies an alternative band limit (the maximum is 20). `-m0' requests the band limit to be removed. As many bands as necessary are produced. However no key is produced as it won't fit! It is useful for displaying creation time profiles with many bands.

`-p'

Use previous parameters. By default, the PostScript graph is automatically scaled both horizontally and vertically so that it fills the page. However, when preparing a series of graphs for use in a presentation, it is often useful to draw a new graph using the same scale, shading and ordering as a previous one. The `-p' flag causes the graph to be drawn using the parameters determined by a previous run of `hp2ps' on file. These are extracted from file`.aux'.

`-s'

Use a small box for the title.

`-t<float>'

Normally trace elements which sum to a total of less than 1% of the profile are removed from the profile. The `-t' option allows this percentage to be modified (maximum 5%). `-t0' requests no trace elements to be removed from the profile, ensuring that all the data will be displayed.

`-?'

Print out usage information.