nextcloud-desktop/doc/owncloudcmd.rst

80 lines
2.6 KiB
ReStructuredText
Raw Normal View History

2015-04-24 21:44:38 +03:00
The ownCloud Client packages contain a command line client, ``owncloudcmd``, that can
be used to synchronize ownCloud files to client machines.
``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::
2014-03-20 19:35:24 +04:00
2014-03-25 22:03:47 +04:00
owncloudcmd [OPTIONS...] sourcedir owncloudurl
2014-03-20 19:35:24 +04:00
2014-03-25 22:03:47 +04:00
where ``sourcedir`` is the local directory and ``owncloudurl`` is
2014-06-26 00:04:33 +04:00
the server URL.
2014-03-20 19:35:24 +04:00
Other command line switches supported by ``owncloudcmd`` include the following:
2014-03-20 19:35:24 +04:00
2014-09-18 13:36:02 +04:00
``--user``, ``-u`` ``[user]``
Use ``user`` as the login name.
2014-03-20 19:35:24 +04:00
2014-09-18 13:36:02 +04:00
``--password``, ``-p`` ``[password]``
Use ``password`` as the password.
2014-03-20 19:35:24 +04:00
2014-09-18 13:36:02 +04:00
``-n``
Use ``netrc (5)`` for login.
2014-09-18 13:36:02 +04:00
``--non-interactive``
Do not prompt for questions.
2014-09-18 13:36:02 +04:00
``--silent``, ``--s``
Inhibits verbose log output.
2014-09-18 13:36:02 +04:00
``--trust``
Trust any SSL certificate, including invalid ones.
2014-09-18 13:36:02 +04:00
``--httpproxy http://[user@pass:]<server>:<port>``
Uses ``server`` as HTTP proxy.
2014-03-20 19:35:24 +04:00
``--nonshib``
Uses Non Shibboleth WebDAV Authentication
``--davpath [path]``
Overrides the WebDAV Path with ``path``
``--exclude [file]``
Exclude list file
``--unsyncedfolders [file]``
File containing the list of unsynced folders (selective sync)
``--max-sync-retries [n]``
Retries maximum n times (defaults to 3)
``-h``
Sync hidden files,do not ignore them
2014-03-25 22:03:47 +04:00
Credential Handling
~~~~~~~~~~~~~~~~~~~
2014-03-20 19:35:24 +04:00
``owncloudcmd`` 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::
2014-03-20 19:35:24 +04:00
$ owncloudcmd / https://carla:secret@server/owncloud/remote.php/webdav/
2014-03-25 22:03:47 +04:00
2014-06-26 00:04:33 +04:00
To synchronize the ownCloud directory ``Music`` to the local directory
2014-09-18 13:36:02 +04:00
``media/music``, through a proxy listening on port ``8080``, and on a gateway
2014-06-26 00:04:33 +04:00
machine using IP address ``192.168.178.1``, the command line would be::
2014-03-25 22:03:47 +04:00
$ owncloudcmd --httpproxy http://192.168.178.1:8080 \
$HOME/media/music \
https://server/owncloud/remote.php/webdav/Music
``owncloudcmd`` will prompt for the user name and password, unless they have
2015-04-24 21:44:38 +03:00
been specified on the command line or ``-n`` has been passed.