mkprimer(1) - generate a primer for torx
Table of Contents
mkprimer - generate a primer for torx
mkprimer [ options ... ]
mkprimer generates from a given specification file
an executable primer program (see torx-primer(5)) and two configuration
files. By default, mkprimer tries to use the suffix of the given specification
file to detect the specification language. This can be overruled with the
--language option. By default, the name of the generated primer file is derived
from the given specification file name by omitting the file name suffix.
This can be overruled with a -o option.
If no specification is given, mkprimer
lists the specifcation languages that it can handle, together with their
corresponding file name suffixes. If the --list flag is given, mkprimer lists
the specifcation languages that it can handle, one per line, on standard
output, and exits.
mkprimer takes its information about specification languages
and file name suffixes from a number of mkprimer(5) modules in the distribution
Use of a preprocessor with mkprimer(1) is discussed in cppmkprimer(1),
m4mkprimer(1), and preprocmkprimer(1).
- -o primer
- This option specificies
the name of the primer that will be generated. By default the name is derived
from input-name, by omitting the recognized language suffix.
- --language name
- This option specificies the format of the input file. It overrules the default
file suffix association. This option has to be accompanied by the -o option.
- This option makes mkprimer list the specifcation languages that it
can handle, one per line, on standard output, after which it exits.
- This option is only relevant for specifications for which the
generic, language independent primer(1) is used. This option indicates that
in the generatef primer program the primer(1) should be invoked with a
-f config-file option.
- --inputs gate-names
- This option is not relevant for Promela
specifications. This option indicates that events that `happen' on gates in
gate-names should be treated as inputs. It also triggers the generation of
the file.torx and the file.gates configuration files. (this command line
option will probably be removed, eventually)
- --outputs gate-names
- This option
is not relevant for Promela specifications. This option indicates that events
that `happen' on gates in gate-names should be treated as outputs. It also
triggers the generation of the file.torx and the file.gates configuration
files. (this command line option will probably be deprecated)
- The generated primer executable. The interface to it is described
- this file contains the information given
with the --inputs and --outputs options, as torx-config(4) INPUT and OUTPUT
entries containing only gate names, which makes it a suitable (additional)
configuration file for torx.
- this file contains information about
the location of the specification file, in the form of the following entries
in the torx-config(4) format. The entries in this file can be used to generate
a SOURCESPEC or SOURCEIUT entry for torx-config(4), for example in a xtorx-extension(n)
- SOURCEGIVEN specification-given
- The specification filename with which
mkprimer(1) is invoked.
- SOURCEABS specification-absolute
- The specification
filename, but translated to an absolute path.
- SOURCEREL specification-relative
- The specification filename, but translated to a relative path, relative
to the directory in which the generated primer is written.
- SOURCECWD directory
- The absolute path name to the directory in which the generated primer is
mkprimer-cadp(1), mkprimer-ltsa(1), mkprimer-trojka(1), torx(1), torx-primer(5),
cppmkprimer(1), m4mkprimer(1), preprocmkprimer(1), torx-config(4), mkprimer(5)
For LOTOS specifications the input specification needs to have a known
suffix, which will guarantee that this suffix is recognized by open.caesar,
the tool that is used to generate part of LOTOS primers. Using the mkprimer
--language option does not help here.
- a mkprimer(5) description
file for a language or toolkit supported by TorX.
The primer.gates file (and the --inputs
and --outputs options) are only useful if no other information needs to be
specified with the INPUT and OUTPUT torx-config(4) configuration entries.
By Email: <firstname.lastname@example.org>
This manual page documents
version 3.9.0 of mkprimer.
Table of Contents
Table of Contents
Appendix D: TorX Manual Pages: mkprimer-trojka(1) - generate a promela primer for torx using trojka
Appendix D: TorX Manual Pages: mscviewer(1) - view a Message Sequence Chart