Annotation of freem/doc/freem.1, revision 1.3
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: .\"
16: .\" freem.1
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: .\"
40: .\"
41: .\"
1.3 ! snw 42: .TH freem 1 "3 April 2025" FreeM "FreeM User Manual"
1.1 snw 43: .SH NAME
44: freem
45: .SH SYNOPSIS
46: .B freem [OPTION...]
47: .SH DESCRIPTION
48: The
49: .B freem
50: program runs an instance of
51: .IR "FreeM"
52: \.
53:
54: 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.
55:
56: 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.
57:
58: More information is available at https://freem.coherent-logic.com/
59:
60: Please see the FreeM texinfo documentation for language, database, and administration details ("info freem").
61: .SH OPTIONS
62: .TP
63: \-h, --help
1.3 ! snw 64: Display a list of freem command-line flags
1.1 snw 65: .TP
66: \-i, --import
1.3 ! snw 67: Imports UNIX environment variables as M locals
! 68: .TP
! 69: \-e <environment-name>, --environment=<environment-name>
! 70: Sets active environment to <environment-name> (DEFAULT if unspecified)
1.1 snw 71: .TP
72: \-f, --filter
1.3 ! snw 73: Allows M code to be used as a filter
1.1 snw 74: .TP
75: \-n <NAMESPACE>, --namespace=<NAMESPACE>
1.3 ! snw 76: Selects <NAMESPACE> as the startup namespace instead of USER
1.1 snw 77: .TP
78: \-q, --quiet
1.3 ! snw 79: Sisables startup messages and prompt string
1.1 snw 80: .TP
1.3 ! snw 81: \-r <LABEL^ROUTINE>, --routine=<LABEL^ROUTINE>
! 82: Executes <LABEL^ROUTINE> on startup instead of entering direct mode
! 83: \-s <standard>, --standard=<standard>
! 84: Restricts access to FreeM vendor extensions not present in relevant standards*. In this flag, <standard> can be:
! 85: - M77
! 86: - M84
! 87: - M90
! 88: - M95
! 89: - MDS
! 90: - M5
! 91: - FREEM
1.1 snw 92: .TP
93: \-v, --version
1.3 ! snw 94: Display FreeM version information
1.1 snw 95: .TP
96: \-x <MCODE>, --execute=<MCODE>
1.3 ! snw 97: Execute M code <MCODE> on startup
! 98: .TP
! 99: \-d, --daemon
! 100: Run the FreeM daemon (one and only one FreeM daemon must always be running for each configured environment)
! 101: .TP
! 102: \-k, --nofork
! 103: Run the FreeM daemon in foreground (requires --daemon)
! 104: .TP
! 105: \-S <BYTES>, --shmsize=<BYTES>
! 106: Sets the size of the shared memory segment where FreeM stores the job table, lock table, and IPC table.
! 107: - Each concurrent job takes 1024 bytes (1 page) of shared memory
! 108: - Each LOCK takes 2048 bytes (2 pages) of shared memory
! 109: - Each IPC takes 1024 bytes (1 page) of shared memory
1.1 snw 110: .SH "RETURN VALUES"
111: Returns 0 for non-error condition.
112: .SH FILES
113: .TP
1.3 ! snw 114: env.conf
! 115: The FreeM environment catalog. Normally located in $PREFIX/etc/freem/env.conf
! 116: .TP
1.1 snw 117: freem.conf
1.3 ! snw 118: The FreeM configuration file. Normally located in $PREFIX/etc/freem/<environment-name>/freem.conf.
1.1 snw 119: .SH ENVIRONMENT
1.3 ! snw 120: .TP
! 121: \$DISPLAY
! 122: Determines the value of the $PDISPLAY intrinsic special variable. This determines the X11 display used by the M Windowing API. Only applies when FreeM is built with the '--enable-mwapi' configuration option.
! 123: .TP
! 124: \$TERM
! 125: Used by the ^$DEVICE structured system variable to provide the TERMID value for I/O channel 0.
1.1 snw 126: .SH BUGS
1.3 ! snw 127: Check the issue tracker at https://bugs.coherent-logic.com for more detailed information on current bugs.
1.1 snw 128: .SH AUTHOR
129: Provided by Shalom ha-Ashkenaz, 1998/06/18 CE, to the stewardship of the
130: MUG Deutschland. The GUMP (Generic Universal M Project) took over after this point,
1.2 snw 131: and ownership of the original SourceForge project was handed over to Serena Willis of
1.1 snw 132: Coherent Logic Development LLC in 2014.
133: .br
134: The author's identity is a mystery. Can anyone shed light on this?
135: .br
136:
137: .br
138: Man page written by Ron Fox (rfox@dls.queens.org)
139: .br
1.2 snw 140: Maintained and updated by Serena Willis (snw@coherent-logic.com)
1.1 snw 141: .SH COPYRIGHT
142:
143: Copyright (C) 1998 MUG Deutschland
144: .br
1.3 ! snw 145: Copyright (C) 2014. 2021, 2025 Coherent Logic Development LLC
1.1 snw 146:
147: Permission is hereby granted, free of charge, to any person obtaining a copy of
148: this software and associated documentation files (the "Software"), to deal in
149: the Software without restriction, including without limitation the rights to
150: use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
151: of the Software, and to permit persons to whom the Software is furnished to do
152: so, subject to the following conditions:
153:
154: The above copyright notice and this permission notice shall be included in all
155: copies or substantial portions of the Software.
156:
157: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
158: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FIT-
159: NESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
160: MUG DEUTSCHLAND BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
161: AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
162: WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
163:
164: Except as contained in this notice, the name of FreeM shall not
165: be used in advertising or otherwise to promote the sale, use or other dealings
166: in this Software without prior written authorization from Coherent Logic Development
167: LLC.
168: .SH "SEE ALSO"
169: .BR fmadm (8)
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