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

Document new '-v' option/directive arguments on man pages. 

git-svn-id: https://smartmontools.svn.sourceforge.net/svnroot/smartmontools/trunk@2977 4ea69e1a-61f1-4043-bf83-b5c94c648137
parent 65999d9a
No related branches found
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
smartmontools/smartctl.8.in
+ 100
− 51
View file @ 71330e89
......@@ -1017,42 +1017,78 @@ writes a binary representation of the one sector log 0x11
(SATA Phy Event Counters) to file log.bin.
.TP
.B \-v N,OPTION, \-\-vendorattribute=N,OPTION
[ATA only] Sets a vendor\-specific display OPTION for Attribute N. This
option may be used multiple times. Valid arguments to this option are:
.B \-v ID,FORMAT[,NAME], \-\-vendorattribute=ID,FORMAT[,NAME]
[ATA only] Sets a vendor\-specific raw value print FORMAT and
optional NAME for Attribute ID.
This option may be used multiple times.
.I help
The Attribute ID can be in the range 1 to 255. If \'N\' is specified as
ID, the settings for all Attributes are changed. The NAME is a string of
letters, digits and underscore.
.I \-v help
\- Prints (to STDOUT) a list of all valid arguments to this option,
then exits.
.I 9,minutes
\- Raw Attribute number 9 is power\-on time in minutes. Its raw value
Valid arguments for FORMAT are:
.I raw8
\- Print the Raw value as six 8\-bit unsigned base\-10 integers.
This may be useful for decoding the meaning of the Raw value.
.I raw16
\- Print the Raw value as three 16\-bit unsigned base\-10 integers.
This may be useful for decoding the meaning of the Raw value.
.I raw48
\- Print the Raw value as a 48\-bit unsigned base\-10 integer.
This is the default for most attributes.
.I raw64
\- Print the Raw value as a 64\-bit unsigned base\-10 integer.
This includes two bytes from the normalized and worst attribute value.
This new raw format is used by some recent SSD devices.
.I min2hour
\- Raw Attribute is power\-on time in minutes. Its raw value
will be displayed in the form "Xh+Ym". Here X is hours, and Y is
minutes in the range 0\-59 inclusive. Y is always printed with two
digits, for example "06" or "31" or "00".
.I 9,seconds
\- Raw Attribute number 9 is power\-on time in seconds. Its raw value
.I sec2hour
\- Raw Attribute is power\-on time in seconds. Its raw value
will be displayed in the form "Xh+Ym+Zs". Here X is hours, Y is
minutes in the range 0\-59 inclusive, and Z is seconds in the range
0\-59 inclusive. Y and Z are always printed with two digits, for
example "06" or "31" or "00".
.I 9,halfminutes
\- Raw Attribute number 9 is power\-on time, measured in units of 30
.I halfmin2hour
\- Raw Attribute is power\-on time, measured in units of 30
seconds. This format is used by some Samsung disks. Its raw value
will be displayed in the form "Xh+Ym". Here X is hours, and Y is
minutes in the range 0\-59 inclusive. Y is always printed with two
digits, for example "06" or "31" or "00".
.I 9,temp
\- Raw Attribute number 9 is the disk temperature in Celsius.
.I tempminmax
\- Raw Attribute is the disk temperature in Celsius. Info about
Lifetime Min/Max temperature is printed if available. This is the
default for Attributes 190 and 194.
.I 192,emergencyretractcyclect
\- Raw Attribute number 192 is the Emergency Retract Cycle Count.
.I temp10x
\- Raw Attribute is ten times the disk temperature in Celsius.
.I 193,loadunload
\- Raw Attribute number 193 contains two values. The first is the
.I raw16(raw16)
\- Print the raw attribute as a 16\-bit value and two optional
16\-bit values if these words are nonzero. This is the default
for Attributes 5 and 196.
.I raw16(avg16)
\- Raw attribute is spin-up time. It is printed as a 16-bit value
and an optional "Average" 16-bit value if the word is nonzero.
This is the default for Attribute 3.
.I raw24/raw24
\- Raw Attribute contains two 24\-bit values. The first is the
number of load cycles. The second is the number of unload cycles.
The difference between these two values is the number of times that
the drive was unexpectedly powered off (also called an emergency
......@@ -1060,61 +1096,74 @@ unload). As a rule of thumb, the mechanical stress created by one
emergency unload is equivalent to that created by one hundred normal
unloads.
The following old arguments to \'\-v\' are also still valid:
.I 9,minutes
\- same as:
.I 9,min2hour,Power_On_Minutes.
.I 9,seconds
\- same as:
.I 9,sec2hour,Power_On_Seconds.
.I 9,halfminutes
\- same as:
.I 9,halfmin2hour,Power_On_Half_Minutes.
.I 9,temp
\- same as:
.I 9,tempminmax,Temperature_Celsius.
.I 192,emergencyretractcyclect
\- same as:
.I 192,raw48,Emerg_Retract_Cycle_Ct
.I 193,loadunload
\- same as:
.I 193,raw24/raw24.
.I 194,10xCelsius
\- Raw Attribute number 194 is ten times the disk temperature in
Celsius. This is used by some Samsung disks (example: model SV1204H
with RK100\-13 firmware).
\- same as:
.I 194,temp10x,Temperature_Celsius_x10.
.I 194,unknown
\- Raw Attribute number 194 is NOT the disk temperature, and its
interpretation is unknown. This is primarily useful for the \-P
(presets) option.
\- same as:
.I 194,raw48,Unknown_Attribute.
.I 197,increasing
\- Raw Attribute number 197 (Current Pending Sector Count) is not
reset if uncorrectable sectors are reallocated.
\- same as:
.I 197,raw48,Total_Pending_Sectors.
Also means that Attribute number 197 (Current Pending Sector Count)
is not reset if uncorrectable sectors are reallocated
(see \fBsmartd.conf\fP(5) man page).
.I 198,increasing
\- Raw Attribute number 198 (Offline Uncorrectable Sector Count) is not
reset if uncorrectable sectors are reallocated.
\- same as:
.I 198,raw48,Total_Offl_Uncorrectabl.
Also means that Attribute number 198 (Offline Uncorrectable Sector Count)
is not reset if uncorrectable sectors are reallocated
(see \fBsmartd.conf\fP(5) man page).
.I 198,offlinescanuncsectorct
\- Raw Attribute number 198 is the Offline Scan UNC Sector Count.
\- same as:
.I 198,raw48,Offline_Scan_UNC_SectCt.
.I 200,writeerrorcount
\- Raw Attribute number 200 is the Write Error Count.
\- same as:
.I 200,raw48,Write_Error_Count.
.I 201,detectedtacount
\- Raw Attribute number 201 is the Detected TA Count.
\- same as:
.I 201,raw48,Detected_TA_Count.
.I 220,temp
\- Raw Attribute number 220 is the disk temperature in Celsius.
\- same as:
.I 220,raw48,Temperature_Celsius.
Note: a table of hard drive models, listing which Attribute
corresponds to temperature, can be found at:
\fBhttp://www.guzu.net/linux/hddtemp.db\fP
.I N,raw8
\- Print the Raw value of Attribute N as six 8\-bit unsigned base\-10
integers. This may be useful for decoding the meaning of the Raw
value. The form \'N,raw8\' prints Raw values for ALL Attributes in this
form. The form (for example) \'123,raw8\' only prints the Raw value for
Attribute 123 in this form.
.I N,raw16
\- Print the Raw value of Attribute N as three 16\-bit unsigned base\-10
integers. This may be useful for decoding the meaning of the Raw
value. The form \'N,raw16\' prints Raw values for ALL Attributes in this
form. The form (for example) \'123,raw16\' only prints the Raw value for
Attribute 123 in this form.
.I N,raw48
\- Print the Raw value of Attribute N as a 48\-bit unsigned base\-10
integer. This may be useful for decoding the meaning of the Raw
value. The form \'N,raw48\' prints Raw values for ALL Attributes in
this form. The form (for example) \'123,raw48\' only prints the Raw
value for Attribute 123 in this form.
.TP
.B \-F TYPE, \-\-firmwarebug=TYPE
[ATA only] Modifies the behavior of \fBsmartctl\fP to compensate for some
......
smartmontools/smartd.8.in
+ 15
− 97
View file @ 71330e89
......@@ -157,7 +157,7 @@ The path must be absolute, except if debug mode is enabled.
[NEW EXPERIMENTAL SMARTD FEATURE] Read the drive database from FILE.
The new database replaces the built in database by default. If \'+\' is
specified, then the new entries prepend the built in entries.
Please see the \fBsmartctl\fP man page for further details.
Please see the \fBsmartctl\fP(8) man page for further details.
.TP
.B \-c FILE, \-\-configfile=FILE
......@@ -722,8 +722,8 @@ along with the \'\-d areca,N\' Directive (see below). The individual
SATA disks hosted by the Areca controller appear to \fBsmartd\fP as
normal ATA devices. Hence all the ATA directives can be used for
these disks. Areca firmware version 1.46 or later which supports
smartmontools must be used; Please see the \fBsmartctl\fP man page for
further details.
smartmontools must be used; Please see the \fBsmartctl\fP(8) man page
for further details.
.TP
.B \-d TYPE
......@@ -795,14 +795,14 @@ you may use \fBany\fP of the 3ware SCSI logical devices /dev/sd? to
address \fBany\fP of the physical disks (3ware ports), error and log
messages will make the most sense if you always list the 3ware SCSI
logical device corresponding to the particular physical disks. Please
see the \fBsmartctl\fP man page for further details.
see the \fBsmartctl\fP(8) man page for further details.
ATA disks behind 3ware controllers may alternatively be accessed via a
character device interface /dev/twe0-15 (3ware 6000/7000/8000
controllers) and /dev/twa0-15 (3ware 9000 series controllers). Note
that the 9000 series controllers may \fBonly\fP be accessed using the
character device interface /dev/twa0-15 and not the SCSI device
interface /dev/sd?. Please see the \fBsmartctl\fP man page for
interface /dev/sd?. Please see the \fBsmartctl\fP(8) man page for
further details.
Note that older 3w-xxxx drivers do not pass the \'Enable Autosave\'
......@@ -1605,105 +1605,23 @@ values for \'\-F\' (see the \'\-P\' option below).
[Please see the \fBsmartctl \-F\fP command-line option.]
.TP
.B \-v N,OPTION
Modifies the labeling for Attribute N, for disks which use
non-standard Attribute definitions. This is useful in connection with
the Attribute tracking/reporting Directives.
This Directive may appear multiple times. Valid arguments to this
Directive are:
.B \-v ID,FORMAT[,NAME]
[ATA only] Sets a vendor\-specific raw value print FORMAT and
optional NAME for Attribute ID.
This directive may be used multiple times.
Please see \fBsmartctl -v\fP command-line option for further details.
.I 9,minutes
\- Raw Attribute number 9 is power-on time in minutes. Its raw value
will be displayed in the form \'Xh+Ym\'. Here X is hours, and Y is
minutes in the range 0-59 inclusive. Y is always printed with two
digits, for example \'06\' or \'31\' or \'00\'.
.I 9,seconds
\- Raw Attribute number 9 is power-on time in seconds. Its raw value
will be displayed in the form \'Xh+Ym+Zs\'. Here X is hours, Y is
minutes in the range 0-59 inclusive, and Z is seconds in the range
0-59 inclusive. Y and Z are always printed with two digits, for
example \'06\' or \'31\' or \'00\'.
.I 9,halfminutes
\- Raw Attribute number 9 is power-on time, measured in units of 30
seconds. This format is used by some Samsung disks. Its raw value
will be displayed in the form \'Xh+Ym\'. Here X is hours, and Y is
minutes in the range 0-59 inclusive. Y is always printed with two
digits, for example \'06\' or \'31\' or \'00\'.
.I 9,temp
\- Raw Attribute number 9 is the disk temperature in Celsius.
.I 192,emergencyretractcyclect
\- Raw Attribute number 192 is the Emergency Retract Cycle Count.
.I 193,loadunload
\- Raw Attribute number 193 contains two values. The first is the
number of load cycles. The second is the number of unload cycles.
The difference between these two values is the number of times that
the drive was unexpectedly powered off (also called an emergency
unload). As a rule of thumb, the mechanical stress created by one
emergency unload is equivalent to that created by one hundred normal
unloads.
.I 194,10xCelsius
\- Raw Attribute number 194 is ten times the disk temperature in
Celsius. This is used by some Samsung disks (example: model SV1204H
with RK100-13 firmware).
.I 194,unknown
\- Raw Attribute number 194 is NOT the disk temperature, and its
interpretation is unknown. This is primarily useful for the -P
(presets) Directive.
The following arguments affect smartd warning output:
.I 197,increasing
\- Raw Attribute number 197 (Current Pending Sector Count) is not
reset if uncorrectable sectors are reallocated. This also sets
\'-C 197+\' if no other \'-C\' directive is specified.
reset if uncorrectable sectors are reallocated. This sets \'-C 197+\'
if no other \'-C\' directive is specified.
.I 198,increasing
\- Raw Attribute number 198 (Offline Uncorrectable Sector Count) is not
reset if uncorrectable sector are reallocated. This also sets
\'-U 198+\' if no other \'-U\' directive is specified.
.I 198,offlinescanuncsectorct
\- Raw Attribute number 198 is the Offline Scan UNC Sector Count.
.I 200,writeerrorcount
\- Raw Attribute number 200 is the Write Error Count.
.I 201,detectedtacount
\- Raw Attribute number 201 is the Detected TA Count.
.I 220,temp
\- Raw Attribute number 220 is the disk temperature in Celsius.
Note: a table of hard drive models, listing which Attribute
corresponds to temperature, can be found at:
\fBhttp://www.guzu.net/linux/hddtemp.db\fP
.I N,raw8
\- Print the Raw value of Attribute N as six 8-bit unsigned base-10
integers. This may be useful for decoding the meaning of the Raw
value. The form \'N,raw8\' prints Raw values for ALL Attributes in this
form. The form (for example) \'123,raw8\' only prints the Raw value for
Attribute 123 in this form.
.I N,raw16
\- Print the Raw value of Attribute N as three 16-bit unsigned base-10
integers. This may be useful for decoding the meaning of the Raw
value. The form \'N,raw16\' prints Raw values for ALL Attributes in this
form. The form (for example) \'123,raw16\' only prints the Raw value for
Attribute 123 in this form.
.I N,raw48
\- Print the Raw value of Attribute N as a 48-bit unsigned base-10
integer. This may be useful for decoding the meaning of the Raw
value. The form \'N,raw48\' prints Raw values for ALL Attributes in
this form. The form (for example) \'123,raw48\' only prints the Raw
value for Attribute 123 in this form.
reset if uncorrectable sector are reallocated. This sets \'-U 198+\'
if no other \'-U\' directive is specified.
.TP
.B \-P TYPE
......
smartmontools/smartd.conf.5.in
+ 16
− 101
View file @ 71330e89
......@@ -57,8 +57,7 @@ Under FreeBSD,
\fBsmartd\fP
will try to open all existing ATA devices (with entries in /dev)
.B /dev/ad[0-9]+
and all existing SCSI devices
.B /dev/da[0-9]+.
and all existing SCSI devices (using CAM subsystem).
Under NetBSD/OpenBSD,
\fBsmartd\fP
will try to open all existing ATA devices (with entries in /dev)
......@@ -285,8 +284,8 @@ along with the \'\-d areca,N\' Directive (see below). The individual
SATA disks hosted by the Areca controller appear to \fBsmartd\fP as
normal ATA devices. Hence all the ATA directives can be used for
these disks. Areca firmware version 1.46 or later which supports
smartmontools must be used; Please see the \fBsmartctl\fP man page for
further details.
smartmontools must be used; Please see the \fBsmartctl\fP(8) man page
for further details.
.TP
.B \-d TYPE
......@@ -358,14 +357,14 @@ you may use \fBany\fP of the 3ware SCSI logical devices /dev/sd? to
address \fBany\fP of the physical disks (3ware ports), error and log
messages will make the most sense if you always list the 3ware SCSI
logical device corresponding to the particular physical disks. Please
see the \fBsmartctl\fP man page for further details.
see the \fBsmartctl\fP(8) man page for further details.
ATA disks behind 3ware controllers may alternatively be accessed via a
character device interface /dev/twe0-15 (3ware 6000/7000/8000
controllers) and /dev/twa0-15 (3ware 9000 series controllers). Note
that the 9000 series controllers may \fBonly\fP be accessed using the
character device interface /dev/twa0-15 and not the SCSI device
interface /dev/sd?. Please see the \fBsmartctl\fP man page for
interface /dev/sd?. Please see the \fBsmartctl\fP(8) man page for
further details.
Note that older 3w-xxxx drivers do not pass the \'Enable Autosave\'
......@@ -394,9 +393,7 @@ inclusive) denotes which disk on the controller is monitored. In log
files and email messages this disk will be identified as cciss_disk_XX
with XX in the range from 00 to 15 inclusive.
.B 3ware and cciss controllers are currently ONLY supported under Linux and FreeBSD.
.B MegaRAID and Areca controllers are currently ONLY supported under Linux.
.B 3ware, MegaRAID, Areca and cciss controllers are currently ONLY supported under Linux.
.I hpt,L/M/N
\- the device consists of one or more ATA disks connected to a HighPoint
......@@ -1170,105 +1167,23 @@ values for \'\-F\' (see the \'\-P\' option below).
[Please see the \fBsmartctl \-F\fP command-line option.]
.TP
.B \-v N,OPTION
Modifies the labeling for Attribute N, for disks which use
non-standard Attribute definitions. This is useful in connection with
the Attribute tracking/reporting Directives.
This Directive may appear multiple times. Valid arguments to this
Directive are:
.B \-v ID,FORMAT[,NAME]
[ATA only] Sets a vendor\-specific raw value print FORMAT and
optional NAME for Attribute ID.
This directive may be used multiple times.
Please see \fBsmartctl -v\fP command-line option for further details.
.I 9,minutes
\- Raw Attribute number 9 is power-on time in minutes. Its raw value
will be displayed in the form \'Xh+Ym\'. Here X is hours, and Y is
minutes in the range 0-59 inclusive. Y is always printed with two
digits, for example \'06\' or \'31\' or \'00\'.
.I 9,seconds
\- Raw Attribute number 9 is power-on time in seconds. Its raw value
will be displayed in the form \'Xh+Ym+Zs\'. Here X is hours, Y is
minutes in the range 0-59 inclusive, and Z is seconds in the range
0-59 inclusive. Y and Z are always printed with two digits, for
example \'06\' or \'31\' or \'00\'.
.I 9,halfminutes
\- Raw Attribute number 9 is power-on time, measured in units of 30
seconds. This format is used by some Samsung disks. Its raw value
will be displayed in the form \'Xh+Ym\'. Here X is hours, and Y is
minutes in the range 0-59 inclusive. Y is always printed with two
digits, for example \'06\' or \'31\' or \'00\'.
.I 9,temp
\- Raw Attribute number 9 is the disk temperature in Celsius.
.I 192,emergencyretractcyclect
\- Raw Attribute number 192 is the Emergency Retract Cycle Count.
.I 193,loadunload
\- Raw Attribute number 193 contains two values. The first is the
number of load cycles. The second is the number of unload cycles.
The difference between these two values is the number of times that
the drive was unexpectedly powered off (also called an emergency
unload). As a rule of thumb, the mechanical stress created by one
emergency unload is equivalent to that created by one hundred normal
unloads.
.I 194,10xCelsius
\- Raw Attribute number 194 is ten times the disk temperature in
Celsius. This is used by some Samsung disks (example: model SV1204H
with RK100-13 firmware).
.I 194,unknown
\- Raw Attribute number 194 is NOT the disk temperature, and its
interpretation is unknown. This is primarily useful for the -P
(presets) Directive.
The following arguments affect smartd warning output:
.I 197,increasing
\- Raw Attribute number 197 (Current Pending Sector Count) is not
reset if uncorrectable sectors are reallocated. This also sets
\'-C 197+\' if no other \'-C\' directive is specified.
reset if uncorrectable sectors are reallocated. This sets \'-C 197+\'
if no other \'-C\' directive is specified.
.I 198,increasing
\- Raw Attribute number 198 (Offline Uncorrectable Sector Count) is not
reset if uncorrectable sector are reallocated. This also sets
\'-U 198+\' if no other \'-U\' directive is specified.
.I 198,offlinescanuncsectorct
\- Raw Attribute number 198 is the Offline Scan UNC Sector Count.
.I 200,writeerrorcount
\- Raw Attribute number 200 is the Write Error Count.
.I 201,detectedtacount
\- Raw Attribute number 201 is the Detected TA Count.
.I 220,temp
\- Raw Attribute number 220 is the disk temperature in Celsius.
Note: a table of hard drive models, listing which Attribute
corresponds to temperature, can be found at:
\fBhttp://www.guzu.net/linux/hddtemp.db\fP
.I N,raw8
\- Print the Raw value of Attribute N as six 8-bit unsigned base-10
integers. This may be useful for decoding the meaning of the Raw
value. The form \'N,raw8\' prints Raw values for ALL Attributes in this
form. The form (for example) \'123,raw8\' only prints the Raw value for
Attribute 123 in this form.
.I N,raw16
\- Print the Raw value of Attribute N as three 16-bit unsigned base-10
integers. This may be useful for decoding the meaning of the Raw
value. The form \'N,raw16\' prints Raw values for ALL Attributes in this
form. The form (for example) \'123,raw16\' only prints the Raw value for
Attribute 123 in this form.
.I N,raw48
\- Print the Raw value of Attribute N as a 48-bit unsigned base-10
integer. This may be useful for decoding the meaning of the Raw
value. The form \'N,raw48\' prints Raw values for ALL Attributes in
this form. The form (for example) \'123,raw48\' only prints the Raw
value for Attribute 123 in this form.
reset if uncorrectable sector are reallocated. This sets \'-U 198+\'
if no other \'-U\' directive is specified.
.TP
.B \-P TYPE
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment

AEI Privacy Policy Imprint