next up previous contents index
Next: Initialization Files Up: Environment Variables Previous: Microsoft Windows   Contents   Index

WRspice Environment Variables

All of the XicTools programs respond to the XT_PREFIX environment variable. When the tools are installed in a non-standard location, i.e., other than /usr/local, this can be set to the directory prefix which effectively replaces ``/usr/local'', and the programs will be able to access the installation library files without further directives.

There are several environment variables which can be used to alter some of the WRspice defaults. On startup, WRspice checks for the following variables in the environment, and alters internal defaults accordingly. The defaults can be modified when the program is built, the defaults listed below are those assigned in the distribution.

HOME
This is used only in the Microsoft Windows version, and can be set to a full directory path which will be taken as the user's home directory.

DISPLAY
This variable defines the X window system display that WRspice will use, but is ignored if the -d option is used on the WRspice command line. The display must be specified for graphics to be enabled in WRspice.

EDITOR
If defined to the invoking string for a text editor, that editor will be used in the edit command. This is superseded by the SPICE_EDITOR variable, if set.

SPICE_EDITOR
The text editor called by the edit command can be set with this variable. The variable is defined to the command string one would type to invoke the editor. This will supersede the EDITOR variable, if set, but which would otherwise have the same effect. If no editor is specified in the environment, or with the editor shell variable, which supersedes the environment variables, a default internal editor is used. The default internal editor can also be specified by setting SPICE_EDITOR to nothing, ``default'', or ``xeditor''.

TMPDIR
This specifies a directory to use for temporary files, and is superseded by SPICE_TMP_DIR, if defined. The default location if not specified is /tmp.

SPICE_TMP_DIR
When WRspice creates a temporary file, it will look for a directory named by the SPICE_TMP_DIR environment variable, and if not found the directory named in the TMPDIR variable, and if still not found the file will be created in /tmp.

SPICE_EXEC_DIR
This variable can be used to define the directory containing the XicTools binaries, used by the aspice command and the wrspiced daemon. If not set, the default is ``/usr/local/bin'', or, if XT_PREFIX is set, its value replaces ``/usr/local''.

SPICE_PATH
This can be used to set the full path to the WRspice executable, for the aspice command and the wrspiced daemon. If not set, the default is ``/usr/local/bin/wrspice'', or, if XT_PREFIX is set, its value replaces ``/usr/local''. The SPICE_EXEC_DIR variable can also be used for this purpose, unless the wrspice executable has been renamed. The spicepath shell variable, if set, will override the path set in the environment.

SPICE_LIB_DIR
This variable can be used to change the default location where WRspice looks for system startup files. If not set, the internal default is ``/usr/local/lib/xictools/wrspice/startup'', or, if XT_PREFIX is set, its value replaces ``/usr/local''.

SPICE_INP_PATH
This can be set to a list of directories to search for input files and scripts. If not set, the internal default is ``( . /usr/local/lib/xictools/wrspice/scripts )'', or, if XT_PREFIX is set, its value replaces ``/usr/local''.

SPICE_HLP_PATH
This can be set to a list of directories to search for help database files. If not set, the internal default is ``( /usr/local/lib/xictools/wrspice/help )'', or, if XT_PREFIX is set, its value replaces ``/usr/local''. This is superseded by the helppath shell variable, if set.

SPICE_NEWS_FILE
This variable can be set to the full path to a text file which is printed when WRspice starts. If not set, the file /usr/local/lib/xictools/wrspice/startup/news will be printed, if it exists (if XT_PREFIX is set, its value replaces ``/usr/local'').

SPICE_BUGADDR
This variable can be set to an Internet mail address to use in the bug reporting command. If not set, the built in default is the Whiteley Research technical support address.

SPICE_OPTCHAR
This variable can be defined to a character that will be used to flag options on the WRspice command line. If not defined, the option character is ``-''.

SPICE_ASCIIRAWFILE
If this variable is defined to ``0'' (zero), WRspice will create binary plot-data files (rawfiles). If not set or set to something else, WRspice will create the default ascii-format rawfiles. The filetype shell variable can also be used to set the mode, which will supersede the environment variable. The rawfiles are normally created with the write command.

SPICE_HOST
This variable can be used to set the host name to use for remote SPICE runs. The host name can optionally be suffixed by a colon followed by the port number to use for communication with the wrspiced daemon. If not given, the port is obtained from the operating system for ``spice/tcp'', or 3004 if this is not defined. There is no default for this variable. Hosts can also be specified with the rhost command, and given with the rhost shell variable.

SPICE_DAEMONLOG
This variable is used by the wrspiced daemon program to set an alternate path for the log file. The default path is /tmp/wrspiced.log.


next up previous contents index
Next: Initialization Files Up: Environment Variables Previous: Microsoft Windows   Contents   Index
Stephen R. Whiteley 2006-10-23