summaryrefslogtreecommitdiff
path: root/sbin/atactl
diff options
context:
space:
mode:
authorJason McIntyre <jmc@cvs.openbsd.org>2006-10-03 14:19:35 +0000
committerJason McIntyre <jmc@cvs.openbsd.org>2006-10-03 14:19:35 +0000
commitad96545b3d13ac570fd88eea5945f0c65a36137a (patch)
tree2a2b411207f2781b4b55cf5773263f2411300e66 /sbin/atactl
parent8c6741ff7e95e217cb60b2ab998e7c3c1e116848 (diff)
put the command list into some semblance of order;
Diffstat (limited to 'sbin/atactl')
-rw-r--r--sbin/atactl/atactl.8308
1 files changed, 156 insertions, 152 deletions
diff --git a/sbin/atactl/atactl.8 b/sbin/atactl/atactl.8
index 5bd942cfe99..3ea658ae16c 100644
--- a/sbin/atactl/atactl.8
+++ b/sbin/atactl/atactl.8
@@ -1,4 +1,4 @@
-.\" $OpenBSD: atactl.8,v 1.31 2006/10/02 19:47:12 jmc Exp $
+.\" $OpenBSD: atactl.8,v 1.32 2006/10/03 14:19:34 jmc Exp $
.\" $NetBSD: atactl.8,v 1.5 1999/02/24 18:49:14 jwise Exp $
.\"
.\" Copyright (c) 1998 The NetBSD Foundation, Inc.
@@ -62,43 +62,32 @@ command is implied.
The following commands may be used:
.Pp
.Bl -tag -width xxxxxxx -compact
-.It Li identify
-Identify the specified device, displaying the device's vendor, product,
-revision strings, supported capabilities and enabled capabilities.
-.Pp
-.It Li idle
-Place the specified device into Idle mode.
-This mode may consume less power than Active mode.
-.Pp
-.It Li standby
-Place the specified device into Standby mode.
-This mode will consume less power than Idle mode.
-.Pp
-.It Li 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.
-Typically the
-.Xr wd 4
-driver performs this reset automatically, but this should still be
-used with caution.
-.Pp
-.It Li 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.
+.It Li acousticdisable
+Disables support for automatic acoustic management on the specified device.
+Note that devices supporting automatic acoustic management may refuse to
+disable it, resulting in an
+.Sq ATA device returned Aborted Command
+warning.
.Pp
-.It Li 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.
+.It Li acousticset Ar acoustic-management-level
+Enables and sets the automatic acoustic management level to the requested
+level on the specified device (if supported).
+Device performance may
+increase with increasing automatic acoustic management levels at the cost of
+potentially generating more noise and requiring more power.
+Valid values are 0 up to and including 126.
+Support for automatic acoustic management is indicated by the device with
+.Sq Automatic Acoustic Management feature set
+in the output of the
+.Li identify
+command.
.Pp
-.It Li checkpower
-Will print out if the device is in Active, Idle, or Standby power
-management mode.
+.It Li apmdisable
+Disables support for advanced power management on the specified device.
+Note that devices supporting advanced power management may refuse to
+disable it, resulting in an
+.Sq ATA device returned Aborted Command
+warning.
.Pp
.It Li apmset Ar power-management-level
Enables and sets the advanced power management level to the requested
@@ -123,36 +112,21 @@ in the output of the
.Li identify
command.
.Pp
-.It Li apmdisable
-Disables support for advanced power management on the specified device.
-Note that devices supporting advanced power management may refuse to
-disable it, resulting in an
-.Sq ATA device returned Aborted Command
-warning.
+.It Li checkpower
+Will print out if the device is in Active, Idle, or Standby power
+management mode.
.Pp
-.It Li acousticset Ar acoustic-management-level
-Enables and sets the automatic acoustic management level to the requested
-level on the specified device (if supported).
-Device performance may
-increase with increasing automatic acoustic management levels at the cost of
-potentially generating more noise and requiring more power.
-Valid values are 0 up to and including 126.
-Support for automatic acoustic management is indicated by the device with
-.Sq Automatic Acoustic Management feature set
-in the output of the
-.Li identify
-command.
+.It Li dump
+Extracts the records about issued ATA commands from the log buffer.
+The log buffer is cleared after extraction.
.Pp
-.It Li acousticdisable
-Disables support for automatic acoustic management on the specified device.
-Note that devices supporting automatic acoustic management may refuse to
-disable it, resulting in an
-.Sq ATA device returned Aborted Command
-warning.
+.It Li identify
+Identify the specified device, displaying the device's vendor, product,
+revision strings, supported capabilities and enabled capabilities.
.Pp
-.It Li podenable
-Allows the specified device to revert to power-on default (pod) settings
-after a software reset.
+.It Li idle
+Place the specified device into Idle mode.
+This mode may consume less power than Active mode.
.Pp
.It Li poddisable
Disallows the specified device to revert to power-on default (pod) settings
@@ -160,6 +134,17 @@ after a software reset.
In other words this permits the settings that have been modified since
power-on to remain after a software reset.
.Pp
+.It Li podenable
+Allows the specified device to revert to power-on default (pod) settings
+after a software reset.
+.Pp
+.It Li puisdisable
+Disables power-up in standby (puis) on the specified device, causing the
+device to spin up the disks after power-up.
+This should be the factory
+default setting of the device and it is recommended to leave this
+setting disabled.
+.Pp
.It Li puisenable
Enables power-up in standby (puis) on the specified device, causing the
device to wait while spinning up the disks after power-up.
@@ -175,17 +160,20 @@ in the output of the
.Li identify
command.
.Pp
-.It Li puisdisable
-Disables power-up in standby (puis) on the specified device, causing the
-device to spin up the disks after power-up.
-This should be the factory
-default setting of the device and it is recommended to leave this
-setting disabled.
-.Pp
.It Li puisspinup
Explicitly spins up the device if power-up in standby (puis) mode
is enabled.
.Pp
+.It Li readaheaddisable
+Disables read look-ahead on the specified device.
+This may decrease performance.
+Note that the device may use
+.Sq vendor specific
+behaviour in implementing this, so it is
+.Em not
+recommended to issue this command on a disk containing any currently
+mounted filesystems.
+.Pp
.It Li readaheadenable
Enables read look-ahead on the specified device.
This may increase performance.
@@ -196,15 +184,61 @@ in the output of the
.Li identify
command.
.Pp
-.It Li readaheaddisable
-Disables read look-ahead on the specified device.
-This may decrease performance.
-Note that the device may use
-.Sq vendor specific
-behaviour in implementing this, so it is
-.Em not
-recommended to issue this command on a disk containing any currently
-mounted filesystems.
+.It Li readattr
+Displays attribute thresholds and values for the specified device.
+Besides attribute values, device vendors may provide additional information
+shown in the last column, ``Raw''.
+Attributes names can be completely wrong since they vary between vendors and
+even models, so don't rely on it.
+SMART must be enabled while executing this command or the device will return
+an error.
+.Pp
+SMART commands and
+.Li readattr
+command are for experts only.
+.Pp
+.It Li secdisablepass Ar user\*(Bamaster
+Disables the lock mode for the specified device with user or master password.
+This command won't change the master password.
+The master password will be reactivated when a user password is set.
+.Pp
+Support for the security commands is indicated by the device with
+.Sq Security Mode feature set
+in the output of the
+.Li identify
+command.
+.Pp
+.Em WARNING
+.br
+Be very careful while playing with these commands.
+Loss of the user and master passwords for the device will result
+in an inaccessible device.
+.Pp
+.It Li secerase Ar user\*(Bamaster Op Ar enhanced
+Erases all user data and unlocks the specified device.
+Execution of this command with the master password is the only way to unlock a
+device locked at maximum security level with the
+.Li secsetpass
+command if the user's password is lost or unknown.
+There are two erase modes: normal and enhanced.
+Default erase mode is normal.
+In the normal erase mode this command will write binary zeroes to
+all user data areas.
+The enhanced erase mode is optional and may not be supported by the device.
+When enhanced erase mode is specified, the device will write predetermined
+data patterns to all user data areas.
+In enhanced erase mode, all previously written user data will be overwritten,
+including sectors that are no longer in use due to reallocation.
+This command will disable the device lock mode, however, the master password
+will still be stored internally within the device and may be reactivated later
+when a new user password is set.
+.Pp
+.It Li secfreeze
+Prevents changes to passwords until a following power cycle.
+The purpose of this command is to prevent password setting attacks on the
+security system.
+After command completion any other commands that update the device lock mode
+will be aborted.
.Pp
.It Li secsetpass Ar user Ar high\*(Bamaximum
.It Li secsetpass Ar master
@@ -251,48 +285,40 @@ If the security level was set to maximum during the last
.Li secsetpass
command, the device won't unlock even if the master password is received.
.Pp
-.It Li secerase Ar user\*(Bamaster Op Ar enhanced
-Erases all user data and unlocks the specified device.
-Execution of this command with the master password is the only way to unlock a
-device locked at maximum security level with the
-.Li secsetpass
-command if the user's password is lost or unknown.
-There are two erase modes: normal and enhanced.
-Default erase mode is normal.
-In the normal erase mode this command will write binary zeroes to
-all user data areas.
-The enhanced erase mode is optional and may not be supported by the device.
-When enhanced erase mode is specified, the device will write predetermined
-data patterns to all user data areas.
-In enhanced erase mode, all previously written user data will be overwritten,
-including sectors that are no longer in use due to reallocation.
-This command will disable the device lock mode, however, the master password
-will still be stored internally within the device and may be reactivated later
-when a new user password is set.
+.It Li 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
-.It Li secfreeze
-Prevents changes to passwords until a following power cycle.
-The purpose of this command is to prevent password setting attacks on the
-security system.
-After command completion any other commands that update the device lock mode
-will be aborted.
+.It Li 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
-.It Li secdisablepass Ar user\*(Bamaster
-Disables the lock mode for the specified device with user or master password.
-This command won't change the master password.
-The master password will be reactivated when a user password is set.
+.It Li 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.
+Typically the
+.Xr wd 4
+driver performs this reset automatically, but this should still be
+used with caution.
.Pp
-Support for the security commands is indicated by the device with
-.Sq Security Mode feature set
-in the output of the
-.Li identify
-command.
+.It Li smartautosave Ar enable\*(Badisable
+Enables/disables attribute autosave feature on the specified device.
.Pp
-.Em WARNING
-.br
-Be very careful while playing with these commands.
-Loss of the user and master passwords for the device will result
-in an inaccessible device.
+.It Li smartdisable
+Disables support for SMART on the specified device.
+Note that this means that the device will no longer record any SMART
+information.
+.Pp
+Note that SMART
+.Em must
+be enabled while executing the following commands or the device will
+return an error.
.Pp
.It Li smartenable
Enables SMART (Self-Monitoring, Analysis, and Reporting Technology) on the
@@ -305,26 +331,9 @@ in the output of the
.Li identify
command.
.Pp
-.It Li smartdisable
-Disables support for SMART on the specified device.
-Note that this means that the device will no longer record any SMART
-information.
-.Pp
-Note that SMART
-.Em must
-be enabled while executing the following commands or the device will
-return an error.
-.Pp
-.It Li smartstatus
-Reads the reliability status of the specified device.
-If the device reports
-that one of its thresholds is exceeded (a strong indication of imminent
-failure), the warning
-.Sq SMART threshold exceeded!
-is printed to stderr and a status of 2 is returned.
-.Pp
-.It Li smartautosave Ar enable\*(Badisable
-Enables/disables attribute autosave feature on the specified device.
+SMART commands and
+.Li readattr
+command are for experts only.
.Pp
.It Li smartoffline Ar subcommand
Causes the specified device to immediately initiate the optional set of
@@ -384,18 +393,17 @@ The self-test log.
The summary error log.
.El
.Pp
-.It Li readattr
-Displays attribute thresholds and values for the specified device.
-Besides attribute values, device vendors may provide additional information
-shown in the last column, ``Raw''.
-Attributes names can be completely wrong since they vary between vendors and
-even models, so don't rely on it.
-SMART must be enabled while executing this command or the device will return
-an error.
+.It Li smartstatus
+Reads the reliability status of the specified device.
+If the device reports
+that one of its thresholds is exceeded (a strong indication of imminent
+failure), the warning
+.Sq SMART threshold exceeded!
+is printed to stderr and a status of 2 is returned.
.Pp
-SMART commands and
-.Li readattr
-command are for experts only.
+.It Li standby
+Place the specified device into Standby mode.
+This mode will consume less power than Idle mode.
.Pp
.It Li writecachedisable
Disable the write cache on the specified device (if supported).
@@ -414,10 +422,6 @@ powerdown
The
.Xr wd 4
driver performs a cache flush automatically before shutdown.
-.Pp
-.It Li dump
-Extracts the records about issued ATA commands from the log buffer.
-The log buffer is cleared after extraction.
.El
.Sh EXAMPLES
Display the vendor, product, revision strings, and capabilities (such as