Return to fmadm.8 CVS log

Up to [Coherent Logic Development] / freem / doc

Annotation of freem/doc/fmadm.8, revision 1.2

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