diff --git a/README.rst b/README.rst index c223fd92..3c1b0e8e 100644 --- a/README.rst +++ b/README.rst @@ -32,15 +32,15 @@ See `doc/install.txt`_ in the source code archive for general information. Excep .. _doc/install.txt: doc/install.txt -Python 3 or later is needed. +Python 3.5 or later is needed. -The version in the pip repository is old. Instead, you can use pip to install the latest release from git: ``pip install git+https://github.com/linkchecker/linkchecker.git``. See `#359 `_. +The version in the pip repository is old. Instead, you can use pip to install the latest release from git: ``sudo pip3 install git+https://github.com/linkchecker/linkchecker.git``. See `#359 `_. Windows builds are seriously lagging behind the Linux releases, see `#53 `_ for details. For now, the only two options are to install from source or use `Docker for Windows `_. Usage ------ -Execute ``linkchecker http://www.example.com``. +Execute ``linkchecker https://www.example.com``. For other options see ``linkchecker --help``. Docker usage @@ -48,12 +48,10 @@ Docker usage If you do not want to install any additional libraries/dependencies you can use the Docker image. -Example for external web site check: -``` -docker run --rm -it -u $(id -u):$(id -g) linkchecker/linkchecker --verbose https://google.com -``` +Example for external web site check:: -Local HTML file check: -``` -docker run --rm -it -u $(id -u):$(id -g) -v "$PWD":/mnt linkchecker/linkchecker --verbose index.html -``` + docker run --rm -it -u $(id -u):$(id -g) linkchecker/linkchecker --verbose https://www.example.com + +Local HTML file check:: + + docker run --rm -it -u $(id -u):$(id -g) -v "$PWD":/mnt linkchecker/linkchecker --verbose index.html diff --git a/doc/install.txt b/doc/install.txt index 474d893f..f8677aeb 100644 --- a/doc/install.txt +++ b/doc/install.txt @@ -8,18 +8,16 @@ Setup with pip If pip_ is available, this command should install LinkChecker on the local system: -.. _pip: https://pypi.python.org/pypi/pip +.. _pip: https://pypi.org/project/pip/ -``sudo pip install LinkChecker`` - -Note that this needs the Python development and a C compiler installed. -For example on Debian Linux systems use ``sudo apt-get install python-dev``. +``sudo pip3 install LinkChecker`` +You can also use pip to install the latest from git: ``sudo pip3 install git+https://github.com/linkchecker/linkchecker.git``. Setup for Windows ----------------- -Execute ``LinkChecker-x.y.exe`` and follow the instructions. - +Nobody is currently offering an "exe" download for Windows +See https://github.com/linkchecker/linkchecker/issues/53 Setup for Mac OS X ------------------ @@ -32,47 +30,39 @@ Setup for GNU/Linux On all major Linux distributions (Debian, Mandriva, Redhat, Suse, Ubuntu), the ``linkchecker`` package is available for install. - Manual setup for Unix systems ----------------------------- First, install the required software. -1. You need a standard GNU development environment with - - - C compiler (for example the GNU C Compiler gcc) - - Depending on your distribution, several development packages - might be needed to provide a fully functional C development - environment. - - Note for developers: if you want to regenerate the po/linkchecker.pot - template from the source files, you will need xgettext with Python - support. This is available in gettext >= 0.12. +1. Python >= 3.5.0 from https://www.python.org/ -2. Python >= 2.7.2 from http://www.python.org/ - Be sure to also have installed the included distutils module. On most distributions, the distutils module is included in an extra ``python-dev`` package. -3. Python requests module from https://pypi.python.org/pypi/requests +2. Python requests package from https://pypi.org/project/requests/ + +3. Python Beautiful Soup package from https://pypi.org/project/beautifulsoup4/ 4. *Optional, for bash-completion:* - argcomplete Python module from https://pypi.python.org/pypi/argcomplete + argcomplete Python module from https://pypi.org/project/argcomplete/ 5. *Optional, for displaying country codes:* - GeoIP from http://www.maxmind.com/app/python + GeoIP from https://pypi.org/project/GeoIP/ 6. *Optional, used for Virus checking:* - ClamAv from http://www.clamav.net/ + ClamAv from https://www.clamav.net/ 7. *Optional, for GNOME proxy setting parsing:* Python Gtk from http://www.pygtk.org/downloads.html 8. *Optional, to run the WSGI web interface:* - Apache from http://httpd.apache.org/ - mod_wsgi from http://code.google.com/p/modwsgi/ + Apache from https://httpd.apache.org/ + mod_wsgi from https://pypi.org/project/mod-wsgi/ +Note for developers: if you want to regenerate the po/linkchecker.pot template +from the source files, you will need xgettext with Python support. This is +available in gettext >= 0.12. Now install the application. @@ -83,8 +73,6 @@ Now install the application. Run ``python setup.py build`` to compile the Python files. For help about the setup.py script options, run ``python setup.py --help``. - The CC environment variable is checked before compilation, so you can - change the default C compiler with ``export CC=myccompiler``. 2. a) Installation as root @@ -117,7 +105,7 @@ Manual setup for OSX systems 2. Install homebrew_ - .. _homebrew: http://mxcl.github.com/homebrew/ + .. _homebrew: https://brew.sh/ 3. Install dependencies @@ -147,7 +135,7 @@ Manual setup for OSX systems mkdir -p dist/mnt hdiutil attach -mountpoint dist/mnt dist/LinkChecker-x.y.z.dmg # to run directly - open -n dist/mnt/LinkChecker.app --args http://www.example.org + open -n dist/mnt/LinkChecker.app --args https://www.example.org # install the app sudo cp -r dist/mnt/LinkChecker.app /Applications # unmount DMG diff --git a/doc/upgrading.txt b/doc/upgrading.txt index 89e71e83..8902f5a6 100644 --- a/doc/upgrading.txt +++ b/doc/upgrading.txt @@ -1,8 +1,18 @@ Upgrading ========= +Migrating from 9.x to 10.0 +------------------------- +Python 3.5 or newer is required. + +The Python Beautiful Soup package is now required. A C compiler is not needed +for building. + +The loginuserfield and loginpasswordfield entries in the authentication section +of linkcheckerrc are now matched to a login form case-sensitively. + Migrating from 8.x to 9.0 ------------------------- -The Python requests module is now required. +The Python requests package is now required. Several checks have been moved to plugins (see below). Plugins have to be enabled in the configuration file.