Return to freem.conf.5 CVS log

Up to [Coherent Logic Development] / freem / doc

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