Improve formatting.

This commit is contained in:
wiz 2005-04-12 11:50:29 +00:00
parent 10e5ded54b
commit 5c35c1667a

View File

@ -1,4 +1,4 @@
.\" $NetBSD: atactl.8,v 1.20 2005/04/12 11:41:14 drochner Exp $
.\" $NetBSD: atactl.8,v 1.21 2005/04/12 11:50:29 wiz Exp $
.\"
.\" Copyright (c) 1998 The NetBSD Foundation, Inc.
.\" All rights reserved.
@ -58,24 +58,17 @@ the command to perform, and any arguments the command may require.
.Sh DEVICE COMMANDS
The following commands may be used on IDE and ATA devices.
Note that not all devices support all commands.
.Pp
.Cm identify
.Pp
.Bl -tag -width setidleXX
.It Cm identify
Identify the specified device, displaying the device's vendor, product,
revision strings, and the device's capabilities.
.Pp
.Cm idle
.Pp
.It Cm idle
Place the specified device into Idle mode.
This mode may consume less power than Active mode.
.Pp
.Cm standby
.Pp
.It Cm standby
Place the specified device into Standby mode.
This mode will consume less power than Idle mode.
.Pp
.Cm sleep
.Pp
.It Cm sleep
Place the specified device into Sleep mode.
This mode will consume less power than Standby mode,
but requires a device reset to resume operation.
@ -83,54 +76,38 @@ Typically the
.Xr wd 4
driver performs this reset automatically,
but this should still be used with caution.
.Pp
.Cm setidle
.Ar idle-timer
.Pp
.It Cm setidle Ar idle-timer
Places the specified device into Idle mode,
and sets the Idle timer to
.Ar idle-timer
seconds.
A value of 0 will disable the Idle timer.
.Pp
.Cm setstandby
.Ar standby-timer
.Pp
.It Cm setstandby Ar standby-timer
Places the specified device into Standby mode,
and sets the Standby timer to
.Ar standby-timer
seconds.
A value of 0 will disable the Standby timer.
.Pp
.Cm checkpower
.Pp
.It Cm checkpower
Will print out if the device is in Active, Idle, or Standby power
management mode.
.Pp
.Cm smart
.Ar [enable | disable | status | offline # | error-log | selftest-log]
.Pp
.It Cm smart Bq Ar enable | disable | status | offline # | error-log | selftest-log
Controls SMART feature set of the specified device.
SMART stands for Self-Monitoring, Analysis, and Reporting Technology.
It provides an early warning system by comparing subtle operation
characteristics to those determined in vendor testing
to precede device failures.
.Pp
.Ar enable
.Pp
.Bl -tag -width selftestXlogXX
.It Ar enable
Enables access to SMART capabilities within the device.
Prior to being enabled, a SMART capable device neither
monitors nor saves SMART attribute values.
The state of SMART, either enabled or disabled, will
be preserved by the device across power cycles.
.Pp
.Ar disable
.Pp
.It Ar disable
Disables access to SMART capabilities within the device.
Attribute values will be saved, and will no longer be monitored.
.Pp
.Ar status
.Pp
.It Ar status
Reports whether SMART is supported by the device, and whether SMART is
enabled on the device (can only be determined on ATA6 or better devices).
If SMART is enabled, then a table of attribute information is printed.
@ -154,7 +131,9 @@ Each attribute threshold represents the lowest limit to which its
corresponding attribute value can equal while still retaining a
positive reliability status.
.Pp
If the crit field is "yes" then negative reliability of this attribute
If the crit field is
.Dq yes
then negative reliability of this attribute
predicts imminent data loss.
Otherwise it merely indicates that the intended design life period
of usage or age has been exceeded.
@ -162,22 +141,14 @@ The collect field indicates whether this attribute is updated while the
device is online.
The reliability field indicates whether the attribute
value is within the acceptable threshold.
.Pp
.Ar offline #
.Pp
.It Ar offline #
Runs the numbered offline self-test on the drive.
.Pp
.Ar error-log
.Pp
.It Ar error-log
Prints the error log.
.Pp
.Ar selftest-log
.Pp
.It Ar selftest-log
Prints the self-test log.
.Pp
.Cm security
.Ar [freeze | status]
.Pp
.El
.It Cm security Bq Ar freeze | status
Controls
.Dq security
(password protection) features of modern ATA drives.
@ -191,23 +162,22 @@ Older and buggy BIOSes neglect to do so; in these cases it might make
sense to issue the
.Dq freeze
command early in the boot process.
.Pp
.Ar freeze
.Pp
.Bl -tag -width freezeXX
.It Ar freeze
freezes the drive's security status
.Pp
.Ar status
.Pp
.It Ar status
displays the drive's security status
.El
.El
.Sh BUS COMMANDS
The following commands may be used on IDE and ATA busses.
Note that not all devices support all commands.
.Pp
.Cm reset
.Pp
.Bl -tag -width resetXX
.It Cm reset
Reset the bus.
This will reset all ATA devices present on the bus.
Any ATAPI device with pending commands will also be reset.
.El
.Sh SEE ALSO
.Xr ioctl 2 ,
.Xr wd 4 ,