Update man pages

This commit is contained in:
LinkChecker 2021-12-14 19:27:40 +00:00
parent 289ef5dc5b
commit 7497f1aa63
4 changed files with 195 additions and 108 deletions

View file

@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
.TH "LINKCHECKER" "1" "Juni 20, 2021" "2021-06-20" "LinkChecker"
.SH NAME
linkchecker \- Kommandozeilenprogramm zum Prüfen von HTML Dokumenten und Webseiten auf ungültige Verknüpfungen
.
.nr rst2man-indent-level 0
.
@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "LINKCHECKER" "1" "Dezember 14, 2021" "10.0.1.post91+g7f175c13" "LinkChecker"
.SH NAME
linkchecker \- Kommandozeilenprogramm zum Prüfen von HTML Dokumenten und Webseiten auf ungültige Verknüpfungen
.SH SYNTAX
.sp
\fBlinkchecker\fP [\fIOptionen\fP] [\fIDatei\-oder\-URL\fP]...
@ -56,8 +56,6 @@ Unterstützung für Cookies
.IP \(bu 2
Unterstützung für HTML5
.IP \(bu 2
HTML\- und CSS\-Syntaxprüfung
.IP \(bu 2
Antivirusprüfung
.IP \(bu 2
ein Kommandozeilenprogramm und web interface
@ -182,20 +180,23 @@ Gebe die Version aus und beende das Programm.
Print available check plugins and exit.
.UNINDENT
.SS Ausgabeoptionen
.INDENT 0.0
.TP
.B \-D STRING, \-\-debug=STRING
Gebe Testmeldungen aus für den angegebenen Logger. Verfügbare Logger sind cmdline, checking, cache, dns, plugin und all. Die Angabe all ist ein Synonym für alle verfügbaren Logger. Diese Option kann mehrmals angegeben werden, um mit mehr als einem Logger zu testen. Um akkurate Ergebnisse zu erzielen, werden Threads deaktiviert.
.UNINDENT
.SS URL checking results
.INDENT 0.0
.TP
.B \-F TYPE[/ENCODING][/FILENAME], \-\-file\-output=TYPE[/ENCODING][/FILENAME]
Ausgabe in eine Datei namens linkchecker\-out.TYP, $HOME/.linkchecker/failures bei failures Ausgabe, oder DATEINAME falls angegeben. Das ENCODING gibt die Ausgabekodierung an. Der Standard ist das der lokalen Spracheinstellung. Gültige Enkodierungen sind aufgelistet unter \fI\%https://docs.python.org/library/codecs.html#standard\-encodings\fP\&. Der DATEINAME und ENKODIERUNG Teil wird beim Ausgabetyp none ignoriert, ansonsten wird die Datei überschrieben falls sie existiert. Sie können diese Option mehr als einmal verwenden. Gültige Ausgabetypen sind text, html, sql, csv, gml, dot, xml, sitemap, none oder failures. Standard ist keine Dateiausgabe. Die unterschiedlichen Ausgabetypen sind weiter unten dokumentiert. Beachten Sie, dass Sie mit der Option \fI\%\-o\fP \fInone\fP jegliche Ausgaben auf der Konsole verhindern können.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-status
Gebe keine Statusmeldungen aus.
Output to a file linkchecker\-out.TYPE,
$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
\fI\%https://docs.python.org/library/codecs.html#standard\-encodings\fP\&.
The FILENAME and ENCODING parts of the none output type will
be ignored, else if the file already exists, it will be overwritten.
You can specify this option more than once. Valid file output TYPEs
are text, html, sql, csv, gml, dot, xml,
sitemap, none or failures. Default is no file output.
The various output types are documented below. Note that you can
suppress all console output with the option \fI\%\-o\fP \fInone\fP\&.
.UNINDENT
.INDENT 0.0
.TP
@ -205,22 +206,37 @@ Gebe keine Warnungen aus. Standard ist die Ausgabe von Warnungen.
.INDENT 0.0
.TP
.B \-o TYPE[/ENCODING], \-\-output=TYPE[/ENCODING]
Gib Ausgabetyp als text, html, sql, csv, gml, dot, xml, sitemap, none oder failures an. Stadard Typ ist text. Die verschiedenen Ausgabetypen sind unten dokumentiert. Das ENCODING gibt die Ausgabekodierung an. Der Standard ist das der lokalen Spracheinstellung. Gültige Enkodierungen sind aufgelistet unter \fI\%https://docs.python.org/library/codecs.html#standard\-encodings\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-q, \-\-quiet
Keine Ausgabe, ein Alias für \fI\%\-o\fP \fInone\fP\&. Dies ist nur in Verbindung mit \fI\%\-F\fP nützlich.
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.
The ENCODING specifies the output encoding, the default is that of
your locale. Valid encodings are listed at
\fI\%https://docs.python.org/library/codecs.html#standard\-encodings\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-v, \-\-verbose
Gebe alle geprüften URLs aus. Standard ist es, nur fehlerhafte URLs und Warnungen auszugeben.
.UNINDENT
.SS Progress updates
.INDENT 0.0
.TP
.B \-W REGEX, \-\-warning\-regex=REGEX
Definieren Sie einen regulären Ausdruck der eine Warnung ausgibt falls er auf den Inhalt einer geprüften URL zutrifft. Dies gilt nur für gültige Seiten deren Inhalt wir bekommen können. Benutzen Sie dies, um nach Seiten zu suchen, welche bestimmte Fehler enthalten, zum Beispiel "Diese Seite ist umgezogen" oder "Oracle "Applikationsfehler". Man beachte, dass mehrere Werte in dem regulären Ausdruck kombiniert werden können, zum Beispiel "(Diese Seite ist umgezogen|Oracle Applikationsfehler)". Siehe Abschnitt \fI\%REGULAR EXPRESSIONS\fP für weitere Infos.
.B \-\-no\-status
Do not print URL check status messages.
.UNINDENT
.SS Application
.INDENT 0.0
.TP
.B \-D STRING, \-\-debug=STRING
Gebe Testmeldungen aus für den angegebenen Logger. Verfügbare Logger sind cmdline, checking, cache, dns, plugin und all. Die Angabe all ist ein Synonym für alle verfügbaren Logger. Diese Option kann mehrmals angegeben werden, um mit mehr als einem Logger zu testen. Um akkurate Ergebnisse zu erzielen, werden Threads deaktiviert.
.UNINDENT
.SS Quiet
.INDENT 0.0
.TP
.B \-q, \-\-quiet
Quiet operation, an alias for \fI\%\-o\fP \fInone\fP that also hides
application information messages.
This is only useful with \fI\%\-F\fP, else no results will be output.
.UNINDENT
.SS Optionen zum Prüfen
.INDENT 0.0
@ -366,7 +382,17 @@ Set\-cookie: baggage="elitist"; comment="hologram"
.UNINDENT
.SH PROXY UNTERSTÜTZUNG
.sp
Um einen Proxy unter Unix oder Windows zu benutzen, setzen Sie die \fI\%http_proxy\fP, \fBhttps_proxy\fP oder \fI\%ftp_proxy\fP Umgebungsvariablen auf die Proxy URL. Die URL sollte die Form \fBhttp://\fP[\fIuser\fP\fB:\fP\fIpass\fP\fB@\fP]\fIhost\fP[\fB:\fP\fIport\fP] besitzen. LinkChecker erkennt auch die Proxy\-Einstellungen des Internet Explorers auf einem Windows\-System, und GNOME oder KDE auf Linux Systemen. Auf einem Mac benutzen Sie die Internet Konfiguration. Sie können eine komma\-separierte Liste von Domainnamen in der \fI\%no_proxy\fP Umgebungsvariable setzen, um alle Proxies für diese Domainnamen zu ignorieren.
To use a proxy on Unix or Windows set the \fI\%http_proxy\fP or
\fBhttps_proxy\fP environment variables to the proxy URL. The URL should be
of the form
\fBhttp://\fP[\fIuser\fP\fB:\fP\fIpass\fP\fB@\fP]\fIhost\fP[\fB:\fP\fIport\fP].
LinkChecker also detects manual proxy settings of Internet Explorer
under Windows systems. On a Mac use
the Internet Config to select a proxy.
You can also set a comma\-separated domain list in the \fI\%no_proxy\fP
environment variable to ignore any proxy settings for these domains.
The \fBcurl_ca_bundle\fP environment variable can be used to identify an
alternative certificate bundle to be used with an HTTPS proxy.
.sp
Einen HTTP\-Proxy unter Unix anzugeben sieht beispielsweise so aus:
.INDENT 0.0

View file

@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
.TH "LINKCHECKERRC" "5" "Juni 20, 2021" "2021-06-20" "LinkChecker"
.SH NAME
linkcheckerrc \- Konfigurationsdatei für LinkChecker
.
.nr rst2man-indent-level 0
.
@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "LINKCHECKERRC" "5" "Dezember 14, 2021" "10.0.1.post91+g7f175c13" "LinkChecker"
.SH NAME
linkcheckerrc \- Konfigurationsdatei für LinkChecker
.SH BESCHREIBUNG
.sp
\fBlinkcheckerrc\fP ist die Konfigurationsdatei für LinkChecker. Die Datei ist in einem INI\-Format geschrieben. Die Standarddatei ist \fB~/.linkchecker/linkcheckerrc\fP unter Unix\-, \fB%HOMEPATH%\elinkchecker\elinkcheckerrc\fP unter Windows\-Systemen.
@ -167,22 +167,26 @@ without checking whether matching input elements exist in the HTML
form.
.UNINDENT
.SS output
.SS URL checking results
.INDENT 0.0
.TP
\fBdebug=\fP\fISTRING\fP[\fB,\fP\fISTRING\fP\&...]
Gebe Testmeldungen aus für den angegebenen Logger. Verfügbare Logger sind \fBcmdline\fP, \fBchecking\fP, \fBcache\fP, \fBdns\fP, \fBthread\fP, \fBplugins\fP und \fBall\fP\&. Die Angabe \fBall\fP ist ein Synonym für alle verfügbaren Logger. Kommandozeilenoption: \fB\-\-debug\fP
.TP
\fBfileoutput=\fP\fITYPE\fP[\fB,\fP\fITYPE\fP\&...]
Ausgabe in Datei \fBlinkchecker\-out.\fP\fITYP\fP, \fB$HOME/.linkchecker/failures\fP für \fBfailures\fP Ausgabe. Gültige Ausgabearten sind \fBtext\fP, \fBhtml\fP, \fBsql\fP, \fBcsv\fP, \fBgml\fP, \fBdot\fP, \fBxml\fP, \fBnone\fP> oder \fBfailures\fP Standard ist keine Dateiausgabe. Die verschiedenen Ausgabearten sind unten dokumentiert. Bemerke, dass man alle Konsolenausgaben mit \fBoutput=none\fP unterdrücken kann. Kommandozeilenoption: \fB\-\-file\-output\fP
Output to a file \fBlinkchecker\-out.\fP\fITYPE\fP, or
\fB$HOME/.linkchecker/failures\fP for the \fBfailures\fP output type.
Valid file output types are \fBtext\fP, \fBhtml\fP, \fBsql\fP, \fBcsv\fP,
\fBgml\fP, \fBdot\fP, \fBxml\fP, \fBnone\fP or \fBfailures\fP\&. Default is no
file output. The various output types are documented below. Note
that you can suppress all console output with \fBoutput=none\fP\&.
Command line option: \fB\-\-file\-output\fP
.TP
\fBlog=\fP\fITYPE\fP[\fB/\fP\fIENCODING\fP]
Gib Ausgabetyp als \fBtext\fP, \fBhtml\fP, \fBsql\fP, \fBcsv\fP, \fBgml\fP, \fBdot\fP, \fBxml\fP, \fBnone\fP oder \fBfailures\fP an. Stadard Typ ist \fBtext\fP\&. Die verschiedenen Ausgabetypen sind unten dokumentiert. Das \fIENCODING\fP gibt die Ausgabekodierung an. Der Standard ist das der lokalen Spracheinstellung. Gültige Enkodierungen sind aufgelistet unter \fI\%https://docs.python.org/library/codecs.html#standard\-encodings\fP\&. Kommandozeilenoption: \fB\-\-output\fP
.TP
\fBquiet=\fP[\fB0\fP|\fB1\fP]
Falls gesetzt, erfolgt keine Ausgabe. Ein Alias für \fBlog=none\fP\&. Dies ist nur in Verbindung mit \fBfileoutput\fP nützlich. Kommandozeilenoption: \fB\-\-verbose\fP
.TP
\fBstatus=\fP[\fB0\fP|\fB1\fP]
Kontrolle der Statusmeldungen. Standard ist 1. Kommandozeilenoption: \fB\-\-no\-status\fP
Specify the console output type as \fBtext\fP, \fBhtml\fP, \fBsql\fP, \fBcsv\fP,
\fBgml\fP, \fBdot\fP, \fBxml\fP, \fBnone\fP or \fBfailures\fP\&. Default type
is \fBtext\fP\&. The various output types are documented below.
The \fIENCODING\fP specifies the output encoding, the default is that of
your locale. Valid encodings are listed at
\fI\%https://docs.python.org/library/codecs.html#standard\-encodings\fP\&.
Command line option: \fB\-\-output\fP
.TP
\fBverbose=\fP[\fB0\fP|\fB1\fP]
Falls gesetzt, gebe alle geprüften URLs einmal aus. Standard ist es, nur fehlerhafte URLs und Warnungen auszugeben. Kommandozeilenoption: \fB\-\-verbose\fP
@ -190,6 +194,29 @@ Falls gesetzt, gebe alle geprüften URLs einmal aus. Standard ist es, nur fehler
\fBwarnings=\fP[\fB0\fP|\fB1\fP]
Falls gesetzt, gebe keine Warnungen aus. Standard ist die Ausgabe von Warnungen. Kommandozeilenoption: \fB\-\-verbose\fP
.UNINDENT
.SS Progress updates
.INDENT 0.0
.TP
\fBstatus=\fP[\fB0\fP|\fB1\fP]
Control printing URL checker status messages. Default is 1.
Command line option: \fB\-\-no\-status\fP
.UNINDENT
.SS Application
.INDENT 0.0
.TP
\fBdebug=\fP\fISTRING\fP[\fB,\fP\fISTRING\fP\&...]
Gebe Testmeldungen aus für den angegebenen Logger. Verfügbare Logger sind \fBcmdline\fP, \fBchecking\fP, \fBcache\fP, \fBdns\fP, \fBthread\fP, \fBplugins\fP und \fBall\fP\&. Die Angabe \fBall\fP ist ein Synonym für alle verfügbaren Logger. Kommandozeilenoption: \fB\-\-debug\fP
.UNINDENT
.SS Quiet
.INDENT 0.0
.TP
\fBquiet=\fP[\fB0\fP|\fB1\fP]
If set, operate quiet. An alias for \fBlog=none\fP that also hides
application information messages.
This is only useful with \fBfileoutput\fP, else no results will be output.
Command line option: \fB\-\-quiet\fP
.UNINDENT
.SH AUSGABETYPEN
.SS text
.INDENT 0.0
.TP
@ -200,7 +227,9 @@ Gebe Dateiname für Textausgabe an. Standard Dateiname ist \fBlinkchecker\-out.t
Kommagetrennte Liste von Teilen, die ausgegeben werden sollen. Siehe \fI\%LOGGER PARTS\fP weiter unten. Kommandozeilenoption: none
.TP
\fBencoding=\fP\fISTRING\fP
Gültige Enkodierungen sind aufgelistet unter \fI\%https://docs.python.org/library/codecs.html#standard\-encodings\fP\&. Die Standardenkodierung ist \fBiso\-8859\-15\fP\&.
Valid encodings are listed in
\fI\%https://docs.python.org/library/codecs.html#standard\-encodings\fP\&.
Default encoding is the system default locale encoding.
.TP
.B \fIcolor*\fP
Farbwerte für die verschiedenen Ausgabeteile. Syntax ist \fIcolor\fP oder \fItype\fP\fB;\fP\fIcolor\fP\&. Der \fItype\fP kann \fBbold\fP, \fBlight\fP, \fBblink\fP> oder \fBinvert\fP sein. Die \fIcolor\fP kann \fBdefault\fP, \fBblack\fP, \fBred\fP, \fBgreen\fP, \fByellow\fP, \fBblue\fP, \fBpurple\fP, \fBcyan\fP, \fBwhite\fP, \fBBlack\fP, \fBRed\fP, \fBGreen\fP, \fBYellow\fP, \fBBlue\fP, \fBPurple\fP, \fBCyan\fP oder \fBWhite\fP sein. Kommandozeilenoption: none
@ -275,7 +304,7 @@ Siehe \fI\%[text]\fP Sektion weiter oben.
Siehe \fI\%[text]\fP Sektion weiter oben.
.TP
\fBseparator=\fP\fICHAR\fP
Das CSV Trennzeichen. Standard ist Komma (\fB,\fP).
Set CSV separator. Default is a semicolon (\fB;\fP).
.TP
\fBquotechar=\fP\fICHAR\fP
Setze CSV Quotezeichen. Standard ist das doppelte Anführungszeichen (\fB"\fP).
@ -473,6 +502,13 @@ options in their section.
.SS AnchorCheck
.sp
Checks validity of HTML anchors.
.sp
\fBBEMERKUNG:\fP
.INDENT 0.0
.INDENT 3.5
The AnchorCheck plugin is currently broken and is disabled.
.UNINDENT
.UNINDENT
.SS LocationInfo
.sp
Adds the country and if possible city name of the URL host as info.
@ -502,6 +538,13 @@ Configures the expiration warning time in days.
.SS HtmlSyntaxCheck
.sp
Prüfe Syntax von HTML URLs mit dem W3C Online Validator. Siehe \fI\%https://validator.w3.org/docs/api.html\fP\&.
.sp
\fBBEMERKUNG:\fP
.INDENT 0.0
.INDENT 3.5
The HtmlSyntaxCheck plugin is currently broken and is disabled.
.UNINDENT
.UNINDENT
.SS HttpHeaderInfo
.sp
Print HTTP headers in URL info.

View file

@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
.TH "LINKCHECKER" "1" "June 20, 2021" "2021-06-20" "LinkChecker"
.SH NAME
linkchecker \- command line client to check HTML documents and websites for broken links
.
.nr rst2man-indent-level 0
.
@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "LINKCHECKER" "1" "December 14, 2021" "10.0.1.post91+g7f175c13" "LinkChecker"
.SH NAME
linkchecker \- command line client to check HTML documents and websites for broken links
.SH SYNOPSIS
.sp
\fBlinkchecker\fP [\fIoptions\fP] [\fIfile\-or\-url\fP]...
@ -58,8 +58,6 @@ support for Cookies
.IP \(bu 2
support for HTML5
.IP \(bu 2
HTML and CSS syntax check
.IP \(bu 2
Antivirus check
.IP \(bu 2
a command line and web interface
@ -189,21 +187,12 @@ Print version and exit.
Print available check plugins and exit.
.UNINDENT
.SS Output options
.INDENT 0.0
.TP
.B \-D STRING, \-\-debug=STRING
Print debugging output for the given logger. Available loggers are
cmdline, checking, cache, dns, plugin and
all. Specifying all is an alias for specifying all available
loggers. The option can be given multiple times to debug with more
than one logger. For accurate results, threading will be disabled
during debug runs.
.UNINDENT
.SS URL checking results
.INDENT 0.0
.TP
.B \-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
@ -218,47 +207,48 @@ suppress all console output with the option \fI\%\-o\fP \fInone\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-status
Do not print check status messages.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-warnings
Don\(aqt log warnings. Default is to log warnings.
.UNINDENT
.INDENT 0.0
.TP
.B \-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
\fI\%https://docs.python.org/library/codecs.html#standard\-encodings\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-q, \-\-quiet
Quiet operation, an alias for \fI\%\-o\fP \fInone\fP\&. This is only useful with
\fI\%\-F\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-v, \-\-verbose
Log all checked URLs. Default is to log only errors and warnings.
.UNINDENT
.SS Progress updates
.INDENT 0.0
.TP
.B \-W REGEX, \-\-warning\-regex=REGEX
Define a regular expression which prints a warning if it matches any
content of the checked link. This applies only to valid pages, so we
can get their content.
Use this to check for pages that contain some form of error, for
example "This page has moved" or "Oracle Application error".
Note that multiple values can be combined in the regular expression,
for example "(This page has moved|Oracle Application error)".
See section \fI\%REGULAR EXPRESSIONS\fP for more info.
.B \-\-no\-status
Do not print URL check status messages.
.UNINDENT
.SS Application
.INDENT 0.0
.TP
.B \-D STRING, \-\-debug=STRING
Print debugging output for the given logger. Available loggers are
cmdline, checking, cache, dns, plugin and
all. Specifying all is an alias for specifying all available
loggers. The option can be given multiple times to debug with more
than one logger. For accurate results, threading will be disabled
during debug runs.
.UNINDENT
.SS Quiet
.INDENT 0.0
.TP
.B \-q, \-\-quiet
Quiet operation, an alias for \fI\%\-o\fP \fInone\fP that also hides
application information messages.
This is only useful with \fI\%\-F\fP, else no results will be output.
.UNINDENT
.SS Checking options
.INDENT 0.0
@ -436,15 +426,17 @@ Set\-cookie: baggage="elitist"; comment="hologram"
.UNINDENT
.SH PROXY SUPPORT
.sp
To use a proxy on Unix or Windows set the \fI\%http_proxy\fP, \fBhttps_proxy\fP or
\fI\%ftp_proxy\fP environment variables to the proxy URL. The URL should be of
the form
To use a proxy on Unix or Windows set the \fI\%http_proxy\fP or
\fBhttps_proxy\fP environment variables to the proxy URL. The URL should be
of the form
\fBhttp://\fP[\fIuser\fP\fB:\fP\fIpass\fP\fB@\fP]\fIhost\fP[\fB:\fP\fIport\fP].
LinkChecker also detects manual proxy settings of Internet Explorer
under Windows systems, and GNOME or KDE on Linux systems. On a Mac use
under Windows systems. On a Mac use
the Internet Config to select a proxy.
You can also set a comma\-separated domain list in the \fI\%no_proxy\fP
environment variables to ignore any proxy settings for these domains.
environment variable to ignore any proxy settings for these domains.
The \fBcurl_ca_bundle\fP environment variable can be used to identify an
alternative certificate bundle to be used with an HTTPS proxy.
.sp
Setting a HTTP proxy on Unix for example looks like this:
.INDENT 0.0

View file

@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
.TH "LINKCHECKERRC" "5" "June 20, 2021" "2021-06-20" "LinkChecker"
.SH NAME
linkcheckerrc \- configuration file for LinkChecker
.
.nr rst2man-indent-level 0
.
@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "LINKCHECKERRC" "5" "December 14, 2021" "10.0.1.post91+g7f175c13" "LinkChecker"
.SH NAME
linkcheckerrc \- configuration file for LinkChecker
.SH DESCRIPTION
.sp
\fBlinkcheckerrc\fP is the configuration file for LinkChecker. The file is
@ -207,18 +207,12 @@ without checking whether matching input elements exist in the HTML
form.
.UNINDENT
.SS output
.SS URL checking results
.INDENT 0.0
.TP
\fBdebug=\fP\fISTRING\fP[\fB,\fP\fISTRING\fP\&...]
Print debugging output for the given modules. Available debug
modules are \fBcmdline\fP, \fBchecking\fP, \fBcache\fP, \fBdns\fP,
\fBthread\fP, \fBplugins\fP and \fBall\fP\&. Specifying \fBall\fP is an alias
for specifying all available loggers.
Command line option: \fB\-\-debug\fP
.TP
\fBfileoutput=\fP\fITYPE\fP[\fB,\fP\fITYPE\fP\&...]
Output to a file \fBlinkchecker\-out.\fP\fITYPE\fP, or
\fB$HOME/.linkchecker/failures\fP for \fBfailures\fP output.
\fB$HOME/.linkchecker/failures\fP for the \fBfailures\fP output type.
Valid file output types are \fBtext\fP, \fBhtml\fP, \fBsql\fP, \fBcsv\fP,
\fBgml\fP, \fBdot\fP, \fBxml\fP, \fBnone\fP or \fBfailures\fP\&. Default is no
file output. The various output types are documented below. Note
@ -226,7 +220,7 @@ that you can suppress all console output with \fBoutput=none\fP\&.
Command line option: \fB\-\-file\-output\fP
.TP
\fBlog=\fP\fITYPE\fP[\fB/\fP\fIENCODING\fP]
Specify output type as \fBtext\fP, \fBhtml\fP, \fBsql\fP, \fBcsv\fP,
Specify the console output type as \fBtext\fP, \fBhtml\fP, \fBsql\fP, \fBcsv\fP,
\fBgml\fP, \fBdot\fP, \fBxml\fP, \fBnone\fP or \fBfailures\fP\&. Default type
is \fBtext\fP\&. The various output types are documented below.
The \fIENCODING\fP specifies the output encoding, the default is that of
@ -234,15 +228,6 @@ your locale. Valid encodings are listed at
\fI\%https://docs.python.org/library/codecs.html#standard\-encodings\fP\&.
Command line option: \fB\-\-output\fP
.TP
\fBquiet=\fP[\fB0\fP|\fB1\fP]
If set, operate quiet. An alias for \fBlog=none\fP\&. This is only
useful with \fBfileoutput\fP\&.
Command line option: \fB\-\-verbose\fP
.TP
\fBstatus=\fP[\fB0\fP|\fB1\fP]
Control printing check status messages. Default is 1.
Command line option: \fB\-\-no\-status\fP
.TP
\fBverbose=\fP[\fB0\fP|\fB1\fP]
If set log all checked URLs once. Default is to log only errors and
warnings.
@ -252,6 +237,33 @@ Command line option: \fB\-\-verbose\fP
If set log warnings. Default is to log warnings.
Command line option: \fB\-\-no\-warnings\fP
.UNINDENT
.SS Progress updates
.INDENT 0.0
.TP
\fBstatus=\fP[\fB0\fP|\fB1\fP]
Control printing URL checker status messages. Default is 1.
Command line option: \fB\-\-no\-status\fP
.UNINDENT
.SS Application
.INDENT 0.0
.TP
\fBdebug=\fP\fISTRING\fP[\fB,\fP\fISTRING\fP\&...]
Print debugging output for the given modules. Available debug
modules are \fBcmdline\fP, \fBchecking\fP, \fBcache\fP, \fBdns\fP,
\fBthread\fP, \fBplugins\fP and \fBall\fP\&. Specifying \fBall\fP is an alias
for specifying all available loggers.
Command line option: \fB\-\-debug\fP
.UNINDENT
.SS Quiet
.INDENT 0.0
.TP
\fBquiet=\fP[\fB0\fP|\fB1\fP]
If set, operate quiet. An alias for \fBlog=none\fP that also hides
application information messages.
This is only useful with \fBfileoutput\fP, else no results will be output.
Command line option: \fB\-\-quiet\fP
.UNINDENT
.SH OUTPUT TYPES
.SS text
.INDENT 0.0
.TP
@ -268,7 +280,7 @@ Command line option: none
\fBencoding=\fP\fISTRING\fP
Valid encodings are listed in
\fI\%https://docs.python.org/library/codecs.html#standard\-encodings\fP\&.
Default encoding is \fBiso\-8859\-15\fP\&.
Default encoding is the system default locale encoding.
.TP
.B \fIcolor*\fP
Color settings for the various log parts, syntax is \fIcolor\fP or
@ -349,7 +361,7 @@ See \fI\%[text]\fP section above.
See \fI\%[text]\fP section above.
.TP
\fBseparator=\fP\fICHAR\fP
Set CSV separator. Default is a comma (\fB,\fP).
Set CSV separator. Default is a semicolon (\fB;\fP).
.TP
\fBquotechar=\fP\fICHAR\fP
Set CSV quote character. Default is a double quote (\fB"\fP).
@ -550,6 +562,13 @@ options in their section.
.SS AnchorCheck
.sp
Checks validity of HTML anchors.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The AnchorCheck plugin is currently broken and is disabled.
.UNINDENT
.UNINDENT
.SS LocationInfo
.sp
Adds the country and if possible city name of the URL host as info.
@ -583,6 +602,13 @@ Configures the expiration warning time in days.
.sp
Check the syntax of HTML pages with the online W3C HTML validator. See
\fI\%https://validator.w3.org/docs/api.html\fP\&.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The HtmlSyntaxCheck plugin is currently broken and is disabled.
.UNINDENT
.UNINDENT
.SS HttpHeaderInfo
.sp
Print HTTP headers in URL info.