|--- Main Contents ---|
Legal's & Copyright
Contact, info sources
Extending this program
Bugs & Limits
Before you start
Installation, basic usage
Command file Examples
Command file syntax
FAQ / Common pitfalls
This is a syntactical description of the command files.
A command file consists of statements. Each statement is a keyword or file name, optionally followed by a block in brackets '(...)'. It may also contain Comments at any position.
A Statement can be on of
The create statement must be followed by an opening bracket, a file name base, and a closing bracket, like in 'create ( fnamebase )'
This statement tells rvglue what files to write. Rvglue adds the suffices '.w' and '.ncp' to the file name base.
The create section is usually required to get rvglue to run. You may use the '-o=' and '-output=' command line options instead of this section.
See Example 1.
The global section is a special Instance Option Group, that is used for instances not mentioned in 'real' instance option groups.
It is defined by the key word 'global' followed by an instance option group.
See Example 8.
The define section is a special Instance Option Group, that is used to store options list for later usage.
It is defined by the key word 'define' followed by an instance option group.
The appearance of the name of a .w file tells rvglue to read that file and include it in the output files.
The file name may be followed by an Option Set.
See Example 1.
The appearance of the name of a .fin file tells rvglue to read that file and include every instance mentioned in it in the output files.
The file name may be followed by an Instance Option Group.
See Example 4.
An option set is a list of options (as listed in the Options Reference), enclosed in round brackets '(...)'.
See Example 2.
An instance option group defines specific options for specific instances. It is enclosed in round brackets '(...)'.
Every entry in the instance option group consists of an instance's file name base (The instance name without the .prm extension) and a associated Option Set.
It may also contain a special set, that is indicated by the key word 'default'
When reading .fin files, and including their instances, the program will look for an option set it should apply to an instance:
See Example 5.
A comment can be either something enclosed in square brackets '[...]', which may span multiple lines, or a hashmark '#', which reaches to the end of the line.
See Example 7.