Return to env.conf.5 CVS log

Up to [Coherent Logic Development] / freem / doc

Updates to init_execution_context

    1: .\" To display this man page, either:
    2: .\"   1) Install this file along with the other subject.1 files in your
    3: .\"      system's man1 directory (usually this is /usr/man/man1) and
    4: .\"      enter the command:
    5: .\"        man freem
    6: .\"   or
    7: .\"   2) Specify the input (this file) and the output (your favorite pager)
    8: .\"      explicitly.  For example, if this file is in your current working
    9: .\"      directory, you can use the following to view the formatted man page
   10: .\"      using the "less" pager:
   11: .\"        man ./freem.1 | less
   12: .\"
   13: .\" To print this man page to a PostScript printer:
   14: .\"   man -t ./freem.1 | lpr
   15: .\"
   16: .\"   $Id: env.conf.5,v 1.3 2025/04/20 03:13:17 snw Exp $
   17: .\"    FreeM env.conf man page
   18: .\"
   19: .\"  
   20: .\"   Author: Serena Willis <snw@coherent-logic.com>
   21: .\"    Copyright (C) 1998 MUG Deutschland
   22: .\"    Copyright (C) 2020, 2025 Coherent Logic Development LLC
   23: .\"
   24: .\"
   25: .\"   This file is part of FreeM.
   26: .\"
   27: .\"   FreeM is free software: you can redistribute it and/or modify
   28: .\"   it under the terms of the GNU Affero Public License as published by
   29: .\"   the Free Software Foundation, either version 3 of the License, or
   30: .\"   (at your option) any later version.
   31: .\"
   32: .\"   FreeM is distributed in the hope that it will be useful,
   33: .\"   but WITHOUT ANY WARRANTY; without even the implied warranty of
   34: .\"   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   35: .\"   GNU Affero Public License for more details.
   36: .\"
   37: .\"   You should have received a copy of the GNU Affero Public License
   38: .\"   along with FreeM.  If not, see <https://www.gnu.org/licenses/>.
   39: .\"
   40: .\"   $Log: env.conf.5,v $
   41: .\"   Revision 1.3  2025/04/20 03:13:17  snw
   42: .\"   Updates to init_execution_context
   43: .\"
   44: .\"   Revision 1.2  2025/04/17 17:57:35  snw
   45: .\"   Major updates to man pages
   46: .\"
   47: .\"   Revision 1.1  2025/04/17 15:55:21  snw
   48: .\"   Add env.conf man page
   49: .\"
   50: .\"
   51: .TH env.conf 5 "17 April 2025" FreeM "FreeM User Manual"
   52: .SH NAME
   53: env.conf - FreeM environment catalog
   54: .SH DESCRIPTION
   55: .PP
   56: $PREFIX/etc/env.conf
   57: contains configuration information for FreeM environments.
   58: 
   59: A FreeM environment is a collection of FreeM resources comprising the following elements:
   60: .sp
   61: .RS 4
   62: .ie n \{\
   63: \h'-04'\(bu\h'+03'\c
   64: .\}
   65: .el \{\
   66: .sp -1
   67: .IP \(bu 2.3
   68: .\}
   69: One and only one environment daemon responsible for managing shared environment resources, including the lock table, job table, memory-backed globals, and inter-process communication
   70: .RE
   71: .sp
   72: .RS 4
   73: .ie n \{\
   74: \h'-04'\(bu\h'+03'\c
   75: .\}
   76: .el \{\
   77: .sp -1
   78: .IP \(bu 2.3
   79: .\}
   80: At least two namespaces: minimally,
   81: \fISYSTEM\fR
   82: and
   83: \fIUSER\fR
   84: .RE
   85: .sp
   86: .RS 4
   87: .ie n \{\
   88: \h'-04'\(bu\h'+03'\c
   89: .\}
   90: .el \{\
   91: .sp -1
   92: .IP \(bu 2.3
   93: .\}
   94: A set of pre-installed vendor routines located in the environment's
   95: \fISYSTEM\fR
   96: namespace.
   97: .RE
   98: .sp
   99: .RS 4
  100: .ie n \{\
  101: \h'-04'\(bu\h'+03'\c
  102: .\}
  103: .el \{\
  104: .sp -1
  105: .IP \(bu 2.3
  106: .\}
  107: Zero or more instances of the FreeM interpreter running M application code
  108: .RE
  109: .sp
  110: .RS 4
  111: .ie n \{\
  112: \h'-04'\(bu\h'+03'\c
  113: .\}
  114: .el \{\
  115: .sp -1
  116: .IP \(bu 2.3
  117: .\}
  118: Zero or more fmadm processes for managing the environment
  119: .RE
  120: .sp
  121: .RS 4
  122: .ie n \{\
  123: \h'-04'\(bu\h'+03'\c
  124: .\}
  125: .el \{\
  126: .sp -1
  127: .IP \(bu 2.3
  128: .\}
  129: Optionally, an after-image journal, providing recoverability under certain abnormal conditions
  130: .RE
  131: .PP
  132: The file is organized into a series of sections, such as
  133: \fI[DEFAULT]\fR
  134: , indicating the environment name to which the configuration values beneath it will apply
  135: .RE
  136: .SH CONFIGURABLE OPTIONS
  137: .TP
  138: user
  139: .RS 4
  140: The user account under which the environment will run - the default is
  141: \fIfreem\fR
  142: .RE
  143: .TP
  144: group
  145: .RS 4
  146: 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
  147: .RE
  148: \fIfreem\fR
  149: .TP
  150: enabled
  151: .RS 4
  152: A
  153: \fItrue\fR
  154: or
  155: \fIfalse\fR
  156: value indicating whether or not the environment is administratively enabled - default is
  157: \fItrue\fR
  158: .RE
  159: .TP
  160: env_path
  161: .RS 4
  162: An absolute filesystem path to the root of the filesystem - default is
  163: \fI$PREFIX/var/freem/<environment-name>\fR
  164: .RE
  165: .TP
  166: log_threshold_file
  167: .RS 4
  168: The minimum threshold at which log messages will be sent to
  169: \fI/var/log/freem/<environment-name>.log\fR
  170: (may be overridden for a specific process by setting the
  171: \fI$FREEM_LOG_THRESHOLD_FILE\fR
  172: environment variable prior to launching the process)
  173: 
  174: (see the
  175: \fBLOG THRESHOLD VALUES\fR
  176: section for details)
  177: .RE
  178: .TP
  179: log_threshold_syslog
  180: .RS 4
  181: The minimum threshold at which log messages will be sent to the system's
  182: \fIsyslog\fR
  183: facility, if supported on your platform
  184: (may be overridden for a specific process by setting the
  185: \fI$FREEM_LOG_THRESHOLD_SYSLOG\fR
  186: environment variable prior to launching the process)
  187: 
  188: (see the
  189: \fBLOG THRESHOLD VALUES\fR
  190: section for details)
  191: .RE
  192: .TP
  193: log_threshold_stderr
  194: .RS 4
  195: The minimum threshold at which log messages will be echoed to
  196: \fIstderr\fR
  197: (may be overridden for a specific process by setting the
  198: \fI$FREEM_LOG_THRESHOLD_STDERR\fR
  199: environment variable prior to launching the process)
  200: 
  201: (see the
  202: \fBLOG THRESHOLD VALUES\fR
  203: section for details)
  204: .RE
  205: .SH LOG THRESHOLD VALUES
  206: This section details the valid values for each of the
  207: \fIlog_threshold_*\fR
  208: 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
  209: \fIwarning\fR
  210: is selected, messages with a diagnostic class of
  211: \fIwarning, error, and fatal\fR
  212: will be delivered through the selected mechanism.
  213: 
  214: Valid values for each of these configuration keys are as follows:
  215: .TP
  216: debug
  217: .RS 4
  218: 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.
  219: .RE
  220: .TP
  221: info
  222: .RS 4
  223: 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
  224: \fIwarning\fR
  225: instead.
  226: .RE
  227: .TP
  228: warning
  229: .RS 4
  230: 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.
  231: .RE
  232: .TP
  233: error
  234: .RS 4
  235: 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.
  236: .RE
  237: .TP
  238: fatal
  239: .RS 4
  240: 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.
  241: .RE
  242: .SH AUTHOR
  243: Written by Serena Willis (snw@coherent-logic.com)
  244: .SH COPYRIGHT
  245: Copyright (C) 2025 Coherent Logic Development LLC
  246: 
  247: Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover texts, and with no Back-Cover Texts.
  248: 
  249: .SH "FILES"
  250: .PP
  251: $PREFIX/etc/freem/env.conf
  252: .RS 4
  253: FreeM environment catalog
  254: .RE
  255: .SH "SEE ALSO"
  256: .PP
  257: \fBfreem\fR(1),
  258: \fBfmadm\fR(8),
  259: \fBfreem.conf\fR(5)