2015-04-24 18:34:20 +00:00
|
|
|
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
|
2014-12-31 19:27:52 +00:00
|
|
|
URL using the following command::
|
2014-03-20 15:35:24 +00:00
|
|
|
|
2014-03-25 18:03:47 +00:00
|
|
|
owncloudcmd [OPTIONS...] sourcedir owncloudurl
|
2014-03-20 15:35:24 +00:00
|
|
|
|
2014-03-25 18:03:47 +00:00
|
|
|
where ``sourcedir`` is the local directory and ``owncloudurl`` is
|
2014-06-25 20:04:33 +00:00
|
|
|
the server URL.
|
2014-03-20 15:35:24 +00:00
|
|
|
|
2015-04-24 18:34:20 +00:00
|
|
|
Other command line switches supported by ``owncloudcmd`` include the following:
|
2014-03-20 15:35:24 +00:00
|
|
|
|
2014-09-18 09:36:02 +00:00
|
|
|
``--user``, ``-u`` ``[user]``
|
2015-04-24 18:34:20 +00:00
|
|
|
Specify the user's login name.
|
2014-03-20 15:35:24 +00:00
|
|
|
|
2014-09-18 09:36:02 +00:00
|
|
|
``--password``, ``-p`` ``[password]``
|
2015-04-24 18:34:20 +00:00
|
|
|
Specify the user's password.
|
2014-03-20 15:35:24 +00:00
|
|
|
|
2014-09-18 09:36:02 +00:00
|
|
|
``-n``
|
2015-04-24 18:34:20 +00:00
|
|
|
Use ``netrc (5)`` for login.
|
2014-09-18 09:36:02 +00:00
|
|
|
|
|
|
|
|
``--non-interactive``
|
2015-04-24 18:34:20 +00:00
|
|
|
Do not prompt for questions.
|
2014-09-18 09:36:02 +00:00
|
|
|
|
|
|
|
|
``--silent``, ``-s``
|
2015-04-24 18:34:20 +00:00
|
|
|
Inhibits verbose log output.
|
2014-09-18 09:36:02 +00:00
|
|
|
|
|
|
|
|
``--trust``
|
2015-04-24 18:34:20 +00:00
|
|
|
Trust any SSL certificate, including invalid ones.
|
2014-09-18 09:36:02 +00:00
|
|
|
|
|
|
|
|
``--httpproxy http://[user@pass:]<server>:<port>``
|
2014-06-25 20:04:33 +00:00
|
|
|
Uses the specified ``server`` as the HTTP proxy.
|
2015-04-24 18:34:20 +00:00
|
|
|
|
|
|
|
|
``--unsyncedfolders [file]``
|
|
|
|
|
File containing list of folders to not sync
|
2014-03-20 15:35:24 +00:00
|
|
|
|
2014-03-25 18:03:47 +00:00
|
|
|
Credential Handling
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~
|
2014-03-20 15:35:24 +00:00
|
|
|
|
2014-12-31 19:27:52 +00:00
|
|
|
By default, ``owncloudcmd`` reads the client configuration and uses the
|
2015-04-24 18:34:20 +00:00
|
|
|
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::
|
2014-03-20 15:35:24 +00:00
|
|
|
|
2015-04-24 18:34:20 +00:00
|
|
|
$ owncloudcmd / https://carla:secret@server/owncloud/remote.php/webdav/
|
2014-03-25 18:03:47 +00:00
|
|
|
|
2014-06-25 20:04:33 +00:00
|
|
|
To synchronize the ownCloud directory ``Music`` to the local directory
|
2014-09-18 09:36:02 +00:00
|
|
|
``media/music``, through a proxy listening on port ``8080``, and on a gateway
|
2014-06-25 20:04:33 +00:00
|
|
|
machine using IP address ``192.168.178.1``, the command line would be::
|
2014-03-25 18:03:47 +00:00
|
|
|
|
|
|
|
|
$ owncloudcmd --httpproxy http://192.168.178.1:8080 \
|
|
|
|
|
$HOME/media/music \
|
|
|
|
|
https://server/owncloud/remote.php/webdav/Music
|
|
|
|
|
|
2015-04-24 18:34:20 +00:00
|
|
|
``owncloudcmd`` will prompt for the user name and password, unless they have
|
|
|
|
|
been specified on the command line or ``-n`` has been passed.
|
