[BACK]Return to env.conf.5 CVS log [TXT] [DIR] Up to [Coherent Logic Development] / freem / doc

Diff for /freem/doc/env.conf.5 between versions 1.1 and 1.2

version 1.1, 2025/04/17 15:55:21 version 1.2, 2025/04/17 17:57:35
Line 38 Line 38
 .\"   along with FreeM.  If not, see <https://www.gnu.org/licenses/>.  .\"   along with FreeM.  If not, see <https://www.gnu.org/licenses/>.
 .\"  .\"
 .\"   $Log$  .\"   $Log$
   .\"   Revision 1.2  2025/04/17 17:57:35  snw
   .\"   Major updates to man pages
   .\"
 .\"   Revision 1.1  2025/04/17 15:55:21  snw  .\"   Revision 1.1  2025/04/17 15:55:21  snw
 .\"   Add env.conf man page  .\"   Add env.conf man page
 .\"  .\"
 .\"  .\"
 .TH env.conf 5 "17 April 2025" FreeM "FreeM User Manual"  .TH env.conf 5 "17 April 2025" FreeM "FreeM User Manual"
 .SH NAME  .SH NAME
 env.conf - FreeM environments configuration  env.conf - FreeM environment catalog
 .SH DESCRIPTION  .SH DESCRIPTION
 .PP  .PP
 $PREFIX/etc/env.conf  $PREFIX/etc/env.conf
Line 130  The file is organized into a series of s Line 133  The file is organized into a series of s
 .SH CONFIGURABLE OPTIONS  .SH CONFIGURABLE OPTIONS
 .TP  .TP
 user  user
   .RS 4
 The user account under which the environment will run - the default is  The user account under which the environment will run - the default is
 \fIfreem\fR  \fIfreem\fR
   .RE
 .TP  .TP
 group  group
   .RS 4
 The group under which the environment will run - note that any users wishing to interact with the environment will need to belong to this group, and the default is  The group under which the environment will run - note that any users wishing to interact with the environment will need to belong to this group, and the default is
   .RE
 \fIfreem\fR  \fIfreem\fR
 .TP  .TP
 enabled  enabled
   .RS 4
 A  A
 \fItrue\fR  \fItrue\fR
 or  or
 \fIfalse\fR  \fIfalse\fR
 value indicating whether or not the environment is administratively enabled - default is  value indicating whether or not the environment is administratively enabled - default is
 \fItrue\fR  \fItrue\fR
   .RE
 .TP  .TP
 env_path  env_path
   .RS 4
 An absolute filesystem path to the root of the filesystem - default is  An absolute filesystem path to the root of the filesystem - default is
 \fI$PREFIX/var/freem/<environment-name>\fR  \fI$PREFIX/var/freem/<environment-name>\fR
   .RE
 .TP  .TP
 log_threshold_file  log_threshold_file
   .RS 4
 The minimum threshold at which log messages will be sent to  The minimum threshold at which log messages will be sent to
 \fI/var/log/freem/<environment-name>.log\fR  \fI/var/log/freem/<environment-name>.log\fR
   (may be overridden for a specific process by setting the
   \fI$FREEM_LOG_THRESHOLD_FILE\fR
   environment variable prior to launching the process)
   
 (see the  (see the
 \fILOG THRESHOLDS\fR  \fBLOG THRESHOLD VALUES\fR
 section for descriptions of these values)  section for details)
   .RE
 .TP  .TP
 log_threshold_syslog  log_threshold_syslog
   .RS 4
 The minimum threshold at which log messages will be sent to the system's  The minimum threshold at which log messages will be sent to the system's
 \fIsyslog\fR  \fIsyslog\fR
 facility, if supported on your platform  facility, if supported on your platform
   (may be overridden for a specific process by setting the
   \fI$FREEM_LOG_THRESHOLD_SYSLOG\fR
   environment variable prior to launching the process)
   
 (see the  (see the
 \fILOG THRESHOLDS\fR  \fBLOG THRESHOLD VALUES\fR
 section for descriptions of these values)  section for details)
   .RE
 .TP  .TP
 log_threshold_stderr  log_threshold_stderr
   .RS 4
 The minimum threshold at which log messages will be echoed to  The minimum threshold at which log messages will be echoed to
 \fIstderr\fR  \fIstderr\fR
   (may be overridden for a specific process by setting the
   \fI$FREEM_LOG_THRESHOLD_STDERR\fR
   environment variable prior to launching the process)
   
 (see the  (see the
 \fILOG THRESHOLDS\fR  \fBLOG THRESHOLD VALUES\fR
 section for descriptions of these values)  section for details)
   .RE
   .SH LOG THRESHOLD VALUES
   This section details the valid values for each of the
   \fIlog_threshold_*\fR
   values, and each value indicates a minimum diagnostic level at which the indicated class of message will be delivered through the selected mechanism. All messages with an equal or higher diagnostic level than the class indicated will be delivered, i.e., if
   \fIwarning\fR
   is selected, messages with a diagnostic class of
   \fIwarning, error, and fatal\fR
   will be delivered through the selected mechanism.
   
   Valid values for each of these configuration keys are as follows:
   .TP
   debug
   .RS 4
   Messages useful mostly for developers contributing to FreeM itself. Will produce a high volume of log messages, and is likely to impact system performance. Not recommended for production usage.
   .RE
   .TP
   info
   .RS 4
   Includes messages of an informational nature. Will produce a moderately high volume of log messages. For heavily multi-user and multi-process systems, it is recommended to use
   \fIwarning\fR
   instead.
   .RE
   .TP
   warning
   .RS 4
   Includes warning messages. These indicate conditions (including retries when attempting to acquire semaphores) that warrant further investigation by the system operator, but do not typically prevent applications from running.
   .RE
   .TP
   error
   .RS 4
   Includes error messages. This class of messages indicates that a recoverable error has occurred in the FreeM engine. Warrants immediate attention by the system operator.
   .RE
   .TP
   fatal
   .RS 4
   Includes messages indicating errors that are not recoverable. If this class of message occurs, the process that triggered the message has terminated abnormally. Requires immediate system operator intervention, and can indicate gross misconfiguration of the FreeM engine or the host operating system environment, or even a FreeM bug.
   .RE
   .SH "FILES"
   .PP
   $PREFIX/etc/freem/env.conf
   .RS 4
   FreeM environment catalog
   .RE
   .SH "SEE ALSO"
   .PP
   \fBfreem\fR(1),
   \fBfmadm\fR(8),
   \fBfreem.conf\fR(5)
Removed from v.1.1  
changed lines
  Added in v.1.2

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>