Annotation of freem/doc/fmadm.8, revision 1.5
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.5 ! snw 16: .\" $Id: fmadm.8,v 1.4 2025/04/17 17:57:35 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.5 ! snw 40: .\" Revision 1.4 2025/04/17 17:57:35 snw
! 41: .\" Major updates to man pages
! 42: .\"
1.4 snw 43: .\" Revision 1.3 2025/04/17 15:08:24 snw
44: .\" Add documentation on FREEM_LOG_THRESHOLD environment variables to man pages
45: .\"
1.3 snw 46: .\" Revision 1.2 2025/04/04 12:49:19 snw
47: .\" Dollar signs cut off in ENVIRONMENT sections of both man pages
48: .\"
1.2 snw 49: .\" Revision 1.1 2025/04/03 15:56:41 snw
50: .\" Add fmadm man page to CVS
51: .\"
1.1 snw 52: .\"
53: .TH fmadm 8 "3 April 2025" FreeM "FreeM User Manual"
54: .SH NAME
55: fmadm
56: .SH SYNOPSIS
1.2 snw 57: fmadm <action> <object> [-e=<environment] [-n=<namespace>] [OPTIONS]
1.1 snw 58:
59: fmadm configure [-e=<environment] [-n=<namespace>] [-u=<user>] [-g=<group>] [-E=true|false]
60:
61: fmadm reconfigure [-e=<environment] [-n=<namespace>] [-u=<user>] [-g=<group>] [-E=true|false]
62:
63: <action> can be one of:
64: list, examine, verify, remove, import, export, backup, restore,
65: edit, start, stop, restart, status
66:
67: <object> can be one of:
68: lock, journal, namespace, global, routine, job,
69: environment
70:
71: Running fmadm with no command-line arguments will start the interactive mode.
72: .SH DESCRIPTION
73: The
74: .B fmadm
75: program is a systems administration tool used by FreeM operators to manage their environments.
76:
77: Please see the FreeM texinfo documentation for more details ("info freem").
78: .SH FLAGS
79: Please note that fmadm flags MUST consist of a hyphen, the letter representing the flag, an equal sign, and the value for the flag.
80:
81: A valid flag looks like this:
82:
83: \-e=DEFAULT
84:
85: Spaces surrounding the equal sign, or a space in lieu of the equal sign, are
86: invalid syntax.
87:
88: .TP
89: \-e
1.4 snw 90: .RS 4
91: Sets the environment to be acted upon in this fmadm session.
92: \fIDEFAULT\fR
93: is assumed if this flag is not provided.
94: .RE
1.1 snw 95: .TP
96: \-n
1.4 snw 97: .RS 4
98: Sets the namespace to be acted upon in this fmadm session.
99: \fISYSTEM\fR
100: is assumed if this flag is not provided.
101: .RE
1.1 snw 102: .TP
103: \-u
1.4 snw 104: .RS 4
105: Sets the owning UNIX account of the environment.
106: \fIfreem\fR
107: is assumed if this flag is not provided. The UNIX account must already exist on your system. Applies only to
108: \fIfmadm configure\fR
109: and
110: \fIfmadm reconfigure\fR.
111: .RE
1.1 snw 112: .TP
113: \-g
1.4 snw 114: .RS 4
115: Sets the owning UNIX group of the environment.
116: \fIfreem\fR
117: is assumed if this flag is not provided. The UNIX group must already exist on your system. Applies only to
118: \fIfmadm configure\fR
119: and
120: \fIfmadm reconfigure\fR.
121: .RE
1.1 snw 122: .TP
123: \-E
1.4 snw 124: .RS 4
125: Enables or disables an environment. Valid values are
126: \fItrue\fR
127: and
128: \fIfalse\fR.
129: \fItrue\fR
130: is assumed if this flag is not provided. Applies only to
131: \fIfmadm configure\fR
132: and
133: \fIfmadm reconfigure\fR.
134: .RE
1.1 snw 135: .SH ACTIONS
136: .TP
137: configure
1.4 snw 138: .RS 4
139: Configures an environment. No object will be used with this action. Instead, the
140: \fI-e\fR,
141: \fI-u\fR,
142: \fI-g\fR, and
143: \fI-E\fR flags will be referenced.
144: .RE
1.1 snw 145: .TP
146: reconfigure
1.4 snw 147: .RS 4
148: Reconfigures an environment. No object will be used with this action. Instead, the
149: \fI-e\fR,
150: \fI-u\fR,
151: \fI-g\fR, and
152: \fI-E\fR flags will be referenced.
153: .RE
1.1 snw 154: .TP
155: list
1.4 snw 156: .RS 4
157: Generates a list of <object>s. Applies to
158: \fIlock\fR,
159: \fIroutine\fR,
160: \fIglobal\fR, and job.
161: .RE
1.1 snw 162: .TP
163: examine
1.4 snw 164: .RS 4
165: Examines a specific instance of
166: \fI<object>\fR. Applies to
167: \fIroutine\fR,
168: \fIglobal\fR,
169: \fIjob\fR, and
170: \fIjournal\fR.
171: .RE
1.1 snw 172: .TP
173: verify
1.4 snw 174: .RS 4
175: Verifies the integrity of
176: \fI<object>\fR. Applies to
177: \fIglobal\fR.
178: .RE
1.1 snw 179: .TP
180: remove
1.4 snw 181: .RS 4
182: Removes an instance of
183: \fI<object>\fR. Applies to
184: \fIjob\fR,
185: \fIlock\fR,
186: \fIroutine\fR, and
187: \fIglobal\fR.
188: .RE
1.1 snw 189: .TP
190: import
1.4 snw 191: .RS 4
192: Imports an instance of
193: \fI<object>\fR. Applies to
194: \fIroutine\fR (imports routine archives in RO/RSA format).
195: .RE
1.1 snw 196: .TP
197: export
1.4 snw 198: .RS 4
199: Exports an instance of
200: \fI<object>\fR. Applies to
201: \fIroutine\fR (exports routine archives in RO/RSA format).
202: .RE
1.1 snw 203: .TP
204: backup
1.4 snw 205: .RS 4
206: Backs up an instance of
207: \fI<object>\fR. Applies to
208: \fIroutine\fR.
209: .RE
1.1 snw 210: .TP
211: restore
1.4 snw 212: .RS 4
213: Restores an instance of
214: \fI<object>\fR. Applies to
215: \fIjournal\fR (plays back after-image journals).
216: .RE
1.1 snw 217: .TP
218: edit
1.4 snw 219: .RS 4
220: Edits an
221: \fI<object>\fR. Applies to
222: \fIroutine\fR (will open the routine in
223: \fI$EDITOR\fR) and
224: \fIglobal\fR (will open the interactive global editor).
225: .RE
1.1 snw 226: .TP
227: start
1.4 snw 228: .RS 4
229: Starts one environment, multiple environments, or all environments. Applies to
230: \fIenvironment\fR.
231: .RE
1.1 snw 232: .TP
233: stop
1.4 snw 234: .RS 4
235: Stops one environment, multiple environments, or all environments. Applies to
236: \fIenvironment\fR.
237: .RE
1.1 snw 238: .TP
239: restart
1.4 snw 240: .RS 4
241: Restarts one environment, multiple environments, or all environments. Applies to
242: \fIenvironment\fR.
243: .RE
1.1 snw 244: .TP
245: status
1.4 snw 246: .RS 4
247: Gets the status of one environment, multiple environments, or all environments. Applies to
248: \fIenvironment\fR.
249: .RE
1.1 snw 250: .SH "FURTHER INFORMATION"
251: Please note that the primary documentation for FreeM is the 'info' manual, accessed with the following command:
252:
1.4 snw 253: \fIinfo freem\fR
1.1 snw 254:
255: These manual pages are minimal, and maintained on a strictly best-effort basis.
256: .SH "RETURN VALUES"
257: Returns 0 for non-error condition.
258: .SH FILES
259: .TP
260: env.conf
1.4 snw 261: .RS 4
1.1 snw 262: The FreeM environment catalog. Normally located in $PREFIX/etc/freem/env.conf
1.4 snw 263: .RE
1.1 snw 264: .TP
265: freem.conf
1.4 snw 266: .RS 4
1.1 snw 267: The FreeM configuration file. Normally located in $PREFIX/etc/freem/<environment-name>/freem.conf.
1.4 snw 268: .RE
1.1 snw 269: .SH ENVIRONMENT
270: .TP
1.2 snw 271: $EDITOR
1.4 snw 272: .RS 4
273: Determines the text editor used by
274: \fIedit routine\fR.
275: .RE
1.3 snw 276: .TP
277: $FREEM_LOG_THRESHOLD_FILE
1.5 ! snw 278: .RS 4
! 279: Overrides the configured threshold at which log messages are written to files in
! 280: \fI/var/log/freem\fR, corresponding to the
! 281: \fIlog_threshold_file\fR environment setting in
! 282: \fI$PREFIX/etc/env.conf\fR. The default value is
1.4 snw 283: \fIinfo\fR.
1.5 ! snw 284: .RE
1.3 snw 285: .TP
286: $FREEM_LOG_THRESHOLD_SYSLOG
1.5 ! snw 287: .RS 4
! 288: Overrides the configured threshold at which log messages are sent to the
! 289: \fIsyslog\fR facility on systems that support it, corresponding to the
! 290: \fIlog_threshold_syslog\fR environment setting in
! 291: \fI$PREFIX/etc/env.conf\fR. The default value is
! 292: \fIinfo\fR.
! 293: .RE
1.3 snw 294: .TP
295: $FREEM_LOG_THRESHOLD_STDERR
1.5 ! snw 296: .RS 4
! 297: Overrides the configured threshold at which log messages are sent to
! 298: \fIstderr\fR, corresponding to the
! 299: \fIlog_threshold_stderr\fR environment setting in
! 300: \fI$PREFIX/etc/env.conf\fR. The default value is
! 301: \fIwarning\fR.
! 302: .RE
1.3 snw 303: .SH LOG THRESHOLD VALUES
1.5 ! snw 304: This section details the valid values for each of the
! 305: \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
! 306: \fIwarning\fR is selected, messages with a diagnostic class of
! 307: \fIwarning\fR,
! 308: \fIerror\fR, and
! 309: \fIfatal\fR will be delivered through the selected mechanism.
1.3 snw 310:
311: Valid values for each of these environment variables are as follows:
312: .TP
313: debug
1.4 snw 314: .RS 4
1.3 snw 315: 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 316: .RE
1.3 snw 317: .TP
318: info
1.4 snw 319: .RS 4
1.5 ! snw 320: 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
! 321: \fIwarning\fR instead.
1.4 snw 322: .RE
1.3 snw 323: .TP
324: warning
1.4 snw 325: .RS 4
1.3 snw 326: 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 327: .RE
1.3 snw 328: .TP
329: error
1.4 snw 330: .RS 4
1.3 snw 331: 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 332: .RE
1.3 snw 333: .TP
334: fatal
1.4 snw 335: .RS 4
1.3 snw 336: 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 337: .RE
338: .SH FILES
339: .PP
340: $PREFIX/etc/freem/env.conf
341: .RS 4
342: FreeM environment catalog
343: .RE
1.5 ! snw 344:
1.4 snw 345: $PREFIX/etc/freem/<environment-name>/freem.conf
346: .RS 4
347: FreeM per-environment configuration
348: .RE
1.1 snw 349: .SH BUGS
350: Check the issue tracker at https://bugs.coherent-logic.com for more detailed information on current bugs.
351: .SH AUTHOR
352: Authored, maintained and updated by Serena Willis (snw@coherent-logic.com)
353: .SH COPYRIGHT
354: Copyright (C) 2014, 2021, 2025 Coherent Logic Development LLC
355:
356: 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.
357:
358: .SH "SEE ALSO"
1.4 snw 359: .PP
360: \fBfreem\fR(1),
361: \fBenv.conf\fR(5),
362: \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