diff options
author | Carla Schroder <carla@owncloud.com> | 2015-04-24 21:34:20 +0300 |
---|---|---|
committer | Carla Schroder <carla@owncloud.com> | 2015-04-24 21:42:10 +0300 |
commit | 60c18f75b50dce9305a0638659a008c18f23725c (patch) | |
tree | 51641417c576c5d4ebd140317822ad05dc2e426b /doc | |
parent | c7f3791f3da381a27d711c6e5ea362f7c38e9c5c (diff) |
update owncloud and owncloudcmd docs
Conflicts:
doc/owncloudcmd.rst
Diffstat (limited to 'doc')
-rw-r--r-- | doc/advancedusage.rst | 1 | ||||
-rw-r--r-- | doc/options.rst | 21 | ||||
-rw-r--r-- | doc/owncloudcmd.rst | 69 |
3 files changed, 42 insertions, 49 deletions
diff --git a/doc/advancedusage.rst b/doc/advancedusage.rst index 7204d45a9..df40707a0 100644 --- a/doc/advancedusage.rst +++ b/doc/advancedusage.rst @@ -1,3 +1,4 @@ +============== Advanced Usage ============== diff --git a/doc/options.rst b/doc/options.rst index 7261e0d88..037f29b29 100644 --- a/doc/options.rst +++ b/doc/options.rst @@ -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 diff --git a/doc/owncloudcmd.rst b/doc/owncloudcmd.rst index c8f7c97ab..128409234 100644 --- a/doc/owncloudcmd.rst +++ b/doc/owncloudcmd.rst @@ -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 |