diff --git a/doc/conf.py.in b/doc/conf.py.in index bdd3133c5af..5fb89bebb81 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -215,6 +215,8 @@ latex_documents = [ man_pages = [ ('owncloud.1', 'owncloud', u'File synchronisation desktop utility.', [u'The ownCloud developers'], 1), + ('owncloudcmd.1', 'owncloudcmd', u'Command line ownCloud client tool.', + [u'The ownCloud developers'], 1), ] # If true, show URL addresses after external links. diff --git a/doc/owncloud.1.rst b/doc/owncloud.1.rst index 71a814634f0..a67cf18341f 100644 --- a/doc/owncloud.1.rst +++ b/doc/owncloud.1.rst @@ -1,7 +1,8 @@ +:orphan: + owncloud(1) ----------- - SYNOPSIS ======== *owncloud* [`OPTIONS`...] @@ -28,10 +29,10 @@ Config File BUGS ==== -Please report bugs at https://github.com/owncloud/core/issues. +Please report bugs at https://github.com/owncloud/mirall/issues. SEE ALSO ======== - `csync(1)` +:manpage:`owncloudcmd(1)` diff --git a/doc/owncloudcmd.1.rst b/doc/owncloudcmd.1.rst new file mode 100644 index 00000000000..cf286e93ec2 --- /dev/null +++ b/doc/owncloudcmd.1.rst @@ -0,0 +1,34 @@ +:orphan: + +owncloudcmd(1) +-------------- + +SYNOPSIS +======== +*owncloudcmd* [`OPTIONS`...] sourcedir owncloudurl + +DESCRIPTION +=========== +owncloudcmd is the command line tool for the ownCloud file synchronisation +desktop utility, based on mirall. + +Contrary to the :manpage:`owncloud(1)` GUI client, `owncloudcmd` will only +perform a single sync run and then exit. It thus replaces the `ocsync` binary +used for the same purpose in earlier releases. + +A sync run will sync a single local directory with a WebDAV share on a +remote ownCloud server. + +OPTIONS +======= +``--confdir`` `PATH` + The configuration dir where `csync.conf` is located + +BUGS +==== +Please report bugs at https://github.com/owncloud/mirall/issues. + +SEE ALSO +======== +:manpage:`owncloud(1)` + diff --git a/src/owncloudcmd/owncloudcmd.cpp b/src/owncloudcmd/owncloudcmd.cpp index f1c0c42dc2b..b7a2f7da9c5 100644 --- a/src/owncloudcmd/owncloudcmd.cpp +++ b/src/owncloudcmd/owncloudcmd.cpp @@ -62,7 +62,7 @@ void help() { std::cout << "owncloudcmd - command line ownCloud client tool." << std::endl; std::cout << "" << std::endl; - std::cout << "Call owncloudcmd sourcedir owncloudurl" << std::endl; + std::cout << "Usage: owncloudcmd " << std::endl; std::cout << "" << std::endl; std::cout << "Options:" << std::endl; std::cout << " --confdir = configdir: Read config from there." << std::endl;