Difference between revisions of "Appendix"

From HemeraBook
Jump to: navigation, search
Line 8: Line 8:
 
<br />
 
<br />
 
You can see [[Install_Hemera#Configure |Configuring Hemera]].
 
You can see [[Install_Hemera#Configure |Configuring Hemera]].
 +
<br />
 +
==Binary and Library paths configuration==
 +
If you are not familiar with '''PATH''' and '''LD_LIBRARY_PATH''' environment variables, see [http://en.wikipedia.org/wiki/Environment_variable#Examples_of_Unix_environment_variables *nix environment variables].<br /><br />
 +
For better ease of use, Hemera configuration file provides two [[Appendix#Configuration_file |configuration elements]] to define some directory paths to add automatically to '''PATH''' or '''LD_LIBRARY_PATH''' environment variables
 +
'''hemera.path.bin'''
 +
'''hemera.path.lib'''
 +
<br />
 +
The syntax is a colon-separated list of directories.<br />
 +
You can use the '*' wildcard if path can vary according to situation (like it is the case with [[Install_third-party_tools#From_source|SphinxTrain]] ''bin-XX'' sub-directory). Hemera scripts will dynamically complete paths when starting.<br />
 +
<br />
 +
In [[Appendix#Configuration_file |configuration file]], there is various configuration elements named '''hemera.*.path''' allowing to define third-party tools to use.<br />
 +
For each, you can choose one of these ways to define it:
 +
* specify the full path of the tool
 +
* specify a path relative to [[Appendix#HEMERA_TP_PATH |HEMERA_TP_PATH]]
 +
* specify simply the name of the tool if:
 +
** it is available in the PATH environment variable (outside of Hemera)
 +
** you have added its parent directory in '''hemera.path.bin'''
 +
<br />
 +
'''IMPORTANT''': ensure to add library directory to '''hemera.path.lib''' for each third-party tools for which you have compiled source code (but if you have then installed them on your system). It is the case, for instance, if you have compiled [[Install_third-party_tools#From_source|sphinx3 source code]].
 +
 
<br />
 
<br />
 
=Variables=
 
=Variables=

Revision as of 10:09, 19 May 2011

Notion

Configuration file

To help configuring the whole of Hemera, a global configuration file system has been created.

  • since v0.2, it correspond to $HOME/.hemera/hemera.conf file
  • in v0.1, it correspond to HEMERA_ROOT_PATH/Hemera/config/hemera.conf

These pages use the notion of configuration elements which refers to elements which can be defined in the configuration file.

You can see Configuring Hemera.

Binary and Library paths configuration

If you are not familiar with PATH and LD_LIBRARY_PATH environment variables, see *nix environment variables.

For better ease of use, Hemera configuration file provides two configuration elements to define some directory paths to add automatically to PATH or LD_LIBRARY_PATH environment variables

hemera.path.bin
hemera.path.lib


The syntax is a colon-separated list of directories.
You can use the '*' wildcard if path can vary according to situation (like it is the case with SphinxTrain bin-XX sub-directory). Hemera scripts will dynamically complete paths when starting.

In configuration file, there is various configuration elements named hemera.*.path allowing to define third-party tools to use.
For each, you can choose one of these ways to define it:

  • specify the full path of the tool
  • specify a path relative to HEMERA_TP_PATH
  • specify simply the name of the tool if:
    • it is available in the PATH environment variable (outside of Hemera)
    • you have added its parent directory in hemera.path.bin


IMPORTANT: ensure to add library directory to hemera.path.lib for each third-party tools for which you have compiled source code (but if you have then installed them on your system). It is the case, for instance, if you have compiled sphinx3 source code.


Variables

HEMERA_ROOT_PATH

The root directory where Hemera projects are installed.

N.B.: in v0.1, it has referenced temporarily the Hemera main project root directory.

HEMERA_TP_PATH

The root directory of third-party project in which tools can be installed (or symbolic links can be created).