Skip to content

Commit

Permalink
Incorporate doc fixes from pull request #6122
Browse files Browse the repository at this point in the history
Fix issues on manpages

Signed-off-by: Claudio Cambra <[email protected]>
  • Loading branch information
claucambra committed Oct 18, 2024
1 parent 5412fd2 commit 34e4f40
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 79 deletions.
36 changes: 1 addition & 35 deletions doc/nextcloudcmd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,41 +52,7 @@ the server URL.

Other command line switches supported by ``nextcloudcmd`` include the following:

``--path``
Overrides default remote root folder to a specific subfolder on the server(e.g.: /Documents would sync the Documents subfolder on the server)

``--user``, ``-u`` ``[user]``
Use ``user`` as the login name.

``--password``, ``-p`` ``[password]``
Use ``password`` as the password.

``-n``
Use ``netrc (5)`` for login.

``--non-interactive``
Do not prompt for questions.

``--silent``, ``--s``
Inhibits verbose log output.

``--trust``
Trust any SSL certificate, including invalid ones.

``--httpproxy http://[user@pass:]<server>:<port>``
Uses ``server`` as HTTP proxy.

``--exclude [file]``
Exclude list file

``--unsyncedfolders [file]``
File containing the list of un-synced remote folders (selective sync)

``--max-sync-retries [n]``
Retries maximum n times (defaults to 3)

``-h``
Sync hidden files, do not ignore them
.. include:: ../doc/options-cmd.rst

Credential Handling
~~~~~~~~~~~~~~~~~~~
Expand Down
35 changes: 35 additions & 0 deletions doc/options-cmd.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
``--path``
Overrides default remote root folder to a specific subfolder on the server(e.g.: /Documents would sync the Documents subfolder on the server)

``--user``, ``-u`` `<user>`
Use ``user`` as the login name.

``--password``, ``-p`` `<password>`
Use `password` as the password.

``-n``
Use :manpage:`netrc(5)` for login.

``--non-interactive``
Do not prompt for questions.

``--silent``, ``--s``
Inhibits verbose log output.

``--trust``
Trust any SSL certificate, including invalid ones.

``--httpproxy`` `http://[user@pass:]<server>:<port>`
Uses `server` as HTTP proxy.

``--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
7 changes: 3 additions & 4 deletions man/nextcloud.1.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:orphan:

nextcloud(1)
————
------------

SYNOPSIS
========
Expand All @@ -14,17 +14,16 @@ The nextCloud Client is a file synchronization desktop utility. It synchronizes

Normally, you start the client by clicking on the desktop icon or by starting it from the client application menu. After starting, an nextCloud icon appears in the computer system tray or on your tablet or handheld device.

Options
OPTIONS
=======
.. include:: ../doc/options.rst

Config File
CONFIG FILE
===========
.. include:: ../doc/conffile.rst

BUGS
====

Please report bugs at https://github.com/nextcloud/client/issues.


Expand Down
46 changes: 6 additions & 40 deletions man/nextcloudcmd.1.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:orphan:

nextcloudcmd(1)
—————
---------------

SYNOPSIS
========
Expand Down Expand Up @@ -29,58 +29,24 @@ the server URL.

OPTIONS
=======
``--path``
Overrides default remote root folder to a specific subfolder on the server(e.g.: /Documents would sync the Documents subfolder on the server)

``—user``, ``-u`` ``[user]``
Use ``user`` as the login name.

``—password``, ``-p`` ``[password]``
Use ``password`` as the password.

``-n``
Use ``netrc (5)`` for login.

``—non-interactive``
Do not prompt for questions.

``—silent``, ``—s``
Inhibits verbose log output.

``—trust``
Trust any SSL certificate, including invalid ones.

``—httpproxy http://[user@pass:]<server>:<port>``
Uses ``server`` as HTTP proxy.

``—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
.. 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 \
$ 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 `netrc(5)`) has been passed.
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 \
$ nextcloudcmd --httpproxy http://192.168.178.1:8080 --path /Music \
$HOME/media/music \
ownclouds://server/nextcloud

Expand All @@ -91,4 +57,4 @@ Please report bugs at https://github.com/nextcloud/client/issues.

SEE ALSO
========
:manpage:`nextcloud(1)`
:manpage:`nextcloud(1)`, :manpage:`netrc(5)`

0 comments on commit 34e4f40

Please sign in to comment.