update owncloud and owncloudcmd docs
authorCarla Schroder <carla@owncloud.com>
Fri, 24 Apr 2015 18:34:20 +0000 (11:34 -0700)
committerCarla Schroder <carla@owncloud.com>
Fri, 24 Apr 2015 18:42:10 +0000 (11:42 -0700)
Conflicts:
doc/owncloudcmd.rst

doc/advancedusage.rst
doc/options.rst
doc/owncloudcmd.rst

index 7204d45a9efdbc89d6454cd680beaed231922625..df40707a069b441dd42ea84ac20ececd86ca4acf 100644 (file)
@@ -1,3 +1,4 @@
+==============
 Advanced Usage
 ==============
 
index 7261e0d88d856f3416a61743db1fbb2aeb8eeea3..037f29b290146935456c97fb1a8e1daa088eb4b1 100644 (file)
@@ -1,23 +1,28 @@
-When invoking the client from the command line, the following options are supported:
+You have the option of starting your ownCloud desktop client with the 
+``owncloud`` command. The following options are supported:
 
-``-h``, ``--help``
+``owncloud -h`` or ``owncloud --help``
         Displays all command options.
 
+The other options are:
+
 ``--logwindow``
         Opens a window displaying log output.
 
 ``--logfile`` `<filename>`
-        Write log output to the file specified. To write to stdout, specify `-` as the filename.
+        Write log output to the file specified. To write to stdout, specify `-` 
+        as the filename.
 
 ``--logdir`` `<name>`
-        Writes each synchronization log output in a new file in the specified directory.
-
+        Writes each synchronization log output in a new file in the specified 
+        directory.
+        
 ``--logexpire`` `<hours>`
-        Removes logs older than the value specified (in hours). This command is used with ``--logdir``.
+        Removes logs older than the value specified (in hours). This command is 
+        used with ``--logdir``.
 
 ``--logflush``
         Clears (flushes) the log file after each write action.
 
 ``--confdir`` `<dirname>`
-        Uses the specified configuration directory.
-
+        Uses the specified configuration directory.
\ No newline at end of file
index c8f7c97ab8bdc2fc7378104241611e7f9a7c1978..1284092341e62f8c8b2f0bde3e0ad64951f12d18 100644 (file)
@@ -1,16 +1,15 @@
-The ownCloud Client packages contain a command line client that can be used to
-synchronize ownCloud files to client machines. The command line client is
-called ``owncloudcmd``.
-
-owncloudcmd performs a single *sync run* and then exits the synchronization
-process. In this manner, owncloudcmd processes the differences between client
-and server directories and propagates the files to bring both repositories to
-the same state. Contrary to the GUI-based client, ``owncloudcmd`` does not 
-repeat
-synchronizations on its own. It also does not monitor for file system changes.
-
-To invoke ``owncloudcmd``, you must provide the local and the remote 
-repository
+The ownCloud Client packages contain a command line client, `owncloud`, that can 
+be used to synchronize ownCloud files to client machines. The command line 
+client is called ``owncloudcmd``.
+
+``owncloudcmd`` performs a single *sync run* and then exits the synchronization 
+process. In this manner, ``owncloudcmd`` processes the differences between 
+client and server directories and propagates the files to bring both 
+repositories to the same state. Contrary to the GUI-based client, 
+``owncloudcmd`` does not repeat synchronizations on its own. It also does not 
+monitor for file system changes.
+
+To invoke ``owncloudcmd``, you must provide the local and the remote repository 
 URL using the following command::
 
   owncloudcmd [OPTIONS...] sourcedir owncloudurl
@@ -18,45 +17,41 @@ URL using the following command::
 where ``sourcedir`` is the local directory and ``owncloudurl`` is
 the server URL.
 
-.. note:: Prior to the 1.6 version of owncloudcmd, the tool only accepted
-   ``owncloud://`` or ``ownclouds://`` in place of ``http://`` and ``https://`` as
-   a scheme. See ``Examples`` for details.
-
-Other comand line switches supported by owncloudcmd include the following:
+Other command line switches supported by ``owncloudcmd`` include the following:
 
 ``--user``, ``-u`` ``[user]``
-       Use ``user`` as the login name.
+      Specify the user's login name.
 
 ``--password``, ``-p`` ``[password]``
-       Use ``password`` as the password.
+      Specify the user's password.
 
 ``-n``
-       Use ``netrc (5)`` for login.
+      Use ``netrc (5)`` for login.
 
 ``--non-interactive``
-       Do not prompt for questions.
+      Do not prompt for questions.
 
 ``--silent``, ``-s``
-       Inhibits verbose log output.
+      Inhibits verbose log output.
 
 ``--trust``
-       Trust any SSL certificate, including invalid ones.
+      Trust any SSL certificate, including invalid ones.
 
 ``--httpproxy  http://[user@pass:]<server>:<port>``
       Uses the specified ``server`` as the HTTP proxy.
+      
+``--unsyncedfolders [file]`` 
+      File containing list of folders to not sync
 
 Credential Handling
 ~~~~~~~~~~~~~~~~~~~
 
 By default, ``owncloudcmd`` reads the client configuration and uses the 
-credentials of the GUI synchronization client. If no client is configured, or if you choose
-to use a different user to synchronize, you can specify the user password
-setting with the usual URL pattern.  For example::
-
-  https://user:secret@192.168.178.2/remote.php/webdav
+credentials of the GUI synchronization client. If no client is configured, or if 
+you choose to use a different user to synchronize, you can specify the user 
+password setting with the usual URL pattern.  For example::
 
-Example
-~~~~~~~
+  $ owncloudcmd / https://carla:secret@server/owncloud/remote.php/webdav/
 
 To synchronize the ownCloud directory ``Music`` to the local directory
 ``media/music``, through a proxy listening on port ``8080``, and on a gateway
@@ -66,13 +61,5 @@ machine using IP address ``192.168.178.1``, the command line would be::
                 $HOME/media/music \
                 https://server/owncloud/remote.php/webdav/Music
 
-``owncloudcmd`` will enquire user name and password, unless they have
-been specified on the command line or ``-n`` has been passed.
-
-Using the legacy scheme, the command line would be::
-
-  $ owncloudcmd --httpproxy http://192.168.178.1:8080 \
-                $HOME/media/music \
-                ownclouds://server/owncloud/remote.php/webdav/Music
-
-
+``owncloudcmd`` will prompt for the user name and password, unless they have
+been specified on the command line or ``-n`` has been passed.
\ No newline at end of file