| 1 | .TH "dxsclient" "1" "0.9.3" "Josef Spillner" "Desktop Exchange Service Client" |
|---|
| 2 | .SH "NAME" |
|---|
| 3 | .LP |
|---|
| 4 | dxsclient \- command line client for the Desktop Exchange Service (DXS) |
|---|
| 5 | .SH "SYNOPSIS" |
|---|
| 6 | .LP |
|---|
| 7 | Interactive mode: |
|---|
| 8 | .br |
|---|
| 9 | \fBdxsclient \fR[\fB\-\-webservice\fR=\fIURL\fP]\fR |
|---|
| 10 | .LP |
|---|
| 11 | Batch mode: |
|---|
| 12 | .br |
|---|
| 13 | \fBdxsclient \fR[\fIOPTIONS\fP] [\fICOMMAND\fP] |
|---|
| 14 | .LP |
|---|
| 15 | .SH "DESCRIPTION" |
|---|
| 16 | .LP |
|---|
| 17 | The dxsclient program is a command line frontend for the data sharing |
|---|
| 18 | service DXS. With the help of the tool it is possible to browse already |
|---|
| 19 | published entries at a specific provider, and to publish own creations. |
|---|
| 20 | .LP |
|---|
| 21 | Both interactive mode and batch mode are supported. In interactive mode, |
|---|
| 22 | while the communication is still stateless, a lot of information is cached |
|---|
| 23 | so many operations perform very well. |
|---|
| 24 | .SH "OPTIONS" |
|---|
| 25 | .LP |
|---|
| 26 | General Options |
|---|
| 27 | .TP |
|---|
| 28 | \fB\-h\fR, \fB\-\-help\fR |
|---|
| 29 | General help on all command line options and arguments. |
|---|
| 30 | The program will display the help and exit. |
|---|
| 31 | .TP |
|---|
| 32 | \fB\-w\fR, \fB\-\-webservice\fR |
|---|
| 33 | Selection of a webservice provider. If not given, the hardcoded |
|---|
| 34 | default provider is used instead. |
|---|
| 35 | .LP |
|---|
| 36 | Command Options/Operations |
|---|
| 37 | .TP |
|---|
| 38 | \fB\-u\fR, \fB\-\-upload=\fR\fIFILENAME\fP |
|---|
| 39 | Reads in a meta information file (.meta), including its references to a |
|---|
| 40 | preview image and payload file, which are also read in. All the information |
|---|
| 41 | is then uploaded to the DXS. |
|---|
| 42 | .TP |
|---|
| 43 | \fB\-i\fR, \fB\-\-information\fR |
|---|
| 44 | Displays information about the service provider. This includes the name |
|---|
| 45 | and the homepage URL, as well as the name and the version of the used |
|---|
| 46 | server backend. |
|---|
| 47 | .TP |
|---|
| 48 | \fB\-c\fR, \fB\-\-categories\fR |
|---|
| 49 | Lists all the data categories registered at the provider. Any value |
|---|
| 50 | which appears in the result list can then be used to query the DXS and to |
|---|
| 51 | get the list of entries for each category. |
|---|
| 52 | .TP |
|---|
| 53 | \fB\-l\fR, \fB\-\-list=\fR\fICATEGORY\fP |
|---|
| 54 | Retrieves a list of entries of a specific \fICATEGORY\fP and |
|---|
| 55 | displays the most important information (name, author and internal |
|---|
| 56 | id). The id can then be used to retrieve detailed information when |
|---|
| 57 | running in interactive mode. |
|---|
| 58 | .LP |
|---|
| 59 | .SH "INTERACTIVE MODE" |
|---|
| 60 | .LP |
|---|
| 61 | Most of the operations from the command line are mapped onto commands |
|---|
| 62 | for the interactive shell. However there are some extensions. |
|---|
| 63 | .TP |
|---|
| 64 | \fBdetails \fR\fIID\fP |
|---|
| 65 | Displays detailed information about an entry. The id must refer to the |
|---|
| 66 | internal id as returned by the list command. |
|---|
| 67 | .TP |
|---|
| 68 | \fBpreview \fR\fIID\fP |
|---|
| 69 | Downloads the preview image into a temporary location and runs the default |
|---|
| 70 | image viewer on it. |
|---|
| 71 | .TP |
|---|
| 72 | \fBinstall \fR\fIID\fP |
|---|
| 73 | Downloads the payload file into a temporary location. No real installation |
|---|
| 74 | is done at the moment. |
|---|
| 75 | .TP |
|---|
| 76 | \fBcomment \fR\fIID\fP \fR\fICOMMENT\fP |
|---|
| 77 | Adds a comment to an entry. The comment text should be enclosed in "". |
|---|
| 78 | .TP |
|---|
| 79 | \fBrating \fR\fIID\fP \fR\fIRATING\fP |
|---|
| 80 | User rating for an entry. This is a value between 0 and 100. The overall |
|---|
| 81 | rating will then be accumulated from all ratings. |
|---|
| 82 | .SH "FILES" |
|---|
| 83 | .LP |
|---|
| 84 | \fI/etc/dxsclient.rc\fP |
|---|
| 85 | .LP |
|---|
| 86 | \fI~/.dxsclient.rc\fP |
|---|
| 87 | .SH "BUGS" |
|---|
| 88 | .LP |
|---|
| 89 | The DXS standard is not yet finished. The client and the server may |
|---|
| 90 | disagree about the acceptable messages and their contents. |
|---|
| 91 | .SH "AUTHORS" |
|---|
| 92 | .LP |
|---|
| 93 | Josef Spillner |
|---|
| 94 | <josef@kstuff.org> |
|---|
| 95 | .SH "SEE ALSO" |
|---|
| 96 | .LP |
|---|
| 97 | dxs(7) |
|---|
