Update man pages

This commit is contained in:
LinkChecker 2023-09-11 18:26:39 +00:00
parent fcce23e434
commit 3e6cb3d84f
4 changed files with 36 additions and 81 deletions

View file

@ -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" "Mai 15, 2023" "10.2.1.post54+g6c0f1f336" "LinkChecker"
.TH "LINKCHECKER" "1" "September 11, 2023" "10.2.1.post89+g3a276cfc8" "LinkChecker"
.SH NAME
linkchecker \- Kommandozeilenprogramm zum Prüfen von HTML Dokumenten und Webseiten auf ungültige Verknüpfungen
.SH SYNTAX
@ -42,13 +42,13 @@ rekursives Prüfen und Multithreading
.IP \(bu 2
Ausgabe als farbigen oder normalen Text, HTML, SQL, CSV, XML oder einen Sitemap\-Graphen in verschiedenen Formaten
.IP \(bu 2
Unterstützung von HTTP/1.1, HTTPS, FTP, mailto:, news:, nntp:, Telnet und Verknüpfungen auf lokale Dateien
support for HTTP/1.1, HTTPS, FTP, mailto: and local file links
.IP \(bu 2
Einschränkung der Linküberprüfung mit URL\-Filter
.IP \(bu 2
Proxy\-Unterstützung
.IP \(bu 2
Benutzer/Passwort Authorisierung für HTTP, FTP und Telnet
username/password authorization for HTTP and FTP
.IP \(bu 2
Unterstützung des robots.txt Protokolls
.IP \(bu 2
@ -258,11 +258,6 @@ See section \fI\%REGULAR EXPRESSIONS\fP for more info.
.UNINDENT
.INDENT 0.0
.TP
.B \-N STRING, \-\-nntp\-server=STRING
Gibt ein NNTP Rechner für news: Links. Standard ist die Umgebungsvariable \fI\%NNTP_SERVER\fP\&. Falls kein Rechner angegeben ist, wird lediglich auf korrekte Syntax des Links geprüft.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-follow\-url=REGEX
Prüfe URLs die auf den regulären Ausdruck zutreffen, aber führe keine Rekursion durch. Diese Option kann mehrmals angegeben werden. Siehe Abschnitt \fI\%REGULAR EXPRESSIONS\fP für weitere Infos.
.UNINDENT
@ -490,12 +485,6 @@ Versuche, in das angegebene Verzeichnis zu wechseln
Liste die Dateien im Verzeichnis auf mit dem NLST\-Befehl
.UNINDENT
.TP
Telnet links (\fBtelnet:\fP)
Versuche, zu dem angegeben Telnetrechner zu verginden und falls Benutzer/Passwort angegeben sind, wird versucht, sich anzumelden.
.TP
NNTP links (\fBnews:\fP, \fBsnews:\fP, \fBnntp\fP)
Versuche, zu dem angegebenen NNTP\-Rechner eine Verbindung aufzubaucne. Falls eine Nachrichtengruppe oder ein bestimmter Artikel angegeben ist, wird versucht, diese Gruppe oder diesen Artikel vom Rechner anzufragen.
.TP
Nicht unterstützte Links (\fBjavascript:\fP, etc.)
Ein nicht unterstützter Link wird nur eine Warnung ausgeben. Weitere Prüfungen werden nicht durchgeführt.
.sp
@ -546,16 +535,9 @@ Javascript Links werden nicht unterstützt.
Wenn Ihr System keine Threads unterstützt, deaktiviert diese LinkChecker automatisch.
.sp
Sie können mehrere Benutzer/Passwort Paare in einer Konfigurationsdatei angeben.
.sp
Beim Prüfen von \fBnews:\fP Links muß der angegebene NNTP Rechner nicht unbedingt derselbe wie der des Benutzers sein.
.SH UMGEBUNG
.INDENT 0.0
.TP
.B NNTP_SERVER
gibt Standard NNTP Server an
.UNINDENT
.INDENT 0.0
.TP
.B http_proxy
gibt Standard HTTP Proxy an
.UNINDENT

View file

@ -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 "LINKCHECKERRC" "5" "Mai 15, 2023" "10.2.1.post54+g6c0f1f336" "LinkChecker"
.TH "LINKCHECKERRC" "5" "September 11, 2023" "10.2.1.post89+g3a276cfc8" "LinkChecker"
.SH NAME
linkcheckerrc \- Konfigurationsdatei für LinkChecker
.SH BESCHREIBUNG
@ -52,9 +52,6 @@ Command line option: none
\fBlocalwebroot=\fP\fISTRING\fP
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 \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: \fI\%\-\-recursion\-level\fP
.TP
@ -124,6 +121,11 @@ Command line option: none
\fBignore=\fP\fIREGEX\fP (\fI\%MULTILINE\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\&...]
Ignore the comma\-separated list of warnings. See \fI\%WARNINGS\fP for
the list of supported warnings. Messages are logged as information.
Command line option: none
.TP
\fBinternlinks=\fP\fIREGEX\fP
Regulärer Ausdruck, um mehr URLs als interne Verknüpfungen hinzuzufügen. Standard ist dass URLs der Kommandozeile als intern gelten. Kommandozeilenoption: none
.TP
@ -140,7 +142,7 @@ Command line option: \fI\%\-\-check\-extern\fP
\fBentry=\fP\fIREGEX\fP \fIBENUTZER\fP [\fIPASSWORT\fP] (\fI\%MULTILINE\fP)
Provide individual username/password pairs for different links. In
addition to a single login page specified with \fBloginurl\fP multiple
FTP, HTTP (Basic Authentication) and telnet links are supported.
FTP and HTTP (Basic Authentication) links are supported.
Entries are a triple (URL regex, username, password) or a tuple (URL
regex, username), where the entries are separated by whitespace.
The password is optional and if missing it has to be entered at the
@ -199,9 +201,6 @@ 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: \fI\%\-\-verbose\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
.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
@ -265,6 +264,11 @@ 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
\fBwraplength=\fP\fINUMBER\fP
The number of characters at which to wrap each message line.
The default is 65.
Command line option: none
.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
.TP
@ -642,15 +646,12 @@ Die URL besitzt keinen Inhalt.
\fBhttp\-rate\-limited\fP
Too many HTTP requests.
.TP
\fBhttp\-redirected\fP
Redirected to a different URL.
.TP
\fBmail\-no\-mx\-host\fP
Der MX Mail\-Rechner konnte nicht gefunden werden.
.TP
\fBnntp\-no\-newsgroup\fP
Die NNTP Nachrichtengruppe konnte nicht gefunden werden.
.TP
\fBnntp\-no\-server\fP
Es wurde kein NNTP Server gefunden.
.TP
\fBurl\-content\-size\-zero\fP
Der URL Inhaltsgrößenangabe ist Null.
.TP

View file

@ -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" "May 15, 2023" "10.2.1.post54+g6c0f1f336" "LinkChecker"
.TH "LINKCHECKER" "1" "September 11, 2023" "10.2.1.post89+g3a276cfc8" "LinkChecker"
.SH NAME
linkchecker \- command line client to check HTML documents and websites for broken links
.SH SYNOPSIS
@ -43,14 +43,13 @@ recursive and multithreaded checking
output in colored or normal text, HTML, SQL, CSV, XML or a sitemap
graph in different formats
.IP \(bu 2
support for HTTP/1.1, HTTPS, FTP, mailto:, news:, nntp:, Telnet and
local file links
support for HTTP/1.1, HTTPS, FTP, mailto: and local file links
.IP \(bu 2
restriction of link checking with URL filters
.IP \(bu 2
proxy support
.IP \(bu 2
username/password authorization for HTTP, FTP and Telnet
username/password authorization for HTTP and FTP
.IP \(bu 2
support for robots.txt exclusion protocol
.IP \(bu 2
@ -264,13 +263,6 @@ See section \fI\%REGULAR EXPRESSIONS\fP for more info.
.UNINDENT
.INDENT 0.0
.TP
.B \-N STRING, \-\-nntp\-server=STRING
Specify an NNTP server for news: links. Default is the
environment variable \fI\%NNTP_SERVER\fP\&. If no host is given, only the
syntax of the link is checked.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-follow\-url=REGEX
Check but do not recurse into URLs matching the given regular
expression.
@ -536,14 +528,6 @@ try to change to the given directory
list the file with the NLST command
.UNINDENT
.TP
Telnet links (\fBtelnet:\fP)
We try to connect and if user/password are given, login to the given
telnet server.
.TP
NNTP links (\fBnews:\fP, \fBsnews:\fP, \fBnntp\fP)
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 (\fBjavascript:\fP, etc.)
An unsupported link will only print a warning. No further checking
will be made.
@ -615,17 +599,9 @@ If your platform does not support threading, LinkChecker disables it
automatically.
.sp
You can supply multiple user/password pairs in a configuration file.
.sp
When checking \fBnews:\fP links the given NNTP host doesn\(aqt need to be the
same as the host of the user browsing your pages.
.SH ENVIRONMENT
.INDENT 0.0
.TP
.B NNTP_SERVER
specifies default NNTP server
.UNINDENT
.INDENT 0.0
.TP
.B http_proxy
specifies default HTTP proxy server
.UNINDENT

View file

@ -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 "LINKCHECKERRC" "5" "May 15, 2023" "10.2.1.post54+g6c0f1f336" "LinkChecker"
.TH "LINKCHECKERRC" "5" "September 11, 2023" "10.2.1.post89+g3a276cfc8" "LinkChecker"
.SH NAME
linkcheckerrc \- configuration file for LinkChecker
.SH DESCRIPTION
@ -59,12 +59,6 @@ slash to join directories instead of a backslash. And the given
directory must end with a slash.
Command line option: none
.TP
\fBnntpserver=\fP\fISTRING\fP
Specify an NNTP server for \fBnews:\fP links. Default is the
environment variable \fI\%NNTP_SERVER\fP\&. If no host is given, only the
syntax of the link is checked.
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.
@ -155,6 +149,11 @@ Command line option: none
Only check syntax of URLs matching the given regular expressions.
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
the list of supported warnings. Messages are logged as information.
Command line option: none
.TP
\fBinternlinks=\fP\fIREGEX\fP
Regular expression to add more URLs recognized as internal links.
Default is that URLs given on the command line are internal.
@ -175,7 +174,7 @@ Command line option: \fI\%\-\-check\-extern\fP
\fBentry=\fP\fIREGEX\fP \fIUSER\fP [\fIPASS\fP] (\fI\%MULTILINE\fP)
Provide individual username/password pairs for different links. In
addition to a single login page specified with \fBloginurl\fP multiple
FTP, HTTP (Basic Authentication) and telnet links are supported.
FTP and HTTP (Basic Authentication) links are supported.
Entries are a triple (URL regex, username, password) or a tuple (URL
regex, username), where the entries are separated by whitespace.
The password is optional and if missing it has to be entered at the
@ -237,11 +236,6 @@ Command line option: \fI\%\-\-verbose\fP
If set log warnings. Default is to log warnings.
Command line option: \fI\%\-\-no\-warnings\fP
.TP
\fBignorewarnings=\fP\fINAME\fP[\fB,\fP\fINAME\fP\&...]
Ignore the comma\-separated list of warnings. See \fI\%WARNINGS\fP for
the list of supported warnings.
Command line option: none
.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
@ -309,6 +303,11 @@ 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
\fBwraplength=\fP\fINUMBER\fP
The number of characters at which to wrap each message line.
The default is 65.
Command line option: none
.TP
.B \fIcolor*\fP
Color settings for the various log parts, syntax is \fIcolor\fP or
\fItype\fP\fB;\fP\fIcolor\fP\&. The \fItype\fP can be \fBbold\fP, \fBlight\fP,
@ -701,15 +700,12 @@ The URL had no content.
\fBhttp\-rate\-limited\fP
Too many HTTP requests.
.TP
\fBhttp\-redirected\fP
Redirected to a different URL.
.TP
\fBmail\-no\-mx\-host\fP
The mail MX host could not be found.
.TP
\fBnntp\-no\-newsgroup\fP
The NNTP newsgroup could not be found.
.TP
\fBnntp\-no\-server\fP
No NNTP server was found.
.TP
\fBurl\-content\-size\-zero\fP
The URL content size is zero.
.TP