Return to fmadm.8 CVS log

Up to [Coherent Logic Development] / freem / doc

Add fmadm man page to CVS

.\" To display this man page, either:
.\"   1) Install this file along with the other subject.8 files in your
.\"      system's man1 directory (usually this is /usr/man/man18) and
.\"      enter the command:
.\"        man fmadm
.\"   or
.\"   2) Specify the input (this file) and the output (your favorite pager)
.\"      explicitly.  For example, if this file is in your current working
.\"      directory, you can use the following to view the formatted man page
.\"      using the "less" pager:
.\"        man ./fmadm.8 | less
.\"
.\" To print this man page to a PostScript printer:
.\"   man -t ./fmadm.8 | lpr
.\"
.\"   $Id: fmadm.8,v 1.1 2025/04/03 15:56:41 snw Exp $
.\"    fmadm man page
.\"
.\"  
.\"   Author: Serena Willis <snw@coherent-logic.com>
.\"    Copyright (C) 2025 Coherent Logic Development LLC
.\"
.\"
.\"   This file is part of FreeM.
.\"
.\"   FreeM is free software: you can redistribute it and/or modify
.\"   it under the terms of the GNU Affero Public License as published by
.\"   the Free Software Foundation, either version 3 of the License, or
.\"   (at your option) any later version.
.\"
.\"   FreeM is distributed in the hope that it will be useful,
.\"   but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"   GNU Affero Public License for more details.
.\"
.\"   You should have received a copy of the GNU Affero Public License
.\"   along with FreeM.  If not, see <https://www.gnu.org/licenses/>.
.\"
.\"   $Log: fmadm.8,v $
.\"   Revision 1.1  2025/04/03 15:56:41  snw
.\"   Add fmadm man page to CVS
.\"
.\"
.TH fmadm 8 "3 April 2025" FreeM "FreeM User Manual"
.SH NAME
fmadm
.SH SYNOPSIS
fmadm <action> <object> [-e=<environment] [-n=<namespace>] [-u=<user>] [-g=<group>] [-E=true|false] [OPTIONS]

fmadm configure [-e=<environment] [-n=<namespace>] [-u=<user>] [-g=<group>] [-E=true|false]

fmadm reconfigure [-e=<environment] [-n=<namespace>] [-u=<user>] [-g=<group>] [-E=true|false]

<action> can be one of:
    list, examine, verify, remove, import, export, backup, restore,
    edit, start, stop, restart, status

<object> can be one of:
    lock, journal, namespace, global, routine, job,
    environment

Running fmadm with no command-line arguments will start the interactive mode.
.SH DESCRIPTION
The
.B fmadm
program is a systems administration tool used by FreeM operators to manage their environments.

Please see the FreeM texinfo documentation for more details ("info freem").
.SH FLAGS
Please note that fmadm flags MUST consist of a hyphen, the letter representing the flag, an equal sign, and the value for the flag.

A valid flag looks like this:

\-e=DEFAULT

Spaces surrounding the equal sign, or a space in lieu of the equal sign, are
invalid syntax.

.TP
\-e
Sets the environment to be acted upon in this fmadm session. 'DEFAULT' is assumed if this flag is not provided.
.TP
\-n
Sets the namespace to be acted upon in this fmadm session. 'SYSTEM' is assumed if this flag is not provided.
.TP
\-u
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'. 
.TP
\-g
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'.
.TP
\-E
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'.
.SH ACTIONS
.TP
configure
Configures an environment. No object will be used with this action. Instead, the -e, -u, -g, and -E flags will be referenced.
.TP
reconfigure
Reconfigures an environment. No object will be used with this action. Instead, the -e, -u, -g, and -E flags will be referenced.
.TP
list
Generates a list of <object>s. Applies to lock, routine, global, and job.
.TP
examine
Examines a specific instance of <object>. Applies to routine, global, job, and journal.
.TP
verify
Verifies the integrity of <object>. Applies to global.
.TP
remove
Removes an instance of <object>. Applies to job, lock, routine, and global.
.TP
import
Imports an instance of <object>. Applies to routine (imports routine archives in RO/RSA format).
.TP
export
Exports an instance of <object>. Applies to routine (exports routine archives in RO/RSA format).
.TP
backup
Backs up an instance of <object>. Applies to routine.
.TP
restore
Restores an instance of <object>. Applies to journal (plays back after-image journals).
.TP
edit
Edits an <object>. Applies to routine (will open the routine in $EDITOR) and global (will open the interactive global editor).
.TP
start
Starts one environment, multiple environments, or all environments. Applies to environment.
.TP
stop
Stops one environment, multiple environments, or all environments. Applies to environmen
.TP
restart
Restarts one environment, multiple environments, or all environments. Applies to environment.
.TP
status
Gets the status of one environment, multiple environments, or all environments. Applies to environment.
.SH "FURTHER INFORMATION"
Please note that the primary documentation for FreeM is the 'info' manual, accessed with the following command:

info freem

These manual pages are minimal, and maintained on a strictly best-effort basis.
.SH "RETURN VALUES"
Returns 0 for non-error condition.
.SH FILES
.TP
env.conf
The FreeM environment catalog. Normally located in $PREFIX/etc/freem/env.conf
.TP
freem.conf
The FreeM configuration file. Normally located in $PREFIX/etc/freem/<environment-name>/freem.conf.
.SH ENVIRONMENT
.TP
\$EDITOR
Determines the text editor used by `edit routine`.
.SH BUGS
Check the issue tracker at https://bugs.coherent-logic.com for more detailed information on current bugs.
.SH AUTHOR
Authored, maintained and updated by Serena Willis (snw@coherent-logic.com)
.SH COPYRIGHT
Copyright (C) 2014, 2021, 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.

.SH "SEE ALSO"
.BR freem (1)