Back to Contents

The FGLPROFILE configuration file

Summary:

• Basics
• FGLPROFILE Entry Syntax
• Supported Entries

See also: Programs

Basics

The runtime system uses one or more configuration files in which you can define entries to change the behavior of the programs.

There is no specific naming convention for the configuration files, however, we recommend to use an extension such as prf.

There are three different levels to specify a configuration file, and these files are loaded in the following order:

1. First, the runtime system reads the configuration file provided in FGLDIR/etc/fglprofile. This file contains all supported entries, identifies the possible values for an entry, and documents default values. You should not modify this default configuration file, see warning below.
2. Then, if the FGLPROFILE environment variable is set, the runtime system reads entries from the files specified by this environment variable. A list of files can be provided with FGLPROFILE. Files must be separated by the operating system specific path separator.
3. After loading and merging the two previous levels, the runtime system checks if the fglrun.defaults entry is set. This entry defines the program-specific profile directory. If this directory contains a file with the same name as the current program (without .42r extension), the runtime system reads the entries from that file.

Note that it is not recommended to change the default configuration file in FGLDIR/etc/fglprofile. This file will be overwritten by a new installation and your changes will be lost. You better make a copy and define your private configuration file with the FGLPROFILE environment variable.

The runtime system merges the different configuration files found at the three levels. If the same entry is defined in several files, the last loaded entry wins. This means that the order of precedence is:

1. Program specific configuration file (if fglrun.defaults is defined in one of the other levels).
2. Configuration files defined by the FGLPROFILE environment variable.
3. The default configuration file FGLDIR/etc/fglprofile.

FGLPROFILE Entry Syntax

Purpose:

An FGLPROFILE entry is a line in the configuration file associating a parameter name to a value that can be specified as a numeric, string or boolean.

Syntax:

where entry is:

ident [.ident [.ident] [...] ] ]

and value is:

  [-]{ digit [...] }[ . digit [...] ]
| " alphanum [...] "
| {true|false}

Notes:

1. entry identifies the name of the entry. This can be a dot-separated list of identifiers.
2. value is the value of the entry; it might be a numeric value, a string literal, or a Boolean value (true/false).

Usage:

The entries are defined by a name composed of a list of identifiers separated by a dot character. Entry names are converted to lower case when loaded by the runtime system. In order to avoid any confusion, it is recommended to write FGLPROFILE entry names in lower case. If an entry is defined several times in the same file, the last entry found in the file is used. No error is raised.

The value can be a numeric literal, a string literal, or a Boolean (true/false).

Numeric values are composed by an optional sign, followed by digits, followed by an optional decimal point and digits:

my.numeric.entry = -1566.57

String values must be delimited by single or double quotes. The escape character is backslash, \t \n \r \f are interpreted as TAB, NL, CR, FF.

my.string.entry = "C:\\data\\test1.dbf"

Boolean values must be either the true or false keyword:

my.boolean.entry = true

For the complete list of supported entries, see Supported Entries.

Example:

01 report.aggregatezero = true
02 gui.connection.timeout = 100
03 dbi.database.stores.source = "C:\\data\\test1.dbf"
04 dbi.database.stores.prefetch.rows = 200

Supported Entries

The following table shows the a partial list of supported FGLPROFILE entries. You can find the complete usage for an entry in the corresponding documentation section referenced in the description of the entry.