Annotation of freem/doc/fmadm.8, revision 1.3
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.3 ! snw 16: .\" $Id: fmadm.8,v 1.2 2025/04/04 12:49:19 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.3 ! snw 40: .\" Revision 1.2 2025/04/04 12:49:19 snw
! 41: .\" Dollar signs cut off in ENVIRONMENT sections of both man pages
! 42: .\"
1.2 snw 43: .\" Revision 1.1 2025/04/03 15:56:41 snw
44: .\" Add fmadm man page to CVS
45: .\"
1.1 snw 46: .\"
47: .TH fmadm 8 "3 April 2025" FreeM "FreeM User Manual"
48: .SH NAME
49: fmadm
50: .SH SYNOPSIS
1.2 snw 51: fmadm <action> <object> [-e=<environment] [-n=<namespace>] [OPTIONS]
1.1 snw 52:
53: fmadm configure [-e=<environment] [-n=<namespace>] [-u=<user>] [-g=<group>] [-E=true|false]
54:
55: fmadm reconfigure [-e=<environment] [-n=<namespace>] [-u=<user>] [-g=<group>] [-E=true|false]
56:
57: <action> can be one of:
58: list, examine, verify, remove, import, export, backup, restore,
59: edit, start, stop, restart, status
60:
61: <object> can be one of:
62: lock, journal, namespace, global, routine, job,
63: environment
64:
65: Running fmadm with no command-line arguments will start the interactive mode.
66: .SH DESCRIPTION
67: The
68: .B fmadm
69: program is a systems administration tool used by FreeM operators to manage their environments.
70:
71: Please see the FreeM texinfo documentation for more details ("info freem").
72: .SH FLAGS
73: Please note that fmadm flags MUST consist of a hyphen, the letter representing the flag, an equal sign, and the value for the flag.
74:
75: A valid flag looks like this:
76:
77: \-e=DEFAULT
78:
79: Spaces surrounding the equal sign, or a space in lieu of the equal sign, are
80: invalid syntax.
81:
82: .TP
83: \-e
84: Sets the environment to be acted upon in this fmadm session. 'DEFAULT' is assumed if this flag is not provided.
85: .TP
86: \-n
87: Sets the namespace to be acted upon in this fmadm session. 'SYSTEM' is assumed if this flag is not provided.
88: .TP
89: \-u
90: 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'.
91: .TP
92: \-g
93: 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'.
94: .TP
95: \-E
96: 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'.
97: .SH ACTIONS
98: .TP
99: configure
100: Configures an environment. No object will be used with this action. Instead, the -e, -u, -g, and -E flags will be referenced.
101: .TP
102: reconfigure
103: Reconfigures an environment. No object will be used with this action. Instead, the -e, -u, -g, and -E flags will be referenced.
104: .TP
105: list
106: Generates a list of <object>s. Applies to lock, routine, global, and job.
107: .TP
108: examine
109: Examines a specific instance of <object>. Applies to routine, global, job, and journal.
110: .TP
111: verify
112: Verifies the integrity of <object>. Applies to global.
113: .TP
114: remove
115: Removes an instance of <object>. Applies to job, lock, routine, and global.
116: .TP
117: import
118: Imports an instance of <object>. Applies to routine (imports routine archives in RO/RSA format).
119: .TP
120: export
121: Exports an instance of <object>. Applies to routine (exports routine archives in RO/RSA format).
122: .TP
123: backup
124: Backs up an instance of <object>. Applies to routine.
125: .TP
126: restore
127: Restores an instance of <object>. Applies to journal (plays back after-image journals).
128: .TP
129: edit
130: Edits an <object>. Applies to routine (will open the routine in $EDITOR) and global (will open the interactive global editor).
131: .TP
132: start
133: Starts one environment, multiple environments, or all environments. Applies to environment.
134: .TP
135: stop
136: Stops one environment, multiple environments, or all environments. Applies to environmen
137: .TP
138: restart
139: Restarts one environment, multiple environments, or all environments. Applies to environment.
140: .TP
141: status
142: Gets the status of one environment, multiple environments, or all environments. Applies to environment.
143: .SH "FURTHER INFORMATION"
144: Please note that the primary documentation for FreeM is the 'info' manual, accessed with the following command:
145:
146: info freem
147:
148: These manual pages are minimal, and maintained on a strictly best-effort basis.
149: .SH "RETURN VALUES"
150: Returns 0 for non-error condition.
151: .SH FILES
152: .TP
153: env.conf
154: The FreeM environment catalog. Normally located in $PREFIX/etc/freem/env.conf
155: .TP
156: freem.conf
157: The FreeM configuration file. Normally located in $PREFIX/etc/freem/<environment-name>/freem.conf.
158: .SH ENVIRONMENT
159: .TP
1.2 snw 160: $EDITOR
1.1 snw 161: Determines the text editor used by `edit routine`.
1.3 ! snw 162: .TP
! 163: $FREEM_LOG_THRESHOLD_FILE
! 164: 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".
! 165: .TP
! 166: $FREEM_LOG_THRESHOLD_SYSLOG
! 167: 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".
! 168: .TP
! 169: $FREEM_LOG_THRESHOLD_STDERR
! 170: 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".
! 171: .SH LOG THRESHOLD VALUES
! 172: 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.
! 173:
! 174: Valid values for each of these environment variables are as follows:
! 175: .TP
! 176: debug
! 177: 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.
! 178: .TP
! 179: info
! 180: 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.
! 181: .TP
! 182: warning
! 183: 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.
! 184: .TP
! 185: error
! 186: 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.
! 187: .TP
! 188: fatal
! 189: 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.
! 190:
1.1 snw 191: .SH BUGS
192: Check the issue tracker at https://bugs.coherent-logic.com for more detailed information on current bugs.
193: .SH AUTHOR
194: Authored, maintained and updated by Serena Willis (snw@coherent-logic.com)
195: .SH COPYRIGHT
196: Copyright (C) 2014, 2021, 2025 Coherent Logic Development LLC
197:
198: 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.
199:
200: .SH "SEE ALSO"
201: .BR freem (1)
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