Return to freem.conf.5 CVS log

Up to [Coherent Logic Development] / freem / doc

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