--- freem/doc/fmadm.8 2025/04/17 15:08:24 1.3 +++ freem/doc/fmadm.8 2025/04/18 01:23:05 1.5 @@ -13,7 +13,7 @@ .\" To print this man page to a PostScript printer: .\" man -t ./fmadm.8 | lpr .\" -.\" $Id: fmadm.8,v 1.3 2025/04/17 15:08:24 snw Exp $ +.\" $Id: fmadm.8,v 1.5 2025/04/18 01:23:05 snw Exp $ .\" fmadm man page .\" .\" @@ -37,6 +37,12 @@ .\" along with FreeM. If not, see . .\" .\" $Log: fmadm.8,v $ +.\" Revision 1.5 2025/04/18 01:23:05 snw +.\" More documentation updates +.\" +.\" Revision 1.4 2025/04/17 17:57:35 snw +.\" Major updates to man pages +.\" .\" Revision 1.3 2025/04/17 15:08:24 snw .\" Add documentation on FREEM_LOG_THRESHOLD environment variables to man pages .\" @@ -84,69 +90,170 @@ invalid syntax. .TP \-e -Sets the environment to be acted upon in this fmadm session. 'DEFAULT' is assumed if this flag is not provided. +.RS 4 +Sets the environment to be acted upon in this fmadm session. +\fIDEFAULT\fR +is assumed if this flag is not provided. +.RE .TP \-n -Sets the namespace to be acted upon in this fmadm session. 'SYSTEM' is assumed if this flag is not provided. +.RS 4 +Sets the namespace to be acted upon in this fmadm session. +\fISYSTEM\fR +is assumed if this flag is not provided. +.RE .TP \-u -Sets the owning UNIX account of the environment. 'freem' is assumed if this flag is not provided. The UNIX account must already exist on your system. Applies only to 'fmadm configure' and 'fmadm reconfigure'. +.RS 4 +Sets the owning UNIX account of the environment. +\fIfreem\fR +is assumed if this flag is not provided. The UNIX account must already exist on your system. Applies only to +\fIfmadm configure\fR +and +\fIfmadm reconfigure\fR. +.RE .TP \-g -Sets the owning UNIX group of the environment. 'freem' is assumed if this flag is not provided. The UNIX group must already exist on your system. Applies only to 'fmadm configure' and 'fmadm reconfigure'. +.RS 4 +Sets the owning UNIX group of the environment. +\fIfreem\fR +is assumed if this flag is not provided. The UNIX group must already exist on your system. Applies only to +\fIfmadm configure\fR +and +\fIfmadm reconfigure\fR. +.RE .TP \-E -Enables or disables an environment. Valid values are 'true' and 'false'. 'true' is assumed if this flag is not provided. Applies only to 'fmadm configure' and 'fmadm reconfigure'. +.RS 4 +Enables or disables an environment. Valid values are +\fItrue\fR +and +\fIfalse\fR. +\fItrue\fR +is assumed if this flag is not provided. Applies only to +\fIfmadm configure\fR +and +\fIfmadm reconfigure\fR. +.RE .SH ACTIONS .TP configure -Configures an environment. No object will be used with this action. Instead, the -e, -u, -g, and -E flags will be referenced. +.RS 4 +Configures an environment. No object will be used with this action. Instead, the +\fI-e\fR, +\fI-u\fR, +\fI-g\fR, and +\fI-E\fR flags will be referenced. +.RE .TP reconfigure -Reconfigures an environment. No object will be used with this action. Instead, the -e, -u, -g, and -E flags will be referenced. +.RS 4 +Reconfigures an environment. No object will be used with this action. Instead, the +\fI-e\fR, +\fI-u\fR, +\fI-g\fR, and +\fI-E\fR flags will be referenced. +.RE .TP list -Generates a list of s. Applies to lock, routine, global, and job. +.RS 4 +Generates a list of s. Applies to +\fIlock\fR, +\fIroutine\fR, +\fIglobal\fR, and job. +.RE .TP examine -Examines a specific instance of . Applies to routine, global, job, and journal. +.RS 4 +Examines a specific instance of +\fI\fR. Applies to +\fIroutine\fR, +\fIglobal\fR, +\fIjob\fR, and +\fIjournal\fR. +.RE .TP verify -Verifies the integrity of . Applies to global. +.RS 4 +Verifies the integrity of +\fI\fR. Applies to +\fIglobal\fR. +.RE .TP remove -Removes an instance of . Applies to job, lock, routine, and global. +.RS 4 +Removes an instance of +\fI\fR. Applies to +\fIjob\fR, +\fIlock\fR, +\fIroutine\fR, and +\fIglobal\fR. +.RE .TP import -Imports an instance of . Applies to routine (imports routine archives in RO/RSA format). +.RS 4 +Imports an instance of +\fI\fR. Applies to +\fIroutine\fR (imports routine archives in RO/RSA format). +.RE .TP export -Exports an instance of . Applies to routine (exports routine archives in RO/RSA format). +.RS 4 +Exports an instance of +\fI\fR. Applies to +\fIroutine\fR (exports routine archives in RO/RSA format). +.RE .TP backup -Backs up an instance of . Applies to routine. +.RS 4 +Backs up an instance of +\fI\fR. Applies to +\fIroutine\fR. +.RE .TP restore -Restores an instance of . Applies to journal (plays back after-image journals). +.RS 4 +Restores an instance of +\fI\fR. Applies to +\fIjournal\fR (plays back after-image journals). +.RE .TP edit -Edits an . Applies to routine (will open the routine in $EDITOR) and global (will open the interactive global editor). +.RS 4 +Edits an +\fI\fR. Applies to +\fIroutine\fR (will open the routine in +\fI$EDITOR\fR) and +\fIglobal\fR (will open the interactive global editor). +.RE .TP start -Starts one environment, multiple environments, or all environments. Applies to environment. +.RS 4 +Starts one environment, multiple environments, or all environments. Applies to +\fIenvironment\fR. +.RE .TP stop -Stops one environment, multiple environments, or all environments. Applies to environmen +.RS 4 +Stops one environment, multiple environments, or all environments. Applies to +\fIenvironment\fR. +.RE .TP restart -Restarts one environment, multiple environments, or all environments. Applies to environment. +.RS 4 +Restarts one environment, multiple environments, or all environments. Applies to +\fIenvironment\fR. +.RE .TP status -Gets the status of one environment, multiple environments, or all environments. Applies to environment. +.RS 4 +Gets the status of one environment, multiple environments, or all environments. Applies to +\fIenvironment\fR. +.RE .SH "FURTHER INFORMATION" Please note that the primary documentation for FreeM is the 'info' manual, accessed with the following command: -info freem +\fIinfo freem\fR These manual pages are minimal, and maintained on a strictly best-effort basis. .SH "RETURN VALUES" @@ -154,43 +261,94 @@ Returns 0 for non-error condition. .SH FILES .TP env.conf +.RS 4 The FreeM environment catalog. Normally located in $PREFIX/etc/freem/env.conf +.RE .TP freem.conf +.RS 4 The FreeM configuration file. Normally located in $PREFIX/etc/freem//freem.conf. +.RE .SH ENVIRONMENT .TP $EDITOR -Determines the text editor used by `edit routine`. +.RS 4 +Determines the text editor used by +\fIedit routine\fR. +.RE .TP $FREEM_LOG_THRESHOLD_FILE -Overrides the configured threshold at which log messages are written to files in /var/log/freem, corresponding to the log_threshold_file environment setting in $PREFIX/etc/env.conf. The default value is "info". +.RS 4 +Overrides the configured threshold at which log messages are written to files in +\fI/var/log/freem\fR, corresponding to the +\fIlog_threshold_file\fR environment setting in +\fI$PREFIX/etc/env.conf\fR. The default value is +\fIinfo\fR. +.RE .TP $FREEM_LOG_THRESHOLD_SYSLOG -Overrides the configured threshold at which log messages are sent to the syslog facility on systems that support it, corresponding to the log_threshold_syslog environment setting in $PREFIX/etc/env.conf. The default value is "info". +.RS 4 +Overrides the configured threshold at which log messages are sent to the +\fIsyslog\fR facility on systems that support it, corresponding to the +\fIlog_threshold_syslog\fR environment setting in +\fI$PREFIX/etc/env.conf\fR. The default value is +\fIinfo\fR. +.RE .TP $FREEM_LOG_THRESHOLD_STDERR -Overrides the configured threshold at which log messages are sent to stderr, corresponding to the log_threshold_stderr environment setting in $PREFIX/etc/env.conf. The default value is "warning". +.RS 4 +Overrides the configured threshold at which log messages are sent to +\fIstderr\fR, corresponding to the +\fIlog_threshold_stderr\fR environment setting in +\fI$PREFIX/etc/env.conf\fR. The default value is +\fIwarning\fR. +.RE .SH LOG THRESHOLD VALUES -This section details the valid values for each of the $FREEM_LOG_THRESHOLD_* environment variables, and each value indicates a minimum diagnostic level at which the indicated class of message will be delivered through the selected mechanism. All messages with an equal or higher diagnostic level than the class indicated will be delivered, i.e., if "warning" is selected, messages with a diagnostic class of warning, error, and fatal will be delivered through the selected mechanism. +This section details the valid values for each of the +\fI$FREEM_LOG_THRESHOLD_*\fR environment variables, and each value indicates a minimum diagnostic level at which the indicated class of message will be delivered through the selected mechanism. All messages with an equal or higher diagnostic level than the class indicated will be delivered, i.e., if +\fIwarning\fR is selected, messages with a diagnostic class of +\fIwarning\fR, +\fIerror\fR, and +\fIfatal\fR will be delivered through the selected mechanism. Valid values for each of these environment variables are as follows: .TP debug +.RS 4 Messages useful mostly for developers contributing to FreeM itself. Will produce a high volume of log messages, and is likely to impact system performance. Not recommended for production usage. +.RE .TP info -Includes messages of an informational nature. Will produce a moderately high volume of log messages. For heavily multi-user and multi-process systems, it is recommended to use "warning" instead. +.RS 4 +Includes messages of an informational nature. Will produce a moderately high volume of log messages. For heavily multi-user and multi-process systems, it is recommended to use +\fIwarning\fR instead. +.RE .TP warning +.RS 4 Includes warning messages. These indicate conditions (including retries when attempting to acquire semaphores) that warrant further investigation by the system operator, but do not typically prevent applications from running. +.RE .TP error +.RS 4 Includes error messages. This class of messages indicates that a recoverable error has occurred in the FreeM engine. Warrants immediate attention by the system operator. +.RE .TP fatal +.RS 4 Includes messages indicating errors that are not recoverable. If this class of message occurs, the process that triggered the message has terminated abnormally. Requires immediate system operator intervention, and can indicate gross misconfiguration of the FreeM engine or the host operating system environment, or even a FreeM bug. - +.RE +.SH FILES +.PP +$PREFIX/etc/freem/env.conf +.RS 4 +FreeM environment catalog +.RE + +$PREFIX/etc/freem//freem.conf +.RS 4 +FreeM per-environment configuration +.RE .SH BUGS Check the issue tracker at https://bugs.coherent-logic.com for more detailed information on current bugs. .SH AUTHOR @@ -201,4 +359,7 @@ Copyright (C) 2014, 2021, 2025 Coherent 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 "SEE ALSO" -.BR freem (1) +.PP +\fBfreem\fR(1), +\fBenv.conf\fR(5), +\fBfreem.conf\fR(5)