--- freem/doc/freem.1 2025/04/17 15:08:24 1.6 +++ freem/doc/freem.1 2025/04/17 17:57:35 1.7 @@ -13,7 +13,7 @@ .\" To print this man page to a PostScript printer: .\" man -t ./freem.1 | lpr .\" -.\" $Id: freem.1,v 1.6 2025/04/17 15:08:24 snw Exp $ +.\" $Id: freem.1,v 1.7 2025/04/17 17:57:35 snw Exp $ .\" FreeM man page .\" .\" @@ -38,6 +38,9 @@ .\" along with FreeM. If not, see . .\" .\" $Log: freem.1,v $ +.\" Revision 1.7 2025/04/17 17:57:35 snw +.\" Major updates to man pages +.\" .\" Revision 1.6 2025/04/17 15:08:24 snw .\" Add documentation on FREEM_LOG_THRESHOLD environment variables to man pages .\" @@ -70,34 +73,134 @@ Please see the FreeM texinfo documentati .SH OPTIONS .TP \-h, --help +.RS 4 Display a list of freem command-line flags +.RE .TP \-i, --import +.RS 4 Imports UNIX environment variables as M locals +.RE .TP \-e , --environment= -Sets active environment to (DEFAULT if unspecified) +.RS 4 +Sets active environment to +\fI\fR; +\fIDEFAULT\fR if unspecified +.RE .TP \-f, --filter +.RS 4 Allows M code to be used as a filter +.RE .TP \-n , --namespace= -Selects as the startup namespace instead of USER +.RS 4 +Selects +\fI\fR as the startup namespace instead of +\fIUSER\fR +.RE .TP \-q, --quiet -Sisables startup messages and prompt string +.RS 4 +Disables startup messages and prompt string +.RE .TP \-r , --routine= -Executes on startup instead of entering direct mode +.RS 4 +Executes +\fI\fR on startup instead of entering direct mode +.RE +.TP \-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 +.RS 4 +Restricts access to FreeM vendor extensions not present in relevant standards +\fI*\fR. In this flag, +\fI\fR can be: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +M77 +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +M84 +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +M90 +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +M95 +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +MDS +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +M5 +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +FREEM + +.RE +\fB*\fR FreeM is not entirely compliant with any MDC standard, regardless of the value of the +\fI--standard\fR command-line flag. + +See the +\fBCompliance Clause\fR on the FreeM Wiki for more information on FreeM's deviations from MDC standards. +.RE .TP \-v, --version Display FreeM version information @@ -183,6 +286,18 @@ Copyright (C) 1998 MUG Deutschland 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. - +.SH FILES +.PP +$PREFIX/etc/freem/env.conf +.RS 4 +FreeM environment catalog +.RE +.PP +$PREFIX/etc/freem//freem.conf +.RS 4 +FreeM per-environment configuration .SH "SEE ALSO" -.BR fmadm (8) +.PP +\fBfmadm\fR(8), +\fBenv.conf\fR(5), +\fBfreem.conf\fR(5)