linkchecker/doc/source/index.txt

123 lines
3.7 KiB
Text

The latest version of this document is available at
http://linkchecker.sourceforge.net/.
If you like LinkChecker, consider a donation_ to improve it even
more!
.. _donation:
http://sourceforge.net/donate/index.php?group_id=1913
Features
========
- recursive and multithreaded checking
- output in colored or normal text, HTML, SQL, CSV, XML or a sitemap
graph in different formats
- HTTP/1.1, HTTPS, FTP, mailto:, news:, nntp:, Telnet and local file
links support
- restriction of link checking with regular expression filters for URLs
- proxy support
- username/password authorization for HTTP and FTP and Telnet
- honors robots.txt exclusion protocol
- Cookie support
- HTML and CSS syntax check
- Antivirus check
- a command line interface
- a (Fast)CGI web interface (requires HTTP server)
Download
========
LinkChecker is `OpenSource`_ software and licensed under the `GPL`_.
Downloads are available for Windows and Unix systems from the
`LinkChecker download section`_.
.. _OpenSource:
http://www.opensource.org/
.. _GPL:
http://www.gnu.org/licenses/licenses.html#TOCGPL
.. _LinkChecker download section:
http://sourceforge.net/project/showfiles.php?group_id=1913
Requirements and installation instructions are located at the
`install documentation`_. To see what has changed between releases
look at the ChangeLog_.
.. _install documentation:
install.html
.. _ChangeLog:
http://linkchecker.svn.sourceforge.net/viewvc/linkchecker/trunk/linkchecker/ChangeLog?view=markup
Screenshots
===========
+------------------------------------+------------------------------------+
| .. image:: shot1_thumb.jpg | .. image:: shot2_thumb.jpg |
| :align: center | :align: center |
| :target: _static/shot1.png | :target: _static/shot2.png |
+------------------------------------+------------------------------------+
| Commandline interface | Web interface |
+------------------------------------+------------------------------------+
Running
=======
Running under Unix or Mac OS X platforms
----------------------------------------
The local configuration file is $HOME/.linkcheckerrc
Type "linkchecker" followed by your URLs you want to check.
Type "linkchecker -h" for help.
Running under Windows platforms
-------------------------------
Start "Check URL" in your LinkChecker program group.
URL input is interactive.
Another way is executing on the command line.
If there is a file ``linkchecker.bat`` in your Python Scripts directory
you can run eg. ``c:\Python25\Scripts\linkchecker.bat``.
If there is only a ``linkchecker`` file in your Python Scripts
directory, you have to run eg.
``c:\Python25\python.exe c:\Python25\Scripts\linkchecker``.
Internationalization
--------------------
For german output execute "export LC_MESSAGES=de" in bash or
"setenv LC_MESSAGES de" in tcsh.
Under Windows, execute "set LC_MESSAGES=de".
Other supported languages are 'nl' (Nederlands) and 'fr' (francais).
You can help to translate LinkChecker by copying the included
``po/linkchecker.pot`` file to ``po/language.po``, translate it and
send it to me.
Bug reporting
=============
The `SourceForge Bug interface`_ allows submitting of bugs, patches
and requests.
.. _SourceForge Bug interface:
http://sourceforge.net/tracker/?func=add&group_id=1913&atid=101913
Subversion access
=================
The `SourceForge Subversion page`_ 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 `installation page`_.
.. _SourceForge Subversion page:
http://sourceforge.net/svn/?group_id=1913
.. _installation page:
install.html