|
|
|---|
The Rational PureCoverage HTML tool is a Perl script that converts a PureCoverage text data file into a set of HTML files. You must have Perl installed on your system to run it. This script runs on Windows and UNIX. The Perl program must be on your command search PATH. IBM does not provide Perl for this script. Perl is available for free on the Internet.
You can invoke the tool, purecovweb.pl, like this on either system:
perl purecovweb.pl [options] PureCoverage-txt-File
This command reads the Rational PureCoverage text file to produce a set of HTML files. The starting HTML file is default.htm on Windows and index.html on UNIX. On Windows, all of the HTML files will have a .htm suffix. On Unix, all of the HTML files will have a .html suffix. The files are put in the same directory as the text file. The images used by purecovweb.pl are copied to the same location. This program expects the JPEG files to be in a directory called purecovweb_files located in the same directory as the purecovweb.pl script.
Options:
-a/nnotate_source
If you use the -e, -i, -so, or -su options, -a is assumed.
The text file includes source locations. In addition to that, the CLASSPATH environment variable is considered when searching for Java source.
Refer to the -so option for specifying additional paths to search.
-d/estination directory
-e/xclude source-path
On Windows, use a semi-colon separator, like this to not
generate annotated source that is in either of these two folders:
-e "C:\My Files;E:\Your Files"
On UNIX, use a colon separator, like this:
-e "/user/tom/project-A:/user/joe/project-A"
If you use this option, you cannot use the -include option.
-f/orce
-h/elp
-i/nclude source-path
On Windows, use a semi-colon separator, like this to
generate annotated source that is only in these two folders:
-i "C:\My Files;E:\Your Files"
On UNIX, use a colon separator, like this:
-i "/user/tom/project-A:/user/joe/project-A"
If you use this option, you cannot use the -exclude option.
-l/ang language
-l ja
-m/essages
-p/roject Project-Name
-p "The ACME Project"
-so/urce-file-path path-to-source
On Windows, use a semi-colon separator, like this:
-so "C:\My Files;E:\Your Files"
which is the same as this:
-so "C:\My Files" -so "E:\Your Files"
Note that you must quote paths that have spaces in the names.
On UNIX, use a colon separator, like this:
-so /user/tom/project-A:/user/joe/project-A
Note that the paths do not need quoting--there are no spaces.
The -so parameter can be an environment variable. You can use the $ or % to expand it. Without the $ or %, the program will look up the value. Assume SOURCE_LIST is set to /user/tom/project-A:/user/joe/project-A. These 3 examples are equivalent:
-so "%SOURCE_LIST%" (on Windows)
-so "$SOURCE_LIST" (on UNIX)
-so SOURCE_LIST (on Windows or UNIX, all upper-case, can be A-Z, _, and 0-9 in the name)
If the directory or folder ends in **, the program will do a recursive search of the underlying directories or folders:
-so "C:\My Files\**;E:\Your Files\**"
On Windows, use a semi-colon separator when two or more
substitutions are specified:
On UNIX, use a colon separator, like this:
-t/runcate [ right | left | center ]
-v/ersion
-w/idth integer
This option is used to find files to annotate if the path
is different than indicated in the text data. If PureCoverage
was run on source in 'E:\My Source\' and later moved to
'G:\Toms Source\', the source can be located for annotation
using this option. You can specify one or more -su options.
You can specify one or more pairs in an -su option.
-su "E:\My Source|G:\Toms Source;C:\Project 1|G:\Project 1"
Note that you must quote this option.
-su "/user/tom/src-A|/user/joe/src-A:/opt/ibm/src|/usr/local/src"
This allows the tool to find the original src-A source in
/user/joe/src-A and /opt/ibm/src in /usr/local/src.
If a path name is too long for the display truncate it on
the right, the left, or the center using ... notation.
The default is to truncate in the center. Function
and class names are truncated on the right only.
Display the program version and exit.
Set the width of the Coverage Item field from 20 to 128 characters.
The default width is 60 characters.
The minimum width is 20 and the maximum width is 128.
Examples:
This command uses the PureCoverage java2d.txt file in the current folder to create the HTML files in the same folder: default.htm and default2.htm.
Example 2: On Windows:
This command is the same as the first, except, path truncation is done on the left and the source annotation files will be created:
src1.htm, ... srcN.htm (one for each source file)
dir1.htm, ... dirN.htm (one for each folder)
Example 3: On UNIX:
This command will use the PureCoverage cool-app.pcx file in the /project/acme/cool-app directory. It creates the HTML files in the web server directory /usr/web/htdocs/cool-app-results. The files it creates are:
index.html
src1.html, ... srcN.html (one for each source file)
dir1.html, ... dirN.html (one for each directory)
