summaryrefslogtreecommitdiffstats
path: root/sbin/atacontrol
diff options
context:
space:
mode:
authorsos <sos@FreeBSD.org>2001-03-19 07:57:25 +0000
committersos <sos@FreeBSD.org>2001-03-19 07:57:25 +0000
commita0b76b829fda872fb196554d2ff84e9f629fcd8a (patch)
tree45b82c5427e413ad710a78d7cf3b5fbf967c11a2 /sbin/atacontrol
parent8dfcbabba9112ca838bafff955924b4de6b5fdc4 (diff)
downloadFreeBSD-src-a0b76b829fda872fb196554d2ff84e9f629fcd8a.zip
FreeBSD-src-a0b76b829fda872fb196554d2ff84e9f629fcd8a.tar.gz
Incorporate most of Ruslans changes plus minor addtion by me
Diffstat (limited to 'sbin/atacontrol')
-rw-r--r--sbin/atacontrol/atacontrol.880
1 files changed, 48 insertions, 32 deletions
diff --git a/sbin/atacontrol/atacontrol.8 b/sbin/atacontrol/atacontrol.8
index 4c24549..e933635 100644
--- a/sbin/atacontrol/atacontrol.8
+++ b/sbin/atacontrol/atacontrol.8
@@ -33,78 +33,94 @@
.Nd
ATA device driver control program
.Sh SYNOPSIS
-.Nm
+.Nm
.Aq Ar command
-.Op channel [args]
-
+.Ar channel Op Ar args
+.Pp
.Nm
.Ic attach
-.Op channel
+.Ar channel
.Nm
.Ic detach
-.Op channel
+.Ar channel
.Nm
.Ic reinit
-.Op channel
+.Ar channel
.Nm
.Ic mode
-.Op channel
-.Op mastermode slavemode
+.Ar channel
+.Op Ar mastermode slavemode
.Nm
.Ic info
-.Op channel
-
+.Ar channel
.Sh DESCRIPTION
.Nm
is a control program that provides the user access and control to the
-.Fx
-ATA subsystem.
+.Fx
+.Xr ata 4
+subsystem.
.Pp
.Nm
can cause severe system crashes and loss of data if used improperly, please
-exercise caution when using this command!.
+exercise caution when using this command!
.Pp
.Nm
supports the following commands:
-.Pp
-.Bl -tag -width 8n
-.It Ic attach
-Attach an ATA channel, devices on the channel are probed and attached as
+.Bl -tag -width "attach"
+.It Ic attach
+Attach an ATA
+.Ar channel ,
+devices on the channel are probed and attached as
is done on boot.
-.Pp
.It Ic detach
-Detach an ATA channel, devices on the channel are removed from the kernel,
+Detach an ATA
+.Ar channel ,
+devices on the channel are removed from the kernel,
and all outstanding tranfers etc are returned back to the system marked
as failed.
-.Pp
.It Ic reinit
-Reinitialize an ATA channel. Both devices on the channel are reset and
+Reinitialize an ATA
+.Ar channel .
+Both devices on the channel are reset and
initialized to the parameters the ATA driver has stored internally.
Devices that has gone bad and no longer responds to the probe, or devices
-that has physically been removed are removed from the kernel. Likewise
+that has physically been removed are removed from the kernel.
+Likewise
are devices that show up during a reset, probed and attached.
-.Pp
-.It Ic mode
+.It Ic mode
Without the two mode arguments the current transfer modes of both
-devices are printed. If the mode arguments are given, the ATA driver
-is asked to change the transfer modes to those given. The ATA driver
+devices are printed.
+If the mode arguments are given, the ATA driver
+is asked to change the transfer modes to those given.
+The ATA driver
will reject modes that is not supported by the hardware.
-Modes are given like PIO3, udma2, udma100, case does not matter.
-.Pp
+Modes are given like
+.Dq Li PIO3 ,
+.Dq Li udma2 ,
+.Dq Li udma100 ,
+case does not matter.
+If one of the devices mode should not be changed, use a nonexisting mode
+as argument (ie
+.Dq Li XXX
+), and the mode will remain unchanged.
.It Ic info
-Show info on the device on the channel, currently only the device
+Show info on the device on the
+.Ar channel ,
+currently only the device
name and manufacture/version strings are shown.
-.Pp
+.El
+.Sh SEE ALSO
+.Xr ata 4
.Sh HISTORY
The
.Nm
-driver first appeared in
+utility first appeared in
.Fx 5.0 .
.Sh AUTHORS
.An -nosplit
The
.Nm
-driver was written by
+utility was written by
.An S\(/oren Schmidt
.Aq sos@FreeBSD.org .
.Pp
OpenPOWER on IntegriCloud