xref: /netbsd/sbin/atactl/atactl.8 (revision bf9ec67e)
1.\"	$NetBSD: atactl.8,v 1.9 2001/11/16 11:21:37 wiz Exp $
2.\"
3.\" Copyright (c) 1998 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Ken Hornstein.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd November 18, 1998
38.Dt ATACTL 8
39.Os
40.Sh NAME
41.Nm atactl
42.Nd a program to manipulate ATA (IDE) devices
43.Sh SYNOPSIS
44.Nm
45.Ar device
46.Ar command
47.Oo
48.Ar arg Oo ...
49.Oc
50.Oc
51.Sh DESCRIPTION
52.Nm
53allows a user or system administrator to issue commands to and otherwise
54control devices which reside on standard IDE and ATA controllers.  It is
55used by specifying
56a device to manipulate, the command to perform, and any arguments
57the command may require.
58.Sh DEVICE COMMANDS
59The following commands may be used on IDE and ATA devices.  Note
60that not all devices support all commands.
61.Pp
62.Cm identify
63.Pp
64Identify the specified device, displaying the device's vendor, product,
65revision strings, and the device's capabilities.
66.Pp
67.Cm idle
68.Pp
69Place the specified device into Idle mode.  This mode may consume less
70power than Active mode.
71.Pp
72.Cm standby
73.Pp
74Place the specified device into Standby mode.  This mode will consume
75less power than Idle mode.
76.Pp
77.Cm sleep
78.Pp
79Place the specified device into Sleep mode.  This mode will consume
80less power than Standby mode, but requires a device reset to resume
81operation.  Typically the
82.Xr wd 4
83driver performs this reset automatically, but this should still be
84used with caution.
85.Pp
86.Cm setidle
87.Ar idle-timer
88.Pp
89Places the specified device into Idle mode, and sets the Idle timer
90to
91.Ar idle-timer
92seconds.  A value of 0 will disable the Idle timer.
93.Pp
94.Cm setstandby
95.Ar standby-timer
96.Pp
97Places the specified device into Standby mode, and sets the Standby timer
98to
99.Ar standby-timer
100seconds.  A value of 0 will disable the Standby timer.
101.Pp
102.Cm checkpower
103.Pp
104Will print out if the device is in Active, Idle, or Standby power
105management mode.
106.Sh SEE ALSO
107.Xr ioctl 2 ,
108.Xr wd 4
109.Sh HISTORY
110The
111.Nm
112command first appeared in
113.Nx 1.4 .
114.Sh AUTHORS
115The
116.Nm
117command was written by Ken Hornstein.  It was based heavily on the
118.Xr scsictl 8
119command written by Jason R. Thorpe.
120.Sh BUGS
121The output from the
122.Cm identify
123command is rather ugly.
124