Museum

Home

Lab Overview

Retrotechnology Articles

⇒ Online Manual

Media Vault

Software Library

Restoration Projects

Artifacts Sought

Syntax:

Unix:
     a_reveng  -model model_name -input file_name1 [file_name2...]
               [-config config_file] [-layout_info layout_info_file_name]
               [-generate generate_option] [-errorfile file_name] [-verbose]
               [-help [help_dir] | -syntax [help_dir] | -version]
               [-options] [-arg_input filename] [-noheader]
               [-quiet] [-ask] [-unix] [-vms] [-os2]

VMS:
     a_reveng  /model="model_name" /input=(file_name1,file_name2,...)
               [/config=config_file] [/layout_info=layout_info_file_name]
               [/generate=generate_option] [/errorfile=file_name] [/verbose]
               [/help [=help_dir] | /syntax [=help_dir] | /version]
               [/options] [/arg_input=filename] [/noheader]
               [/quiet] [/ask] [/unix] [/vms] [/os2]

OS2:
     a_reveng  /model:model_name /input:(file_name1,file_name2...)
               [/config:file_name] [/layout_info:file_name]
               [/generate:gen_option] [/errorfile:file_name] [/verbose]
               [/help [:help_dir] | /syntax [:help_dir] | /version]
               [/options] [/arg_input:filename] [/noheader]
               [/quiet] [/ask] [/unix] [/vms] [/os2]

Program Description:
     a_reveng recognizes the defining structure of one or more
Ada programs, and creates Ada Structure Graphs to represent that
structure.

Options:
     model <model_name>       Specifies a model name.
     input <file_name...>     Specifies the input file(s), which MUST contain
                                  a proper Ada program.
     config <config_file>     Specifies a configuration file.
     layout_info <file_name>  Specifies a layout info file (see below.)
                                  (Default: internal default values.)
     generate <gen_option>    Specifies which ASG's to generate.
                                  "gen_option" can have the following
                                  values (the default is "all"):
                                    all           all defining diagrams and
                                                    the CONTEXT diagram
                                    context_only  only the CONTEXT diagram
                                    no_context    all defining diagrams, but
                                                    no CONTEXT diagram
     errorfile <file_name>    Specifies an error file  (default: stderr).
     verbose                  Shows extra status messages.
     help <help_dir>          Shows the full help screen (this information)
                                  and exits.  The optional argument indicates
                                  the directory that contains the help file.
     syntax <help_dir>        Shows the short help screen (syntax lines only)
                                  and exits.  The optional argument indicates
                                  the directory that contains the help file.
     version                  Shows the program header and the teamwork
                                  version, and exits.
     options                  Shows the command line options chosen, before
                                  executing the program.
     arg_input <file_name>    Indicates that more command line options are in
                                  the file 'file_name'.
     noheader                 Suppresses display of the program header
                                  before program execution.
     quiet                    Suppresses status messages during
                                  program execution.
     ask                      Prompts the user for required command line
                                  options that are not specified.
     unix                     Allows the entry of options in Unix format
                                  (-example_option).
     vms                      Allows the entry of options in VMS format
                                  (/example_option).
     os2                      Allows the entry of options in OS2 format
                                  (/example_option).

Examples (Unix-format):

1)  Reverse engineer the file "myfile" and put all diagrams into model
    "mymodel" using config file "/joe/config":

    a_reveng -model mymodel -input myfile -config /joe/config

2)  Reverse engineer the files "ada_1", "ada_2", and "ada_3", make just
    the CONTEXT diagram out of them, and put it into "my_Other_Model" using
    "my_config":

    a_reveng -config my_config -model my_Other_Model -generate context_only
             -input ada_1 ada_2 ada_3

3)  Reverse engineer "ada_file", make all (and only) the defining diagrams
    from it using the parameters in "dimensions_file", and put the diagrams
    into model "mymodel" using "/cadre/tsa/config_file":

    a_reveng -model mymodel -input ada_file -generate no_context
             -layout_info dimensions_file -config /cadre/tsa/config_file


Below is a sample layout_info file.  Each of the 14 lines must start with
the value.  The order of the values is assumed to be the same as below (the
comments after the values are ignored).  The values shown here are equal to
the default values taken if the layout_info option is not in the
command line.

25      -- Vertical spacing between children
25      -- Horizontal spacing between children
70      -- Vertical spacing between parents
70      -- Horizontal spacing between parents
40      -- Shortest allowable height of a unit
100     -- Thinnest allowable width of a unit
400     -- Starting leftmost x-coord
450     -- Starting topmost y-coord
5       -- Horizontal space between couples
5       -- Max # children before parent is split into two columns
20      -- Height of instantiation invocation from top of unit
75      -- Distance of externally connected unit from main unit
70      -- Default length of a defining invocation with no couples
30      -- Vertical space between generic subprogram parameters

Typewritten Software • bear@typewritten.org • Edmonds, WA 98026