Annotation of freem/doc/env.conf.5, revision 1.1
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: .\"
! 16: .\" $Id$
! 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$
! 41: .\"
! 42: .TH env.conf 5 "17 April 2025" FreeM "FreeM User Manual"
! 43: .SH NAME
! 44: env.conf - FreeM environments configuration
! 45: .SH DESCRIPTION
! 46: .PP
! 47: $PREFIX/etc/env.conf
! 48: contains configuration information for FreeM environments.
! 49:
! 50: A FreeM environment is a collection of FreeM resources comprising the following elements:
! 51: .sp
! 52: .RS 4
! 53: .ie n \{\
! 54: \h'-04'\(bu\h'+03'\c
! 55: .\}
! 56: .el \{\
! 57: .sp -1
! 58: .IP \(bu 2.3
! 59: .\}
! 60: 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
! 61: .RE
! 62: .sp
! 63: .RS 4
! 64: .ie n \{\
! 65: \h'-04'\(bu\h'+03'\c
! 66: .\}
! 67: .el \{\
! 68: .sp -1
! 69: .IP \(bu 2.3
! 70: .\}
! 71: At least two namespaces: minimally,
! 72: \fISYSTEM\fR
! 73: and
! 74: \fIUSER\fR
! 75: .RE
! 76: .sp
! 77: .RS 4
! 78: .ie n \{\
! 79: \h'-04'\(bu\h'+03'\c
! 80: .\}
! 81: .el \{\
! 82: .sp -1
! 83: .IP \(bu 2.3
! 84: .\}
! 85: A set of pre-installed vendor routines located in the environment's
! 86: \fISYSTEM\fR
! 87: namespace.
! 88: .RE
! 89: .sp
! 90: .RS 4
! 91: .ie n \{\
! 92: \h'-04'\(bu\h'+03'\c
! 93: .\}
! 94: .el \{\
! 95: .sp -1
! 96: .IP \(bu 2.3
! 97: .\}
! 98: Zero or more instances of the FreeM interpreter running M application code
! 99: .RE
! 100: .sp
! 101: .RS 4
! 102: .ie n \{\
! 103: \h'-04'\(bu\h'+03'\c
! 104: .\}
! 105: .el \{\
! 106: .sp -1
! 107: .IP \(bu 2.3
! 108: .\}
! 109: Zero or more fmadm processes for managing the environment
! 110: .RE
! 111: .sp
! 112: .RS 4
! 113: .ie n \{\
! 114: \h'-04'\(bu\h'+03'\c
! 115: .\}
! 116: .el \{\
! 117: .sp -1
! 118: .IP \(bu 2.3
! 119: .\}
! 120: Optionally, an after-image journal, providing recoverability under certain abnormal conditions
! 121: .RE
! 122: .PP
! 123: The file is organized into a series of sections, such as
! 124: \fI[DEFAULT]\fR
! 125: , indicating the environment name to which the configuration values beneath it will apply
! 126: .RE
! 127: .SH CONFIGURABLE OPTIONS
! 128: .TP
! 129: user
! 130: The user account under which the environment will run - the default is
! 131: \fIfreem\fR
! 132: .TP
! 133: group
! 134: 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
! 135: \fIfreem\fR
! 136: .TP
! 137: enabled
! 138: A
! 139: \fItrue\fR
! 140: or
! 141: \fIfalse\fR
! 142: value indicating whether or not the environment is administratively enabled - default is
! 143: \fItrue\fR
! 144: .TP
! 145: env_path
! 146: An absolute filesystem path to the root of the filesystem - default is
! 147: \fI$PREFIX/var/freem/<environment-name>\fR
! 148: .TP
! 149: log_threshold_file
! 150: The minimum threshold at which log messages will be sent to
! 151: \fI/var/log/freem/<environment-name>.log\fR
! 152:
! 153: (see the
! 154: \fILOG THRESHOLDS\fR
! 155: section for descriptions of these values)
! 156: .TP
! 157: log_threshold_syslog
! 158: The minimum threshold at which log messages will be sent to the system's
! 159: \fIsyslog\fR
! 160: facility, if supported on your platform
! 161:
! 162: (see the
! 163: \fILOG THRESHOLDS\fR
! 164: section for descriptions of these values)
! 165: .TP
! 166: log_threshold_stderr
! 167: The minimum threshold at which log messages will be echoed to
! 168: \fIstderr\fR
! 169:
! 170: (see the
! 171: \fILOG THRESHOLDS\fR
! 172: section for descriptions of these values)
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