next up previous contents index
Next: General Visual Up: Xic Variables Previous: Startup   Contents   Index


Paths and Directories

These variables set the search paths (see 2.6) and document directory used in Xic. These have counterpart environment variables (see 2.5). The search paths can also be set from the technology file.

If not set by any means, internal defaults are used for the search paths and document directory. Under Windows, the default is set to point to the actual installation location subdirectories when necessary. Under Unix/Linux, the XT_PREFIX environment variable should be set to the installation location prefix that effectively replaces ``/usr/local''.

Below, PREFIX is obtained from the Windows Registry database under Windows, which is defined when the program is installed. Under Unix/Linux, PREFIX is obtained from the XT_PREFIX environment variable. In both cases, the default value for PREFIX, if another definition is not found, is ``/usr/local''.

Path
Value: path string, can't be unset.
This variable contains the design data search path. It is always defined, and can not be unset. This path is used to find native cell, archive, and library files.

If not set by any means, a default path is used.
Default: ``( . )''

LibPath
Value: path string, can't be unset.
This variable contains the startup library search path. It is always defined, and can not be unset. The library path is used to find the technology file, device and model libraries, and other initialization files.

Unlike other search paths, the current directory is always searched first, whether or not this is indicated in the search path string. If not set by any means, a default library path is used.
Default: ``( . PREFIX/xictools/xic/startup )''

HelpPath
Value: path string, can't be unset.
This variable contains the help search path. It is always defined, and can not be unset. This path is used to find files that contain information for the help system.

If not set by any means, a default help path is used.
Default: ``( PREFIX/xictools/xic/help )''

ScriptPath
Value: path string, can't be unset.
This variable contains the script search path. It is always defined, and can not be unset. This path is used to find script and menu files that will appear in the User Menu.

If not set by any means, a default script path is used.
Default: ``( PREFIX/xictools/xic/scripts )''

The treatment of any path which is given with a native cell to open in the Open command can be altered with the next two variables.

NoReadExclusive
Value: boolean.
When a native cell name with a path is opened, the path is stripped from the cell name. If the path is not already in the search path, it is added. Ordinarily, the path is put in front of the search path for the duration of the read, so that subcells will be opened from the same directory. If this variable is set, the path is not necessarily moved to the front of the search path.

AddToBack
Value: boolean.
A path stripped from a given cell name in the Open command is added to the back of the search path, rather than the front.

The behavior is described below for the various permutations:

NoReadExclusive unset
AddToBack unset
(default behavior)

The directory is added to the front of the search path during the read. The ``.'' element of the path, if it exists, is moved to the front after the read.

NoReadExclusive unset
AddToBack set

The directory is added to the front of the search path during the read. The ``.'' element of the path, if it exists, is moved to the front, and the directory is moved to the end after the read.

NoReadExclusive set
AddToBack unset

If the directory exists in the path, nothing is changed, otherwise the directory is added to the front. After the read, the ``.'' entry, if it exists, is moved to the front.

NoReadExclusive set
AddToBack set

If the directory exists in the path, nothing is changed, otherwise the directory is added to the end.

DocsDir
Value: path to directory.
The given directory is searched for the release notes, for the Release Notes command in the Help Menu.

If not set by any means, a default document directory is used.
Default: ``PREFIX/xictools/xic/docs''

ProgramRoot
Value: string.
This variable is set by the program to the installation location assumed by the program at program start-up. For example, for Xic installed in the standard location, the variable will contain the string ``/usr/local/xictools/xic''. This variable is not used by Xic, but is available in scripts so that the user can query the value when needing to access files in the installation location. Note that the user can set or clear this variable arbitrarily.

TeePrompt
Value: path to file.
When set, the prompt line messages are copied to the given file. If a file name is not given, or when the variable is unset, redirection stops. The value string can be ``stderr'' or ``stdout'' to redirect output to the terminal window instead of a file.


next up previous contents index
Next: General Visual Up: Xic Variables Previous: Startup   Contents   Index
Stephen R. Whiteley 2017-11-08