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 3949 2014-07-13 17:23:40Z chrfranke $
   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-9 Bruce Allen <smartmontools-support@lists.sourceforge.net>
  23 Copyright (C) 2004-14 Christian Franke <smartmontools-support@lists.sourceforge.net>
  24
  25 This program is free software; you can redistribute it and/or modify it
  26 under the terms of the GNU General Public License as published by the Free
  27 Software Foundation; either version 2, or (at your option) any later
  28 version.
  29
  30 You should have received a copy of the GNU General Public License (for
  31 example COPYING).  If not, see <http://www.gnu.org/licenses/>.
  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 (SMART) system build into ATA/SATA and SCSI/SAS hard drives and
  45 solid-state drives.  This is used to check the reliability of the
  46 drive and to predict drive failures.
  47
  48
  49 == CONTENTS ==
  50 The suite contains two utilities:
  51
  52 smartctl is a command line utility designed to perform S.M.A.R.T. tasks
  53          such as disk self-checks, and to report the S.M.A.R.T. status of
  54          the disk.
  55
  56 smartd   is a daemon that periodically monitors S.M.A.R.T. status and
  57          reports errors and changes in S.M.A.R.T. attributes to syslog.
  58
  59
  60 == OBTAINING SMARTMONTOOLS ==
  61
  62 Source tarballs
  63 ---------------
  64
  65 http://sourceforge.net/projects/smartmontools/files/
  66
  67 SVN
  68 ---
  69
  70 svn co http://svn.code.sf.net/p/smartmontools/code/trunk/smartmontools smartmontools
  71
  72 This will create a subdirectory called smartmontools containing the code.
  73
  74 To instead get the 5.38 release:
  75
  76 svn co http://svn.code.sf.net/p/smartmontools/code/tags/RELEASE_5_38/sm5 smartmontools
  77
  78 You can see what the different tags are by looking at
  79 http://sourceforge.net/p/smartmontools/code/HEAD/tree/tags/
  80
  81 == BUILDING/INSTALLING SMARTMONTOOLS ==
  82
  83 Refer to the "INSTALL" file for detailed installation instructions.
  84
  85 == GETTING STARTED ==
  86
  87 To examine SMART data from a disk, try:
  88   smartctl -a /dev/hda
  89 for ATA disks, or
  90   smartctl -a /dev/sda
  91 for SCSI disks.  See the manual page 'man smartctl' for more
  92 information.
  93
  94 To start automatic monitoring of your disks with the smartd daemon,
  95 try:
  96   smartd -d
  97 to start the daemon in foreground (debug) mode, or
  98   smartd
  99 to start the daemon in background mode.  This will log messages to
 100 SYSLOG.  If you would like to get email warning messages, please set
 101 up the configuration file smartd.conf with the '-m' mail warning
 102 Directive.  See the manual page 'man smartd' for more information.