linkcheckerrc(5) Konfigurationsdatei für LinkChecker

BESCHREIBUNG

linkcheckerrc ist die Konfigurationsdatei für LinkChecker. Die Datei ist in einem INI-Format geschrieben.
Die Standarddatei ist ~/.linkchecker/linkcheckerrc unter Unix-, %HOMEPATH%\.linkchecker\linkcheckerrc unter Windows-Systemen.

EIGENSCHAFTEN

[checking]

cookiefile=Dateiname
Lese eine Datei mit Cookie-Daten. Das Cookie Datenformat wird in linkchecker(1) erklärt.
Kommandozeilenoption: --cookiefile
localwebroot=STRING
Beim Prüfen von absoluten URLs in lokalen Dateien wird das angegebene Wurzelverzeichnis als Basis-URL benutzt.
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: keine
nntpserver=STRING
Gibt ein NNTP Rechner für news: Links. Standard ist die Umgebungsvariable NNTP_SERVER. Falls kein Rechner angegeben ist, wird lediglich auf korrekte Syntax des Links geprüft.
Kommandozeilenoption: --nntp-server
recursionlevel=NUMBER
Prüfe rekursiv alle URLs bis zu der angegebenen Tiefe. Eine negative Tiefe bewirkt unendliche Rekursion. Standard Tiefe ist unendlich.
Kommandozeilenoption: --recursion-level
threads=NUMBER
Generiere nicht mehr als die angegebene Anzahl von Threads. Standard Anzahl von Threads ist 100. Um Threads zu deaktivieren, geben Sie eine nicht positive Nummer an.
Kommandozeilenoption: --threads
timeout=NUMMER
Setze den Timeout für TCP-Verbindungen in Sekunden. Der Standard Timeout ist 60 Sekunden.
Kommandozeilenoption: --timeout
aborttimeout=NUMBER
Time to wait for checks to finish after the user aborts the first time (with Ctrl-C or the abort button). The default abort timeout is 300 seconds.
Kommandozeilenoption: --timeout
useragent=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.
Kommandozeilenoption: --user-agent
sslverify=[0|1|dateiname]
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: keine
maxrunseconds=NUMBER
Hört nach der angegebenen Anzahl von Sekunden auf, neue URLs zu prüfen. Dies ist dasselbe als wenn der Benutzer nach der gegebenen Anzahl von Sekunden stoppt (durch Drücken von Strg-C oder Klicken auf den Knopf Abbrechen im GUI).
Standard ist nicht zu stoppen bis alle URLs geprüft sind.
Kommandozeilenoption: keine
maxnumurls=NUMBER
Maximale Anzahl von URLs die geprüft werden. Neue URLs werden nicht angenommen nachdem die angegebene Anzahl von URLs geprüft wurde.
Standard ist alle URLs anzunehmen und zu prüfen.
Kommandozeilenoption: keine
maxrequestspersecond=NUMBER
Limit the maximum number of requests per second to one host.
allowedschemes=NAME[,NAME...]
Allowed URL schemes as comma-separated list.

[filtering]

ignore=REGEX (MULTILINE)
Prüfe lediglich die Syntax von URLs, welche dem angegebenen regulären Ausdruck entsprechen.
Kommandozeilenoption: --ignore-url
ignorewarnings=NAME[,NAME...]
Ignoriere die kommagetrennte Liste von Warnungen. Siehe WARNUNGEN für die Liste von erkannten Warnungen.
Kommandozeilenoption: keine
internlinks=REGEX
Regulärer Ausdruck, um mehr URLs als interne Verknüpfungen hinzuzufügen. Standard ist dass URLs der Kommandozeile als intern gelten.
Kommandozeilenoption: keine
nofollow=REGEX (MULTILINE)
Prüfe URLs die auf den regulären Ausdruck zutreffen, aber führe keine Rekursion durch.
Kommandozeilenoption: --no-follow-url
checkextern=[0|1]
Check external links. Default is to check internal links only.
Command line option: --checkextern

[authentication]

entry=REGEX BENUTZER [PASSWORT] (MULTILINE)
Erstelle verschiedene Benutzer/Passwort-Paare für verschiedene Verknüpfungsarten. Einträge sind ein Tripel (URL regulärer Ausdruck, Benutzername, Passwort) oder ein Tupel (URL regulärer Ausdruck, Benutzername), wobei die Einträge durch Leerzeichen getrennt sind.
Das Passwort ist optional und muss falls es fehlt auf der Kommandozeile eingegeben werden.
Falls der reguläre Ausdruck auf die zu prüfende URL zutrifft, wird das angegebene Benutzer/Passwort-Paar zum Authentifizieren genutzt. Die Kommandozeilenoptionen -u und -p treffen auf jede Verknüpfung zu und überschreiben daher die Einträge hier. Der erste Treffer gewinnt. Im Moment wird Authentifizierung für http[s] und ftp Verknüpfungen benutzt.
Kommandozeilenoption: -u, -p
loginurl=URL
A login URL to be visited before checking. Also needs authentication data set for it.
loginuserfield=NAME
Der Name für das Benutzer CGI-Feld. Der Standardname ist login.
loginpasswordfield=NAME
Der Name für das Passwort CGI-Feld. Der Standardname ist password.
loginextrafields=NAME:WERT (MULTILINE)
Optional zusätzliche CGI Namen/Werte-Paare. Die Default-Werte werden automatisch übermittelt.

[output]

debug=STRING[,STRING...]
Gebe Testmeldungen aus für den angegebenen Logger. Verfügbare Logger sind cmdline, checking,cache, gui, dns, thread und all. Die Angabe all ist ein Synonym für alle verfügbaren Logger.
[output]
fileoutput=TYPE[,TYPE...]
Ausgabe in Datei linkchecker-out.TYPE, $HOME/.linkchecker/blacklist für blacklist Ausgabe.
Gültige Ausgabearten sind text, html, sql, csv, gml, dot, xml, none oder blacklist Standard ist keine Dateiausgabe. Die verschiedenen Ausgabearten sind unten dokumentiert. Bemerke, dass man alle Konsolenausgaben mit output=none unterdrücken kann.
Kommandozeilenoption: --file-output
log=TYPE[/ENCODING]
Gib Ausgabetyp als text, html, sql, csv, gml, dot, xml, none oder blacklist 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 http://docs.python.org/library/codecs.html#standard-encodings.
Kommandozeilenoption: --output
quiet=[0|1]
Falls gesetzt, erfolgt keine Ausgabe. Ein Alias für log=none. Dies ist nur in Verbindung mit fileoutput nützlich.
Kommandozeilenoption: --verbose
status=[0|1]
Kontrolle der Statusmeldungen. Standard ist 1.
Kommandozeilenoption: --no-status
verbose=[0|1]
Falls gesetzt, gebe alle geprüften URLs einmal aus. Standard ist es, nur fehlerhafte URLs und Warnungen auszugeben.
Kommandozeilenoption: --verbose
warnings=[0|1]
Falls gesetzt, gebe keine Warnungen aus. Standard ist die Ausgabe von Warnungen.
Kommandozeilenoption: --no-warnings

[text]

filename=STRING
Gebe Dateiname für Textausgabe an. Standard Dateiname ist linkchecker-out.txt.
Kommandozeilenoption: --file-output=
parts=STRING
Kommagetrennte Liste von Teilen, die ausgegeben werden sollen. Siehe LOGGER PART weiter unten.
Kommandozeilenoption: keine
encoding=STRING
Gültige Enkodierungen sind aufgelistet unter http://docs.python.org/library/codecs.html#standard-encodings.
Die Standardenkodierung ist iso-8859-15.
color*
Farbwerte für die verschiedenen Ausgabeteile. Syntax ist color oder type;color. Der type kann bold, light, blink oder invert sein. Die color kann default, black, red, green, yellow, blue, purple, cyan, white, Black, Red, Green, Yellow, Blue, Purple, Cyan oder White sein.
Kommandozeilenoption: keine
colorparent=STRING
Setze Farbe des Vaters. Standard ist white.
colorurl=STRING
Setze URL Farbe. Standard ist default.
colorname=STRING
Kommandozeilenoption: --file-output=
colorreal=STRING
Setze Farbe für tatsächliche URL. Default ist cyan.
colorbase=STRING
Setzt Basisurl Farbe. Standard ist purple.
colorvalid=STRING
Setze gültige Farbe. Standard ist bold;green.
colorinvalid=STRING
Setze ungültige Farbe. Standard ist bold;red.
colorinfo=STRING
Setzt Informationsfarbe. Standard ist default.
colorwarning=STRING
Setze Warnfarbe. Standard ist bold;yellow.
colordltime=STRING
Setze Downloadzeitfarbe. Standard ist default.
colorreset=STRING
Setze Reset Farbe. Standard ist default.

[gml]

filename=STRING
Siehe [text] Sektion weiter oben.
parts=STRING
Siehe [text] Sektion weiter oben.
encoding=STRING
Siehe [text] Sektion weiter oben.

[dot]

filename=STRING
Siehe [text] Sektion weiter oben.
parts=STRING
Siehe [text] Sektion weiter oben.
encoding=STRING
Siehe [text] Sektion weiter oben.

[csv]

filename=STRING
Siehe [text] Sektion weiter oben.
parts=STRING
Siehe [text] Sektion weiter oben.
encoding=STRING
Siehe [text] Sektion weiter oben.
separator=CHAR
Das CSV Trennzeichen. Standard ist Komma (,).
quotechar=CHAR
Setze CSV Quotezeichen. Standard ist das doppelte Anführungszeichen (").

[sql]

filename=STRING
Siehe [text] Sektion weiter oben.
parts=STRING
Siehe [text] Sektion weiter oben.
encoding=STRING
Siehe [text] Sektion weiter oben.
dbname=STRING
Setze Datenbankname zum Speichern. Standard ist linksdb.
separator=CHAR
Setze SQL Kommandotrennzeichen. Standard ist ein Strichpunkt (;).

[html]

filename=STRING
Siehe [text] Sektion weiter oben.
parts=STRING
Siehe [text] Sektion weiter oben.
encoding=STRING
Siehe [text] Sektion weiter oben.
colorbackground=COLOR
Setze Reset Farbe. Standard ist default.
colorurl=
Setze HTML URL Farbe. Standard ist #dcd5cf.
colorborder=
Setze HTML Rahmenfarbe. Standard ist #000000.
colorlink=
Setze HTML Verknüpfungsfarbe. Standard ist #191c83.
colorwarning=
Setze HTML Warnfarbe. Standard ist #e0954e.
colorerror=
Setze HTML Fehlerfarbe. Standard ist #db4930.
colorok=
Setze HTML Gültigkeitsfarbe. Standard ist #3ba557.

[blacklist]

filename=STRING
Siehe [text] Sektion weiter oben.
encoding=STRING
Siehe [text] Sektion weiter oben.

[xml]

filename=STRING
Siehe [text] Sektion weiter oben.
parts=STRING
Siehe [text] Sektion weiter oben.
encoding=STRING
Siehe [text] Sektion weiter oben.

[gxml]

filename=STRING
Siehe [text] Sektion weiter oben.
parts=STRING
Siehe [text] Sektion weiter oben.
encoding=STRING
Siehe [text] Sektion weiter oben.

[sitemap]

filename=STRING
Siehe [text] Sektion weiter oben.
parts=STRING
Siehe [text] Sektion weiter oben.
encoding=STRING
Siehe [text] Sektion weiter oben.
priority=NUMMER
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.
frequency=[always|hourly|daily|weekly|monthly|yearly|never]
Die Häufigkeit mit der Seiten sich ändern.

AUSGABE PARTS


 all       (für alle Teile)
 id        (eine eindeutige ID für jeden Logeintrag)
 realurl   (die volle URL Verknüpfung)
 result    (gültig oder ungültig, mit Nachrichten)
 extern    (1 oder 0, nur in einigen Ausgabetypen protokolliert)
 base      (base href=...)
 name      (<a href=...>name</a> and <img alt="name">)
 parenturl (falls vorhanden)
 info      (einige zusätzliche Infos, z.B. FTP Willkommensnachrichten)
 warning   (Warnungen)
 dltime    (Downloadzeit)
 checktime (Prüfzeit)
 url       (Der Original URL Name, kann relativ sein)
 intro     (Das Zeug am Anfang, "Beginne am ...")
 outro     (Das Zeug am Ende, "X Fehler gefunden ...")

MULTILINE

Einige Optionen können mehrere Zeilen lang sein. Jede Zeile muss dafür eingerückt werden. Zeilen die mit einer Raute (#) beginnen werden ignoriert, müssen aber eingerückt sein.


 ignore=
   lconline
   bookmark
   # a comment   ^mailto:

BEISPIEL


 [output]
 log=html


 [checking]
 threads=5


 [filtering]
 ignorewarnings=http-moved-permanent

PLUGINS

All plugins have a separate section. If the section appears in the configuration file the plugin is enabled. Some plugins read extra options in their section.

[AnchorCheck]

Checks validity of HTML anchors.

[LocationInfo]

Adds the country and if possible city name of the URL host as info. Needs GeoIP or pygeoip and a local country or city lookup DB installed.

[RegexCheck]

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 message, for example 'This page has moved' or 'Oracle Application error'.

Man beachte, dass mehrere Werte in dem regulären Ausdruck kombiniert werden können, zum Beispiel "(Diese Seite ist umgezogen|Oracle Applikationsfehler)".

[SslCertificateCheck]

Check SSL certificate expiration date. Only internal https: links will be checked. A domain will only be checked once to avoid duplicate warnings.
sslcertwarndays=NUMBER
Configures the expiration warning time in days.

[HtmlSyntaxCheck]

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

[HttpHeaderInfo]

Print HTTP headers in URL info.
prefixes=prefix1[,prefix2]...
List of comma separated header prefixes. For example to display all HTTP headers that start with "X-".

[CssSyntaxCheck]

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

[VirusCheck]

Checks the page content for virus infections with clamav. A local clamav daemon must be installed.
clamavconf=Dateiname
Dateiname von clamd.conf Konfigurationsdatei.

[PdfParser]

Parse PDF files for URLs to check. Needs the pdfminer Python package installed.

[WordParser]

Parse Word files for URLs to check. Needs the pywin32 Python extension installed.

WARNUNGEN

Die folgenden Warnungen werden vom Konfigurationseintrag 'ignorewarnings' erkannt:
file-missing-slash
Der file: URL fehlt ein abschließender Schrägstrich.
file-system-path
Der file: Pfad ist nicht derselbe wie der Systempfad.
ftp-missing-slash
Der ftp: URL fehlt ein abschließender Schrägstrich.
http-cookie-store-error
Ein Fehler trat auf während des Speicherns eines Cookies.
http-empty-content
Die URL besitzt keinen Inhalt.
mail-no-mx-host
Der MX Mail-Rechner konnte nicht gefunden werden.
nntp-no-newsgroup
Die NNTP Nachrichtengruppe konnte nicht gefunden werden.
nntp-no-server
Es wurde kein NNTP Server gefunden.
url-content-size-zero
Der URL Inhaltsgrößenangabe ist Null.
url-content-too-large
Der URL Inhalt ist zu groß.
url-effective-url
Die effektive URL unterscheidet sich vom Original.
url-error-getting-content
Konnte den Inhalt der URL nicht bekommen.
url-obfuscated-ip
Die IP-Adresse ist verschleiert.
url-whitespace
Die URL %(url)s enthält Leerzeichen am Anfang oder Ende.

AUTHOR

Bastian Kleineidam <[email protected]>

COPYRIGHT

Copyright © 2000-2014 Bastian Kleineidam