GNU Info

(heroes.info)Environment

---

Next: heroesrc Prev: Invoking heroes Up: Running

---

Enter node , (file) or (file)node

Environment variables
=====================

`HEROES_DEBUG'
--------------

   The very first action of Heroes when it starts is to look the
environment for a `HEROES_DATA_DIR' variable.  If Heroes has been
compiled with the `--enable-heroes-debug' configure option (which is
the default), this variable specify the kind of debug messages that
should be printed out.  Possible values are the following (they can be
printed using the `--list=debug' option).

`SECTION'
     The different parts of the game (introduction, demonstration,
     menus, ...).

`SYSTEM'
     Handling of environment variables, creation of directories,
     initialization of libraries.

`RESOURCE'
     Filename Resources Handling.

`FILE'
     Files And Directories Handling.

`LEVEL'
     Levels Handling.

`SOUND_TRACK'
     Sound Track Events.

`SOUND_EFFECT'
     Sound Effects Events.

`VIDEO'
     Events related to the display interface.

`JOYSTICK'
     Joystick Initialization And Events.

`TIMER'
     Timer Handling.

`MISC'
     Miscellaneous Events.

`FADER'
     Palette Fade Events.

`BONUS'
     Bonus handling.

`ALL'
     All of the above.

   Multiple values can be separated by `:', and a value is negated if
prefixed by `-'.  For example the following command line sets
`HEROES_DEBUG' so that all messages get printed except those related to
timer handling.

     export HEROES_DEBUG=all:-timer

`HEROES_PREFIX'
---------------

   The `HEROES_PREFIX' indicate the base directory where Heroes was
installed.  It is equivalant to the `--prefix' option of `configure'.
This variable is not found the default prefix (configured at build
time) will be used, usually this is something like `/usr/local' or
`/usr'.  Type `heroes --list=resources | grep prefix' to see the value
actually used by Heroes.

   Most people don't need to set this variable.  This is only useful if
you got Heroes as a binary distribution and want to move files around.

`HEROES_DATA_DIR'
-----------------

   The `HEROES_DATA_DIR' variable may specify the path were the data
files are located.  It thus allows you to relocate the data file.  If
this variable is not found the default path (configured at build time)
will be used.  Run `heroes --list=resources | grep data-dir' to see the
value actually used by Heroes.

   The path to datafiles is adjusted automatically if you set
`HEROES_PREFIX' (because it is a subdirectory of `HEROES_PREFIX'), so
most people don't need to set `HEROES_DATA_DIR'.

`HEROES_LOCALE_DIR'
-------------------

   The `HEROES_LOCALE_DIR' variable override the path were the message
catalogs are looked for.  The default value is hardcoded into the
Heroes binary, and you can see it if you run `heroes --list=resources |
grep locale-dir'.

   As for `HEROES_DATA_DIR', changing `HEROES_PREFIX' is usually enough
because `HEROES_LOCALE_DIR' is a subdirectory of `HEROES_PREFIX'.

`HOME'
------

   The `HOME' variable is used to locate your home directory.  You can
also use `HEROES_HOME'.