Log Validator

  

How to install the Log Validator

Foreword

This isntallation guide assumes you have read "How to get the Log Validator" and thus know which version of the product you want to install.

If you have, please proceed to :

• install using CPAN
• install a standards archive or the CVS source

When you're done, proceed to learn How to use the Log Validator.

Install the Log Validator using CPAN

The Log Validator is now available to install through CPAN.

CPAN usually stands for two different things :

• The Comprehensive Perl Archive Network (CPAN) a repository of perl modules and resources. We will use the term "CPAN archive" for it.
• CPAN is also the name of a perl module allowing for easy installation of perl modules. We will use the term "CPAN module" for it.

This installation procedure explains how to install the Log Validator with the CPAN module (and, actually, one can easily adapt the procedure to install any module on the CPAN archive with the CPAN module...). You may want to Learn more about CPAN (especially configuration hints) before proceeding any further.

Requirements

This procedure assumes that you have perl installed on your system, as well as the interactive mode of the CPAN module.

Installation procedure with CPAN

Launch the CPAN shell with "perl -MCPAN -e shell" which puts you in CPAN interactive mode

Then type "install W3C::LogValidator" and watch the magic happen.

Note : if you want to use CPAN for missing modules on which the Log Validator depend, try "install <ModuleName>" while in the CPAN interactive mode.

Next: Use

Install the Log Validator from a standard archive or the CVS source

You have downloaded the Log Validator in the form of a standard archive, most likely a file looking like W3C-LogValidator-2.12.tar.gz, or you have retrieved the source from CVS.

This installation guide will give you step-by-step instructions to install the LogValidator and other modules it depends on easily.

Uncompressing the archive

If you got the archive (i.e you did not get the source via CVS) you have a compressed archive you need to expand.

• if the file has the .tar.gz or .tgz extension:
  • On *nix systems you can use tar to uncompress it.
    try "tar -zxv Nameofthefile.tgz". If that doesn't work, check the manual for your version of the "tar" tool.
  • On other platforms various tools are available to uncompress such files (e.g Stuffit expander on MacOSX).
• if the file has the .tar extension (not .tar.gz):
  • On *nix systems you can use tar to uncompress it.
    try "tar -xv Nameofthefile.tgz". If that doesn't work, check the manual for your version of the "tar" tool.
  • On other platforms various tools are available to uncompress such files (e.g Stuffit expander on MacOSX).

When this is done you should be left with the original archive, and a folder with all the files necessary to install the Log Validator. Open this folder and proceed.

Dependencies : what Log Validator needs

The Log Validator is not a standalone program. It is a library with a program that uses this library. The library is written in the perl language, so you will need perl to run it. The library also interacts with other libraries, so you will need them too.

This procedure also assumes you have the proper tools installed on your system. You will need at least:

• Perl installed on your system. You don't need the very latest version of it, Log Validator will run on any reasonably recent perl system (note : >v5.6, I believe)

• A few perl modules.

  It can be a bit painful to install all those, we really suggest you try using packages for your operating system (if available) or with the CPAN inteactive mode.

  If you can't use those, you will have to install the pre-required modules before installing the LogValidator.

  The needed modules are : LWP::UserAgent (CPAN archive), Sys::Hostname::Long (CPAN archive), Config::General (CPAN archive), File::Temp(CPAN archive), DB_File (CPAN archive), Mail::Sendmail (CPAN archive), URI::Escape (in the URI module - CPAN archive), WebService::Validator::CSS::W3C (CPAN archive)

Installation procedure

To configure this module, once all the pre-required modules are installed, cd to the directory that contains the README file, e.g.:
shell# cd perl/modules/W3C/LogValidator
and type the following to start the pre-install process:
shell# perl Makefile.PL

Alternatively, if you plan to install the W3C libraries somewhere other than your system's perl library directory (which make install will do automatically for you) you can type something like this:
shell# perl Makefile.PL PREFIX=/home/me/perl INSTALLDIRS=perl

Then to build the programe you run:
shell# make

you may then install it on the system (optional but recommended) by typing
shell# make install
It will install the library in your system's perl tree.

Note that installing usually requires system administrator level on the machine, but it is NOT mandatory: once built, the program can be used "in place" without needing to be installed in the very center of the operating system.

When the installation is complete

When you're done, proceed to learn How to use the Log Validator.