Incorporate doc fixes from pull request #6122

Fix issues on manpages

Signed-off-by: Claudio Cambra <claudio.cambra@nextcloud.com>

diff --git a/doc/nextcloudcmd.rst b/doc/nextcloudcmd.rst
index 57de7e2b8bc2275d7e556689a66ec4c20a6db97a..23b0212a439e5d0640d93b5ed4a03eda7ef96933 100644 (file)
--- 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:]<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
 ~~~~~~~~~~~~~~~~~~~

diff --git a/doc/options-cmd.rst b/doc/options-cmd.rst
new file mode 100644 (file)
index 0000000..6e14265
--- /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`` `<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

diff --git a/man/nextcloud.1.rst b/man/nextcloud.1.rst
index 95feac644052148db85aae608829e97a3d400ed1..f40ea364d7ca736946fa8349b6948c0b5b2945ef 100644 (file)
--- 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 a78a99a2366e1c5e80ab56875fdf427d5c87cf0e..00afd3cbca45a6f9d8e6bbfcaf3571dd331bcd81 100644 (file)
--- 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:]<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
 =======
@@ -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)`