Skip to content
Snippets Groups Projects
Commit 630ec855 authored by ballen4705's avatar ballen4705
Browse files

Modified to agree with ordering of options.

git-svn-id: https://smartmontools.svn.sourceforge.net/svnroot/smartmontools/trunk@67 4ea69e1a-61f1-4043-bf83-b5c94c648137
parent b785f84e
No related branches found
No related tags found
No related merge requests found
\# Copyright (C) 2002 Bruce Allen <smartmontools-support@lists.sourceforge.net>
\#
\# $Id: smartctl.8,v 1.10 2002/10/16 07:26:00 ballen4705 Exp $
\# $Id: smartctl.8,v 1.11 2002/10/20 18:57:34 ballen4705 Exp $
\#
\# 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
......@@ -15,12 +15,11 @@
\# 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 SMARTCTL 8 "$Date: 2002/10/16 07:26:00 $" "smartmontools-5.0"
.TH SMARTCTL 8 "$Date: 2002/10/20 18:57:34 $" "smartmontools-5.0"
.SH NAME
smartctl \- S.M.A.R.T. control utility
.SH SYNOPSIS
.B smartctl
[\-\icavglLdeOSXsxAtTfF] [device]
.B smartctl \-[piaedtTfFcgvlLm][O|S|s|X|x|A] device
.SH DESCRIPTION
.B smartctl
......@@ -47,43 +46,121 @@ changers.
takes two arguments, options and device. Examples are given below.
The first argument, options, begins with a '\-' followed by
letters. Multiple options must begin with a single '\-'.
letters. Multiple options must begin with a single '\-'. The order of
the options does not matter.
The second argument is the device to be controlled. ATA devices use the
form "/dev/hd*" and SCSI devices use the form "/dev/sd*".
The second argument is the device to be controlled or
interrogated. ATA devices use the form "/dev/hd*" and SCSI devices use
the form "/dev/sd*".
SCSI devices only accept the options a,i,c,e,d, and p. For SCSI Tape
Drives and Changers with TapeAlerts support use the devices "/dev/st*"
and "/dev/sg*". TapeAlerts devices accept the options a,i,c,e,d, and
p.
The options are grouped below into several categories.
.B smartctl
will execute these in the order: INFORMATION, ENABLE/DISABLE, DISPLAY
DATA, RUN/ABORT TESTS.
.PP
.SH OPTIONS
.TP
.B Read-only options:
.B SHOW INFORMATION:
.TP
.B p
Print: Prints version, Copyright, License, home page and CVS-id
information for your copy of
.B smartctl.
Please include the CVS and version information if you are reporting
bugs or problems.
.TP
.B i
Information: Prints the disk model number, serial number,
firmware version, and ATA Standard version/revision information.
Says if the device supports S.M.A.R.T., and if so, whether
S.M.A.R.T. support is currently enabled or disabled.
.TP
.B a
All: Prints all parameters for c,i,g,v,t,l,L (for SCSI c,i). This prints all
S.M.A.R.T. information about the disk.
.TP
.B S.M.A.R.T. FEATURE ENABLE/DISABLE COMMANDS:
.IP
.B Note:
if multiple options are used to both enable and disable a
feature, then
.B both
the enable and disable commands will be issued. The enable command
will always be issued
.B before
the correponding disable command.
.TP
.B e
Enable: Enables S.M.A.R.T. on device. Note that this command (perhaps
used with with the '\-t' and '\-f' options) should be placed in a
start-up script for your machine, for example in rc.local or
rc.sysinit. In princple the S.M.A.R.T. feature settings are preserved
over power-cycling, but it doesn't hurt to be sure.
.TP
.B d
Disable: Disables S.M.A.R.T. on device. This turns off all
S.M.A.R.T. functionality. [I can't imagine why you would want to do
this. Or do you cover up the oil-pressure warning light on your car?]
.TP
.B t
Test: Enables S.M.A.R.T. automatic offline test timer which scans the drive
every four hours for disk defects. This command can be given during normal
system operation.
S.M.A.R.T. provides three basic classes of testing. The so-called 'online'
testing has no effect on the performance of the device. It
is turned on by the '\-e' option. The offline testing, enabled by
this '\-t' option, can, in principle, degrade the device performance. Normally,
the disk will suspend any offline testing while disk accesses are
taking place, then automatically resume them when the disk would
otherwise be idle, so in practice it has little effect. The third
class of testing is the 'self' testing; see below.
Any errors detected in the automatic offline testing will be shown in
the S.M.A.R.T. error log, and will be reflected in the values of the
S.M.A.R.T. attributes. These are visible with the '\-l' and '\-v'
options.
.TP
.B T
unTest: Disables S.M.A.R.T. automatic offline test timer.
.TP
.B f
File: Enables S.M.A.R.T. autosave of device vendor-specific attributes.
.TP
p
Print: Prints version, copyright and license information.
.B F
unFile: Disables S.M.A.R.T. autosave of device vendor-specific attributes.
.TP
i
Information: Check if the device supports S.M.A.R.T. Prints the
device model number, the ATA version and revision supported, and the
device serial number and firmware version.
.B S.M.A.R.T. READ AND DISPLAY DATA OPTIONS:
.TP
c
Check: See if the device has any S.M.A.R.T. Warranty Failures. If so,
this either means that the device has already failed, or that it is
predicting its own failure within the next 24 hours. If this happens,
use the '\-a' option to get more information.
.B c
Check: Ask the device to report its S.M.A.R.T. health status. It does
this using information that it has gathered from online and offline
tests, which were used to determine/update its
S.M.A.R.T. vendor-specific attribute values.
If the device reports failing health status, this means
.B either
that the device has already failed,
.B or
that it is predicting its own failure within the next 24 hours. If
this happens, use the '\-a' option to get more information, and
.B get your data off the disk and someplace safe as soon as you can.
.TP
g
Generic: Prints only the generic S.M.A.R.T. attributes. This shows the
S.M.A.R.T. capabilities of the device (can it log errors, does it
.B g
Generic: Prints only the generic S.M.A.R.T. attributes. This shows
the S.M.A.R.T. capabilities of the device (can it log errors, does it
support offline surface scanning, and so on). If the device can carry
out self-tests, it also lists the estimated time required to run those
tests. See REFERENCES below for further information about their
meaning.
.TP
v
.B v
Vendor: Prints only the vendor specific S.M.A.R.T. attributes. The
attributes are numbered from 1 to 253 and have specific names. For
example attribute 12 is 'power cycle count': how many times has the
......@@ -105,7 +182,7 @@ conventions. For example the Hitachi disk on my laptop reports its
power-on hours in minutes, not hours. Some IBM disks track three
temperatures rather than one, in their raw values. And so on.
.TP
l
.B l
Log: Prints only the S.M.A.R.T. error log. S.M.A.R.T. disks maintain
a log of the most recent five non-trivial errors. For each of these
errors, the disk power-on lifetime at which the error occurred is
......@@ -115,130 +192,105 @@ error are also recorded, along with a timestamp measured in seconds
from when the disk was powered up during the session where the error
took place. The key ATA disk registers are also recorded in the log.
.TP
L
.B L
Log: Prints only the S.M.A.R.T. self-test log. The disk maintains a
log showing the results of the self tests, which can be run using the
'\-S', '\-s', '\-X', and '\-x' options. The log will show, for each
of the most recent twenty-one self-tests, the type of test (short or
extended, off-line or captive) and the final status of the test. If
the test did not complete successfully, the percentage of the test
remaining is show. The time at which the test took place, measured in
hours of disk lifetime, is shown. If any errors were detected, the
Logical Blobk Address (LBA) of the first error is also indicated.
log showing the results of the self tests, which can be run using
the '\-S', '\-s', '\-X', and '\-x' options described below. The log will
show, for each of the most recent twenty-one self-tests, the type of
test (short or extended, off-line or captive) and the final status of
the test. If the test did not complete successfully, the percentage
of the test remaining is show. The time at which the test took place,
measured in hours of disk lifetime, is shown. If any errors were
detected, the Logical Block Address (LBA) of the first error is printed
in hexidecimal notation.
.TP
a
.B a
All: Prints all parameters for c,i,g,v,t,l,L (for SCSI c,i). This prints all
S.M.A.R.T. information about the disk.
.TP
.B Vendor-specific Attribute Display Options:
.TP
m
.B m
Minutes: The disk stores Raw Attribute number 9 (power on time) in
minutes, rather than hours. Divide by 60 before displaying it as "power
on hours" when using '\-v' or other options that display Raw values.
.TP
.B Enable/Disable Options:
.B S.M.A.R.T. RUN/ABORT OFFLINE TEST AND SELF-TEST OPTIONS:
.IP
.B Note:
only a single one of these tests can be run at a time, so no more than one
of the following options should be given on the command line.
.TP
e
Enable: Enables S.M.A.R.T. on device. Note that this command (perhaps
with the '\-t' and '\-f' options also enabled) should be placed in a
start-up script for your machine, for example in rc.local or
rc.sysinit.
.TP
d
Disable: Disables S.M.A.R.T. on device. This turns off all
S.M.A.R.T. functionality. I can't imagine why you would want to do
this. [Or do you cover up the oil-pressure warning light on your car?]
.TP
t
Test: Enables S.M.A.R.T. automatic offline test timer which scans the drive
every four hours for disk defects. This command can be given during normal
system operation.
S.M.A.R.T. provides three basic classes of testing. The so-called
'online'
testing has no effect on the performance of the device. It
is turned on by the '\-e' option. The offline testing, enabled by this
'\-t' option, can, in principle, degrade the device performance. Normally,
the disk will suspend any offline testing while disk accesses are
taking place, then automatically resume them when the disk would
otherwise be idle, so in practice it has little effect. The third
class of testing is the 'self' testing; see below.
Any errors detected in the automatic offline testing will be shown in
the S.M.A.R.T. error log, and will be reflected in the values of the
S.M.A.R.T. attributes. These are visible with the '\-l' and '\-v'
options.
.TP
T
unTest: Disables S.M.A.R.T. automatic offline test timer.
.TP
f
File: Enables S.M.A.R.T. autosave of device vendor-specific attributes.
.TP
F
unFile: Disables S.M.A.R.T. autosave of device vendor-specific attributes.
.TP
.B Run a Test Immediately Options:
.TP
O
.B O
Offline: Runs S.M.A.R.T. Immediate offline Test. This immediately
starts the test describe above. This command can be given during
normal system operation.
normal system operation. The effects of this test are visible only in
that it updates the S.M.A.R.T. attribute values, and if errors are
found they will appear in the S.M.A.R.T. error log, visible with the '\-l' option.
.TP
S
Selftest: Runs S.M.A.R.T. Short Self Test (usually under ten
minutes). This is a test in a different category than the automatic
offline tests. The 'Self' tests check the electrical and mechanical
performance as well as the read performance of the disk. Their
results are reported in the Self Test Error Log, readable with the
'\-L' option. Note that this command can be given during normal system
operation.
.B S
Selftest: Runs S.M.A.R.T. Short Self Test (usually under ten minutes).
This command can be given during normal system operation. This is a
test in a different category than the immediate or automatic offline tests.
The 'Self' tests check the electrical and mechanical performance as well
as the read performance of the disk. Their results are reported in
the Self Test Error Log, readable with the '\-L' option. Note that
the progress of the test can be monitored by watching this log during the test.
.TP
s
Selftest: Runs S.M.A.R.T. Short Self Test in Captive Mode. (WARNING: This test
will busy out drive for length of test. Only run this on drives
without any mounted partitions.)
.B s
Selftest: Runs the S.M.A.R.T. Short Self Test just described, in Captive Mode.
.B WARNING: This test may busy out the drive for the length of the test.
.B Only run this on drives without any mounted partitions.
.TP
X
.B X
eXtended: Runs S.M.A.R.T. Extended Self Test (tens of minutes). This is a
longer and more thorough version of the Short Self Test described
under the '\-x' option. Note that this command can be given during normal
under the '\-S' option. Note that this command can be given during normal
system operation.
.TP
x
eXtended: Runs S.M.A.R.T. Extended Self Test in Captive Mode. (WARNING: This
test will busy out drive for length of test. Only run this on drives
without any mounted partitions.)
.B x
eXtended: Runs the S.M.A.R.T. Extended Self Test just described, in Captive Mode.
.B WARNING: This test may busy out the drive for the length of the test.
.B Only run this on drives without any mounted partitions.
.TP
A
.B A
Abort: Aborts Non-Captive S.M.A.R.T. Self Tests.
.PP
.SH EXAMPLES
.nf
.B smartctl -a /dev/hda
.fi
prints all S.M.A.R.T. information for drive /dev/hda (Primary Master).
Print all S.M.A.R.T. information for drive /dev/hda (Primary Master).
.PP
.nf
.B smartctl -d /dev/hdd
.fi
disable S.M.A.R.T. on drive /dev/hdd (Secondary Slave).
Disable S.M.A.R.T. on drive /dev/hdd (Secondary Slave).
.PP
.nf
.B smartctl -etf /dev/hda
.fi
enables S.M.A.R.T. on drive /dev/hda, enables automatic offline
testing every four hours, and enables autosaving of
Enable S.M.A.R.T. on drive /dev/hda, enable automatic offline
testing every four hours, and enable autosaving of
S.M.A.R.T. attributes. This is a good start-up line for your system's
init files. You can issue this command on a running system.
.PP
.nf
.B smartctl -X /dev/hdc
.fi
begin an extended self-test of drive /dev/hdc. The results can be
seen in the self-test log after the test has completed. You can issue
this command on a running system.
Begin an extended self-test of drive /dev/hdc. You can issue this
command on a running system. The results can be seen in the self-test
log visible with the '\-L' option while the test is running and after
it has completed.
.PP
.nf
.B smartctl -eO /dev/hda
.fi
Enable S.M.A.R.T. on the disk, and begin an immediate offline test of
drive /dev/hda. You can issue this command on a running system. The
results uare only used to update the S.M.A.R.T. attributes, visible
with the '\-v' option. If any device errors occur, they are logged
the S.M.A.R.T. error log., which can be seen with the '\-l' option.
.PP
.nf
.B smartctl -vm /dev/hda
......@@ -320,4 +372,4 @@ Please let us know if there is an on\-line source for this document.
.SH
CVS ID OF THIS PAGE:
$Id: smartctl.8,v 1.10 2002/10/16 07:26:00 ballen4705 Exp $
$Id: smartctl.8,v 1.11 2002/10/20 18:57:34 ballen4705 Exp $
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment