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

XicTools Environment Variables

The following environment variables are used by all XicTools programs.

This variable applies only when running under Microsoft Windows, and Cygwin is installed. Cygwin is Linux-like environment and tool set which is a very useful adjunct to Windows. In particular, it provides a bash shell with standard Linux commands, and an X server, among many installable features.

XicTools programs will in some cases, such as when popping up a shell window, look for a Cygwin program. If the Cygwin program binaries (.exe files) are located in /bin or /cygwin/bin on the current disk drive, they will be found automatically. Otherwise, this variable can be set to the Windows path, including a drive letter if necessary, to the directory containing the Cygwin binaries. This is not necessarily the path one perceives from within Cygwin, since the XicTools programs do not know about the Cygwin mount points or symbolic links. The path is the one that would be seen from a DOS box, with forward or reverse slash directory separators.

By default, Unix/Linux versions of Xic and WRspice use authorization provided by an external license server, possibly hosted on a different machine. On the other hand, the Windows versions use built-in local authentication. Both the external license server and the programs not using the license server make use of a file named ``LICENSE'' provided by Whiteley Research, Inc., which provides authorization to run on the host computer.

Whether to use a license server or local authentication can be set with the environment variable XT_AUTH_MODE. This variable has meaning if set to one of the keywords ``Server'' or ``Local''. If set to ``Server'' on a Windows machine, Xic and WRspice can by authenticated from a license server. If set to ``Local'' on a Linux/OS X system, Xic and WRspice will be self-validating.

Xic and/or WRspice users on a single licensed workstation may prefer to set the environment variable in their shell startup file and not use the external license server.

When the programs look for the LICENSE file in ``Local'' mode, if the file is not found in the startup or license directories, the programs will look in the home and current directories, in that order, unless XT_LICENSE_PATH is also set.

When using local validation (i.e., not using the license server) XT_LICENSE_PATH can be set to the full path to the license file. Only this file will be used - the regular search is suppressed.

This provides the host name of the host running the license server needed to validate the application. It is in a format understandable to the local name server. The host name can optionally be suffixed by ``:port'', where port is the port number in use by the server. There should be no space around the colon when using this form.

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. The Xic -R command line option can also be used for this purpose. This should not be needed under Windows, as the Registry provides the default paths.

If the variable XTNETDEBUG is defined, Xic and WRspice will echo interprocess messages sent and received to the console. In server mode, Xic will not go into the background, but will remain in the foreground, printing status messages while servicing requests.

Linux and FreeBSD releases can use an included local memory allocation package. In earlier Xic releases, this allocator, rather than the allocator provided by the operating system, was used by default. In 32-bit releases, the local allocator was often able to allocate more memory than the allocators provided by the operating system. It also provided custom error reporting and statistics.

This feature is now disabled, as in modern operating systems there is dubious benefit, and it can produce stability problems in some cases. However, if this variable is set in the environment when Xic is started, the local allocator will be used. The interested user is encouraged to experiment.

This variable was once used to disable the internal local memory allocator, which in earlier releases was enabled by default. Currently, this variable is ignored.

next up previous contents index
Next: Xic Environment Variables Up: Xic Environment Variables Previous: Microsoft Windows   Contents   Index
Stephen R. Whiteley 2017-03-22