owncloudcmd.1.rst 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. :orphan:
  2. owncloudcmd(1)
  3. --------------
  4. SYNOPSIS
  5. ========
  6. *owncloudcmd* [`OPTIONS`...] sourcedir owncloudurl
  7. DESCRIPTION
  8. ===========
  9. owncloudcmd is the command line tool used for the ownCloud file synchronization
  10. desktop utility.
  11. Contrary to the :manpage:`owncloud(1)` GUI client, `owncloudcmd` only performs
  12. a single sync run and then exits. In so doing, `owncloudcmd` replaces the
  13. `ocsync` binary used for the same purpose in earlier releases.
  14. A *sync run* synchronizes a single local directory using a WebDAV share on a
  15. remote ownCloud server.
  16. To invoke the command line client, provide the local and the remote repository:
  17. The first parameter is the local directory. The second parameter is
  18. the server URL.
  19. .. note:: Prior to the 1.6 release of owncloudcmd, the tool only accepted
  20. ``owncloud://`` or ``ownclouds://`` in place of ``http://`` and ``https://`` as
  21. a scheme. See ``Examples`` for details.
  22. OPTIONS
  23. =======
  24. ``--user``, ``-u`` ``[user]``
  25. Use ``user`` as the login name.
  26. ``--password``, ``-p`` ``[password]``
  27. Use ``password`` as the password.
  28. ``-n``
  29. Use ``netrc (5)`` for login.
  30. ``--non-interactive``
  31. Do not prompt for questions.
  32. ``--silent``, ``--s``
  33. Inhibits verbose log output.
  34. ``--trust``
  35. Trust any SSL certificate, including invalid ones.
  36. ``--httpproxy http://[user@pass:]<server>:<port>``
  37. Uses ``server`` as HTTP proxy.
  38. ``--nonshib``
  39. Uses Non Shibboleth WebDAV Authentication
  40. ``--davpath [path]``
  41. Overrides the WebDAV Path with ``path``
  42. ``--exclude [file]``
  43. Exclude list file
  44. ``--unsyncedfolders [file]``
  45. File containing the list of un-synced folders (selective sync)
  46. ``--max-sync-retries [n]``
  47. Retries maximum n times (defaults to 3)
  48. ``-h``
  49. Sync hidden files,do not ignore them
  50. Example
  51. =======
  52. To synchronize the ownCloud directory ``Music`` to the local directory ``media/music``
  53. through a proxy listening on port ``8080`` on the gateway machine ``192.168.178.1``,
  54. the command line would be::
  55. $ owncloudcmd --httpproxy http://192.168.178.1:8080 \
  56. $HOME/media/music \
  57. https://server/owncloud/remote.php/webdav/Music
  58. ``owncloudcmd`` will enquire user name and password, unless they have
  59. been specified on the command line or ``-n`` (see `netrc(5)`) has been passed.
  60. Using the legacy scheme, it would be::
  61. $ owncloudcmd --httpproxy http://192.168.178.1:8080 \
  62. $HOME/media/music \
  63. ownclouds://server/owncloud/remote.php/webdav/Music
  64. BUGS
  65. ====
  66. Please report bugs at https://github.com/owncloud/client/issues.
  67. SEE ALSO
  68. ========
  69. :manpage:`owncloud(1)`