From 895e2ddb4389f2b7789ff01cabaf2d5ff19ae0da Mon Sep 17 00:00:00 2001
From: Chris Mayo <aklhfex@gmail.com>
Date: Mon, 29 Nov 2021 19:48:50 +0000
Subject: [PATCH] Improve documentation of output

---
 doc/src/man/linkchecker.rst   | 9 ++++-----
 doc/src/man/linkcheckerrc.rst | 8 ++++----
 2 files changed, 8 insertions(+), 9 deletions(-)

diff --git a/doc/src/man/linkchecker.rst b/doc/src/man/linkchecker.rst
index f1efcb01..91aacca9 100644
--- a/doc/src/man/linkchecker.rst
+++ b/doc/src/man/linkchecker.rst
@@ -124,7 +124,7 @@ Output options
 .. option:: -F TYPE[/ENCODING][/FILENAME], --file-output=TYPE[/ENCODING][/FILENAME]
 
     Output to a file linkchecker-out.TYPE,
-    $HOME/.linkchecker/failures for failures output, or
+    $HOME/.linkchecker/failures for the failures output type, or
     FILENAME if specified. The ENCODING specifies the output
     encoding, the default is that of your locale. Valid encodings are
     listed at
@@ -147,10 +147,9 @@ Output options
 
 .. option:: -o TYPE[/ENCODING], --output=TYPE[/ENCODING]
 
-    Specify output type as text, html, sql, csv,
+    Specify the console output type as text, html, sql, csv,
     gml, dot, xml, sitemap, none or failures.
-    Default type is text. The various output types are documented
-    below.
+    Default type is text. The various output types are documented below.
     The ENCODING specifies the output encoding, the default is that of
     your locale. Valid encodings are listed at
     https://docs.python.org/library/codecs.html#standard-encodings.
@@ -158,7 +157,7 @@ Output options
 .. option:: -q, --quiet
 
     Quiet operation, an alias for :option:`-o` *none*. This is only useful with
-    :option:`-F`.
+    :option:`-F`, else no results will be output.
 
 .. option:: -v, --verbose
 
diff --git a/doc/src/man/linkcheckerrc.rst b/doc/src/man/linkcheckerrc.rst
index 8eb49328..10e1dd25 100644
--- a/doc/src/man/linkcheckerrc.rst
+++ b/doc/src/man/linkcheckerrc.rst
@@ -169,14 +169,14 @@ output
     Command line option: :option:`--debug`
 **fileoutput=**\ *TYPE*\ [**,**\ *TYPE*...]
     Output to a file **linkchecker-out.**\ *TYPE*, or
-    **$HOME/.linkchecker/failures** for **failures** output.
+    **$HOME/.linkchecker/failures** for the **failures** output type.
     Valid file output types are **text**, **html**, **sql**, **csv**,
     **gml**, **dot**, **xml**, **none** or **failures**. Default is no
     file output. The various output types are documented below. Note
     that you can suppress all console output with **output=none**.
     Command line option: :option:`--file-output`
 **log=**\ *TYPE*\ [**/**\ *ENCODING*]
-    Specify output type as **text**, **html**, **sql**, **csv**,
+    Specify the console output type as **text**, **html**, **sql**, **csv**,
     **gml**, **dot**, **xml**, **none** or **failures**. Default type
     is **text**. The various output types are documented below.
     The *ENCODING* specifies the output encoding, the default is that of
@@ -185,8 +185,8 @@ output
     Command line option: :option:`--output`
 **quiet=**\ [**0**\ \|\ **1**]
     If set, operate quiet. An alias for **log=none**. This is only
-    useful with **fileoutput**.
-    Command line option: :option:`--verbose`
+    useful with **fileoutput**, else no results will be output.
+    Command line option: :option:`--quiet`
 **status=**\ [**0**\ \|\ **1**]
     Control printing check status messages. Default is 1.
     Command line option: :option:`--no-status`