[BACK]Return to fmadm.8 CVS log [TXT] [DIR] Up to [Coherent Logic Development] / freem / doc

Diff for /freem/doc/fmadm.8 between versions 1.3 and 1.4

version 1.3, 2025/04/17 15:08:24 version 1.4, 2025/04/17 17:57:35
Line 37 Line 37
 .\"   along with FreeM.  If not, see <https://www.gnu.org/licenses/>.  .\"   along with FreeM.  If not, see <https://www.gnu.org/licenses/>.
 .\"  .\"
 .\"   $Log$  .\"   $Log$
   .\"   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  .\"   Revision 1.3  2025/04/17 15:08:24  snw
 .\"   Add documentation on FREEM_LOG_THRESHOLD environment variables to man pages  .\"   Add documentation on FREEM_LOG_THRESHOLD environment variables to man pages
 .\"  .\"
Line 84  invalid syntax. Line 87  invalid syntax.
   
 .TP  .TP
 \-e  \-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  .TP
 \-n  \-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  .TP
 \-u  \-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  .TP
 \-g  \-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  .TP
 \-E  \-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  .SH ACTIONS
 .TP  .TP
 configure  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  .TP
 reconfigure  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  .TP
 list  list
 Generates a list of <object>s. Applies to lock, routine, global, and job.  .RS 4
   Generates a list of <object>s. Applies to
   \fIlock\fR,
   \fIroutine\fR,
   \fIglobal\fR, and job.
   .RE
 .TP  .TP
 examine  examine
 Examines a specific instance of <object>. Applies to routine, global, job, and journal.  .RS 4
   Examines a specific instance of
   \fI<object>\fR. Applies to
   \fIroutine\fR,
   \fIglobal\fR,
   \fIjob\fR, and
   \fIjournal\fR.
   .RE
 .TP  .TP
 verify  verify
 Verifies the integrity of <object>. Applies to global.  .RS 4
   Verifies the integrity of
   \fI<object>\fR. Applies to
   \fIglobal\fR.
   .RE
 .TP  .TP
 remove  remove
 Removes an instance of <object>. Applies to job, lock, routine, and global.  .RS 4
   Removes an instance of
   \fI<object>\fR. Applies to
   \fIjob\fR,
   \fIlock\fR,
   \fIroutine\fR, and
   \fIglobal\fR.
   .RE
 .TP  .TP
 import  import
 Imports an instance of <object>. Applies to routine (imports routine archives in RO/RSA format).  .RS 4
   Imports an instance of
   \fI<object>\fR. Applies to
   \fIroutine\fR (imports routine archives in RO/RSA format).
   .RE
 .TP  .TP
 export  export
 Exports an instance of <object>. Applies to routine (exports routine archives in RO/RSA format).  .RS 4
   Exports an instance of
   \fI<object>\fR. Applies to
   \fIroutine\fR (exports routine archives in RO/RSA format).
   .RE
 .TP  .TP
 backup  backup
 Backs up an instance of <object>. Applies to routine.  .RS 4
   Backs up an instance of
   \fI<object>\fR. Applies to
   \fIroutine\fR.
   .RE
 .TP  .TP
 restore  restore
 Restores an instance of <object>. Applies to journal (plays back after-image journals).  .RS 4
   Restores an instance of
   \fI<object>\fR. Applies to
   \fIjournal\fR (plays back after-image journals).
   .RE
 .TP  .TP
 edit  edit
 Edits an <object>. Applies to routine (will open the routine in $EDITOR) and global (will open the interactive global editor).  .RS 4
   Edits an
   \fI<object>\fR. Applies to
   \fIroutine\fR (will open the routine in
   \fI$EDITOR\fR) and
   \fIglobal\fR (will open the interactive global editor).
   .RE
 .TP  .TP
 start  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  .TP
 stop  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  .TP
 restart  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  .TP
 status  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"  .SH "FURTHER INFORMATION"
 Please note that the primary documentation for FreeM is the 'info' manual, accessed with the following command:  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.  These manual pages are minimal, and maintained on a strictly best-effort basis.
 .SH "RETURN VALUES"  .SH "RETURN VALUES"
Line 154  Returns 0 for non-error condition. Line 258  Returns 0 for non-error condition.
 .SH FILES  .SH FILES
 .TP  .TP
 env.conf  env.conf
   .RS 4
 The FreeM environment catalog. Normally located in $PREFIX/etc/freem/env.conf  The FreeM environment catalog. Normally located in $PREFIX/etc/freem/env.conf
   .RE
 .TP  .TP
 freem.conf  freem.conf
   .RS 4
 The FreeM configuration file. Normally located in $PREFIX/etc/freem/<environment-name>/freem.conf.  The FreeM configuration file. Normally located in $PREFIX/etc/freem/<environment-name>/freem.conf.
   .RE
 .SH ENVIRONMENT  .SH ENVIRONMENT
 .TP  .TP
 $EDITOR  $EDITOR
 Determines the text editor used by `edit routine`.  .RS 4
   Determines the text editor used by
   \fIedit routine\fR.
   .RE
 .TP  .TP
 $FREEM_LOG_THRESHOLD_FILE  $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".  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
   \fIinfo\fR.
 .TP  .TP
 $FREEM_LOG_THRESHOLD_SYSLOG  $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".  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".
Line 177  This section details the valid values fo Line 289  This section details the valid values fo
 Valid values for each of these environment variables are as follows:  Valid values for each of these environment variables are as follows:
 .TP  .TP
 debug  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.  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  .TP
 info  info
   .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 "warning" instead.  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.
   .RE
 .TP  .TP
 warning  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.  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  .TP
 error  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.  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  .TP
 fatal  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.  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/<environment-name>/freem.conf
   .RS 4
   FreeM per-environment configuration
   .RE
 .SH BUGS  .SH BUGS
 Check the issue tracker at https://bugs.coherent-logic.com 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
Line 201  Copyright (C) 2014, 2021, 2025 Coherent Line 332  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.  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"  .SH "SEE ALSO"
 .BR freem (1)  .PP
   \fBfreem\fR(1),
   \fBenv.conf\fR(5),
   \fBfreem.conf\fR(5)
Removed from v.1.3  
changed lines
  Added in v.1.4

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>