README

===============================================
SMARTMONTOOLS - SMART utility toolset for Linux
===============================================

== HOME ==
The home for smartmontools is located at:
    http://smartmontools.sourceforge.net
Please see this web site for updates, documentation, and for
submitting patches and bug reports.

You will find a mailing list for support and other questions at:
http://lists.sourceforge.net/lists/listinfo/smartmontools-support


== COPYING ==
Copyright (C) 2002 Bruce Allen <smartmontools-support@lists.sourceforge.net>

This program 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; either version 2, or (at your option) any later
version.

You should have received a copy of the GNU General Public License (for
example COPYING); if not, write to the Free Software Foundation, Inc., 675
Mass Ave, Cambridge, MA 02139, USA.


== CREDITS ==
This code was originally developed as a Senior Thesis by Michael Cornwell
at the Concurrent Systems Laboratory (now part of the Storage Systems
Research Center), Jack Baskin School of Engineering, University of
California, Santa Cruz. http://ssrc.soe.ucsc.edu/


== OVERVIEW ==
SMARTMONTOOLS contains utilities that control and monitor storage
devices using the Self-Monitoring, Analysis and Reporting Technology
(S.M.A.R.T.) system build into ATA and SCSI Hard Drives. This is used
to check the reliability of the hard drive and to predict drive
failures.  SMARTMONTOOLS Version 5.x is designed to comply to the
ATA/ATAPI-5 specification (Revision 1).  Future releases of
SMARTMONTOOLS (Versions 6.x and 7.x) will comply with the ATA/ATAPI-6
and ATA/ATAPI-7 specifications.

This package is meant to be an up-to-date replacement for the
ucsc-smartsuite and smartsuite packages, and is derived from that
code.


== CONTENTS ==
The suite contains two utilities:

smartctl is a command line utility designed to perform
         S.M.A.R.T. tasks.such as disk self-checks, and to
         report the S.M.A.R.T. status of the disk.

smartd   is a daemon that periodically monitors S.M.A.R.T. status and
         reports errors and changes in S.M.A.R.T. attributes to syslog.

SEE THE FILE "WARNINGS" FOR REPORTS OF HARDWARE WHERE THESE UTILITIES MIGHT
CAUSE SERIOUS PROBLEMS SUCH AS LOCKUPS.

If you have just downloaded smartmontools from the URL above, then
you can read about these commands using the man pages.  Within this
directory the commands:
  man ./smartctl.8
and
  man ./smartd.8

will display the manual pages for the two commands.  If you have
already installed the package on your system, then:
  man smartctl
and
  man smartd
will display the same information.


== INSTALLATION ==
To install, use the commands:
  make
  make install
The tools require Linux kernel 2.2.14 or greater in order to run. Any
recent Linux distribution should support this package.
 
Fourteen files are installed:
/usr/sbin/smartd                               [Executable daemon]
/usr/sbin/smartctl                             [Executable command-line utility]
/etc/rc.d/init.d/smartd                        [Init/Startup script for smartd]
/usr/share/man/man8/smartctl.8.gz              [Manual page]
/usr/share/man/man8/smartd.8.gz                [Manual page]
/usr/share/man/man8/smartd.conf.5.gz           [Manual page]
/usr/share/doc/smartmontools-5.0/README        [What you are reading!]
/usr/share/doc/smartmontools-5.0/TODO          [Things that need to be done/fixed]
/usr/share/doc/smartmontools-5.0/CHANGELOG     [A log of changes. Also see CVS]
/usr/share/doc/smartmontools-5.0/COPYING       [GNU Public License.] 
/usr/share/doc/smartmontools-5.0/VERSION       [Version number]
/usr/share/doc/smartmontools-5.0/WARNINGS      [Systems where lockups or other serious problems reported]
/usr/share/doc/smartmontools-5.0/smartd.conf   [Example Configuration file for /etc/]
/etc/smartd.conf.example                       [Example Configuration file for /etc/]

Source and binary RPM files are available at the website listed above.

PLEASE READ THE MANUAL PAGES FOR SMARTCTL AND SMARTD FOR MORE INFORMATION.