Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
stdoptions:start [2022/06/24 06:48]
rajit
stdoptions:start [2022/06/24 06:54] (current)
rajit [Command-line flags]
Line 1: Line 1:
-===== Common command-line options =====+===== Common options ===== 
 + 
 +==== Command-line flags ====
  
 ACT tools that use the core act library all accept the following command-line options. These options should come first, before any tool-specific options: ACT tools that use the core act library all accept the following command-line options. These options should come first, before any tool-specific options:
Line 6: Line 8:
    * ''-cnf=//file//'': reads in the specified file as an ACT configuration file (after the default files for the specified technology)    * ''-cnf=//file//'': reads in the specified file as an ACT configuration file (after the default files for the specified technology)
    * ''-W//name//:on'' or ''-W//name//:off'': turn on/off warnings. ''name'' can be:    * ''-W//name//:on'' or ''-W//name//:off'': turn on/off warnings. ''name'' can be:
-      * ''empty_select'' : warn if all the guards in a selection statement in ACT are false.+      * ''empty_select'' : warn if all the guards in a selection statement in ACT (the core language, not the CHP/HSE sub-language) are false.
       * ''dup_pass'' : warn if an ACT tool registers a duplicate pass.       * ''dup_pass'' : warn if an ACT tool registers a duplicate pass.
       * ''no_local_driver'' : warn if a local variable doesn't have a driver if detected during some of the ACT analysis passes.       * ''no_local_driver'' : warn if a local variable doesn't have a driver if detected during some of the ACT analysis passes.
       * ''double_expand'' : warn if an ACT tool attempts to expand an already expanded ACT object.       * ''double_expand'' : warn if an ACT tool attempts to expand an already expanded ACT object.
       * ''lang_subst'' : warn if an ACT tool uses a different language body within a process than the default choice.       * ''lang_subst'' : warn if an ACT tool uses a different language body within a process than the default choice.
-      * ''all''turn on all warnings+      * ''all'' all warnings
    * ''-V//name//'': turn on verbose log messages in the ACT library. Currently ''name'' can be:    * ''-V//name//'': turn on verbose log messages in the ACT library. Currently ''name'' can be:
       * ''config'' : print out absolute paths for the config files read. This goes to stderr by default       * ''config'' : print out absolute paths for the config files read. This goes to stderr by default
Line 19: Line 21:
    * ''-ref=//number//'': select refinement body, if it exists. Refinements can be nested, so the number specifies the number of refinement levels that should be expanded. The standard use case is ''-ref=1'', where one level of refinement is selected.    * ''-ref=//number//'': select refinement body, if it exists. Refinements can be nested, so the number specifies the number of refinement levels that should be expanded. The standard use case is ''-ref=1'', where one level of refinement is selected.
  
-An individual project might want to include a standard set of ACT options (e.g. -T//tech//) for all ACT tool invocations. The environment variable ''ACT_STD_CMDLINE'' can be set to the standard command-line options.+==== Environment variables ==== 
 + 
 +A number of environment variables impact the operation of the ACT tools.
  
 +   * ''ACT_HOME'': this should be set to the directory of the ACT installation. Standard system-wide ACT libraries are located in ''$ACT_HOME/act'', and this directory is part of the search path for ACT files that are ''import''ed.
 +   * ''ACT_PATH'': this is a colon-separated search path for ACT files (akin to the standard Unix ''PATH'' variable used by the shell). This is typically set to the root of an ACT project, so that all the ACT files in the project can be accessed relative to the specified path. 
 +   * ''ACT_STD_CMDLINE'': An individual project might want to include a standard set of ACT options (e.g. -T//tech//) for all ACT tool invocations. The environment variable ''ACT_STD_CMDLINE'' can be set to the standard command-line options.