|
version 1.2, 2025/03/09 15:20:18
|
version 1.3, 2025/04/03 15:51:20
|
|
Line 2
|
Line 2
|
| .\" 1) Install this file along with the other subject.1 files in your |
.\" 1) Install this file along with the other subject.1 files in your |
| .\" system's man1 directory (usually this is /usr/man/man1) and |
.\" system's man1 directory (usually this is /usr/man/man1) and |
| .\" enter the command: |
.\" enter the command: |
| .\" man mumps |
.\" man freem |
| .\" or |
.\" or |
| .\" 2) Specify the input (this file) and the output (your favorite pager) |
.\" 2) Specify the input (this file) and the output (your favorite pager) |
| .\" explicitly. For example, if this file is in your current working |
.\" explicitly. For example, if this file is in your current working |
| .\" directory, you can use the following to view the formatted man page |
.\" directory, you can use the following to view the formatted man page |
| .\" using the "less" pager: |
.\" using the "less" pager: |
| .\" man ./mumps.1 | less |
.\" man ./freem.1 | less |
| .\" |
.\" |
| .\" To print this man page to a PostScript printer: |
.\" To print this man page to a PostScript printer: |
| .\" man -t ./mumps.1 | lpr |
.\" man -t ./freem.1 | lpr |
| .\" |
.\" |
| .\" freem.1 |
.\" freem.1 |
| .\" FreeM man page |
.\" FreeM man page |
|
Line 19
|
Line 19
|
| .\" |
.\" |
| .\" Author: Serena Willis <snw@coherent-logic.com> |
.\" Author: Serena Willis <snw@coherent-logic.com> |
| .\" Copyright (C) 1998 MUG Deutschland |
.\" 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. |
.\" This file is part of FreeM. |
|
Line 39
|
Line 39
|
| .\" |
.\" |
| .\" |
.\" |
| .\" |
.\" |
| .TH freem 1 "20 August 2021" FreeM "FreeM User Manual" |
.TH freem 1 "3 April 2025" FreeM "FreeM User Manual" |
| .SH NAME |
.SH NAME |
| freem |
freem |
| .SH SYNOPSIS |
.SH SYNOPSIS |
|
Line 60 More information is available at https:/
|
Line 60 More information is available at https:/
|
| Please see the FreeM texinfo documentation for language, database, and administration details ("info freem"). |
Please see the FreeM texinfo documentation for language, database, and administration details ("info freem"). |
| .SH OPTIONS |
.SH OPTIONS |
| .TP |
.TP |
| \-c, --config |
|
| Specify a configuration file other than the default. |
|
| .TP |
|
| \-h, --help |
\-h, --help |
| Display a list of valid FreeM command-line options. |
Display a list of freem command-line flags |
| .TP |
.TP |
| \-i, --import |
\-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-name>, --environment=<environment-name> |
| |
Sets active environment to <environment-name> (DEFAULT if unspecified) |
| .TP |
.TP |
| \-f, --filter |
\-f, --filter |
| Allows your MUMPS code to be used as a UNIX filter. |
Allows M code to be used as a filter |
| .TP |
.TP |
| \-n <NAMESPACE>, --namespace=<NAMESPACE> |
\-n <NAMESPACE>, --namespace=<NAMESPACE> |
| Selects <NAMESPACE> as the startup namespace instead of USER. |
Selects <NAMESPACE> as the startup namespace instead of USER |
| .TP |
.TP |
| \-q, --quiet |
\-q, --quiet |
| Disables startup messages and direct-mode prompt string. |
Sisables startup messages and prompt string |
| .TP |
.TP |
| \-r <ENTRY^ROUTINE>, --routine=<ENTRY^ROUTINE> |
\-r <LABEL^ROUTINE>, --routine=<LABEL^ROUTINE> |
| Causes <ENTRY^ROUTINE> to be executed at startup, instead of ^%ZFREEM. |
Executes <LABEL^ROUTINE> on startup instead of entering direct mode |
| |
\-s <standard>, --standard=<standard> |
| |
Restricts access to FreeM vendor extensions not present in relevant standards*. In this flag, <standard> can be: |
| |
- M77 |
| |
- M84 |
| |
- M90 |
| |
- M95 |
| |
- MDS |
| |
- M5 |
| |
- FREEM |
| .TP |
.TP |
| \-v, --version |
\-v, --version |
| Displays FreeM version information. |
Display FreeM version information |
| .TP |
.TP |
| \-x <MCODE>, --execute=<MCODE> |
\-x <MCODE>, --execute=<MCODE> |
| Executes M code <MCODE> at startup, instead of ^%ZFREEM. |
Execute M code <MCODE> 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 <BYTES>, --shmsize=<BYTES> |
| |
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" |
.SH "RETURN VALUES" |
| Returns 0 for non-error condition. |
Returns 0 for non-error condition. |
| .SH FILES |
.SH FILES |
| .TP |
.TP |
| |
env.conf |
| |
The FreeM environment catalog. Normally located in $PREFIX/etc/freem/env.conf |
| |
.TP |
| freem.conf |
freem.conf |
| The FreeM configuration file. Normally located in $PREFIX/etc/freem.conf. |
The FreeM configuration file. Normally located in $PREFIX/etc/freem/<environment-name>/freem.conf. |
| .SH ENVIRONMENT |
.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 |
.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 |
.SH AUTHOR |
| Provided by Shalom ha-Ashkenaz, 1998/06/18 CE, to the stewardship of the |
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, |
MUG Deutschland. The GUMP (Generic Universal M Project) took over after this point, |
|
Line 113 Maintained and updated by Serena Willis
|
Line 142 Maintained and updated by Serena Willis
|
| |
|
| Copyright (C) 1998 MUG Deutschland |
Copyright (C) 1998 MUG Deutschland |
| .br |
.br |
| Copyright (C) 2014-2021 Coherent Logic Development LLC |
Copyright (C) 2014. 2021, 2025 Coherent Logic Development LLC |
| |
|
| Permission is hereby granted, free of charge, to any person obtaining a copy of |
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 |
this software and associated documentation files (the "Software"), to deal in |
![[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