Annotation of freem/doc/freem.1, revision 1.1
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 mumps
! 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 ./mumps.1 | less
! 12: .\"
! 13: .\" To print this man page to a PostScript printer:
! 14: .\" man -t ./mumps.1 | lpr
! 15: .\"
! 16: .\" *
! 17: .\" * *
! 18: .\" * *
! 19: .\" ***************
! 20: .\" * * * *
! 21: .\" * MUMPS *
! 22: .\" * * * *
! 23: .\" ***************
! 24: .\" * *
! 25: .\" * *
! 26: .\" *
! 27: .\"
! 28: .\" freem.1
! 29: .\" FreeM man page
! 30: .\"
! 31: .\"
! 32: .\" Author: John P. Willis <jpw@coherent-logic.com>
! 33: .\" Copyright (C) 1998 MUG Deutschland
! 34: .\" Copyright (C) 2020 Coherent Logic Development LLC
! 35: .\"
! 36: .\"
! 37: .\" This file is part of FreeM.
! 38: .\"
! 39: .\" FreeM is free software: you can redistribute it and/or modify
! 40: .\" it under the terms of the GNU Affero Public License as published by
! 41: .\" the Free Software Foundation, either version 3 of the License, or
! 42: .\" (at your option) any later version.
! 43: .\"
! 44: .\" FreeM is distributed in the hope that it will be useful,
! 45: .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
! 46: .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
! 47: .\" GNU Affero Public License for more details.
! 48: .\"
! 49: .\" You should have received a copy of the GNU Affero Public License
! 50: .\" along with FreeM. If not, see <https://www.gnu.org/licenses/>.
! 51: .\"
! 52: .\"
! 53: .\"
! 54: .TH freem 1 "20 August 2021" FreeM "FreeM User Manual"
! 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:
! 72: Please see the FreeM texinfo documentation for language, database, and administration details ("info freem").
! 73: .SH OPTIONS
! 74: .TP
! 75: \-c, --config
! 76: Specify a configuration file other than the default.
! 77: .TP
! 78: \-h, --help
! 79: Display a list of valid FreeM command-line options.
! 80: .TP
! 81: \-i, --import
! 82: Causes your UNIX environment variables to be imported into FreeM's local symbol table.
! 83: .TP
! 84: \-f, --filter
! 85: Allows your MUMPS code to be used as a UNIX filter.
! 86: .TP
! 87: \-n <NAMESPACE>, --namespace=<NAMESPACE>
! 88: Selects <NAMESPACE> as the startup namespace instead of USER.
! 89: .TP
! 90: \-q, --quiet
! 91: Disables startup messages and direct-mode prompt string.
! 92: .TP
! 93: \-r <ENTRY^ROUTINE>, --routine=<ENTRY^ROUTINE>
! 94: Causes <ENTRY^ROUTINE> to be executed at startup, instead of ^%ZFREEM.
! 95: .TP
! 96: \-v, --version
! 97: Displays FreeM version information.
! 98: .TP
! 99: \-x <MCODE>, --execute=<MCODE>
! 100: Executes M code <MCODE> at startup, instead of ^%ZFREEM.
! 101: .SH "RETURN VALUES"
! 102: Returns 0 for non-error condition.
! 103: .SH FILES
! 104: .TP
! 105: freem.conf
! 106: The FreeM configuration file. Normally located in $PREFIX/etc/freem.conf.
! 107: .SH ENVIRONMENT
! 108: There may be some environment variables that affect the operation of these programs.
! 109: .SH BUGS
! 110: Check the issue tracker at https://gitlab.coherent-logic.com/jpw/freem for more detailed information on current bugs.
! 111: .SH AUTHOR
! 112: Provided by Shalom ha-Ashkenaz, 1998/06/18 CE, to the stewardship of the
! 113: MUG Deutschland. The GUMP (Generic Universal M Project) took over after this point,
! 114: and ownership of the original SourceForge project was handed over to John Willis of
! 115: Coherent Logic Development LLC in 2014.
! 116: .br
! 117: The author's identity is a mystery. Can anyone shed light on this?
! 118: .br
! 119:
! 120: .br
! 121: Man page written by Ron Fox (rfox@dls.queens.org)
! 122: .br
! 123: Maintained and updated by John P. Willis (jpw@coherent-logic.com)
! 124: .SH COPYRIGHT
! 125:
! 126: Copyright (C) 1998 MUG Deutschland
! 127: .br
! 128: Copyright (C) 2014-2021 Coherent Logic Development LLC
! 129:
! 130: Permission is hereby granted, free of charge, to any person obtaining a copy of
! 131: this software and associated documentation files (the "Software"), to deal in
! 132: the Software without restriction, including without limitation the rights to
! 133: use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
! 134: of the Software, and to permit persons to whom the Software is furnished to do
! 135: so, subject to the following conditions:
! 136:
! 137: The above copyright notice and this permission notice shall be included in all
! 138: copies or substantial portions of the Software.
! 139:
! 140: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
! 141: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FIT-
! 142: NESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
! 143: MUG DEUTSCHLAND BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
! 144: AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
! 145: WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
! 146:
! 147: Except as contained in this notice, the name of FreeM shall not
! 148: be used in advertising or otherwise to promote the sale, use or other dealings
! 149: in this Software without prior written authorization from Coherent Logic Development
! 150: LLC.
! 151: .SH "SEE ALSO"
! 152: .BR fmadm (8)
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>