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