abf-admin

From PMFLib Wiki
Jump to navigation Jump to search

Navigation: Documentation / Methods / Adaptive Biasing Force Method / ABF:Utilities / abf-admin


ABF Utilities

abf-admin: version 5.271.40980cf (2020-03-02 15:18)

Name

abf-admin

Synopsis

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

Description

The utility that controls the behaviour and state of the server implementing the multiple walkers extension of the ABF method.

Arguments

abf://server[:port]/command
It provides the action specification. The server is either the DNS name or IP address of the server or word 'serverkey' or 'key'. In the later case, the information about the server is read from the server key file. The port number, on which the server is listen, may be optionally provided. Finally, the command is administration task, which can be one of the following:
info = print information about registered clients
flush = save the accumulated ABF data on the server side
get?file=NAME = get the accumulated ABF data and saves them locally to the NAME file (the default name is _abfserver.rst)
shutdown = stop the server execution (use --force to skip protection by passphrase)
errors = print 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.
-f, --force
Skip protection of server shutdown by passphrase.
-v, --verbose
Increase output verbosity.
--version
Output version information and exit.
-h, --help
Display this help and exit.