DragonFly BSD
DragonFly submit List (threaded) for 2004-01
[Date Prev][Date Next]  [Thread Prev][Thread Next]  [Date Index][Thread Index]

firewire manpage updates


From: Christian Brueffer <chris@xxxxxxxxxxxxx>
Date: Fri, 30 Jan 2004 19:15:31 +0100

Hi,

the following patches sync the dfly manpages with the ones in FreeBSD
4-STABLE (minus a small revision in firewire.4, which can be applied
once the dfly firewire code is synched with FreeBSD).

I have updated the $FreeBSD$ lines as well (is this preferred or not?).

- Christian

-- 
Christian Brueffer	chris@xxxxxxxxxxxxx	brueffer@xxxxxxxxxxx
GPG Key:	 http://people.freebsd.org/~brueffer/brueffer.key.asc
GPG Fingerprint: A5C8 2099 19FF AACA F41B  B29B 6C76 178C A0ED 982D
Index: firewire.4
===================================================================
RCS file: /usr/home/ncvs/dragonfly/src/share/man/man4/firewire.4,v
retrieving revision 1.2
diff -u -r1.2 firewire.4
--- firewire.4	17 Jun 2003 04:36:59 -0000	1.2
+++ firewire.4	28 Jan 2004 02:15:40 -0000
@@ -29,7 +29,7 @@
 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/firewire.4,v 1.1.2.3 2003/02/14 08:22:03 simokawa Exp $
+.\" $FreeBSD: src/share/man/man4/firewire.4,v 1.9 2003/12/17 01:13:13 brueffer Exp $
 .\" $DragonFly: src/share/man/man4/firewire.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
 .\"
 .Dd May 23, 2002
@@ -44,7 +44,6 @@
 or
 .Pp
 .Cd "device firewire"
-.Cd "device fwohci"
 .Pp
 .In dev/firewire/firewire.h
 .Sh DESCRIPTION
@@ -63,33 +62,33 @@
 The
 .Nm
 bus attaches to the controller.
-And the additional driver can be attached to the bus.
+Additional drivers can be attached to the bus.
 .Pp
 Up to 63 devices, including the host itself, can be attached to
 a
 .Nm
 bus.
-The root node is dynamically assigned with PHY device function.
+The root node is dynamically assigned with a PHY device function.
 Also, the other
 .Nm
 bus specific parameters,
 e.g., node ID, cycle master, isochronous resource manager and bus
 manager, are dynamically assigned, after bus reset is initiated.
-On
+On the
 .Nm
-bus, every device is identified with EUI 64 address.
+bus, every device is identified by a EUI 64 address.
 .Sh FILES
-.Bl -tag -width indent -compact
+.Bl -tag -compact
 .It Pa /dev/fw0
 .It Pa /dev/fwmem0
 .El
 .Sh SEE ALSO
-.Xr fwcontrol 8 ,
 .Xr fwe 4 ,
 .Xr fwohci 4 ,
-.Xr kldload 8 ,
 .Xr pci 4 ,
 .Xr sbp 4 ,
+.Xr fwcontrol 8 ,
+.Xr kldload 8 ,
 .Xr sysctl 8
 .Sh HISTORY
 The
@@ -107,6 +106,7 @@
 for the
 .Fx
 project.
-.Pp
 .Sh BUGS
-See fwohci(4) for security note.
+See
+.Xr fwohci 4
+for security note.
Index: fwohci.4
===================================================================
RCS file: /usr/home/ncvs/dragonfly/src/share/man/man4/fwohci.4,v
retrieving revision 1.2
diff -u -r1.2 fwohci.4
--- fwohci.4	17 Jun 2003 04:36:59 -0000	1.2
+++ fwohci.4	28 Jan 2004 01:36:02 -0000
@@ -29,7 +29,7 @@
 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/fwohci.4,v 1.1.2.4 2003/03/03 18:51:16 trhodes Exp $
+.\" $FreeBSD: src/share/man/man4/fwohci.4,v 1.1.2.6 2003/12/25 22:48:49 brueffer Exp $
 .\" $DragonFly: src/share/man/man4/fwohci.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
 .\"
 .\"
@@ -44,13 +44,12 @@
 .Pp
 or
 .Pp
-.Cd "device fwohci"
 .Cd "device firewire"
 .Sh DESCRIPTION
 The
 .Nm
 driver provides support for PCI/CardBus firewire interface cards.
-The driver supports following IEEE 1394 OHCI chipsets.
+The driver supports the following IEEE 1394 OHCI chipsets.
 .Pp
 .Bl -item
 .It
@@ -86,7 +85,7 @@
 .Sh BUGS
 The driver allows physical access from any nodes on the bus by default.
 This means that any devices on the bus can read and modify any memory space
-which can be accessed by IEEE 1394 OHCI chip.
+which can be accessed by an IEEE 1394 OHCI chip.
 It is allowed mostly for
 .Xr sbp 4
 devices.
Index: fwe.4
===================================================================
RCS file: /usr/home/ncvs/dragonfly/src/share/man/man4/fwe.4,v
retrieving revision 1.2
diff -u -r1.2 fwe.4
--- fwe.4	17 Jun 2003 04:36:59 -0000	1.2
+++ fwe.4	28 Jan 2004 01:21:50 -0000
@@ -22,7 +22,7 @@
 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/fwe.4,v 1.2.4.3 2003/03/03 18:51:16 trhodes Exp $
+.\" $FreeBSD: src/share/man/man4/fwe.4,v 1.2.4.4 2003/12/25 22:47:38 brueffer Exp $
 .\" $DragonFly: src/share/man/man4/fwe.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
 .\"
 .\"
@@ -64,12 +64,14 @@
 .Dv DEVICE_POLLING
 option.
 .Sh HISTORY
-The fwe device driver first appeared in
+The
+.Nm
+device driver first appeared in
 .Fx 5.0 .
 .Sh BUGS
-This driver emulates ethernet very adhoc way and it does not reserve a
+This driver emulates ethernet in a very adhoc way and it does not reserve a
 stream channel using an isochronous manager.
-Note this driver uses very different protocol from RFC 2734
+Note that this driver uses a protocol which is very different from RFC 2734
 (IPv4 over IEEE 1394).
 .Sh SEE ALSO
 .Xr arp 4 ,
Index: sbp.4
===================================================================
RCS file: /usr/home/ncvs/dragonfly/src/share/man/man4/sbp.4,v
retrieving revision 1.2
diff -u -r1.2 sbp.4
--- sbp.4	17 Jun 2003 04:36:59 -0000	1.2
+++ sbp.4	28 Jan 2004 01:41:16 -0000
@@ -29,7 +29,7 @@
 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/sbp.4,v 1.1.2.3 2003/02/14 08:22:03 simokawa Exp $
+.\" $FreeBSD: src/share/man/man4/sbp.4,v 1.1.2.5 2003/12/25 22:51:32 brueffer Exp $
 .\" $DragonFly: src/share/man/man4/sbp.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
 .\"
 .Dd May 20, 2002
@@ -54,23 +54,33 @@
 .Sh DESCRIPTION
 The
 .Nm
-driver provides support for SBP-2 devices that attach to the firewire
+driver provides support for SBP-2 devices that attach to the FireWire
 (IEEE 1394) port.
-It should work with SBP-2 devices which CAM layer supports, for example,
-HDD, CDROM drive and DVD drive.
+It should work with SBP-2 devices which the CAM layer supports, for example,
+HDDs, CDROM drives and DVD drives.
 .Pp
-Some users familier with
+Some users familiar with
 .Xr umass 4
-might wander why the device is not detached at the CAM layer when the device
-is unplugged. It's detached only if the device has not been plugged again
-during several bus resets. This is for preventing to detach an active filesystem
-even when the device cannot be probe correctly for some reason after a bus reset
+might wonder why the device is not detached at the CAM layer when the device
+is unplugged.
+It is detached only if the device has not been plugged again
+during several bus resets.
+This is for preventing to detach an active file system
+even when the device cannot be probed correctly for some reason after a bus reset
 or when the device is temporary disconnected because the user changes the bus
-topology. If you want to force to detach the device, run 'fwcontrol -r'
+topology.
+If you want to force to detach the device, run
+.Dq Nm fwcontrol Fl r
 several times.
+.Pp
+Some (broken) HDDs don't work well with tagged queuing. If you have problems
+with such drives, try
+.Dq Nm camcontrol [device id] tags -N 1
+to disable tagged queuing.
 .Sh SEE ALSO
-.Xr camcontrol 8 ,
+.Xr cam 4 ,
 .Xr firewire 4 ,
+.Xr camcontrol 8 ,
 .Xr fwcontrol 8 ,
 .Xr kldload 8 ,
 .Xr sysctl 8

Attachment: pgp00021.pgp
Description: PGP signature



[Date Prev][Date Next]  [Thread Prev][Thread Next]  [Date Index][Thread Index]