linkcheckerrc(5) File Formats Manual linkcheckerrc(5)
NAME
linkcheckerrc - configuration file for LinkChecker
DESCRIPTION
linkcheckerrc is the default configuration file LinkChecker. The file is written in an INI-style format.
SETTINGS
[checking]
threads=NUMBER
Generate no more than the given number of threads. Default number of threads is 10. To disable threading specify a non-positive num-
ber.
Command line option: --threads
timeout=NUMBER
Set the timeout for connection attempts in seconds. The default timeout is 60 seconds.
Command line option: --timeout
anchors=[0|1]
Check HTTP anchor references. Default is not to check anchors. This option enables logging of the warning url-anchor-not-found.
Command line option: --anchors
recursionlevel=NUMBER
Check recursively all links up to given depth. A negative depth will enable infinite recursion. Default depth is infinite.
Command line option: --recursion-level
warningregex==REGEX
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, for example "This page has moved" or "Oracle Application Server error".
Command line option: --warning-regex
warnsizebytes=NUMBER
Print a warning if content size info is available and exceeds the given number of bytes.
Command line option: --warning-size-bytes
nntpserver=STRING
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.
Command line option: --nntp-server
useragent=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
the current version of LinkChecker.
Command line option: --user-agent
checkhtml=[0|1]
Check syntax of HTML URLs with the HTML tidy library, falling back to the W3C online validator if HTML tidy is not available..
Command line option: --check-html
checkcss=[0|1]
Check syntax of CSS URLs with the cssutils library, falling back to the W3C online validator if cssutils is not available.
Command line option: --check-css
scanvirus=[0|1]
Scan content of URLs for viruses with ClamAV.
Command line option: --scan-virus
clamavconf=filename
Filename of clamd.conf config file.
Command line option: none
cookies=[0|1]
Accept and send HTTP cookies.
Command line option: --cookies
cookiefile=filename
Read a file with initial cookie data. The cookie data format is explained in linkchecker(1).
Command line option: --cookiefile
pause=NUMBER
Pause the given number of seconds between two subsequent connection requests to the same host.
Command line option: --pause
debugmemory=[0|1]
When checking finishes, write a memory dump to a temporary file. The memory dump is written both when checking finishes normally
and when checking gets canceled.
The memory dump only works if the python-meliae package is installed. Otherwise a warning is printed to install it.
Command line option: none
localwebroot=STRING
When checking absolute URLs inside local files, the given root directory is used as base URL.
Note that the given directory must have URL syntax, so it must use a slash to join directories instead of a backslash. And the
given directory must end with a slash.
Command line option: none
[filtering]
ignore=REGEX (MULTILINE)
Only check syntax of URLs matching the given regular expressions.
Command line option: --ignore-url
nofollow=REGEX (MULTILINE)
Check but do not recurse into URLs matching the given regular expressions.
Command line option: --no-follow-url
ignorewarnings=NAME[,NAME...]
Ignore the comma-separated list of warnings. See WARNIGS for the list of supported warnings.
Command line option: none
internlinks=REGEX
Regular expression to add more URLs recognized as internal links. Default is that URLs given on the command line are internal.
Command line option: none
[authentication]
entry=REGEX USER [PASS] (MULTILINE)
Provide different user/password pairs for different link types. 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 user/password pair is used for authentication. The commandline options
-u and -p match every link and therefore override the entries given here. The first match wins. At the moment, authentication is
used/needed for http[s] and ftp links.
Command line option: -u, -p
loginurl=URL
A login URL to be visited before checking. Also needs authentication data set for it, and implies using cookies because most logins
use cookies nowadays.
loginuserfield=STRING
The name of the user CGI field. Default name is login.
loginpasswordfield=STRING
The name of the password CGI field. Default name is password.
loginextrafields=NAME:VALUE (MULTILINE)
Optionally any additional CGI name/value pairs. Note that the default values are submitted automatically.
[output]
debug=STRING[,STRING...]
Print debugging output for the given loggers. Available loggers are cmdline, checking, cache, gui, dns, thread and all. Specifying
all is an alias for specifying all available loggers.
Command line option: --debug
status=[0|1]
Control printing check status messages. Default is 1.
Command line option: --no-status
log=TYPE[/ENCODING]
Specify output type as text, html, sql, csv, gml, dot, xml, none or blacklist. 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
http://docs.python.org/library/codecs.html#standard-encodings.
Command line option: --output
verbose=[0|1]
If set log all checked URLs once. Default is to log only errors and warnings.
Command line option: --verbose
complete=[0|1]
If set log all checked URLs, even duplicates. Default is to log duplicate URLs only once.
Command line option: --complete
warnings=[0|1]
If set log warnings. Default is to log warnings.
Command line option: --no-warnings
quiet=[0|1]
If set, operate quiet. An alias for log=none. This is only useful with fileoutput.
Command line option: --verbose
fileoutput=TYPE[,TYPE...]
Output to a files linkchecker-out.TYPE, $HOME/.linkchecker/blacklist for blacklist output.
Valid file output types are text, html, sql, csv, gml, dot, xml, none or blacklist 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
[text]
filename=STRING
Specify output filename for text logging. Default filename is linkchecker-out.txt.
Command line option: --file-output=
parts=STRING
Comma-separated list of parts that have to be logged. See LOGGER PARTS below.
Command line option: none
encoding=STRING
Valid encodings are listed in http://docs.python.org/library/codecs.html#standard-encodings.
Default encoding is iso-8859-15.
color* Color settings for the various log parts, syntax is color or type;color. The type can be bold, light, blink, invert. The color can
be default, black, red, green, yellow, blue, purple, cyan, white, Black, Red, Green, Yellow, Blue, Purple, Cyan or White.
Command line option: none
colorparent=STRING
Set parent color. Default is white.
colorurl=STRING
Set URL color. Default is default.
colorname=STRING
Set name color. Default is default.
colorreal=STRING
Set real URL color. Default is cyan.
colorbase=STRING
Set base URL color. Default is purple.
colorvalid=STRING
Set valid color. Default is bold;green.
colorinvalid=STRING
Set invalid color. Default is bold;red.
colorinfo=STRING
Set info color. Default is default.
colorwarning=STRING
Set warning color. Default is bold;yellow.
colordltime=STRING
Set download time color. Default is default.
colorreset=STRING
Set reset color. Default is deault.
[gml]
filename=STRING
See [text] section above.
parts=STRING
See [text] section above.
encoding=STRING
See [text] section above.
[dot]
filename=STRING
See [text] section above.
parts=STRING
See [text] section above.
encoding=STRING
See [text] section above.
[csv]
filename=STRING
See [text] section above.
parts=STRING
See [text] section above.
encoding=STRING
See [text] section above.
separator=CHAR
Set CSV separator. Default is a comma (,).
quotechar=CHAR
Set CSV quote character. Default is a double quote (").
[sql]
filename=STRING
See [text] section above.
parts=STRING
See [text] section above.
encoding=STRING
See [text] section above.
dbname=STRING
Set database name to store into. Default is linksdb.
separator=CHAR
Set SQL command separator character. Default is a semicolor (;).
[html]
filename=STRING
See [text] section above.
parts=STRING
See [text] section above.
encoding=STRING
See [text] section above.
colorbackground=COLOR
Set HTML background color. Default is #fff7e5.
colorurl=
Set HTML URL color. Default is #dcd5cf.
colorborder=
Set HTML border color. Default is #000000.
colorlink=
Set HTML link color. Default is #191c83.
colorwarning=
Set HTML warning color. Default is #e0954e.
colorerror=
Set HTML error color. Default is #db4930.
colorok=
Set HTML valid color. Default is #3ba557.
[blacklist]
filename=STRING
See [text] section above.
encoding=STRING
See [text] section above.
[xml]
filename=STRING
See [text] section above.
parts=STRING
See [text] section above.
encoding=STRING
See [text] section above.
[gxml]
filename=STRING
See [text] section above.
parts=STRING
See [text] section above.
encoding=STRING
See [text] section above.
LOGGER 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
Some option values can span multiple lines. Each line has to be indented for that to work. Lines starting with a hash (#) will be ignored,
though they must still be indented.
ignore=
lconline
bookmark
# a comment
^mailto:
EXAMPLE
[output]
log=html
[checking]
threads=5
[filtering]
ignorewarnings=http-moved-permanent
WARNINGS
The following warnings are recognized in the 'ignorewarnings' config file entry:
file-missing-slash
The file: URL is missing a trailing slash.
file-system-path
The file: path is not the same as the system specific path.
ftp-missing-slash
The ftp: URL is missing a trailing slash.
http-auth-unknonwn
Unsupported HTTP authentication method.
http-cookie-store-error
An error occurred while storing a cookie.
http-decompress-error
An error occurred while decompressing the URL content.
http-empty-content
The URL had no content.
http-moved-permanent
The URL has moved permanently.
http-robots-denied
The http: URL checking has been denied.
http-unsupported-encoding
The URL content is encoded with an unknown encoding.
http-wrong-redirect
The URL has been redirected to an URL of a different type.
ignore-url
The URL has been ignored.
mail-no-connection
No connection to a MX host could be established.
mail-no-mx-host
The mail MX host could not be found.
mail-unverified-address
The mailto: address could not be verified.
nntp-no-newsgroup
The NNTP newsgroup could not be found.
nntp-no-server
No NNTP server was found.
url-anchor-not-found
URL anchor was not found.
url-content-size-unequal
The URL content size and download size are unequal.
url-content-size-zero
The URL content size is zero.
url-content-too-large
The URL content size is too large.
url-effective-url
The effective URL is different from the original.
url-error-getting-content
Could not get the content of the URL.
url-obfuscated-ip
The IP is obfuscated.
url-warnregex-found
The warning regular expression was found in the URL contents.
url-whitespace
The URL contains leading or trailing whitespace.
SEE ALSO
linkchecker(1)
AUTHOR
Bastian Kleineidam <calvin@users.sourceforge.net>
COPYRIGHT
Copyright (C) 2000-2012 Bastian Kleineidam
LinkChecker 2007-11-30 linkcheckerrc(5)