From f014cd2f0fec05919f9d120123d8ab5a6bc738a9 Mon Sep 17 00:00:00 2001
From: pjwilliams <pjwilliams@4ea69e1a-61f1-4043-bf83-b5c94c648137>
Date: Sat, 28 Dec 2002 16:16:52 +0000
Subject: [PATCH] Updated documentation for new smartctl options.
git-svn-id: https://smartmontools.svn.sourceforge.net/svnroot/smartmontools/trunk@384 4ea69e1a-61f1-4043-bf83-b5c94c648137
---
sm5/CHANGELOG | 6 +-
sm5/README | 26 ++-
sm5/smartctl.8 | 427 ++++++++++++++++++++++++++-----------------------
3 files changed, 239 insertions(+), 220 deletions(-)
diff --git a/sm5/CHANGELOG b/sm5/CHANGELOG
index cc87a8f57..fca1a008e 100644
--- a/sm5/CHANGELOG
+++ b/sm5/CHANGELOG
@@ -1,6 +1,6 @@
CHANGELOG for smartmontools
-$Id: CHANGELOG,v 1.70 2002/12/16 12:27:00 ballen4705 Exp $
+$Id: CHANGELOG,v 1.71 2002/12/28 16:16:52 pjwilliams Exp $
Copyright (C) 2002 Bruce Allen <smartmontools-support@lists.sourceforge.net>
@@ -32,7 +32,9 @@ NOTES FOR FUTURE RELEASES: see TODO file.
CURRENT RELEASE (see VERSION file in this directory):
- ]BA] Use strerror() to generate system call error messages.
+ [PW] Changed options for smartctl -- see man page.
+
+ [BA] Use strerror() to generate system call error messages.
[BA] smartd: fflush() all open streams before fork().
diff --git a/sm5/README b/sm5/README
index 2cd6c3573..435c2169d 100644
--- a/sm5/README
+++ b/sm5/README
@@ -103,10 +103,9 @@ Source and binary RPM files are available at the website listed above.
PLEASE READ THE MANUAL PAGES FOR SMARTCTL AND SMARTD FOR MORE INFORMATION.
-== PROPOSED OPTION NAMES FOR SMARTCTL ==
-The following is a list of proposed options to replace the existing options in
-smartctl. If you have any comments or would like to suggest improvements then
-please post to the smartmontools mailing list.
+== NEW OPTION NAMES FOR SMARTCTL 5.1 ==
+The following is a synopsis of the new options in smartctl 5.1 -- please see the
+man page for more information.
-h, --help, --usage
Show usage and syntax help
@@ -180,12 +179,13 @@ please post to the smartmontools mailing list.
-X, --abort
Abort any non-captive test
-The following table shows the mapping of old options to new options:
+The following table shows the mapping of old to new smartctl options and of
+old to new smartd.conf directives:
-------------------------------------------------------------------------------------------------------------------
Old option New short option New long option smartd.conf smartd.conf
- Versions <= Versions >= Versions >= DIRECTIVE DIRECTIVE
- 5.0-X 5.0-Y 5.0-Y <= 5.0-X >= 5.0-Y
+ Versions <= Versions >= 5.1 Versions >= 5.1 DIRECTIVE DIRECTIVE
+ 5.0 <= 5.0 >= 5.1
-------------------------------------------------------------------------------------------------------------------
-h, -? -h, -? --help
-V -V --version, --copyright, --license
@@ -234,10 +234,10 @@ The following table shows the mapping of old options to new options:
\ Line continuation \
-------------------------------------------------------------------------------------------------------------------
-Suggested changes to smartd options:
+Changes to smartd options (not yet implemented):
----------------------------------------------------------------------------------------------------------
- 5.0.x short 5.0.x long 5.1.x short 5.1.x long
+ 5.0 short 5.0 long 5.1 short 5.1 long
option option option option
----------------------------------------------------------------------------------------------------------
-h, -? --help -h, -? --help
@@ -246,11 +246,3 @@ Suggested changes to smartd options:
-i N --interval=N
----------------------------------------------------------------------------------------------------------
-Suggested change order (CVS commit at least after each of these):
-Modify smartctl command-line options
-Modify smartctl man page, README file, CHANGELOG
-Modify smartmontools index.html page to warn users of change in syntax, point to end of README file
-Modify smartd to take -C out of config file, put onto command line
-Modify smartd and smartd.conf man pages, README file, CHANGELOG
-Modify smartd Directive names, parsing
-Modify smartd and smartd.conf man pages, README file, CHANGELOG, example smartd.conf configuration file
diff --git a/sm5/smartctl.8 b/sm5/smartctl.8
index cdce96cfa..01ab6b1c1 100644
--- a/sm5/smartctl.8
+++ b/sm5/smartctl.8
@@ -1,6 +1,6 @@
\# Copyright (C) 2002 Bruce Allen <smartmontools-support@lists.sourceforge.net>
\#
-\# $Id: smartctl.8,v 1.29 2002/11/27 13:58:30 ballen4705 Exp $
+\# $Id: smartctl.8,v 1.30 2002/12/28 16:16:52 pjwilliams 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
@@ -16,11 +16,11 @@
\# Research Center), Jack Baskin School of Engineering, University of
\# California, Santa Cruz. http://ssrc.soe.ucsc.edu/
\#
-.TH SMARTCTL 8 "$Date: 2002/11/27 13:58:30 $" "smartmontools-5.0"
+.TH SMARTCTL 8 "$Date: 2002/12/28 16:16:52 $" "smartmontools-5.0"
.SH NAME
smartctl \- S.M.A.R.T. control and monitor utility
.SH SYNOPSIS
-.B smartctl \-[ViaqQnNPUWedtTfFcgvlLm[O|S|s|X|x|A]] device
+.B smartctl [options] device
.SH DESCRIPTION
.B smartctl
@@ -44,122 +44,141 @@ drive are ignored and return an error.
.B smartctl
also provides limited TapeAlerts support for some SCSI tape drives and
changers.
-.PP
-.SH SYNTAX
-.PP
-.B smartctl
-takes a string of (optional) arguments followed by a mandatory device
-name. Examples are given below.
-The option arguments begin with a '\-' followed by letters. Multiple
-options may begin with a single '\-', or each option may have its own '\-'.
-The order of the options does not matter.
-
-The final argument is the device to be controlled or interrogated. ATA
-devices use the form "/dev/hd*" and SCSI devices use the form "/dev/sd*".
-More general paths may also be specified.
-.B Smartctl
-will attempt to guess the device type. If needed, use the '\-n' and '\-N'
-options respectively for specifying ATA and SCSI device type.
+The user must specify the device to be controlled or interrogated as an
+argument to
+.B smartctl.
+ATA devices use the form "/dev/hd*" and SCSI devices use the form "/dev/sd*".
+For SCSI Tape Drives and Changers with TapeAlerts support use the devices
+"/dev/st*" and "/dev/sg*". More general paths may also be specified.
+.B smartctl
+will attempt to guess the device type, but the '\-d' option can be used to
+specify a device type of ATA or SCSI if required.
-SCSI devices only accept the options
-.B \-a, \-i, \-c, \-e, \-d, \-O, \-s, \-S, \-x, \-X, \-A, \-N
-and
-.B \-V.
-For SCSI Tape Drives and Changers with TapeAlerts support use
-the devices "/dev/st*" and "/dev/sg*". TapeAlerts devices accept the
-options
-.B \-a, \-i, \-c, \-e, \-d, \-N
-and
-.B \-V.
+.PP
+.SH OPTIONS
+.PP
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
+SCSI devices only accept the options
+.B \-h, \-?, \-V, \-i, \-a, \-d, \-s, \-H, \-t, \-C
+and
+.B \-X.
+TapeAlerts devices only accept the options
+.B \-h, \-?, \-V, \-i, \-a, \-d, \-s
+and
+.B \-H.
+
+Long options are not supported on all systems. Use
+.B 'smartd \-h'
+to see the available options.
+
.TP
.B SHOW INFORMATION:
.TP
-.B \-V
-Version: Prints version, Copyright, License, home page and CVS-id
-information for your copy of
+.B \-h, \-\-help, \-\-usage
+Prints a usage message and exits.
+.TP
+.B \-?
+Same as
+.B \-h.
+.TP
+.B \-V, \-\-version, \-\-copyright, \-\-license
+Prints version, copyright, license, home page and CVS-id information for your
+copy of
.B smartctl.
-Please include this information if you are reporting
-bugs or problems.
+Please include this 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.
+.B \-i, \-\-info
+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.
+.B \-a, \-\-all
+Prints all S.M.A.R.T. information about the disk. This is equivalent to '\-H
+\-i \-c \-A \-l error \-l selftest' (for SCSI, '\-H \-i').
.TP
.B RUN-TIME BEHAVIOR:
.TP
-.B \-q
-Quiet mode: Only print: For the '\-l' option, if nonzero, the number
+.B \-q TYPE, \-\-quietmode=TYPE
+Specifies that
+.B smartctl
+should run in one of the two quiet modes described here. The valid arguments
+to this option are:
+
+.I errorsonly
+\- only print: For the '\-l error' option, if nonzero, the number
of errors recorded in the SMART error log and the power-on time when
-they occured; For the '\-L' option, errors recorded in the device
-self-test log; For the '\-c' SMART "disk failing" status or device
+they occurred; For the '\-l selftest' option, errors recorded in the device
+self-test log; For the '\-H' option, SMART "disk failing" status or device
attributes (pre-failure or usage) which failed either now or in the
-past; For the '\-v' option device attributes (pre-failure or usage)
+past; For the '\-A' option, device attributes (pre-failure or usage)
which failed either now or in the past.
-.TP
-.B \-Q
-Very Quiet mode: Print no ouput. The only way to learn about what was
+
+.I silent
+\- print no output. The only way to learn about what was
found is to use the exit status of
.B smartctl
(see RETURN VALUES below).
.TP
-.B \-n
-NotSCSI: Device is an ATA device.
-.TP
-.B \-N
-NotATA: Device is a SCSI device. If neither this nor the previous
-option are specified, then
-.B smartctl
-will attempt to guess the device type from the device name. You can
-use this option or the previous option to force the type.
-.TP
-.B \-P
-Permissive: If a mandatory S.M.A.R.T. command to the
-disk fails, do
-.I not
-exit, but carry on in spite of it. Normally (without this option
-enabled)
+.B \-d TYPE, \-\-device=TYPE
+Specifies the type of the device. The valid arguments to this option are
+.I ata
+and
+.I scsi.
+If this option is not used then
.B smartctl
-would exit with an error if a mandatory command failed. Here 'mandatory'
-means "Required by the ATA/ATAPI-5 Specification if the
-device implements the S.M.A.R.T. command set." The 'mandatory'
-S.M.A.R.T. commands are: (1) Enable/Disable Attribute Autosave, (2)
-Enable/Disable S.M.A.R.T., and (3) S.M.A.R.T. Return Status.
-.TP
-.B \-U
-Ultraconservative: Exit
-.B smartctl
-immediately if an optional S.M.A.R.T. command to the disk fails.
-Normally (without this option enabled)
+will attempt to guess the device type from the device name.
+.TP
+.B \-T TYPE, \-\-tolerance=TYPE
+Specifies how tolerant
.B smartctl
-would just carry on if an optional command fails. Here "optional"
-means "Not required by the ATA/ATAPI-5 Specification even if the
-device implements the S.M.A.R.T. command set."
+should be of S.M.A.R.T. command failures. The valid arguments to this option
+are:
+
+.I normal
+\- exit on failure of a mandatory S.M.A.R.T. command, but not on failure of an
+optional S.M.A.R.T. command. This is the default.
+
+.I conservative
+\- exit on failure of any S.M.A.R.T. command.
+
+.I permissive
+\- ignore failure of any S.M.A.R.T. command.
+
+Here "mandatory" means "required by the ATA/ATAPI-5 Specification if the
+device implements the S.M.A.R.T. command set" and "optional" means "not
+required by the ATA/ATAPI-5 Specification even if the device implements
+the S.M.A.R.T. command set." The 'mandatory' S.M.A.R.T. commands are: (1)
+Enable/Disable Attribute Autosave, (2) Enable/Disable S.M.A.R.T., and (3)
+S.M.A.R.T. Return Status.
+
.TP
-.B \-W
-Warning: Exit
+.B \-b TYPE, \-\-badsum=TYPE
+Specifies the action
.B smartctl
-immediately if a checksum error is detected in the: (1) Device
+should take if a checksum error is detected in the: (1) Device
Identity Structure, (2) S.M.A.R.T. Self-Test Log Structure, (3)
S.M.A.R.T. Attribute Value Structure, (4) S.M.A.R.T. Attribute
-Threshold Structure, or (5) ATA Error Log Structure. Normally
-(without this option enabled)
-.B smartctl
-will report the incorrect checksum but will carry on in spite of it.
+Threshold Structure, or (5) ATA Error Log Structure.
+
+The valid arguments to this option are:
+
+.I warn
+\- report the incorrect checksum but carry on in spite of it. This is the
+default.
+
+.I exit
+\- exit
+.B smartctl.
+
+.I ignore
+\- continue silently without issuing a warning.
+
.TP
.B S.M.A.R.T. FEATURE ENABLE/DISABLE COMMANDS:
.IP
@@ -170,24 +189,27 @@ feature, then
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 which scans the drive
+the corresponding disable command.
+.TP
+.B \-s VALUE, \-\-smart=VALUE
+Enables or disables S.M.A.R.T. on device. The valid arguments to
+this option are
+.I on
+and
+.I off.
+Note that the command '\-s on' (perhaps
+used with with the '\-o on' and '\-S on' options) should be placed in a
+start-up script for your machine, for example in rc.local or rc.sysinit.
+In principle the S.M.A.R.T. feature settings are preserved over
+power-cycling, but it doesn't hurt to be sure.
+.TP
+.B \-o VALUE, \-\-offlineauto=VALUE
+Enables or disables S.M.A.R.T. automatic offline test, which scans the drive
every four hours for disk defects. This command can be given during normal
-system operation.
+system operation. The valid arguments to this option are
+.I on
+and
+.I off.
Note that the S.M.A.R.T. automatic offline test command is listed as 'Obsolete'
in every version of the ATA and ATA/ATAPI Specifications
@@ -202,35 +224,34 @@ S.M.A.R.T. provides
The
.B first category,
called 'online' testing, has no effect on the performance of
-the device. It is turned on by the '\-e' option.
+the device. It is turned on by the '\-s on' option.
The
.B second category of testing
is called 'offline' testing. This type
-of test can, in principle, degrade the device performance. The '\-t'
+of test can, in principle, degrade the device performance. The '\-o on'
option causes this offline testing to be carried out, automatically,
on a regular scheduled basis. 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. Note that a one-time offline test can
also be carried out immediately upon receipt of a user command. See
-the '\-O' option below, which causes a one-time offline test to be
+the '\-t offline' option below, which causes a one-time offline test to be
carried out immediately.
Any errors detected in automatic or immediate 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.
+of the S.M.A.R.T. attributes. These are visible with the '\-l error' and '\-A' options.
The
.B third category of testing
is the 'self' testing. This third type of
test is only performed (immediately) when a command to run it is
-issued. The '\-S', '\-s', '\-X', '\-x', and '\-A' options below can
-be used to carry out (and abort) such self-tests; please see below for further
-details.
+issued. The '\-t' and '\-X' options can be used to carry out and abort such
+self-tests; please see below for further details.
Any errors detected in the self testing will be shown in the
-S.M.A.R.T. self-test log, which can be examined using the '\-L'
+S.M.A.R.T. self-test log, which can be examined using the '\-l selftest'
option.
.B Note:
@@ -241,22 +262,18 @@ just described, e.g. for the 'offline' testing. The words
.B "Self-test"
are used in connection with the third category.
.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. Note that this feature is preserved across disk power
-cycles, so you should only need to issue it once.
-.TP
-.B \-F
-unFile: Disables S.M.A.R.T. autosave of device vendor-specific
-attributes. Note that this feature is preserved across disk power
-cycles, so you should only need to issue it once.
+.B \-S VALUE, \-\-saveauto=VALUE
+Enables or disables S.M.A.R.T. autosave of device vendor-specific
+attributes. The valid arguments to this option are
+.I on
+and
+.I off.
+Note that this feature is preserved across disk power cycles, so you should only
+need to issue it once.
.TP
.B S.M.A.R.T. READ AND DISPLAY DATA OPTIONS:
.TP
-.B \-c
+.B \-H, \-\-health
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
@@ -270,25 +287,25 @@ 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
-.B \-g
-Generic: Prints only the generic S.M.A.R.T. capabilities. These show
+.B \-c, \-\-capabilities
+Prints only the generic S.M.A.R.T. capabilities. These show
what S.M.A.R.T. features are implemented and how the device will
respond to some of the different S.M.A.R.T. commands. For example it
-shows if the device logs errors, if it support 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
option also shows the estimated time required to run those tests.
Note that the time required to run the Self-tests (listed in minutes)
are fixed. However the time required to run the Immediate Offline
Test (listed in seconds) is variable. This means that if you issue a
-command to perform an Immediate Offline test with the '\-O' option,
+command to perform an Immediate Offline test with the '\-t offline' option,
then the time may jump to a larger value and then count down as the
Immediate Offline Test is carried out. Please see REFERENCES below
for further information about the the flags and capabilities described
by this option.
.TP
-.B \-v
-Vendor: Prints only the vendor specific S.M.A.R.T. attributes. The
+.B \-A, \-\-attributes
+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
disk been powered up. Each attribute has a 'Raw' value, printed under
@@ -326,8 +343,12 @@ attribute fields has been made entirely vendor-specific. However most
ATA/ATAPI-5 disks seem to respect their meaning, so we have retained
this option.
.TP
-.B \-l
-Log: Prints only the S.M.A.R.T. error log. S.M.A.R.T. disks maintain
+.B \-l TYPE, \-\-log=TYPE
+Prints either the S.M.A.R.T. error log or the S.M.A.R.T. self-test log. The
+valid arguments to this option are:
+
+.I error
+\- 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
recorded, as is the device status (idle, standby, etc) at the time of
@@ -337,99 +358,103 @@ from when the disk was powered up during the session where the error
took place. [Note: this time stamp wraps after 2^32 milliseconds, or
49 days 17 hours 2 minutes and 47.296 seconds.]
The key ATA disk registers are also recorded in the log.
-.TP
-.B \-L
-Log: Prints only the S.M.A.R.T. self-test log. The disk maintains a
+
+.I selftest
+\- 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 described below. The log will
-show, for each of the most recent twenty-one self-tests, the type of
+the '\-t' option 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
-.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:
+in hexadecimal notation.
+
.TP
-.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.
+.B \-v N,OPTION, \-\-vendorattribute=N,OPTION
+Sets a vendor-specific display OPTION for attribute N. There is currently only
+one valid argument to this option:
+
+.I 9,minutes
+\- the disk stores Raw Attribute number 9 (power on time) in
+minutes rather than hours, so divide by 60 before displaying it.
+
.TP
.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
-.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
+.B \-t TEST, \-\-test=TEST
+Executes TEST immediately. The '\-C' option can be used in conjunction
+with this option to run the short or long self-tests in captive mode.
+Note that only one test can be run at a time, so this option should only
+be used once per command line.
+
+The valid arguments to this option are:
+
+.I offline
+\- runs S.M.A.R.T. Immediate Offline Test. This immediately
+starts the test described above. This command can be given during
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.
+found they will appear in the S.M.A.R.T. error log, visible with the '\-l error'
+option.
-If the '\-g' option to
+If the '\-c' option to
.B smartctl
shows that the device has the "Suspend Offline collection upon new
command" capability then you can track the progress of the Immediate Offline
-test using the '\-g' option to
+test using the '\-c' option to
.B smartctl.
-If the '\-g' option show that the device has the "Abort Offline
+If the '\-c' option show that the device has the "Abort Offline
collection upon new command" capability then most commands will abort
the Immediate Offline Test, so you should not try to track the
-progress of the test with '\-g', as it will abort the test.
-.TP
-.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
+progress of the test with '\-c', as it will abort the test.
+
+.I short
+\- runs S.M.A.R.T. Short Self Test (usually under ten minutes).
+This command can be given during normal system operation (unless run in
+captive mode \- see the '\-C' option below). 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 on some disks the progress of the test can be
-monitored by watching this log during the test; with other disks use
-the '\-g option to monitor progress.
-.TP
-.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
-.B \-X
-eXtended: Runs S.M.A.R.T. Extended Self Test (tens of minutes). This is a
+the '\-l selftest' option. Note that on some disks the progress of the
+test can be monitored by watching this log during the test; with other disks
+use the '\-c' option to monitor progress.
+
+.I long
+\- 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 '\-S' option. Note that this command can be given during normal
-system operation.
+above. Note that this command can be given during normal
+system operation (unless run in captive mode \- see the '\-C' option below).
+
.TP
-.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.
+.B \-C, \-\-captive
+With '\-t short' or '\-t long', runs the self-test in captive mode. This has
+no effect with '\-t offline' or if the '\-t' option is not used.
+
+.B WARNING: Tests run in captive mode may busy out the drive for the length
+.B of the test. Only run this on drives without any mounted partitions.
+
.TP
-.B \-A
-Abort: Aborts Non-Captive S.M.A.R.T. Self Tests. Note that this
+.B \-X, \-\-abort
+Aborts non-captive S.M.A.R.T. Self Tests. Note that this
command will abort the Offline Immediate Test routine only if your
disk has the "Abort Offline collection upon new command" capability.
.PP
.SH EXAMPLES
.nf
-.B smartctl -a /dev/hda
+.B smartctl \-a /dev/hda
.fi
Print all S.M.A.R.T. information for drive /dev/hda (Primary Master).
.PP
.nf
-.B smartctl -d /dev/hdd
+.B smartctl \-s off /dev/hdd
.fi
Disable S.M.A.R.T. on drive /dev/hdd (Secondary Slave).
.PP
.nf
-.B smartctl -etf /dev/hda
+.B smartctl \-\-smart=on \-\-offlineauto=on \-\-saveauto=on /dev/hda
.fi
Enable S.M.A.R.T. on drive /dev/hda, enable automatic offline
testing every four hours, and enable autosaving of
@@ -437,35 +462,35 @@ 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
+.B smartctl \-t long /dev/hdc
.fi
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 after it has completed.
+log visible with the '\-l selftest' option after it has completed.
.PP
.nf
-.B smartctl -eO /dev/hda
+.B smartctl \-s on \-t offline /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.
+results are only used to update the S.M.A.R.T. attributes, visible
+with the '\-A' option. If any device errors occur, they are logged to
+the S.M.A.R.T. error log, which can be seen with the '\-l error' option.
.PP
.nf
-.B smartctl -vm /dev/hda
+.B smartctl \-A \-v 9,minutes /dev/hda
.fi
Shows the vendor attributes, when the disk stores its power-on time
internally in minutes rather than hours.
.PP
.nf
-.B smartctl -qcL /dev/hda
+.B smartctl \-q errorsonly \-H \-l selftest /dev/hda
.fi
Produces output only if the device returns failing S.M.A.R.T. status,
or if some of the logged self-tests ended with errors.
.PP
.nf
-.B smartctl -Qa /dev/hda
+.B smartctl \-q silent \-a /dev/hda
.fi
Examine all S.M.A.R.T. data for device /dev/hda, but produce no
printed output. You must use the exit status (the
@@ -488,7 +513,7 @@ Device open failed, or device did not return an IDENTIFY DEVICE structure.
.TP
.B Bit 2:
Some SMART command to the disk failed, or there was a checksum error
-in a SMART data structure (see '\-W' option above).
+in a SMART data structure (see '\-b' option above).
.TP
.B Bit 3:
SMART status check returned "DISK FAILING".
@@ -524,7 +549,7 @@ failing' and zero otherwise.
Bruce Allen
.B smartmontools-support@lists.sourceforge.net
.fi
-University of Wisconsin - Milwaukee Physics Department
+University of Wisconsin \- Milwaukee Physics Department
.PP
.SH CREDITS
@@ -593,4 +618,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.29 2002/11/27 13:58:30 ballen4705 Exp $
+$Id: smartctl.8,v 1.30 2002/12/28 16:16:52 pjwilliams Exp $
--
GitLab