[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 4063 2015-04-19 17:34:25Z chrfranke $

== 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-9 Bruce Allen
Copyright (C) 2004-15 Christian Franke

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, see <http://www.gnu.org/licenses/>.


== CREDITS ==
See AUTHORS file.


== OVERVIEW ==
smartmontools contains utilities that control and monitor storage
devices using the Self-Monitoring, Analysis and Reporting Technology
(SMART) system build into ATA/SATA and SCSI/SAS hard drives and
solid-state drives.  This is used to check the reliability of the
drive and to predict drive failures.


== 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/projects/smartmontools/files/

SVN
---

svn co http://svn.code.sf.net/p/smartmontools/code/trunk/smartmontools smartmontools

This will create a subdirectory called smartmontools containing the code.

To instead get the 5.38 release:

svn co http://svn.code.sf.net/p/smartmontools/code/tags/RELEASE_5_38/sm5 smartmontools

You can see what the different tags are by looking at
http://sourceforge.net/p/smartmontools/code/HEAD/tree/tags/

== BUILDING/INSTALLING SMARTMONTOOLS ==

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

== GETTING STARTED ==

To examine SMART data from a disk, try:
  smartctl -a /dev/sda
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.
Commit	Line	Data
	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 4063 2015-04-19 17:34:25Z 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
	23	Copyright (C) 2004-15 Christian Franke
	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	See AUTHORS file.
	36
	37
	38	== OVERVIEW ==
	39	smartmontools contains utilities that control and monitor storage
	40	devices using the Self-Monitoring, Analysis and Reporting Technology
	41	(SMART) system build into ATA/SATA and SCSI/SAS hard drives and
	42	solid-state drives. This is used to check the reliability of the
	43	drive and to predict drive failures.
	44
	45
	46	== CONTENTS ==
	47	The suite contains two utilities:
	48
	49	smartctl is a command line utility designed to perform S.M.A.R.T. tasks
	50	such as disk self-checks, and to report the S.M.A.R.T. status of
	51	the disk.
	52
	53	smartd is a daemon that periodically monitors S.M.A.R.T. status and
	54	reports errors and changes in S.M.A.R.T. attributes to syslog.
	55
	56
	57	== OBTAINING SMARTMONTOOLS ==
	58
	59	Source tarballs
	60	---------------
	61
	62	http://sourceforge.net/projects/smartmontools/files/
	63
	64	SVN
	65	---
	66
	67	svn co http://svn.code.sf.net/p/smartmontools/code/trunk/smartmontools smartmontools
	68
	69	This will create a subdirectory called smartmontools containing the code.
	70
	71	To instead get the 5.38 release:
	72
	73	svn co http://svn.code.sf.net/p/smartmontools/code/tags/RELEASE_5_38/sm5 smartmontools
	74
	75	You can see what the different tags are by looking at
	76	http://sourceforge.net/p/smartmontools/code/HEAD/tree/tags/
	77
	78	== BUILDING/INSTALLING SMARTMONTOOLS ==
	79
	80	Refer to the "INSTALL" file for detailed installation instructions.
	81
	82	== GETTING STARTED ==
	83
	84	To examine SMART data from a disk, try:
	85	smartctl -a /dev/sda
	86	See the manual page 'man smartctl' for more information.
	87
	88	To start automatic monitoring of your disks with the smartd daemon,
	89	try:
	90	smartd -d
	91	to start the daemon in foreground (debug) mode, or
	92	smartd
	93	to start the daemon in background mode. This will log messages to
	94	SYSLOG. If you would like to get email warning messages, please set
	95	up the configuration file smartd.conf with the '-m' mail warning
	96	Directive. See the manual page 'man smartd' for more information.