Return to freem.1 CVS log

Up to [Coherent Logic Development] / freem / doc

Annotation of freem/doc/freem.1, revision 1.2

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: .\"   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
                     22: .\"    Copyright (C) 2020 Coherent Logic Development LLC
                     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: .\"
                     42: .TH freem 1 "20 August 2021" FreeM "FreeM User Manual"
                     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: \-c, --config
                     64: Specify a configuration file other than the default.
                     65: .TP
                     66: \-h, --help
                     67: Display a list of valid FreeM command-line options.
                     68: .TP
                     69: \-i, --import
                     70: Causes your UNIX environment variables to be imported into FreeM's local symbol table.
                     71: .TP
                     72: \-f, --filter
                     73: Allows your MUMPS code to be used as a UNIX filter.
                     74: .TP
                     75: \-n <NAMESPACE>, --namespace=<NAMESPACE>
                     76: Selects <NAMESPACE> as the startup namespace instead of USER.
                     77: .TP
                     78: \-q, --quiet
                     79: Disables startup messages and direct-mode prompt string.
                     80: .TP
                     81: \-r <ENTRY^ROUTINE>, --routine=<ENTRY^ROUTINE>
                     82: Causes <ENTRY^ROUTINE> to be executed at startup, instead of ^%ZFREEM.
                     83: .TP
                     84: \-v, --version
                     85: Displays FreeM version information.
                     86: .TP
                     87: \-x <MCODE>, --execute=<MCODE>
                     88: Executes M code <MCODE> at startup, instead of ^%ZFREEM.
                     89: .SH "RETURN VALUES"
                     90: Returns 0 for non-error condition.
                     91: .SH FILES
                     92: .TP
                     93: freem.conf
                     94: The FreeM configuration file. Normally located in $PREFIX/etc/freem.conf.
                     95: .SH ENVIRONMENT
                     96: There may be some environment variables that affect the operation of these programs.
                     97: .SH BUGS
                     98: Check the issue tracker at https://gitlab.coherent-logic.com/jpw/freem for more detailed information on current bugs.
                     99: .SH AUTHOR
                    100: Provided by Shalom ha-Ashkenaz, 1998/06/18 CE, to the stewardship of the
                    101: MUG Deutschland. The GUMP (Generic Universal M Project) took over after this point,
1.2     ! snw       102: and ownership of the original SourceForge project was handed over to Serena Willis of
1.1       snw       103: Coherent Logic Development LLC in 2014.
                    104: .br
                    105: The author's identity is a mystery.  Can anyone shed light on this?
                    106: .br
                    107: 
                    108: .br
                    109: Man page written by Ron Fox (rfox@dls.queens.org)
                    110: .br
1.2     ! snw       111: Maintained and updated by Serena Willis (snw@coherent-logic.com)
1.1       snw       112: .SH COPYRIGHT
                    113: 
                    114: Copyright (C) 1998 MUG Deutschland
                    115: .br
                    116: Copyright (C) 2014-2021 Coherent Logic Development LLC
                    117: 
                    118: Permission is hereby granted, free of charge, to any person obtaining a copy of
                    119: this software and associated documentation files (the "Software"), to deal in
                    120: the Software without restriction, including without limitation the rights to
                    121: use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
                    122: of the Software, and to permit persons to whom the Software is furnished to do
                    123: so, subject to the following conditions:
                    124: 
                    125: The above copyright notice and this permission notice shall be included in all
                    126: copies or substantial portions of the Software.
                    127: 
                    128: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
                    129: IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FIT-
                    130: NESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
                    131: MUG DEUTSCHLAND BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
                    132: AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
                    133: WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
                    134: 
                    135: Except as contained in this notice, the name of FreeM shall not
                    136: be used in advertising or otherwise to promote the sale, use or other dealings
                    137: in this Software without prior written authorization from Coherent Logic Development
                    138: LLC.
                    139: .SH "SEE ALSO"
                    140: .BR fmadm (8)