--- freem/doc/freem.1 2025/01/19 02:04:04 1.1.1.1 +++ freem/doc/freem.1 2025/04/03 15:56:41 1.4 @@ -2,36 +2,24 @@ .\" 1) Install this file along with the other subject.1 files in your .\" system's man1 directory (usually this is /usr/man/man1) and .\" enter the command: -.\" man mumps +.\" man freem .\" or .\" 2) Specify the input (this file) and the output (your favorite pager) .\" explicitly. For example, if this file is in your current working .\" directory, you can use the following to view the formatted man page .\" using the "less" pager: -.\" man ./mumps.1 | less +.\" man ./freem.1 | less .\" .\" To print this man page to a PostScript printer: -.\" man -t ./mumps.1 | lpr +.\" man -t ./freem.1 | lpr .\" -.\" * -.\" * * -.\" * * -.\" *************** -.\" * * * * -.\" * MUMPS * -.\" * * * * -.\" *************** -.\" * * -.\" * * -.\" * -.\" -.\" freem.1 +.\" $Id: freem.1,v 1.4 2025/04/03 15:56:41 snw Exp $ .\" FreeM man page .\" .\" -.\" Author: John P. Willis +.\" Author: Serena Willis .\" Copyright (C) 1998 MUG Deutschland -.\" Copyright (C) 2020 Coherent Logic Development LLC +.\" Copyright (C) 2020, 2025 Coherent Logic Development LLC .\" .\" .\" This file is part of FreeM. @@ -49,9 +37,12 @@ .\" You should have received a copy of the GNU Affero Public License .\" along with FreeM. If not, see . .\" +.\" $Log: freem.1,v $ +.\" Revision 1.4 2025/04/03 15:56:41 snw +.\" Add fmadm man page to CVS .\" .\" -.TH freem 1 "20 August 2021" FreeM "FreeM User Manual" +.TH freem 1 "3 April 2025" FreeM "FreeM User Manual" .SH NAME freem .SH SYNOPSIS @@ -72,46 +63,75 @@ More information is available at https:/ Please see the FreeM texinfo documentation for language, database, and administration details ("info freem"). .SH OPTIONS .TP -\-c, --config -Specify a configuration file other than the default. -.TP \-h, --help -Display a list of valid FreeM command-line options. +Display a list of freem command-line flags .TP \-i, --import -Causes your UNIX environment variables to be imported into FreeM's local symbol table. +Imports UNIX environment variables as M locals +.TP +\-e , --environment= +Sets active environment to (DEFAULT if unspecified) .TP \-f, --filter -Allows your MUMPS code to be used as a UNIX filter. +Allows M code to be used as a filter .TP \-n , --namespace= -Selects as the startup namespace instead of USER. +Selects as the startup namespace instead of USER .TP \-q, --quiet -Disables startup messages and direct-mode prompt string. +Sisables startup messages and prompt string .TP -\-r , --routine= -Causes to be executed at startup, instead of ^%ZFREEM. +\-r , --routine= +Executes on startup instead of entering direct mode +\-s , --standard= +Restricts access to FreeM vendor extensions not present in relevant standards*. In this flag, can be: + - M77 + - M84 + - M90 + - M95 + - MDS + - M5 + - FREEM .TP \-v, --version -Displays FreeM version information. +Display FreeM version information .TP \-x , --execute= -Executes M code at startup, instead of ^%ZFREEM. +Execute M code on startup +.TP +\-d, --daemon +Run the FreeM daemon (one and only one FreeM daemon must always be running for each configured environment) +.TP +\-k, --nofork +Run the FreeM daemon in foreground (requires --daemon) +.TP +\-S , --shmsize= +Sets the size of the shared memory segment where FreeM stores the job table, lock table, and IPC table. + - Each concurrent job takes 1024 bytes (1 page) of shared memory + - Each LOCK takes 2048 bytes (2 pages) of shared memory + - Each IPC takes 1024 bytes (1 page) of shared memory .SH "RETURN VALUES" Returns 0 for non-error condition. .SH FILES .TP +env.conf +The FreeM environment catalog. Normally located in $PREFIX/etc/freem/env.conf +.TP freem.conf -The FreeM configuration file. Normally located in $PREFIX/etc/freem.conf. +The FreeM configuration file. Normally located in $PREFIX/etc/freem//freem.conf. .SH ENVIRONMENT -There may be some environment variables that affect the operation of these programs. +.TP +\$DISPLAY +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. +.TP +\$TERM +Used by the ^$DEVICE structured system variable to provide the TERMID value for I/O channel 0. .SH BUGS -Check the issue tracker at https://gitlab.coherent-logic.com/jpw/freem for more detailed information on current bugs. +Check the issue tracker at https://bugs.coherent-logic.com for more detailed information on current bugs. .SH AUTHOR Provided by Shalom ha-Ashkenaz, 1998/06/18 CE, to the stewardship of the MUG Deutschland. The GUMP (Generic Universal M Project) took over after this point, -and ownership of the original SourceForge project was handed over to John Willis of +and ownership of the original SourceForge project was handed over to Serena Willis of Coherent Logic Development LLC in 2014. .br The author's identity is a mystery. Can anyone shed light on this? @@ -120,33 +140,14 @@ The author's identity is a mystery. Can .br Man page written by Ron Fox (rfox@dls.queens.org) .br -Maintained and updated by John P. Willis (jpw@coherent-logic.com) +Maintained and updated by Serena Willis (snw@coherent-logic.com) .SH COPYRIGHT Copyright (C) 1998 MUG Deutschland .br -Copyright (C) 2014-2021 Coherent Logic Development LLC +Copyright (C) 2025 Coherent Logic Development LLC + +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. -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies -of the Software, and to permit persons to whom the Software is furnished to do -so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FIT- -NESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -MUG DEUTSCHLAND BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN -AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -Except as contained in this notice, the name of FreeM shall not -be used in advertising or otherwise to promote the sale, use or other dealings -in this Software without prior written authorization from Coherent Logic Development -LLC. .SH "SEE ALSO" .BR fmadm (8)