BTRV Edition User's Guide

<log>

The log option indicates whether to log events such as errors that occur in FairCom RTG. This feature might be helpful for diagnostics purposes.

Attributes

Value	Effect	Synonyms
file	Specifies the log file name. If omitted the log messages are redirected to the standard error stream (stderr).

Accepted Values

Value	Effect	Synonyms
yes	Turns on logging. This option has the same effect as turning on the <error>, <warning>, and <info> sub-options.	y, true, on, 1
no	Turns off logging. This is the default value.	n, false, off, 0

If the log option is enabled, it may accept the following sub-options to specify which event to log:

<debug> log option

• The debug option indicates to log debug information.

<error> log option

• The error option indicates to log errors.

<info> log option

• The info option indicates to log generic information.

<profile> log option

• The info option indicates to log performance profiling information.

<warning> log option

• The info option indicates to insert a warning into the log file.

If the log option is enabled and no sub-options are specified, it has the same effect as turning on the <error>, <warning>, and <info> sub-options.

Examples

The following example turns on implicit logging of errors and generic information to standard error stream:

<log>yes</log>

The following example turns on explicit logging of errors and generic information to file mylog.txt:

<log file="mylog.txt">

<error>yes</error>

<info>yes</info>

</log>

The following example turns on only error logging:

<log>

<error>yes</error>

</log>

Substitution Specifiers

Substitution specifiers can be used in the <log file> configuration attribute. The <log file> attribute can contain substitution specifiers to build the log file name using (for example) an environmental variable.

Example:

The following setting creates a different log file for each Windows user:

<log file="%(USERNAME).log">yes</log>

In This Section <debug> <error> <info> <profile> <warning>