Add man page for owncloudcmd

Fixes #1234
owncloud · Dec 4, 2013 · 72b0f4e · 72b0f4e
1 parent 861de89
commit 72b0f4e
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 4 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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 <sourcedir> <owncloudurl>" << std::endl;
     std::cout << "" << std::endl;
     std::cout << "Options:" << std::endl;
     std::cout << "  --confdir = configdir: Read config from there." << std::endl;