Return to README CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / smartmontools

Annotation of embedaddon/smartmontools/README, revision 1.1.1.3

1.1       misho       1: ==========================================================
                      2: smartmontools - S.M.A.R.T. utility toolset for Darwin/Mac
                      3: OSX, FreeBSD, Linux, NetBSD, OpenBSD, Solaris, and Windows.
                      4: ==========================================================
                      5: 
1.1.1.3 ! misho       6: $Id: README 3817 2013-06-09 16:59:50Z chrfranke $
1.1       misho       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: 
                     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
1.1.1.2   misho      30: example COPYING); if not, write to the Free Software Foundation, Inc.,
                     31: 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
1.1       misho      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: 
1.1.1.3 ! misho      72: http://sourceforge.net/projects/smartmontools/files/
1.1       misho      73: 
                     74: SVN
                     75: ---
                     76: 
1.1.1.3 ! misho      77: svn co http://svn.code.sf.net/p/smartmontools/code/trunk/smartmontools smartmontools
1.1       misho      78: 
                     79: This will create a subdirectory called smartmontools containing the code.
                     80: 
                     81: To instead get the 5.38 release:
                     82: 
1.1.1.3 ! misho      83: svn co http://svn.code.sf.net/p/smartmontools/code/tags/RELEASE_5_38/sm5 smartmontools
1.1       misho      84: 
                     85: You can see what the different tags are by looking at
1.1.1.3 ! misho      86: http://sourceforge.net/p/smartmontools/code/HEAD/tree/tags/
1.1       misho      87: 
                     88: == BUILDING/INSTALLING SMARTMONTOOLS ==
                     89: 
                     90: Refer to the "INSTALL" file for detailed installation instructions.
                     91: 
                     92: See the "WARNINGS" file for reports of hardware where these utilities
                     93: might cause serious problems such as lockups.
                     94: 
                     95: == GETTING STARTED ==
                     96: 
                     97: To examine SMART data from a disk, try:
                     98:   smartctl -a /dev/hda
                     99: for ATA disks, or
                    100:   smartctl -a /dev/sda
                    101: for SCSI disks.  See the manual page 'man smartctl' for more
                    102: information.
                    103: 
                    104: To start automatic monitoring of your disks with the smartd daemon,
                    105: try:
                    106:   smartd -d
                    107: to start the daemon in foreground (debug) mode, or
                    108:   smartd
                    109: to start the daemon in background mode.  This will log messages to
                    110: SYSLOG.  If you would like to get email warning messages, please set
                    111: up the configuration file smartd.conf with the '-m' mail warning
                    112: Directive.  See the manual page 'man smartd' for more information.