LINKCHECKERRC(5)

NAME
linkcheckerrc - Konfigurationsdatei für LinkChecker

BESCHREIBUNG

linkcheckerrc is the configuration file for LinkChecker. The file is written in an INI-style format. The default file location is $XDG_CONFIG_HOME/linkchecker/linkcheckerrc or else ~/.config/linkchecker/linkcheckerrc on Unix, %HOMEPATH%\.config\linkchecker\linkcheckerrc on Windows systems.

EIGENSCHAFTEN

  checking

cookiefile=Dateiname
    Lese eine Datei mit Cookie-Daten. Das Cookie Datenformat wird in linkchecker(1) erklärt. Kommandozeilenoption: --cookiefile

debugmemory=[0|1]
    Write memory allocation statistics to a file on exit, requires meliae. The default is not to write the file. Command line option: none

localwebroot=STRING
    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

recursionlevel=NUMMER
    Prüfe rekursiv alle URLs bis zu der angegebenen Tiefe. Eine negative Tiefe bewirkt unendliche Rekursion. Standard Tiefe ist unendlich. Kommandozeilenoption: --recursion-level

threads=NUMMER
    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: --threads

timeout=NUMMER
    Setze den Timeout für TCP-Verbindungen in Sekunden. Der Standard Timeout ist 60 Sekunden. Kommandozeilenoption: --timeout

aborttimeout=NUMMER
    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. Command line option: none

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|filename]
    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

maxrunseconds=NUMMER
    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). Kommandozeilenoption: none

maxfilesizedownload=NUMBER
    Files larger than NUMBER bytes will be ignored, without downloading anything if accessed over http and an accurate Content-Length header was returned. No more than this amount of a file will be downloaded. The default is 5242880 (5 MB). Command line option: none

maxfilesizeparse=NUMBER
    Files larger than NUMBER bytes will not be parsed for links. The default is 1048576 (1 MB). Command line option: none

maxnumurls=NUMMER
    Maximale Anzahl von URLs die geprüft werden. Neue URLs werden nicht angenommen nachdem die angegebene Anzahl von URLs geprüft wurde. Kommandozeilenoption: none

maxrequestspersecond=NUMMER
    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 LinkChecker response header. The default is 10. Command line option: none

robotstxt=[0|1]
    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: --no-robots

allowedschemes=NAME[,NAME...]
    Allowed URL schemes as comma-separated list. Command line option: none

resultcachesize=NUMBER
    Set the result cache size. The default is 100 000 URLs. Command line option: none

  filtering

ignore=REGEX (MULTILINE)
    Prüfe lediglich die Syntax von URLs, welche dem angegebenen regulären Ausdruck entsprechen. Kommandozeilenoption: --ignore-url

ignorewarnings=NAME[,NAME...]
    Ignore the comma-separated list of warnings. See WARNINGS for the list of supported warnings. Messages are logged as information. Command line option: none

ignorewarningsforurls=URL_REGEX [NAME_REGEX] (MULTILINE)
    Specify regular expressions to ignore warnings for matching URLs, one per line. On each line, you can specify a second regular expression, ensuring that only the warnings with names matching the second expression will be ignored for that URL. If the second expression is omitted, all warnings are ignored for that URL.

    Default is to not ignore any warnings. See WARNINGS for the list of supported warnings. Messages are logged as information. Command line option: none

    Example:

    [filtering]
    ignorewarningsforurls=
      ^https://redirected\.example\.com ^http-redirected

internlinks=REGEX
    Regulärer Ausdruck, um mehr URLs als interne Verknüpfungen hinzuzufügen. Standard ist dass URLs der Kommandozeile als intern gelten. Kommandozeilenoption: none

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: --check-extern

  authentication

entry=REGEX BENUTZER [PASSWORT] (MULTILINE)
    Provide individual username/password pairs for different links. In addition to a single login page specified with loginurl multiple 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 commandline. If the regular expression matches the checked URL, the given username/password pair is used for authentication. The command line options -u and -p match every link and therefore override the entries given here. The first match wins. Command line option: -u, -p

loginurl=URL
    The URL of a login page to be visited before link checking. The page is expected to contain an HTML form to collect credentials and submit them to the address in its action attribute using an HTTP POST request. The name attributes of the input elements of the form and the values to be submitted need to be available (see entry for an explanation of username and password values).

loginuserfield=STRING
    Der Name für das Benutzer CGI-Feld. Der Standardname ist login.

loginpasswordfield=STRING
    Der Name für das Passwort CGI-Feld. Der Standardname ist password.

loginextrafields=NAME:WERT (MULTILINE)
    Optionally the name attributes of any additional input elements and the values to populate them with. Note that these are submitted without checking whether matching input elements exist in the HTML form.

  output

  URL checking results

fileoutput=TYPE[,TYPE...]
    Output to a file linkchecker-out.TYPE, or $XDG_DATA_HOME/linkchecker/failures for the failures output type. Valid file output types are text, html, sql, csv, gml, dot, xml, none or failures. Default is no file output. The various output types are documented below. Note that you can suppress all console output with output=none. Command line option: --file-output

log=TYPE[/ENCODING]
    Specify the console output type as text, html, sql, csv, gml, dot, xml, 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 https://docs.python.org/library/codecs.html#standard-encodings. Command line option: --output

verbose=[0|1]
    If set log all checked URLs once, overriding warnings. Default is to log only errors and warnings. Command line option: --verbose

warnings=[0|1]
    Falls gesetzt, gebe keine Warnungen aus. Standard ist die Ausgabe von Warnungen. Kommandozeilenoption: --verbose

ignoreerrors=URL_REGEX [MESSAGE_REGEX] (MULTILINE)
    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 filtering, this happens after checking, which allows checking URLs despite certain expected and tolerable errors. Default is to not ignore any errors. Example:

    [output]
    ignoreerrors=
      ^https://deprecated\.example\.com ^410 Gone
      # ignore all errors (no second expression), also for syntax check:
      ^mailto:.*@example\.com$

  Progress updates

status=[0|1]
    Control printing URL checker status messages. Default is 1. Command line option: --no-status

  Application

debug=STRING[,STRING...]
    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. Command line option: --debug

  Quiet

quiet=[0|1]
    If set, operate quiet. An alias for log=none that also hides application information messages. This is only useful with fileoutput, else no results will be output. Command line option: --quiet

AUSGABETYPEN

  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 PARTS weiter unten. Kommandozeilenoption: none

encoding=STRING
    Valid encodings are listed in https://docs.python.org/library/codecs.html#standard-encodings. Default encoding is the system default locale encoding.

wraplength=NUMBER
    The number of characters at which to wrap each message line. The default is 65. Command line option: none

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: none

colorparent=STRING
    Setze Farbe des Vaters. Standard ist white.

colorurl=STRING
    Setze URL Farbe. Standard ist default.

colorname=STRING
    Setze Namensfarbe. Standard ist default.

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
    Set CSV separator. Default is a semicolon (;).

quotechar=CHAR
    Setze CSV Quotezeichen. Standard ist das doppelte Anführungszeichen (").

dialect=STRING
    Controls the output formatting. See https://docs.python.org/3/library/csv.html#csv.Dialect. Default is excel.

  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 HTML Hintergrundfarbe. Standard ist #fff7e5.

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.

  failures

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]
    How frequently pages are changing. Default is daily.

AUSGABE PARTS

all for all parts

id  a unique ID for each logentry

realurl
    the full url link

result
    valid or invalid, with messages

extern
    1 or 0, only in some logger types reported

base
    base href=...

name
    <a href=...>name</a> and <img alt="name">

parenturl
    if any

info
    some additional info, e.g. FTP welcome messages

warning
    warnings

dltime
    download time

checktime
    check time

url the original url name, can be relative

intro
    the blurb at the beginning, "starting at ..."

outro
    the blurb at the end, "found x errors ..."

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. When checking local files, URLs with anchors that link to directories e.g. "example/#anchor" are not supported. There is no such limitation when using http(s).

  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

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.

warningregex=REGEX
    Use this to check for pages that contain some form of error message, for example "This page has moved" or "Oracle Application error". REGEX should be unquoted.

    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=NUMMER
    Configures the expiration warning time in days.

  HtmlSyntaxCheck

Check the syntax of HTML pages by submitting their URLs to the online W3C HTML validator. If a page URL is not accessible to the validator no check is performed and no warning given. See https://validator.w3.org/docs/api.html.

BEMERKUNG: The HtmlSyntaxCheck plugin is currently broken and is disabled.

  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 CSS stylesheets by submitting their URLs to the online W3C CSS validator. If a stylesheet URL is not accessible to the validator no check is performed and no warning given. See https://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.six Python package installed.

  WordParser

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

  MarkdownCheck

Parse Markdown files for URLs to check.

filename_re=REGEX
    Regular expression matching the names of Markdown files.

WARNUNGEN

The following warnings are recognized by ignorewarnings and ignorewarningsforurls:

file-anchorcheck-directory
    A local directory with an anchor, not supported by AnchorCheck.

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.

http-rate-limited
    Too many HTTP requests.

http-redirected
    Redirected to a different URL.

mail-no-mx-host
    Der MX Mail-Rechner konnte nicht gefunden werden.

url-content-size-zero
    Der URL Inhaltsgrößenangabe ist Null.

url-content-too-large
    Der URL Inhalt ist zu groß.

url-content-type-unparseable
    The URL content type is not parseable.

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.

SIEHE AUCH

linkchecker(1)

AUTHOR
Bastian Kleineidam <bastian.kleineidam@web.de>

COPYRIGHT
2000-2016 Bastian Kleineidam, 2010-2024 LinkChecker Authors