Incorporate doc fixes from pull request #6122

Fix issues on manpages

Signed-off-by: Claudio Cambra <claudio.cambra@nextcloud.com>
This commit is contained in:
Claudio Cambra 2023-10-09 10:34:40 +08:00
parent 5412fd2498
commit 34e4f40408
4 changed files with 45 additions and 79 deletions

View file

@ -52,41 +52,7 @@ the server URL.
Other command line switches supported by ``nextcloudcmd`` include the following: Other command line switches supported by ``nextcloudcmd`` include the following:
``--path`` .. include:: ../doc/options-cmd.rst
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
Credential Handling Credential Handling
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~

35
doc/options-cmd.rst Normal file
View file

@ -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

View file

@ -1,7 +1,7 @@
:orphan: :orphan:
nextcloud(1) nextcloud(1)
———— ------------
SYNOPSIS SYNOPSIS
======== ========
@ -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. 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 .. include:: ../doc/options.rst
Config File CONFIG FILE
=========== ===========
.. include:: ../doc/conffile.rst .. include:: ../doc/conffile.rst
BUGS BUGS
==== ====
Please report bugs at https://github.com/nextcloud/client/issues. Please report bugs at https://github.com/nextcloud/client/issues.

View file

@ -1,7 +1,7 @@
:orphan: :orphan:
nextcloudcmd(1) nextcloudcmd(1)
————— ---------------
SYNOPSIS SYNOPSIS
======== ========
@ -29,41 +29,7 @@ the server URL.
OPTIONS OPTIONS
======= =======
``--path`` .. include:: ../doc/options-cmd.rst
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
Example Example
======= =======
@ -71,16 +37,16 @@ To synchronize the nextCloud directory ``Music`` to the local directory ``media/
through a proxy listening on port ``8080`` on the gateway machine ``192.168.178.1``, through a proxy listening on port ``8080`` on the gateway machine ``192.168.178.1``,
the command line would be:: 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 \ $HOME/media/music \
https://server/nextcloud https://server/nextcloud
``nextcloudcmd`` will enquire user name and password, unless they have ``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:: 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 \ $HOME/media/music \
ownclouds://server/nextcloud ownclouds://server/nextcloud
@ -91,4 +57,4 @@ Please report bugs at https://github.com/nextcloud/client/issues.
SEE ALSO SEE ALSO
======== ========
:manpage:`nextcloud(1)` :manpage:`nextcloud(1)`, :manpage:`netrc(5)`