linkchecker/doc/de/linkchecker.de.1
2004-11-25 23:18:58 +00:00

293 lines
10 KiB
Groff

.TH LINKCHECKER 1 "25. November 2004"
.SH NAME
linkchecker \- prüfe HTML Dokumente auf kaputte Verknüpfungen
.SH SYNTAX
.B linkchecker
[
.I Optionen
]
[
.I Datei-oder-URL
]
.SH BESCHREIBUNG
.LP
LinkChecker bietet rekursives Prüfen, Multithreading,
Ausgabe als farbigen oder normalen Text, HTML, SQL, CSV oder einen
Sitemap-Graphen in GML oder XML,
Unterstützung für HTTP/1.1, HTTPS, FTP, mailto:, news:, nntp:,
Gopher, Telnet und lokale Dateiverknüpfungen,
Einschränkung der Verknüpfungsüberprüfung mit URL Filtern bestehend aus
regulären Ausdrücken, Proxy Unterstützung, Benutzer/Passwort
Authentifizierung für HTTP und FTP, Unterstützung des robots.txt
Protokolls, Mehrsprachigkeit, eine Kommandozeilenschnittstelle
sowie eine CGI Webschnittstelle (benötigt einen HTTP Server).
.SH BEISPIELE
Der häufigste Gebrauchsfall prüft eine gegebene Domäne rekursiv,
inklusive aller einzelnen nach außen zeigenden Verknüpfungen:
\fBlinkchecker http://treasure.calvinsplayground.de/\fP
Beachten Sie dass dies die komplette Domäne überprüft welche aus
mehreren hunderttausend URLs bestehen kann. Benutzen Sie die Option -r,
um die Rekursionstiefe zu beschränken.
Keine Verbindungen zu mailto: Rechnern, nur die Syntax wird geprüft. Alle
anderen Verknüpfungen werden wie üblich geprüft:
\fBlinkchecker --intern='!^mailto:' --extern-strict-all www.mysite.org\fP
Überprüfung einer lokalen HTML Datei unter Unix:
\fBlinkchecker ../bla.html\fP
Überprüfung einer lokalen HTML Datei unter Windows:
\fBlinkchecker c:\\temp\\test.html\fP
Sie können den \fBhttp://\fP URL Anteil weglassen wenn die Domäne mit
\fBwww.\fP beginnt:
\fBlinkchecker www.myhomepage.de\fP
Sie können den \fBftp://\fP URL Anteil weglassen wenn die Domäne mit
\fBftp.\fP beginnt:
\fBlinkchecker -r0 ftp.linux.org\fP
.SH OPTIONEN
.SS Allgemeine Optionen
.TP
\fB-h\fP, \fB--help\fP
Hilfe! Gebe Gebrauchsanweisung für dieses Programm aus.
.TP
\fB-f\fP\fIKonfigurationsdatei\fP, \fB--config=\fP\fIKonfigurationsdatei\fP
Benutze \fIfile\fP as configuration file. As default LinkChecker first searches
/etc/linkchecker/linkcheckerrc and then ~/.linkcheckerrc.
.TP
\fB-I\fP, \fB--interactive\fP
Frage nach URLs, falls keine auf der Kommandozeile eingegeben wurde.
.TP
\fB-V\fP, \fB--version\fP
Drucke die Version und beende das Programm.
.TP
\fB-t\fP\fInum\fP, \fB--threads=\fP\fInum\fP
Generiere nicht mehr als \fInum\fP Threads. Standard Anzahl von Threads
ist 10.
.SS Ausgabeoptionen
.TP
\fB-v\fP, \fB--verbose\fP
Logge alle geprüften URLs (impliziert \fB-w\fP). Standard ist es, nur
fehlerhafte URLs zu loggen.
.TP
\fB-w\fP, \fB--warnings\fP
Logge Warnungen.
.TP
\fB-W\fP\fIregex\fP, \fB--warning-regex=\fIregex\fP
Definieren Sie einen regulären Ausdruck, der eine Warnung ausgibt
falls er den Inhalt einer geprüften URL matcht.
Dies gilt nur für gültige Seiten deren Inhalt wir bekommen können.
.BR
Sie können dies verwenden, um Seiten mit Fehlermeldungen wie z.B.
'Diese Seite ist umgezogen' oder 'Oracle Server Fehler'.
Diese Option impliziert \fB-w\fP.
.TP
\fB--warning-size-bytes=\fP\fIbytes\fP
Drucke eine Warnung wenn die Inhaltsgröße bekannt ist und die
angegebene Anzahl von \fIbytes\fP Bytes übersteigt.
Diese Option impliziert \fB-w\fP.
.TP
\fB-q\fP, \fB--quiet\fP
Keine Ausgabe, ein Alias für \fB-o none\fP. Dies ist nur in Verbindung
mit \fB-F\fP nützlich.
.TP
\fB-o\fP\fITyp\fP[\fB/\fP\fIEnkodierung\fP], \fB--output=\fP\fITyp\fP[\fB/\fP\fIEnkodierung\fP]
Spezifiziere die Ausgabe als \fBtext\fP, \fBhtml\fP, \fBsql\fP,
\fBcsv\fP, \fBgml\fP, \fBxml\fP, \fBnone\fP oder \fBblacklist\fP.
Standardausgabe ist \fBtext\fP. \fIEnkodierung\fP gibt die
Ausgabekodierung an, die Standardkodierung ist \fBiso-8859-15\fP.
Gültige Encodierungen sind unter
\fBhttp://docs.python.org/lib/node127.html\fP aufgelistet.
.TP
\fB-F\fP\fITyp\fP[\fB/\fP\fIEnkodierung\fP][\fB/\fP\fIDateiname\fP], \fB--file-output=\fP\fITyp\fP[\fB/\fP\fIEnkodierung\fP][\fB/\fP\fIDateiname\fP]
Ausgabe in eine Datei namens \fBlinkchecker-out.\fP\fITyp\fP,
\fB$HOME/.linkchecker_blacklist\fP
bei \fBblacklist\fP Ausgabe, oder \fIDateiname\fP falls angegeben.
Der \fIDateiname\fP Teil wird beim Ausgabetyp \fBnone\fP ignoriert,
ansonsten wird die Datei überschreiben falls sie existiert.
Sie können diese Option mehr als einmal verwenden. Gültige
Ausgabetypen sind \fBtext\fP, \fBhtml\fP, \fBsql\fP,
\fBcsv\fP, \fBgml\fP, \fBxml\fP, \fBnone\fP oder \fBblacklist\fP.
Standard ist keine Dateiausgabe. \fIEnkodierung\fP gibt die
Ausgabekodierung an, die Standardkodierung ist \fBiso-8859-15\fP.
Gültige Encodierungen sind unter
\fBhttp://docs.python.org/lib/node127.html\fP aufgelistet.
Bemerken Sie dass die Option
\fB-o none\fP jegliche Ausgaben auf der Konsole verhindert.
.TP
\fB--no-status\fP
Gebe keine Statusmeldungen aus.
.TP
\fB-D\fP, \fB--debug\fP
Gebe Debugmeldungen aus für den angegebenen Logger.
Verfügbare Logger sind \fBcmdline\fP, \fBchecking\fP,
\fBcache\fP, \fBgui\fP and \fBall\fP.
Die Angabe \fBall\fP ist ein Synonym für alle verfügbaren Logger.
Diese Option kann mehrmals angegeben werden, um
mit mehr als einem Logger zu debuggen.
.BR
Für exakte Resultate wird Threading während einem
Debuglauf deaktiviert.
.TP
\fB--profile\fP
Schreibe Profiling-Daten in eine Datei namens \fBlinkchecker.prof\fP im
aktuellen Arbeitsverzeichnis. Siehe auch \fB--viewprof\fP.
.TP
\fB--viewprof\fP
Gebe vorher generierte Profiling-Daten aus. Siehe auch \fB--profile\fP.
.SS Optionen zum Prüfen
.TP
\fB-r\fP\fIdepth\fP, \fB--recursion-level=\fP\fIdepth\fP
Check recursively all links up to given \fIdepth\fP.
A negative depth will enable inifinite recursion.
Default depth is inifinite.
.TP
\fB-i\fP\fIregex\fP, \fB--intern=\fIregex\fP
Assume URLs that match the given regular expression as internal.
LinkChecker descends recursively only to internal URLs, not to external.
.TP
\fB-e\fP\fIregex\fP, \fB--extern=\fP\fIregex\fP
Assume urls that match the given regular expression as external.
Only internal HTML links are checked recursively.
.TP
\fB--extern-strict=\fP\fIregex\fP
Assume urls that match the given regular expression as strict external.
Only internal HTML links are checked recursively.
.TP
\fB-s\fP, \fB--extern-strict-all\fP
Check only the syntax of external links, do not try to connect to them.
For local file urls, only local files are internal. For
http and ftp urls, all urls at the same domain name are internal.
.TP
\fB-d\fP, \fB--denyallow\fP
Swap checking order to external/internal. Default checking order is
internal/external.
.TP
\fB-C\fP, \fB--cookies\fP
Accept and send HTTP cookies according to RFC 2109. Only cookies
which are sent back to the originating server are accepted.
Sent and accepted cookies are provided as additional logging
information.
.TP
\fB-a\fP, \fB--anchors\fP
Check HTTP anchor references. This option applies to both internal
and external urls. Default is don't check anchors.
This option implies -w because anchor errors are always warnings.
.TP
\fB--no-anchor-caching\fP
Treat url#anchora and url#anchorb as equal on caching. This
is the default browser behaviour, but it's not specified in
the URI specification. Use with care.
.TP
\fB-u\fP\fIname\fP, \fB--user=\fP\fIname\fP
Try username \fIname\fP for HTTP and FTP authorization.
For FTP the default username is \fBanonymous\fP. See also \fB-p\fP.
.TP
\fB-p\fP\fIpwd\fP, \fB--password=\fP\fIpwd\fP
Try the password \fIpwd\fP for HTTP and FTP authorization.
For FTP the default password is \fBanonymous@\fP. See also \fB-u\fP.
.TP
\fB--timeout=\fP\fIsecs\fP
Set the timeout for connection attempts in seconds. The default timeout
is 30 seconds.
.TP
\fB-P\fP\fIsecs\fP, \fB--pause=\fP\fIsecs\fP
Pause \fIsecs\fP seconds between each url check. This option
implies \fB-t0\fP.
Default is no pause between requests.
.TP
\fB-N\fP\fIserver\fP, \fB--nntp-server=\fP\fIserver\fP
Specify an NNTP server for 'news:...' links. Default is the
environment variable NNTP_SERVER. If no host is given,
only the syntax of the link is checked.
.SS Alte Optionen
.TP
\fB--status\fP
Print check status every 5 seconds to stderr. This is the default now.
.SH AUSGABETYPEN
Note that by default only errors are logged.
.TP
\fBtext\fP
Standard text logger, logging URLs in keyword: argument fashion
.TP
\fBhtml\fP
Log URLs in keyword: argument fashion, formatted as HTML.
Additionally has links to the referenced pages. Invalid URLs have
HTML and CSS syntax check links appended.
.TP
\fBcsv\fP
Log check result in CSV format with one URL per line.
.TP
\fBgml\fP
Log parent-child relations between linked URLs as a GML graph.
You should use the \fB--verbose\fP option to get a complete graph.
.TP
\fBxml\fP
Log check result as machine-readable XML file.
.TP
\fBsql\fP
Log check result as SQL script with INSERT commands. An example
script to create the initial SQL table is included as create.sql.
.TP
\fBblacklist\fP
Suitable for cron jobs. Logs the check result into a file
\fB~/.blacklist\fP which only contains entries with invalid urls and
the number of times they have failed.
.TP
\fBnone\fP
Logs nothing. Suitable for scripts.
.SH BEMERKUNGEN
Ein \fB!\fP vor einem regulären Ausdruck negiert diesen. Also matcht
\fB'!^mailto:'\fP alles außer mailto Links.
URLs von der Kommandozeile die mit \fBftp.\fP beginnen werden wie
\fBftp://ftp.\fP behandelt, URLs die mit \fBwww.\fP beginnen wie
\fBhttp://www.\fP.
Sie können auch lokale Dateien als Argumente angeben.
Falls sich Ihr System automatisch mit dem Internet verbindet
(z.B. mit diald), wird es dies tun wenn Sie Links prüfen, die nicht
auf Ihren lokalen Rechner verweisen
Benutzen Sie die Optionen \fB-s\fP und \fB-i\fP, um dies zu verhindern.
Javascript Links werden zur Zeit ignoriert
Wenn Ihr System keine Threads unterstützt, benutzt LinkChecker
automatisch \fB-t0\fP..
Sie können mehrere user/password Paare in einer Konfigurationsdatei
angeben
Um Proxies zu benutzen, setzen Sie $http_proxy, $https_proxy unter
Unix oder Windows. Auf einem Mac benutzen Sie die Internet Config.
Beim Prüfen von \fBnews:\fP Links muß der angegebene NNTP Rechner nicht
unbedingt derselbe wie der des Benutzers sein.
.SH DATEIEN
\fB/etc/linkchecker/linkcheckerrc\fP, \fB~/.linkcheckerrc\fP -
Standardkonfigurationsdateien
\fB~/.blacklist\fP - Standard Dateiname der blacklist Logger Ausgabe
\fBlinkchecker-out.\fP\fItype\fP - Standard Dateiname der Logger Ausgabe
\fBhttp://docs.python.org/lib/node127.html\fP - gültige Ausgabe
Enkodierungen
.SH AUTHOR
Bastian Kleineidam <calvin@users.sourceforge.net>