From a205a3722b58ac51acab5e18feaaf12617a13fc8 Mon Sep 17 00:00:00 2001 From: Chris Mayo Date: Fri, 24 Apr 2020 19:46:30 +0100 Subject: [PATCH] Update man pages to optimise for both html and man - Use "LinkChecker User Manual" as the source for both pages. - .UR/.UE for external links to allow mandoc to create links in html. - Use Linux man-pages format for cross references e.g. .BR linkcheckerrc (5) which are replace in the html by the Makefile. --- doc/en/linkchecker.1 | 187 +++++++++++---------- doc/en/linkcheckerrc.5 | 88 +++++----- doc/web/media/man1/linkchecker.1.html | 213 +++++++++++++----------- doc/web/media/man5/linkcheckerrc.5.html | 135 ++++++++++----- 4 files changed, 355 insertions(+), 268 deletions(-) diff --git a/doc/en/linkchecker.1 b/doc/en/linkchecker.1 index 0ba1ad8e..9b1c7798 100644 --- a/doc/en/linkchecker.1 +++ b/doc/en/linkchecker.1 @@ -1,12 +1,12 @@ -.TH LINKCHECKER 1 2010-07-01 "LinkChecker" "LinkChecker commandline usage" +.TH LINKCHECKER 1 2020-04-24 "LinkChecker" "LinkChecker User Manual" .SH NAME -linkchecker - command line client to check HTML documents and websites for broken links -. +linkchecker \- command line client to check HTML documents and websites for broken links .SH SYNOPSIS -\fBlinkchecker\fP [\fIoptions\fP] [\fIfile-or-url\fP]... -. +.B linkchecker +.RI [ options ] +.RI [ file-or-url ]... .SH DESCRIPTION -.LP +.TP 2 LinkChecker features .IP \(bu recursive and multithreaded checking, @@ -33,30 +33,30 @@ Antivirus check .IP \(bu a command line and web interface .SH EXAMPLES +.TP 2 The most common use checks the given domain recursively: - \fBlinkchecker http://www.example.com/\fP +.B linkchecker http://www.example.com/ .br Beware that this checks the whole site which can have thousands of URLs. Use the \fB\-r\fP option to restrict the recursion depth. -.br +.TP Don't check URLs with \fB/secret\fP in its name. All other links are checked as usual: - \fBlinkchecker \-\-ignore\-url=/secret mysite.example.com\fP -.br +.B linkchecker \-\-ignore\-url=/secret mysite.example.com +.TP Checking a local HTML file on Unix: - \fBlinkchecker ../bla.html\fP -.br +.B linkchecker ../bla.html +.TP Checking a local HTML file on Windows: - \fBlinkchecker c:\\temp\\test.html\fP -.br +.B linkchecker c:\\temp\\test.html +.TP You can skip the \fBhttp://\fP url part if the domain starts with \fBwww.\fP: - \fBlinkchecker www.example.com\fP -.br +.B linkchecker www.example.com +.TP You can skip the \fBftp://\fP url part if the domain starts with \fBftp.\fP: - \fBlinkchecker \-r0 ftp.example.com\fP -.br +.B linkchecker \-r0 ftp.example.com +.TP Generate a sitemap graph and convert it with the graphviz dot utility: - \fBlinkchecker \-odot \-v www.example.com | dot \-Tps > sitemap.ps\fP -. +.B linkchecker \-odot \-v www.example.com | dot \-Tps > sitemap.ps .SH OPTIONS .SS General options .TP @@ -99,7 +99,8 @@ Output to a file \fBlinkchecker\-out.\fP\fITYPE\fP, The \fIENCODING\fP specifies the output encoding, the default is that of your locale. Valid encodings are listed at -\fBhttp://docs.python.org/library/\:codecs.html#standard-encodings\fP. +.UR http://docs.python.org/library/codecs.html#standard-encodings +.UE . .br The \fIFILENAME\fP and \fIENCODING\fP parts of the \fBnone\fP output type will be ignored, else if the file already exists, it will be overwritten. @@ -126,7 +127,8 @@ below. .br The \fIENCODING\fP specifies the output encoding, the default is that of your locale. Valid encodings are listed at -\fBhttp://docs.python.org/library/\:codecs.html#standard-encodings\fP. +.UR http://docs.python.org/library/codecs.html#standard-encodings +.UE . .TP \fB\-q\fP, \fB\-\-quiet\fP Quiet operation, an alias for \fB\-o none\fP. @@ -203,7 +205,9 @@ version of LinkChecker. .SH "CONFIGURATION FILES" Configuration files can specify all options above. They can also specify some options that cannot be set on the command line. -See \fBlinkcheckerrc\fP(5) for more info. +See +.BR linkcheckerrc (5) +for more info. .SH OUTPUT TYPES Note that by default only errors and warnings are logged. @@ -236,7 +240,8 @@ Log check result as machine-readable XML. .TP \fBsitemap\fP Log check result as an XML sitemap whose protocol is documented at -\fBhttp://www.sitemaps.org/protocol.html\fP. +.UR http://www.sitemaps.org/protocol.html +.UE . .TP \fBsql\fP Log check result as SQL script with INSERT commands. An example @@ -252,7 +257,10 @@ Logs nothing. Suitable for debugging or checking the exit code. . .SH REGULAR EXPRESSIONS LinkChecker accepts Python regular expressions. -See \fBhttp://docs.python.org/\:howto/regex.html\fP for an introduction. +See +.UR http://docs.python.org/howto/regex.html +.UE +for an introduction. An addition is that a leading exclamation mark negates the regular expression. @@ -276,15 +284,15 @@ Multiple entries are separated by a blank line. The example below will send two cookies to all URLs starting with \fBhttp://example.com/hello/\fP and one to all URLs starting with \fBhttps://example.org/\fP: - - Host: example.com - Path: /hello - Set-cookie: ID="smee" - Set-cookie: spam="egg" - - Host: example.org - Set-cookie: baggage="elitist"; comment="hologram" - +.EX + Host: example.com + Path: /hello + Set-cookie: ID="smee" + Set-cookie: spam="egg" +.PP + Host: example.org + Set-cookie: baggage="elitist"; comment="hologram" +.EE .SH PROXY SUPPORT To use a proxy on Unix or Windows set the $http_proxy, $https_proxy or $ftp_proxy environment variables to the proxy URL. The URL should be of the form @@ -292,29 +300,27 @@ environment variables to the proxy URL. The URL should be of the form LinkChecker also detects manual proxy settings of Internet Explorer under Windows systems, and gconf or KDE on Linux systems. On a Mac use the Internet Config to select a proxy. -. +.PP You can also set a comma-separated domain list in the $no_proxy environment variables to ignore any proxy settings for these domains. -. +.TP Setting a HTTP proxy on Unix for example looks like this: - - export http_proxy="http://proxy.example.com:8080" - +.B +export http_proxy="http://proxy.example.com:8080" +.TP Proxy authentication is also supported: - - export http_proxy="http://user1:mypass@proxy.example.org:8081" - +.B +export http_proxy="http://user1:mypass@proxy.example.org:8081" +.TP Setting a proxy on the Windows command prompt: - - set http_proxy=http://proxy.example.com:8080 - +.B +set http_proxy=http://proxy.example.com:8080 .SH PERFORMED CHECKS All URLs have to pass a preliminary syntax test. Minor quoting mistakes will issue a warning, all other invalid syntax issues are errors. After the syntax check passes, the URL is queued for connection checking. All connection check types are described below. -. .TP HTTP links (\fBhttp:\fP, \fBhttps:\fP) After connecting to the given HTTP server the given path @@ -322,75 +328,74 @@ or query is requested. All redirections are followed, and if user/password is given it will be used as authorization when necessary. All final HTTP status codes other than 2xx are errors. -. +.IP HTML page contents are checked for recursion. .TP Local files (\fBfile:\fP) A regular, readable file that can be opened is valid. A readable directory is also valid. All other files, for example device files, unreadable or non-existing files are errors. -. +.IP HTML or other parseable file contents are checked for recursion. .TP Mail links (\fBmailto:\fP) A mailto: link eventually resolves to a list of email addresses. If one address fails, the whole list will fail. For each mail address we check the following things: -. - 1) Check the adress syntax, both of the part before and after - the @ sign. - 2) Look up the MX DNS records. If we found no MX record, - print an error. - 3) Check if one of the mail hosts accept an SMTP connection. - Check hosts with higher priority first. - If no host accepts SMTP, we print a warning. - 4) Try to verify the address with the VRFY command. If we got - an answer, print the verified address as an info. +.br +1) Check the adress syntax, both of the part before and after the @ sign. +.br +2) Look up the MX DNS records. If we found no MX record, print an error. +.br +3) Check if one of the mail hosts accept an SMTP connection. +Check hosts with higher priority first. +If no host accepts SMTP, we print a warning. +.br +4) Try to verify the address with the VRFY command. If we got an answer, +print the verified address as an info. + .TP FTP links (\fBftp:\fP) - - For FTP links we do: - - 1) connect to the specified host - 2) try to login with the given user and password. The default - user is ``anonymous``, the default password is ``anonymous@``. - 3) try to change to the given directory - 4) list the file with the NLST command +For FTP links we do: +.br +1) connect to the specified host +.br +2) try to login with the given user and password. The default +user is ``anonymous``, the default password is ``anonymous@``. +.br +3) try to change to the given directory +.br +4) list the file with the NLST command .TP Telnet links (``telnet:``) - - We try to connect and if user/password are given, login to the - given telnet server. +We try to connect and if user/password are given, login to the +given telnet server. .TP NNTP links (``news:``, ``snews:``, ``nntp``) - - We try to connect to the given NNTP server. If a news group or - article is specified, try to request it from the server. +We try to connect to the given NNTP server. If a news group or +article is specified, try to request it from the server. .TP Unsupported links (``javascript:``, etc.) - - An unsupported link will only print a warning. No further checking - will be made. - - The complete list of recognized, but unsupported links can be found - in the \fBlinkcheck/checker/unknownurl.py\fP source file. - The most prominent of them should be JavaScript links. - +An unsupported link will only print a warning. No further checking +will be made. +.IP +The complete list of recognized, but unsupported links can be found +in the \fBlinkcheck/checker/unknownurl.py\fP source file. +The most prominent of them should be JavaScript links. .SH PLUGINS There are two plugin types: connection and content plugins. -. Connection plugins are run after a successful connection to the URL host. -. Content plugins are run if the URL type has content (mailto: URLs have no content for example) and if the check is not forbidden (ie. by HTTP robots.txt). -. +.PP See \fBlinkchecker \-\-list\-plugins\fP for a list of plugins and -their documentation. All plugins are enabled via the \fBlinkcheckerrc\fP(5) +their documentation. All plugins are enabled via the +.BR linkcheckerrc (5) configuration file. .SH RECURSION @@ -455,11 +460,11 @@ same as the host of the user browsing your pages. . .SH RETURN VALUE The return value is 2 when -.IP \(bu +.IP \(bu 2 a program error occurred. .PP The return value is 1 when -.IP \(bu +.IP \(bu 2 invalid links were found or .IP \(bu link warnings were found and warnings are enabled @@ -478,12 +483,16 @@ might slow down the program or even the whole system. .br \fBlinkchecker\-out.\fP\fITYPE\fP - default logger file output name .br -\fBhttp://docs.python.org/library/codecs.html#standard-encodings\fP - valid output encodings +.UR http://docs.python.org/library/codecs.html#standard-encodings +.UE +\- valid output encodings .br -\fBhttp://docs.python.org/howto/regex.html\fP - regular expression documentation +.UR http://docs.python.org/howto/regex.html +.UE +\- regular expression documentation .SH "SEE ALSO" -\fBlinkcheckerrc\fP(5) +.BR linkcheckerrc (5) . .SH AUTHOR Bastian Kleineidam diff --git a/doc/en/linkcheckerrc.5 b/doc/en/linkcheckerrc.5 index b2095288..05e21afa 100644 --- a/doc/en/linkcheckerrc.5 +++ b/doc/en/linkcheckerrc.5 @@ -1,4 +1,4 @@ -.TH linkcheckerrc 5 2007-11-30 "LinkChecker" +.TH LINKCHECKERRC 5 2020-04-24 "LinkChecker" "LinkChecker User Manual" .SH NAME linkcheckerrc - configuration file for LinkChecker . @@ -13,7 +13,8 @@ The default file location is \fB~/.linkchecker/linkcheckerrc\fP on Unix, .TP \fBcookiefile=\fP\fIfilename\fP Read a file with initial cookie data. The cookie data -format is explained in linkchecker(1). +format is explained in +.BR linkchecker (1). .br Command line option: \fB\-\-cookiefile\fP .TP @@ -188,7 +189,8 @@ below. .br The \fIENCODING\fP specifies the output encoding, the default is that of your locale. Valid encodings are listed at -\fBhttp://docs.python.org/library/codecs.html#standard-encodings\fP. +.UR http://docs.python.org/library/codecs.html#standard-encodings +.UE . .br Command line option: \fB\-\-output\fP .TP @@ -228,7 +230,8 @@ Command line option: none .TP \fBencoding=\fP\fISTRING\fP Valid encodings are listed in -\fBhttp://docs.python.org/library/codecs.html#standard-encodings\fP. +.UR http://docs.python.org/library/codecs.html#standard-encodings +.UE . .br Default encoding is \fBiso\-8859\-15\fP. .TP @@ -404,42 +407,47 @@ priority for the first URL is 1.0, for all child URLs 0.5. How frequently pages are changing. . .SH "LOGGER PARTS" - \fBall\fP (for all parts) - \fBid\fP (a unique ID for each logentry) - \fBrealurl\fP (the full url link) - \fBresult\fP (valid or invalid, with messages) - \fBextern\fP (1 or 0, only in some logger types reported) - \fBbase\fP (base href=...) - \fBname\fP (name and name) - \fBparenturl\fP (if any) - \fBinfo\fP (some additional info, e.g. FTP welcome messages) - \fBwarning\fP (warnings) - \fBdltime\fP (download time) - \fBchecktime\fP (check time) - \fBurl\fP (the original url name, can be relative) - \fBintro\fP (the blurb at the beginning, "starting at ...") - \fBoutro\fP (the blurb at the end, "found x errors ...") +.TS +nokeep, tab(@); +ll. +\fBall\fP@(for all parts) +\fBid\fP@(a unique ID for each logentry) +\fBrealurl\fP@(the full url link) +\fBresult\fP@(valid or invalid, with messages) +\fBextern\fP@(1 or 0, only in some logger types reported) +\fBbase\fP@(base href=...) +\fBname\fP@(name and name) +\fBparenturl\fP@(if any) +\fBinfo\fP@(some additional info, e.g. FTP welcome messages) +\fBwarning\fP@(warnings) +\fBdltime\fP@(download time) +\fBchecktime\fP@(check time) +\fBurl\fP@(the original url name, can be relative) +\fBintro\fP@(the blurb at the beginning, "starting at ...") +\fBoutro\fP@(the blurb at the end, "found x errors ...") +.TE .SH MULTILINE Some option values can span multiple lines. Each line has to be indented for that to work. Lines starting with a hash (\fB#\fP) will be ignored, though they must still be indented. - - ignore= - lconline - bookmark - # a comment - ^mailto: -. +.EX +ignore= + lconline + bookmark + # a comment + ^mailto: +.EE .SH EXAMPLE - [output] - log=html - - [checking] - threads=5 - - [filtering] - ignorewarnings=http-moved-permanent - +.EX +[output] +log=html +.PP +[checking] +threads=5 +.PP +[filtering] +ignorewarnings=http-moved-permanent +.EE .SH PLUGINS All plugins have a separate section. If the section appears in the configuration file the plugin is enabled. @@ -475,7 +483,9 @@ Configures the expiration warning time in days. .SS \fB[HtmlSyntaxCheck]\fP Check the syntax of HTML pages with the online W3C HTML validator. -See http://validator.w3.org/docs/api.html. +See +.UR http://validator.w3.org/docs/api.html +.UE . .SS \fB[HttpHeaderInfo]\fP Print HTTP headers in URL info. @@ -486,7 +496,9 @@ to display all HTTP headers that start with "X-". .SS \fB[CssSyntaxCheck]\fP Check the syntax of HTML pages with the online W3C CSS validator. -See http://jigsaw.w3.org/css-validator/manual.html#expert. +See +.UR http://jigsaw.w3.org/css-validator/manual.html#expert +.UE . .SS \fB[VirusCheck]\fP Checks the page content for virus infections with clamav. @@ -551,7 +563,7 @@ The IP is obfuscated. The URL contains leading or trailing whitespace. .SH "SEE ALSO" -linkchecker(1) +.BR linkchecker (1) . .SH AUTHOR Bastian Kleineidam diff --git a/doc/web/media/man1/linkchecker.1.html b/doc/web/media/man1/linkchecker.1.html index 9344feab..122473e6 100644 --- a/doc/web/media/man1/linkchecker.1.html +++ b/doc/web/media/man1/linkchecker.1.html @@ -20,7 +20,7 @@ - +
LINKCHECKER(1)LinkChecker commandline usageLinkChecker User Manual LINKCHECKER(1)
@@ -36,7 +36,10 @@ linkchecker - command line client to check HTML documents and websites for

-LinkChecker features +
+
LinkChecker features
+
+
  • recursive and multithreaded checking,
  • output in colored or normal text, HTML, SQL, CSV, XML or a sitemap graph @@ -56,30 +59,30 @@ LinkChecker features

-The most common use checks the given domain recursively: - linkchecker http://www.example.com/ -
-Beware that this checks the whole site which can have thousands of URLs. Use the - -r option to restrict the recursion depth. -
-Don't check URLs with /secret in its name. All other links are checked as - usual: - linkchecker --ignore-url=/secret mysite.example.com -
-Checking a local HTML file on Unix: - linkchecker ../bla.html -
-Checking a local HTML file on Windows: - linkchecker c:\temp\test.html -
-You can skip the http:// url part if the domain starts with www.: - linkchecker www.example.com -
-You can skip the ftp:// url part if the domain starts with ftp.: - linkchecker -r0 ftp.example.com -
-Generate a sitemap graph and convert it with the graphviz dot utility: - linkchecker -odot -v www.example.com | dot -Tps > sitemap.ps +
+
The most common use checks the given domain recursively:
+
linkchecker http://www.example.com/ +
+ Beware that this checks the whole site which can have thousands of URLs. Use + the -r option to restrict the recursion depth.
+
Don't check URLs with /secret in its name. All other links are + checked as usual:
+
linkchecker --ignore-url=/secret mysite.example.com
+
Checking a local HTML file on Unix:
+
linkchecker ../bla.html
+
Checking a local HTML file on Windows:
+
linkchecker c:empest.html
+
You can skip the http:// url part if the domain starts with + www.:
+
linkchecker www.example.com
+
You can skip the ftp:// url part if the domain starts with + ftp.:
+
linkchecker -r0 ftp.example.com
+
Generate a sitemap graph and convert it with the graphviz dot + utility:
+
linkchecker -odot -v www.example.com | dot -Tps > + sitemap.ps
+

@@ -120,7 +123,8 @@ Generate a sitemap graph and convert it with the graphviz dot utility: $HOME/.linkchecker/blacklist for blacklist output, or FILENAME if specified. The ENCODING specifies the output encoding, the default is that of your locale. Valid encodings are listed - at http://docs.python.org/library/codecs.html#standard-encodings. + at + http://docs.python.org/library/codecs.html#standard-encodings.
The FILENAME and ENCODING parts of the none output type will be ignored, else if the file already exists, it will be overwritten. @@ -142,7 +146,7 @@ Generate a sitemap graph and convert it with the graphviz dot utility:
The ENCODING specifies the output encoding, the default is that of your locale. Valid encodings are listed at - http://docs.python.org/library/codecs.html#standard-encodings. + http://docs.python.org/library/codecs.html#standard-encodings.
-q, --quiet
Quiet operation, an alias for -o none. This is only useful with -F.
@@ -247,7 +251,7 @@ Note that by default only errors and warnings are logged. You should use the
Log check result as machine-readable XML.
sitemap
Log check result as an XML sitemap whose protocol is documented at - http://www.sitemaps.org/protocol.html.
+ http://www.sitemaps.org/protocol.html.
sql
Log check result as SQL script with INSERT commands. An example script to create the initial SQL table is included as create.sql.
@@ -263,7 +267,8 @@ Note that by default only errors and warnings are logged. You should use the

LinkChecker accepts Python regular expressions. See - http://docs.python.org/howto/regex.html for an introduction. + http://docs.python.org/howto/regex.html + for an introduction.

An addition is that a leading exclamation mark negates the regular expression.

@@ -284,15 +289,16 @@ A cookie file contains standard HTTP header (RFC 2616) data with the following will send two cookies to all URLs starting with http://example.com/hello/ and one to all URLs starting with https://example.org/:

-

- Host: example.com - Path: /hello - Set-cookie: ID="smee" - Set-cookie: spam="egg"

-

- Host: example.org - Set-cookie: baggage="elitist"; comment="hologram"

-

+
+  Host: example.com
+  Path: /hello
+  Set-cookie: ID="smee"
+  Set-cookie: spam="egg"
+
+
+  Host: example.org
+  Set-cookie: baggage="elitist"; comment="hologram"
+

linkcheckerrc(5) configuration file. + the check is not forbidden (ie. by HTTP robots.txt). +

See linkchecker --list-plugins for a list of plugins and + their documentation. All plugins are enabled via the linkcheckerrc(5) + configuration file.

@@ -480,11 +495,11 @@ LinkChecker consumes memory for each queued URL to check. With thousands of
linkchecker-out.TYPE - default logger file output name
-http://docs.python.org/library/codecs.html#standard-encodings - valid - output encodings +http://docs.python.org/library/codecs.html#standard-encodings + - valid output encodings
-http://docs.python.org/howto/regex.html - regular expression - documentation +http://docs.python.org/howto/regex.html + - regular expression documentation

@@ -503,7 +518,7 @@ Copyright © 2000-2014 Bastian Kleineidam - +
2010-07-012020-04-24 LinkChecker
diff --git a/doc/web/media/man5/linkcheckerrc.5.html b/doc/web/media/man5/linkcheckerrc.5.html index 1841f978..cb6e29bb 100644 --- a/doc/web/media/man5/linkcheckerrc.5.html +++ b/doc/web/media/man5/linkcheckerrc.5.html @@ -14,14 +14,14 @@ code.Nm, code.Fl, code.Cm, code.Ic, code.In, code.Fd, code.Fn, code.Cd { font-weight: bold; font-family: inherit; } - linkcheckerrc(5) + LINKCHECKERRC(5) - - - + + +
linkcheckerrc(5)File Formats Manuallinkcheckerrc(5)LINKCHECKERRC(5)LinkChecker User ManualLINKCHECKERRC(5)
@@ -44,7 +44,7 @@ The default file location is ~/.linkchecker/linkcheckerrc on Unix,
cookiefile=filename
Read a file with initial cookie data. The cookie data format is explained - in linkchecker(1). + in linkchecker(1).
Command line option: --cookiefile
localwebroot=STRING
@@ -201,7 +201,7 @@ The default file location is ~/.linkchecker/linkcheckerrc on Unix,
The ENCODING specifies the output encoding, the default is that of your locale. Valid encodings are listed at - http://docs.python.org/library/codecs.html#standard-encodings. + http://docs.python.org/library/codecs.html#standard-encodings.
Command line option: --output
quiet=[0|1]
@@ -239,7 +239,7 @@ The default file location is ~/.linkchecker/linkcheckerrc on Unix, Command line option: none
encoding=STRING
Valid encodings are listed in - http://docs.python.org/library/codecs.html#standard-encodings. + http://docs.python.org/library/codecs.html#standard-encodings.
Default encoding is iso-8859-15.
color*
@@ -405,46 +405,97 @@ The default file location is ~/.linkchecker/linkcheckerrc on Unix,

- all (for all parts) - id (a unique ID for each logentry) - realurl (the full url link) - result (valid or invalid, with messages) - extern (1 or 0, only in some logger types reported) - base (base href=...) - name (<a href=...>name</a> and <img - alt="name">) - parenturl (if any) - info (some additional info, e.g. FTP welcome messages) - warning (warnings) - dltime (download time) - checktime (check time) - url (the original url name, can be relative) - intro (the blurb at the beginning, "starting at ...") - outro (the blurb at the end, "found x errors ...") + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
all(for all parts)
id(a unique ID for each logentry)
realurl(the full url link)
result(valid or invalid, with messages)
extern(1 or 0, only in some logger types reported)
base(base href=...)
name(<a href=...>name</a> and <img + alt="name">)
parenturl(if any)
info(some additional info, e.g. FTP welcome messages)
warning(warnings)
dltime(download time)
checktime(check time)
url(the original url name, can be relative)
intro(the blurb at the beginning, "starting at ...")
outro(the blurb at the end, "found x errors ...")

Some option values can span multiple lines. Each line has to be indented for that to work. Lines starting with a hash (#) will be ignored, though they must still be indented. -

- ignore= - lconline - bookmark - # a comment - ^mailto:

+
+ignore=
+  lconline
+  bookmark
+  # a comment
+  ^mailto:
+

- [output] - log=html -

- [checking] - threads=5

-

- [filtering] - ignorewarnings=http-moved-permanent

-

+
+[output]
+log=html
+
+
+[checking]
+threads=5
+
+
+[filtering]
+ignorewarnings=http-moved-permanent
+

@@ -493,7 +544,7 @@ Check SSL certificate expiration date. Only internal https: links will be

Check the syntax of HTML pages with the online W3C HTML validator. See - http://validator.w3.org/docs/api.html. + http://validator.w3.org/docs/api.html.

@@ -510,7 +561,7 @@ Print HTTP headers in URL info.

Check the syntax of HTML pages with the online W3C CSS validator. See - http://jigsaw.w3.org/css-validator/manual.html#expert. + http://jigsaw.w3.org/css-validator/manual.html#expert.

@@ -575,7 +626,7 @@ The following warnings are recognized in the 'ignorewarnings' config file entry:

-linkchecker(1) +linkchecker(1)

@@ -588,7 +639,7 @@ Copyright © 2000-2014 Bastian Kleineidam
- +
2007-11-302020-04-24 LinkChecker