.TH DOKUJCLIENT "1"
.SH NAME
dokujclient \- interact (read, write, ...) with an instance of Dokuwiki

.SH SYNOPSIS
.B dokujclient
\fIGENERAL_OPTIONS COMMAND COMMAND_OPTIONS\fR

.SH DESCRIPTION
Dokuwiki is an open source wiki engine.
It's hence meant to be mainly used through a web browser.
However, it also has an xmlrpc API.
.br
Dokujclient uses this xmlrpc API, so that it's possible to interact
with an instance of Dokuwiki through a console or a shell script.

.SH GENERAL OPTIONS
.TP
\fB\-\-url\fR \fIURL\fR
The url to the xmlrpc interface. Should look like http[s]://server/mywiki\fI/lib/exe/xmlrpc.php\fR.
.br
Obviously, the wiki should be configured to accept incoming xmlrpc queries.
See Dokuwiki's \fIremote\fR config.
.br
This parameter is mandatory.
.TP
\fB\-u\fR \fIUSER\fR, \fB\-\-user\fR \fIUSER\fR
Specify the username \fIUSER\fR to use to connect to the server.
.br
Obviously, the \fIUSER\fR should be authorized to use the xmlrpc interface.
See Dokuwiki's \fIremoteuser\fR config.
.TP
\fB\-p\fR \fIPASSWORD\fR, \fB\-\-password\fR \fIPASSWORD\fR
The password of the \fIUSER\fR
.TP
\fB\-\-password-interactive\fR
You will be prompted to enter the user's password interactively.
Useful to avoid writing the password in clear text in the command line.
.TP
\fB\-\-version\fR
Prints the version of dokujclient
.TP
\fB\-h\fR \fB\-\-help\fR
Prints the general help
.TP
\fB\-\-debug\fR
Enable debug mode, which will print more information

.SH COMMANDS
.TP
\fBhelp\fR
Prints the general help
.TP
\fBhelp\fR \fICOMMAND\fR
Prints the help and the \fICOMMAND_OPTIONS\fR for \fICOMMAND\fR
.TP
Other commands are:

.SH FILES
To avoid typing your url, user, and password each time, you may create in your home a file .dokujclientrc,
and put some or all of this info in it.

 echo "url=http://myhost/mywiki/lib/exe/xmlrpc.php" > ~/.dokujclientrc
 echo "user=toto" >> ~/.dokujclientrc
 echo "password=myPassword" >> ~/.dokujclientrc

.SH EXAMPLES

 dokujclient \-\-user myUser \-\-password myPassword \-\-url http://mywiki/lib/exe/xmlrpc.php getTitle
 > myWiki title

 dokujclient help
 > [(\-u|\-\-user) <user>] \-\-url <url> [(\-p|\-\-password) <password>] [\-h|\-\-help] [\-\-version] [\-\-password\-interactive] command
 >
 > Available commands:
 > [...skipped...]

 #put user, password, and url, in the config file
 vim ~/.dokujclientrc

 #get the list of pages of all the wiki
 dokujclient getPagelist .
 > [...skipped...]

 dokujclient appendPage builds:synthesis "Build launched at 12:23 took 3'24"
 dokujclient getPage builds:synthesis
 > Build launched at 11:12 took 3'19
 > Build launched at 12:23 took 3'24

 #help command can give information about a given command
 dokujclient help putAttachment
 > Syntax for putAttachment: [\-f|\-\-force] <attachmentId> <localFile>

 dokujclient putAttachment some:file.jpg ~/results.jpg

.SH REPORTING BUGS
You are welcome to report bugs to the bugtracker
https://github.com/gturri/dokujclient/issues
.br
You may also ask questions on the mailing list dokujclient@freelists.org

.SH SEE ALSO

The documentation of the server  API is available at
https://www.dokuwiki.org/devel:xmlrpc