Next: , Previous: Description, Up: Running


7.2 General options

-I dir
Add the directory dir to the list of directories to be searched for included files. The dir argument is passed as-is to the cpp program via the same -I option.

When -r option is in effect (either explicitely passed on the command line, or configured by default during the build process), an implicit -I directive pointing to the directory of the input file is appended to the end of the list of searched directories.

-D macro[=value]
Predefine macro to value if given, or 1 if value is omitted, in the same way as a #define directive would do it. This option is passed as-is to the cpp program.

If you are invoking genom from the shell, you may have to use the shell quoting character to protect shell's special characters such as spaces.

An implicit macro __GENOM__ is always defined and contains the version of the genom program. This can be used to divert some lines in source files meant to be included by other tools that genom, and that contain syntax that genom does not understand.

-E
Stop after the preprocessing stage, and do not run genom proper. The output of cpp is sent to the standard output. genom exits with a non-zero status if there are any preprocessing errors, such as a non-existent included file.
-n
--parse-only
Stop after the input file parsing stage, and do not invoke any template. This is useful to check the syntax of the input file. Any errors or warning are reported and genom exits with a non-zero status if there are errors.
-N
--dump
Stop after the input file parsing stage, do not invoke any template and dump the parsed specification in dotgen format. This is mostly useful for debugging genom itself or to view the actual specification built by genom from a complex (set of) file(s). Any errors or warning are reported and genom exits with a non-zero status if there are errors.
-l
--list
Print to the standard output the list of available templates, one per line.

By default, the standard templates directory is searched, but any -t option will be taken into account.

-t path
--tmpldir=path
Use path as the directory containing templates. This can be a colon separated list of directories which are searched in order.

This option is useful only for templates not installed in the genom standard directories, i.e. share/genom/<version>/templates or share/genom/site-templates.

Each component of path is searched for files matching */template.tcl, where * is interpreted as the template name.

-s dir
--sysdir=dir
Use dir as the directory holding genom engine files. This option is useful if non-standard engines are to be used. The default value is share/genom/<version>/engines.

dir should contain directories named after the engine name.

-T dir
--tmpdir=dir
Use dir as the temporary directory holding intermediate files. See also the environment variable TMPDIR.
-r
--rename
Some cpp programs cannot handle correctly files with a .gen extension. This option will make genom call cpp with an input file ending in .c, linked to the real input file.
-v
--verbose
Force genom to be more verbose while processing input files.
-d
--debug
Activate some debugging options. In particular, temporary files are not deleted. Useful for debugging genom itself or generator engines.
--version
Display the version number of the invoked GenoM.
-h
--help
Print usage summary and exit.