2014-06-11 20:44:57 +00:00
LinkChecker
============
2017-11-10 13:26:13 +00:00
|Build Status|_ |License|_
2014-07-01 17:56:50 +00:00
2017-01-31 17:18:47 +00:00
.. |Build Status| image :: https://travis-ci.org/linkcheck/linkchecker.svg?branch=master
.. _Build Status: https://travis-ci.org/linkcheck/linkchecker
2014-07-01 18:13:40 +00:00
.. |License| image :: http://img.shields.io/badge/license-GPL2-d49a6a.svg
2014-07-01 17:56:50 +00:00
.. _License: http://opensource.org/licenses/GPL-2.0
2014-06-11 20:44:57 +00:00
Check for broken links in web sites.
Features
---------
- recursive and multithreaded checking and site crawling
- 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
- restrict link checking with regular expression filters for URLs
- proxy support
- username/password authorization for HTTP, FTP and Telnet
- honors robots.txt exclusion protocol
- Cookie support
- HTML5 support
2016-01-23 12:28:15 +00:00
- a command line and web interface
2014-06-11 20:44:57 +00:00
- various check plugins available, eg. HTML syntax and antivirus checks.
Installation
-------------
See doc/install.txt in the source code archive.
2017-10-24 19:20:29 +00:00
Python 2.7.2 or later is needed. It doesn't work with Python 3 yet, see `#40 <https://github.com/linkcheck/linkchecker/pull/40> `_ for details.
2014-06-11 20:44:57 +00:00
2017-11-10 13:26:13 +00:00
`` pip install linkchecker `` should NOT be used for now, as it will install the old version of linkchecker. See `#4 <https://github.com/linkcheck/linkchecker/pull/4> `_ .
2014-06-11 20:44:57 +00:00
Usage
------
Execute `` linkchecker http://www.example.com `` .
For other options see `` linkchecker --help `` .
