diff --git a/src/site/markdown/1-usage.md b/src/site/markdown/1-usage.md index 8d3d5a289..3d94cd89a 100644 --- a/src/site/markdown/1-usage.md +++ b/src/site/markdown/1-usage.md @@ -32,3 +32,5 @@ See the following pages for usage information: * @subpage performance * @subpage map-filter * @subpage multiprocess-logging +* @subpage environment-variables +* @subpage macros-influencing-log4cxx diff --git a/src/site/markdown/environment-variables.md b/src/site/markdown/environment-variables.md new file mode 100644 index 000000000..aeed4697f --- /dev/null +++ b/src/site/markdown/environment-variables.md @@ -0,0 +1,38 @@ +Environment Variables {#environment-variables} +=== + + + +# Environment Variables Used by Log4cxx + +There are several environment variables that can be set in order to influence how +Log4cxx works. They are summarized in the following table: + + +| Environment Variable | Usage | +| -------------------- | ----- | +| LOG4CXX\_DEBUG | Set to the value 'true' to enable internal debugging of Log4cxx. All output goes to stderr. This can be useful to determine why a configuration file is not loading | +| log4j.configuratorClass | Used to determine what class to use to configure the logging system | +| LOG4CXX\_CONFIGURATOR\_CLASS | Used to determine what class to use to configure the logging system. Takes precedence over log4j.configuratorClass | +| log4j.configuration | Set the file to load to configure the logging system | +| LOG4CXX\_CONFIGURATION | Set the file to load to configure the logging system. Takes precedence over log4j.configuration | +| LOG4CXX\_CONFIGURATION\_WATCH\_SECONDS | Set how often the configuration file should be checked for changes | + diff --git a/src/site/markdown/macros-influencing-log4cxx.md b/src/site/markdown/macros-influencing-log4cxx.md new file mode 100644 index 000000000..fc2edc481 --- /dev/null +++ b/src/site/markdown/macros-influencing-log4cxx.md @@ -0,0 +1,35 @@ +Macros Influencing Log4cxx {#macros-influencing-log4cxx} +=== + + + +# Macros that influence Log4cxx + +The following macros can be defined in client code to influence how log messages +are set or not. + +These macros may be set on a per-file basis(in which case they must be before any +Log4cxx includes), or they may be set globally via your build system. + +| Macro | Usage | +| ----- | ----- | +| LOG4CXX\_THRESHOLD | Used to determine if log messages are compiled in or not. A higher value causes more messages to be compiled out. See [removing log statements](usage.html#removing-log-statements) for more information. | +| LOG4CXX\_DISABLE\_LOCATION\_INFO | Define this macro to disable location information on log statements. Location information includes the filename, class name, method name, and line number |