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

Diff for /freem/doc/freem.1 between versions 1.3 and 1.6

version 1.3, 2025/04/03 15:51:20 version 1.6, 2025/04/17 15:08:24
Line 13 Line 13
 .\" To print this man page to a PostScript printer:  .\" To print this man page to a PostScript printer:
 .\"   man -t ./freem.1 | lpr  .\"   man -t ./freem.1 | lpr
 .\"  .\"
 .\"   freem.1  .\"   $Id$
 .\"    FreeM man page  .\"    FreeM man page
 .\"  .\"
 .\"    .\"  
Line 37 Line 37
 .\"   You should have received a copy of the GNU Affero Public License  .\"   You should have received a copy of the GNU Affero Public License
 .\"   along with FreeM.  If not, see <https://www.gnu.org/licenses/>.  .\"   along with FreeM.  If not, see <https://www.gnu.org/licenses/>.
 .\"  .\"
   .\"   $Log$
   .\"   Revision 1.6  2025/04/17 15:08:24  snw
   .\"   Add documentation on FREEM_LOG_THRESHOLD environment variables to man pages
   .\"
   .\"   Revision 1.5  2025/04/04 12:49:19  snw
   .\"   Dollar signs cut off in ENVIRONMENT sections of both man pages
   .\"
   .\"   Revision 1.4  2025/04/03 15:56:41  snw
   .\"   Add fmadm man page to CVS
 .\"  .\"
 .\"  .\"
 .TH freem 1 "3 April 2025" FreeM "FreeM User Manual"  .TH freem 1 "3 April 2025" FreeM "FreeM User Manual"
Line 118  freem.conf Line 127  freem.conf
 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.
 .SH ENVIRONMENT  .SH ENVIRONMENT
 .TP  .TP
 \$DISPLAY  $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.  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  .TP
 \$TERM  $TERM
 Used by the ^$DEVICE structured system variable to provide the TERMID value for I/O channel 0.  Used by the ^$DEVICE structured system variable to provide the TERMID value for I/O channel 0.
   .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".
   .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".
   .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".
   .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.
   
   Valid values for each of these environment variables are as follows:
   .TP
   debug
   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.
   .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.
   .TP
   warning
   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.
   .TP
   error
   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.
   .TP
   fatal
   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.
   
 .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 142  Maintained and updated by Serena Willis Line 180  Maintained and updated by Serena Willis
   
 Copyright (C) 1998 MUG Deutschland  Copyright (C) 1998 MUG Deutschland
 .br  .br
 Copyright (C) 2014. 2021, 2025 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"  .SH "SEE ALSO"
 .BR fmadm (8)  .BR fmadm (8)
Removed from v.1.3  
changed lines
  Added in v.1.6

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