|
|
## Command-Line Interface
|
|
|
# Command-Line Interface (CLI)
|
|
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
These pages summarises the ideas about the command-line interface for Datovka.
|
|
|
This document summarises the command-line interface of Datovka.
|
|
|
|
|
|
### Background
|
|
|
|
|
|
Several users have been complaining about a missing CLI. Their wish is to have an interface that could:
|
|
|
Several users have been complaining about a missing CLI. Their wish was to have an interface that could:
|
|
|
|
|
|
* send a message
|
|
|
* send messages
|
|
|
* check for new messages
|
|
|
* extract a message
|
|
|
* extract content of new messages
|
... | ... | @@ -17,9 +17,11 @@ The client should not provide any means of sending messages via e-mail. Should o |
|
|
|
|
|
### Inspiration
|
|
|
|
|
|
The command-line interface should resemble [Thunderbird CLI](http://kb.mozillazine.org/Command_line_arguments_%28Thunderbird%29). Also, there exists a command-line ISDS client called [shigofumi](http://xpisar.wz.cz/shigofumi/) :smiley_cat:. It may be useful to have a look at its CLI too.
|
|
|
The command-line interface resembles the [Thunderbird CLI](http://kb.mozillazine.org/Command_line_arguments_%28Thunderbird%29). Also, there exists a command-line ISDS client called [shigofumi](http://xpisar.wz.cz/shigofumi/) :smiley_cat:.
|
|
|
|
|
|
## Basic Datovka CLI
|
|
|
## Basic command-line options
|
|
|
|
|
|
The following parameters are available in both the GUI application and for the special CLI application (available only on Windows).
|
|
|
|
|
|
```
|
|
|
Usage: datovka [ options ] [ zfo-file ]
|
... | ... | @@ -37,10 +39,10 @@ Usage: datovka [ options ] [ zfo-file ] |
|
|
* **--save-conf _conf_** - On stop save *conf* file.
|
|
|
* **--log-file _file_** - Log messages to *file*. (in development branch)
|
|
|
|
|
|
#### Arguments:
|
|
|
#### Parameters:
|
|
|
**zfo-file** - ZFO file to be viewed.
|
|
|
|
|
|
## Advanced Datovka CLI - databox/message operations
|
|
|
## Command-line only options - databox/message operations
|
|
|
|
|
|
```
|
|
|
Usage: datovka --login "username='xxxxxx'" --service-name "parameter-list"
|
... | ... | |