Options

All options and swiches are case-insensitive. If you start hsc without any options, a short help message will be displayed.

HELP

Display a short help message and exit.

LICENSE

Display a short version of the GNU General Public License and exit.

[FROM=]inputfile_name

Specifies the input filename. To use stdin as input file, see PIPEIN. If you specify more than one file, the first file is taken as mainfile, and all other files are included before it. This is useful to include macro-definitions without an <$include>.

TO=output_filename|destination_directory

Specifies the output filename or the destination directory. If the argument ends with a "/" (or also ":"), it is interpreted as a directory. In this case, the name of the outputfile is created from the name of the input file, with the extension set to ".html".
If no output file is set, stdout is used instead.

MSGFILE=message_filename

Redirects messages to a file. By default, stderr ist used.

MSGFORMAT=format_description

Describes how messages should be displayed. Legal placeholders:

        %f      filename
        %x, %y  location in file (column, line)
        %c      message class
        %i      message id (numeric)
        %m      message text
        %n      inserts a linefeed
    

Example: To get GCC-like messages, use MSGFORMAT="%f:%y: %c %i: %m".

PRJFILE=project_filename

Currently only stores information about defined IDs so links like <A HREF="document.html#id"> can be checked. All documents within a project should use the same project-file.

IGNORE

Ignore warning message number. Usually, IGNORE needs a numeric argument and can occure multiple. Example:

        IGNORE=21 IGN=18 IGN 3         (ignore warnings #21, #18, #3)

Additionally, you can give IGNORE some special values:

ALL

Ignore all non-error messages

NOTES

Ignore all notes

BADSTYLE

Ignore all bad style warnings

All these special values add new messages to the list of messages to be ignored, but do not reset any IGNOREs passed before.

MODE

Set base mode for syntax check. Legal values are PEDANTIC, NORMAL and RELAXED. Default is NORMAL. This only disables several messages and warnings from the beginning. Any IGNOREs passed before are reseted.

STATUS

Display several status messages (output goes to stderr). Legal flags are:

• QUIET: no status messages
• LINE: display name and line of file currently processing Included files are also displayed. After processing a file, the filename and the total number of lines remain visible.
• VERSION: display program title and version
• VERBOSE: enable verbose status messages; for example, the information displayed during the processing of <$exec> remains visible.

The above flags can be combined by separating them with a "|", eg STATUS=line|version, exept for QUIET.

STRIPTAGS=tag_list

Strip some specific tags from document. tag_list is a string, that contains all tags that should be stripped, sepparated by a vertical bar ("|").
See also STRIPCOMMENT and STRIPEXTERNAL.

ICONBASE=base_uri

Replace all icon-entities by images that must be available in base_uri. For example, with ICONBASE=:icons, the entity &back; is replaced by <IMG SRC=":icons/back.gif" ALT="back">. Note that this argument does not denote a directoty, but an URI. It's recommended to use an absolute URI.

Switches

COMPACT

Strip redundant linefeeds and white-spaces from output.

GETSIZE

Get width and height of images and set corresponding attributes WIDTH and HEIGHTwith these values;

PIPEIN

Read input file from stdin

RPLCENT

Replace special charaters with its entity (eg "ü" becomes "&uuml").

SMARTENT

Replace special charaters "&", "<" and ">" with its entity (&, < and >) if they are surrounded by white-spaces. Also replace quotes by ".

STRIPCOMMENT

Strip all SGML-comments from input.

STRIPEXTERNAL

Strip tags, that reference to an external URI.