Abf-admin: Difference between revisions

Jump to navigation Jump to search
no edit summary
No edit summary
No edit summary
 
Line 1: Line 1:
{{DISPLAYTITLE:abf-admin}}
Navigation: [[Documentation]] / [[Methods]] / [[Adaptive Biasing Force Method]] / [[ABF:Utilities]] / [[abf-admin]]
Navigation: [[Documentation]] / [[Methods]] / [[Adaptive Biasing Force Method]] / [[ABF:Utilities]] / [[abf-admin]]
----
----
{{ABFUtils}}
{{ABFUtils}}
'''Name'''
<div style="text-align: center">abf-admin: version 5.271.40980cf (2020-03-02 15:18)</div>'''Name'''


abf-admin
<span style="margin-left: 15px;">abf-admin</span>


'''Synopsis'''
'''Synopsis'''


<span style="color: maroon;">abf-admin</span> <span style="color: blue;">[OPTIONS]</span> [--] <span style="color: purple;">abf://server[:port]/command</span>
<span style="color: maroon; margin-left: 15px;">abf-admin</span> <span style="color: blue;">[OPTIONS]</span> [--] <span style="color: purple;">abf://server[:port]/command</span>


'''Description'''
'''Description'''


The utility that controls the behaviour and state of the server implementing the multiple walkers extension of the ABF method.
<p style="text-indent: 1em; text-align: justify;">The utility that controls the behaviour and state of the server implementing the multiple walkers extension of the ABF method.</p>


'''Arguments'''
'''Arguments'''


{| style="margin-left: 2em; width: 75%;"
{| style="margin-left: 2em; width: 95%;"
|- style="vertical-align: top;"
| <span style="color: purple;">abf://server[:port]/command</span><br/>
<span style="margin-left: 30px;">It provides the action specification. The server is either the DNS name, IP address of the server or word 'serverkey'. In the later case the information about the server is read from the server key file. 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:
{|
|- style="vertical-align: top; background-color: #e6e6e6;"
| info
| prints information about registered clients
|-
| flush
| save the accumulated ABF data on server side
|- style="vertical-align: top; background-color: #e6e6e6;"
| get?file=NAME
| get the accumulated ABF data and saves them locally to the file with NAME
|-
| shutdown
| stop the server execution
|- style="vertical-align: top; background-color: #e6e6e6;"
|- style="vertical-align: top; background-color: #e6e6e6;"
| errors
| <span style="color: purple;">abf://server[:port]/command</span><br/><div style="margin-left: 30px;">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:<br />info          = print information about registered clients<br />flush          = save the accumulated ABF data on the server side<br />get?file=NAME  = get the accumulated ABF data and saves them locally to the NAME file (the default name is _abfserver.rst)<br />shutdown      = stop the server execution (use --force to skip protection by passphrase)<br />errors         = print errors from the server stack</div>
| print errors from the server stack
|}
</span>
|}
|}


Line 44: Line 26:
{| style="margin-left: 2em; width: 95%;"
{| style="margin-left: 2em; width: 95%;"
|- style="vertical-align: top; background-color: #e6e6e6;"
|- style="vertical-align: top; background-color: #e6e6e6;"
|<span style="color: blue;">-s, --serverkey FILE</span><br/><span style="margin-left: 30px;">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.</span>
|<span style="color: blue;">-s, --serverkey FILE</span><br/><div style="margin-left: 30px;">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.</div><span style="color:purple; margin-left: 30px;">(Default: server.key)</span>
|- style="vertical-align: top;"
|- style="vertical-align: top;"
|<span style="color: blue;">-p, --password FILE</span><br/><span style="margin-left: 30px;">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.</span>
|<span style="color: blue;">-p, --password FILE</span><br/><div style="margin-left: 30px;">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.</div>
|- style="vertical-align: top; background-color: #e6e6e6;"
|- style="vertical-align: top; background-color: #e6e6e6;"
|<span style="color: blue;">-v, --verbose</span><br/><span style="margin-left: 30px;">Increase output verbosity.</span>
|<span style="color: blue;">-f, --force</span><br/><div style="margin-left: 30px;">Skip protection of server shutdown by passphrase.</div>
|- style="vertical-align: top;"
|- style="vertical-align: top;"
|<span style="color: blue;">--version</span><br/><span style="margin-left: 30px;">Output version information and exit.</span>
|<span style="color: blue;">-v, --verbose</span><br/><div style="margin-left: 30px;">Increase output verbosity.</div>
|- style="vertical-align: top; background-color: #e6e6e6;"
|- style="vertical-align: top; background-color: #e6e6e6;"
|<span style="color: blue;">-h, --help</span><br/><span style="margin-left: 30px;">Display this help and exit.</span>
|<span style="color: blue;">--version</span><br/><div style="margin-left: 30px;">Output version information and exit.</div>
|- style="vertical-align: top;"
|<span style="color: blue;">-h, --help</span><br/><div style="margin-left: 30px;">Display this help and exit.</div>
|}
|}

Navigation menu