Tornado Reference : Tornado Utilities

htmlLink

NAME

htmlLink - install cross references in HTML documents

SYNOPSIS

htmlLink [-h] [-R] [-skip dirName] [directory]

DESCRIPTION

This tool uses the information in the linkage files RTN and LIB to create HTML links from references in documents to the appropriate reference entries. It can also concatenate the various RTN and LIB files under each directory into RTN.SUB and LIB.SUB files recursively.

This command is used to create all the cross reference links to HTML reference manuals previously generated with refgen. It should only be used after all the HTML documentation files have been built for a given project.

OPTIONS

-h

Display a brief message describing the usage of this tool.

-R

Make links in all subdirectories (recursion).

-skip dirName

Do not process directory dirName when -R flag is in effect. Each directory to be skipped must be listed separately, as:

htmlLink -R -skip notes -skip lost+found -skip private

directory

The directory to be processed. If the -R flag is used, all its subdirectories will also be processed. If no directory is specified, the current working directory is processed.

RETURNS

N/A

ERRORS

N/A

EXAMPLE

Building cross-references for a BSP help files.

Go to the BSP directory and build the HTML documentation:

% cd $WIND_BASE/target/config/myBsp
% make man

Generate cross-references in the BSP help files:

% cd $WIND_BASE/docs/vxworks/bsp/myBsp
% htmlLink .

SEE ALSO

htmlLink, refgen, windHelpLib, htmlBook