The gsdbdoc command
The gsdbdoc command generates documentation from a meta-schema.
This tool is provided by Genero Studio, and can be found in the $GSTDIR/bin (or, if you are on a Mac, $GSTDIR/Contents/MacOS) directory. It is called when the user selects the menu option to generate the meta-schema documentation; however, you can also open a command prompt (such as the Genero Workplace Window) and run the command from the command line.
Syntax
gsdbdoc [
options]
Option | Description |
---|---|
-db file |
Specify the path of the schema file. Required. |
-o dir |
Specify the output directory. When this option is not provided, the current directory is used. |
-st file |
Specify the path of the style (.css) file relative to the output directory. When this option is not provided, default styling is applied. Default styling is defined in the /src/db/tools/style.css file located in $GSTDIR/bin (or, if you are on a Mac, $GSTDIR/Contents/MacOS). Tip:
Use the default style file as a basis for creating your custom style file. You can also look at the generated HTML (in the output directory) for a list of possible style elements. |
-t dir |
Specify the directory for the BAM template.
dir can be either:
When this option is not provided, the GSTSETUPDIR environment variable is used. |
-l VERBOSE |
Display a verbose log for troubleshooting. |
-h |
Display help. |
-V |
Display program name and version. |