stm-admin

Navigation: Documentation / Utilities / stm-admin

---

stm-admin: version 6.1090.a7cf688 (2026-06-18 21:15)

Name

stm-admin

Synopsis

stm-admin [OPTIONS] [--] stm://server[:port]/command

Description

The utility that controls the behaviour and state of the server implementing the string method.

Arguments

stm://server[:port]/command The server can be specified as either the DNS name, the IP address of the server, or the keyword 'serverkey' or 'key'. In the latter case, the server information is read from the server key file. The listening port number can be optionally provided. Finally, the command specifies an administrative task, which can be one of the following: info = display information about registered clients flush = save the accumulated STM path on the server side get?file=output.path = retrieve the accumulated STM path and save it locally to the file 'output.path' release?id=bead_id = unregister a client associated with the specified bead ID terminate = terminate the server at the end of the STM cycle shutdown = stop the server execution errors = display errors from the server stack

Options

-s, --serverkey FILE Name of file containing the server key. The server key contains the server name, port, and password. This option is mutually exclusive with 'password' option. (Default: server.key)

-p, --password FILE Name of file containing the server magic word. If the pasword is not provided via this option or via the server key then it is read interactively from the keyboard. This option is mutually exclusive with 'serverkey' option.

-v, --verbose Increase output verbosity.

--version Output version information and exit.

-h, --help Display this help and exit.