From 65f2ca726203061dd846f681d23b34909b6335e6 Mon Sep 17 00:00:00 2001 From: Claudio Cambra Date: Mon, 9 Oct 2023 10:34:40 +0800 Subject: [PATCH] Incorporate doc fixes from pull request #6122s Fix issues on manpages Signed-off-by: Claudio Cambra --- doc/nextcloudcmd.rst | 36 +-------------------------------- doc/options-cmd.rst | 35 ++++++++++++++++++++++++++++++++ man/nextcloud.1.rst | 7 +++---- man/nextcloudcmd.1.rst | 46 ++++++------------------------------------ 4 files changed, 45 insertions(+), 79 deletions(-) create mode 100644 doc/options-cmd.rst diff --git a/doc/nextcloudcmd.rst b/doc/nextcloudcmd.rst index 57de7e2b8bc22..23b0212a439e5 100644 --- a/doc/nextcloudcmd.rst +++ b/doc/nextcloudcmd.rst @@ -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:]:`` - 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 ~~~~~~~~~~~~~~~~~~~ diff --git a/doc/options-cmd.rst b/doc/options-cmd.rst new file mode 100644 index 0000000000000..6e1426564ccae --- /dev/null +++ b/doc/options-cmd.rst @@ -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`` `` + Use ``user`` as the login name. + +``--password``, ``-p`` `` + 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:]:` + Uses `server` as HTTP proxy. + +``--exclude`` `` + Exclude list file + +``--unsyncedfolders`` `` + File containing the list of unsynced folders (selective sync) + +``--max-sync-retries`` `` + Retries maximum n times (defaults to 3) + +``-h`` + Sync hidden files,do not ignore them diff --git a/man/nextcloud.1.rst b/man/nextcloud.1.rst index 95feac6440521..f40ea364d7ca7 100644 --- a/man/nextcloud.1.rst +++ b/man/nextcloud.1.rst @@ -1,7 +1,7 @@ :orphan: nextcloud(1) -———— +------------ 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. -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. diff --git a/man/nextcloudcmd.1.rst b/man/nextcloudcmd.1.rst index a78a99a2366e1..00afd3cbca45a 100644 --- a/man/nextcloudcmd.1.rst +++ b/man/nextcloudcmd.1.rst @@ -1,7 +1,7 @@ :orphan: nextcloudcmd(1) -————— +--------------- SYNOPSIS ======== @@ -29,41 +29,7 @@ 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:]:`` - 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 ======= @@ -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``, 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 @@ -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)`