Technical data

Syntax conventions
CR-242 Command Syntax and Conventions ModelSim EE/SE Command Reference
Syntax conventions
These syntax elements are used within all ModelSim command documentation:
Comments in argument files loaded with -f <filename>
Argument files may be loaded with the -f <filename> argument of the vcom, vlog,
and vsim commands. The -f <filename> argument specifies a file that contains
more command line arguments. It allows complex arguments to be reused without
retyping.
Comments within the argument files follow these rules:
All text in a line beginning with // to its end is treated as a comment.
All text bracketed by /* ... */ is treated as a comment.
Also, program arguments can be placed on separate lines in the argument file, with
the newline characters treated as space characters. There is no need to put '\' at the
end of each line.
Note: Neither the prompt at the beginning of a line nor the <Enter> or <Return> key that ends a line is
shown in the examples.
Syntax notation Description
< > angled brackets surrounding a syntax item indicate a user-defined argument; do
not enter the brackets in commands
[ ] square brackets indicate an optional item; if the brackets surround several
words, all must be entered as a group; the brackets are not entered
...
an ellipsis indicates items that may appear more than once; the ellipsis itself
does not appear in commands
| the vertical bar indicates a choice between items on either side of it; do not
include the bar in the command
monospaced type
monospaced type is used in examples
# comments included with commands are preceded by the number sign (#); useful
for adding comments to DO files (macros)