From 33fdbb491e92b6976673e222b2efdf6057aab844 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sandro=20Knau=C3=9F?= Date: Mon, 9 Oct 2023 00:21:22 +0200 Subject: [PATCH 1/5] replace em-dash with -- MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This breaks the manpage build ( no headlines are shown) and it is syntactically wrong, the cli has -- for long options. Signed-off-by: Sandro Knauß --- man/nextcloud.1.rst | 2 +- man/nextcloudcmd.1.rst | 24 ++++++++++++------------ 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/man/nextcloud.1.rst b/man/nextcloud.1.rst index 95feac6440521..2a7759c09997d 100644 --- a/man/nextcloud.1.rst +++ b/man/nextcloud.1.rst @@ -1,7 +1,7 @@ :orphan: nextcloud(1) -———— +------------ SYNOPSIS ======== diff --git a/man/nextcloudcmd.1.rst b/man/nextcloudcmd.1.rst index a78a99a2366e1..89e45d71f8b9a 100644 --- a/man/nextcloudcmd.1.rst +++ b/man/nextcloudcmd.1.rst @@ -1,7 +1,7 @@ :orphan: nextcloudcmd(1) -————— +--------------- SYNOPSIS ======== @@ -32,34 +32,34 @@ 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]`` +``--user``, ``-u`` ``[user]`` Use ``user`` as the login name. -``—password``, ``-p`` ``[password]`` +``--password``, ``-p`` ``[password]`` Use ``password`` as the password. ``-n`` Use ``netrc (5)`` for login. -``—non-interactive`` +``--non-interactive`` Do not prompt for questions. -``—silent``, ``—s`` +``--silent``, ``--s`` Inhibits verbose log output. -``—trust`` +``--trust`` Trust any SSL certificate, including invalid ones. -``—httpproxy http://[user@pass:]:`` +``--httpproxy http://[user@pass:]:`` Uses ``server`` as HTTP proxy. -``—exclude [file]`` +``--exclude [file]`` Exclude list file -``—unsyncedfolders [file]`` +``--unsyncedfolders [file]`` File containing the list of unsynced folders (selective sync) -``—max-sync-retries [n]`` +``--max-sync-retries [n]`` Retries maximum n times (defaults to 3) ``-h`` @@ -71,7 +71,7 @@ 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 @@ -80,7 +80,7 @@ been specified on the command line or ``-n`` (see `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 From 1925e24afb91f245965ef95b86ec48d2d8495112 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sandro=20Knau=C3=9F?= Date: Mon, 9 Oct 2023 00:26:38 +0200 Subject: [PATCH 2/5] Sections on manpages are uppercase. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Sandro Knauß --- man/nextcloud.1.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/man/nextcloud.1.rst b/man/nextcloud.1.rst index 2a7759c09997d..66b08912132d3 100644 --- a/man/nextcloud.1.rst +++ b/man/nextcloud.1.rst @@ -14,11 +14,11 @@ 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 From a9af2202f364ac821f1db272fd8db540c367e7ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sandro=20Knau=C3=9F?= Date: Mon, 9 Oct 2023 00:26:54 +0200 Subject: [PATCH 3/5] remove empty line. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Sandro Knauß --- man/nextcloud.1.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/man/nextcloud.1.rst b/man/nextcloud.1.rst index 66b08912132d3..f40ea364d7ca7 100644 --- a/man/nextcloud.1.rst +++ b/man/nextcloud.1.rst @@ -24,7 +24,6 @@ CONFIG FILE BUGS ==== - Please report bugs at https://github.com/nextcloud/client/issues. From b52b97e884f09ba50b1f9952ea065d42293c5ec9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sandro=20Knau=C3=9F?= Date: Mon, 9 Oct 2023 00:31:24 +0200 Subject: [PATCH 4/5] Move options of nextcloudcmd for easier changes. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Sandro Knauß --- doc/nextcloudcmd.rst | 36 +----------------------------------- doc/options-cmd.rst | 35 +++++++++++++++++++++++++++++++++++ man/nextcloudcmd.1.rst | 36 +----------------------------------- 3 files changed, 37 insertions(+), 70 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/nextcloudcmd.1.rst b/man/nextcloudcmd.1.rst index 89e45d71f8b9a..280de8015a740 100644 --- a/man/nextcloudcmd.1.rst +++ b/man/nextcloudcmd.1.rst @@ -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 ======= From 9dc107db5ca3a7b566b76ce5437d96dcf7d636fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sandro=20Knau=C3=9F?= Date: Mon, 9 Oct 2023 00:31:58 +0200 Subject: [PATCH 5/5] Mark netrc(5) as manpage links. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Sandro Knauß --- man/nextcloudcmd.1.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/man/nextcloudcmd.1.rst b/man/nextcloudcmd.1.rst index 280de8015a740..00afd3cbca45a 100644 --- a/man/nextcloudcmd.1.rst +++ b/man/nextcloudcmd.1.rst @@ -42,7 +42,7 @@ the command line would be:: 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:: @@ -57,4 +57,4 @@ Please report bugs at https://github.com/nextcloud/client/issues. SEE ALSO ======== -:manpage:`nextcloud(1)` +:manpage:`nextcloud(1)`, :manpage:`netrc(5)`