Environment Variables

Variable Name Used By Description
CLEARCASE_ROOT    
DISPLAY vovsh

GUI

nc run -Ix

Name of the X display. It is required to use the graphical user interface.
HERO_EMUL HERO

hero

The name of a specific emulator in Hero. Available at runtime
HERO_HOST HERO

HERO_PORT

Together with HERO_PORT, used by some Hero utilities to locate the HERO wrapper for one emulator. Each emulator has a wrapper and the wrapper can be found with HERO_PORT and HERO_HOST. This variable should not be set by the user.
HERO_PORT HERO

HERO_HOST

Together with HERO_HOST, it is used by some Hero utilities to locate the HERO wrapper for one emulator. Each emulator has a wrapper and the wrapper can be found with HERO_PORT and HERO_HOST. This variable should not be set by the user.
HERO_VENDOR HERO

hero

One of the supported Hero vendors (currently, one of zebu palladium veloce).
KRB5CCNAME nc kerberos The name of the Kerberos Credential Cache file.
LD_LIBRARY_PATH vrt
LD_LIBRARY_PATH_64 vrt
LD_PRELOAD vrt Used on Linux to preload vovrti.so, the interception library.
LM_PROJECT nc This variable is used by FlexNet Publisher to specify a project for a checkout. It is also used by nc run to define the default value of the jobproj field of a job. See also VOV_JOBPROJ and RLM_PROJECT.
LM_VAR_NAME vovgetflexlmdaemons

vwrap

vw

Specify the name of the environment variables to be set on the basis of the grabbed resources. This variable is used by the wrapper vw and by the script vovgetflexlmdaemons.tcl. The variable VOV_LM_VARNAMES is preferable to this.
LOGNAME   Normally defined in the standard environment (POSIX).
NC_AUDIT_FILE nc Specify a file in which to log NC CLI commands for auditing. The file must be writable by the user issuing the nc command. The variable may contain a single reference to another, which will be expanded to compute the file pathname.
# This could go in the .cshrc file.  Note single-quotes here.
setenv NC_AUDIT_FILE '$HOME/.vncaudit.txt'
NC_CONFIG_DIR nc/wx utilities

ncmgr/wxmgr

LSF emulation utilities

Specify the directory that contains the NC/WX queue configuration file. This location must be a shared network location that all clients can read. The default location is $VOVDIR/local/vncConfig. Because the configuration is created by ncmgr/wxmgr, the variable must be set before running those utilities to create a queue. Afterward, the variable must be set in the admin-defined, shell-specific vovsetup.csh|sh|tcl script (Linux) in $VOVDIR/local, or vovinit.bat (Windows) in $VOVDIR/local.
NC_DEFAULT_JOBCLASS nc run

nc jobclass

This is a useful variable to speedup job submission with nc run. If this variable is set, use its value to find out the default jobclass. This is should be the same as the property NC_DEFAULT_JOBCLASS attached to Object 1.
NC_FIFO nc run Use this variable if you are running a lot (thousands) of nc commands from the same shell. This variable points to a file that is used in a mkfifo command to create a fifo. When nc is run, it checks that fifo. If it does not exist, it creates it, and then waits for commands to arrive on that fifo. If it does exist, it sends the arguments of nc run to the fifo. The benefit is that we bypass the initialization of the Tcl interpreter.
# Example:
# This could go in the .cshrc file
setenv NC_FIFO /tmp/vovncfifo$$
NC_LIST_FORMAT nc Specify the default format for nc list.
NC_LOGDIR nc run

bsub

Specify the directory to be used to store the logs. This is used also by the LSF emulation script bsub.
# This could go in the .cshrc file
setenv NC_LOGDIR $USER/.myvnc_logs
Old names also supported: VNC_LOGDIR, FTNC_LOGDIR.
NC_LOGDIR_PERMS nc run

bsub

Specify the permissions for the directory to be used to store user logs. Must be specified in UNIX permissions format. Default value is 0775. This is used also by the LSF emulation script bsub.
# This could go in the .cshrc file
setenv NC_LOGDIR_PERMS 0777
NC_NOLOG nc run

bsub

Internal variable used only to disambiguate the environment for interactive jobs. Do not set this variable.
NC_OLDQUEUE nc

ncmgr

Used to migrate from an old queue to the new queue.
NC_OLDVERSION nc

ncmgr

Used to migrate from an old queue to the new queue.
NC_QUEUE nc

ncmgr

wx

wxmgr

Specify the name of the queue used by the nc and wx commands. This can be specified as a simple name (e.g. XXXX), in which case the system sources the file in $VOVDIR/local/vncConfig/XXXX.tcl, or it could be the full path to the setup.tcl file in the .swd. If not specified, the value used is "vnc".
NC_RUN_ARGS nc Specify the default arguments for nc run. The arguments in this variable are prepended to the arguments passed on the command line. Use NC_RUN_ARGS_AFTER is you want to append arguments to the command line.
NC_RUN_ARGS_AFTER nc Specify some default arguments for nc run. The arguments in this variable are appended to the arguments passed on the command line. Use NC_RUN_ARGS is you want to prepend arguments to the command line.
NC_RUN_BLOCKING_STDOUT nc Experimental. Controls whether the stdout/stdin descriptors in an interactive job are to be set to non-blocking or not. Typical usage in situations like:
% env NC_RUN_BLOCKING_STDOUT=0 nc run -Il my_command | tee foo.log
NC_SNAPSHOTDIR nc

ncmgr

Specify the directory to be used to store the environment snapshots. This variable can be the path to a directory or a symbolic value such as
  • "normal", which is the same as using $NC_LOGDIR/snapshots/$USER/$VOVARCH
  • "fullpath", which is the same as "normal" except a full path is used
  • "serverdir", which uses $PROJECT.swd/snapshots/$USER/$VOVARCH
  • "homedir", which uses ~/.ncsnapshots/$VOVARCH
The default directory for the snapshot is ./vnc_logs/snapshots/$USER/$VOVARCH
NC_SNAPSHOTDIR_PERMS nc run

bsub

Specify the permissions for the directory to be used to store the environment snapshots. Must be specified in UNIX permissions format. Default value is 0775. This is used also by the LSF emulation script bsub.
# This could go in the .cshrc file
setenv NC_SNAPSHOTDIR_PERMS 0777
NC_SNAPSHOTFILE_PERMS nc run

bsub

Specify the permissions for the environments snapshot files. Must be specified in UNIX permissions format. Default value is 0664. This is used also by the LSF emulation script bsub.
# This could go in the .cshrc file
setenv NC_SNAPSHOTFILE_PERMS 0644
NC_STOP_SIGNALS nc stop

bkill

Specify the signals sent by nc stop. This is a comma-separated list of signals to be sent to the processes in the job. The signals include TERM INT KILL HUP USR1 USR2 CONT TSTP.
In addition, EXT is supported in the format EXT:SIGNAL:INCLUDERX:EXCLUDERX:SKIPTOP (notice that we use the colon ':' instead of ',' commas).
  • SIGNAL is required
  • INCLUDERX is optional and is a regexp that matches names of processes that will be sent the signal
  • EXCLUDERX is optional and is a regexp that matches names of processes that will NOT be sent the signal
  • SKIPTOP is optional (default 1) and is a boolean to control whether the top process (normally vw) is skipped or not (i.e. by default we do not send the signal to vw)
Examples:
% setenv NC_STOP_SIGNALS TERM,INT,KILL
% setenv NC_STOP_SIGNALS EXT:TSTP:vwish
% setenv NC_STOP_SIGNALS CONT,CONT,EXT:TSTP:vwish,CONT
In the case of nc stop, instead of this environment variable, you can use a property on a job with the name NC_STOP_SIGNALS and with the same syntax. The signals are sent to the job with a delay determined by VOV_STOP_SIGNAL_DELAY or NC_STOP_SIG_DELAY, and is 3 second by default. If both NC_STOP_SIGNALS and VOV_STOP_SIGNALS are present in the environment, the value of VOV_STOP_SIGNALS will be used. If both NC_STOP_SIG_DELAY and VOV_STOP_SIGNAL_DELAY are present in the environment, the value of VOV_STOP_SIGNAL_DELAY will be used.
NC_STOP_SIG_DELAY nc stop

bkill

Specify the delay between signals sent by nc stop. In seconds. The default value is 3 seconds. If both NC_STOP_SIG_DELAY and VOV_STOP_SIGNAL_DELAY are present in the environment, the value of VOV_STOP_SIGNAL_DELAY will be used.
NC_SUSPEND_SIGNALS vtk_job_control Specify the signals sent by vtk_job_control when action is SUSPEND This is a comma-separated list of signals to be sent to the processes in the job. The signals include TERM INT KILL HUP USR1 USR2 CONT TSTP.
In addition, EXT is supported as a signal in the format EXT:SIGNAL:INCLUDERX:EXCLUDERX:SKIPTOP (notice that we use the colon ':' instead of ',' commas).
  • SIGNAL is required
  • INCLUDERX is optional and is a regexp that matches names of processes that will be sent the signal
  • EXCLUDERX is optional and is a regexp that matches names of processes that will NOT be sent the signal
  • SKIPTOP is optional (default 1) and is a boolean to control whether the top process (normally vw) is skipped or not (i.e. by default we do not send the signal to vw)
Examples:
% setenv NC_SUSPEND_SIGNALS STOP
% setenv NC_SUSPEND_SIGNALS EXT:STOP:::1
A property on a job with the name SUSPEND_SIGNALS can be used with the same syntax. If both NC_SUSPEND_SIGNALS and VOV_SUSPEND_SIGNALS are present in the environment, the value of VOV_SUSPEND_SIGNALS will be used. The signals are sent to the job with a delay determined by vtk_job_control -delay option.
NC_TEST_KERBEROS nc kerberos Used only for testing. If set to any value, then the kerberos code assumes that the Kerberor Credential Cache file is good instead of testing it with klist. Adds verbosity to vovbytepump (only useful to developers).
NC_URL nc run This is a useful variable to speedup job submission with nc run. If this variable is set, use its value to compute the URL for the submitted job instead of asking the server. This saves one round-trip from client to server. Also consider NC_DEFAULT_JOBCLASS and NC_VALID_DIRECTORIES
Example:
setenv NC_URL `vovbrowser -url ""` 
NC_VALID_DIRECTORIES nc run This is a useful variable to speedup job submission with nc run. If this variable is set to a space-separated list of directories, we use its value to determine valid submission directories. This is supposed to be the same as the property NC_VALID_DIRECTORIES attached to Object 1. Also consider NC_URL and NC_DEFAULT_JOBCLASS.

Example 1: setenv NC_VALID_DIRECTORIES "/scratch/ /remote/work"

Example 2: setenv NC_VALID_DIRECTORIES ""

PATH   Normally defined in the standard environment (POSIX).
RLM_PROJECT nc This variable is used by Reprise to specify a project for a checkout. It is also used by nc run to define the default value of the jobproj field of a job. See also VOV_JOBPROJ and LM_PROJECT.
SECURITY_LEVEL vovsh If set, this variable can lower the security level of the vovsh. This variable can never increase the security level, which is determined by security.tcl. The variable is an integer. The common values are
  • 2 = READONLY
  • 3 = USER
  • 4 = LEADER
% env SECURITY_LEVEL=3 vovsh -f myscript.tcl
SHELL ves

vovprompt

vovsetupuser

Normally defined in the standard environment (POSIX).
TEMP vovbytepump

VovTmpFile

Normally defined in Windows to point to a writable directory for temporary files, this variable is used also on UNIX in the Tcl procedure VovTmpFile.
TZ   Normally defined in the standard environment (POSIX).
USER   Normally defined in the standard environment (POSIX).
VNCSWD nc

ncmgr

Normally used to specify the server working directory for Accelerator. Its value is normally $VOVDIR/../../vnc. For installations including a mix of UNIX and Windows NT, the value of VNCSWD is normally set also in $VOVDIR/local/vovinit.bat which is executed as part of the initialization sequence on Windows NT.
VOVARCH   Identifies the application architecture. It is computed by the tool vovarch. It is normally set in $VOVDIR/etc/vovrc.{sh,csh,bat}.
VOVBUILDOPTIONS vovmake Pass options to be used by vovbuild inside of vovmake.
VOVCLEARCASE   If set to "ENABLED", this variable activates the ClearCase routines to track dependencies on both the "view extended name" and the "version extended name" of a file.
VOVCONSOLE_SUBMIT_CMD vovconsole Define that environment variable so that the vovconsole automatically bsubs itself. Typical usage:
setenv VOVCONSOLE_SUBMIT_CMD 'bsub -o /dev/null -R "rusage[mem=200]" '
Use:
printenv | grep VOVCONSOLE_SUBMIT_CMD
VOVCONSOLE_SUBMIT_CMD=bsub -R "rusage[mem=200]"

to check the value of that variable as echo $VOVCONSOLE_SUBMIT_CMD would return a No match error.

You may also want to use:
setenv VOVCONSOLE_SUBMIT_CMD 'bsub -R "rusage[mem=200]" -I '

to debug submission errors.

VOVDIR   The root of the VOV distribution tree for a specific architecture. VOVDIR always includes the architecture. From $VOVDIR, you can get the binaries in $VOVDIR/bin.
VOVEQUIV_CACHE_FILE   Provides the ability to override the default behavior of using a server-side cache of path equivalence information. Set to a value of "legacy" to instruct clients to read the file directly. This is a legacy method that requires that all clients have access to the server working directory so they can parse equiv.tcl file for entries, and read/write access to the equiv.caches directory so the entries can be written to a host-based cache file for future use. Set to a custom cache file path to instruct clients to read a specific cache file only. This is a special method used in corner cases where directories may not be the same but should be forced to be considered the same. This is utilized mainly by Monitor agent single-file distributables.
VOVGMAKE vovmake Specify the path to gmaek_with_vov_extension
VOVLSFINFOD vsm

nc mon

This variable should have the form HOST:PORT and represents the way to access the vovlsfinfod daemon. The PORT is normally 6006.
VOVLSF_USE_NC LSF emulation utilities Set to 0 to prevent LSF emulation from interacting with Accelerator. This is only required when wanting LSF emulation to interact with a FlowTracer server instead of Accelerator.
VOVMAKEDOCLEANUP vovmake If set to 1, do not cleanup the intermediate Flow file caused by dumping the makefiles rules.
VOVPROJECT_SUBMIT_CMD vovproject

vovserver

This variable contains the command used by vovproject to launch the vovserver, for example using bsub. Typical usage:
setenv VOVPROJECT_SUBMIT_CMD 'bsub -o logs/server.20130531_123000.log
-R "rusage[mem=200]" '
Since this variable often has a value with tricky characters, we suggest you use:
% printenv | grep VOVPROJECT_SUBMIT_CMD
VOVPROJECT_SUBMIT_CMD=bsub -R "rusage[mem=200]"

to check the value of that variable as echo $VOVPROJECT_SUBMIT_CMD would return a No match error.

For debugging purposes, you may also want to use interactive options like the option -I in this example:
% setenv VOVPROJECT_SUBMIT_CMD 'bsub -R "rusage[mem=200]" -I '
VOVRTILIB   Control the name of the dynamic library used for Runtime Interception. By default, the library is $VOVDIR/lib/vovrti.so. This variable is used mostly by developers.
VOVRTILOGFILE   Specify location of log file for debugging information about the behavior of VOVRTI.
VOVSAVEPROMPT vovprompt

ves

veprestore

Used to store the original value of the prompt.
VOVSETUPFILE indirect taskers

nc run ID ...

If this variable is set, then the indirect tasker use its value when submitting a job from FlowTracer to Accelerator. Specifically, the value of VOVSETUPFILE becomes the parameter for the PROJECT environment. In other words, the indirect tasker submits a job of type vrun with environment "PROJECT($VOVSETUPFILE)"
VOVTMPVAR vovtasker Temporary variable used only in the initialization of the multi-environment subsystem. Do not use this variable because it is likely to be over-written.
VOV_32BIT vovarch See VOV_BIT_MODE instead.
VOV_ALARM vovgetgroups Used by vovgetgroups to avoid hanging indefinitely. The default value is 10 seconds, but there is no maximum upper limit.
VOV_BACKGROUND   Sets the background color of the GUI and of all the browser pages. If not set, the color is chosen automatically by hashing the project name so that each project has a slightly different background. The background should be light. Examples:
setenv VOV_BACKGROUND wheat
setenv VOV_BACKGROUND #FFB094
VOV_BIT_MODE vovarch This variable is used to select which architecture to use on 64-bit Linux machines and affects the output of the vovarch command. By default the command returns "linux64" on 64-bit Linux machines. However, these machines can also run 32-bit binaries as long as the standard 32-bit libraries are included in the Linux installation. To force a 64-bit machine to run Altair Accelerator in 32-bit mode, set this environment variable to "linux" before sourcing the shell-appropriate vovrc setup script. Example:
setenv VOV_BIT_MODE "linux64"
VOV_BJOBS_JOBID_WIDTH bjobs Used to override the default job ID column width of -7. Characters to the left of the width limit are truncated and replaced with an asterisk to indicate the truncation. Pass a negative integer for left justification. Pass a positive integer for right justification.
VOV_CAPSULE_DIR vov

vw

vrt

vw2

vtrace

Specify a list of directories where capsules can be found. The list is separated by a colon ':' on Unix and by a semicolon ';' on Windows.
The other directories that are searched are:
  • The current working directory
  • $VOV_CAPSULE_DIR
  • $VOVDIR/local/capsules
  • $VOVDIR/tcl/vtcl/capsules
VOV_CGROUPS_ENABLE   If this variable is set to 1 in the environment of vovtaskerroot, then the CGROUP:RAM capability is enabled.
# Recommended in vnc.swd/setup.tcl
setenv VOV_CGROUPS_ENABLE 1 
VOV_CHANNEL VIL Full path to the vovchannel binary. Defaults to $VOVDIR/bin/vovchannel.
VOV_CHANNEL_OPEN VIL

vovchanneld

Used internally by VIL and by vovchannel. Should not be set by the user.
VOV_CLIENT_NAME   If set, this variable is used to set the name field for a client. The client name is only visible from the /admin?page=clients browser page.
VOV_CONFLICT_CONTROL vw

vrt

vov

vtrace

vw2

If there is a conflict, check the value of this variable. If it is ABORT or CONTINUE, behave correspondingly. If it has another value, print a warning and return ABORT. If the variable is not set, in case of conflict a dialog will be posted to determine what to do. This variable is used to control Runtime Tracing in case of conflict. If the behavior is ABORT, then the tool is aborted at the first conflict. If the behavior is CONTINUE, then the tool continues to execute.
VOV_DB_APP   This variable can be used to select different database configurations for the same VOV project. In the file *.swd/db/config.tcl, use VovSQL::getDbApp to return the value of this variable.
VOV_DEBUG_BYTEPUMP vovbytepump Adds verbosity to vovbytepump (only useful to developers).
VOV_DEBUG_ENV vel

ves

Adds verbosity to vel and ves. Set the value to 1 for debugging, to 0 to disable debugging.
VOV_DEBUG_EQUIV vw2

vov

vrt

vtrace

vw

vovtasker

vovtaskerroot

Adds verbosity to equivalence handling module.
VOV_DEBUG_FLAGS All VOV clients This variable is to be used only by developers and experts. It controls debugging output to monitor communication between clients and server. It also controls verbosity of some modules. Here is a quick reminder of the possible values for this variable.
  • 1 - CHANNEL
  • 2 - CLIENT
  • 4 - SERVER
  • 8 - VIL
  • 16 - RPC Codes
  • 128 - Exclusions
  • 256 - VOVRTI
The definition of the flags is documented in \$VOVDIR/src/vil/vil.h
VOV_DEBUG_GETGROUPS vovtasker Adds verbosity to vovgetgroups.
VOV_DEBUG_LDAPAUTH vovserver

vovldapauth

Adds verbosity to LDAP authentication procedure.
VOV_DEBUG_LIMITS vw2

vov

vrt

vtrace

vw

vovtasker

vovtaskerroot

Adds verbosity to tools that set the resource limits like cputime and coredumpsize. Affects vovtasker and vw2.
VOV_DEBUG_MD5 vw

vov

vrt

vw2

Adds verbosity to wrapper code used to implement MD5 based barriers. Any value of this variable activates the verbosity. Unset the variable to disable.
VOV_DEBUG_NO_START vovtasker Provides debug info for jobs launched by taskers that do not start successfully. Causes the tasker to run the vov_diagnostic_no_start script to generate detailed debug information on why a job did not start. Set to 1 for coarse info (most common setting). Set to 2 for more detail (should only be done for brief periods on selected taskers due to high server load).
VOV_DEBUG_ORIGARGS nc Enables the capturing of the original argument list to nc run and stores it as a property (ORIGARGS) for debugging purposes. Set this variable to 1 in the submit shell or NC setup.tcl file to enable. Do not use this function unless it is needed, however, since it will cause the server to consume a significant amount of RAM with higher workloads.
VOV_DEBUG_PAMAUTH vovserver

vovpamauth

Adds verbosity to pam authentication procedure.
VOV_DEBUG_PTY vovtasker

vovsh

Adds verbosity to PTY code, used in vovsh and vovtasker with interactive jobs that require a PTY. Set the value to 1 for basic information, or to 2 to see every character being sent.
VOV_DEBUG_TASKER_CHDIR vovtasker

vovtaskerroot

Used to troubleshoot problems with subtasker changing to the run directory. Only useful for debugging, should normally be unset. Debugging output appears in vovtasker's log file. When set, activates a call the script vov_diagnostics_chdir whenever a vovtasker is unable to start a job because the working directory for the job cannot be reached. This type of errors can be hard to diagnose, for example in cases when the error is caused by slow or overloaded auto-mounters.
VOV_DEBUG_TASKER_GROUPS vovtasker

vovtaskerroot

Adds verbosity to the code used to compute os groups for users.
VOV_DEBUG_TASKER_NC vovtasker Adds verbosity to the indirect NC tasker. Set variable to 1 to enable, to 0 to disable. Default is 0.
VOV_DEBUG_SYMLINKS vw

vrt

vov
Adds verbosity to code used to expand symlinks. Often used in conjunction with VOV_SYNC_CACHE_DIR Set the value to 1 to activate, unset to deactivate.
VOV_DEBUG_VTKGRAPH vovsh

GUI

Adds verbosity to graph widget in vovsh.
VOV_DELAY_BEGIN vw Delay job execution after start by specified number of seconds. Used to compensate for offset in filesystem clock.
VOV_DELAY_END vw Introduce a small delay after the job is done and before checking the timestamps of the outputs.
VOV_DELAY_FIRE vw Delay tasker firing by specified number of seconds. Used to compensate for offset in filesystem clock.
VOV_DISABLE_DST_CHECK   Disable the code used to compensate for "Daylight Saving Time" overcompensation bug on Windows NT. By default, the code is active.
VOV_DISABLE_SHARED_MEMORY_LOOKUP vovtaskerroot

vovtasker

Instructs the tasker (the top level vovtaskerroot/vovtasker process) to disable the calculation of the job's CURRAM usage by extracting Pss usage statistics from /proc/PID/smaps system files. In disabled mode, the RSS usage for all processes in a job will be used to calculate CURRAM instead. Specify 0 to enable and 1 to disable. Default: 0
VOV_DISABLE_VIL_REDIRECT VIL

vovchannel

Disable redirection of stdout and stderr through VIL and vovchannel.
VOV_EDITOR vovsh

GUI

Used by the GUI to decide which editor to use. If not set, it defaults to write on Win64 and to xterm -e vi on UNIX.
VOV_ENV ves

vw

Used to support multiple environments. Stores the name of the current environment. If it is not set, the environment name is assumed to be DEFAULT and the multiple environment support is disabled.
VOV_ENV_DIR vel

ves

vovtasker

Used to support multiple environments. Its value is a list of the directories that contain the environment scripts. The list elements are separated by colons ':' on UNIX and by semicolons ';' on Windows NT.
VOV_ENV_SOURCE vwrap Used by vwrap to source the environment snapshot. Should not be set by the user.
VOV_ENV_STRICT ves By default, ves ignores errors when switching environments. When this variable is set to a non-zero value, any environment switch which writes to stderr will be strictly treated as an error and the environment switch will fail.
VOV_EXCLUDE_FILES vw

vov

vrt

vw1

List of files containing exclusion rules. If this variable is not set, the wrappers only read the exclude.tcl file in the SWD directory. Missing files in the list are silently ignored. Errors in sourcing the files are also silently ignored. The files in the list are separated by colons ':' on UNIX and by semicolons ';' on Windows.
VOV_FAIL_ON_CONFLICT   Use VOV_CONFLICT_CONTROL instead. If there is a conflict, cause the job to fail right away. Do not pop-up a dialog or wait for user input. Especially useful in the environment for taskers in Windows-NT.
VOV_FDL_ONLY viltool

VovInput

VovOutput

VovFdl

VovResources

If this variable is set, the VIL-Tools do not communicate with the server but instead generate the equivalent FDL code. If the value of the variable is "1", the code is printed on stdout. If the value of the variable is the name of a writable file, the code is written to that file (no locking). A value of "0" is the same as not having the variable defined. See example in $VOVDIR/training/basic/example.csh.
VOV_FIFO_OPEN VIL

vovchannel

Used internally by VIL and by vovchannel. Should not be set by the user.
VOV_FOREGROUND vovserver

vovsh

GUI

Sets the foreground color of the VOV dialogs. If not set, the color is chosen automatically so that each project has a slightly different foreground. The foreground should be dark. Examples:
setenv VOV_FOREGROUND black
setenv VOV_FOREGROUND #00322F 
VOV_FT_LOGS vrun When using vrun (see "indirect taskers") you can choose to propagate the list of log files from FT to NC. This is done by setting VOV_FT_LOGS to 1 in the environment for vrun.
VOV_GOTOHOST_COMMAND vovconsole Command used in the "GoToHost" callback in vovconsole. The command should contain the token '@HOST@' which will be replaced with the name of the host. The default value is "vovxrsh @HOST@".
VOV_GRABBED_RESOURCES   When a job is being executed on a vovtasker this environment variable is set to describe the resources that have been grabbed for this job.
VOV_GROUP   If present, it defines the FairShare group for jobs.
VOV_GROUP_PURGE_PERIOD vovtaskerroot

vovtasker

Instructs the tasker to periodically purge cached UNIX group information, including gid/name maps and user group lists. Specified in seconds (minimum 60). Default: 0 (disabled).
VOV_HOST_HTTP_NAME   Variable to control the name of the server as it is to be used in the HTTP interface. If not defined, use VOV_HOST_NAME.
VOV_HOST_IP   If present, used to connect to the vovserver. You may want to use this variable to avoid calling the function getaddrinfo() which can be expensive on systems in which the DNS is not working properly.
Warning: For some values of this variable, the clients will hang indefinitely. The recommendation, in general, is to not use this variable. The variable overrides the value of VOV_HOST_NAME. Example:
% setenv VOV_HOST_IP 192.168.33.12
VOV_HOST_NAME   Used by all tools. It is the name of the machine on which the vovserver is running, unless VOV_HOST_IP is also set, in which case it takes precedence.
VOV_HTTP_UNSECURE vovserver Disables authentication in the browser. Everyone can connect, but their security level will be READONLY. Used only by vovserver. Its usage is discouraged. Use config(httpSecure) in policy.tcl file instead.
VOV_INSTANCE_CHARGE_BOUNDARY vovtasker

vovtaskerroot

This variable is used mostly for testing, so you don't have to wait for a full hour to test the effect of the other variable VOV_INSTANCE_LAUNCH_TS. If not defined, the CHARGE BOUNDARY is considered to be 3600, which is 1 hour in seconds. The minimum value for this variable is 300 seconds. There is no upper bound. For testing, this variable can be set to lower values, like 300. Recommendation: do not use this variable and accept the default value.
VOV_INSTANCE_LAUNCH_TS vovtasker

vovtaskerroot

Used in cloud computing environments where the charges per instance are rounded up to the nearest hour. If set, it represents the launch time of the instance. If the vovtasker/vovtaskerroot uses the option -z TIMESPEC (e.g. -z 2m), the idea is to terminate the vovtasker after it has been idle for the specified amount. However, if the variable VOV_INSTANCE_LAUNCH_TS is set, then the tasker is kept running if more than 4 minutes away from the hour boundary. This is to avoid wasting a vovtasker that is essentially already paid for. The ordinary way to set this variable is in the boot script for an instance using the value returned, for example, by vov_ec2_get_launch_time
% setenv VOV_INSTANCE_LAUNCH_TS `vov_ec2_get_launch_time`
VOV_INTERACTIVE_AUTH_TIMEOUT vovtasker If interactive jobs are failing due to authentication timeouts on the vovtasker, this environment variable can be used to increase the timeout. For example, setenv VOV_INTERACTIVE_AUTH_TIMEOUT 5s will set the authentication timeout used by interactive jobs to 5 seconds. The default is 2s. The value of VOV_INTERACTIVE_AUTH_TIMEOUT is silently restricted between 2s and 30s. It is recommended to use as small a value as feasible since this also blocks the vovtasker from running other jobs. Too long a timeout can also lead to the vovserver marking the vovtasker as sick.
VOV_INTERACTIVE_PING nc run -I For sites that have firewalls that close inactive connections, you can use this variable to force Accelerator to keep the connection alive when running in interactive mode (nc -I, etc.). For example:
setenv VOV_INTERACTIVE_PING 2m 
will send a message every 20m to the interactive job.

The value of VOV_INTERACTIVE_PING is silently limited to a minimum of 1m.

VOV_JOBCLASS vw2

vw

vov

vrt

If a new job is being added to the trace by direct execution and this variable is set, it will be used as "jobclass" of the job.
VOV_JOBCLASS_DIRS nc

FDL

vovresourced

Used to specify jobclass directories in addition to the system ones in vnc.swd/jobclass, \$VOVDIR/local/jobclass and \$VOVDIR/etc/jobclass. Its value is a list of the directories to search for jobclass files. The list elements are separated by colons ':' on UNIX and by semicolons ';' on Windows.
VOV_JOBCOUNTER vovcounters

vlmstat

vtool

In the form PORT@HOST,PROJNAME, points to the license emulation server. Examples:
% setenv VOV_JOBCOUNTER 6306@somehost,licadm
% setenv VOV_JOBCOUNTER 5555@otherhost,licmon
VOV_JOBCOUNTER_PROJECT vovcounters Not used.
VOV_JOBCOUNTER_VERBOSE vovcounters Make vovcounters more verbose.
VOV_JOBID   When a job is running, it can find its own ID by querying this variable.
VOV_JOBINDEX   When a job array is submitted, the VOV_JOBINDEX environment variable will be set in the execution environment of each job in the array. The variable is for consumption only and is not intended to be set by the user at any time.
VOV_JOBNAME vw2

vw

vov

vrt

If a new job is being added to the trace by direct execution and this variable is set, it will be used as "jobname" of the job.
VOV_JOBPROJ nc Used by nc run to define the default value of the jobproj field of a job. The order in which these variables are checked is VOV_JOBPROJ LM_PROJECT RLM_PROJECT and the first one found prevails.
VOV_JOBSLOT   Set only for jobs running on a tasker. It represents the slot number in which the job is running.
VOV_JOB_BLOCKNAME vovsql_record_one_job Allows the CAD engineers to define a name for a block. Examples are: CPU, Cache, Sequencer, Decoder, Bus, PCI, DRAM1... If it is not defined, vovsql_record_one_job will also look in the environment for a value from BLOCK.
VOV_JOB_BLOCKRELEASE vovsql_record_one_job Complement/qualifier to VOV_JOB_BLOCKNAME. It allows the CAD engineer to record what specific release of the block is currently being used. For one NAME and one SPIN, there maybe several RELEASEs.
VOV_JOB_BLOCKSPIN vovsql_record_one_job Complement/qualifier to VOV_JOB_BLOCKNAME. It allows the CAD engineer to record what specific spin of the block is being used. One NAME will typically have multiple SPINs. In electronic design, it is usually the floorplan name.
VOV_JOB_BLOCKVARIANT vovsql_record_one_job Complement/qualifier to VOV_JOB_BLOCKNAME. It allows the CAD engineer to record what specific variant of the block is being used. A VARIANT is typically of larger scope than a NAME. One VARIANT will typically have multiple NAMEs. It's like a family or generation of blocks.
VOV_JOB_EXPERIMENTNAME vovsql_record_one_job Define a short name for the experiment in progress. Examples: congestion_0p60 or congestion_0p65, or syn_effort_low, or 16_tracks, etc. If not defined, the script will look for a common environment variable: NICKNAME. The experiment name is picked by each designer as they go through their design cycle and is meaningful mostly to the designer.
VOV_JOB_EXPERIMENTROOTDIR vovsql_record_one_job Define a root directory for the experiment in progress. If not defined, but an experiment config file was found, the location of the experiment config file will be used.
VOV_JOB_FLOWNAME vovsql_record_one_job Allows the CAD engineers to define a name for a flow. Examples are: synthesis, verification, placenoute.
VOV_JOB_FLOWRELEASE vovsql_record_one_job Complement/qualifier to VOV_JOB_FLOWNAME. It allows the CAD engineer to record what specific release of the flow is being used. For one NAME and one SPIN, there maybe several RELEASEs. Examples are: build_78666, rel_1.0, 2012.09...
VOV_JOB_FLOWSPIN vovsql_record_one_job Complement/qualifier to VOV_JOB_FLOWNAME. It allows the CAD engineer to record what specific spin of the flow is being used. One NAME will typically have multiple SPINs. It could be considered as the personality of the flow. Examples are: Q1_stretch...
VOV_JOB_FLOWVARIANT vovsql_record_one_job Complement/qualifier to VOV_JOB_FLOWNAME. It allows the CAD engineer to record what specific variant of the flow is being used. A VARIANT is typically of larger scope than a NAME. One VARIANT will typically have multiple NAMEs. It's like a family of flows. Examples are: FullChip, Block...
VOV_JOB_NAME vovsql_record_one_job Should be set to the name of the job (see the "activity" paragraph in the "recording jobs" page for a discussion on job names). If it is not defined, the jobname defined during the building of the graph will be used, and otherwise an abbreviated command line will be used.
VOV_JOB_PREDICTIONS_DIR vovsql_record_one_job Name of the directory where to generate the memory prediction files. Used by gen_predict_files .
VOV_JOB_PREDICTNAME vovsql_record_one_job Enables invisible override of VOV_JOB_NAME so that a different name can be used for the job just for the matters of memory usage prediction. If it does not exist, the value of VOV_JOB_NAME is used, and if VOV_JOB_NAME does not exist, then the jobname defined during the building of the graph will be used, and if that does not exist, the tool name will be used.
VOV_JOB_PROJECTNAME vovsql_record_one_job Allows the CAD engineers to define a name for a project. Examples are: SandyBridge, IvyBridge, Nehalem, Westmere, Bulldozer, Bobcat, Redwood, Cedar, Krait... If it is not defined, vovsql_record_one_job will also look in the environment for a value from LSB_PROJECT, then LM_PROJECT, then PROJECT.
VOV_JOB_PROJECTRELEASE vovsql_record_one_job Complement/qualifier to VOV_JOB_PROJECTNAME. It allows the CAD engineer to record what specific release of the project is currently being used. For one NAME and one SPIN, there maybe several RELEASEs. Examples are: rel_1.0, nl-2.1, fp10... If it is not defined, vovsql_record_one_job will also look in the environment for a value from RELEASE.
VOV_JOB_PROJECTSPIN vovsql_record_one_job Complement/qualifier to VOV_JOB_PROJECTNAME. It allows the CAD engineer to record what specific spin of the project is being used. One NAME will typically have multiple SPINs. In electronic design, it is usually the tapeout name. Examples are: v1, sa11... If it is not defined, vovsql_record_one_job will also look in the environment for a value from SPIN then TAPEOUT.
VOV_JOB_PROJECTVARIANT vovsql_record_one_job Complement/qualifier to VOV_JOB_PROJECTNAME. It allows the CAD engineer to record what specific variant of the project is being used. A VARIANT is typically of larger scope than a NAME. One VARIANT will typically have multiple NAMEs. It's like a family or generation of projects. Examples are: Evergreen, SouthernIslands, Kepler... If it is not defined, vovsql_record_one_job will also look in the environment for a value from VARIANT.
VOV_JOB_SITECITY vovsql_record_one_job Provide a city name for a site. Some companies use a convention for site names that may not be obvious to a newcomer. Example: LSDC would stand for Lone Star Design Centre. If you're not American, you may not know this means Austin, Texas. The SITECITY field lets you record the name of the city where the site is. Example: Austin.
VOV_JOB_SITECOUNTRY vovsql_record_one_job Records the country of the current site.
VOV_JOB_SITENAME vovsql_record_one_job Provide a site name. This is usually used to record a common disk space / server farm. Examples are: Hyderabad, HYDC, LoneStar, sj, Canada. If it is not defined, vovsql_record_one_job will also look in the environment for a value from SITE, then XSITE.
VOV_JOB_SITETIMEZONE vovsql_record_one_job Records the timezone of the current site.
VOV_JOB_USERSITENAME vovsql_record_one_job User site vs host site. With global companies, a user located in Hyderabad, India may be working remotely on a server farm located in Anchorage, Alaska, USA. Due to the hierarchy of the company, you may want to capture the difference between the site where the user is physically located (Hyderabad) as (s)he may report through a local hierarchy, and the site where the job is running (Anchorage) as this cost depends from the American hierarchy. Depending on their level in the organization, some persons may be interested in activity reports based on people's locations (such as, what are my people in Hyderabad doing), while others may be interested in how is the Anchorage farm doing.

The best way to address this is to use a background data acquisition script that populates/refreshes the users' sites everyday from a central location like LDAP or Microsoft ActiveDirectory, and to let the environment variables take care of the job/compute host's site. VOV_JOB_USERSITENAME can provide a different site name just for the user. This is usually used to record the physical location of the human running the jobs.

Examples are: Hyderabad, HYDC, LoneStar, sj, Canada. If it is not defined, vovsql_record_one_job will also look in the environment for a value from VOV_JOB_SITENAME, then SITE, then XSITE.

VOV_LICENSE_KEY vovserver

vovreadlicutil

Specify a path for the VOV License Key file. The default is license.key in the PROJECT.swd directory.
VOV_LICMON ftlm_lmproject Register job project information. It is used to point to the instance of Monitor that captures checkout information. It has the following forms:
Non-SSL: <host>:<port>
         Example: lmsrv:5555
SSL:     <host>:<port>:ssl
         Example: lmsrv:5555:ssl
VOV_LIMIT_cputime vw

vovtasker

Together with other VOV_LIMIT_* variables, allows passing of 'limit' information to a job using the environment. This one controls the "cputime" limit. Common use in Accelerator:
% nc run -e "BASE+D(VOV_LIMIT_cputime=10)" short_job
VOV_LIMIT_datasize vw

vovtasker

Together with other VOV_LIMIT_* variables, allows passing of 'limit' information to a job using the environment. Common use in Accelerator:
% nc run -e "BASE+D(VOV_LIMIT_datasize=8192k)" job_command
The value of the variable must be an sequence of digits followed by an optional unit indicator letter (case insensitive), or the string value 'unlimited'. If there is no unit indicator, the units are kilobytes (1024 bytes). The recognized unit indicators are:
  • k or K, kilobytes (same as no unit indicator)
  • M, Megabytes (multiply by 1024)
  • G, Gigabytes (multiply by 1024*1024)
  • T, Terabytes (multiply by 1024*1024*1024)
VOV_LIMIT_descriptors vw

vovtasker

Do not use this variable. Use VOV_LIMIT_openfiles instead.
VOV_LIMIT_filesize vw

vovtasker

Together with other VOV_LIMIT_* variables, allows passing of 'limit' information to a job using the environment. Common use in Accelerator:
% nc run -e "BASE+D(VOV_LIMIT_filesize=100M)" job_command 

On Linux, this limit controls the system limit called RLIMIT_FSIZE.

The value of the variable must be an sequence of digits followed by an optional unit indicator letter (case insensitive), or the string value 'unlimited'. If there is no unit indicator, the units are kilobytes (1024 bytes). The recognized unit indicators are:
  • k or K, kilobytes (same as no unit indicator)
  • M, Megabytes (multiply by 1024)
  • G, Gigabytes (multiply by 1024*1024)
  • T, Terabytes (multiply by 1024*1024*1024)
VOV_LIMIT_maxproc vw

vovtasker

Together with other VOV_LIMIT_* variables, allows passing of 'limit' information to a job using the environment. Common use in Accelerator:
% nc run -e "BASE+D(VOV_LIMIT_maxproc=100)" job_command

On Linux, this limit controls the system limit called RLIMIT_NPROC.

The value of the variable must be an integer.

VOV_LIMIT_memorylocked vw

vovtasker

Together with other VOV_LIMIT_* variables, allows passing of 'limit' information to a job using the environment. Common use in Accelerator:
% nc run -e "BASE+D(VOV_LIMIT_memorylocked=200)" job_command

On Linux, this limit controls the system limit called RLIMIT_MEMLOCK.

The value of the variable must be an sequence of digits followed by an optional unit indicator letter (case insensitive), or the string value 'unlimited'. If there is no unit indicator, the units are kilobytes (1024 bytes). The recognized unit indicators are:
  • k or K, kilobytes (same as no unit indicator)
  • M, Megabytes (multiply by 1024)
  • G, Gigabytes (multiply by 1024*1024)
  • T, Terabytes (multiply by 1024*1024*1024)
VOV_LIMIT_memoryuse vw

vovtasker

This variable is a no-op and is provided for backward compatibility only. The same is true for the memoryuse limit in UNIX shells as well.
VOV_LIMIT_openfiles vw

vovtasker

Together with other VOV_LIMIT_* variables, allows passing of 'limit' information to a job using the environment. This one controls the number of file descriptors that can be used by a job. Common use in Accelerator:
% nc run -e "BASE+D(VOV_LIMIT_openfiles=1024)" job_command

In C-shell, this limit is also called 'descriptors'.

VOV_LIMIT_stacksize vw

vovtasker

Together with other VOV_LIMIT_* variables, allows passing of 'limit' information to a job using the environment. Common use in Accelerator:
% nc run -e "BASE+D(VOV_LIMIT_stacksize=8192k)" job_command
The value of the variable must be an sequence of digits followed by an optional unit indicator letter (case insensitive), or the string value 'unlimited'. If there is no unit indicator, the units are kilobytes (1024 bytes). The recognized unit indicators are:
  • k or K, kilobytes (same as no unit indicator)
  • M, Megabytes (multiply by 1024)
  • G, Gigabytes (multiply by 1024*1024)
  • T, Terabytes (multiply by 1024*1024*1024)
VOV_LIMIT_vmemoryuse vw

vovtasker

Together with other VOV_LIMIT_* variables, is used to pass shell 'limit' information to a job via the environment. Common use in Accelerator:
% nc run -e "BASE+D(VOV_LIMIT_vmemoryuse=100M)" job_command

On Linux, this limit controls the system limit called RLIMIT_AS (address space).

The value of the variable must be an sequence of digits followed by an optional unit indicator letter (case insensitive), or the string value 'unlimited'. If there is no unit indicator, the units are kilobytes (1024 bytes). The recognized unit indicators are:
  • k or K, kilobytes (same as no unit indicator)
  • M, Megabytes (multiply by 1024)
  • G, Gigabytes (multiply by 1024*1024)
  • T, Terabytes (multiply by 1024*1024*1024)
VOV_LIVERECORDER_LOGDIR vovsh Specify directory for LiveRecorder log file for vovsh. Default is /tmp.
VOV_LIVERECORDER_LOGSIZE vovsh Specify maximum size (MB) of LiveRecorder log file for vovsh. Default is 256.
VOV_LIVERECORDER_ON vovsh Set to any value to enable LiveRecorder for vovsh.
VOV_LMPROJECT_EXPIRE ftlm_lmproject When set, this overrides the default 4h expiration of the management project designation entered by the ftlm_lmproject script. The value is a VOV timespec, e.g. 7d is seven days.
VOV_LM_BATCH ftlm_batch_report Affects the generation of HTML for batch reports. In particular, if the variable is set (to any value), it disables the INPUT on images.
VOV_LM_VARNAMES vw Specify a comma-separated list of variables to be set automatically on the basis of the grabbed resources. This variable is honored by the VOV wrappers (vw, vov, ...) so jobs that use no wrapper (like interactive jobs) do not have access to this service. An alternative method to set the LM_LICENSE_FILE automatically is provided by the utility vovgetflexlmdaemons.
VOV_LOCAL_DIR vovworkflowsim A local directory on the machine that can be used for I/O intensive operations. This is used by vovworkflowsim to store the intermediate results of the simulation. In that context, the default value of the directory is /tmp/vov/wa.
VOV_LOG_LSFEMUL bsub

bjob

bkill

lsid

lshosts

bqueues

bmgroup

Choose file to be used to log the invocations of the LSF emulation scripts. Example: setenv VOV_LOG_LSFEMUL ~/lsfemul.log
VOV_LSF_QUEUES vsm

nc mon

Only needed when using indirect taskers from VOV to LSF. It represents a space-separated list of LSF queues to be monitored.
VOV_MAX_WAIT_AFTER_CRASH vovtaskerroot

vovtasker

Deprecated. Please use VOV_MAX_WAIT_TO_RECONNECT instead.
VOV_MAX_WAIT_NO_START vovtaskerroot

vovtasker

Controls the time a tasker waits for fork()/exec() to work. This is called the "time to start" and it is typically a few milliseconds, but could grow large or infinite if there are problems with the machines. The valid range is 20 seconds to 8 days. The default value is 1 minute. This value may be a VOV timespec, e.g. 5m (5 minutes). This variable must be set when vovtasker starts, usually by setting it in the project SWD/setup.tcl file. The value may be changed at runtime with vovtaskermgr configure TASKERNAME maxwaitnostart TIMESPEC.
VOV_MAX_WAIT_TO_RECONNECT vovtaskerroot

vovtasker

Controls the time a tasker waits for a new vovserver to appear after losing connection to the server. The default value is 3 minutes for FlowTracer and 4 days for all other products. This variable must be set when the tasker starts.
VOV_MD5_CMD

vw

vov

vrt

vw2

Change the command used to compute the md5 digest for purpose of computing MD5 based barriers. The default is /sbin/md5 -q on MacOsX and /usr/bin/md5sum on the other platforms.
VOV_MIN_DESCRIPTORS ncmgr

wxmgr

Specify the minimum number of file descriptors to be required by the server. The shell in which the server is being started will be tested, and if the current file descriptor soft limit is less than the specified minimum, an attempt will be made to raise the limit. If the specified minimum exceeds the system's file descriptor hard limit, an error will be displayed and the server will not be started. If not specified, the value used is 2500.
VOV_NAME_SERVICE_RETRY_MAX vovserver

vovtasker

Number of attempts the tasker will make to determine the current username via local name services. Retries may be necessitated by misconfigured or malfunctioning name services on the host. The default value is 3.
VOV_NAME_SERVICE_RETRY_WAIT vovserver

vovtasker

Number of seconds to wait between retries when querying the name services for the current username. Retries may be necessitated by misconfigured or malfunctioning name services on the host. The default value is 3.
VOV_NISRETRYCT vovtasker In systems where NIS is slow or unreliable, this variable controls how many times the getgrnam() call should be retried (default 5s). Its use is discouraged: fix NIS instead.
VOV_NISRETRYWAIT vovtasker In systems where NIS is slow or unreliable, this variable controls how long to wait bewteen retries (default 10s). Its use is discouraged: fix NIS instead.
VOV_PAUSE_CHILD_SIGNAL vovtasker Linux platforms only

Controls the signal sent to child processes when a tasker enters the PAUSED state. By default, this signal will be SIGSTOP. If an unsupported value is entered, the variable will be ignored and the default behavior ("STOP") will occur.

Supported values:
  1. STOP : send SIGSTOP to child processes. This is the default behavior.
  2. TSTP : send SIGTSTP to child processes.
    Note: Child processes are not guaranteed to be suspended by this signal.
  3. NONE : do not send a signal to child processes.
  4. <empty string> : same as NONE.
Examples:
% setenv VOV_PAUSE_CHILD_SIGNAL "STOP"
% setenv VOV_PAUSE_CHILD_SIGNAL "TSTP"
% setenv VOV_PAUSE_CHILD_SIGNAL "NONE"
% setenv VOV_PAUSE_CHILD_SIGNAL ""
VOV_PBS_JOB_HISTORY_ENABLE qdel Direct the PBS emulation environment to behave as though job history were enabled. User must set the value of this variable to an integer greater than zero to enable this behavior. Default is disabled.
VOV_PIPES_TO_CLOSE VIL

vovchannel

Used internally by VIL on Windows and by vovchannel. Should not be set by the user.
VOV_PORT_NUMBER vovserver

vovtasker

vovsh

Controls the port number to which vovserver will bind. The port is used by various clients to establish a connection with the server. The variable can have the following forms:
  1. A number: specify a static port.
  2. A colon-separated list of numbers.
  3. Two numbers separated by a + (e.g. 8000+20000) where the first number represents a base and the second number a range for the selection of a port based on a hash of the project name. In the example 8000+20000, the port will be selected in the range from 8000 to 28000.
  4. The value "automatic" (default), which maps to a integer value hashed from the project name in the range 6200-6455
  5. The value "any", vovserver will search for an available port starting from 8000, up to 30000, until one is found.
  6. The value "NUMBER:any", vovserver will first try to open the specified port, then switch to "any" if that port cannot be used.
Examples:
% setenv VOV_PORT_NUMBER "automatic"
% setenv VOV_PORT_NUMBER 5555
% setenv VOV_PORT_NUMBER "6000+15000"
% setenv VOV_PORT_NUMBER "6273:automatic"
% setenv VOV_PORT_NUMBER "any"
% setenv VOV_PORT_NUMBER "7202:any"
% setenv VOV_PORT_NUMBER "8690:8891:8892:8893"
VOV_PROJECT_NAME   Used by all tools. Name of the project managed by a vovserver.
VOV_PROJECT_TYPES_DIR   The primary directory where one can find the definition of project types. The default directories that are always searched are: $VOVDIR/local/ProjectTypes and $VOVDIR/etc/ProjectTypes .
VOV_PROTOCOL ALL Control the communication protocol between clients and server. The default value is "8.2". Legal values are either "8.2" or "8.3", but any value other than "8.2" is interpreted as "8.3" at this time. Introduced in 8.2.5, mostly for testing. Customers should not set this variable.
VOV_PTY_PORT_RANGE ALL This range is to illustrate that at most one -I job can run. If a run -I job is submitted and a PTY port in this range is not available then the submission will fail to add a job.

Example usage: setenv VOV_PTY_PORT_RANGE 14000:14000

VOV_RAM_SENTRY vovtaskerroot

vovtasker

Enables the RAM Sentry, a mechanism that monitors jobs' memory utilization and prevents them from forcing a tasker to enter swap. Set this variable to 1 in the NC setup.tcl file to enable the RAM Sentry.
VOV_READONLY_PORT_NUMBER vovserver Controls the port number to which vovserver will bind for guest access to the web UI. The variable can have the following forms:
  1. A number: specify a static port.
  2. Two numbers separated by a + (e.g. 8000+20000) where the first number represents a base and the second number a range for the selection of a port based on a hash of the project name. In the example 8000+20000, the port will be selected in the range from 8000 to 28000.
  3. The value "automatic", which prompts vovserver to use the chosen web port number as a baseline, increment it by 1, and use the result as the port number. If the web port is disabled (set to 0), the numeric hash of the project/instance name added to a base number of 6200 will be used as the baseline. If the resulting port is not available, vovserver will search for an available port in incremenents of 1, up to the initial port + 10, until one is found. This value is accepted for first starts only, as vovserver will rewrite the variable to the appropriate configuration files in the format of N:automatic, where N is the port number that was chosen. This format provides clients with the port number on which to communicate and also the port selection mode that is to be used for subsequent starts.
  4. The value "any" (default), which is identical to the automatic behavior described above, except that if the initially chosen port is unavailable, vovserver will search for an available port in increments of 1, up to 30000, until one is found.
Examples:
% setenv VOV_READONLY_PORT_NUMBER 5555
% setenv VOV_READONLY_PORT_NUMBER "6000+15000"
% setenv VOV_READONLY_PORT_NUMBER "automatic"
% setenv VOV_READONLY_PORT_NUMBER "6272:automatic"
% setenv VOV_READONLY_PORT_NUMBER "any"
% setenv VOV_READONLY_PORT_NUMBER "7201:any"
VOV_REGISTRY vovproject

vovserver

Used to point at the VOV Registry directory. By default, this is $VOVDIR/local/registry.
VOV_RELIABLE_TIMEOUT vovsh

vovtasker

This variable controls how long the software waits for the server to appear or to reappear after a crash. The value is a "time specification". The default is 3 seconds for the first connection and 0 seconds for reconnection after a crash.
VOV_RESOURCES vw

vw2

vov

vrt

If a new job is being added to the trace by direct execution and this variable is set, it will be used as resources of the job.
VOV_RETRACE_FAST vw

vrt

vtrace

vw2

vov

Used to indicate to the tools that a fast retracing has been requested, meaning that the dependencies should not be computed. The value of the variable is irrelevant. This variable is set by vw. The user should not be concerned about this variable.
VOV_RETRY_CHDIR vovtasker Control how many times the tasker needs to try chdir() to the working directory of the job. Normally, the chdir() is quite fast. On some systems, the chdir() may fail for a variety of reasons, including automount failure, NFS caching delays. The default value is 1, the range is from 0 to 100, which is silently enforced.
VOV_RETRY_CHDIR_SLEEP vovtasker Controls the time interval between successive attempts to try chdir() to the working directory of the job. The default value is 1, the range is from 0 to 100, which is silently enforced.
VOV_RETRY_CHDIR_SLEEP_BACKOFF vovtasker A factor that scales the VOV_RETRY_CHDIR_SLEEP amount between successive attempts to try chdir() to the working directory of the job. See also VOV_RETRY_CHDIR and VOV_RETRY_CHDIR_SLEEP. The default value is 1.0 and must be 1.0 or greater and is silently enforced.
VOV_RSH_COMMAND vovtaskermgr Command used in vovtaskermgr to start taskers.
VOV_SERVER_EXE vovproject Name to the vovserver binary. Defaults to vovserver. Normally used during testing.
VOV_SHOW_SERVICE_TIME vovsh

vovtasker

vovbuild

Used only on the client side. The vovserver always sends back to the client the "cost" in milliseconds of each service performed on behalf of the client. If set, its value represent the threshold at which the expensive services are reported using stdout. This variable is useful to educate the user about the impact of each client call on the vovserver. If the variable is missing or it has a non-positive value, the showing is disabled. Otherwise the value is capped to 1000ms. Example:
% setenv VOV_SHOW_SERVICE_TIME 10
VOV_SH_NOCONNECT   Tell vovsh to not connect to the server. Use option -n instead.
VOV_SKIP_SERVER_LOCK vovserver Use if locking is disabled or not working in the filesystem containing the directory where you want to run a vovserver. To be effective, you have to set this variable to 1 before starting vovserver. Use with care. You must be absolutely sure that there is no other vovserver running in the same directory.
VOV_TASKER_LOADAVG vovtasker

vovtaskerroot

When computing the load on a machine, vovtasker normally uses the largest of the 1m and 5m loads. If this variable is set to any value, then the machine load will simply be the 1m load. Implemented because of user request. Our recommendation is to not use this variable.
VOV_TASKER_NAME   When a job is running in a tasker, this variable specifies the name of the tasker.
VOV_TASKER_PROCLIST_FLAGS vovtasker

vovtaskerroot

Linux platforms only

Flags to control how to assign processes to a job. There are three flags:
  • 0x1: use the process group ID
  • 0x2: use the session ID
  • 0x4: use the jobid variable found in the environment

As of version 2019.01u4, the default value is 0x7 (i.e. all flags are on). Previously, the default value was 0x1.

VOV_TASKER_SID_DISABLE vovtasker

vovtaskerroot

Linux platforms only

Possible values are 0 and 1; default is 0. Signifies that the tasker should not create a new Linux session for itself and its child processes.

VOV_SQ3_DIR   The default directory for the SQLite databases is sq3 in the server working directory (e.g. vnc.swd/sq3/.) This variable allows the user to change the directory. This is useful if the default directory is not in a local file-system.
VOV_STAGING_DIR vovserver The staging of files is allowed only from a specific directory visible by vovserver. This directory is normally PROJECT.swd/staging but this can be changed by using the variable VOV_STAGING_DIR.
VOV_STDOUT_SPEC vw

vrt

vov

vtrace

vw2

Control the names of files used to save stdout and stderr. The value is computed by substituting the substrings @OUT@ and @UNIQUE@ and @ID@. Examples:
% setenv VOV_STDOUT_SPEC .std@OUT@.@UNIQUE@
% setenv VOV_STDOUT_SPEC .std@OUT@.@ID@
VOV_STOP_SIGNALS nc stop

bkill

Specify the signals sent by nc stop. This is a comma-separated list of signals to be sent to the processes in the job. The signals include TERM INT KILL HUP USR1 USR2 CONT TSTP.
In addition, EXT is supported in the format EXT:SIGNAL:INCLUDERX:EXCLUDERX:SKIPTOP (notice that we use the colon ':' instead of ',' commas).
  • SIGNAL is required
  • INCLUDERX is optional and is a regexp that matches names of processes that will be sent the signal
  • EXCLUDERX is optional and is a regexp that matches names of processes that will NOT be sent the signal
  • SKIPTOP is optional (default 1) and is a boolean to control whether the top process (normally vw) is skipped or not (i.e. by default we do not send the signal to vw)
Example:
% setenv VOV_STOP_SIGNALS TERM,INT,KILL
% setenv VOV_STOP_SIGNALS EXT:TSTP:vwish
% setenv VOV_STOP_SIGNALS CONT,CONT,EXT:TSTP:vwish,CONT 

In the case of nc stop, instead of this environment variable, one can use a property on a job with the name STOP_SIGNALS and with the same syntax. The signals are sent to the job with a delay determined by VOV_STOP_SIGNAL_DELAY, which by default is 3 second. A property on a job STOP_SIGNAL_DELAY can be used as well.

If both property and env exist, the property is honored. If both NC_STOP_SIGNALS and VOV_STOP_SIGNALS are present in the environment, the value of VOV_STOP_SIGNALS will be used. If both NC_STOP_SIG_DELAY and VOV_STOP_SIGNAL_DELAY are present in the environment, the value of VOV_STOP_SIGNAL_DELAY will be used.

VOV_STOP_SIGNAL_DELAY nc stop

bkill

Specify the delay between signals sent by nc stop. In seconds. The default value is 3 second. If both NC_STOP_SIG_DELAY and VOV_STOP_SIGNAL_DELAY are present in the environment, the value of VOV_STOP_SIGNAL_DELAY will be used.
VOV_STRICT_TRACING vw

vrt

vov

vtrace

By default, FlowTracer does not trace the files specified by file in the exclude file (exclude.tcl) in the server working directory. If this variable is set then all files will be traced.
VOV_SUSPEND_SIGNALS vtk_job_control Specify the signals sent by vtk_job_control when action is SUSPEND

This is a comma-separated list of signals to be sent to the processes in the job. The signals include TERM INT KILL HUP USR1 USR2 CONT TSTP.

In addition, EXT is supported as a signal in the format EXT:SIGNAL:INCLUDERX:EXCLUDERX:SKIPTOP (notice that we use the colon ':' instead of ',' commas).
  • SIGNAL is required
  • INCLUDERX is optional and is a regexp that matches names of processes that will be sent the signal
  • EXCLUDERX is optional and is a regexp that matches names of processes that will NOT be sent the signal
  • SKIPTOP is optional (default 1) and is a boolean to control whether the top process (normally vw) is skipped or not (i.e. by default we do not send the signal to vw)
Exmple:
% setenv VOV_SUSPEND_SIGNALS STOP
% setenv VOV_SUSPEND_SIGNALS EXT:STOP:::1 

A property on a job with the name SUSPEND_SIGNALS can be used with the same syntax. The signals are sent to the job with a delay determined by vtk_job_control -delay option. If both NC_SUSPEND_SIGNALS and VOV_SUSPEND_SIGNALS are present in the environment, the value of VOV_SUSPEND_SIGNALS will be used.

VOV_SWD_KEY nc

ncmgr

This variable is used in the routines to find the server working directory. There are possibly many mappings for the server working directory, which you can find with vovserverdir -m.

To add a new mapping, use vtk_swd_set in the policy.tcl file. The default for this variable is "unix" on UNIX systems and "windows" on Windows systems. If the value of this variable is "none", then the client will run without access to the SWD directory. This is often used with VOVEQUIV_CACHE_FILE=vovcache

VOV_SYNC_CACHE_DIR   Point to a colon-separated list of cache directories in DesignSync (formerly by Synchronicity, then Enovia, now Dassault) Set to the canonical full path to the cache directory. If set, all links into the cache are NOT expanded. The recommended way to set this variable is with vovequiv -p. Do not use:
% setenv VOV_SYNC_CACHE_DIR /whatever/location/.sync/cache
but rather use:
% setenv VOV_SYNC_CACHE_DIR `vovequiv -p /whatever/location/.sync/cache`
You can use VOV_DEBUG_SYMLINKS to check the behavior of this variable.
VOV_UMASK vw

vov vrt

Used to control umask inside a wrapper, it controls the permissions on the files created by the wrappers, such as the stdout and stderr logs. This takes any value allowed for umask.
% setenv VOV_UMASK 022
VOV_UNSET_VARNAMES vw Specify a comma-separated list of variables to be unset in the job execution environment. This is normally used in conjunction with VOV_LM_VARNAMES so that license variables are cleaned before being augmented by Accelerator. This variable is honored by the VOV wrappers (vw, vov, ...) so jobs that use no wrapper (like interactive jobs) do not have access to this service.
VOV_USE_COMMAS_IN_MAPS vovlanc

vovlavtkncset

This variable controls how the complex maps created by Allocator are defined on the Accelerator side. By default, if a resource map License:a maps to two components like License:a1 and License:a2, then LA defines the map as "License:a1 OR License:a2". If the variable VOV_USE_COMMAS_IN_MAPS is set to a non-zero value, then the map will be defined as "License:a1,License:a2" which is more efficient to manage in the scheduler.
VOV_USE_INITGROUPS vovtaskerroot Used on UNIX by vovtaskerroot to decide the method to use to switch a user identity and to initialize the groups. If set to a non-null value, the tasker uses initgroups() to initialize the groups. This call may add some load to the NIS information system. By default, vovtaskerroot caches the groups information for a user and uses a more economical call to setgroups() to initialize the groups. Use of this variable is recommended for the sites that have complicated setup of groups.
VOV_USE_PS vovps

vovtaskerroot

vovtasker

Used by the routine that scans the process table. Use this variable to disable the code that scans the /proc filesytem and revert to a method based on running ps. This is only a bit slower. Use vovps -a to see if you need to set the variable. If the command freezes, then set VOV_USE_PS and try again. Also, you may want to try to use truss vovps -a to see which PID is causing the trouble. The same behavior is obtained with the option -P of vovps.
VOV_USE_VEP std.vov.aliases

std.vov.aliases.sh

Used by Altair Accelerator Products setup scripts.

Controls whether the 'vep' command is active. This command sets the prompt to show the Altair Accelerator Products project and environment.

If unset or set to a non-zero value, the vep command will be active as an alias for csh/tcsh or a shell function for sh/ksh/bash.

Set VOV_USE_VEP to 0 before sourcing your .vovrc file to disable vep. The alias still exists, but is set to do nothing.

VOV_USE_VOVGETGROUPS vovtaskerroot Used on UNIX-based systems by vovtaskerroot. By default, instead of directly calling the getgrnam() POSIX API function, which has been shown to hang randomly and indefinitely on some systems (e.g. Linux with LDAP), the tasker will call the external utility vovgetgroups to find the list of groups to which a user belongs. This variable provides two types of control over this behavior: Set to 0 to disable the use of the external vovgetgroups utility and force the tasker to call getgrnam() directly. Set to 1 to continue to use the external utility, but instruct the utility to call the getgrent() POSIX API function instead of the default call to getgrouplist(). This is mainly for debugging purposes, since this mode of operation results in slower processing of group information.
VOV_VW_CHECK_UPCONE vw

vov

vrt

vw2

setenv VOV_VW_CHECK_UPCONE 1

If set to 1, tells the Vov wrappers to check the timestamp of the files in the upcone of the job. This is useful if your organization allows editing of intermediate files. This is equivalent to using the option -u in vw (or vov, vrt, vw2).

VOV_VW_ENTERPRISE vw

vov

vrt

vw2

When the environment variable VOV_VW_ENTERPRISE is defined, each job wrapper - vov, vw, vrt, vw2 - will look for two scripts in $VOV_VW_ENTERPRISE_DIR or $VOVDIR/local/ProjectTypes/ftenterprise/db/
  • vov_job_start - executed in parallel to the job at the same time as the job starts. As it runs in the background, its output gets logged into a unique file of the form .stdstart_xxx similar to the .stdout files.
  • vov_job_end - executed in the background right after the job end. As it runs in the background, its output gets logged into a unique file of the form .stdend_xxx similar to the .stdout files.

Those scripts can be written in bourne shell, cshell, tcl or any other language.

VOV_VW_ENTERPRISE_DIR vw

vov

vrt

vw2

Used in conjunction when the environment variable VOV_VW_ENTERPRISE is defined. Use VOV_VW_ENTERPRISE_DIR to define a location where to find:
  • vov_job_start - executed in parallel to the job at the same time as the job starts.
  • vov_job_end - executed in the background right after the job end.

If this variable is not defined, the location $VOVDIR/local/ProjectTypes/ftenterprise/db/ will be used instead.

VOV_VW_EXE_DB vw

vov

vrt

vw2

Choose the database (DB) of the executables used to run the command. The normal value is "FILE" and other meaningful values are "FILEX", "PHANTOM". If you specify another value, e.g. "NONE", then the executable will not be added to the input dependencies of the job. The default value is "FILE".
VOV_VW_LICMON vw

vov

vrt

vw2

If this variable is set, then the wrappers react to VOV_LICMON by calling ftlm_lmproject. If the variable is not set, then only the vovtasker reacts to VOV_LICMON.
VOV_VW_LIVERECORDER_LOGDIR vw

vov

vrt

vw2

Specify directory for LiveRecorder log file for the job wrapper. Default is /tmp.
VOV_VW_LIVERECORDER_LOGSIZE vw

vov

vrt

vw2

Specify maximum size (MB) of LiveRecorder log file for the job wrapper. Default is 256.
VOV_VW_LIVERECORDER_ON vw

vov

vrt

vw2

Set to any value to enable LiveRecorder for the job wrapper.
VOV_VW_LOGNAME vw

vov

vrt

vw2

Choose the name of the logfile used for verbose output. The default has the form .vw2_PID_verbose.out
VOV_VW_NFS_PROTECTION vw

vov

vrt

vw2

setenv VOV_VW_NFS_PROTECTION 1

This is equivalent to the option -n in vw. If set to 1, tell vov wrappers to activate the protection (retry up to 60 seconds at 5 seconds intervals) against dirty NFS caches. You can find that a particular job has needed that protection by looking for a NFS_PROTECTION property attached to the job.

VOV_VW_NFS_WAIT vw

vov

vrt

vw2

This variable controls the wait time for the NFS protection mechanism. The acceptable range is between 10s and 1h. The default value is 1m.
Example:
setenv VOV_VW_NFS_WAIT 10m 
VOV_VW_PAUSE_ON_TSTP vw Determines whether to pause vw jobs when they receive a SIGTSTP signal. Possible values are 0 and 1; default is 0. If set to 1, vw jobs will be paused when they receive a SIGTSTP signal and continue when receiving either a SIGCONT or SIGALRM signal.
Example:
% setenv VOV_VW_PAUSE_ON_TSTP 1 
VOV_VW_PING vw

vov

vrt

vw2

For sites that have nasty firewalls that close inactive connections, you can use this variable to force vw to keep the connection alive. For example,
setenv VOV_VW_PING 20m
will send a message ('ping') every 20m The default is 20m. The value of VOV_VW_PING is silently restricted between 3s and 10d. This function is disabled by setting VOV_VW_PING to 0. A good place to set this variable is the setup.tcl file.
VOV_VW_RETRY_WHICH vw Control how many times the wrapper will try to verify the existence of a job's command. This is mainly useful when submission scripts are used that generate a job script, and that script is located on an NFS file share that often experiences delays. The default value is 0 (try once, no retries), the range is from 0 to 100, which is silently enforced.
VOV_VW_RETRY_WHICH_SLEEP vw Controls the time interval (in seconds) between successive attempts to verify the existence a job's command. The default value is 1, the range is from 1 to 100, which is silently enforced.
VOV_VW_RETRY_WHICH_SLEEP_BACKOFF vw A factor that scales the VOV_VW_RETRY_WHICH_SLEEP amount between successive attempts to try verify a job's command. The default value is 1.0, the range is from 1.0 to 10.0, which is silently enforced.
VOV_VW_SIG_IGN vw

vov

vrt

vw2

Tell vov wrappers to ignore most signals. Same behavior as option -s.
VOV_VW_TRACK_LINKS vw

vov

vrt

vw2

Tell vov wrappers to track all symbolic links used in path expansion.
VOV_VW_VERBOSE vw

vov

vrt

vw2

Make vov wrappers verbose. Same as -v. Use values from 0 to 4.
VOV_WEB_PORT_NUMBER vovserver Controls the port number to which vovserver will bind for guest access to the web UI. The variable can have the following forms:
  1. A number: specify a static port.
  2. Two numbers separated by a + (e.g. 8000+20000) where the first number represents a base and the second number a range for the selection of a port based on a hash of the project name. In the example 8000+20000, the port will be selected in the range from 8000 to 28000.
  3. The value "automatic", which prompts vovserver to create a numeric hash of the project/instance name, add it to a base number of 6200, and use the result as the web port number. If the resulting port is not available, vovserver will search for an available port in increments of 1, up to the initial port + 10, until one is found. This value is accepted for first starts only, as vovserver will rewrite the variable to the appropriate configuration files in the format of N:automatic, where N is the port number that was chosen. This format provides clients with the port number on which to communicate and also the port selection mode that is to be used for subsequent starts. This port will be used to seed the selection process for the VOV_READONLY_PORT_NUMBER.
  4. The value "any" (default), which is identical to the automatic behavior described above, except that if the initially chosen port is unavailable, vovserver will search for an available port in increments of 1, up to 30000, until one is found.
Examples:
% setenv VOV_WEB_PORT_NUMBER 5555
% setenv VOV_WEB_PORT_NUMBER "6000+15000"
% setenv VOV_WEB_PORT_NUMBER "automatic"
% setenv VOV_WEB_PORT_NUMBER "6271:automatic"
% setenv VOV_WEB_PORT_NUMBER "any"
% setenv VOV_WEB_PORT_NUMBER "7200:any"
VOV_WX_STUCK_VOVWXD_AGE live_wx_check_vovwxd_daemon.tcl Age at which the vovwxd daemon should be considered as stuck and an alert should be generated.

Set in wx.swd/setup.tcl. Age can be in timespec or seconds format.

VOV_WX_STUCK_VOVWXD_RESTART live_wx_check_vovwxd_daemon.tcl If set to 1, the vovwxd daemon will be restarted if the stuck age has been exceeded.

Set in wx.swd/setup.tcl.

VOV_WX_STUCK_VOVWXD_ALERT_AGE live_wx_check_vovwxd_daemon.tcl If set to 1, the vovwxd daemon will be straced if the stuck age has been exceeded.
Set in wx.swd/setup.tcl.
Note: Both the timeout and strace commands must be on the system path for this functionality to be enabled.
WX_NOCLEAN_CMDFILE_LINES wxrun Performance optimization for Accelerator Plus job submissions.

Setting to 1 will disable line cleaning in wxrun when using a command file (-f). Doing so puts the burden of making sure the command file has clean line endings and appropriately escaped characters, when needed.

WX_PREJOB_PER_TASKER bsub Performance optimization for Accelerator Plus job submissions using the LSF bsub emulation utility.

Setting to 1 will change the behavior of specifying a pre-job in such a way that it is done on a per-tasker basis instead of a per-job basis. This is beneficial when the pre-job is used to validate that a host is appropriate for a job and no per-job functionality is being performed.