Return to freem.conf.5 CVS log

Up to [Coherent Logic Development] / freem / doc

Updates to init_execution_context

.\" 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: freem.conf.5,v 1.2 2025/04/20 03:13:17 snw Exp $
.\"    FreeM freem.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: freem.conf.5,v $
.\"   Revision 1.2  2025/04/20 03:13:17  snw
.\"   Updates to init_execution_context
.\"
.\"   Revision 1.1  2025/04/17 20:11:24  snw
.\"   Add freem.conf man page
.\"
.\"
.TH freem.conf 5 "17 April 2025" FreeM "FreeM User Manual"
.SH NAME
freem.conf - FreeM environment configuration
.SH DESCRIPTION
.PP
$PREFIX/etc/<environment-name>/freem.conf
contains configuration information for a single FreeM environment.

The file is organized into a series of sections, such as
\fI[SYSTEM]\fR
, indicating the namespace to which the configuration values beneath it will apply
.RE

.SH CONFIGURABLE OPTIONS
.TP
root
.RS 4
The base directory of this namespace - the default is
\fI$PREFIX/var/freem/<environment-name>/<namespace>\fR
.RE
.TP
routines_path
.RS 4
The location in which M routines are located for this namespace
.RE
.TP
globals_path
.RS 4
The location in which M globals are stored for this namespace
.RE
.TP
journal_file
.RS 4
The location of after-image journals (valid only in the
\fI[SYSTEM]\fR section)
.RE
.TP
journal_mode
.RS 4
If set to
\fIon\fR, enables after-image journaling for this environment (valid only in the
\fI[SYSTEM]\fR section), otherwise, set to
\fIoff\fR.
.RE
.TP
journal_cut_threshold
.RS 4
The number of bytes at which the current after-image journal file will be renamed and a new, empty after-image journal created. Defaults to 429496700 (4 GiB). Valid only in the
\fI[SYSTEM]\fR section.
.RE
.TP
zdate_format
.RS 4
The default format for the
\fI$ZDATE\fR intrinsic function. Defaults to
\fI%x\fR. See
\fBstrftime\fR(3) for valid format codes. Valid only in the
\fI[SYSTEM]\fR section.
.RE
.TP
ztime_format
.RS 4
The default format for the
\fI$ZTIME\fR intrinsic function. Defaults to
\fI%X\fR. See
\fBstrftime\fR(3) for valid format codes. Valid only in the
\fI[SYSTEM]\fR section.
.RE
.SH AUTHOR
Written by Serena Willis (snw@coherent-logic.com)
.SH COPYRIGHT
Copyright (C) 2025 Coherent Logic Development LLC

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.

.SH "FILES"
.PP
$PREFIX/etc/freem/<environment-name>/freem.conf
.RS 4
FreeM environment configuration
.RE
.SH "SEE ALSO"
.PP
\fBfreem\fR(1),
\fBfmadm\fR(8),
\fBenv.conf\fR(5)