Firebird Documentation IndexFirebird 3.0.2 Release NotesConfiguration Additions and Changes → Macro Substitution
Firebird Home Firebird Home Prev: Configuration Additions and ChangesFirebird Documentation IndexUp: Configuration Additions and ChangesNext: Includes

Macro Substitution

A number of predefined macros (syntax $(name)) is available for use in the configuration files to substitute for a directory name:

$(root)

Root directory of Firebird instance

$(install)

Directory where Firebird is installed. $(root) and $(install) are initially the same. $(root) can be overridden by setting or altering the environment variable FIREBIRD, in which case it becomes different from $(install).

$(this)

Directory where current configuration file is located

$(dir_conf)

Directory where firebird.conf and databases.conf are located

$(dir_secdb)

Directory where the default security database is located

$(dir_plugins)

Directory where plugins are located

$(dir_udf)

Directory where UDFs are located by default

$(dir_sample)

Directory where samples are located

$(dir_sampledb)

Directory where sample DB (employee.fdb) is located

$(dir_intl)

Directory where international modules are located

$(dir_msg)

Directory where the messages file (firebird.msg) is located. $(dir_msg) usually should be the same as $(root) but can be overridden by the environment variable FIREBIRD_MSG.

Tip

You can observe the usage of some of the macros in databases.conf.

Notes

In our pre-built binaries, $(dir_conf) and $(dir_secdb) would normally be the same as $(root) and $(install).

$(dir_plugins), $(dir_udf), $(dir_sample), $(dir_sampledb) and $(dir_intl) are predefined sub-directories inside $(root).

The build conventions are not “rules” that could be expected to apply in every distribution of Firebird. Distro-specific Linux packages, for example, each prefer to fit the Firebird components into standard layouts that comply with their own conventions. As an illustration, user binaries, such as isql might be located in /usr/bin, server binaries in /usr/sbin, configuration files in /etc/firebird.d and so on. Obviously, $(root) would then make no sense, even if the $(dir_something) macros still pointed to actual directories.

Prev: Configuration Additions and ChangesFirebird Documentation IndexUp: Configuration Additions and ChangesNext: Includes
Firebird Documentation IndexFirebird 3.0.2 Release NotesConfiguration Additions and Changes → Macro Substitution