Mtd-admin: Difference between revisions

From PMFLib Wiki
Jump to navigation Jump to search
(Created page with "Navigation: Documentation / Methods / Metadynamics / MTD:Utilities / mtd-admin ---- {{MTDUtils}} '''Name''' mtd-admin '''Synopsis''' <span style="color:...")
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:mtd-admin}}
Navigation: [[Documentation]] / [[Methods]] / [[Metadynamics]] / [[MTD:Utilities]] / [[mtd-admin]]
Navigation: [[Documentation]] / [[Methods]] / [[Metadynamics]] / [[MTD:Utilities]] / [[mtd-admin]]
----
----
{{MTDUtils}}
{{MTDUtils}}
'''Name'''
<div style="text-align: center">mtd-admin: version 5.271.40980cf (2020-03-02 15:18)</div>'''Name'''


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


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


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


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


The utility that controls the behaviour and state of the server implementing the multiple walkers extension of the metadynamics 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 metadynamics method.</p>


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


{| style="margin-left: 2em; width: 75%;"
{| style="margin-left: 2em; width: 95%;"
|- style="vertical-align: top;"
| <span style="color: purple;">mtd://server[:port]/command</span><br/>
<span 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'. 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:
{|
|- style="vertical-align: top; background-color: #e6e6e6;"
|- style="vertical-align: top; background-color: #e6e6e6;"
|info          || print information about registered clients
| <span style="color: purple;">mtd://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 MTD data on the server side<br />get?file=NAME  = get the accumulated MTD data and saves them locally to the file with NAME<br />shutdown      = stop the server execution<br />errors        = print errors from the server stack</div>
|-
|flush          || save the accumulated MTD data on the server side
|- style="vertical-align: top; background-color: #e6e6e6;"
|get?file=NAME  || get the accumulated MTD data and saves them locally to the file with NAME
|-
|shutdown      || stop the server execution
|- style="vertical-align: top; background-color: #e6e6e6;"
|errors        || print errors from the server stack
|}
</span>
|}
|}


Line 39: 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><br/><span style="color:purple; margin-left: 30px;">(Default: )</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><br/><span style="color:purple; margin-left: 30px;">(Default: )</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;">-v, --verbose</span><br/><div style="margin-left: 30px;">Increase output verbosity.</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;">--version</span><br/><div style="margin-left: 30px;">Output version information and exit.</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;">-h, --help</span><br/><div style="margin-left: 30px;">Display this help and exit.</div>
|}
|}

Latest revision as of 17:01, 6 March 2020

Navigation: Documentation / Methods / Metadynamics / MTD:Utilities / mtd-admin


MTD Utilities

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

Name

mtd-admin

Synopsis

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

Description

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

Arguments

mtd://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 MTD data on the server side
get?file=NAME = get the accumulated MTD data and saves them locally to the file with NAME
shutdown = stop the server execution
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.
-v, --verbose
Increase output verbosity.
--version
Output version information and exit.
-h, --help
Display this help and exit.