1. Introduction
2. Command line syntax
3. Options
4. Output files
The utility may be used to automatically produce HTML texts for Eiffel projects and libraries generated by Visual Eiffel. The output includes an index, source files and short forms of Eiffel classes.
The GUI version of the program is also provided: dm_ghtml.
Command line syntax:
gHTML [options]
where
Options for gHTML should begin with '-' or '/' character.
The following options are supported by gHTML:
/? | display short help about gHTML options |
---|---|
/list:<kind> | display names of projects and libraries registered in the repository; parameter
<kind> involves some restrictions on the output list and should be one of the
following:
|
/prj:<name> | specify name of the project or library for which HTML output would be provided; parameter <name> should be a name of the existing project or library |
/ref:<kind> | specify which HTML output is referenced by the class index (used together with
"/prj" option):
|
HTML output is produced only when proper "/prj" option is specified. If no option is specified, gHTML assumes "/?".
All output files are stored in the folder "HTML.nnn", where nnn = 1, 2,... This folder is created as a subfolder of the corresponding project or library folder. The output files are the following:
????????.htm | root file which an contains index of all classes which belong to the project or library; the name of this file is a name of the project/library shortened to the 8-character name |
---|---|
sNNN.htm | short form of the classes (one file per one class); NNN = 1, 2, ... |
oNNN.htm | source text of the classes (one file per one class); NNN = 1, 2, ... |