User Tools

Site Tools


The VruiConfigurations Directory

The VruiConfigurations directory configures the choices available in the ConfigVislet Dialog. This directory is searched for in the following locations (in the following order):

  • The current directory
  • The user's home directory
  • /share
  • /usr/share
  • /usr/local

(Note: this search order can be changed by modifying the VRUI_CONFIG_SEARCH_LOCATIONS variable in the VruiConfigDriver script.)

Within the VruiConfigurations directory, the subdirectories Configs, Frags and Commands must exist, and an optional Saves directory and an optional Hosts directory may also exist.


This directory must contain full configurations from which the user may select. It is also the location where current configurations are saved if the Saves directory (see below) does not exist. Configuration files stored in this directory should define a top-level Vrui section that contains a single section named *. The * section is a placeholder for the hostname-specific section to be used when the configuration is activated by the VruiConfig system. These configurations may additionally define a tag named VruiCommandOptions that defines command-line arguments that will be added to commands run with this configuration. See Appendix 1.


This optional directory, if it exists, is where current configurations are stored. If this directory does not exist, then current configurations are stored in the Configs directory. This permits a strategy where a generally-accessible VruiConfigurations directory can be configured, and then each individual user has their own VruiConfigurations directory that contains with links to the global VruiConfigurations directory's Configs, Frags and Commands, but contains an actual Saves directory where their personal saved configurations are stored.

When this directory is distinct from the Configs directory, the ConfigVislet Dialog displays both directories' contents in the Next configuration: column. Frags This directory must contain configuration fragments. See Appendix 1 for details.


This directory must contain programs that will ultimately launch Vrui programs. These could be full-fledged Vrui programs, but most typically will be shell scripts like the following:

  #! /bin/bash
  cd ~/src/Vrui-1.0/ExamplePrograms
  ./ShowEarthModel $*

The commands in this directory must be current-directory-independent, i.e., they must be runnanble independent of where current directory happens to be.


This optional directory, if it exists, may contain subdirectories corresponding to hostnames as returned by the hostname command. If the machine on which you are running returns <hostname> from the hostname command and if the directory VruiConfigurations/Hosts/<hostname> exists and contains Configs, Frags, Commands and (optionally) Saves, then the VruiConfigurations/Hosts/<hostname> directory is used as the actual VruiConfigurations directory. This permits per-host configurations to be stored under a single VruiConfigurations directory.

keckcaves/vruiconfigurations.txt · Last modified: 2009/07/01 06:55 by sumner