Specify Command Line Options
Command line utilities require zero or more options in order to run. These options may be supplied on the command line or placed in one or more configuration files.
hwGenImages -pb channel -inp channel.img
or place the
following lines in the configuration file hw.cnf:
problem= channel
inp= channel.img
and issue the
commandhwGenImages
If both command line argument and
configuration options are provided, the former takes precedence.hwGenImages -pb channel
is equivalent
to hwGenImages -problem channel
problem= channel
is
equivalent to pb= channel
setenv HW_CNF_FILES ./hw.cnf:~/hw.cnf:/scratch/hw.cnf
the
files hw.cnf are searched in the local, home, and the /scratch
directories for each option. Missing files are ignored. If the environment variable
is not set, it is assumed to have the following value:
./hw.cnf:~/hw.cnf
Empty lines and lines starting with a hash
(#) are ignored in configuration files. All unrecognized options are also ignored.
Each recognized line consists of one option and its value; they are separated by an
"=" and any (or no) amount of white space (tabs and blanks).hwGenImages -h
prints a message
such as the following and
exits:hwGenImages:
hwGenImages: Usage:
hwGenImages:
hwGenImages: hwGenImages [options]
hwGenImages:
hwGenImages: Options:
hwGenImages:
hwGenImages: -h print usage and exit
hwGenImages: help= TRUE [command-line]
hwGenImages: -pb <str> problem name
hwGenImages: problem= _undefined [default]
hwGenImages: -inp <str> input file name (_auto, use <problem>.img
hwGenImages: input_file= _auto [default]
hwGenImages: -dir <str> run directory
hwGenImages: run_directory= _auto [default]
hwGenImages: -np <str> number of processors
hwGenImages: num_processors= _auto [default]
hwGenImages: -copy_input copy input file into run directory
hwGenImages: copy= TRUE [default]
hwGenImages: -socket_port <str> socket port for client server communication
hwGenImages: port= _auto [default]
hwGenImages: -fieldview_type <enum> type of fieldview installation: acu,full
hwGenImages: fv_type= full [default]
hwGenImages: -image_size <enum> image size (tiny=640x480,small=800x600,medium_small=960x720,medium=1280x960,medium_large=1920x1440,poster_medium_large=1920x1280,large=2560x1920,poster_large=2880x1920,huge=3840x2880): tiny,small,medium_small,medium,medium_large,poster_medium_large,large,poster_large,huge
hwGenImages: size= medium_small [default]
hwGenImages: -log_msg record terminal output into a log file
hwGenImages: log= TRUE [default]
hwGenImages: -overwrite_output overwrite output of previous run
hwGenImages: overwrite= TRUE [default]
hwGenImages: -stream_msg stream output messages to terminal
hwGenImages: stream= TRUE [default]
hwGenImages: -run_fieldview run fieldview
hwGenImages: run= TRUE [default]
hwGenImages: -image_format <enum> format for the individual frames: png,jpg,bmp,miff,eps
hwGenImages: ifmt= png [default]
hwGenImages: -dataguide activate dataguide to accelerate subsequent file reads
hwGenImages: dg= FALSE [default]
hwGenImages: -software_render use software rendering
hwGenImages: sr= FALSE [default]
hwGenImages: -optimize_boundary_memory optimize boundaries for memory usage
hwGenImages: opt_bnd_mem= TRUE [default]
hwGenImages: -optimize_isosurface_memory optimize isosurfaces for memory usage
hwGenImages: opt_iso_mem= TRUE [default]
hwGenImages: -optimize_view_operations optimize view operations for speed
hwGenImages: opt_view= TRUE [default]
hwGenImages: -fit_view fit each image to the screen
hwGenImages: fit= TRUE [default]
hwGenImages: -export_plots export plot data in text file
hwGenImages: exp_plt= TRUE [default]
hwGenImages: -generate_report generate report containing images
hwGenImages: rep= TRUE [default]
hwGenImages: -report_format <enum> report format (pdf or powerpoint): pdf,pptx,both
hwGenImages: format= both [default]
hwGenImages: -image_borders add borders to images in reports
hwGenImages: borders= TRUE [default]
hwGenImages: -write_extract_database write extract data base to disk
hwGenImages: xdb= FALSE [default]
hwGenImages: -run_in_batch run completely in batch mode
hwGenImages: batch= TRUE [default]
hwGenImages: -v <int> verbose level
hwGenImages: verbose= 1 [default]
hwGenImages:
hwGenImages: Configuration Files:
hwGenImages:
hwGenImages: ./hw.cnf:/home/corsoda/hw.cnf
hwGenImages:
verbose= 1
is interpreted by all programs. To assign an option
to a single executable, add the name of the executable plus a period to the
beginning of the option's name. For
example,verbose= 1
hwGenImages.verbose= 0
The verbose value of
1 is used by all programs except hwGenImages, which uses the value of 0.verbose= 1
HP.verbose= 2
The executable and
architecture names may be combined in either
order:HP.hwGenImages.verbose= 0
hwGenImages.SUN.verbose= 1
Option Types
- String
- This is a user-given string value. On the command line, this option must
be followed by a value. For example:
The equivalent option in the hw.cnf file ishwGenImages -problem channel
problem= channel
Note: The (upper/lower) case of the option is preserved. If a string contains white spaces, it must be enclosed in a pair of double-quotes. The double-quotes may be omitted in hw.cnf:surface_integral_output_sets= wall surface
- Enumerated (enum)
- This is a set of values available for a given option. On the command
line, this option must be followed by a value. For example,
or equivalently the hw.cnf optionhwGenImages -image_format png
causes hwGenImages to generate images in the png format.image_format= png
- Boolean
- This turns a given option on or off. To turn on an option, issue the
command with the option as the argument. For example:
To turn off an option, issue the command with a no_appended to the option. For example:hwGenImages -batch
In the configuration file, specify on by assigning 1, t, true, yes or on in upper or lower case. Specify off by assigning 0, f, false, no or off in upper or lower case. For example the following configuration options are equivalent to the above command line options:hwGenImages -no_batch
andrun_in_batch= yes
run_in_batch= FALSE
- Integer
- This is an integer value option. On the command line, this option must
be followed by a value. For example:
or equivalently in the configuration file,hwGenImages -np 4
num_processors= 4
- Real
- This is a floating point value option. On the command line, this option must be followed by a value.