Skip to content
Snippets Groups Projects
Commit d7a79de7 authored by chrfranke's avatar chrfranke
Browse files

Improve [ATA] and [SCSI] notes. 

git-svn-id: https://smartmontools.svn.sourceforge.net/svnroot/smartmontools/trunk@2803 4ea69e1a-61f1-4043-bf83-b5c94c648137
parent 605397df
Branches
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
Showing
with 38 additions and 39 deletions
sm5/smartctl.8.in
+ 38
− 39
View file @ d7a79de7
.ig .ig
Copyright (C) 2002-8 Bruce Allen <smartmontools-support@lists.sourceforge.net> Copyright (C) 2002-8 Bruce Allen <smartmontools-support@lists.sourceforge.net>
$Id: smartctl.8.in,v 1.126 2009/06/13 16:18:16 chrfranke Exp $ $Id: smartctl.8.in,v 1.127 2009/06/13 17:04:19 chrfranke Exp $
This program is free software; you can redistribute it and/or modify it 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 under the terms of the GNU General Public License as published by the Free
...@@ -644,8 +644,8 @@ this happens, use the \'\-a\' option to get more information, and ...@@ -644,8 +644,8 @@ this happens, use the \'\-a\' option to get more information, and
.B get your data off the disk and to someplace safe as soon as you can. .B get your data off the disk and to someplace safe as soon as you can.
.TP .TP
.B \-c, \-\-capabilities .B \-c, \-\-capabilities
Prints only the generic SMART capabilities. These show [ATA only] Prints only the generic SMART capabilities. These
what SMART features are implemented and how the device will show what SMART features are implemented and how the device will
respond to some of the different SMART commands. For example it respond to some of the different SMART commands. For example it
shows if the device logs errors, if it supports offline surface shows if the device logs errors, if it supports offline surface
scanning, and so on. If the device can carry out self\-tests, this scanning, and so on. If the device can carry out self\-tests, this
...@@ -661,8 +661,8 @@ for further information about the the flags and capabilities described ...@@ -661,8 +661,8 @@ for further information about the the flags and capabilities described
by this option. by this option.
.TP .TP
.B \-A, \-\-attributes .B \-A, \-\-attributes
Prints only the vendor specific SMART Attributes. The Attributes are [ATA] Prints only the vendor specific SMART Attributes. The Attributes
numbered from 1 to 253 and have specific names and ID numbers. For are numbered from 1 to 253 and have specific names and ID numbers. For
example Attribute 12 is "power cycle count": how many times has the example Attribute 12 is "power cycle count": how many times has the
disk been powered up. disk been powered up.
...@@ -743,7 +743,7 @@ Attribute fields has been made entirely vendor\-specific. However most ...@@ -743,7 +743,7 @@ Attribute fields has been made entirely vendor\-specific. However most
ATA/ATAPI\-5 disks seem to respect their meaning, so we have retained ATA/ATAPI\-5 disks seem to respect their meaning, so we have retained
the option of printing the Attribute values. the option of printing the Attribute values.
For SCSI devices the "attributes" are obtained from the temperature [SCSI] For SCSI devices the "attributes" are obtained from the temperature
and start\-stop cycle counter log pages. Certain vendor specific and start\-stop cycle counter log pages. Certain vendor specific
attributes are listed if recognised. The attributes are output in a attributes are listed if recognised. The attributes are output in a
relatively free format (compared with ATA disk attributes). relatively free format (compared with ATA disk attributes).
...@@ -754,9 +754,9 @@ Selective Self\-Test Log [ATA only], the Log Directory [ATA only], or ...@@ -754,9 +754,9 @@ Selective Self\-Test Log [ATA only], the Log Directory [ATA only], or
the Background Scan Results Log [SCSI only]. the Background Scan Results Log [SCSI only].
The valid arguments to this option are: The valid arguments to this option are:
.I error [ATA] .I error
\- prints the Summary SMART error log. SMART disks maintain a log of the \- [ATA] prints the Summary SMART error log. SMART disks maintain a log
most recent five non\-trivial errors. For each of these errors, the of the most recent five non\-trivial errors. For each of these errors, the
disk power\-on lifetime at which the error occurred is recorded, as is disk power\-on lifetime at which the error occurred is recorded, as is
the device status (idle, standby, etc) at the time of the error. For the device status (idle, standby, etc) at the time of the error. For
some common types of errors, the Error Register (ER) and Status some common types of errors, the Error Register (ER) and Status
...@@ -829,12 +829,12 @@ Please note that some manufacturers \fBignore\fP the ATA ...@@ -829,12 +829,12 @@ Please note that some manufacturers \fBignore\fP the ATA
specifications, and make entries in the error log if the device specifications, and make entries in the error log if the device
receives a command which is not implemented or is not valid. receives a command which is not implemented or is not valid.
.I error [SCSI] .I error
\- prints the error counter log pages for reads, write and verifies. \- [SCSI] prints the error counter log pages for reads, write and verifies.
The verify row is only output if it has an element other than zero. The verify row is only output if it has an element other than zero.
.I xerror[,NUM] [ATA] .I xerror[,NUM]
\- [NEW EXPERIMENTAL SMARTCTL FEATURE] prints the Extended \- [ATA only] [NEW EXPERIMENTAL SMARTCTL FEATURE] prints the Extended
Comprehensive SMART error log (General Purpose Log address 0x03). Comprehensive SMART error log (General Purpose Log address 0x03).
Unlike the Summary SMART error log (see \'\-l error\' above), Unlike the Summary SMART error log (see \'\-l error\' above),
it provides sufficient space to log the contents of the 48-bit it provides sufficient space to log the contents of the 48-bit
...@@ -847,8 +847,8 @@ If the optional parameter NUM is specified, only the NUM most ...@@ -847,8 +847,8 @@ If the optional parameter NUM is specified, only the NUM most
recent log entries are printed. Otherwise, all entries are printed. recent log entries are printed. Otherwise, all entries are printed.
.I selftest .I selftest
\- prints the SMART self\-test log. The disk maintains a self\-test log \- [ATA] prints the SMART self\-test log. The disk maintains a self\-test
showing the results of the self tests, which can be run using the log showing the results of the self tests, which can be run using the
\'\-t\' option described below. For each of the most recent \'\-t\' option described below. For each of the most recent
twenty\-one self\-tests, the log shows the type of test (short or twenty\-one self\-tests, the log shows the type of test (short or
extended, off\-line or captive) and the final status of the test. If extended, off\-line or captive) and the final status of the test. If
...@@ -860,9 +860,9 @@ printed in decimal notation. On Linux systems the smartmontools ...@@ -860,9 +860,9 @@ printed in decimal notation. On Linux systems the smartmontools
web page has instructions about how to convert this LBA address to the web page has instructions about how to convert this LBA address to the
name of the disk file containing the erroneous block. name of the disk file containing the erroneous block.
.I selftest [SCSI] .I selftest
\- the self\-test log for a SCSI device has a slightly different format \- [SCSI] the self\-test log for a SCSI device has a slightly different
than for an ATA device. For each of the most recent twenty format than for an ATA device. For each of the most recent twenty
self\-tests, it shows the type of test and the status (final or in self\-tests, it shows the type of test and the status (final or in
progress) of the test. SCSI standards use the terms "foreground" and progress) of the test. SCSI standards use the terms "foreground" and
"background" (rather than ATA\'s corresponding "captive" and "background" (rather than ATA\'s corresponding "captive" and
...@@ -882,9 +882,9 @@ Additional Sense Code Qualifier (ASQ) are also printed. The self tests ...@@ -882,9 +882,9 @@ Additional Sense Code Qualifier (ASQ) are also printed. The self tests
can be run using the \'\-t\' option described below (using the ATA can be run using the \'\-t\' option described below (using the ATA
test terminology). test terminology).
.I xselftest[,NUM] [ATA] .I xselftest[,NUM]
\- [NEW EXPERIMENTAL SMARTCTL FEATURE] prints the Extended SMART \- [ATA only] [NEW EXPERIMENTAL SMARTCTL FEATURE] prints the Extended
self\-test log (General Purpose Log address 0x07). Unlike the SMART SMART self\-test log (General Purpose Log address 0x07). Unlike the SMART
self\-test log (see \'\-l selftest\' above), it supports 48-bit LBA self\-test log (see \'\-l selftest\' above), it supports 48-bit LBA
and logs with more than one sector. Each sector holds up to 19 log and logs with more than one sector. Each sector holds up to 19 log
entries. The actual number of log sectors is vendor specific, typical entries. The actual number of log sectors is vendor specific, typical
...@@ -893,9 +893,8 @@ values are 1 (Seagate) or 2 (Samsung). ...@@ -893,9 +893,8 @@ values are 1 (Seagate) or 2 (Samsung).
If the optional parameter NUM is specified, only the NUM most If the optional parameter NUM is specified, only the NUM most
recent log entries are printed. Otherwise, all entries are printed. recent log entries are printed. Otherwise, all entries are printed.
.I selective [ATA] .I selective
\- Some ATA\-7 disks (example: Maxtor) also maintain a selective \- [ATA only] Please see the \'\-t select\' option below for a
self\-test log. Please see the \'\-t select\' option below for a
description of selective self\-tests. The selective self\-test log description of selective self\-tests. The selective self\-test log
shows the start/end Logical Block Addresses (LBA) of each of the five shows the start/end Logical Block Addresses (LBA) of each of the five
test spans, and their current test status. If the span is being test spans, and their current test status. If the span is being
...@@ -909,9 +908,9 @@ delay before restarting this read\-scan if it is interrupted (see ...@@ -909,9 +908,9 @@ delay before restarting this read\-scan if it is interrupted (see
report unusual or incorrect behavior to the smartmontools\-support report unusual or incorrect behavior to the smartmontools\-support
mailing list. mailing list.
.I directory[,gs] [ATA] .I directory[,gs]
\- if the device supports the General Purpose Logging feature set \- [ATA only] if the device supports the General Purpose Logging feature
(ATA\-6 to ATA\-8 only) then this prints the Log Directory (the log at set (ATA\-6 and above) then this prints the Log Directory (the log at
address 0). The Log Directory shows what logs are available and their address 0). The Log Directory shows what logs are available and their
length in sectors (512 bytes). The contents of the logs at address 1 length in sectors (512 bytes). The contents of the logs at address 1
[Summary SMART error log] and at address 6 [SMART self\-test log] may [Summary SMART error log] and at address 6 [SMART self\-test log] may
...@@ -925,10 +924,10 @@ General Purpose Log (GPL) and SMART Log (SL) directories are printed in ...@@ -925,10 +924,10 @@ General Purpose Log (GPL) and SMART Log (SL) directories are printed in
one combined table. The output can be restricted to the GPL directory or one combined table. The output can be restricted to the GPL directory or
SL directory by \'\-l directory,q\' or \'\-l directory,s\' respectively. SL directory by \'\-l directory,q\' or \'\-l directory,s\' respectively.
.I background [SCSI] .I background
\- the background scan results log outputs information derived from \- [SCSI only] the background scan results log outputs information derived
Background Media Scans (BMS) done after power up and/or periodocally (e.g. from Background Media Scans (BMS) done after power up and/or periodocally
every 24 hours) on recent SCSI disks. If supported, the BMS status (e.g. every 24 hours) on recent SCSI disks. If supported, the BMS status
is output first, indicating whether a background scan is currently is output first, indicating whether a background scan is currently
underway (and if so a progress percentage), the amount of time the disk underway (and if so a progress percentage), the amount of time the disk
has been powered up and the number of scans already completed. Then there has been powered up and the number of scans already completed. Then there
...@@ -951,13 +950,13 @@ The SCT commands are specified in the proposed ATA\-8 Command Set ...@@ -951,13 +950,13 @@ The SCT commands are specified in the proposed ATA\-8 Command Set
(ACS), and are already implemented in some recent ATA\-7 disks. (ACS), and are already implemented in some recent ATA\-7 disks.
.I sataphy[,reset] .I sataphy[,reset]
\- [SATA ONLY] [NEW EXPERIMENTAL SMARTCTL FEATURE] prints values \- [SATA only] [NEW EXPERIMENTAL SMARTCTL FEATURE] prints values
and descriptions of the SATA Phy Event Counters (General Purpose Log and descriptions of the SATA Phy Event Counters (General Purpose Log
address 0x11). If \'\-l sataphy,reset\' is specified, all counters address 0x11). If \'\-l sataphy,reset\' is specified, all counters
are reset after reading the values. are reset after reading the values.
.I gplog,ADDR[,FIRST[\-LAST|+SIZE]] .I gplog,ADDR[,FIRST[\-LAST|+SIZE]]
\- [ATA ONLY] [NEW EXPERIMENTAL SMARTCTL FEATURE] prints a hex dump \- [ATA only] [NEW EXPERIMENTAL SMARTCTL FEATURE] prints a hex dump
of any log accessible via General Purpose Logging (GPL) feature. of any log accessible via General Purpose Logging (GPL) feature.
The log address ADDR is the hex address listed in the log directory The log address ADDR is the hex address listed in the log directory
(see \'\-l directory\' above). The range of log sectors (pages) can (see \'\-l directory\' above). The range of log sectors (pages) can
...@@ -966,7 +965,7 @@ defaults to 0, SIZE defaults to 1. LAST can be set to \'max\' to ...@@ -966,7 +965,7 @@ defaults to 0, SIZE defaults to 1. LAST can be set to \'max\' to
specify the last page of the log. specify the last page of the log.
.I smartlog,ADDR[,FIRST[\-LAST|+SIZE]] .I smartlog,ADDR[,FIRST[\-LAST|+SIZE]]
\- [ATA ONLY] [NEW EXPERIMENTAL SMARTCTL FEATURE] prints a hex dump \- [ATA only] [NEW EXPERIMENTAL SMARTCTL FEATURE] prints a hex dump
of any log accessible via SMART Read Log command. See of any log accessible via SMART Read Log command. See
\'\-l gplog,...\' above for parameter syntax. \'\-l gplog,...\' above for parameter syntax.
...@@ -1286,7 +1285,7 @@ above. Note that this command can be given during normal ...@@ -1286,7 +1285,7 @@ above. Note that this command can be given during normal
system operation (unless run in captive mode \- see the \'\-C\' option below). system operation (unless run in captive mode \- see the \'\-C\' option below).
.I conveyance .I conveyance
\- [ATA ONLY] runs a SMART Conveyance Self Test (minutes). This \- [ATA only] runs a SMART Conveyance Self Test (minutes). This
self\-test routine is intended to identify damage incurred during self\-test routine is intended to identify damage incurred during
transporting of the device. This self\-test routine should take on the transporting of the device. This self\-test routine should take on the
order of minutes to complete. Note that this command can be given order of minutes to complete. Note that this command can be given
...@@ -1393,7 +1392,7 @@ that the last test was aborted by the host. Otherwise it run the \'next\' ...@@ -1393,7 +1392,7 @@ that the last test was aborted by the host. Otherwise it run the \'next\'
(above) test. (above) test.
.I afterselect,on .I afterselect,on
\- [ATA ONLY] perform an offline read scan after a Selective Self\-test \- [ATA only] perform an offline read scan after a Selective Self\-test
has completed. This option must be used together with one or more of has completed. This option must be used together with one or more of
the \fIselect,N\-M\fP options above. If the LBAs that have been the \fIselect,N\-M\fP options above. If the LBAs that have been
specified in the Selective self\-test pass the test with no errors specified in the Selective self\-test pass the test with no errors
...@@ -1404,13 +1403,13 @@ timer (see below). The value of this option is preserved between ...@@ -1404,13 +1403,13 @@ timer (see below). The value of this option is preserved between
selective self\-tests. selective self\-tests.
.I afterselect,off .I afterselect,off
\- [ATA ONLY] do not read scan the remainder of the disk after a \- [ATA only] do not read scan the remainder of the disk after a
Selective self\-test has completed. This option must be use together Selective self\-test has completed. This option must be use together
with one or more of the \fIselect,N\-M\fP options above. The value of this with one or more of the \fIselect,N\-M\fP options above. The value of this
option is preserved between selective self\-tests. option is preserved between selective self\-tests.
.I pending,N .I pending,N
\- [ATA ONLY] set the pending offline read scan timer to N minutes. \- [ATA only] set the pending offline read scan timer to N minutes.
Here N is an integer in the range from 0 to 65535 inclusive. If the Here N is an integer in the range from 0 to 65535 inclusive. If the
device is powered off during a read scan after a Selective self\-test, device is powered off during a read scan after a Selective self\-test,
then resume the test automatically N minutes after power\-up. This then resume the test automatically N minutes after power\-up. This
...@@ -1687,7 +1686,7 @@ these documents may be found in the References section of the ...@@ -1687,7 +1686,7 @@ these documents may be found in the References section of the
.SH .SH
CVS ID OF THIS PAGE: CVS ID OF THIS PAGE:
$Id: smartctl.8.in,v 1.126 2009/06/13 16:18:16 chrfranke Exp $ $Id: smartctl.8.in,v 1.127 2009/06/13 17:04:19 chrfranke Exp $
.\" Local Variables: .\" Local Variables:
.\" mode: nroff .\" mode: nroff
.\" End: .\" End:
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment

AEI Privacy Policy Imprint