Guide for Persistence
Man Pages for Store

There are two executables for the Store, each with it's own man page:


Umestored Man Page  <-

The umestored executable can be run interactively from a command prompt or from a script/batch file. For use as a Windows Service, see Umestoreds Man Page.

UMP Store daemon
Usage: umestored [options] configfile
Available options:
-h, --help display this help and exit
-d, --dump-dtd dump DTD to stdout
-f, --detach detach from terminal (not supported on Windows)
-v, --validate validate config, but do not run
Description
Persistent Store services are provided by umestored.
The configfile parameter is required and specifies the Store's XML configuration file.
The DTD used to validate a configuration file will be dumped to standard output with the -d or --dump-dtd. After dumping the DTD, umestored exits instead of providing persistence services as usual.
The configuration file will be validated against the DTD if either the -v or --validate options are given. After attempting validation, umestored exits instead of providing persistence services as usual. The exit status will be 0 for a configuration file validated by the DTD and non-zero otherwise.
Umestored normally remains attached to the controlling terminal and runs until interrupted. If the -f or --detach options are given, umestored instead forks, detaches the child from the controlling terminal, and the parent exits immediately.
Command line help is available with -h.
Usage Notes
When shutting down the UM Persistent Store daemon, use a SIGINT to trigger a clean shutdown, which attempts to cleanly finish outstanding IO requests before shutting down. Two successive SIGINTs force an immediate shutdown (not recommended unless absolutely necessary).
Exit Status
The exit status from umestored is 0 for success and some non-zero value for failure.


Umestoreds Man Page  <-

The umestoreds executable is for use as a Windows Service. The service can be installed as a service by the Windows package installer.

Alternatively, the umestoreds executable can be run interactively from a command prompt to install the service or to change certain configuration elements. See UM Daemons as Windows Services for more details.

UMP Store service
Usage: umestoreds [options] [configfile]
Available options:
-h, --help display this help and exit
-d, --dump-dtd dump DTD to stdout
-s, --service=install install the service passing configfile
-s, --service=remove delete/remove the service
-s, --service=config update configfile info to use configfile passed
-v, --validate validate config, but do not run
-e, --event-log-level Update/set service logging level. This is the minimum logging
level to send to the Windows event log. Valid values are:
NONE - Send no events
INFO
WARN - default
ERROR
configfile XML config file (if not present, looks in registry)
Description
Persistent Store services are provided by the umestoreds Windows Service.
The configfile parameter is used interactively to configure the Store's XML configuration file.
The DTD used to validate a configuration file will be dumped to standard output with the -d or --dump-dtd. After dumping the DTD, umestoreds exits instead of providing persistence services as usual.
The configuration file will be validated against the DTD if either the -v or --validate options are given. After attempting validation, umestoreds exits instead of providing persistence services as usual. The exit status will be 0 for a configuration file validated by the DTD and non-zero otherwise.
The -s is used interactively to control the installation of the Windows service. The -e is used interactively to configure the logging threshold for writing to the Windows Event Log. See UM Daemons as Windows Services for more details.
Command line help is available with -h.
Usage Notes
When installing the UM Persistent Store as a Microsoft Windows service, use only local disk devices and fully qualified path names for all filenames. This is because Windows services run by default under a Local System account, which has reduced privileges and is not allowed access to network devices.
Stopping the UM Persistent Store service triggers a clean shutdown, which attempts to cleanly finish outstanding IO requests before shutting down.
Exit Status
The exit status from umestored is 0 for success and some non-zero value for failure.