Annotation of freem/doc/freem.1, revision 1.10
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.10 ! snw 16: .\" $Id: freem.1,v 1.9 2025/04/18 22:12:29 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.10 ! snw 41: .\" Revision 1.9 2025/04/18 22:12:29 snw
! 42: .\" Fix texinfo bogosity and add subjects to man pages
! 43: .\"
1.9 snw 44: .\" Revision 1.8 2025/04/18 01:23:05 snw
45: .\" More documentation updates
46: .\"
1.8 snw 47: .\" Revision 1.7 2025/04/17 17:57:35 snw
48: .\" Major updates to man pages
49: .\"
1.7 snw 50: .\" Revision 1.6 2025/04/17 15:08:24 snw
51: .\" Add documentation on FREEM_LOG_THRESHOLD environment variables to man pages
52: .\"
1.6 snw 53: .\" Revision 1.5 2025/04/04 12:49:19 snw
54: .\" Dollar signs cut off in ENVIRONMENT sections of both man pages
55: .\"
1.5 snw 56: .\" Revision 1.4 2025/04/03 15:56:41 snw
57: .\" Add fmadm man page to CVS
58: .\"
1.1 snw 59: .\"
1.3 snw 60: .TH freem 1 "3 April 2025" FreeM "FreeM User Manual"
1.1 snw 61: .SH NAME
1.9 snw 62: freem - FreeM programming language interpreter
1.1 snw 63: .SH SYNOPSIS
64: .B freem [OPTION...]
65: .SH DESCRIPTION
66: The
67: .B freem
68: program runs an instance of
69: .IR "FreeM"
70: \.
71:
72: 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.
73:
74: 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.
75:
76: More information is available at https://freem.coherent-logic.com/
77:
1.8 snw 78: Please see the FreeM
79: \fIinfo\fR documentation for language, database, and administration details.
1.1 snw 80: .SH OPTIONS
81: .TP
82: \-h, --help
1.7 snw 83: .RS 4
1.3 snw 84: Display a list of freem command-line flags
1.7 snw 85: .RE
1.1 snw 86: .TP
87: \-i, --import
1.7 snw 88: .RS 4
1.3 snw 89: Imports UNIX environment variables as M locals
1.7 snw 90: .RE
1.3 snw 91: .TP
92: \-e <environment-name>, --environment=<environment-name>
1.7 snw 93: .RS 4
94: Sets active environment to
95: \fI<environment-name>\fR;
96: \fIDEFAULT\fR if unspecified
97: .RE
1.1 snw 98: .TP
99: \-f, --filter
1.7 snw 100: .RS 4
1.3 snw 101: Allows M code to be used as a filter
1.7 snw 102: .RE
1.1 snw 103: .TP
104: \-n <NAMESPACE>, --namespace=<NAMESPACE>
1.7 snw 105: .RS 4
106: Selects
107: \fI<NAMESPACE>\fR as the startup namespace instead of
108: \fIUSER\fR
109: .RE
1.1 snw 110: .TP
111: \-q, --quiet
1.7 snw 112: .RS 4
113: Disables startup messages and prompt string
114: .RE
1.1 snw 115: .TP
1.3 snw 116: \-r <LABEL^ROUTINE>, --routine=<LABEL^ROUTINE>
1.7 snw 117: .RS 4
118: Executes
119: \fI<LABEL^ROUTINE>\fR on startup instead of entering direct mode
120: .RE
121: .TP
1.3 snw 122: \-s <standard>, --standard=<standard>
1.7 snw 123: .RS 4
124: Restricts access to FreeM vendor extensions not present in relevant standards
125: \fI*\fR. In this flag,
126: \fI<standard>\fR can be:
127: .sp
128: .RS 4
129: .ie n \{\
130: \h'-04'\(bu\h'+03'\c
131: .\}
132: .el \{\
133: .sp -1
134: .IP \(bu 2.3
135: .\}
136: M77
137: .RE
138: .sp
139: .RS 4
140: .ie n \{\
141: \h'-04'\(bu\h'+03'\c
142: .\}
143: .el \{\
144: .sp -1
145: .IP \(bu 2.3
146: .\}
147: M84
148: .RE
149: .sp
150: .RS 4
151: .ie n \{\
152: \h'-04'\(bu\h'+03'\c
153: .\}
154: .el \{\
155: .sp -1
156: .IP \(bu 2.3
157: .\}
158: M90
159: .RE
160: .sp
161: .RS 4
162: .ie n \{\
163: \h'-04'\(bu\h'+03'\c
164: .\}
165: .el \{\
166: .sp -1
167: .IP \(bu 2.3
168: .\}
169: M95
170: .RE
171: .sp
172: .RS 4
173: .ie n \{\
174: \h'-04'\(bu\h'+03'\c
175: .\}
176: .el \{\
177: .sp -1
178: .IP \(bu 2.3
179: .\}
180: MDS
181: .RE
182: .sp
183: .RS 4
184: .ie n \{\
185: \h'-04'\(bu\h'+03'\c
186: .\}
187: .el \{\
188: .sp -1
189: .IP \(bu 2.3
190: .\}
191: M5
192: .RE
193: .sp
194: .RS 4
195: .ie n \{\
196: \h'-04'\(bu\h'+03'\c
197: .\}
198: .el \{\
199: .sp -1
200: .IP \(bu 2.3
201: .\}
202: FREEM
203:
204: .RE
205: \fB*\fR FreeM is not entirely compliant with any MDC standard, regardless of the value of the
206: \fI--standard\fR command-line flag.
207:
208: See the
209: \fBCompliance Clause\fR on the FreeM Wiki for more information on FreeM's deviations from MDC standards.
210: .RE
1.1 snw 211: .TP
212: \-v, --version
1.3 snw 213: Display FreeM version information
1.1 snw 214: .TP
215: \-x <MCODE>, --execute=<MCODE>
1.8 snw 216: Execute M code
217: \fI<MCODE>\fR on startup
1.3 snw 218: .TP
219: \-d, --daemon
220: Run the FreeM daemon (one and only one FreeM daemon must always be running for each configured environment)
221: .TP
222: \-k, --nofork
1.8 snw 223: Run the FreeM daemon in foreground (requires
224: \fI--daemon\fR)
1.3 snw 225: .TP
226: \-S <BYTES>, --shmsize=<BYTES>
227: Sets the size of the shared memory segment where FreeM stores the job table, lock table, and IPC table.
228: - Each concurrent job takes 1024 bytes (1 page) of shared memory
229: - Each LOCK takes 2048 bytes (2 pages) of shared memory
230: - Each IPC takes 1024 bytes (1 page) of shared memory
1.1 snw 231: .SH "RETURN VALUES"
232: Returns 0 for non-error condition.
233: .SH FILES
234: .TP
1.3 snw 235: env.conf
1.8 snw 236: The FreeM environment catalog. Normally located in
237: \fI$PREFIX/etc/freem/env.conf\fR
1.3 snw 238: .TP
1.1 snw 239: freem.conf
1.8 snw 240: The FreeM configuration file. Normally located in
241: \fI$PREFIX/etc/freem/<environment-name>/freem.conf\fR
1.1 snw 242: .SH ENVIRONMENT
1.3 snw 243: .TP
1.5 snw 244: $DISPLAY
1.8 snw 245: Determines the value of the
246: \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
247: \fI--enable-mwapi\fR configuration option.
1.3 snw 248: .TP
1.5 snw 249: $TERM
1.8 snw 250: Used by the
251: \fI^$DEVICE\fR structured system variable to provide the
252: \fITERMID\fR value for I/O channel 0.
1.6 snw 253: .TP
254: $FREEM_LOG_THRESHOLD_FILE
1.8 snw 255: Overrides the configured threshold at which log messages are written to files in
256: \fI/var/log/freem\fR, corresponding to the
257: \fIlog_threshold_file\fR environment setting in
258: \fI$PREFIX/etc/env.conf\fR. The default value is
259: \fIinfo\fR.
1.6 snw 260: .TP
261: $FREEM_LOG_THRESHOLD_SYSLOG
1.8 snw 262: Overrides the configured threshold at which log messages are sent to the
263: \fIsyslog\fR facility on systems that support it, corresponding to the
264: \fIlog_threshold_syslog\fR environment setting in
265: \fI$PREFIX/etc/env.conf\fR. The default value is
266: \fIinfo\fR.
1.6 snw 267: .TP
268: $FREEM_LOG_THRESHOLD_STDERR
1.8 snw 269: Overrides the configured threshold at which log messages are sent to
270: \fIstderr\fR, corresponding to the
271: \fIlog_threshold_stderr\fR environment setting in
272: \fI$PREFIX/etc/env.conf\fR. The default value is
273: \fIwarning\fR.
1.6 snw 274: .SH LOG THRESHOLD VALUES
1.8 snw 275: This section details the valid values for each of the
276: \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
277: \fIwarning\fR is selected, messages with a diagnostic class of
278: \fIwarning\fR,
279: \fIerror\fR, and
280: \fIfatal\fR will be delivered through the selected mechanism.
1.6 snw 281:
282: Valid values for each of these environment variables are as follows:
283: .TP
284: debug
1.8 snw 285: .RS 4
1.6 snw 286: 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 287: .RE
1.6 snw 288: .TP
289: info
1.8 snw 290: .RS 4
291: 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
292: \fIwarning\fR instead.
293: .RE
1.6 snw 294: .TP
295: warning
1.8 snw 296: .RS 4
1.6 snw 297: 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 298: .RE
1.6 snw 299: .TP
300: error
1.8 snw 301: .RS 4
1.6 snw 302: 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 303: .RE
1.6 snw 304: .TP
305: fatal
1.8 snw 306: .RS 4
1.6 snw 307: 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 308: .RE
1.1 snw 309: .SH BUGS
1.3 snw 310: Check the issue tracker at https://bugs.coherent-logic.com for more detailed information on current bugs.
1.1 snw 311: .SH AUTHOR
312: Provided by Shalom ha-Ashkenaz, 1998/06/18 CE, to the stewardship of the
313: MUG Deutschland. The GUMP (Generic Universal M Project) took over after this point,
1.2 snw 314: and ownership of the original SourceForge project was handed over to Serena Willis of
1.1 snw 315: Coherent Logic Development LLC in 2014.
316: .br
317: The author's identity is a mystery. Can anyone shed light on this?
318: .br
319:
320: .br
321: Man page written by Ron Fox (rfox@dls.queens.org)
322: .br
1.2 snw 323: Maintained and updated by Serena Willis (snw@coherent-logic.com)
1.1 snw 324: .SH COPYRIGHT
325:
326: Copyright (C) 1998 MUG Deutschland
327: .br
1.4 snw 328: Copyright (C) 2025 Coherent Logic Development LLC
329:
330: 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 331: .SH "SEE ALSO"
1.7 snw 332: .PP
333: \fBfmadm\fR(8),
334: \fBenv.conf\fR(5),
335: \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