stydoc Command description

contents

# stydoc STYX Documentation Generator

'stydoc' produces a HTML-like reference documentation for a STYX grammar [.sty].

Comments not starting with ';;' will also be included.

## Arguments

Name | Type | Semantic
InFile | path | path of the STYX grammar [.sty]
Template | path | path of the template file (eg. tstydoc_us.htm)

The target file 'OutFile' should contain the language name so that embedded languages can be referenced, too.

## Options

An option will be specified as follows: -<Name>=<Value>
A flag is toggled that way: -<Name>
The default value will be applied when the option wasn't specified.

Name | Type | Default value | Semantic
OutFile | path | "" | path of the target file (default: stdout)
StyxPath | path | . | path of STYX grammar include files
RefAlias | string | & | alias for the first character of a pattern reference
recursiv | flag | false | recursive pattern evaluation
prodcom | flag | false | print production comments
keepNTs | string | "" | NTs which shouldn't be expanded ( NT ; ... )
noClass | string | "" | split NT Classes ( NT ; ... )
exProds | string | "" | hide NT Productions ( NT . Prod ; ... )
ignRRef | string | "" | ignore recursive references ( NT ; ... )

## Environment

An environment variable will be specified as followed: -<Name>=<Value>
The default value will be applied when no environment variable was specified.

Name | Type | Default value | Semantic
BINSTYX | path | PATH | search environment for the parse table image [.pim]