Return to env.conf.5 CVS log

Up to [Coherent Logic Development] / freem / doc

Add env.conf man page

.\" To display this man page, either:
.\"   1) Install this file along with the other subject.1 files in your
.\"      system's man1 directory (usually this is /usr/man/man1) and
.\"      enter the command:
.\"        man freem
.\"   or
.\"   2) Specify the input (this file) and the output (your favorite pager)
.\"      explicitly.  For example, if this file is in your current working
.\"      directory, you can use the following to view the formatted man page
.\"      using the "less" pager:
.\"        man ./freem.1 | less
.\"
.\" To print this man page to a PostScript printer:
.\"   man -t ./freem.1 | lpr
.\"
.\"   $Id: env.conf.5,v 1.1 2025/04/17 15:55:21 snw Exp $
.\"    FreeM env.conf man page
.\"
.\"  
.\"   Author: Serena Willis <snw@coherent-logic.com>
.\"    Copyright (C) 1998 MUG Deutschland
.\"    Copyright (C) 2020, 2025 Coherent Logic Development LLC
.\"
.\"
.\"   This file is part of FreeM.
.\"
.\"   FreeM is free software: you can redistribute it and/or modify
.\"   it under the terms of the GNU Affero Public License as published by
.\"   the Free Software Foundation, either version 3 of the License, or
.\"   (at your option) any later version.
.\"
.\"   FreeM is distributed in the hope that it will be useful,
.\"   but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"   GNU Affero Public License for more details.
.\"
.\"   You should have received a copy of the GNU Affero Public License
.\"   along with FreeM.  If not, see <https://www.gnu.org/licenses/>.
.\"
.\"   $Log: env.conf.5,v $
.\"   Revision 1.1  2025/04/17 15:55:21  snw
.\"   Add env.conf man page
.\"
.\"
.TH env.conf 5 "17 April 2025" FreeM "FreeM User Manual"
.SH NAME
env.conf - FreeM environments configuration
.SH DESCRIPTION
.PP
$PREFIX/etc/env.conf
contains configuration information for FreeM environments.

A FreeM environment is a collection of FreeM resources comprising the following elements:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
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
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
At least two namespaces: minimally,
\fISYSTEM\fR
and
\fIUSER\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A set of pre-installed vendor routines located in the environment's
\fISYSTEM\fR
namespace.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Zero or more instances of the FreeM interpreter running M application code
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Zero or more fmadm processes for managing the environment
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Optionally, an after-image journal, providing recoverability under certain abnormal conditions
.RE
.PP
The file is organized into a series of sections, such as
\fI[DEFAULT]\fR
, indicating the environment name to which the configuration values beneath it will apply
.RE
.SH CONFIGURABLE OPTIONS
.TP
user
The user account under which the environment will run - the default is
\fIfreem\fR
.TP
group
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
\fIfreem\fR
.TP
enabled
A
\fItrue\fR
or
\fIfalse\fR
value indicating whether or not the environment is administratively enabled - default is
\fItrue\fR
.TP
env_path
An absolute filesystem path to the root of the filesystem - default is
\fI$PREFIX/var/freem/<environment-name>\fR
.TP
log_threshold_file
The minimum threshold at which log messages will be sent to
\fI/var/log/freem/<environment-name>.log\fR

(see the
\fILOG THRESHOLDS\fR
section for descriptions of these values)
.TP
log_threshold_syslog
The minimum threshold at which log messages will be sent to the system's
\fIsyslog\fR
facility, if supported on your platform

(see the
\fILOG THRESHOLDS\fR
section for descriptions of these values)
.TP
log_threshold_stderr
The minimum threshold at which log messages will be echoed to
\fIstderr\fR

(see the
\fILOG THRESHOLDS\fR
section for descriptions of these values)