Return to freem.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: freem.conf.5,v 1.2 2025/04/20 03:13:17 snw Exp $
   17: .\"    FreeM freem.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: freem.conf.5,v $
   41: .\"   Revision 1.2  2025/04/20 03:13:17  snw
   42: .\"   Updates to init_execution_context
   43: .\"
   44: .\"   Revision 1.1  2025/04/17 20:11:24  snw
   45: .\"   Add freem.conf man page
   46: .\"
   47: .\"
   48: .TH freem.conf 5 "17 April 2025" FreeM "FreeM User Manual"
   49: .SH NAME
   50: freem.conf - FreeM environment configuration
   51: .SH DESCRIPTION
   52: .PP
   53: $PREFIX/etc/<environment-name>/freem.conf
   54: contains configuration information for a single FreeM environment.
   55: 
   56: The file is organized into a series of sections, such as
   57: \fI[SYSTEM]\fR
   58: , indicating the namespace to which the configuration values beneath it will apply
   59: .RE
   60: 
   61: .SH CONFIGURABLE OPTIONS
   62: .TP
   63: root
   64: .RS 4
   65: The base directory of this namespace - the default is
   66: \fI$PREFIX/var/freem/<environment-name>/<namespace>\fR
   67: .RE
   68: .TP
   69: routines_path
   70: .RS 4
   71: The location in which M routines are located for this namespace
   72: .RE
   73: .TP
   74: globals_path
   75: .RS 4
   76: The location in which M globals are stored for this namespace
   77: .RE
   78: .TP
   79: journal_file
   80: .RS 4
   81: The location of after-image journals (valid only in the
   82: \fI[SYSTEM]\fR section)
   83: .RE
   84: .TP
   85: journal_mode
   86: .RS 4
   87: If set to
   88: \fIon\fR, enables after-image journaling for this environment (valid only in the
   89: \fI[SYSTEM]\fR section), otherwise, set to
   90: \fIoff\fR.
   91: .RE
   92: .TP
   93: journal_cut_threshold
   94: .RS 4
   95: 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
   96: \fI[SYSTEM]\fR section.
   97: .RE
   98: .TP
   99: zdate_format
  100: .RS 4
  101: The default format for the
  102: \fI$ZDATE\fR intrinsic function. Defaults to
  103: \fI%x\fR. See
  104: \fBstrftime\fR(3) for valid format codes. Valid only in the
  105: \fI[SYSTEM]\fR section.
  106: .RE
  107: .TP
  108: ztime_format
  109: .RS 4
  110: The default format for the
  111: \fI$ZTIME\fR intrinsic function. Defaults to
  112: \fI%X\fR. See
  113: \fBstrftime\fR(3) for valid format codes. Valid only in the
  114: \fI[SYSTEM]\fR section.
  115: .RE
  116: .SH AUTHOR
  117: Written by Serena Willis (snw@coherent-logic.com)
  118: .SH COPYRIGHT
  119: Copyright (C) 2025 Coherent Logic Development LLC
  120: 
  121: 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.
  122: 
  123: .SH "FILES"
  124: .PP
  125: $PREFIX/etc/freem/<environment-name>/freem.conf
  126: .RS 4
  127: FreeM environment configuration
  128: .RE
  129: .SH "SEE ALSO"
  130: .PP
  131: \fBfreem\fR(1),
  132: \fBfmadm\fR(8),
  133: \fBenv.conf\fR(5)