]> git.proxmox.com Git - mirror_smartmontools-debian.git/blobdiff - smartd.8.in
Imported Upstream version 6.1+svn3812
[mirror_smartmontools-debian.git] / smartd.8.in
index d23497483a8c16e74e149826831f7eeeafb7d7f4..f90f3b699f15062f3e7bba1a0d81cd3c8ca3a7e4 100644 (file)
@@ -1,21 +1,22 @@
 .ig
 Copyright (C) 2002-10 Bruce Allen <smartmontools-support@lists.sourceforge.net>
-$Id: smartd.8.in 3561 2012-06-05 19:49:31Z chrfranke $
+Copyright (C) 2004-13 Christian Franke <smartmontools-support@lists.sourceforge.net>
+
+$Id: smartd.8.in 3799 2013-03-15 17:47:25Z chrfranke $
 
 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.
-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/
+
+You should have received a copy of the GNU General Public License
+(for example COPYING); If not, see <http://www.gnu.org/licenses/>.
+
+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/
+
 ..
 .TH SMARTD 8 CURRENT_SVN_DATE CURRENT_SVN_VERSION CURRENT_SVN_DATE
 .SH NAME
@@ -38,13 +39,15 @@ CURRENT_SVN_VERSION CURRENT_SVN_DATE CURRENT_SVN_REV
 .\"! It does not contain info specific to other platforms.]
 .\"! .PP
 .\" %ENDIF NOT OS ALL
-\fBsmartd\fP is a daemon that monitors the Self-Monitoring, Analysis
-and Reporting Technology (SMART) system built into many ATA-3 and
-later ATA, IDE and SCSI-3 hard drives. The purpose of SMART is to
-monitor the reliability of the hard drive and predict drive failures,
-and to carry out different types of drive self-tests.  This version of
-\fBsmartd\fP is compatible with ATA/ATAPI-7 and earlier standards (see
-\fBREFERENCES\fP below).
+\fBsmartd\fP is a daemon that monitors the Self-Monitoring, Analysis and
+Reporting Technology (SMART) system built into most ATA/SATA and SCSI/SAS
+hard drives and solid-state drives.
+The purpose of SMART is to monitor the reliability of the hard drive
+and predict drive failures, and to carry out different types of drive
+self-tests.
+This version of \fBsmartd\fP is compatible with
+ACS-2, ATA8-ACS, ATA/ATAPI-7 and earlier standards
+(see \fBREFERENCES\fP below).
 
 \fBsmartd\fP will attempt to enable SMART monitoring on ATA devices
 (equivalent to \fBsmartctl -s on\fP) and polls these and SCSI devices
@@ -57,7 +60,7 @@ command-line option described below.
 
 In addition to logging to a file, \fBsmartd\fP can also be configured
 to send email warnings if problems are detected.  Depending upon the
-type of problem, you may want to run self\-tests on the disk, back up
+type of problem, you may want to run self-tests on the disk, back up
 the disk, replace the disk, or use a manufacturer\'s utility to force
 reallocation of bad or unreadable disk sectors.  If disk problems are
 detected, please see the \fBsmartctl\fP manual page and the
@@ -89,11 +92,11 @@ the contents of the (faulty) configuration file, as if the \fBHUP\fP
 signal had never been received.
 
 When \fBsmartd\fP is running in debug mode, the \fBINT\fP signal
-(normally generated from a shell with CONTROL\-C) is treated in the
+(normally generated from a shell with CONTROL-C) is treated in the
 same way as a \fBHUP\fP signal: it makes \fBsmartd\fP reload its
 configuration file. To exit \fBsmartd\fP use CONTROL-\e
 .\" %IF OS Windows
-(Windows: CONTROL\-Break).
+(Windows: CONTROL-Break).
 .\" %ENDIF OS Windows
 
 On startup, in the absence of the configuration file
@@ -104,10 +107,12 @@ devices that support SMART.  The scanning is done as follows:
 Examine all entries \fB"/dev/hd[a-t]"\fP for IDE/ATA
 devices, and \fB"/dev/sd[a-z]"\fP, \fB"/dev/sd[a-c][a-z]"\fP
 for SCSI or SATA devices.
+Disks behind RAID controllers are not included.
 .\" %ENDIF OS Linux
 .\" %IF OS FreeBSD
 .IP \fBFREEBSD:\fP 9
 Authoritative list of disk devices is obtained from SCSI (CAM) and ATA subsystems.
+Disks behind RAID controllers are not included.
 .\" %ENDIF OS FreeBSD
 .\" %IF OS NetBSD OpenBSD
 .IP \fBNETBSD/OPENBSD:\fP 9
@@ -123,17 +128,11 @@ devices, and entries \fB"/dev/rmt/*"\fP for SCSI tape devices.
 .IP \fBDARWIN:\fP 9
 The IOService plane is scanned for ATA block storage devices.
 .\" %ENDIF OS Darwin
-.\" %IF OS Windows
-.IP \fBWINDOWS\ 9x/ME\fP: 9
-Examine all entries \fB"/dev/hd[a-d]"\fP (bitmask
-from "\\\\.\\SMARTVSD") for IDE/ATA devices.
-Examine all entries \fB"/dev/scsi[0\-9][0\-f]"\fP for SCSI devices 
-on ASPI adapter 0\-9, ID 0\-15.
-.\" %ENDIF OS Windows
 .\" %IF OS Windows Cygwin
-.IP \fBWINDOWS\ NT4/2000/XP/2003/Vista/Win7/2008\fP: 9
-Examine all entries \fB"/dev/sd[a-j]"\fP ("\\\\.\\PhysicalDrive[0-9]")
-for IDE/(S)ATA and SCSI disk devices 
+.IP \fBWINDOWS\fP: 9
+Examine all entries \fB"/dev/sd[a\-z]"\fP, \fB"/dev/sd[a\-c][a\-z]"\fP
+and \fB"/dev/sdd[a\-x]"\fP ("\\\\.\\PhysicalDrive[0\-127]") for
+IDE/(S)ATA and SCSI disk devices.
 
 If a 3ware 9000 controller is installed, examine all entries
 \fB"/dev/sdX,N"\fP for the first logical drive (\'unit\'
@@ -143,30 +142,24 @@ detected behind this controller. Same for a second controller if present.
 If directive \'\-d csmi\' or no \'\-d\' directive is specified,
 examine all entries \fB"/dev/csmi[0\-9],N"\fP for drives behind an Intel
 ICHxR controller with RST driver.
+
+Disks behind Areca RAID controllers are not included.
 .\" %ENDIF OS Windows Cygwin
-.\" %IF OS Cygwin
-.IP \fBCYGWIN\fP: 9
-See "WINDOWS NT4/2000/XP/2003/Vista/Win7/2008" above.
-.\" %ENDIF OS Cygwin
-.\" %IF OS OS2
-.IP \fBOS/2,eComStation\fP: 9
-Use the form \fB"/dev/hd[a\-z]"\fP for IDE/ATA devices.
-.\" %ENDIF OS OS2
 .PP
 \fBsmartd\fP then monitors
 for \fIall\fP possible SMART errors (corresponding to the \fB\'\-a\'\fP
-Directive in the configuration file; see \fBCONFIGURATION FILE\fP
-below). 
+Directive in the configuration file; see the \fBsmartd.conf\fP(5) man page).
 
 .SH 
 OPTIONS
 
 .TP
 .B \-A PREFIX, \-\-attributelog=PREFIX
-[ATA only] Writes \fBsmartd\fP attribute information (normalized and raw
-attribute values) to files \'PREFIX\'\'MODEL\-SERIAL.ata.csv\'.  At each
+Writes \fBsmartd\fP attribute information (normalized and raw
+attribute values) to files \'PREFIX\'\'MODEL\-SERIAL.ata.csv\' or \'PREFIX\'\'VENDOR\-MODEL\-SERIAL.scsi.csv\'.  At each
 check cycle attributes are logged as a line of semicolon separated triplets
 of the form "attribute-ID;attribute-norm-value;attribute-raw-value;".
+For SCSI devices error counters and temperature recorded in the form "counter-name;counter-value;"
 Each line is led by a date string of the form "yyyy-mm-dd HH:MM:SS" (in UTC).
 
 .\" %IF ENABLE_ATTRIBUTELOG
@@ -218,10 +211,10 @@ information to STDOUT rather than logging it to SYSLOG and does not
 terminal.  In this mode, \fBsmartd\fP also prints more verbose
 information about what it is doing than when operating in "daemon"
 mode. In this mode, the \fBINT\fP signal (normally generated from a
-terminal with CONTROL\-C) makes \fBsmartd\fP reload its configuration
+terminal with CONTROL-C) makes \fBsmartd\fP reload its configuration
 file.  Please use CONTROL-\e to exit
 .\" %IF OS Windows
-(Windows: CONTROL\-Break).
+(Windows: CONTROL-Break).
 
 [Windows only] The "debug" mode can be toggled by the command
 \fBsmartd sigusr2\fP. A new console for debug output is opened when
@@ -308,18 +301,12 @@ Windows: Some \fBsyslog\fP functionality is implemented
 internally in \fBsmartd\fP as follows: If no \'\-l\' option
 (or \'\-l daemon\') is specified, messages are written to Windows
 event log or to file \fB./smartd.log\fP if event log is not available
-(Win9x/ME or access denied). By specifying other values of FACILITY,
+(access denied). By specifying other values of FACILITY,
 log output is redirected as follows:
 \'\-l local0\' to file \fB./smartd.log\fP,
 \'\-l local1\' to standard output (redirect with \'>\' to any file),
 \'\-l local2\' to standard error,
 \'\-l local[3-7]\': to file \fB./smartd[1-5].log\fP.
-
-When using the event log, the enclosed utility \fBsyslogevt.exe\fP
-should be registered as an event message file to avoid error
-messages from the event viewer. Use \'\fBsyslogevt -r smartd\fP\'
-to register, \'\fBsyslogevt -u smartd\fP\' to unregister and
-\'\fBsyslogevt\fP\' for more help.
 .\" %ENDIF OS Windows
 .TP
 .B \-n, \-\-no\-fork
@@ -392,7 +379,7 @@ a list of future scheduled self tests to stdout, and then exit with zero
 exit status if all of these steps worked correctly.
 Device's SMART status is not checked.
 
-This option is intended to test whether the '-s REGEX' directives in
+This option is intended to test whether the '\-s REGEX' directives in
 smartd.conf will have the desired effect. The output lists the next test
 schedules, limited to 5 tests per type and device. This is followed by a
 summary of all tests of each device within the next 90 days.
@@ -427,17 +414,19 @@ The default level is 1, so \'\-r ataioctl,1\' and \'\-r ataioctl\' are
 equivalent.
 .TP
 .B \-s PREFIX, \-\-savestates=PREFIX
-[ATA only] Reads/writes \fBsmartd\fP state information from/to files
-\'PREFIX\'\'MODEL\-SERIAL.ata.state\'. This preserves SMART attributes, drive
-min and max temperatures (\-W directive), info about last sent warning email
+Reads/writes \fBsmartd\fP state information from/to files
+\'PREFIX\'\'MODEL\-SERIAL.ata.state\' or \'PREFIX\'\'VENDOR\-MODEL\-SERIAL.scsi.state\'. 
+This preserves SMART attributes, drive min and max temperatures (\-W directive),
+info about last sent warning email
 (\-m directive), and the time of next check of the self-test REGEXP
 (\-s directive) across boot cycles.
 
 .\" %IF ENABLE_SAVESTATES
 If this option is not specified, state information is maintained in files
-\'/usr/local/var/lib/smartmontools/smartd.MODEL\-SERIAL.ata.state\'.
+\'/usr/local/var/lib/smartmontools/smartd.MODEL\-SERIAL.ata.state\' for ATA devices and
+\'/usr/local/var/lib/smartmontools/smartd.VENDOR\-MODEL\-SERIAL.scsi.state\' for SCSI devices.
 To disable state files, specify this option with an empty string
-argument: \'-s ""\'.
+argument: \'\-s ""\'.
 .\" %ENDIF ENABLE_SAVESTATES
 MODEL and SERIAL are build from drive identify information, invalid
 characters are replaced by underline.
@@ -453,6 +442,22 @@ always (re)written after reading the configuration file, before rereading
 the configuration file (SIGHUP), before smartd shutdown, and after a check
 forced by SIGUSR1. After a normal check cycle, a file is only rewritten if
 an important change (which usually results in a SYSLOG output) occurred.
+.TP
+.B \-w PATH, \-\-warnexec=PATH
+[NEW EXPERIMENTAL SMARTD FEATURE]
+Run the executable PATH instead of the default script when smartd
+needs to send warning messages.  PATH must point to an executable binary
+file or script.
+The default script is
+.\" %IF NOT OS Windows
+\fB/usr/local/etc/smartd_warning.sh\fP.
+.\" %ENDIF NOT OS Windows
+.\" %IF OS ALL
+(Windows: EXEDIR/smartd_warning.cmd)
+.\" %ENDIF OS ALL
+.\" %IF OS Windows
+.\"! \fBEXEDIR/smartd_warning.cmd\fP.
+.\" %ENDIF OS Windows
 .\" %IF OS Windows
 .TP
 .B \-\-service
@@ -570,7 +575,7 @@ to read:
        ...;daemon.info;...          /var/adm/messages
 .fi
 Alternatively, you can use a local facility to log messages: please
-see the \fBsmartd\fP '-l' command-line option described above.
+see the \fBsmartd\fP '\-l' command-line option described above.
 
 .\" %ENDIF OS Solaris
 .\" %IF OS Cygwin
@@ -587,7 +592,7 @@ The service can be started and stopped by the start-up script as usual
 .\" %ENDIF OS Cygwin
 .\" %IF OS Windows
 On Windows, the log messages are written to the event log or to a file.
-See documentation of the '-l FACILITY' option above for details.
+See documentation of the '\-l FACILITY' option above for details.
 
 On Windows, the following built-in commands can be used to control
 \fBsmartd\fP, if running as a daemon:
@@ -609,22 +614,24 @@ The Windows Version of \fBsmartd\fP has buildin support for services:
 \'\fBsmartd install [options]\fP\' installs a service
 named "smartd" (display name "SmartD Service") using the command line
 \'/INSTALLPATH/smartd.exe \-\-service [options]\'.
+This also installs smartd.exe as a event message file for the Windows
+event viewer.
 
-\'\fBsmartd remove\fP\' can later be used to remove the service entry
-from registry.
+\'\fBsmartd remove\fP\' can later be used to remove the service and
+event message entries from the registry.
 
 Upon startup, the smartd service changes the working directory
 to its own installation path. If smartd.conf and blat.exe are stored
 in this directory, no \'-c\' option and \'-M exec\' directive is needed.
 
-The debug mode (\'-d\', \'-q onecheck\') does not work if smartd is
+The debug mode (\'\-d\', \'\-q onecheck\') does not work if smartd is
 running as service.
 
 The service can be controlled as usual with Windows commands \'net\'
 or \'sc\' (\'\fBnet start smartd\fP\', \'\fBnet stop smartd\fP\').
 
 Pausing the service (\'\fBnet pause smartd\fP\') sets the interval between
-disk checks (\'-i N\') to infinite.
+disk checks (\'\-i N\') to infinite.
 
 Continuing the paused service (\'\fBnet continue smartd\fP\') resets the
 interval and rereads the configuration file immediately (like \fBSIGHUP\fP):
@@ -671,7 +678,7 @@ Forking the daemon failed.
 Couldn\'t create PID file.
 .TP
 .B 5:
-Config file does not exist (only returned in conjunction with the \'-c\' option).
+Config file does not exist (only returned in conjunction with the \'\-c\' option).
 .TP
 .B 6:
 Config file exists, but cannot be read.
@@ -716,17 +723,21 @@ status is then 128 plus the signal number.  For example if
 is killed by SIGKILL (signal 9) then the exit status is 137.
 
 .PP
-.SH AUTHOR
-\fBBruce Allen\fP smartmontools\-support@lists.sourceforge.net
-.fi
+.SH AUTHORS
+\fBBruce Allen\fP
+.br
 University of Wisconsin \- Milwaukee Physics Department
+.br
+\fBChristian Franke\fP (Windows interface, C++ redesign, most enhancements
+since 2009)
+.br
+\fBsmartmontools\-support@lists.sourceforge.net\fP
 
 .PP
 .SH CONTRIBUTORS
 The following have made large contributions to smartmontools:
 .nf
 \fBCasper Dik\fP (Solaris SCSI interface)
-\fBChristian Franke\fP (Windows interface, C++ redesign, USB support, ...)
 \fBDouglas Gilbert\fP (SCSI subsystem)
 \fBGuido Guenther\fP (Autoconf/Automake packaging)
 \fBGeoffrey Keating\fP (Darwin ATA interface)
@@ -747,7 +758,7 @@ Many other individuals have made smaller contributions and corrections.
 .fi
 This code was derived from the smartsuite package, written by Michael
 Cornwell, and from the previous UCSC smartsuite package.  It extends
-these to cover ATA\-5 disks.  This code was originally developed as a
+these to cover ATA-5 disks.  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
@@ -768,18 +779,18 @@ REFERENCES FOR SMART
 .fi
 An introductory article about smartmontools is \fIMonitoring Hard
 Disks with SMART\fP, by Bruce Allen, Linux Journal, January 2004,
-pages 74\-77. This is \fBhttp://www.linuxjournal.com/article/6983\fP
+pages 74-77. This is \fBhttp://www.linuxjournal.com/article/6983\fP
 online.
 
 If you would like to understand better how SMART works, and what it
 does, a good place to start is with Sections 4.8 and 6.54 of the first
-volume of the \'AT Attachment with Packet Interface\-7\' (ATA/ATAPI\-7)
+volume of the \'AT Attachment with Packet Interface-7\' (ATA/ATAPI-7)
 specification Revision 4b.  This documents the SMART functionality which the
 \fBsmartmontools\fP utilities provide access to.
 
 .fi
-The functioning of SMART was originally defined by the SFF\-8035i
-revision 2 and the SFF\-8055i revision 1.4 specifications.  These are
+The functioning of SMART was originally defined by the SFF-8035i
+revision 2 and the SFF-8055i revision 1.4 specifications.  These are
 publications of the Small Form Factors (SFF) Committee.
 
 Links to these and other documents may be found on the Links page of the
@@ -788,4 +799,4 @@ Links to these and other documents may be found on the Links page of the
 
 .SH
 SVN ID OF THIS PAGE:
-$Id: smartd.8.in 3561 2012-06-05 19:49:31Z chrfranke $
+$Id: smartd.8.in 3799 2013-03-15 17:47:25Z chrfranke $