Annotation of freem/doc/fmadm.8, revision 1.4
1.1 snw 1: .\" To display this man page, either:
2: .\" 1) Install this file along with the other subject.8 files in your
3: .\" system's man1 directory (usually this is /usr/man/man18) and
4: .\" enter the command:
5: .\" man fmadm
6: .\" or
7: .\" 2) Specify the input (this file) and the output (your favorite pager)
8: .\" explicitly. For example, if this file is in your current working
9: .\" directory, you can use the following to view the formatted man page
10: .\" using the "less" pager:
11: .\" man ./fmadm.8 | less
12: .\"
13: .\" To print this man page to a PostScript printer:
14: .\" man -t ./fmadm.8 | lpr
15: .\"
1.4 ! snw 16: .\" $Id: fmadm.8,v 1.3 2025/04/17 15:08:24 snw Exp $
1.1 snw 17: .\" fmadm man page
18: .\"
19: .\"
20: .\" Author: Serena Willis <snw@coherent-logic.com>
21: .\" Copyright (C) 2025 Coherent Logic Development LLC
22: .\"
23: .\"
24: .\" This file is part of FreeM.
25: .\"
26: .\" FreeM is free software: you can redistribute it and/or modify
27: .\" it under the terms of the GNU Affero Public License as published by
28: .\" the Free Software Foundation, either version 3 of the License, or
29: .\" (at your option) any later version.
30: .\"
31: .\" FreeM is distributed in the hope that it will be useful,
32: .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
33: .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
34: .\" GNU Affero Public License for more details.
35: .\"
36: .\" You should have received a copy of the GNU Affero Public License
37: .\" along with FreeM. If not, see <https://www.gnu.org/licenses/>.
38: .\"
1.2 snw 39: .\" $Log: fmadm.8,v $
1.4 ! snw 40: .\" Revision 1.3 2025/04/17 15:08:24 snw
! 41: .\" Add documentation on FREEM_LOG_THRESHOLD environment variables to man pages
! 42: .\"
1.3 snw 43: .\" Revision 1.2 2025/04/04 12:49:19 snw
44: .\" Dollar signs cut off in ENVIRONMENT sections of both man pages
45: .\"
1.2 snw 46: .\" Revision 1.1 2025/04/03 15:56:41 snw
47: .\" Add fmadm man page to CVS
48: .\"
1.1 snw 49: .\"
50: .TH fmadm 8 "3 April 2025" FreeM "FreeM User Manual"
51: .SH NAME
52: fmadm
53: .SH SYNOPSIS
1.2 snw 54: fmadm <action> <object> [-e=<environment] [-n=<namespace>] [OPTIONS]
1.1 snw 55:
56: fmadm configure [-e=<environment] [-n=<namespace>] [-u=<user>] [-g=<group>] [-E=true|false]
57:
58: fmadm reconfigure [-e=<environment] [-n=<namespace>] [-u=<user>] [-g=<group>] [-E=true|false]
59:
60: <action> can be one of:
61: list, examine, verify, remove, import, export, backup, restore,
62: edit, start, stop, restart, status
63:
64: <object> can be one of:
65: lock, journal, namespace, global, routine, job,
66: environment
67:
68: Running fmadm with no command-line arguments will start the interactive mode.
69: .SH DESCRIPTION
70: The
71: .B fmadm
72: program is a systems administration tool used by FreeM operators to manage their environments.
73:
74: Please see the FreeM texinfo documentation for more details ("info freem").
75: .SH FLAGS
76: Please note that fmadm flags MUST consist of a hyphen, the letter representing the flag, an equal sign, and the value for the flag.
77:
78: A valid flag looks like this:
79:
80: \-e=DEFAULT
81:
82: Spaces surrounding the equal sign, or a space in lieu of the equal sign, are
83: invalid syntax.
84:
85: .TP
86: \-e
1.4 ! snw 87: .RS 4
! 88: Sets the environment to be acted upon in this fmadm session.
! 89: \fIDEFAULT\fR
! 90: is assumed if this flag is not provided.
! 91: .RE
1.1 snw 92: .TP
93: \-n
1.4 ! snw 94: .RS 4
! 95: Sets the namespace to be acted upon in this fmadm session.
! 96: \fISYSTEM\fR
! 97: is assumed if this flag is not provided.
! 98: .RE
1.1 snw 99: .TP
100: \-u
1.4 ! snw 101: .RS 4
! 102: Sets the owning UNIX account of the environment.
! 103: \fIfreem\fR
! 104: is assumed if this flag is not provided. The UNIX account must already exist on your system. Applies only to
! 105: \fIfmadm configure\fR
! 106: and
! 107: \fIfmadm reconfigure\fR.
! 108: .RE
1.1 snw 109: .TP
110: \-g
1.4 ! snw 111: .RS 4
! 112: Sets the owning UNIX group of the environment.
! 113: \fIfreem\fR
! 114: is assumed if this flag is not provided. The UNIX group must already exist on your system. Applies only to
! 115: \fIfmadm configure\fR
! 116: and
! 117: \fIfmadm reconfigure\fR.
! 118: .RE
1.1 snw 119: .TP
120: \-E
1.4 ! snw 121: .RS 4
! 122: Enables or disables an environment. Valid values are
! 123: \fItrue\fR
! 124: and
! 125: \fIfalse\fR.
! 126: \fItrue\fR
! 127: is assumed if this flag is not provided. Applies only to
! 128: \fIfmadm configure\fR
! 129: and
! 130: \fIfmadm reconfigure\fR.
! 131: .RE
1.1 snw 132: .SH ACTIONS
133: .TP
134: configure
1.4 ! snw 135: .RS 4
! 136: Configures an environment. No object will be used with this action. Instead, the
! 137: \fI-e\fR,
! 138: \fI-u\fR,
! 139: \fI-g\fR, and
! 140: \fI-E\fR flags will be referenced.
! 141: .RE
1.1 snw 142: .TP
143: reconfigure
1.4 ! snw 144: .RS 4
! 145: Reconfigures an environment. No object will be used with this action. Instead, the
! 146: \fI-e\fR,
! 147: \fI-u\fR,
! 148: \fI-g\fR, and
! 149: \fI-E\fR flags will be referenced.
! 150: .RE
1.1 snw 151: .TP
152: list
1.4 ! snw 153: .RS 4
! 154: Generates a list of <object>s. Applies to
! 155: \fIlock\fR,
! 156: \fIroutine\fR,
! 157: \fIglobal\fR, and job.
! 158: .RE
1.1 snw 159: .TP
160: examine
1.4 ! snw 161: .RS 4
! 162: Examines a specific instance of
! 163: \fI<object>\fR. Applies to
! 164: \fIroutine\fR,
! 165: \fIglobal\fR,
! 166: \fIjob\fR, and
! 167: \fIjournal\fR.
! 168: .RE
1.1 snw 169: .TP
170: verify
1.4 ! snw 171: .RS 4
! 172: Verifies the integrity of
! 173: \fI<object>\fR. Applies to
! 174: \fIglobal\fR.
! 175: .RE
1.1 snw 176: .TP
177: remove
1.4 ! snw 178: .RS 4
! 179: Removes an instance of
! 180: \fI<object>\fR. Applies to
! 181: \fIjob\fR,
! 182: \fIlock\fR,
! 183: \fIroutine\fR, and
! 184: \fIglobal\fR.
! 185: .RE
1.1 snw 186: .TP
187: import
1.4 ! snw 188: .RS 4
! 189: Imports an instance of
! 190: \fI<object>\fR. Applies to
! 191: \fIroutine\fR (imports routine archives in RO/RSA format).
! 192: .RE
1.1 snw 193: .TP
194: export
1.4 ! snw 195: .RS 4
! 196: Exports an instance of
! 197: \fI<object>\fR. Applies to
! 198: \fIroutine\fR (exports routine archives in RO/RSA format).
! 199: .RE
1.1 snw 200: .TP
201: backup
1.4 ! snw 202: .RS 4
! 203: Backs up an instance of
! 204: \fI<object>\fR. Applies to
! 205: \fIroutine\fR.
! 206: .RE
1.1 snw 207: .TP
208: restore
1.4 ! snw 209: .RS 4
! 210: Restores an instance of
! 211: \fI<object>\fR. Applies to
! 212: \fIjournal\fR (plays back after-image journals).
! 213: .RE
1.1 snw 214: .TP
215: edit
1.4 ! snw 216: .RS 4
! 217: Edits an
! 218: \fI<object>\fR. Applies to
! 219: \fIroutine\fR (will open the routine in
! 220: \fI$EDITOR\fR) and
! 221: \fIglobal\fR (will open the interactive global editor).
! 222: .RE
1.1 snw 223: .TP
224: start
1.4 ! snw 225: .RS 4
! 226: Starts one environment, multiple environments, or all environments. Applies to
! 227: \fIenvironment\fR.
! 228: .RE
1.1 snw 229: .TP
230: stop
1.4 ! snw 231: .RS 4
! 232: Stops one environment, multiple environments, or all environments. Applies to
! 233: \fIenvironment\fR.
! 234: .RE
1.1 snw 235: .TP
236: restart
1.4 ! snw 237: .RS 4
! 238: Restarts one environment, multiple environments, or all environments. Applies to
! 239: \fIenvironment\fR.
! 240: .RE
1.1 snw 241: .TP
242: status
1.4 ! snw 243: .RS 4
! 244: Gets the status of one environment, multiple environments, or all environments. Applies to
! 245: \fIenvironment\fR.
! 246: .RE
1.1 snw 247: .SH "FURTHER INFORMATION"
248: Please note that the primary documentation for FreeM is the 'info' manual, accessed with the following command:
249:
1.4 ! snw 250: \fIinfo freem\fR
1.1 snw 251:
252: These manual pages are minimal, and maintained on a strictly best-effort basis.
253: .SH "RETURN VALUES"
254: Returns 0 for non-error condition.
255: .SH FILES
256: .TP
257: env.conf
1.4 ! snw 258: .RS 4
1.1 snw 259: The FreeM environment catalog. Normally located in $PREFIX/etc/freem/env.conf
1.4 ! snw 260: .RE
1.1 snw 261: .TP
262: freem.conf
1.4 ! snw 263: .RS 4
1.1 snw 264: The FreeM configuration file. Normally located in $PREFIX/etc/freem/<environment-name>/freem.conf.
1.4 ! snw 265: .RE
1.1 snw 266: .SH ENVIRONMENT
267: .TP
1.2 snw 268: $EDITOR
1.4 ! snw 269: .RS 4
! 270: Determines the text editor used by
! 271: \fIedit routine\fR.
! 272: .RE
1.3 snw 273: .TP
274: $FREEM_LOG_THRESHOLD_FILE
1.4 ! snw 275: 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
! 276: \fIinfo\fR.
1.3 snw 277: .TP
278: $FREEM_LOG_THRESHOLD_SYSLOG
279: 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".
280: .TP
281: $FREEM_LOG_THRESHOLD_STDERR
282: 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".
283: .SH LOG THRESHOLD VALUES
284: 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.
285:
286: Valid values for each of these environment variables are as follows:
287: .TP
288: debug
1.4 ! snw 289: .RS 4
1.3 snw 290: 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.
1.4 ! snw 291: .RE
1.3 snw 292: .TP
293: info
1.4 ! snw 294: .RS 4
1.3 snw 295: 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.
1.4 ! snw 296: .RE
1.3 snw 297: .TP
298: warning
1.4 ! snw 299: .RS 4
1.3 snw 300: 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.
1.4 ! snw 301: .RE
1.3 snw 302: .TP
303: error
1.4 ! snw 304: .RS 4
1.3 snw 305: 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.
1.4 ! snw 306: .RE
1.3 snw 307: .TP
308: fatal
1.4 ! snw 309: .RS 4
1.3 snw 310: 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.
1.4 ! snw 311: .RE
! 312: .SH FILES
! 313: .PP
! 314: $PREFIX/etc/freem/env.conf
! 315: .RS 4
! 316: FreeM environment catalog
! 317: .RE
! 318: $PREFIX/etc/freem/<environment-name>/freem.conf
! 319: .RS 4
! 320: FreeM per-environment configuration
! 321: .RE
1.1 snw 322: .SH BUGS
323: Check the issue tracker at https://bugs.coherent-logic.com for more detailed information on current bugs.
324: .SH AUTHOR
325: Authored, maintained and updated by Serena Willis (snw@coherent-logic.com)
326: .SH COPYRIGHT
327: Copyright (C) 2014, 2021, 2025 Coherent Logic Development LLC
328:
329: 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.
330:
331: .SH "SEE ALSO"
1.4 ! snw 332: .PP
! 333: \fBfreem\fR(1),
! 334: \fBenv.conf\fR(5),
! 335: \fBfreem.conf\fR(5)
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to fmadm.8 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Coherent Logic Development] / freem / doc