INSTALL

                              check-db-links

                         INSTALLATION INSTRUCTIONS


  Copyright (C) 2014 Jaromir Hradilek

  This file covers the installation and uninstallation of the check-db-links
  utility on GNU/Linux. For information on how to use this tool, read the
  file named README.

  See the end of this file for copying conditions.


TABLE OF CONTENTS

  1. System Requirements
  2. Installation
  3. Uninstallation
  4. License


1. SYSTEM REQUIREMENTS

The check-db-links utility depends on the following tools:

  - curl
  - xmllint
  - xmlstarlet

In addition, the included makefile requires the following tool in order to
generate the manual page from the source code:

  - pod2man


2. INSTALLATION

To install the check-db-links utility in the system, change to the main
directory with its source code and type the following at a shell prompt as
the root user:

    make install

This installs the utility, its manual page, and related documentation to the
respective subdirectories in the /usr/local/ directory. To use a different
installation directory, change the value of the "prefix" variable on the
command line. For example, to install check-db-links to ~/.local/, type:

    make prefix=$HOME/.local install


3. UNINSTALLATION

To uninstall the check-db-links utility from the system, change to the main
directory with the source code and type the following at a shell prompt as the
root user:

    make uninstall

This removes the utility, its manual page, and related documentation from
the respective subdirectories in the /usr/local/ directory. If you have
installed the utility in a different directory, change the value of the
"prefix" variable on the command line. For example, if you have installed
check-db-links to ~/.local/, type:

    make prefix=$HOME/.local uninstall


4. LICENSE

This file is part of the check-db-links utility.

The check-db-links utility is free software: you can redistribute it and/or
modify it under the terms of the GNU General Public License as published by the
Free Software Foundation, version 3 of the License.

check-db-links is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.

You should have received a copy of the GNU General Public License along
with this program. If not, see <http://www.gnu.org/licenses/>.