[Pkg-owncloud-commits] [owncloud-client] 210/333: Update owncloudcmd docs

[Sandro Knauß]

This is an automated email from the git hooks/post-receive script.

hefee-guest pushed a commit to branch master
in repository owncloud-client.

commit 1b5e14fbc54037ca71f37c2e04aa37295dd1ec3b
Author: Daniel Molkentin <danimo at owncloud.com>
Date:   Tue Mar 25 19:03:47 2014 +0100

    Update owncloudcmd docs
    
    Fixes #1587
---
 doc/owncloudcmd.1.rst | 32 ++++++++++++++++++++++++++++
 doc/owncloudcmd.rst   | 58 +++++++++++++++++++++++++++++++++++----------------
 2 files changed, 72 insertions(+), 18 deletions(-)

diff --git a/doc/owncloudcmd.1.rst b/doc/owncloudcmd.1.rst
index cf286e9..8ea736d 100644
--- a/doc/owncloudcmd.1.rst
+++ b/doc/owncloudcmd.1.rst
@@ -19,11 +19,43 @@ 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.
 
+To invoke the command line client, provide the local and the remote repository:
+The first parameter is the local directory. The second parameter is
+the server URL.
+
+.. note:: Prior to 1.6, the tool only accepted ``owncloud://`` or ``ownclouds://``
+          in place of ``http://`` and ``https://`` as a scheme. See ``Examples``
+          for details.
+
 OPTIONS
 =======
 ``--confdir`` `PATH`
        The configuration dir where `csync.conf` is located
 
+``--silent``
+       Don't give verbose log output
+
+``--httpproxy  http://[user@pass:]<server>:<port>``
+      Use ``server`` as HTTP proxy
+
+Example
+=======
+To sync the ownCloud directory ``Music`` to the local directory ``media/music``
+through a proxy listening on port ``8080`` on the gateway machine ``192.168.178.1``,
+the command line would be::
+
+  $ owncloudcmd --httpproxy http://192.168.178.1:8080 \
+                $HOME/media/music \
+                https://server/owncloud/remote.php/webdav/Music
+
+
+Using the legacy scheme, it would look like this::
+
+  $ owncloudcmd --httpproxy http://192.168.178.1:8080 \
+                $HOME/media/music \
+                ownclouds://server/owncloud/remote.php/webdav/Music
+
+
 BUGS
 ====
 Please report bugs at https://github.com/owncloud/mirall/issues.
diff --git a/doc/owncloudcmd.rst b/doc/owncloudcmd.rst
index 9e7a173..479d39b 100644
--- a/doc/owncloudcmd.rst
+++ b/doc/owncloudcmd.rst
@@ -2,41 +2,63 @@ The ownCloud Client packages come with a command line client which
 can be used to synchronize ownCloud files to client machines. The
 command line client is called ``owncloudcmd``.
 
-owncloudcmd does exactly one sync run and exits after that is finished.
+owncloudcmd performs a single sync run and then exits.
 That means that it processes the differences between client- and
 server directory and propagates the files to get both repositories
-on the same status. Other than the GUI based client, it does not
-repeat that or monitors for file system changes.
+on the same status. Contrary to the GUI based client, it does not
+repeat syncs on its own. It does also not monitor for file system
+changes.
 
 To invoke the command line client, the user has to provide the local
-and the remote repository urls:
+and the remote repository urls::
 
-``owncloudcmd <local_dir> <remote_url>``
+  owncloudcmd [OPTIONS...] sourcedir owncloudurl
 
-The first parameter is the local directory. The second parameter is
+where ``sourcedir`` is the local directory and ``owncloudurl`` is
 the server url.
 
-.. note:: To access the ownCloud server over SSL, the url scheme has to be ``owncluods``.
-          To access it via an unencrypted http connection (not recommended) the url scheme is ``owncloud``
+.. note:: Prior to 1.6, the tool only accepted ``owncloud://`` or
+          ``ownclouds://`` in place of ``http://`` and ``https://``
+          as a scheme. See ``Examples`` for details.
 
 These are other comand line switches supported by owncloudcmd:
 
-``--silent``: Don't give verbose log output
+``--silent``
+      Don't give verbose log output
 
-``--confdir <confdir>``: Fetch or store configuration in this custom config directory
+``--confdir`` `PATH`
+      Fetch or store configuration in this custom config directory
 
-``--httpproxy``: Use this http proxy. The proxy specification is ``http://<proxy>:<port>``.
+``--httpproxy  http://[user@pass:]<server>:<port>``
+      Use ``server`` as HTTP proxy
 
-**Credential Handling**
+Credential Handling
+~~~~~~~~~~~~~~~~~~~
 
-By default, owncloudcmd reads the client configuration and uses the credentials of
-the GUI sync client. If no client was configured or to use a different user to sync,
-the user password setting can be specified with the usual url pattern, for example ``owncloud://user:secret@192.168.178.2/remote.php/webdav``
+By default, owncloudcmd reads the client configuration and uses the credentials
+of the GUI sync client. If no client was configured or to use a different user
+to sync, the user password setting can be specified with the usual URL pattern,
+for example::
 
+  https://user:secret@192.168.178.2/remote.php/webdav
 
-**Example**
 
-To sync the ownCloud directory *Music* to the local directory *media/music* through the proxy on the gateway machine 192.168.178.1, the command line would look like
+Example
+~~~~~~~
+
+To sync the ownCloud directory ``Music`` to the local directory ``media/music``
+through a proxy listening on port ``8080`` on the gateway machine ``192.168.178.1``,
+the command line would be::
+
+  $ owncloudcmd --httpproxy http://192.168.178.1:8080 \
+                $HOME/media/music \
+                https://server/owncloud/remote.php/webdav/Music
+
+
+Using the legacy scheme, it would look like this::
+
+  $ owncloudcmd --httpproxy http://192.168.178.1:8080 \
+                $HOME/media/music \
+                ownclouds://server/owncloud/remote.php/webdav/Music
 
 
-``owncloudcmd --httpproxy http://192.168.178.1:8080 $HOME/media/music ownclouds://server/owncloud/remote.php/webdav/Music``

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud-client.git