Hopiu/linkchecker
1
0
Fork 0
mirror of https://github.com/Hopiu/linkchecker.git synced 2026-05-05 13:14:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

updated optcomplete install docs

Browse source 
git-svn-id: https://linkchecker.svn.sourceforge.net/svnroot/linkchecker/trunk/linkchecker@2124 e7d03fd6-7b0d-0410-9947-9c21f3af8025
This commit is contained in:
calvin 2005-01-11 11:19:49 +00:00
parent adcaf770e5
commit 846bc2cc41
6 changed files with 74 additions and 75 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

110
doc/documentation.html
View file

@ -3,7 +3,7 @@
<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.4: http://docutils.sourceforge.net/" />
<meta name="generator" content="Docutils 0.3.7: http://docutils.sourceforge.net/" />
<title>Documentation</title>
<meta content="3" name="navigation.order" />
<meta content="Documentation" name="navigation.name" />
@ -33,8 +33,8 @@ window.onload = function() {
</div>
</div>
<!-- /bfknav -->
<h1 class="title">Documentation</h1>
<div class="document" id="documentation">
<h1 class="title">Documentation</h1>
<div class="contents topic" id="contents">
<p class="topic-title first"><a name="contents">Contents</a></p>
<ul class="simple">
@ -46,12 +46,12 @@ window.onload = function() {
</div>
<div class="section" id="basic-usage">
<h1><a class="toc-backref" href="#id2" name="basic-usage">Basic usage</a></h1>
<p>To check an URL like <tt class="literal"><span class="pre">http://www.myhomepage.org/</span></tt> it is enough to
execute <tt class="literal"><span class="pre">linkchecker</span> <span class="pre">http://www.myhomepage.org/</span></tt>. This will check the
<p>To check an URL like <tt class="docutils literal"><span class="pre">http://www.myhomepage.org/</span></tt> it is enough to
execute <tt class="docutils literal"><span class="pre">linkchecker</span> <span class="pre">http://www.myhomepage.org/</span></tt>. This will check the
complete domain of www.myhomepage.org recursively. All links pointing
outside of the domain are also checked for validity.</p>
<p>For more options, read the man page <tt class="literal"><span class="pre">linkchecker(1)</span></tt> or execute
<tt class="literal"><span class="pre">linkchecker</span> <span class="pre">-h</span></tt>.</p>
<p>For more options, read the man page <tt class="docutils literal"><span class="pre">linkchecker(1)</span></tt> or execute
<tt class="docutils literal"><span class="pre">linkchecker</span> <span class="pre">-h</span></tt>.</p>
</div>
<div class="section" id="performed-checks">
<h1><a class="toc-backref" href="#id3" name="performed-checks">Performed checks</a></h1>
@ -61,7 +61,7 @@ are errors.
After the syntax check passes, the URL is queued for connection
checking. All connection check types are described below.</p>
<ul>
<li><p class="first">HTTP links (<tt class="literal"><span class="pre">http:</span></tt>, <tt class="literal"><span class="pre">https:</span></tt>)</p>
<li><p class="first">HTTP links (<tt class="docutils literal"><span class="pre">http:</span></tt>, <tt class="docutils literal"><span class="pre">https:</span></tt>)</p>
<p>After connecting to the given HTTP server the given path
or query is requested. All redirections are followed, and
if user/password is given it will be used as authorization
@ -69,13 +69,13 @@ when necessary.
Permanently moved pages issue a warning.
All final HTTP status codes other than 2xx are errors.</p>
</li>
<li><p class="first">Local files (<tt class="literal"><span class="pre">file:</span></tt>)</p>
<li><p class="first">Local files (<tt class="docutils literal"><span class="pre">file:</span></tt>)</p>
<p>A regular, readable file that can be opened is valid. A readable
directory is also valid. All other files, for example device files,
unreadable or non-existing files are errors.</p>
<p>File contents are checked for recursion.</p>
</li>
<li><p class="first">Mail links (<tt class="literal"><span class="pre">mailto:</span></tt>)</p>
<li><p class="first">Mail links (<tt class="docutils literal"><span class="pre">mailto:</span></tt>)</p>
<p>A mailto: link eventually resolves to a list of email addresses.
If one address fails, the whole list will fail.
For each mail address we check the following things:</p>
@ -89,66 +89,66 @@ If no host accepts SMTP, we print a warning.</li>
an answer, print the verified address as an info.</li>
</ol>
</li>
<li><p class="first">FTP links (<tt class="literal"><span class="pre">ftp:</span></tt>)</p>
<li><p class="first">FTP links (<tt class="docutils literal"><span class="pre">ftp:</span></tt>)</p>
<p>For FTP links we do:</p>
<ol class="arabic simple">
<li>connect to the specified host</li>
<li>try to login with the given user and password. The default
user is <tt class="literal"><span class="pre">anonymous</span></tt>, the default password is <tt class="literal"><span class="pre">anonymous&#64;</span></tt>.</li>
user is <tt class="docutils literal"><span class="pre">anonymous</span></tt>, the default password is <tt class="docutils literal"><span class="pre">anonymous&#64;</span></tt>.</li>
<li>try to change to the given directory</li>
<li>list the file with the NLST command</li>
</ol>
</li>
<li><p class="first">Gopher links (<tt class="literal"><span class="pre">gopher:</span></tt>)</p>
<li><p class="first">Gopher links (<tt class="docutils literal"><span class="pre">gopher:</span></tt>)</p>
<p>We try to send the given selector (or query) to the gopher server.</p>
</li>
<li><p class="first">Telnet links (<tt class="literal"><span class="pre">telnet:</span></tt>)</p>
<li><p class="first">Telnet links (<tt class="docutils literal"><span class="pre">telnet:</span></tt>)</p>
<p>We try to connect and if user/password are given, login to the
given telnet server.</p>
</li>
<li><p class="first">NNTP links (<tt class="literal"><span class="pre">news:</span></tt>, <tt class="literal"><span class="pre">snews:</span></tt>, <tt class="literal"><span class="pre">nntp</span></tt>)</p>
<li><p class="first">NNTP links (<tt class="docutils literal"><span class="pre">news:</span></tt>, <tt class="docutils literal"><span class="pre">snews:</span></tt>, <tt class="docutils literal"><span class="pre">nntp</span></tt>)</p>
<p>We try to connect to the given NNTP server. If a news group or
article is specified, try to request it from the server.</p>
</li>
<li><p class="first">Ignored links (<tt class="literal"><span class="pre">javascript:</span></tt>, etc.)</p>
<li><p class="first">Ignored links (<tt class="docutils literal"><span class="pre">javascript:</span></tt>, etc.)</p>
<p>An ignored link will only print a warning. No further checking
will be made.</p>
<p>Here is a complete list of recognized, but ignored links. The most
prominent of them should be JavaScript links.</p>
<ul class="simple">
<li><tt class="literal"><span class="pre">acap:</span></tt> (application configuration access protocol)</li>
<li><tt class="literal"><span class="pre">afs:</span></tt> (Andrew File System global file names)</li>
<li><tt class="literal"><span class="pre">chrome:</span></tt> (Mozilla specific)</li>
<li><tt class="literal"><span class="pre">cid:</span></tt> (content identifier)</li>
<li><tt class="literal"><span class="pre">clsid:</span></tt> (Microsoft specific)</li>
<li><tt class="literal"><span class="pre">data:</span></tt> (data)</li>
<li><tt class="literal"><span class="pre">dav:</span></tt> (dav)</li>
<li><tt class="literal"><span class="pre">fax:</span></tt> (fax)</li>
<li><tt class="literal"><span class="pre">find:</span></tt> (Mozilla specific)</li>
<li><tt class="literal"><span class="pre">imap:</span></tt> (internet message access protocol)</li>
<li><tt class="literal"><span class="pre">isbn:</span></tt> (ISBN (int. book numbers))</li>
<li><tt class="literal"><span class="pre">javascript:</span></tt> (JavaScript)</li>
<li><tt class="literal"><span class="pre">ldap:</span></tt> (Lightweight Directory Access Protocol)</li>
<li><tt class="literal"><span class="pre">mailserver:</span></tt> (Access to data available from mail servers)</li>
<li><tt class="literal"><span class="pre">mid:</span></tt> (message identifier)</li>
<li><tt class="literal"><span class="pre">mms:</span></tt> (multimedia stream)</li>
<li><tt class="literal"><span class="pre">modem:</span></tt> (modem)</li>
<li><tt class="literal"><span class="pre">nfs:</span></tt> (network file system protocol)</li>
<li><tt class="literal"><span class="pre">opaquelocktoken:</span></tt> (opaquelocktoken)</li>
<li><tt class="literal"><span class="pre">pop:</span></tt> (Post Office Protocol v3)</li>
<li><tt class="literal"><span class="pre">prospero:</span></tt> (Prospero Directory Service)</li>
<li><tt class="literal"><span class="pre">rsync:</span></tt> (rsync protocol)</li>
<li><tt class="literal"><span class="pre">rtsp:</span></tt> (real time streaming protocol)</li>
<li><tt class="literal"><span class="pre">service:</span></tt> (service location)</li>
<li><tt class="literal"><span class="pre">shttp:</span></tt> (secure HTTP)</li>
<li><tt class="literal"><span class="pre">sip:</span></tt> (session initiation protocol)</li>
<li><tt class="literal"><span class="pre">tel:</span></tt> (telephone)</li>
<li><tt class="literal"><span class="pre">tip:</span></tt> (Transaction Internet Protocol)</li>
<li><tt class="literal"><span class="pre">tn3270:</span></tt> (Interactive 3270 emulation sessions)</li>
<li><tt class="literal"><span class="pre">vemmi:</span></tt> (versatile multimedia interface)</li>
<li><tt class="literal"><span class="pre">wais:</span></tt> (Wide Area Information Servers)</li>
<li><tt class="literal"><span class="pre">z39.50r:</span></tt> (Z39.50 Retrieval)</li>
<li><tt class="literal"><span class="pre">z39.50s:</span></tt> (Z39.50 Session)</li>
<li><tt class="docutils literal"><span class="pre">acap:</span></tt> (application configuration access protocol)</li>
<li><tt class="docutils literal"><span class="pre">afs:</span></tt> (Andrew File System global file names)</li>
<li><tt class="docutils literal"><span class="pre">chrome:</span></tt> (Mozilla specific)</li>
<li><tt class="docutils literal"><span class="pre">cid:</span></tt> (content identifier)</li>
<li><tt class="docutils literal"><span class="pre">clsid:</span></tt> (Microsoft specific)</li>
<li><tt class="docutils literal"><span class="pre">data:</span></tt> (data)</li>
<li><tt class="docutils literal"><span class="pre">dav:</span></tt> (dav)</li>
<li><tt class="docutils literal"><span class="pre">fax:</span></tt> (fax)</li>
<li><tt class="docutils literal"><span class="pre">find:</span></tt> (Mozilla specific)</li>
<li><tt class="docutils literal"><span class="pre">imap:</span></tt> (internet message access protocol)</li>
<li><tt class="docutils literal"><span class="pre">isbn:</span></tt> (ISBN (int. book numbers))</li>
<li><tt class="docutils literal"><span class="pre">javascript:</span></tt> (JavaScript)</li>
<li><tt class="docutils literal"><span class="pre">ldap:</span></tt> (Lightweight Directory Access Protocol)</li>
<li><tt class="docutils literal"><span class="pre">mailserver:</span></tt> (Access to data available from mail servers)</li>
<li><tt class="docutils literal"><span class="pre">mid:</span></tt> (message identifier)</li>
<li><tt class="docutils literal"><span class="pre">mms:</span></tt> (multimedia stream)</li>
<li><tt class="docutils literal"><span class="pre">modem:</span></tt> (modem)</li>
<li><tt class="docutils literal"><span class="pre">nfs:</span></tt> (network file system protocol)</li>
<li><tt class="docutils literal"><span class="pre">opaquelocktoken:</span></tt> (opaquelocktoken)</li>
<li><tt class="docutils literal"><span class="pre">pop:</span></tt> (Post Office Protocol v3)</li>
<li><tt class="docutils literal"><span class="pre">prospero:</span></tt> (Prospero Directory Service)</li>
<li><tt class="docutils literal"><span class="pre">rsync:</span></tt> (rsync protocol)</li>
<li><tt class="docutils literal"><span class="pre">rtsp:</span></tt> (real time streaming protocol)</li>
<li><tt class="docutils literal"><span class="pre">service:</span></tt> (service location)</li>
<li><tt class="docutils literal"><span class="pre">shttp:</span></tt> (secure HTTP)</li>
<li><tt class="docutils literal"><span class="pre">sip:</span></tt> (session initiation protocol)</li>
<li><tt class="docutils literal"><span class="pre">tel:</span></tt> (telephone)</li>
<li><tt class="docutils literal"><span class="pre">tip:</span></tt> (Transaction Internet Protocol)</li>
<li><tt class="docutils literal"><span class="pre">tn3270:</span></tt> (Interactive 3270 emulation sessions)</li>
<li><tt class="docutils literal"><span class="pre">vemmi:</span></tt> (versatile multimedia interface)</li>
<li><tt class="docutils literal"><span class="pre">wais:</span></tt> (Wide Area Information Servers)</li>
<li><tt class="docutils literal"><span class="pre">z39.50r:</span></tt> (Z39.50 Retrieval)</li>
<li><tt class="docutils literal"><span class="pre">z39.50s:</span></tt> (Z39.50 Session)</li>
</ul>
</li>
</ul>
@ -157,7 +157,7 @@ prominent of them should be JavaScript links.</p>
<h1><a class="toc-backref" href="#id4" name="recursion">Recursion</a></h1>
<p>Recursion occurs on HTML files, Opera bookmark files and directories.
Note that the directory recursion reads all files in that
directory, not just a subset like <tt class="literal"><span class="pre">index.htm*</span></tt>.</p>
directory, not just a subset like <tt class="docutils literal"><span class="pre">index.htm*</span></tt>.</p>
</div>
<div class="section" id="frequently-asked-questions">
<h1><a class="toc-backref" href="#id5" name="frequently-asked-questions">Frequently asked questions</a></h1>
@ -240,7 +240,7 @@ extern2=hullabulla.com 1
# the 1 means strict external ie don't even connect
</pre>
<p>and the command
<tt class="literal"><span class="pre">linkchecker</span> <span class="pre">--intern=www.mycompany.com</span> <span class="pre">www.mycompany.com</span></tt></p>
<tt class="docutils literal"><span class="pre">linkchecker</span> <span class="pre">--intern=www.mycompany.com</span> <span class="pre">www.mycompany.com</span></tt></p>
<p><strong>Q: Is LinkCheckers cookie feature insecure?</strong></p>
<p>A: Cookies can not store more information as is in the HTTP request itself,
so you are not giving away any more system information.
@ -269,11 +269,11 @@ cfg['fileoutput'].append(cfg.logger_new(log_format, log_args))
<p><strong>Q: LinkChecker does not ignore anchor references on caching.</strong></p>
<p><strong>Q: Some links with anchors are getting checked twice.</strong></p>
<p>A: This is not a bug.
It is common practice to believe that if an URL <tt class="literal"><span class="pre">ABC#anchor1</span></tt> works then
<tt class="literal"><span class="pre">ABC#anchor2</span></tt> works too. That is not specified anywhere and I have seen
It is common practice to believe that if an URL <tt class="docutils literal"><span class="pre">ABC#anchor1</span></tt> works then
<tt class="docutils literal"><span class="pre">ABC#anchor2</span></tt> works too. That is not specified anywhere and I have seen
server-side scripts that fail on some anchors and not on others.
This is the reason for always checking URLs with different anchors.
If you really want to disable this, use the <tt class="literal"><span class="pre">--no-anchor-caching</span></tt>
If you really want to disable this, use the <tt class="docutils literal"><span class="pre">--no-anchor-caching</span></tt>
option.</p>
<p><strong>Q: I see LinkChecker gets a /robots.txt file for every site it
checks. What is that about?</strong></p>
@ -295,9 +295,9 @@ and look for missing files.</p>
<p>A: No can do. Use the <a class="reference" href="http://tidy.sourceforge.net/">HTML Tidy</a> program.</p>
</div>
</div>
<hr class="footer" />
<hr class="docutils footer" />
<div class="footer">
Generated on: 2004-11-25 12:54 UTC.
Generated on: 2005-01-11 11:18 UTC.
</div>
</body>
</html>

18
doc/index.html
View file

@ -3,7 +3,7 @@
<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.4: http://docutils.sourceforge.net/" />
<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" />
@ -31,8 +31,8 @@ window.onload = function() {
</div>
</div>
<!-- /bfknav -->
<h1 class="title">LinkChecker - check HTML documents for broken links</h1>
<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">
@ -79,15 +79,15 @@ look at the <a class="reference" href="http://cvs.sourceforge.net/viewcvs.py/lin
<div class="section" id="screenshots">
<h1><a class="toc-backref" href="#id3" name="screenshots">Screenshots</a></h1>
<blockquote>
<table border="1" class="table">
<table border="1" class="docutils">
<colgroup>
<col width="50%" />
<col width="50%" />
</colgroup>
<tbody valign="top">
<tr><td><p><a class="first last reference" href="shot1.png"><img align="middle" alt="shot1_thumb.jpg" src="shot1_thumb.jpg" /></a></p>
<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><p><a class="first last reference" href="shot2.png"><img align="middle" alt="shot2_thumb.jpg" src="shot2_thumb.jpg" /></a></p>
<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>
@ -124,7 +124,7 @@ commandline options to Python scripts.</p>
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="literal"><span class="pre">linkchecker.pot</span></tt> file to <tt class="literal"><span class="pre">language.po</span></tt>, translate it and
<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>
@ -139,12 +139,12 @@ and requests.</p>
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>
<p><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></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="footer" />
<hr class="docutils footer" />
<div class="footer">
Generated on: 2004-11-25 12:54 UTC.
Generated on: 2005-01-11 11:18 UTC.
</div>
</body>
</html>

6
doc/install.html
View file

@ -57,7 +57,8 @@ This is available in gettext &gt;= 0.12.</p>
On most distributions, the distutils module is included in
an extra &quot;python-dev&quot; package.</p>
</li>
<li><p class="first">optcomplete Python module from <a class="reference" href="http://furius.ca/optcomplete/">http://furius.ca/optcomplete/</a></p>
<li><p class="first"><em>Optional, for bash-completion:</em>
optcomplete Python module from <a class="reference" href="http://furius.ca/optcomplete/">http://furius.ca/optcomplete/</a></p>
</li>
</ol>
</div>
@ -79,7 +80,6 @@ Be sure to install in the given order:<ol class="loweralpha">
[<a class="reference" href="http://osdn.dl.sourceforge.net/sourceforge/mingw/gettext-0.11.5-2003.02.01-1.exe">http://osdn.dl.sourceforge.net/sourceforge/mingw/gettext-0.11.5-2003.02.01-1.exe</a>]</li>
</ol>
</li>
<li>optcomplete Python module from <a class="reference" href="http://furius.ca/optcomplete/">http://furius.ca/optcomplete/</a></li>
</ol>
</div>
<div class="section" id="setup-for-unix-linux-or-mac-os-x">
@ -202,7 +202,7 @@ working</li>
</div>
<hr class="docutils footer" />
<div class="footer">
Generated on: 2005-01-10 15:11 UTC.
Generated on: 2005-01-11 11:18 UTC.
</div>
</body>
</html>

5
doc/install.txt
View file

@ -35,7 +35,8 @@ Requirements for Unix/Linux or Mac OS X
On most distributions, the distutils module is included in
an extra "python-dev" package.
3. optcomplete Python module from http://furius.ca/optcomplete/
3. *Optional, for bash-completion:*
optcomplete Python module from http://furius.ca/optcomplete/
Requirements for Windows
------------------------
@ -56,8 +57,6 @@ Requirements for Windows
d) gettext
[http://osdn.dl.sourceforge.net/sourceforge/mingw/gettext-0.11.5-2003.02.01-1.exe]
3. optcomplete Python module from http://furius.ca/optcomplete/
Setup for Unix/Linux or Mac OS X
--------------------------------

8
doc/other.html
View file

@ -3,7 +3,7 @@
<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.4: http://docutils.sourceforge.net/" />
<meta name="generator" content="Docutils 0.3.7: http://docutils.sourceforge.net/" />
<title>Other link checkers</title>
<meta content="5" name="navigation.order" />
<meta content="Other" name="navigation.name" />
@ -31,8 +31,8 @@ window.onload = function() {
</div>
</div>
<!-- /bfknav -->
<h1 class="title">Other link checkers</h1>
<div class="document" id="other-link-checkers">
<h1 class="title">Other link checkers</h1>
<p>If LinkChecker does not fit your requirements, you can check out the
competition. All of these programs have also an <a class="reference" href="http://www.opensource.org/licenses/">Open Source license</a>
like LinkChecker.</p>
@ -48,9 +48,9 @@ like LinkChecker.</p>
<li><a class="reference" href="http://cgi.linuxfocus.org/~guido/index.html#webgrep">webgrep</a> written in Perl</li>
</ul>
</div>
<hr class="footer" />
<hr class="docutils footer" />
<div class="footer">
Generated on: 2004-11-25 12:54 UTC.
Generated on: 2005-01-11 11:18 UTC.
</div>
</body>
</html>

2
doc/upgrading.html
View file

@ -69,7 +69,7 @@ you can append a <tt class="docutils literal"><span class="pre">||</span> <span
</div>
<hr class="docutils footer" />
<div class="footer">
Generated on: 2005-01-10 15:11 UTC.
Generated on: 2005-01-11 11:18 UTC.
</div>
</body>
</html>