Annotation of freem/doc/freem.1, revision 1.8
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:
1.3 snw 5: .\" man freem
1.1 snw 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:
1.3 snw 11: .\" man ./freem.1 | less
1.1 snw 12: .\"
13: .\" To print this man page to a PostScript printer:
1.3 snw 14: .\" man -t ./freem.1 | lpr
1.1 snw 15: .\"
1.8 ! snw 16: .\" $Id: freem.1,v 1.7 2025/04/17 17:57:35 snw Exp $
1.1 snw 17: .\" FreeM man page
18: .\"
19: .\"
1.2 snw 20: .\" Author: Serena Willis <snw@coherent-logic.com>
1.1 snw 21: .\" Copyright (C) 1998 MUG Deutschland
1.3 snw 22: .\" Copyright (C) 2020, 2025 Coherent Logic Development LLC
1.1 snw 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.5 snw 40: .\" $Log: freem.1,v $
1.8 ! snw 41: .\" Revision 1.7 2025/04/17 17:57:35 snw
! 42: .\" Major updates to man pages
! 43: .\"
1.7 snw 44: .\" Revision 1.6 2025/04/17 15:08:24 snw
45: .\" Add documentation on FREEM_LOG_THRESHOLD environment variables to man pages
46: .\"
1.6 snw 47: .\" Revision 1.5 2025/04/04 12:49:19 snw
48: .\" Dollar signs cut off in ENVIRONMENT sections of both man pages
49: .\"
1.5 snw 50: .\" Revision 1.4 2025/04/03 15:56:41 snw
51: .\" Add fmadm man page to CVS
52: .\"
1.1 snw 53: .\"
1.3 snw 54: .TH freem 1 "3 April 2025" FreeM "FreeM User Manual"
1.1 snw 55: .SH NAME
56: freem
57: .SH SYNOPSIS
58: .B freem [OPTION...]
59: .SH DESCRIPTION
60: The
61: .B freem
62: program runs an instance of
63: .IR "FreeM"
64: \.
65:
66: FreeM is an implementation of the MUMPS programming language, began by the efforts of the mysterious Shalom ha-Ashkenaz. In response to InterSystems' spree of buying up all competing MUMPS implementations, Shalom gifted FreeM to MUG Deutschland in 1998, in hopes that the MUMPS community would turn it into a viable, freely available, and fully-featured MUMPS implementation.
67:
68: After years of dormancy, the FreeM project has been resurrected, and under the stewardship of Coherent Logic Development and a small core team of contributors, work is proceeding towards completing the original FreeM team's goals, and much more.
69:
70: More information is available at https://freem.coherent-logic.com/
71:
1.8 ! snw 72: Please see the FreeM
! 73: \fIinfo\fR documentation for language, database, and administration details.
1.1 snw 74: .SH OPTIONS
75: .TP
76: \-h, --help
1.7 snw 77: .RS 4
1.3 snw 78: Display a list of freem command-line flags
1.7 snw 79: .RE
1.1 snw 80: .TP
81: \-i, --import
1.7 snw 82: .RS 4
1.3 snw 83: Imports UNIX environment variables as M locals
1.7 snw 84: .RE
1.3 snw 85: .TP
86: \-e <environment-name>, --environment=<environment-name>
1.7 snw 87: .RS 4
88: Sets active environment to
89: \fI<environment-name>\fR;
90: \fIDEFAULT\fR if unspecified
91: .RE
1.1 snw 92: .TP
93: \-f, --filter
1.7 snw 94: .RS 4
1.3 snw 95: Allows M code to be used as a filter
1.7 snw 96: .RE
1.1 snw 97: .TP
98: \-n <NAMESPACE>, --namespace=<NAMESPACE>
1.7 snw 99: .RS 4
100: Selects
101: \fI<NAMESPACE>\fR as the startup namespace instead of
102: \fIUSER\fR
103: .RE
1.1 snw 104: .TP
105: \-q, --quiet
1.7 snw 106: .RS 4
107: Disables startup messages and prompt string
108: .RE
1.1 snw 109: .TP
1.3 snw 110: \-r <LABEL^ROUTINE>, --routine=<LABEL^ROUTINE>
1.7 snw 111: .RS 4
112: Executes
113: \fI<LABEL^ROUTINE>\fR on startup instead of entering direct mode
114: .RE
115: .TP
1.3 snw 116: \-s <standard>, --standard=<standard>
1.7 snw 117: .RS 4
118: Restricts access to FreeM vendor extensions not present in relevant standards
119: \fI*\fR. In this flag,
120: \fI<standard>\fR can be:
121: .sp
122: .RS 4
123: .ie n \{\
124: \h'-04'\(bu\h'+03'\c
125: .\}
126: .el \{\
127: .sp -1
128: .IP \(bu 2.3
129: .\}
130: M77
131: .RE
132: .sp
133: .RS 4
134: .ie n \{\
135: \h'-04'\(bu\h'+03'\c
136: .\}
137: .el \{\
138: .sp -1
139: .IP \(bu 2.3
140: .\}
141: M84
142: .RE
143: .sp
144: .RS 4
145: .ie n \{\
146: \h'-04'\(bu\h'+03'\c
147: .\}
148: .el \{\
149: .sp -1
150: .IP \(bu 2.3
151: .\}
152: M90
153: .RE
154: .sp
155: .RS 4
156: .ie n \{\
157: \h'-04'\(bu\h'+03'\c
158: .\}
159: .el \{\
160: .sp -1
161: .IP \(bu 2.3
162: .\}
163: M95
164: .RE
165: .sp
166: .RS 4
167: .ie n \{\
168: \h'-04'\(bu\h'+03'\c
169: .\}
170: .el \{\
171: .sp -1
172: .IP \(bu 2.3
173: .\}
174: MDS
175: .RE
176: .sp
177: .RS 4
178: .ie n \{\
179: \h'-04'\(bu\h'+03'\c
180: .\}
181: .el \{\
182: .sp -1
183: .IP \(bu 2.3
184: .\}
185: M5
186: .RE
187: .sp
188: .RS 4
189: .ie n \{\
190: \h'-04'\(bu\h'+03'\c
191: .\}
192: .el \{\
193: .sp -1
194: .IP \(bu 2.3
195: .\}
196: FREEM
197:
198: .RE
199: \fB*\fR FreeM is not entirely compliant with any MDC standard, regardless of the value of the
200: \fI--standard\fR command-line flag.
201:
202: See the
203: \fBCompliance Clause\fR on the FreeM Wiki for more information on FreeM's deviations from MDC standards.
204: .RE
1.1 snw 205: .TP
206: \-v, --version
1.3 snw 207: Display FreeM version information
1.1 snw 208: .TP
209: \-x <MCODE>, --execute=<MCODE>
1.8 ! snw 210: Execute M code
! 211: \fI<MCODE>\fR on startup
1.3 snw 212: .TP
213: \-d, --daemon
214: Run the FreeM daemon (one and only one FreeM daemon must always be running for each configured environment)
215: .TP
216: \-k, --nofork
1.8 ! snw 217: Run the FreeM daemon in foreground (requires
! 218: \fI--daemon\fR)
1.3 snw 219: .TP
220: \-S <BYTES>, --shmsize=<BYTES>
221: Sets the size of the shared memory segment where FreeM stores the job table, lock table, and IPC table.
222: - Each concurrent job takes 1024 bytes (1 page) of shared memory
223: - Each LOCK takes 2048 bytes (2 pages) of shared memory
224: - Each IPC takes 1024 bytes (1 page) of shared memory
1.1 snw 225: .SH "RETURN VALUES"
226: Returns 0 for non-error condition.
227: .SH FILES
228: .TP
1.3 snw 229: env.conf
1.8 ! snw 230: The FreeM environment catalog. Normally located in
! 231: \fI$PREFIX/etc/freem/env.conf\fR
1.3 snw 232: .TP
1.1 snw 233: freem.conf
1.8 ! snw 234: The FreeM configuration file. Normally located in
! 235: \fI$PREFIX/etc/freem/<environment-name>/freem.conf\fR
1.1 snw 236: .SH ENVIRONMENT
1.3 snw 237: .TP
1.5 snw 238: $DISPLAY
1.8 ! snw 239: Determines the value of the
! 240: \fI$PDISPLAY\fR intrinsic special variable. This determines the X11 display used by the M Windowing API. Only applies when FreeM is built with the
! 241: \fI--enable-mwapi\fR configuration option.
1.3 snw 242: .TP
1.5 snw 243: $TERM
1.8 ! snw 244: Used by the
! 245: \fI^$DEVICE\fR structured system variable to provide the
! 246: \fITERMID\fR value for I/O channel 0.
1.6 snw 247: .TP
248: $FREEM_LOG_THRESHOLD_FILE
1.8 ! snw 249: Overrides the configured threshold at which log messages are written to files in
! 250: \fI/var/log/freem\fR, corresponding to the
! 251: \fIlog_threshold_file\fR environment setting in
! 252: \fI$PREFIX/etc/env.conf\fR. The default value is
! 253: \fIinfo\fR.
1.6 snw 254: .TP
255: $FREEM_LOG_THRESHOLD_SYSLOG
1.8 ! snw 256: Overrides the configured threshold at which log messages are sent to the
! 257: \fIsyslog\fR facility on systems that support it, corresponding to the
! 258: \fIlog_threshold_syslog\fR environment setting in
! 259: \fI$PREFIX/etc/env.conf\fR. The default value is
! 260: \fIinfo\fR.
1.6 snw 261: .TP
262: $FREEM_LOG_THRESHOLD_STDERR
1.8 ! snw 263: Overrides the configured threshold at which log messages are sent to
! 264: \fIstderr\fR, corresponding to the
! 265: \fIlog_threshold_stderr\fR environment setting in
! 266: \fI$PREFIX/etc/env.conf\fR. The default value is
! 267: \fIwarning\fR.
1.6 snw 268: .SH LOG THRESHOLD VALUES
1.8 ! snw 269: This section details the valid values for each of the
! 270: \fI$FREEM_LOG_THRESHOLD_*\fR environment variables, and each value indicates a minimum diagnostic level at which the indicated class of message will be delivered through the selected mechanism. All messages with an equal or higher diagnostic level than the class indicated will be delivered, i.e., if
! 271: \fIwarning\fR is selected, messages with a diagnostic class of
! 272: \fIwarning\fR,
! 273: \fIerror\fR, and
! 274: \fIfatal\fR will be delivered through the selected mechanism.
1.6 snw 275:
276: Valid values for each of these environment variables are as follows:
277: .TP
278: debug
1.8 ! snw 279: .RS 4
1.6 snw 280: Messages useful mostly for developers contributing to FreeM itself. Will produce a high volume of log messages, and is likely to impact system performance. Not recommended for production usage.
1.8 ! snw 281: .RE
1.6 snw 282: .TP
283: info
1.8 ! snw 284: .RS 4
! 285: Includes messages of an informational nature. Will produce a moderately high volume of log messages. For heavily multi-user and multi-process systems, it is recommended to use
! 286: \fIwarning\fR instead.
! 287: .RE
1.6 snw 288: .TP
289: warning
1.8 ! snw 290: .RS 4
1.6 snw 291: Includes warning messages. These indicate conditions (including retries when attempting to acquire semaphores) that warrant further investigation by the system operator, but do not typically prevent applications from running.
1.8 ! snw 292: .RE
1.6 snw 293: .TP
294: error
1.8 ! snw 295: .RS 4
1.6 snw 296: Includes error messages. This class of messages indicates that a recoverable error has occurred in the FreeM engine. Warrants immediate attention by the system operator.
1.8 ! snw 297: .RE
1.6 snw 298: .TP
299: fatal
1.8 ! snw 300: .RS 4
1.6 snw 301: Includes messages indicating errors that are not recoverable. If this class of message occurs, the process that triggered the message has terminated abnormally. Requires immediate system operator intervention, and can indicate gross misconfiguration of the FreeM engine or the host operating system environment, or even a FreeM bug.
1.8 ! snw 302: .RE
1.1 snw 303: .SH BUGS
1.3 snw 304: Check the issue tracker at https://bugs.coherent-logic.com for more detailed information on current bugs.
1.1 snw 305: .SH AUTHOR
306: Provided by Shalom ha-Ashkenaz, 1998/06/18 CE, to the stewardship of the
307: MUG Deutschland. The GUMP (Generic Universal M Project) took over after this point,
1.2 snw 308: and ownership of the original SourceForge project was handed over to Serena Willis of
1.1 snw 309: Coherent Logic Development LLC in 2014.
310: .br
311: The author's identity is a mystery. Can anyone shed light on this?
312: .br
313:
314: .br
315: Man page written by Ron Fox (rfox@dls.queens.org)
316: .br
1.2 snw 317: Maintained and updated by Serena Willis (snw@coherent-logic.com)
1.1 snw 318: .SH COPYRIGHT
319:
320: Copyright (C) 1998 MUG Deutschland
321: .br
1.4 snw 322: Copyright (C) 2025 Coherent Logic Development LLC
323:
324: 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.7 snw 325: .SH FILES
326: .PP
327: $PREFIX/etc/freem/env.conf
328: .RS 4
329: FreeM environment catalog
330: .RE
331: .PP
332: $PREFIX/etc/freem/<environment-name>/freem.conf
333: .RS 4
334: FreeM per-environment configuration
1.1 snw 335: .SH "SEE ALSO"
1.7 snw 336: .PP
337: \fBfmadm\fR(8),
338: \fBenv.conf\fR(5),
339: \fBfreem.conf\fR(5)
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to freem.1 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Coherent Logic Development] / freem / doc