nextcloud-desktop/man/nextcloudcmd.1.rst
Claudio Cambra 34e4f40408 Incorporate doc fixes from pull request #6122
Fix issues on manpages

Signed-off-by: Claudio Cambra <claudio.cambra@nextcloud.com>
2024-10-18 13:33:59 +08:00

60 lines
1.8 KiB
ReStructuredText

:orphan:
nextcloudcmd(1)
---------------
SYNOPSIS
========
*nextcloudcmd* [`OPTIONS`...] sourcedir nextcloudurl
DESCRIPTION
===========
nextcloudcmd is the command line tool used for the nextCloud file synchronization
desktop utility.
Contrary to the :manpage:`nextcloud(1)` GUI client, `nextcloudcmd` only performs
a single sync run and then exits. In so doing, `nextcloudcmd` replaces the
`ocsync` binary used for the same purpose in earlier releases.
A *sync run* synchronizes a single local directory using a WebDAV share on a
remote nextCloud server.
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.
.. note:: Prior to the 1.6 release of nextcloudcmd, the tool only accepted
``owncloud://`` or ``ownclouds://`` in place of ``http://`` and ``https://`` as
a scheme. See ``Examples`` for details.
OPTIONS
=======
.. include:: ../doc/options-cmd.rst
Example
=======
To synchronize the nextCloud directory ``Music`` to the local directory ``media/music``
through a proxy listening on port ``8080`` on the gateway machine ``192.168.178.1``,
the command line would be::
$ nextcloudcmd --httpproxy http://192.168.178.1:8080 --path /Music \
$HOME/media/music \
https://server/nextcloud
``nextcloudcmd`` will enquire user name and password, unless they have
been specified on the command line or ``-n`` (see :manpage:`netrc(5)`) has been passed.
Using the legacy scheme, it would be::
$ nextcloudcmd --httpproxy http://192.168.178.1:8080 --path /Music \
$HOME/media/music \
ownclouds://server/nextcloud
BUGS
====
Please report bugs at https://github.com/nextcloud/client/issues.
SEE ALSO
========
:manpage:`nextcloud(1)`, :manpage:`netrc(5)`