--- fsl.pod 2003/01/06 16:41:21 1.27
+++ fsl.pod 2003/05/22 12:30:35 1.28
@@ -479,39 +479,74 @@
)
};
-=head1 ENVIRONMENT
+=head1 CONFIGURE
-The following environment variables affect the execution of B<OSSP fsl>:
+Operation.
=over 4
-=item C<FSL_CFGDIR>
+=item C<--with-fsl-cfgdir>
-This variable overrides the default value (hard-coded in B<OSSP fsl>
-under built-time via C<--with-fsl-cfgdir=>I<path>) under run-time. The
-value has to point to an existing directory where configuration files
-named "I<prefix>C<*>" (see below) exist. The default value is
+The value has to point to an existing directory where configuration
+files named "I<prefix>C<*>" (see below) exist. The default value is
"C<@FSL_CFGDIR@>".
-=item C<FSL_PREFIX>
+=item C<--with-fsl-prefix>
-This variable overrides the default value (hard-coded in B<OSSP fsl>
-under built-time via C<--with-fsl-prefix=>I<prefix>) under run-time.
The value has to be a valid partial Unix filename. The default value is
"C<@FSL_PREFIX@>".
-=item C<FSL_DEBUG>
+=back
+
+Deployment.
+
+=over 4
+
+=item C<--with-fsl-debuglogcode>
-This variable overrides the default value (hard-coded in B<OSSP fsl>
-under built-time via C<--with-fsl-debug=>I<l2-spec>) under run-time.
-The value has to be a valid B<OSSP l2> channel tree specification. An
-empty value (either hard-coded or overridden) disables B<OSSP fsl>
-debugging via B<OSSP l2> (but still logs errors to F<stderr>). A value
-of "C<null>" instead disables debugging at all by discarding all
-messages.
+The value must be empty or something where empty omits and anything else
+includes debugging code. When debugging is not used the whole debugging
+code is replaced with a simple no-operation stub function. The default
+value is "C<@FSL_DEBUGLOGCODE@>".
+
+=item C<--with-fsl-debuglogfile>
+
+The value has to point to a file where logging information is being
+dumped into. The directory has to exist, the file must be
+creatable/writable. The file is opened, written in append mode and
+closed for every debug log message. In case of problems the debug log
+messages will be silently discarded. The default value is
+"C<@FSL_DEBUGLOGFILE@>".
+
+=item C<--with-fsl-debuglogmask>
+
+The value has to point to a symlink. The content of this symlink is the
+name of a loglevel or a logmask. Possible values are panic, critical,
+error, warning, notice, info, trace, debug; A single word is interpreted
+as a log level and all messages with that or a more important level will
+be logged. If a comma is found in the symlink content a logmask is build
+by or'ing together the values behind all words. The same is true when
+the entire value is inside round brackets, which makes this part of the
+format compatible to l2spec and allows a single word to be a mask rather
+than a level. If for any reasons the symlink does not exist, is not
+readable, has a syntactically wrong value or any other problems the
+debug log messages will be silently discarded. The default value is
+"C<@FSL_DEBUGLOGMASK@>".
+
+=item C<--with-fsl-debuglogstop>
+
+The value is the maximum size of the logfile in bytes. If this size is
+reached or exceeded before the message is written logging stops and
+debug log messages will be silently discarded. The default value is
+"C<@FSL_DEBUGLOGSTOP@>".
=back
+For convenience reasons, what(1) or a "strings binarywithfsl | grep
+'@(#)'" will provide information about debugging code being omitted or
+included and, in the latter case, which logfile and logmask are being
+used.
+
=head1 FILES
=over 4
|
