import upstream version 5.36

[mirror_smartmontools-debian.git] / README

==========================================================
smartmontools - S.M.A.R.T. utility toolset for Darwin/Mac
OSX, FreeBSD, Linux, NetBSD, OpenBSD, Solaris, and Windows.
==========================================================

$Id: README,v 1.55 2006/04/12 14:54:28 ballen4705 Exp $

== 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-6 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.


== OBTAINING SMARTMONTOOLS ==

Source tarballs
---------------

http://sourceforge.net/project/showfiles.php?group_id=64297

CVS
---

cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/smartmontools login (when prompted for a password, just press Enter)
cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/smartmontools co sm5

This will create a subdirectory called sm5/ containing the code.

To instead get the 5.1-16 release:

cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/smartmontools co -r RELEASE_5_1_16 sm5

To update your sources to the 5.1-18 release:

cd sm5
cvs up -r RELEASE_5_1_18

To update any tagged release to the latest development code:

cd sm5
cvs up -A

You can see what the different tags are by looking at
http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/smartmontools/sm5/ .
You'll see the tag names in the little scroll window where it says "Show
only files with tag".

== BUILDING/INSTALLING SMARTMONTOOLS ==

Refer to the "INSTALL" file for detailed installation instructions.

See the "WARNINGS" file for reports of hardware where these utilities
might cause serious problems such as lockups.

== GETTING STARTED ==

To examine SMART data from a disk, try:
  smartctl -a /dev/hda
for ATA disks, or
  smartctl -a /dev/sda
for SCSI disks.  See the manual page 'man smartctl' for more
information.

To start automatic monitoring of your disks with the smartd daemon,
try:
  smartd -d
to start the daemon in foreground (debug) mode, or
  smartd
to start the daemon in background mode.  This will log messages to
SYSLOG.  If you would like to get email warning messages, please set
up the configuration file smartd.conf with the '-m' mail warning
Directive.  See the manual page 'man smartd' for more information.