Annotation of freem/doc/freem.1, revision 1.5
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.5 ! snw 16: .\" $Id: freem.1,v 1.4 2025/04/03 15:56:41 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 $
! 41: .\" Revision 1.4 2025/04/03 15:56:41 snw
! 42: .\" Add fmadm man page to CVS
! 43: .\"
1.1 snw 44: .\"
1.3 snw 45: .TH freem 1 "3 April 2025" FreeM "FreeM User Manual"
1.1 snw 46: .SH NAME
47: freem
48: .SH SYNOPSIS
49: .B freem [OPTION...]
50: .SH DESCRIPTION
51: The
52: .B freem
53: program runs an instance of
54: .IR "FreeM"
55: \.
56:
57: 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.
58:
59: 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.
60:
61: More information is available at https://freem.coherent-logic.com/
62:
63: Please see the FreeM texinfo documentation for language, database, and administration details ("info freem").
64: .SH OPTIONS
65: .TP
66: \-h, --help
1.3 snw 67: Display a list of freem command-line flags
1.1 snw 68: .TP
69: \-i, --import
1.3 snw 70: Imports UNIX environment variables as M locals
71: .TP
72: \-e <environment-name>, --environment=<environment-name>
73: Sets active environment to <environment-name> (DEFAULT if unspecified)
1.1 snw 74: .TP
75: \-f, --filter
1.3 snw 76: Allows M code to be used as a filter
1.1 snw 77: .TP
78: \-n <NAMESPACE>, --namespace=<NAMESPACE>
1.3 snw 79: Selects <NAMESPACE> as the startup namespace instead of USER
1.1 snw 80: .TP
81: \-q, --quiet
1.3 snw 82: Sisables startup messages and prompt string
1.1 snw 83: .TP
1.3 snw 84: \-r <LABEL^ROUTINE>, --routine=<LABEL^ROUTINE>
85: Executes <LABEL^ROUTINE> on startup instead of entering direct mode
86: \-s <standard>, --standard=<standard>
87: Restricts access to FreeM vendor extensions not present in relevant standards*. In this flag, <standard> can be:
88: - M77
89: - M84
90: - M90
91: - M95
92: - MDS
93: - M5
94: - FREEM
1.1 snw 95: .TP
96: \-v, --version
1.3 snw 97: Display FreeM version information
1.1 snw 98: .TP
99: \-x <MCODE>, --execute=<MCODE>
1.3 snw 100: Execute M code <MCODE> on startup
101: .TP
102: \-d, --daemon
103: Run the FreeM daemon (one and only one FreeM daemon must always be running for each configured environment)
104: .TP
105: \-k, --nofork
106: Run the FreeM daemon in foreground (requires --daemon)
107: .TP
108: \-S <BYTES>, --shmsize=<BYTES>
109: Sets the size of the shared memory segment where FreeM stores the job table, lock table, and IPC table.
110: - Each concurrent job takes 1024 bytes (1 page) of shared memory
111: - Each LOCK takes 2048 bytes (2 pages) of shared memory
112: - Each IPC takes 1024 bytes (1 page) of shared memory
1.1 snw 113: .SH "RETURN VALUES"
114: Returns 0 for non-error condition.
115: .SH FILES
116: .TP
1.3 snw 117: env.conf
118: The FreeM environment catalog. Normally located in $PREFIX/etc/freem/env.conf
119: .TP
1.1 snw 120: freem.conf
1.3 snw 121: The FreeM configuration file. Normally located in $PREFIX/etc/freem/<environment-name>/freem.conf.
1.1 snw 122: .SH ENVIRONMENT
1.3 snw 123: .TP
1.5 ! snw 124: $DISPLAY
1.3 snw 125: 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.
126: .TP
1.5 ! snw 127: $TERM
1.3 snw 128: Used by the ^$DEVICE structured system variable to provide the TERMID value for I/O channel 0.
1.1 snw 129: .SH BUGS
1.3 snw 130: Check the issue tracker at https://bugs.coherent-logic.com for more detailed information on current bugs.
1.1 snw 131: .SH AUTHOR
132: Provided by Shalom ha-Ashkenaz, 1998/06/18 CE, to the stewardship of the
133: MUG Deutschland. The GUMP (Generic Universal M Project) took over after this point,
1.2 snw 134: and ownership of the original SourceForge project was handed over to Serena Willis of
1.1 snw 135: Coherent Logic Development LLC in 2014.
136: .br
137: The author's identity is a mystery. Can anyone shed light on this?
138: .br
139:
140: .br
141: Man page written by Ron Fox (rfox@dls.queens.org)
142: .br
1.2 snw 143: Maintained and updated by Serena Willis (snw@coherent-logic.com)
1.1 snw 144: .SH COPYRIGHT
145:
146: Copyright (C) 1998 MUG Deutschland
147: .br
1.4 snw 148: Copyright (C) 2025 Coherent Logic Development LLC
149:
150: 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 151:
152: .SH "SEE ALSO"
153: .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