linkchecker/doc/index.html
2005-01-11 11:19:49 +00:00

150 lines
7.5 KiB
HTML

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.3.7: http://docutils.sourceforge.net/" />
<title>LinkChecker - check HTML documents for broken links</title>
<meta content="0" name="navigation.order" />
<meta content="LinkChecker" name="navigation.name" />
<link rel="stylesheet" href="lc.css" type="text/css" />
<meta rel="SHORTCUT ICON" href="favicon.png" />
<link rel="stylesheet" href="navigation.css" type="text/css" />
<script type="text/javascript">
window.onload = function() {
if (top.location != location) {
top.location.href = document.location.href;
}
}
</script>
</head>
<body>
<!-- bfknav -->
<div class="navigation">
<div class="navrow" style="padding: 0em 0em 0em 1em;">
<span>LinkChecker</span>
<a href="./install.html">Installation</a>
<a href="./upgrading.html">Upgrading</a>
<a href="./documentation.html">Documentation</a>
<a href="./other.html">Other</a>
</div>
</div>
<!-- /bfknav -->
<div class="document" id="linkchecker-check-html-documents-for-broken-links">
<h1 class="title">LinkChecker - check HTML documents for broken links</h1>
<div class="contents topic" id="contents">
<p class="topic-title first"><a name="contents">Contents</a></p>
<ul class="simple">
<li><a class="reference" href="#features" id="id1" name="id1">Features</a></li>
<li><a class="reference" href="#download" id="id2" name="id2">Download</a></li>
<li><a class="reference" href="#screenshots" id="id3" name="id3">Screenshots</a></li>
<li><a class="reference" href="#running" id="id4" name="id4">Running</a><ul>
<li><a class="reference" href="#running-under-unix-or-mac-os-x-platforms" id="id5" name="id5">Running under Unix or Mac OS X platforms</a></li>
<li><a class="reference" href="#running-under-windows-platforms" id="id6" name="id6">Running under Windows platforms</a></li>
<li><a class="reference" href="#running-under-mac-os-9-x-platforms" id="id7" name="id7">Running under Mac OS 9.x platforms</a></li>
<li><a class="reference" href="#internationalization" id="id8" name="id8">Internationalization</a></li>
</ul>
</li>
<li><a class="reference" href="#bug-reporting" id="id9" name="id9">Bug reporting</a></li>
<li><a class="reference" href="#cvs-access" id="id10" name="id10">CVS access</a></li>
</ul>
</div>
<div class="section" id="features">
<h1><a class="toc-backref" href="#id1" name="features">Features</a></h1>
<ul class="simple">
<li>recursive checking</li>
<li>multithreading</li>
<li>output in colored or normal text, HTML, SQL, CSV or a sitemap
graph in GML or XML.</li>
<li>HTTP/1.1, HTTPS, FTP, mailto:, news:, nntp:, Gopher, Telnet and local
file links support</li>
<li>restriction of link checking with regular expression filters for URLs</li>
<li>proxy support</li>
<li>username/password authorization for HTTP and FTP</li>
<li>robots.txt exclusion protocol support</li>
<li>i18n support</li>
<li>a command line interface</li>
<li>a (Fast)CGI web interface (requires HTTP server)</li>
</ul>
</div>
<div class="section" id="download">
<h1><a class="toc-backref" href="#id2" name="download">Download</a></h1>
<p>Download the latest packages from <a class="reference" href="http://sourceforge.net/project/showfiles.php?group_id=1913">LinkChecker download section</a>.
There are also <a class="reference" href="linkchecker-md5sums.txt">Md5sum checksums</a> from above files.</p>
<p>Requirements and installation instructions are located at the
<a class="reference" href="install.html">install documentation</a>. To see what has changed between releases
look at the <a class="reference" href="http://cvs.sourceforge.net/viewcvs.py/linkchecker/linkchecker/ChangeLog?view=markup">ChangeLog</a>.</p>
</div>
<div class="section" id="screenshots">
<h1><a class="toc-backref" href="#id3" name="screenshots">Screenshots</a></h1>
<blockquote>
<table border="1" class="docutils">
<colgroup>
<col width="50%" />
<col width="50%" />
</colgroup>
<tbody valign="top">
<tr><td><div align="middle" class="image align-middle image-reference"><a class="first last reference" href="shot1.png"><img align="middle" alt="shot1_thumb.jpg" src="shot1_thumb.jpg" /></a></div>
</td>
<td><div align="middle" class="image align-middle image-reference"><a class="first last reference" href="shot2.png"><img align="middle" alt="shot2_thumb.jpg" src="shot2_thumb.jpg" /></a></div>
</td>
</tr>
<tr><td>Commandline interface</td>
<td>Web interface</td>
</tr>
</tbody>
</table>
</blockquote>
</div>
<div class="section" id="running">
<h1><a class="toc-backref" href="#id4" name="running">Running</a></h1>
<div class="section" id="running-under-unix-or-mac-os-x-platforms">
<h2><a class="toc-backref" href="#id5" name="running-under-unix-or-mac-os-x-platforms">Running under Unix or Mac OS X platforms</a></h2>
<p>The local configuration file is $HOME/.linkcheckerrc
Type &quot;linkchecker&quot; followed by your URLs you want to check.
Type &quot;linkchecker -h&quot; for help.</p>
</div>
<div class="section" id="running-under-windows-platforms">
<h2><a class="toc-backref" href="#id6" name="running-under-windows-platforms">Running under Windows platforms</a></h2>
<p>Start &quot;Check URL&quot; in your LinkChecker program group.
URL input is interactive.
Another way is executing &quot;python.exe linkchecker&quot; in the Python
Scripts directory.</p>
</div>
<div class="section" id="running-under-mac-os-9-x-platforms">
<h2><a class="toc-backref" href="#id7" name="running-under-mac-os-9-x-platforms">Running under Mac OS 9.x platforms</a></h2>
<p>Read the MacOS Python documentation to find out about passing
commandline options to Python scripts.</p>
</div>
<div class="section" id="internationalization">
<h2><a class="toc-backref" href="#id8" name="internationalization">Internationalization</a></h2>
<p>For german output execute &quot;export LC_MESSAGES=de&quot; in bash or
&quot;setenv LC_MESSAGES de&quot; in tcsh.
Under Windows, execute &quot;set LC_MESSAGES=de&quot;.
Other supported languages are 'nl' (Nederlands) and 'fr' (français).</p>
<p>You can help to translate LinkChecker by copying the included
<tt class="docutils literal"><span class="pre">linkchecker.pot</span></tt> file to <tt class="docutils literal"><span class="pre">language.po</span></tt>, translate it and
send it to me.</p>
</div>
</div>
<div class="section" id="bug-reporting">
<h1><a class="toc-backref" href="#id9" name="bug-reporting">Bug reporting</a></h1>
<p>The <a class="reference" href="http://sourceforge.net/tracker/?func=add&amp;group_id=1913&amp;atid=101913">SourceForge Bug interface</a> allows submitting of bugs, patches
and requests.</p>
</div>
<div class="section" id="cvs-access">
<h1><a class="toc-backref" href="#id10" name="cvs-access">CVS access</a></h1>
<p>The <a class="reference" href="http://sourceforge.net/cvs/?group_id=1913">SourceForge CVS page</a> has all the information on how to
obtain the development version of LinkChecker. Development of
LinkChecker requires some more software to be available, which
is documented on the <cite>installation page</cite>.</p>
<div align="right" class="image align-right image-reference"><a class="reference" href="http://sourceforge.net/"><img align="right" alt="SourceForge Logo" height="31" src="http://sourceforge.net/sflogo.php?group_id=1913&amp;type=1" width="88" /></a></div>
</div>
</div>
<hr class="docutils footer" />
<div class="footer">
Generated on: 2005-01-11 11:18 UTC.
</div>
</body>
</html>