Hopiu/linkchecker
1
0
Fork 0
mirror of https://github.com/Hopiu/linkchecker.git synced 2026-03-25 10:20:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve documentation of output

Browse source
This commit is contained in:
Chris Mayo 2021-11-29 19:48:50 +00:00
parent 995dc9cd41
commit 895e2ddb43
2 changed files with 8 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/src/man/linkchecker.rst
View file

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

8
doc/src/man/linkcheckerrc.rst
View file

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