diff --git a/doc/man/de/linkchecker.1 b/doc/man/de/linkchecker.1 index 609160f8..6820be76 100644 --- a/doc/man/de/linkchecker.1 +++ b/doc/man/de/linkchecker.1 @@ -27,7 +27,7 @@ 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 21, 2021" "10.0.1.post124+ga12fcf04" "LinkChecker" +.TH "LINKCHECKER" "1" "Oktober 31, 2022" "10.1.0.post162+g614e84b5" "LinkChecker" .SH NAME linkchecker \- Kommandozeilenprogramm zum Prüfen von HTML Dokumenten und Webseiten auf ungültige Verknüpfungen .SH SYNTAX @@ -152,7 +152,8 @@ $ linkchecker \-odot \-v www.example.com | dot \-Tps > sitemap.ps .INDENT 0.0 .TP .B \-f FILENAME, \-\-config=FILENAME -Benutze DATEINAME als Konfigurationsdatei. Standardmäßig benutzt LinkChecker ~/.linkchecker/linkcheckerrc. +Use FILENAME as configuration file. By default LinkChecker uses +$XDG_CONFIG_HOME/linkchecker/linkcheckerrc. .UNINDENT .INDENT 0.0 .TP @@ -161,11 +162,6 @@ Hilfe! Gebe Gebrauchsanweisung für dieses Programm aus. .UNINDENT .INDENT 0.0 .TP -.B \-\-stdin -Lese Liste von URLs zum Prüfen von der Standardeingabe, getrennt durch Leerzeichen. -.UNINDENT -.INDENT 0.0 -.TP .B \-t NUMBER, \-\-threads=NUMBER Generiere nicht mehr als die angegebene Anzahl von Threads. Die Standardanzahl von Threads ist 10. Um Threads zu deaktivieren, geben Sie eine nicht positive Nummer an. .UNINDENT @@ -185,7 +181,7 @@ Print available check plugins and exit. .TP .B \-F TYPE[/ENCODING][/FILENAME], \-\-file\-output=TYPE[/ENCODING][/FILENAME] Output to a file linkchecker\-out.TYPE, -$HOME/.linkchecker/failures for the failures output type, or +$XDG_DATA_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 @@ -228,7 +224,10 @@ Do not print URL check status messages. .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. +Print debugging output for the given logger. +Available debug loggers are cmdline, checking, cache, plugin and all. +all is an alias for all available loggers. +This option can be given multiple times to debug with more than one logger. .UNINDENT .SS Quiet .INDENT 0.0 @@ -242,7 +241,8 @@ This is only useful with \fI\%\-F\fP, else no results will be output. .INDENT 0.0 .TP .B \-\-cookiefile=FILENAME -Lese eine Datei mit Cookie\-Daten. Das Cookie Datenformat wird weiter unten erklärt. +Use initial cookie data read from a file. The cookie data format is +explained below. .UNINDENT .INDENT 0.0 .TP @@ -294,7 +294,20 @@ Verwende den angegebenen Benutzernamen für HTTP und FTP Autorisierung. Für FTP .INDENT 0.0 .TP .B \-\-user\-agent=STRING -Gibt den User\-Agent an, der zu HTTP\-Servern geschickt wird, z.B. "Mozilla/4.0". Der Standard ist "LinkChecker/X.Y", wobei X.Y die aktuelle Version von LinkChecker ist. +Gibt den User\-Agent an, der zu HTTP\-Servern geschickt wird, z.B. \(dqMozilla/4.0\(dq. Der Standard ist \(dqLinkChecker/X.Y\(dq, wobei X.Y die aktuelle Version von LinkChecker ist. +.UNINDENT +.SS Input options +.INDENT 0.0 +.TP +.B \-\-stdin +Read from stdin a list of white\-space separated URLs to check. +.UNINDENT +.INDENT 0.0 +.TP +.B FILE\-OR\-URL +The location to start checking with. +A file can be a simple list of URLs, one per line, if the first line is +\(dq# LinkChecker URL list\(dq. .UNINDENT .SH KONFIGURATIONSDATEIEN .sp @@ -305,10 +318,10 @@ Beachten Sie, dass standardmäßig nur Fehler und Warnungen protokolliert werden .INDENT 0.0 .TP \fBtext\fP -Standard Textausgabe in "Schlüssel: Wert"\-Form. +Standard Textausgabe in \(dqSchlüssel: Wert\(dq\-Form. .TP \fBhtml\fP -Gebe URLs in "Schlüssel: Wert"\-Form als HTML formatiert aus. Besitzt zudem Verknüpfungen auf die referenzierten Seiten. Ungültige URLs haben Verknüpfungen zur HTML und CSS Syntaxprüfung angehängt. +Gebe URLs in \(dqSchlüssel: Wert\(dq\-Form als HTML formatiert aus. Besitzt zudem Verknüpfungen auf die referenzierten Seiten. Ungültige URLs haben Verknüpfungen zur HTML und CSS Syntaxprüfung angehängt. .TP \fBcsv\fP Gebe Prüfresultat in CSV\-Format aus mit einer URL pro Zeile. @@ -332,7 +345,9 @@ Protokolliere Prüfergebnisse als XML Sitemap dessen Format unter \fI\%https://w Gebe Prüfresultat als SQL Skript mit INSERT Befehlen aus. Ein Beispielskript, um die initiale SQL Tabelle zu erstellen ist unter create.sql zu finden. .TP \fBfailures\fP -Für Cronjobs geeignet. Gibt das Prüfergebnis in eine Datei \fB~/.linkchecker/failures\fP aus, welche nur Einträge mit fehlerhaften URLs und die Anzahl der Fehlversuche enthält. +Suitable for cron jobs. Logs the check result into a file +\fB$XDG_DATA_HOME/linkchecker/failures\fP which only contains entries with +invalid URLs and the number of times they have failed. .TP \fBnone\fP Gibt nichts aus. Für Debugging oder Prüfen des Rückgabewerts geeignet. @@ -363,8 +378,8 @@ Mehrere Einträge sind durch eine Leerzeile zu trennen. Das untige Beispiel send .ft C Host: example.com Path: /hello -Set\-cookie: ID="smee" -Set\-cookie: spam="egg" +Set\-cookie: ID=\(dqsmee\(dq +Set\-cookie: spam=\(dqegg\(dq .ft P .fi .UNINDENT @@ -375,7 +390,7 @@ Set\-cookie: spam="egg" .nf .ft C Host: example.org -Set\-cookie: baggage="elitist"; comment="hologram" +Set\-cookie: baggage=\(dqelitist\(dq; comment=\(dqhologram\(dq .ft P .fi .UNINDENT @@ -400,7 +415,7 @@ Einen HTTP\-Proxy unter Unix anzugeben sieht beispielsweise so aus: .sp .nf .ft C -$ export http_proxy="http://proxy.example.com:8080" +$ export http_proxy=\(dqhttp://proxy.example.com:8080\(dq .ft P .fi .UNINDENT @@ -412,7 +427,7 @@ Proxy\-Authentifizierung wird ebenfalls unterstützt: .sp .nf .ft C -$ export http_proxy="http://user1:mypass@proxy.example.org:8081" +$ export http_proxy=\(dqhttp://user1:mypass@proxy.example.org:8081\(dq .ft P .fi .UNINDENT @@ -486,6 +501,13 @@ Ein nicht unterstützter Link wird nur eine Warnung ausgeben. Weitere Prüfungen .sp Die komplette Liste von erkannten, aber nicht unterstützten Links ist in der Quelldatei \fI\%linkcheck/checker/unknownurl.py\fP\&. Die bekanntesten davon dürften JavaScript\-Links sein. .UNINDENT +.SH SITEMAPS +.sp +Sitemaps are parsed for links to check and can be detected either from a +sitemap entry in a robots.txt, or when passed as a \fI\%FILE\-OR\-URL\fP +argument in which case detection requires the urlset/sitemapindex tag to be +within the first 70 characters of the sitemap. +Compressed sitemap files are not supported. .SH PLUGINS .sp There are two plugin types: connection and content plugins. Connection @@ -511,7 +533,7 @@ Die maximale Rekursionstiefe darf nicht überschritten werden. Diese wird mit de .IP 5. 3 Die URL darf nicht in der Liste von ignorierten URLs sein. Die ignorierten URLs werden mit der Option \fI\%\-\-ignore\-url\fP konfiguriert. .IP 6. 3 -Das Robots Exclusion Protocol muss es erlauben, dass Verknüpfungen in der URL rekursiv verfolgt werden können. Dies wird geprüft, indem in den HTML Kopfdaten nach der "nofollow"\-Direktive gesucht wird. +Das Robots Exclusion Protocol muss es erlauben, dass Verknüpfungen in der URL rekursiv verfolgt werden können. Dies wird geprüft, indem in den HTML Kopfdaten nach der \(dqnofollow\(dq\-Direktive gesucht wird. .UNINDENT .sp Beachten Sie, dass die Verzeichnisrekursion alle Dateien in diesem Verzeichnis liest, nicht nur eine Untermenge wie bspw. \fBindex.htm\fP\&. @@ -579,9 +601,9 @@ Sonst ist der Rückgabewert Null. LinkChecker benutzt Hauptspeicher für jede zu prüfende URL, die in der Warteschlange steht. Mit tausenden solcher URLs kann die Menge des benutzten Hauptspeichers sehr groß werden. Dies könnte das Programm oder sogar das gesamte System verlangsamen. .SH DATEIEN .sp -\fB~/.linkchecker/linkcheckerrc\fP \- Standardkonfigurationsdatei +\fB$XDG_CONFIG_HOME/linkchecker/linkcheckerrc\fP \- default configuration file .sp -\fB~/.linkchecker/failures\fP \- Standard Dateiname der failures Logger Ausgabe +\fB$XDG_DATA_HOME/linkchecker/failures\fP \- default failures logger output filename .sp \fBlinkchecker\-out.\fP\fITYP\fP \- Standard Dateiname der Logausgabe .SH SIEHE AUCH @@ -594,6 +616,6 @@ LinkChecker benutzt Hauptspeicher für jede zu prüfende URL, die in der Wartesc .SH AUTHOR Bastian Kleineidam .SH COPYRIGHT -2000-2016 Bastian Kleineidam, 2010-2021 LinkChecker Authors +2000-2016 Bastian Kleineidam, 2010-2022 LinkChecker Authors .\" Generated by docutils manpage writer. . diff --git a/doc/man/de/linkcheckerrc.5 b/doc/man/de/linkcheckerrc.5 index d2c4f59d..8c71b372 100644 --- a/doc/man/de/linkcheckerrc.5 +++ b/doc/man/de/linkcheckerrc.5 @@ -27,18 +27,22 @@ 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 21, 2021" "10.0.1.post124+ga12fcf04" "LinkChecker" +.TH "LINKCHECKERRC" "5" "Oktober 31, 2022" "10.1.0.post162+g614e84b5" "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. +\fBlinkcheckerrc\fP is the configuration file for LinkChecker. The file is +written in an INI\-style format. +The default file location is \fB$XDG_CONFIG_HOME/linkchecker/linkcheckerrc\fP +or else \fB~/.config/linkchecker/linkcheckerrc\fP on Unix, +\fB%HOMEPATH%\e.config\elinkchecker\elinkcheckerrc\fP on Windows systems. .SH EIGENSCHAFTEN .SS checking .INDENT 0.0 .TP \fBcookiefile=\fP\fIDateiname\fP -Lese eine Datei mit Cookie\-Daten. Das Cookie Datenformat wird in \fBlinkchecker(1)\fP erklärt. Kommandozeilenoption: \fB\-\-cookiefile\fP +Lese eine Datei mit Cookie\-Daten. Das Cookie Datenformat wird in \fBlinkchecker(1)\fP erklärt. Kommandozeilenoption: \fI\%\-\-cookiefile\fP .TP \fBdebugmemory=\fP[\fB0\fP|\fB1\fP] Write memory allocation statistics to a file on exit, requires \fI\%meliae\fP\&. @@ -49,16 +53,16 @@ Command line option: none Beachten Sie dass das angegebene Verzeichnis in URL\-Syntax sein muss, d.h. es muss einen normalen statt einen umgekehrten Schrägstrich zum Aneinanderfügen von Verzeichnissen benutzen. Und das angegebene Verzeichnis muss mit einem Schrägstrich enden. Kommandozeilenoption: none .TP \fBnntpserver=\fP\fISTRING\fP -Gibt ein NNTP Rechner für \fBnews:\fP Links. Standard ist die Umgebungsvariable \fBNNTP_SERVER\fP\&. Falls kein Rechner angegeben ist, wird lediglich auf korrekte Syntax des Links geprüft. Kommandozeilenoption: \fB\-\-nntp\-server\fP +Gibt ein NNTP Rechner für \fBnews:\fP Links. Standard ist die Umgebungsvariable \fI\%NNTP_SERVER\fP\&. Falls kein Rechner angegeben ist, wird lediglich auf korrekte Syntax des Links geprüft. Kommandozeilenoption: \fI\%\-\-nntp\-server\fP .TP \fBrecursionlevel=\fP\fINUMMER\fP -Prüfe rekursiv alle URLs bis zu der angegebenen Tiefe. Eine negative Tiefe bewirkt unendliche Rekursion. Standard Tiefe ist unendlich. Kommandozeilenoption: \fB\-\-recursion\-level\fP +Prüfe rekursiv alle URLs bis zu der angegebenen Tiefe. Eine negative Tiefe bewirkt unendliche Rekursion. Standard Tiefe ist unendlich. Kommandozeilenoption: \fI\%\-\-recursion\-level\fP .TP \fBthreads=\fP\fINUMMER\fP -Generiere nicht mehr als die angegebene Anzahl von Threads. Die Standardanzahl von Threads ist 10. Um Threads zu deaktivieren, geben Sie eine nicht positive Nummer an. Kommandozeilenoption: \fB\-\-threads\fP +Generiere nicht mehr als die angegebene Anzahl von Threads. Die Standardanzahl von Threads ist 10. Um Threads zu deaktivieren, geben Sie eine nicht positive Nummer an. Kommandozeilenoption: \fI\%\-\-threads\fP .TP \fBtimeout=\fP\fINUMMER\fP -Setze den Timeout für TCP\-Verbindungen in Sekunden. Der Standard Timeout ist 60 Sekunden. Kommandozeilenoption: \fB\-\-timeout\fP +Setze den Timeout für TCP\-Verbindungen in Sekunden. Der Standard Timeout ist 60 Sekunden. Kommandozeilenoption: \fI\%\-\-timeout\fP .TP \fBaborttimeout=\fP\fINUMMER\fP Time to wait for checks to finish after the user aborts the first @@ -67,7 +71,7 @@ time (with Ctrl\-C or the abort button). The default abort timeout is Command line option: none .TP \fBuseragent=\fP\fISTRING\fP -Gibt den User\-Agent an, der zu HTTP\-Servern geschickt wird, z.B. "Mozilla/4.0". Der Standard ist "LinkChecker/X.Y", wobei X.Y die aktuelle Version von LinkChecker ist. Kommandozeilenoption: \fB\-\-user\-agent\fP +Gibt den User\-Agent an, der zu HTTP\-Servern geschickt wird, z.B. \(dqMozilla/4.0\(dq. Der Standard ist \(dqLinkChecker/X.Y\(dq, wobei X.Y die aktuelle Version von LinkChecker ist. Kommandozeilenoption: \fI\%\-\-user\-agent\fP .TP \fBsslverify=\fP[\fB0\fP|\fB1\fP|\fIfilename\fP] Falls der Wert Null ist werden SSL Zertifikate nicht überprüft. Falls er auf Eins gesetzt wird (der Standard) werden SSL Zertifikate mit der gelieferten CA Zertifikatsdatei geprüft. Falls ein Dateiname angegeben ist wird dieser zur Prüfung verwendet. Kommandozeilenoption: none @@ -91,7 +95,11 @@ Command line option: none Maximale Anzahl von URLs die geprüft werden. Neue URLs werden nicht angenommen nachdem die angegebene Anzahl von URLs geprüft wurde. Kommandozeilenoption: none .TP \fBmaxrequestspersecond=\fP\fINUMMER\fP -Limit the maximum number of requests per second to one host. +Limit the maximum number of HTTP requests per second to one host. +The average number of requests per second is approximately one third of the +maximum. Values less than 1 and at least 0.001 can be used. +To use values greater than 10, the HTTP server must return a +\(dqLinkChecker\(dq response header. The default is 10. Command line option: none .TP @@ -99,7 +107,7 @@ Command line option: none When using http, fetch robots.txt, and confirm whether each URL should be accessed before checking. The default is to use robots.txt files. -Command line option: \fB\-\-no\-robots\fP +Command line option: \fI\%\-\-no\-robots\fP .TP \fBallowedschemes=\fP\fINAME\fP[\fB,\fP\fINAME\fP\&...] Allowed URL schemes as comma\-separated list. @@ -114,7 +122,7 @@ Command line option: none .INDENT 0.0 .TP \fBignore=\fP\fIREGEX\fP (\fI\%MULTILINE\fP) -Prüfe lediglich die Syntax von URLs, welche dem angegebenen regulären Ausdruck entsprechen. Kommandozeilenoption: \fB\-\-ignore\-url\fP +Prüfe lediglich die Syntax von URLs, welche dem angegebenen regulären Ausdruck entsprechen. Kommandozeilenoption: \fI\%\-\-ignore\-url\fP .TP \fBignorewarnings=\fP\fINAME\fP[\fB,\fP\fINAME\fP\&...] Ignoriere die kommagetrennte Liste von Warnungen. Siehe \fI\%WARNINGS\fP für die Liste von erkannten Warnungen. Kommandozeilenoption: none @@ -123,18 +131,18 @@ Ignoriere die kommagetrennte Liste von Warnungen. Siehe \fI\%WARNINGS\fP für di Regulärer Ausdruck, um mehr URLs als interne Verknüpfungen hinzuzufügen. Standard ist dass URLs der Kommandozeile als intern gelten. Kommandozeilenoption: none .TP \fBnofollow=\fP\fIREGEX\fP (\fI\%MULTILINE\fP) -Prüfe URLs die auf den regulären Ausdruck zutreffen, aber führe keine Rekursion durch. Kommandozeilenoption: \fB\-\-no\-follow\-url\fP +Prüfe URLs die auf den regulären Ausdruck zutreffen, aber führe keine Rekursion durch. Kommandozeilenoption: \fI\%\-\-no\-follow\-url\fP .TP \fBcheckextern=\fP[\fB0\fP|\fB1\fP] Check external links. Default is to check internal links only. -Command line option: \fB\-\-check\-extern\fP +Command line option: \fI\%\-\-check\-extern\fP .UNINDENT .SS authentication .INDENT 0.0 .TP \fBentry=\fP\fIREGEX\fP \fIBENUTZER\fP [\fIPASSWORT\fP] (\fI\%MULTILINE\fP) Provide individual username/password pairs for different links. In -addtion to a single login page specified with \fBloginurl\fP multiple +addition to a single login page specified with \fBloginurl\fP multiple FTP, HTTP (Basic Authentication) and telnet links are supported. Entries are a triple (URL regex, username, password) or a tuple (URL regex, username), where the entries are separated by whitespace. @@ -142,9 +150,9 @@ The password is optional and if missing it has to be entered at the commandline. If the regular expression matches the checked URL, the given username/password pair is used for authentication. The command line -options \fB\-u\fP and \fB\-p\fP match every link and therefore override +options \fI\%\-u\fP and \fI\%\-p\fP match every link and therefore override the entries given here. The first match wins. -Command line option: \fB\-u\fP, \fB\-p\fP +Command line option: \fI\%\-u\fP, \fI\%\-p\fP .TP \fBloginurl=\fP\fIURL\fP The URL of a login page to be visited before link checking. The page @@ -172,12 +180,12 @@ form. .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 the \fBfailures\fP output type. +\fB$XDG_DATA_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 +Command line option: \fI\%\-\-file\-output\fP .TP \fBlog=\fP\fITYPE\fP[\fB/\fP\fIENCODING\fP] Specify the console output type as \fBtext\fP, \fBhtml\fP, \fBsql\fP, \fBcsv\fP, @@ -186,26 +194,52 @@ 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 +Command line option: \fI\%\-\-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 +Falls gesetzt, gebe alle geprüften URLs einmal aus. Standard ist es, nur fehlerhafte URLs und Warnungen auszugeben. Kommandozeilenoption: \fI\%\-\-verbose\fP .TP \fBwarnings=\fP[\fB0\fP|\fB1\fP] -Falls gesetzt, gebe keine Warnungen aus. Standard ist die Ausgabe von Warnungen. Kommandozeilenoption: \fB\-\-verbose\fP +Falls gesetzt, gebe keine Warnungen aus. Standard ist die Ausgabe von Warnungen. Kommandozeilenoption: \fI\%\-\-verbose\fP +.TP +\fBignoreerrors=\fP\fIURL_REGEX\fP [\fIMESSAGE_REGEX\fP] (\fI\%MULTILINE\fP) +Specify regular expressions to ignore errors for matching URLs, one +per line. A second regular expression can be specified per line to +only ignore matching error messages per corresponding URL. If the +second expression is omitted, all errors are ignored. In contrast +to \fI\%filtering\fP, this happens \fIafter\fP checking, which allows checking +URLs despite certain expected and tolerable errors. Default is to +not ignore any errors. Example: +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +[output] +ignoreerrors= + ^https://deprecated\e.example\e.com ^410 Gone + # ignore all errors (no second expression), also for syntax check: + ^mailto:.*@example\e.com$ +.ft P +.fi +.UNINDENT .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 +Command line option: \fI\%\-\-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 +Print debugging output for the given logger. Available debug +loggers are \fBcmdline\fP, \fBchecking\fP, \fBcache\fP, \fBplugin\fP and \fBall\fP\&. +\fBall\fP is an alias for all available loggers. +Command line option: \fI\%\-\-debug\fP .UNINDENT .SS Quiet .INDENT 0.0 @@ -214,14 +248,14 @@ Gebe Testmeldungen aus für den angegebenen Logger. Verfügbare Logger sind \fBc 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 +Command line option: \fI\%\-\-quiet\fP .UNINDENT .SH AUSGABETYPEN .SS text .INDENT 0.0 .TP \fBfilename=\fP\fISTRING\fP -Gebe Dateiname für Textausgabe an. Standard Dateiname ist \fBlinkchecker\-out.txt\fP\&. Kommandozeilenoption: \fB\-\-file\-output\fP +Gebe Dateiname für Textausgabe an. Standard Dateiname ist \fBlinkchecker\-out.txt\fP\&. Kommandozeilenoption: \fI\%\-\-file\-output\fP .TP \fBparts=\fP\fISTRING\fP Kommagetrennte Liste von Teilen, die ausgegeben werden sollen. Siehe \fI\%LOGGER PARTS\fP weiter unten. Kommandozeilenoption: none @@ -307,7 +341,12 @@ Siehe \fI\%[text]\fP Sektion weiter oben. 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). +Setze CSV Quotezeichen. Standard ist das doppelte Anführungszeichen (\fB\(dq\fP). +.TP +\fBdialect=\fP\fISTRING\fP +Controls the output formatting. +See \fI\%https://docs.python.org/3/library/csv.html#csv.Dialect\fP\&. +Default is \fBexcel\fP\&. .UNINDENT .SS sql .INDENT 0.0 @@ -409,7 +448,7 @@ Siehe \fI\%[text]\fP Sektion weiter oben. Eine Nummer zwischen 0.0 und 1.0, welche die Priorität festlegt. Die Standardpriorität für die erste URL ist 1.0, für alle Kind\-URLs ist sie 0.5. .TP \fBfrequency=\fP[\fBalways\fP|\fBhourly\fP|\fBdaily\fP|\fBweekly\fP|\fBmonthly\fP|\fByearly\fP|\fBnever\fP] -Die Häufigkeit mit der Seiten sich ändern. +How frequently pages are changing. Default is \fBdaily\fP\&. .UNINDENT .SH AUSGABE PARTS .INDENT 0.0 @@ -433,7 +472,7 @@ valid or invalid, with messages base href=... .TP \fBname\fP -name and name +name and \(dqname\(dq .TP \fBparenturl\fP if any @@ -454,10 +493,10 @@ check time the original url name, can be relative .TP \fBintro\fP -the blurb at the beginning, "starting at ..." +the blurb at the beginning, \(dqstarting at ...\(dq .TP \fBoutro\fP -the blurb at the end, "found x errors ..." +the blurb at the end, \(dqfound x errors ...\(dq .UNINDENT .SH MULTILINE .sp @@ -501,14 +540,9 @@ configuration file the plugin is enabled. Some plugins read extra 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 +Checks validity of HTML anchors. When checking local files, URLs with anchors +that link to directories e.g. \(dqexample/#anchor\(dq are not supported. There is no +such limitation when using http(s). .SS LocationInfo .sp Adds the country and if possible city name of the URL host as info. @@ -520,10 +554,10 @@ Definieren Sie einen regulären Ausdruck der eine Warnung ausgibt falls er auf d .TP \fBwarningregex=\fP\fIREGEX\fP Use this to check for pages that contain some form of error message, -for example "This page has moved" or "Oracle Application error". +for example \(dqThis page has moved\(dq or \(dqOracle Application error\(dq. \fIREGEX\fP should be unquoted. .sp -Man beachte, dass mehrere Werte in dem regulären Ausdruck kombiniert werden können, zum Beispiel "(Diese Seite ist umgezogen|Oracle Applikationsfehler)". +Man beachte, dass mehrere Werte in dem regulären Ausdruck kombiniert werden können, zum Beispiel \(dq(Diese Seite ist umgezogen|Oracle Applikationsfehler)\(dq. .UNINDENT .SS SslCertificateCheck .sp @@ -552,7 +586,7 @@ Print HTTP headers in URL info. .TP \fBprefixes=\fP\fIprefix1\fP[,*prefix2*]... List of comma separated header prefixes. For example to display all -HTTP headers that start with "X\-". +HTTP headers that start with \(dqX\-\(dq. .UNINDENT .SS CssSyntaxCheck .sp @@ -568,7 +602,7 @@ Dateiname von \fBclamd.conf\fP Konfigurationsdatei. .UNINDENT .SS PdfParser .sp -Parse PDF files for URLs to check. Needs the \fI\%pdfminer\fP Python package +Parse PDF files for URLs to check. Needs the \fI\%pdfminer.six\fP Python package installed. .SS WordParser .sp @@ -587,6 +621,9 @@ Regular expression matching the names of Markdown files. Die folgenden Warnungen werden vom Konfigurationseintrag \(aqignorewarnings\(aq erkannt: .INDENT 0.0 .TP +\fBfile\-anchorcheck\-directory\fP +A local directory with an anchor, not supported by AnchorCheck. +.TP \fBfile\-missing\-slash\fP Der file: URL fehlt ein abschließender Schrägstrich. .TP @@ -602,6 +639,9 @@ Ein Fehler trat auf während des Speicherns eines Cookies. \fBhttp\-empty\-content\fP Die URL besitzt keinen Inhalt. .TP +\fBhttp\-rate\-limited\fP +Too many HTTP requests. +.TP \fBmail\-no\-mx\-host\fP Der MX Mail\-Rechner konnte nicht gefunden werden. .TP @@ -617,6 +657,9 @@ Der URL Inhaltsgrößenangabe ist Null. \fBurl\-content\-too\-large\fP Der URL Inhalt ist zu groß. .TP +\fBurl\-content\-type\-unparseable\fP +The URL content type is not parseable. +.TP \fBurl\-effective\-url\fP Die effektive URL unterscheidet sich vom Original. .TP @@ -635,6 +678,6 @@ Die URL %(url)s enthält Leerzeichen am Anfang oder Ende. .SH AUTHOR Bastian Kleineidam .SH COPYRIGHT -2000-2016 Bastian Kleineidam, 2010-2021 LinkChecker Authors +2000-2016 Bastian Kleineidam, 2010-2022 LinkChecker Authors .\" Generated by docutils manpage writer. . diff --git a/doc/man/en/linkchecker.1 b/doc/man/en/linkchecker.1 index 86e8ce58..b560c71d 100644 --- a/doc/man/en/linkchecker.1 +++ b/doc/man/en/linkchecker.1 @@ -27,7 +27,7 @@ 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 21, 2021" "10.0.1.post124+ga12fcf04" "LinkChecker" +.TH "LINKCHECKER" "1" "October 31, 2022" "10.1.0.post162+g614e84b5" "LinkChecker" .SH NAME linkchecker \- command line client to check HTML documents and websites for broken links .SH SYNOPSIS @@ -158,7 +158,7 @@ $ linkchecker \-odot \-v www.example.com | dot \-Tps > sitemap.ps .TP .B \-f FILENAME, \-\-config=FILENAME Use FILENAME as configuration file. By default LinkChecker uses -~/.linkchecker/linkcheckerrc. +$XDG_CONFIG_HOME/linkchecker/linkcheckerrc. .UNINDENT .INDENT 0.0 .TP @@ -167,11 +167,6 @@ Help me! Print usage information for this program. .UNINDENT .INDENT 0.0 .TP -.B \-\-stdin -Read list of white\-space separated URLs to check from stdin. -.UNINDENT -.INDENT 0.0 -.TP .B \-t NUMBER, \-\-threads=NUMBER Generate no more than the given number of threads. Default number of threads is 10. To disable threading specify a non\-positive number. @@ -192,7 +187,7 @@ Print available check plugins and exit. .TP .B \-F TYPE[/ENCODING][/FILENAME], \-\-file\-output=TYPE[/ENCODING][/FILENAME] Output to a file linkchecker\-out.TYPE, -$HOME/.linkchecker/failures for the failures output type, or +$XDG_DATA_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 @@ -235,12 +230,10 @@ Do not print URL check status messages. .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. +Print debugging output for the given logger. +Available debug loggers are cmdline, checking, cache, plugin and all. +all is an alias for all available loggers. +This option can be given multiple times to debug with more than one logger. .UNINDENT .SS Quiet .INDENT 0.0 @@ -254,7 +247,7 @@ This is only useful with \fI\%\-F\fP, else no results will be output. .INDENT 0.0 .TP .B \-\-cookiefile=FILENAME -Read a file with initial cookie data. The cookie data format is +Use initial cookie data read from a file. The cookie data format is explained below. .UNINDENT .INDENT 0.0 @@ -319,9 +312,22 @@ username. See also \fI\%\-p\fP\&. .TP .B \-\-user\-agent=STRING Specify the User\-Agent string to send to the HTTP server, for -example "Mozilla/4.0". The default is "LinkChecker/X.Y" where X.Y is +example \(dqMozilla/4.0\(dq. The default is \(dqLinkChecker/X.Y\(dq where X.Y is the current version of LinkChecker. .UNINDENT +.SS Input options +.INDENT 0.0 +.TP +.B \-\-stdin +Read from stdin a list of white\-space separated URLs to check. +.UNINDENT +.INDENT 0.0 +.TP +.B FILE\-OR\-URL +The location to start checking with. +A file can be a simple list of URLs, one per line, if the first line is +\(dq# LinkChecker URL list\(dq. +.UNINDENT .SH CONFIGURATION FILES .sp Configuration files can specify all options above. They can also specify @@ -369,7 +375,7 @@ script to create the initial SQL table is included as create.sql. .TP \fBfailures\fP Suitable for cron jobs. Logs the check result into a file -\fB~/.linkchecker/failures\fP which only contains entries with +\fB$XDG_DATA_HOME/linkchecker/failures\fP which only contains entries with invalid URLs and the number of times they have failed. .TP \fBnone\fP @@ -407,8 +413,8 @@ and one to all URLs starting with \fBhttps://example.org/\fP: .ft C Host: example.com Path: /hello -Set\-cookie: ID="smee" -Set\-cookie: spam="egg" +Set\-cookie: ID=\(dqsmee\(dq +Set\-cookie: spam=\(dqegg\(dq .ft P .fi .UNINDENT @@ -419,7 +425,7 @@ Set\-cookie: spam="egg" .nf .ft C Host: example.org -Set\-cookie: baggage="elitist"; comment="hologram" +Set\-cookie: baggage=\(dqelitist\(dq; comment=\(dqhologram\(dq .ft P .fi .UNINDENT @@ -444,7 +450,7 @@ Setting a HTTP proxy on Unix for example looks like this: .sp .nf .ft C -$ export http_proxy="http://proxy.example.com:8080" +$ export http_proxy=\(dqhttp://proxy.example.com:8080\(dq .ft P .fi .UNINDENT @@ -456,7 +462,7 @@ Proxy authentication is also supported: .sp .nf .ft C -$ export http_proxy="http://user1:mypass@proxy.example.org:8081" +$ export http_proxy=\(dqhttp://user1:mypass@proxy.example.org:8081\(dq .ft P .fi .UNINDENT @@ -547,6 +553,13 @@ in the \fI\%linkcheck/checker/unknownurl.py\fP source file. The most prominent of them should be JavaScript links. .UNINDENT +.SH SITEMAPS +.sp +Sitemaps are parsed for links to check and can be detected either from a +sitemap entry in a robots.txt, or when passed as a \fI\%FILE\-OR\-URL\fP +argument in which case detection requires the urlset/sitemapindex tag to be +within the first 70 characters of the sitemap. +Compressed sitemap files are not supported. .SH PLUGINS .sp There are two plugin types: connection and content plugins. Connection @@ -580,7 +593,7 @@ It must not match the ignored URL list. This is controlled with the \fI\%\-\-ignore\-url\fP option. .IP 6. 3 The Robots Exclusion Protocol must allow links in the URL to be -followed recursively. This is checked by searching for a "nofollow" +followed recursively. This is checked by searching for a \(dqnofollow\(dq directive in the HTML header data. .UNINDENT .sp @@ -660,9 +673,9 @@ of queued URLs the amount of consumed memory can become quite large. This might slow down the program or even the whole system. .SH FILES .sp -\fB~/.linkchecker/linkcheckerrc\fP \- default configuration file +\fB$XDG_CONFIG_HOME/linkchecker/linkcheckerrc\fP \- default configuration file .sp -\fB~/.linkchecker/failures\fP \- default failures logger output filename +\fB$XDG_DATA_HOME/linkchecker/failures\fP \- default failures logger output filename .sp \fBlinkchecker\-out.\fP\fITYPE\fP \- default logger file output name .SH SEE ALSO @@ -677,6 +690,6 @@ documentation .SH AUTHOR Bastian Kleineidam .SH COPYRIGHT -2000-2016 Bastian Kleineidam, 2010-2021 LinkChecker Authors +2000-2016 Bastian Kleineidam, 2010-2022 LinkChecker Authors .\" Generated by docutils manpage writer. . diff --git a/doc/man/en/linkcheckerrc.5 b/doc/man/en/linkcheckerrc.5 index 48944923..23fb7d91 100644 --- a/doc/man/en/linkcheckerrc.5 +++ b/doc/man/en/linkcheckerrc.5 @@ -27,15 +27,16 @@ 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 21, 2021" "10.0.1.post124+ga12fcf04" "LinkChecker" +.TH "LINKCHECKERRC" "5" "October 31, 2022" "10.1.0.post162+g614e84b5" "LinkChecker" .SH NAME linkcheckerrc \- configuration file for LinkChecker .SH DESCRIPTION .sp \fBlinkcheckerrc\fP is the configuration file for LinkChecker. The file is written in an INI\-style format. -The default file location is \fB~/.linkchecker/linkcheckerrc\fP on Unix, -\fB%HOMEPATH%\e.linkchecker\elinkcheckerrc\fP on Windows systems. +The default file location is \fB$XDG_CONFIG_HOME/linkchecker/linkcheckerrc\fP +or else \fB~/.config/linkchecker/linkcheckerrc\fP on Unix, +\fB%HOMEPATH%\e.config\elinkchecker\elinkcheckerrc\fP on Windows systems. .SH SETTINGS .SS checking .INDENT 0.0 @@ -43,7 +44,7 @@ The default file location is \fB~/.linkchecker/linkcheckerrc\fP on Unix, \fBcookiefile=\fP\fIfilename\fP Read a file with initial cookie data. The cookie data format is explained in \fBlinkchecker(1)\fP\&. -Command line option: \fB\-\-cookiefile\fP +Command line option: \fI\%\-\-cookiefile\fP .TP \fBdebugmemory=\fP[\fB0\fP|\fB1\fP] Write memory allocation statistics to a file on exit, requires \fI\%meliae\fP\&. @@ -60,24 +61,24 @@ Command line option: none .TP \fBnntpserver=\fP\fISTRING\fP Specify an NNTP server for \fBnews:\fP links. Default is the -environment variable \fBNNTP_SERVER\fP\&. If no host is given, only the +environment variable \fI\%NNTP_SERVER\fP\&. If no host is given, only the syntax of the link is checked. -Command line option: \fB\-\-nntp\-server\fP +Command line option: \fI\%\-\-nntp\-server\fP .TP \fBrecursionlevel=\fP\fINUMBER\fP Check recursively all links up to given depth. A negative depth will enable infinite recursion. Default depth is infinite. -Command line option: \fB\-\-recursion\-level\fP +Command line option: \fI\%\-\-recursion\-level\fP .TP \fBthreads=\fP\fINUMBER\fP Generate no more than the given number of threads. Default number of threads is 10. To disable threading specify a non\-positive number. -Command line option: \fB\-\-threads\fP +Command line option: \fI\%\-\-threads\fP .TP \fBtimeout=\fP\fINUMBER\fP Set the timeout for connection attempts in seconds. The default timeout is 60 seconds. -Command line option: \fB\-\-timeout\fP +Command line option: \fI\%\-\-timeout\fP .TP \fBaborttimeout=\fP\fINUMBER\fP Time to wait for checks to finish after the user aborts the first @@ -87,9 +88,9 @@ Command line option: none .TP \fBuseragent=\fP\fISTRING\fP Specify the User\-Agent string to send to the HTTP server, for -example "Mozilla/4.0". The default is "LinkChecker/X.Y" where X.Y is +example \(dqMozilla/4.0\(dq. The default is \(dqLinkChecker/X.Y\(dq where X.Y is the current version of LinkChecker. -Command line option: \fB\-\-user\-agent\fP +Command line option: \fI\%\-\-user\-agent\fP .TP \fBsslverify=\fP[\fB0\fP|\fB1\fP|\fIfilename\fP] If set to zero disables SSL certificate checking. If set to one (the @@ -124,7 +125,11 @@ The default is to queue and check all URLs. Command line option: none .TP \fBmaxrequestspersecond=\fP\fINUMBER\fP -Limit the maximum number of requests per second to one host. +Limit the maximum number of HTTP requests per second to one host. +The average number of requests per second is approximately one third of the +maximum. Values less than 1 and at least 0.001 can be used. +To use values greater than 10, the HTTP server must return a +\(dqLinkChecker\(dq response header. The default is 10. Command line option: none .TP @@ -132,7 +137,7 @@ Command line option: none When using http, fetch robots.txt, and confirm whether each URL should be accessed before checking. The default is to use robots.txt files. -Command line option: \fB\-\-no\-robots\fP +Command line option: \fI\%\-\-no\-robots\fP .TP \fBallowedschemes=\fP\fINAME\fP[\fB,\fP\fINAME\fP\&...] Allowed URL schemes as comma\-separated list. @@ -148,7 +153,7 @@ Command line option: none .TP \fBignore=\fP\fIREGEX\fP (\fI\%MULTILINE\fP) Only check syntax of URLs matching the given regular expressions. -Command line option: \fB\-\-ignore\-url\fP +Command line option: \fI\%\-\-ignore\-url\fP .TP \fBignorewarnings=\fP\fINAME\fP[\fB,\fP\fINAME\fP\&...] Ignore the comma\-separated list of warnings. See \fI\%WARNINGS\fP for @@ -163,11 +168,11 @@ Command line option: none \fBnofollow=\fP\fIREGEX\fP (\fI\%MULTILINE\fP) Check but do not recurse into URLs matching the given regular expressions. -Command line option: \fB\-\-no\-follow\-url\fP +Command line option: \fI\%\-\-no\-follow\-url\fP .TP \fBcheckextern=\fP[\fB0\fP|\fB1\fP] Check external links. Default is to check internal links only. -Command line option: \fB\-\-check\-extern\fP +Command line option: \fI\%\-\-check\-extern\fP .UNINDENT .SS authentication .INDENT 0.0 @@ -182,9 +187,9 @@ The password is optional and if missing it has to be entered at the commandline. If the regular expression matches the checked URL, the given username/password pair is used for authentication. The command line -options \fB\-u\fP and \fB\-p\fP match every link and therefore override +options \fI\%\-u\fP and \fI\%\-p\fP match every link and therefore override the entries given here. The first match wins. -Command line option: \fB\-u\fP, \fB\-p\fP +Command line option: \fI\%\-u\fP, \fI\%\-p\fP .TP \fBloginurl=\fP\fIURL\fP The URL of a login page to be visited before link checking. The page @@ -212,12 +217,12 @@ form. .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 the \fBfailures\fP output type. +\fB$XDG_DATA_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 +Command line option: \fI\%\-\-file\-output\fP .TP \fBlog=\fP\fITYPE\fP[\fB/\fP\fIENCODING\fP] Specify the console output type as \fBtext\fP, \fBhtml\fP, \fBsql\fP, \fBcsv\fP, @@ -226,33 +231,55 @@ 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 +Command line option: \fI\%\-\-output\fP .TP \fBverbose=\fP[\fB0\fP|\fB1\fP] If set log all checked URLs once. Default is to log only errors and warnings. -Command line option: \fB\-\-verbose\fP +Command line option: \fI\%\-\-verbose\fP .TP \fBwarnings=\fP[\fB0\fP|\fB1\fP] If set log warnings. Default is to log warnings. -Command line option: \fB\-\-no\-warnings\fP +Command line option: \fI\%\-\-no\-warnings\fP +.TP +\fBignoreerrors=\fP\fIURL_REGEX\fP [\fIMESSAGE_REGEX\fP] (\fI\%MULTILINE\fP) +Specify regular expressions to ignore errors for matching URLs, one +per line. A second regular expression can be specified per line to +only ignore matching error messages per corresponding URL. If the +second expression is omitted, all errors are ignored. In contrast +to \fI\%filtering\fP, this happens \fIafter\fP checking, which allows checking +URLs despite certain expected and tolerable errors. Default is to +not ignore any errors. Example: +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +[output] +ignoreerrors= + ^https://deprecated\e.example\e.com ^410 Gone + # ignore all errors (no second expression), also for syntax check: + ^mailto:.*@example\e.com$ +.ft P +.fi +.UNINDENT .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 +Command line option: \fI\%\-\-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 +Print debugging output for the given logger. Available debug +loggers are \fBcmdline\fP, \fBchecking\fP, \fBcache\fP, \fBplugin\fP and \fBall\fP\&. +\fBall\fP is an alias for all available loggers. +Command line option: \fI\%\-\-debug\fP .UNINDENT .SS Quiet .INDENT 0.0 @@ -261,7 +288,7 @@ Command line option: \fB\-\-debug\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 +Command line option: \fI\%\-\-quiet\fP .UNINDENT .SH OUTPUT TYPES .SS text @@ -270,7 +297,7 @@ Command line option: \fB\-\-quiet\fP \fBfilename=\fP\fISTRING\fP Specify output filename for text logging. Default filename is \fBlinkchecker\-out.txt\fP\&. -Command line option: \fB\-\-file\-output\fP +Command line option: \fI\%\-\-file\-output\fP .TP \fBparts=\fP\fISTRING\fP Comma\-separated list of parts that have to be logged. See \fI\%LOGGER PARTS\fP @@ -364,7 +391,12 @@ See \fI\%[text]\fP section above. 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). +Set CSV quote character. Default is a double quote (\fB\(dq\fP). +.TP +\fBdialect=\fP\fISTRING\fP +Controls the output formatting. +See \fI\%https://docs.python.org/3/library/csv.html#csv.Dialect\fP\&. +Default is \fBexcel\fP\&. .UNINDENT .SS sql .INDENT 0.0 @@ -467,7 +499,7 @@ A number between 0.0 and 1.0 determining the priority. The default priority for the first URL is 1.0, for all child URLs 0.5. .TP \fBfrequency=\fP[\fBalways\fP|\fBhourly\fP|\fBdaily\fP|\fBweekly\fP|\fBmonthly\fP|\fByearly\fP|\fBnever\fP] -How frequently pages are changing. +How frequently pages are changing. Default is \fBdaily\fP\&. .UNINDENT .SH LOGGER PARTS .INDENT 0.0 @@ -491,7 +523,7 @@ valid or invalid, with messages base href=... .TP \fBname\fP -name and name +name and \(dqname\(dq .TP \fBparenturl\fP if any @@ -512,10 +544,10 @@ check time the original url name, can be relative .TP \fBintro\fP -the blurb at the beginning, "starting at ..." +the blurb at the beginning, \(dqstarting at ...\(dq .TP \fBoutro\fP -the blurb at the end, "found x errors ..." +the blurb at the end, \(dqfound x errors ...\(dq .UNINDENT .SH MULTILINE .sp @@ -561,14 +593,9 @@ configuration file the plugin is enabled. Some plugins read extra 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 +Checks validity of HTML anchors. When checking local files, URLs with anchors +that link to directories e.g. \(dqexample/#anchor\(dq are not supported. There is no +such limitation when using http(s). .SS LocationInfo .sp Adds the country and if possible city name of the URL host as info. @@ -582,11 +609,11 @@ get their content. .TP \fBwarningregex=\fP\fIREGEX\fP Use this to check for pages that contain some form of error message, -for example "This page has moved" or "Oracle Application error". +for example \(dqThis page has moved\(dq or \(dqOracle Application error\(dq. \fIREGEX\fP should be unquoted. .sp Note that multiple values can be combined in the regular expression, -for example "(This page has moved|Oracle Application error)". +for example \(dq(This page has moved|Oracle Application error)\(dq. .UNINDENT .SS SslCertificateCheck .sp @@ -616,7 +643,7 @@ Print HTTP headers in URL info. .TP \fBprefixes=\fP\fIprefix1\fP[,*prefix2*]... List of comma separated header prefixes. For example to display all -HTTP headers that start with "X\-". +HTTP headers that start with \(dqX\-\(dq. .UNINDENT .SS CssSyntaxCheck .sp @@ -633,7 +660,7 @@ Filename of \fBclamd.conf\fP config file. .UNINDENT .SS PdfParser .sp -Parse PDF files for URLs to check. Needs the \fI\%pdfminer\fP Python package +Parse PDF files for URLs to check. Needs the \fI\%pdfminer.six\fP Python package installed. .SS WordParser .sp @@ -653,6 +680,9 @@ The following warnings are recognized in the \(aqignorewarnings\(aq config file entry: .INDENT 0.0 .TP +\fBfile\-anchorcheck\-directory\fP +A local directory with an anchor, not supported by AnchorCheck. +.TP \fBfile\-missing\-slash\fP The file: URL is missing a trailing slash. .TP @@ -668,6 +698,9 @@ An error occurred while storing a cookie. \fBhttp\-empty\-content\fP The URL had no content. .TP +\fBhttp\-rate\-limited\fP +Too many HTTP requests. +.TP \fBmail\-no\-mx\-host\fP The mail MX host could not be found. .TP @@ -683,6 +716,9 @@ The URL content size is zero. \fBurl\-content\-too\-large\fP The URL content size is too large. .TP +\fBurl\-content\-type\-unparseable\fP +The URL content type is not parseable. +.TP \fBurl\-effective\-url\fP The effective URL is different from the original. .TP @@ -701,6 +737,6 @@ The URL contains leading or trailing whitespace. .SH AUTHOR Bastian Kleineidam .SH COPYRIGHT -2000-2016 Bastian Kleineidam, 2010-2021 LinkChecker Authors +2000-2016 Bastian Kleineidam, 2010-2022 LinkChecker Authors .\" Generated by docutils manpage writer. .