mirror of
https://github.com/Hopiu/linkchecker.git
synced 2026-05-19 03:51:07 +00:00
647 lines
25 KiB
HTML
647 lines
25 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8"/>
|
|
<style>
|
|
table.head, table.foot { width: 100%; }
|
|
td.head-rtitle, td.foot-os { text-align: right; }
|
|
td.head-vol { text-align: center; }
|
|
div.Pp { margin: 1ex 0ex; }
|
|
div.Nd, div.Bf, div.Op { display: inline; }
|
|
span.Pa, span.Ad { font-style: italic; }
|
|
span.Ms { font-weight: bold; }
|
|
dl.Bl-diag > dt { font-weight: bold; }
|
|
code.Nm, code.Fl, code.Cm, code.Ic, code.In, code.Fd, code.Fn,
|
|
code.Cd { font-weight: bold; font-family: inherit; }
|
|
</style>
|
|
<title>LINKCHECKERRC(5)</title>
|
|
</head>
|
|
<body>
|
|
<table class="head">
|
|
<tr>
|
|
<td class="head-ltitle">LINKCHECKERRC(5)</td>
|
|
<td class="head-vol">LinkChecker User Manual</td>
|
|
<td class="head-rtitle">LINKCHECKERRC(5)</td>
|
|
</tr>
|
|
</table>
|
|
<div class="manual-text">
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
|
|
linkcheckerrc - configuration file for LinkChecker
|
|
</section>
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
|
|
<b>linkcheckerrc</b> is the configuration file for LinkChecker. The file is
|
|
written in an INI-style format.
|
|
<br/>
|
|
The default file location is <b>~/.linkchecker/linkcheckerrc</b> on Unix,
|
|
<b>%HOMEPATH%\.linkchecker\linkcheckerrc</b> on Windows systems.
|
|
</section>
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="SETTINGS"><a class="permalink" href="#SETTINGS">SETTINGS</a></h1>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_checking__fP"><a class="permalink" href="#_fB_checking__fP"><b>[checking]</b></a></h2>
|
|
<dl class="Bl-tag">
|
|
<dt><b>cookiefile=</b><i>filename</i></dt>
|
|
<dd>Read a file with initial cookie data. The cookie data format is explained
|
|
in <a href="../man1/linkchecker.1.html" class="Xr">linkchecker(1)</a>.
|
|
<br/>
|
|
Command line option: <b>--cookiefile</b></dd>
|
|
<dt><b>localwebroot=</b><i>STRING</i></dt>
|
|
<dd>When checking absolute URLs inside local files, the given root directory
|
|
is used as base URL.
|
|
<br/>
|
|
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.
|
|
<br/>
|
|
Command line option: none</dd>
|
|
<dt><b>nntpserver=</b><i>STRING</i></dt>
|
|
<dd>Specify an NNTP server for <b>news:</b> links. Default is the environment
|
|
variable <b>NNTP_SERVER</b>. If no host is given, only the syntax of the
|
|
link is checked.
|
|
<br/>
|
|
Command line option: <b>--nntp-server</b></dd>
|
|
<dt><b>recursionlevel=</b><i>NUMBER</i></dt>
|
|
<dd>Check recursively all links up to given depth. A negative depth will
|
|
enable infinite recursion. Default depth is infinite.
|
|
<br/>
|
|
Command line option: <b>--recursion-level</b></dd>
|
|
<dt><b>threads=</b><i>NUMBER</i></dt>
|
|
<dd>Generate no more than the given number of threads. Default number of
|
|
threads is 10. To disable threading specify a non-positive number.
|
|
<br/>
|
|
Command line option: <b>--threads</b></dd>
|
|
<dt><b>timeout=</b><i>NUMBER</i></dt>
|
|
<dd>Set the timeout for connection attempts in seconds. The default timeout is
|
|
60 seconds.
|
|
<br/>
|
|
Command line option: <b>--timeout</b></dd>
|
|
<dt><b>aborttimeout=</b><i>NUMBER</i></dt>
|
|
<dd>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.
|
|
<br/>
|
|
Command line option: <b>--timeout</b></dd>
|
|
<dt><b>useragent=</b><i>STRING</i></dt>
|
|
<dd>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.
|
|
<br/>
|
|
Command line option: <b>--user-agent</b></dd>
|
|
<dt><b>sslverify=</b>[<b>0</b>|<b>1</b>|<i>filename</i>]</dt>
|
|
<dd>If set to zero disables SSL certificate checking. If set to one (the
|
|
default) enables SSL certificate checking with the provided CA certificate
|
|
file. If a filename is specified, it will be used as the certificate file.
|
|
<br/>
|
|
Command line option: none</dd>
|
|
<dt><b>maxrunseconds=</b><i>NUMBER</i></dt>
|
|
<dd>Stop checking new URLs after the given number of seconds. Same as if the
|
|
user stops (by hitting Ctrl-C) after the given number of seconds.
|
|
<br/>
|
|
The default is not to stop until all URLs are checked.
|
|
<br/>
|
|
Command line option: none</dd>
|
|
<dt><b>maxnumurls=</b><i>NUMBER</i></dt>
|
|
<dd>Maximum number of URLs to check. New URLs will not be queued after the
|
|
given number of URLs is checked.
|
|
<br/>
|
|
The default is to queue and check all URLs.
|
|
<br/>
|
|
Command line option: none</dd>
|
|
<dt><b>maxrequestspersecond=</b><i>NUMBER</i></dt>
|
|
<dd>Limit the maximum number of requests per second to one host.</dd>
|
|
<dt><b>allowedschemes=</b><i>NAME</i>[<b>,</b><i>NAME</i>...]</dt>
|
|
<dd>Allowed URL schemes as comma-separated list.</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_filtering__fP"><a class="permalink" href="#_fB_filtering__fP"><b>[filtering]</b></a></h2>
|
|
<dl class="Bl-tag">
|
|
<dt><b>ignore=</b><i>REGEX</i> (MULTILINE)</dt>
|
|
<dd>Only check syntax of URLs matching the given regular expressions.
|
|
<br/>
|
|
Command line option: <b>--ignore-url</b></dd>
|
|
<dt><b>ignorewarnings=</b><i>NAME</i>[<b>,</b><i>NAME</i>...]</dt>
|
|
<dd>Ignore the comma-separated list of warnings. See <b>WARNINGS</b> for the
|
|
list of supported warnings.
|
|
<br/>
|
|
Command line option: none</dd>
|
|
<dt><b>internlinks=</b><i>REGEX</i></dt>
|
|
<dd>Regular expression to add more URLs recognized as internal links. Default
|
|
is that URLs given on the command line are internal.
|
|
<br/>
|
|
Command line option: none</dd>
|
|
<dt><b>nofollow=</b><i>REGEX</i> (MULTILINE)</dt>
|
|
<dd>Check but do not recurse into URLs matching the given regular expressions.
|
|
<br/>
|
|
Command line option: <b>--no-follow-url</b></dd>
|
|
<dt><b>checkextern=</b>[<b>0</b>|<b>1</b>]</dt>
|
|
<dd>Check external links. Default is to check internal links only.
|
|
<br/>
|
|
Command line option: <b>--checkextern</b></dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_authentication__fP"><a class="permalink" href="#_fB_authentication__fP"><b>[authentication]</b></a></h2>
|
|
<dl class="Bl-tag">
|
|
<dt><b>entry=</b><i>REGEX</i> <i>USER</i> [<i>PASS</i>] (MULTILINE)</dt>
|
|
<dd>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.
|
|
<br/>
|
|
The password is optional and if missing it has to be entered at the
|
|
commandline.
|
|
<br/>
|
|
If the regular expression matches the checked URL, the given user/password
|
|
pair is used for authentication. The commandline options <b>-u</b> and
|
|
<b>-p</b> 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.
|
|
<br/>
|
|
Command line option: <b>-u</b>, <b>-p</b></dd>
|
|
<dt><b>loginurl=</b><i>URL</i></dt>
|
|
<dd>A login URL to be visited before checking. Also needs authentication data
|
|
set for it.</dd>
|
|
<dt><b>loginuserfield=</b><i>STRING</i></dt>
|
|
<dd>The name of the user CGI field. Default name is <b>login</b>.</dd>
|
|
<dt><b>loginpasswordfield=</b><i>STRING</i></dt>
|
|
<dd>The name of the password CGI field. Default name is <b>password</b>.</dd>
|
|
<dt><b>loginextrafields=</b><i>NAME</i><b>:</b><i>VALUE</i> (MULTILINE)</dt>
|
|
<dd>Optionally any additional CGI name/value pairs. Note that the default
|
|
values are submitted automatically.</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_output__fP"><a class="permalink" href="#_fB_output__fP"><b>[output]</b></a></h2>
|
|
<dl class="Bl-tag">
|
|
<dt><b>debug=</b><i>STRING</i>[<b>,</b><i>STRING</i>...]</dt>
|
|
<dd>Print debugging output for the given modules. Available debug modules are
|
|
<b>cmdline</b>, <b>checking</b>, <b>cache</b>, <b>dns</b>, <b>thread</b>,
|
|
<b>plugins</b> and <b>all</b>. Specifying <b>all</b> is an alias for
|
|
specifying all available loggers.
|
|
<br/>
|
|
Command line option: <b>--debug</b></dd>
|
|
<dt><b>fileoutput=</b><i>TYPE</i>[<b>,</b><i>TYPE</i>...]</dt>
|
|
<dd>Output to a files <b>linkchecker-out.</b><i>TYPE</i>,
|
|
<b>$HOME/.linkchecker/blacklist</b> for <b>blacklist</b> output.
|
|
<br/>
|
|
Valid file output types are <b>text</b>, <b>html</b>, <b>sql</b>,
|
|
<b>csv</b>, <b>gml</b>, <b>dot</b>, <b>xml</b>, <b>none</b> or
|
|
<b>blacklist</b> Default is no file output. The various output types are
|
|
documented below. Note that you can suppress all console output with
|
|
<b>output=none</b>.
|
|
<br/>
|
|
Command line option: <b>--file-output</b></dd>
|
|
<dt><b>log=</b><i>TYPE</i>[<b>/</b><i>ENCODING</i>]</dt>
|
|
<dd>Specify output type as <b>text</b>, <b>html</b>, <b>sql</b>, <b>csv</b>,
|
|
<b>gml</b>, <b>dot</b>, <b>xml</b>, <b>none</b> or <b>blacklist</b>.
|
|
Default type is <b>text</b>. The various output types are documented
|
|
below.
|
|
<br/>
|
|
The <i>ENCODING</i> specifies the output encoding, the default is that of
|
|
your locale. Valid encodings are listed at
|
|
<a class="Lk" href="https://docs.python.org/library/codecs.html#standard-encodings">https://docs.python.org/library/codecs.html#standard-encodings</a>.
|
|
<br/>
|
|
Command line option: <b>--output</b></dd>
|
|
<dt><b>quiet=</b>[<b>0</b>|<b>1</b>]</dt>
|
|
<dd>If set, operate quiet. An alias for <b>log=none</b>. This is only useful
|
|
with <b>fileoutput</b>.
|
|
<br/>
|
|
Command line option: <b>--verbose</b></dd>
|
|
<dt><b>status=</b>[<b>0</b>|<b>1</b>]</dt>
|
|
<dd>Control printing check status messages. Default is 1.
|
|
<br/>
|
|
Command line option: <b>--no-status</b></dd>
|
|
<dt><b>verbose=</b>[<b>0</b>|<b>1</b>]</dt>
|
|
<dd>If set log all checked URLs once. Default is to log only errors and
|
|
warnings.
|
|
<br/>
|
|
Command line option: <b>--verbose</b></dd>
|
|
<dt><b>warnings=</b>[<b>0</b>|<b>1</b>]</dt>
|
|
<dd>If set log warnings. Default is to log warnings.
|
|
<br/>
|
|
Command line option: <b>--no-warnings</b></dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_text__fP"><a class="permalink" href="#_fB_text__fP"><b>[text]</b></a></h2>
|
|
<dl class="Bl-tag">
|
|
<dt><b>filename=</b><i>STRING</i></dt>
|
|
<dd>Specify output filename for text logging. Default filename is
|
|
<b>linkchecker-out.txt</b>.
|
|
<br/>
|
|
Command line option: <b>--file-output=</b></dd>
|
|
<dt><b>parts=</b><i>STRING</i></dt>
|
|
<dd>Comma-separated list of parts that have to be logged. See <b>LOGGER
|
|
PARTS</b> below.
|
|
<br/>
|
|
Command line option: none</dd>
|
|
<dt><b>encoding=</b><i>STRING</i></dt>
|
|
<dd>Valid encodings are listed in
|
|
<a class="Lk" href="https://docs.python.org/library/codecs.html#standard-encodings">https://docs.python.org/library/codecs.html#standard-encodings</a>.
|
|
<br/>
|
|
Default encoding is <b>iso-8859-15</b>.</dd>
|
|
<dt><i>color*</i></dt>
|
|
<dd>Color settings for the various log parts, syntax is <i>color</i> or
|
|
<i>type</i><b>;</b><i>color</i>. The <i>type</i> can be <b>bold</b>,
|
|
<b>light</b>, <b>blink</b>, <b>invert</b>. The <i>color</i> can be
|
|
<b>default</b>, <b>black</b>, <b>red</b>, <b>green</b>, <b>yellow</b>,
|
|
<b>blue</b>, <b>purple</b>, <b>cyan</b>, <b>white</b>, <b>Black</b>,
|
|
<b>Red</b>, <b>Green</b>, <b>Yellow</b>, <b>Blue</b>, <b>Purple</b>,
|
|
<b>Cyan</b> or <b>White</b>.
|
|
<br/>
|
|
Command line option: none</dd>
|
|
<dt><b>colorparent=</b><i>STRING</i></dt>
|
|
<dd>Set parent color. Default is <b>white</b>.</dd>
|
|
<dt><b>colorurl=</b><i>STRING</i></dt>
|
|
<dd>Set URL color. Default is <b>default</b>.</dd>
|
|
<dt><b>colorname=</b><i>STRING</i></dt>
|
|
<dd>Set name color. Default is <b>default</b>.</dd>
|
|
<dt><b>colorreal=</b><i>STRING</i></dt>
|
|
<dd>Set real URL color. Default is <b>cyan</b>.</dd>
|
|
<dt><b>colorbase=</b><i>STRING</i></dt>
|
|
<dd>Set base URL color. Default is <b>purple</b>.</dd>
|
|
<dt><b>colorvalid=</b><i>STRING</i></dt>
|
|
<dd>Set valid color. Default is <b>bold;green</b>.</dd>
|
|
<dt><b>colorinvalid=</b><i>STRING</i></dt>
|
|
<dd>Set invalid color. Default is <b>bold;red</b>.</dd>
|
|
<dt><b>colorinfo=</b><i>STRING</i></dt>
|
|
<dd>Set info color. Default is <b>default</b>.</dd>
|
|
<dt><b>colorwarning=</b><i>STRING</i></dt>
|
|
<dd>Set warning color. Default is <b>bold;yellow</b>.</dd>
|
|
<dt><b>colordltime=</b><i>STRING</i></dt>
|
|
<dd>Set download time color. Default is <b>default</b>.</dd>
|
|
<dt><b>colorreset=</b><i>STRING</i></dt>
|
|
<dd>Set reset color. Default is <b>default</b>.</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_gml__fP"><a class="permalink" href="#_fB_gml__fP"><b>[gml]</b></a></h2>
|
|
<dl class="Bl-tag">
|
|
<dt><b>filename=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>parts=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>encoding=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_dot__fP"><a class="permalink" href="#_fB_dot__fP"><b>[dot]</b></a></h2>
|
|
<dl class="Bl-tag">
|
|
<dt><b>filename=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>parts=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>encoding=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_csv__fP"><a class="permalink" href="#_fB_csv__fP"><b>[csv]</b></a></h2>
|
|
<dl class="Bl-tag">
|
|
<dt><b>filename=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>parts=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>encoding=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>separator=</b><i>CHAR</i></dt>
|
|
<dd>Set CSV separator. Default is a comma (<b>,</b>).</dd>
|
|
<dt><b>quotechar=</b><i>CHAR</i></dt>
|
|
<dd>Set CSV quote character. Default is a double quote (<b>"</b>).</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_sql__fP"><a class="permalink" href="#_fB_sql__fP"><b>[sql]</b></a></h2>
|
|
<dl class="Bl-tag">
|
|
<dt><b>filename=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>parts=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>encoding=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>dbname=</b><i>STRING</i></dt>
|
|
<dd>Set database name to store into. Default is <b>linksdb</b>.</dd>
|
|
<dt><b>separator=</b><i>CHAR</i></dt>
|
|
<dd>Set SQL command separator character. Default is a semicolon
|
|
(<b>;</b>).</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_html__fP"><a class="permalink" href="#_fB_html__fP"><b>[html]</b></a></h2>
|
|
<dl class="Bl-tag">
|
|
<dt><b>filename=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>parts=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>encoding=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>colorbackground=</b><i>COLOR</i></dt>
|
|
<dd>Set HTML background color. Default is <b>#fff7e5</b>.</dd>
|
|
<dt><b>colorurl=</b></dt>
|
|
<dd>Set HTML URL color. Default is <b>#dcd5cf</b>.</dd>
|
|
<dt><b>colorborder=</b></dt>
|
|
<dd>Set HTML border color. Default is <b>#000000</b>.</dd>
|
|
<dt><b>colorlink=</b></dt>
|
|
<dd>Set HTML link color. Default is <b>#191c83</b>.</dd>
|
|
<dt><b>colorwarning=</b></dt>
|
|
<dd>Set HTML warning color. Default is <b>#e0954e</b>.</dd>
|
|
<dt><b>colorerror=</b></dt>
|
|
<dd>Set HTML error color. Default is <b>#db4930</b>.</dd>
|
|
<dt><b>colorok=</b></dt>
|
|
<dd>Set HTML valid color. Default is <b>#3ba557</b>.</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_blacklist__fP"><a class="permalink" href="#_fB_blacklist__fP"><b>[blacklist]</b></a></h2>
|
|
<dl class="Bl-tag">
|
|
<dt><b>filename=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>encoding=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_xml__fP"><a class="permalink" href="#_fB_xml__fP"><b>[xml]</b></a></h2>
|
|
<dl class="Bl-tag">
|
|
<dt><b>filename=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>parts=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>encoding=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_gxml__fP"><a class="permalink" href="#_fB_gxml__fP"><b>[gxml]</b></a></h2>
|
|
<dl class="Bl-tag">
|
|
<dt><b>filename=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>parts=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>encoding=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_sitemap__fP"><a class="permalink" href="#_fB_sitemap__fP"><b>[sitemap]</b></a></h2>
|
|
<dl class="Bl-tag">
|
|
<dt><b>filename=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>parts=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>encoding=</b><i>STRING</i></dt>
|
|
<dd>See [text] section above.</dd>
|
|
<dt><b>priority=</b><i>FLOAT</i></dt>
|
|
<dd>A number between 0.0 and 1.0 determining the priority. The default
|
|
priority for the first URL is 1.0, for all child URLs 0.5.</dd>
|
|
<dt><b>frequency=</b>[<b>always</b>|<b>hourly</b>|<b>daily</b>|<b>weekly</b>|<b>monthly</b>|<b>yearly</b>|<b>never</b>]</dt>
|
|
<dd>How frequently pages are changing.</dd>
|
|
</dl>
|
|
</section>
|
|
</section>
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="LOGGER_PARTS"><a class="permalink" href="#LOGGER_PARTS">LOGGER
|
|
PARTS</a></h1>
|
|
<table class="tbl">
|
|
<tr>
|
|
<td><b>all</b></td>
|
|
<td>(for all parts)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>id</b></td>
|
|
<td>(a unique ID for each logentry)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>realurl</b></td>
|
|
<td>(the full url link)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>result</b></td>
|
|
<td>(valid or invalid, with messages)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>extern</b></td>
|
|
<td>(1 or 0, only in some logger types reported)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>base</b></td>
|
|
<td>(base href=...)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>name</b></td>
|
|
<td>(<a href=...>name</a> and <img
|
|
alt="name">)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>parenturl</b></td>
|
|
<td>(if any)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>info</b></td>
|
|
<td>(some additional info, e.g. FTP welcome messages)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>warning</b></td>
|
|
<td>(warnings)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>dltime</b></td>
|
|
<td>(download time)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>checktime</b></td>
|
|
<td>(check time)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>url</b></td>
|
|
<td>(the original url name, can be relative)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>intro</b></td>
|
|
<td>(the blurb at the beginning, "starting at ...")</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>outro</b></td>
|
|
<td>(the blurb at the end, "found x errors ...")</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="MULTILINE"><a class="permalink" href="#MULTILINE">MULTILINE</a></h1>
|
|
Some option values can span multiple lines. Each line has to be indented for
|
|
that to work. Lines starting with a hash (<b>#</b>) will be ignored, though
|
|
they must still be indented.
|
|
<pre>
|
|
ignore=
|
|
lconline
|
|
bookmark
|
|
# a comment
|
|
^mailto:
|
|
</pre>
|
|
</section>
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="EXAMPLE"><a class="permalink" href="#EXAMPLE">EXAMPLE</a></h1>
|
|
<pre>
|
|
[output]
|
|
log=html
|
|
</pre>
|
|
<pre>
|
|
[checking]
|
|
threads=5
|
|
</pre>
|
|
<pre>
|
|
[filtering]
|
|
ignorewarnings=http-moved-permanent
|
|
</pre>
|
|
</section>
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="PLUGINS"><a class="permalink" href="#PLUGINS">PLUGINS</a></h1>
|
|
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.
|
|
<p class="Pp"></p>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_AnchorCheck__fP"><a class="permalink" href="#_fB_AnchorCheck__fP"><b>[AnchorCheck]</b></a></h2>
|
|
Checks validity of HTML anchors.
|
|
<p class="Pp"></p>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_LocationInfo__fP"><a class="permalink" href="#_fB_LocationInfo__fP"><b>[LocationInfo]</b></a></h2>
|
|
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.
|
|
<p class="Pp"></p>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_RegexCheck__fP"><a class="permalink" href="#_fB_RegexCheck__fP"><b>[RegexCheck]</b></a></h2>
|
|
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.
|
|
<dl class="Bl-tag">
|
|
<dt><b>warningregex=</b><i>REGEX</i></dt>
|
|
<dd>Use this to check for pages that contain some form of error message, for
|
|
example "This page has moved" or "Oracle Application
|
|
error". <i>REGEX</i> should be unquoted.
|
|
<p class="Pp">Note that multiple values can be combined in the regular
|
|
expression, for example "(This page has moved|Oracle Application
|
|
error)".</p>
|
|
<p class="Pp"></p>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_SslCertificateCheck__fP"><a class="permalink" href="#_fB_SslCertificateCheck__fP"><b>[SslCertificateCheck]</b></a></h2>
|
|
Check SSL certificate expiration date. Only internal https: links will be
|
|
checked. A domain will only be checked once to avoid duplicate warnings.
|
|
<dl class="Bl-tag">
|
|
<dt><b>sslcertwarndays=</b><i>NUMBER</i></dt>
|
|
<dd>Configures the expiration warning time in days.
|
|
<p class="Pp"></p>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_HtmlSyntaxCheck__fP"><a class="permalink" href="#_fB_HtmlSyntaxCheck__fP"><b>[HtmlSyntaxCheck]</b></a></h2>
|
|
Check the syntax of HTML pages with the online W3C HTML validator. See
|
|
<a class="Lk" href="https://validator.w3.org/docs/api.html">https://validator.w3.org/docs/api.html</a>.
|
|
<p class="Pp"></p>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_HttpHeaderInfo__fP"><a class="permalink" href="#_fB_HttpHeaderInfo__fP"><b>[HttpHeaderInfo]</b></a></h2>
|
|
Print HTTP headers in URL info.
|
|
<dl class="Bl-tag">
|
|
<dt><b>prefixes=</b><i>prefix1</i>[,<i>prefix2</i>]...</dt>
|
|
<dd>List of comma separated header prefixes. For example to display all HTTP
|
|
headers that start with "X-".
|
|
<p class="Pp"></p>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_CssSyntaxCheck__fP"><a class="permalink" href="#_fB_CssSyntaxCheck__fP"><b>[CssSyntaxCheck]</b></a></h2>
|
|
Check the syntax of HTML pages with the online W3C CSS validator. See
|
|
<a class="Lk" href="https://jigsaw.w3.org/css-validator/manual.html#expert">https://jigsaw.w3.org/css-validator/manual.html#expert</a>.
|
|
<p class="Pp"></p>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_VirusCheck__fP"><a class="permalink" href="#_fB_VirusCheck__fP"><b>[VirusCheck]</b></a></h2>
|
|
Checks the page content for virus infections with clamav. A local clamav daemon
|
|
must be installed.
|
|
<dl class="Bl-tag">
|
|
<dt><b>clamavconf=</b><i>filename</i></dt>
|
|
<dd>Filename of <b>clamd.conf</b> config file.</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_PdfParser__fP"><a class="permalink" href="#_fB_PdfParser__fP"><b>[PdfParser]</b></a></h2>
|
|
Parse PDF files for URLs to check. Needs the <b>pdfminer</b> Python package
|
|
installed.
|
|
<p class="Pp"></p>
|
|
</section>
|
|
<section class="Ss">
|
|
<h2 class="Ss" id="_fB_WordParser__fP"><a class="permalink" href="#_fB_WordParser__fP"><b>[WordParser]</b></a></h2>
|
|
Parse Word files for URLs to check. Needs the <b>pywin32</b> Python extension
|
|
installed.
|
|
<p class="Pp"></p>
|
|
</section>
|
|
</section>
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="WARNINGS"><a class="permalink" href="#WARNINGS">WARNINGS</a></h1>
|
|
The following warnings are recognized in the 'ignorewarnings' config file entry:
|
|
<br/>
|
|
<dl class="Bl-tag">
|
|
<dt><b>file-missing-slash</b></dt>
|
|
<dd>The file: URL is missing a trailing slash.</dd>
|
|
<dt><b>file-system-path</b></dt>
|
|
<dd>The file: path is not the same as the system specific path.</dd>
|
|
<dt><b>ftp-missing-slash</b></dt>
|
|
<dd>The ftp: URL is missing a trailing slash.</dd>
|
|
<dt><b>http-cookie-store-error</b></dt>
|
|
<dd>An error occurred while storing a cookie.</dd>
|
|
<dt><b>http-empty-content</b></dt>
|
|
<dd>The URL had no content.</dd>
|
|
<dt><b>mail-no-mx-host</b></dt>
|
|
<dd>The mail MX host could not be found.</dd>
|
|
<dt><b>nntp-no-newsgroup</b></dt>
|
|
<dd>The NNTP newsgroup could not be found.</dd>
|
|
<dt><b>nntp-no-server</b></dt>
|
|
<dd>No NNTP server was found.</dd>
|
|
<dt><b>url-content-size-zero</b></dt>
|
|
<dd>The URL content size is zero.</dd>
|
|
<dt><b>url-content-too-large</b></dt>
|
|
<dd>The URL content size is too large.</dd>
|
|
<dt><b>url-effective-url</b></dt>
|
|
<dd>The effective URL is different from the original.</dd>
|
|
<dt><b>url-error-getting-content</b></dt>
|
|
<dd>Could not get the content of the URL.</dd>
|
|
<dt><b>url-obfuscated-ip</b></dt>
|
|
<dd>The IP is obfuscated.</dd>
|
|
<dt><b>url-whitespace</b></dt>
|
|
<dd>The URL contains leading or trailing whitespace.
|
|
<p class="Pp"></p>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
|
|
ALSO</a></h1>
|
|
<a href="../man1/linkchecker.1.html" class="Xr">linkchecker(1)</a>
|
|
</section>
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="AUTHOR"><a class="permalink" href="#AUTHOR">AUTHOR</a></h1>
|
|
Bastian Kleineidam <bastian.kleineidam@web.de>
|
|
</section>
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="COPYRIGHT"><a class="permalink" href="#COPYRIGHT">COPYRIGHT</a></h1>
|
|
Copyright © 2000-2014 Bastian Kleineidam
|
|
</section>
|
|
</div>
|
|
<table class="foot">
|
|
<tr>
|
|
<td class="foot-date">2020-04-24</td>
|
|
<td class="foot-os">LinkChecker</td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|