PEI Software Distribution, Version 1.251


This software distribution is the first release of the peiCof COF
compliance checker; it is available from PEI's FTP site at
ftp://ftp.picturel.com in the directory /pub/cof/coftest/peiCof.
This directory includes the following files:

	peiCof-1.251.tar.gz	the software distribution file
	peiCof.ps		the peiCof manual page in PostScript
	peiCof.pdf		the peiCof manual page in PDF
	doc1.251		this document

The distribution file consists of the following files:

	pei/src/peiCof.c	the C source for peiCof
	pei/src/Makefile	the makefile for peiCof
	pei/src/make_all	script implemention of "make all"
	pei/src/make_install	script implemention of "make install"

	pei/man/man1/peiCof.1	the peiCof manual page in roff format

	pei/doc/peiCof.pdf	the peiCof manual page in PDF
	pei/doc/doc1.251	this document


HANDLING THE DISTRIBUTION FILE:

The files in the distribution file can be extracted on any reasonable
Unix platform by copying the distribution file to the desired directory
and executing:

	gunzip peiCof-1.251.tar.gz
	tar xf peiCof-1.251.tar

This will create the pei directory tree with the files listed above
rooted at the current directory.


PROGRAM GENERATION:

The program peiCof.c is written in ANSI C and does not make use of
any libraries (other than the standard C library), so it should be
transportable to any C platform.  On the other hand, to date, it
has only been used and tested on Redhat Linux V 5.2.  Under Linux,
the executable program peiCof is generated by:

	cd pei/src
	make

Some other Unix platforms, notably those derived from Unix System V,
implement only a subset of the make syntax, so the Makefile will
not work; for these platforms, the script make_all is provided, and
it can be used in place of make to generate peiCof by executing:

	cd pei/src
	make_all


PROGRAM INSTALLATION:

To install the program, it is only necessary to copy peiCof from
pei/src to /usr/local/bin and peiCof.1 from pei/man/man1 to
/usr/local/man/man1.  This is done under Linux by the superuser with:

	cd pei/src
	su
	make install

An installation script is also provided for other Unix platforms:

	cd pei/src
	su
	make_install


USAGE EXAMPLES:

After installation, the peiCof manual can be viewed on any reasonable
Unix platform with:

	man peiCof

A summary of the manual page is also display by the command:

	peiCof -help

The COF file set in the current directory can be checked with:

	peiCof

To also see a tabulation of the COF symbols found in the file set
and to continue the parse regardless of the number of errors found, use:

	peiCof -dump -max none

To check the COF file sets in every subdirectory of the current
directory, use:

	peiCof *

This example shows how to use peiCof within a C shell script to
branch on the result of the COF verification:

	if (`peiCof -boolean $1` == 0) then
	    echo test passes
	else
	    echo test fails
	endif

The manual page should be consulted for further details on usage.