Svs-client: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 2: | Line 2: | ||
Navigation: [[Documentation]] / [[Commands]] / [[svs-client]] | Navigation: [[Documentation]] / [[Commands]] / [[svs-client]] | ||
---- | ---- | ||
<div style="text-align: center">vs-client: version 2. | <div style="text-align: center">vs-client: version 2.231.418d045(2020-03-01 18:49) [CATs - Conversion And Analysis Tools]</div>'''Name''' | ||
<span style="margin-left: 15px;">vs-client</span> | <span style="margin-left: 15px;">vs-client</span> | ||
| Line 18: | Line 18: | ||
{| 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: purple;">svs://server[:port]/command</span><br/><div style="margin-left: 30px;">Specifies fully qualified administration request. Trasport protocol svs:// has to be always specified, which is followed by the server specification (DNS name or IP address of the server and optionally by the server port). This is followed by the command, which can be one of the following:<br /><span></span> register = register client on server side<br /><span></span> unregister = unregister client on server side (unregister?id=client_id)<br /><span></span> get = get unprocessed structure from database (get?id=client_id,structure=file.ext[,type=xyz])<br /><span></span> write = write data to database and set structure as processed (write?id=client_id,molid=molecule_id[,structure=file.ext,type=log])<br /><span></span> load = load structure from database (load?id=client_id,molid=molecule_id[,structure=file.ext,type=xyz])<br /><span></span> save = save structure to database (save?id=client_id,molid=molecule_id[,structure=file.ext,type=log])<br /><span></span> installpkg = install client package to current directory<br /><span></span> appname = get client application name<br /><span></span> info = prints information about registered clients<br /><span></span> shutdown = stops server execution<br /><span></span> errors = prints errors from the server stack | | <span style="color: purple;">svs://server[:port]/command</span><br/><div style="margin-left: 30px;">Specifies fully qualified administration request. Trasport protocol svs:// has to be always specified, which is followed by the server specification (DNS name or IP address of the server and optionally by the server port). This is followed by the command, which can be one of the following:<br /><span></span> <span style="color: green;">register</span> = register client on server side<br /><span></span> <span style="color: green;">unregister</span> = unregister client on server side (unregister?id=client_id)<br /><span></span> <span style="color: green;">get</span> = get unprocessed structure from database (get?id=client_id,structure=file.ext[,type=xyz])<br /><span></span> <span style="color: green;">write</span> = write data to database and set structure as processed (write?id=client_id,molid=molecule_id[,structure=file.ext,type=log])<br /><span></span> <span style="color: green;">load</span> = load structure from database (load?id=client_id,molid=molecule_id[,structure=file.ext,type=xyz])<br /><span></span> <span style="color: green;">save</span> = save structure to database (save?id=client_id,molid=molecule_id[,structure=file.ext,type=log])<br /><span></span> <span style="color: green;">installpkg</span> = install client package to current directory<br /><span></span> <span style="color: green;">appname</span> = get client application name<br /><span></span> <span style="color: green;">info</span> = prints information about registered clients<br /><span></span> <span style="color: green;">shutdown</span> = stops server execution<br /><span></span> <span style="color: green;">errors</span> = prints errors from the server stack</div> | ||
|} | |} | ||
Latest revision as of 22:32, 3 March 2020
Navigation: Documentation / Commands / svs-client
vs-client: version 2.231.418d045(2020-03-01 18:49) [CATs - Conversion And Analysis Tools]
Name
vs-client
Synopsis
vs-client [OPTIONS] [--] svs://server[:port]/command
Description
Client of the server/client virtual screening infrastructure.
Arguments
| svs://server[:port]/command Specifies fully qualified administration request. Trasport protocol svs:// has to be always specified, which is followed by the server specification (DNS name or IP address of the server and optionally by the server port). This is followed by the command, which can be one of the following:
register = register client on server side unregister = unregister client on server side (unregister?id=client_id) get = get unprocessed structure from database (get?id=client_id,structure=file.ext[,type=xyz]) write = write data to database and set structure as processed (write?id=client_id,molid=molecule_id[,structure=file.ext,type=log]) load = load structure from database (load?id=client_id,molid=molecule_id[,structure=file.ext,type=xyz]) save = save structure to database (save?id=client_id,molid=molecule_id[,structure=file.ext,type=log]) installpkg = install client package to current directory appname = get client application name info = prints information about registered clients shutdown = stops server execution errors = prints errors from the server stack |
Options
| -s, --serverkey FILE name of file containing server description (name, port, and password) (mutually exclusive with 'password' option)
|
| -p, --password FILE name of file containing server magic word, if not specified then password is read interactively
|
| -v, --verbose increase output verbosity
|
| --version output version information and exit
|
| -h, --help display this help and exit
|