nextcloud-desktop/doc/owncloudcmd.1.rst

99 lines
2.6 KiB
ReStructuredText
Raw Normal View History

:orphan:
owncloudcmd(1)
--------------
SYNOPSIS
========
*owncloudcmd* [`OPTIONS`...] sourcedir owncloudurl
DESCRIPTION
===========
2014-06-26 00:04:33 +04:00
owncloudcmd is the command line tool used for the ownCloud file synchronization
2014-11-10 01:09:52 +03:00
desktop utility.
2014-06-26 00:04:33 +04:00
Contrary to the :manpage:`owncloud(1)` GUI client, `owncloudcmd` only performs
a single sync run and then exits. In so doing, `owncloudcmd` replaces the
`ocsync` binary used for the same purpose in earlier releases.
2014-06-26 00:04:33 +04:00
A *sync run* synchronizes a single local directory using a WebDAV share on a
remote ownCloud server.
2014-03-25 22:03:47 +04:00
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.
2014-06-26 00:04:33 +04:00
.. note:: Prior to the 1.6 release of owncloudcmd, the tool only accepted
``owncloud://`` or ``ownclouds://`` in place of ``http://`` and ``https://`` as
a scheme. See ``Examples`` for details.
2014-03-25 22:03:47 +04:00
OPTIONS
=======
2014-09-18 13:36:02 +04:00
``--user``, ``-u`` ``[user]``
Use ``user`` as the login name.
2014-09-18 13:36:02 +04:00
``--password``, ``-p`` ``[password]``
Use ``password`` as the password.
``-n``
Use ``netrc (5)`` for login.
``--non-interactive``
Do not prompt for questions.
``--silent``, ``--s``
2014-06-26 00:04:33 +04:00
Inhibits verbose log output.
2014-03-25 22:03:47 +04:00
2014-09-18 13:36:02 +04:00
``--trust``
Trust any SSL certificate, including invalid ones.
2014-03-25 22:03:47 +04:00
``--httpproxy http://[user@pass:]<server>:<port>``
2014-06-26 00:04:33 +04:00
Uses ``server`` as HTTP proxy.
2014-03-25 22:03:47 +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
Example
=======
2014-06-26 00:04:33 +04:00
To synchronize the ownCloud directory ``Music`` to the local directory ``media/music``
2014-03-25 22:03:47 +04:00
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
2014-09-18 13:36:02 +04:00
``owncloudcmd`` will enquire user name and password, unless they have
been specified on the command line or ``-n`` (see `netrc(5)`) has been passed.
2014-03-25 22:03:47 +04:00
2014-06-26 00:04:33 +04:00
Using the legacy scheme, it would be::
2014-03-25 22:03:47 +04:00
$ owncloudcmd --httpproxy http://192.168.178.1:8080 \
$HOME/media/music \
ownclouds://server/owncloud/remote.php/webdav/Music
BUGS
====
2014-11-10 01:09:52 +03:00
Please report bugs at https://github.com/owncloud/client/issues.
SEE ALSO
========
:manpage:`owncloud(1)`