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