2. Environment variables
Prev | A. Command line options | Next

### 2. Environment variables

All scripts used to start XXE (that is, `xxe`, `xxe.bat` and `xxe.jstart`) automatically define system properties corresponding to the following environment variables.

Note that, due to limitations in Apple's Java™ launcher, you cannot use the following environment variables on the Mac[21].

Variable name | Value | Description
--- | --- | ---
XXE_ADDON_PATH | List of directory names separated by semi-colons ('`;`'). | All the directories referenced in this list are recursively scanned by XXE during its startup to dynamically discover add-ons. More info in chapter "The lookup phase during XXE startup" of Section 1, “Dynamic discovery of add-ons” in XMLmind XML Editor - Configuration and Deployment.
XXE_GUI | Filename (relative or absolute) or URL of an XXE GUI specification (`.xxe_gui`) file. | Specifies which GUI to use for newly started XXE. More info in XMLmind XML Editor - Customizing the User Interface.
XXE_USER_PREFERENCES | Filename of a property file | Specifies the location of a user preferences property file different from the default one: ``XXE_user_preferences_dir`/preferences.property`. This alternate user preferences property file is created (if needed to)/read from/written to by XXE exactly like the default one. Note that the hierarchy of directories containing this alternate user preferences property file is also created by XXE when it does not already exist.

[21] This is the case only with `XMLEditor.app`, the application bundle contained in the `.dmg` distribution. If you are a local guru or a consultant you may prefer to download and install the `xxe-*-mac.zip` distribution rather than the `xxe-*.dmg` distribution.

After unzipping this archive in a directory of your choice, XMLmind XML Editor may be started using the ``XXE_install_dir`/bin/xxe` shell script. Unlike `XMLEditor.app` which leverages Apple's Java™ launcher, the `xxe` shell script makes it easy working with environment variables such as `XXE_GUI`, `XXE_ADDON_PATH`, etc.

Prev | Up | Next
1. Command line | Home | 3. System properties