Appendix A FreeM Administrator

The fmadm utility is the preferred method of managing a FreeM installation, and will eventually replace all of the existing utilities. Unlike the existing, legacy utilities, fmadm presents a consistent, simple interface for all FreeM management tasks, and is namespace-aware. This appendix will document each fmadm facility as it is implemented, until all of the legacy utilities have been replaced.

The fmadm utility’s functions all follow the below, consistent syntax:

usage:  fmadm <action> <object> <namespace> [OPTIONS]

The action keyword can be one of the following:

list

Lists instances of object

examine

Examines a single instance of object

verify

Verifies the integrity of object

compact

Compacts object

repair

Repairs integrity problems in object

create

Creates an instance of object

remove

Removes an instance of object

import

Imports an object

export

Exports an object

backup

Creates a backup of object

restore

Restores a backup of object

migrate

Migrates an instance of object from an older FreeM version to the current version

edit

Edits an instance of object

The object keyword can be one of the following:

lock

The FreeM LOCK table.

Supported actions are list and remove.

zallocate

The FreeM ZALLOCATE table.

No actions yet implemented.

journal

FreeM after-image journaling.

Supported actions are examine and restore.

The examine action will dump the after-image journal entries for the selected namespace in human-readable format.

The restore action will play after-image journals forward for the selected namespace.

namespace

FreeM namespaces (collections of M routines and globals).

No actions yet implemented.

global

The database files representing each FreeM global.

Supported actions are list, examine, remove, and verify.

routine

An M routine, stored as a .m file.

Supported actions are list, examine, remove, import, export, backup, and edit.

job

A UNIX process representing an instance of the FreeM runtime.

Supported actions are list and examine.

This document was generated on September 20, 2023 using texi2html 5.0.