README

   1 ==========================================================
   2 smartmontools - S.M.A.R.T. utility toolset for Darwin/Mac
   3 OSX, FreeBSD, Linux, NetBSD, OpenBSD, Solaris, and Windows.
   4 ==========================================================
   5
   6 $Id: README,v 1.56 2006/05/19 16:33:33 chrfranke Exp $
   7
   8 == HOME ==
   9 The home for smartmontools is located at:
  10
  11     http://smartmontools.sourceforge.net/
  12
  13 Please see this web site for updates, documentation, and for submitting
  14 patches and bug reports.
  15
  16 You will find a mailing list for support and other questions at:
  17
  18     http://lists.sourceforge.net/lists/listinfo/smartmontools-support
  19
  20
  21 == COPYING ==
  22 Copyright (C) 2002-6 Bruce Allen <smartmontools-support@lists.sourceforge.net>
  23
  24 This program is free software; you can redistribute it and/or modify it
  25 under the terms of the GNU General Public License as published by the Free
  26 Software Foundation; either version 2, or (at your option) any later
  27 version.
  28
  29 You should have received a copy of the GNU General Public License (for
  30 example COPYING); if not, write to the Free Software Foundation, Inc., 675
  31 Mass Ave, Cambridge, MA 02139, USA.
  32
  33
  34 == CREDITS ==
  35 This code was originally developed as a Senior Thesis by Michael Cornwell
  36 at the Concurrent Systems Laboratory (now part of the Storage Systems
  37 Research Center), Jack Baskin School of Engineering, University of
  38 California, Santa Cruz. http://ssrc.soe.ucsc.edu/
  39
  40
  41 == OVERVIEW ==
  42 smartmontools contains utilities that control and monitor storage
  43 devices using the Self-Monitoring, Analysis and Reporting Technology
  44 (S.M.A.R.T.) system build into ATA and SCSI Hard Drives. This is used
  45 to check the reliability of the hard drive and to predict drive
  46 failures.  smartmontools Version 5.x is designed to comply to the
  47 ATA/ATAPI-5 specification (Revision 1).  Future releases of
  48 smartmontools (Versions 6.x and 7.x) will comply with the ATA/ATAPI-6
  49 and ATA/ATAPI-7 specifications.
  50
  51 This package is meant to be an up-to-date replacement for the
  52 ucsc-smartsuite and smartsuite packages, and is derived from that
  53 code.
  54
  55
  56 == CONTENTS ==
  57 The suite contains two utilities:
  58
  59 smartctl is a command line utility designed to perform S.M.A.R.T. tasks
  60          such as disk self-checks, and to report the S.M.A.R.T. status of
  61          the disk.
  62
  63 smartd   is a daemon that periodically monitors S.M.A.R.T. status and
  64          reports errors and changes in S.M.A.R.T. attributes to syslog.
  65
  66
  67 == OBTAINING SMARTMONTOOLS ==
  68
  69 Source tarballs
  70 ---------------
  71
  72 http://sourceforge.net/project/showfiles.php?group_id=64297
  73
  74 CVS
  75 ---
  76
  77 cvs -d:pserver:anonymous@smartmontools.cvs.sourceforge.net:/cvsroot/smartmontools login (when prompted for a password, just press Enter)
  78 cvs -d:pserver:anonymous@smartmontools.cvs.sourceforge.net:/cvsroot/smartmontools co sm5
  79
  80 This will create a subdirectory called sm5/ containing the code.
  81
  82 To instead get the 5.1-16 release:
  83
  84 cvs -d:pserver:anonymous@smartmontools.cvs.sourceforge.net:/cvsroot/smartmontools co -r RELEASE_5_1_16 sm5
  85
  86 To update your sources to the 5.1-18 release:
  87
  88 cd sm5
  89 cvs up -r RELEASE_5_1_18
  90
  91 To update any tagged release to the latest development code:
  92
  93 cd sm5
  94 cvs up -A
  95
  96 You can see what the different tags are by looking at
  97 http://smartmontools.cvs.sourceforge.net/smartmontools/sm5/ .
  98 You'll see the tag names in the little scroll window where it says "Show
  99 only files with tag".
 100
 101 == BUILDING/INSTALLING SMARTMONTOOLS ==
 102
 103 Refer to the "INSTALL" file for detailed installation instructions.
 104
 105 See the "WARNINGS" file for reports of hardware where these utilities
 106 might cause serious problems such as lockups.
 107
 108 == GETTING STARTED ==
 109
 110 To examine SMART data from a disk, try:
 111   smartctl -a /dev/hda
 112 for ATA disks, or
 113   smartctl -a /dev/sda
 114 for SCSI disks.  See the manual page 'man smartctl' for more
 115 information.
 116
 117 To start automatic monitoring of your disks with the smartd daemon,
 118 try:
 119   smartd -d
 120 to start the daemon in foreground (debug) mode, or
 121   smartd
 122 to start the daemon in background mode.  This will log messages to
 123 SYSLOG.  If you would like to get email warning messages, please set
 124 up the configuration file smartd.conf with the '-m' mail warning
 125 Directive.  See the manual page 'man smartd' for more information.