Annotation of freem/doc/env.conf.5, revision 1.2
1.1 snw 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: .\"
1.2 ! snw 16: .\" $Id: env.conf.5,v 1.1 2025/04/17 15:55:21 snw Exp $
1.1 snw 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: .\"
1.2 ! snw 40: .\" $Log: env.conf.5,v $
! 41: .\" Revision 1.1 2025/04/17 15:55:21 snw
! 42: .\" Add env.conf man page
! 43: .\"
1.1 snw 44: .\"
45: .TH env.conf 5 "17 April 2025" FreeM "FreeM User Manual"
46: .SH NAME
1.2 ! snw 47: env.conf - FreeM environment catalog
1.1 snw 48: .SH DESCRIPTION
49: .PP
50: $PREFIX/etc/env.conf
51: contains configuration information for FreeM environments.
52:
53: A FreeM environment is a collection of FreeM resources comprising the following elements:
54: .sp
55: .RS 4
56: .ie n \{\
57: \h'-04'\(bu\h'+03'\c
58: .\}
59: .el \{\
60: .sp -1
61: .IP \(bu 2.3
62: .\}
63: 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
64: .RE
65: .sp
66: .RS 4
67: .ie n \{\
68: \h'-04'\(bu\h'+03'\c
69: .\}
70: .el \{\
71: .sp -1
72: .IP \(bu 2.3
73: .\}
74: At least two namespaces: minimally,
75: \fISYSTEM\fR
76: and
77: \fIUSER\fR
78: .RE
79: .sp
80: .RS 4
81: .ie n \{\
82: \h'-04'\(bu\h'+03'\c
83: .\}
84: .el \{\
85: .sp -1
86: .IP \(bu 2.3
87: .\}
88: A set of pre-installed vendor routines located in the environment's
89: \fISYSTEM\fR
90: namespace.
91: .RE
92: .sp
93: .RS 4
94: .ie n \{\
95: \h'-04'\(bu\h'+03'\c
96: .\}
97: .el \{\
98: .sp -1
99: .IP \(bu 2.3
100: .\}
101: Zero or more instances of the FreeM interpreter running M application code
102: .RE
103: .sp
104: .RS 4
105: .ie n \{\
106: \h'-04'\(bu\h'+03'\c
107: .\}
108: .el \{\
109: .sp -1
110: .IP \(bu 2.3
111: .\}
112: Zero or more fmadm processes for managing the environment
113: .RE
114: .sp
115: .RS 4
116: .ie n \{\
117: \h'-04'\(bu\h'+03'\c
118: .\}
119: .el \{\
120: .sp -1
121: .IP \(bu 2.3
122: .\}
123: Optionally, an after-image journal, providing recoverability under certain abnormal conditions
124: .RE
125: .PP
126: The file is organized into a series of sections, such as
127: \fI[DEFAULT]\fR
128: , indicating the environment name to which the configuration values beneath it will apply
129: .RE
130: .SH CONFIGURABLE OPTIONS
131: .TP
132: user
1.2 ! snw 133: .RS 4
1.1 snw 134: The user account under which the environment will run - the default is
135: \fIfreem\fR
1.2 ! snw 136: .RE
1.1 snw 137: .TP
138: group
1.2 ! snw 139: .RS 4
1.1 snw 140: 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
1.2 ! snw 141: .RE
1.1 snw 142: \fIfreem\fR
143: .TP
144: enabled
1.2 ! snw 145: .RS 4
1.1 snw 146: A
147: \fItrue\fR
148: or
149: \fIfalse\fR
150: value indicating whether or not the environment is administratively enabled - default is
151: \fItrue\fR
1.2 ! snw 152: .RE
1.1 snw 153: .TP
154: env_path
1.2 ! snw 155: .RS 4
1.1 snw 156: An absolute filesystem path to the root of the filesystem - default is
157: \fI$PREFIX/var/freem/<environment-name>\fR
1.2 ! snw 158: .RE
1.1 snw 159: .TP
160: log_threshold_file
1.2 ! snw 161: .RS 4
1.1 snw 162: The minimum threshold at which log messages will be sent to
163: \fI/var/log/freem/<environment-name>.log\fR
1.2 ! snw 164: (may be overridden for a specific process by setting the
! 165: \fI$FREEM_LOG_THRESHOLD_FILE\fR
! 166: environment variable prior to launching the process)
1.1 snw 167:
168: (see the
1.2 ! snw 169: \fBLOG THRESHOLD VALUES\fR
! 170: section for details)
! 171: .RE
1.1 snw 172: .TP
173: log_threshold_syslog
1.2 ! snw 174: .RS 4
1.1 snw 175: The minimum threshold at which log messages will be sent to the system's
176: \fIsyslog\fR
177: facility, if supported on your platform
1.2 ! snw 178: (may be overridden for a specific process by setting the
! 179: \fI$FREEM_LOG_THRESHOLD_SYSLOG\fR
! 180: environment variable prior to launching the process)
1.1 snw 181:
182: (see the
1.2 ! snw 183: \fBLOG THRESHOLD VALUES\fR
! 184: section for details)
! 185: .RE
1.1 snw 186: .TP
187: log_threshold_stderr
1.2 ! snw 188: .RS 4
1.1 snw 189: The minimum threshold at which log messages will be echoed to
190: \fIstderr\fR
1.2 ! snw 191: (may be overridden for a specific process by setting the
! 192: \fI$FREEM_LOG_THRESHOLD_STDERR\fR
! 193: environment variable prior to launching the process)
1.1 snw 194:
195: (see the
1.2 ! snw 196: \fBLOG THRESHOLD VALUES\fR
! 197: section for details)
! 198: .RE
! 199: .SH LOG THRESHOLD VALUES
! 200: This section details the valid values for each of the
! 201: \fIlog_threshold_*\fR
! 202: 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
! 203: \fIwarning\fR
! 204: is selected, messages with a diagnostic class of
! 205: \fIwarning, error, and fatal\fR
! 206: will be delivered through the selected mechanism.
! 207:
! 208: Valid values for each of these configuration keys are as follows:
! 209: .TP
! 210: debug
! 211: .RS 4
! 212: 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.
! 213: .RE
! 214: .TP
! 215: info
! 216: .RS 4
! 217: 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
! 218: \fIwarning\fR
! 219: instead.
! 220: .RE
! 221: .TP
! 222: warning
! 223: .RS 4
! 224: 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.
! 225: .RE
! 226: .TP
! 227: error
! 228: .RS 4
! 229: 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.
! 230: .RE
! 231: .TP
! 232: fatal
! 233: .RS 4
! 234: 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.
! 235: .RE
! 236: .SH "FILES"
! 237: .PP
! 238: $PREFIX/etc/freem/env.conf
! 239: .RS 4
! 240: FreeM environment catalog
! 241: .RE
! 242: .SH "SEE ALSO"
! 243: .PP
! 244: \fBfreem\fR(1),
! 245: \fBfmadm\fR(8),
! 246: \fBfreem.conf\fR(5)
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to env.conf.5 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Coherent Logic Development] / freem / doc