* Fix incorrect usage of \- (mathematical minus).
authorSascha Wildner <swildner@dragonflybsd.org>
Thu, 30 Mar 2006 09:52:48 +0000 (09:52 +0000)
committerSascha Wildner <swildner@dragonflybsd.org>
Thu, 30 Mar 2006 09:52:48 +0000 (09:52 +0000)
* Kill hard sentence break.

* Call the driver 'bktr' throughout the document.

* Add HARDWARE section and move the list of supported cards there.

* Use .Cd for configuration declarations.

* Change ports references to pkgsrc.

Except for the pkgsrc references, those were all taken from FreeBSD.

share/man/man4/bktr.4

index a7be93b..f25ac50 100644 (file)
@@ -1,13 +1,13 @@
 .\"
 .\" $FreeBSD: src/share/man/man4/bktr.4,v 1.9.2.9 2002/03/29 09:55:39 schweikh Exp $
-.\" $DragonFly: src/share/man/man4/bktr.4,v 1.4 2006/02/17 19:37:09 swildner Exp $
+.\" $DragonFly: src/share/man/man4/bktr.4,v 1.5 2006/03/30 09:52:48 swildner Exp $
 .\"
-.Dd January 28, 1998
+.Dd March 30, 2006
 .Dt BKTR 4
 .Os
 .Sh NAME
-.Nm brooktree
-.Nd video capture driver
+.Nm bktr
+.Nd Brooktree Bt848/849/878/879 video capture driver
 .Sh SYNOPSIS
 .Cd device bktr
 .Pp
 .Cd device smbus
 .Sh DESCRIPTION
 The
-.Nm bktr
+.Nm
 driver provides support for PCI
 .Em video
 capture and
 .Em VBI
 capture on low cost, high performance boards.
 The driver is based on the Matrox Meteor driver and uses the same API.
-The bktr driver should support most video cards
+The
+.Nm
+driver should support most video cards
 based on the
 .Em "Brooktree Bt848/849/878/879 Video Capture Chip" .
 The driver also supports
 .Em FM Radio
 if the tuner supports it.
 .Pp
-Specifically, the following cards are known to work:
-.Bd -unfilled -offset indent
-.Em Hauppauge Wincast TV and WinTV/PCI
-.Em STB TV PCI Television Tuner
-.Em Miro PC TV
-.Em Intel Smart Video Recorder III
-.Em AverMedia cards
-.Em Video Highway XTreme
-.Em VideoLogic Captivator PCI
-.Ed
-.Pp
 The driver currently supports the following features:
 .Bd -unfilled -offset indent
 PCI to PCI dma transfer
@@ -51,14 +42,17 @@ rgb24
 rgb32
 .Ed
 .Pp
-On these cards, tuners and other components are interconnected with an I2C bus.
+On the supported cards, tuners and other components are interconnected
+with an I2C bus.
 The Brooktree848 chips act as a master device on the bus to control them.
 Therefore,
 .Xr iicbus 4 ,
 .Xr iicbb 4
 and
 .Xr smbus 4
-controller declarations are mandatory to activate bktr support.
+controller declarations are mandatory to activate
+.Nm
+support.
 .Pp
 The following kernel parameters may be used to further configure the driver:
 .Pp
@@ -68,8 +62,8 @@ probed.
 The default number of pages allocated by the kernel is 216.
 This means that there are (216*4096) bytes available for use.
 .Bd -unfilled
-.Em options BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
-.Em options BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
+.Cd options BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
+.Cd options BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
 .Ed
 One of these options can be used to set the default video format for the driver.
 This fixed random hangs and lockups with the VideoLogic Captivator PCI card.
@@ -145,27 +139,49 @@ is set to an integer from 1 to 13 taken from the following table:
 .It ALPS_TSBH1
 13
 .El
+.Sh HARDWARE
+The
+.Nm
+driver supports video capture cards based on the
+Brooktree Bt848/849/878/879 chips, including:
+.Pp
+.Bl -bullet -compact
+.It
+Hauppauge Wincast TV and WinTV/PCI
+.It
+STB TV PCI Television Tuner
+.It
+Miro PC TV
+.It
+Intel Smart Video Recorder III
+.It
+AverMedia cards
+.It
+Video Highway XTreme
+.It
+VideoLogic Captivator PCI
+.El
 .Sh FILES
 .Bl -tag -width /usr/share/examples/meteor -compact
 .It Pa /usr/share/examples/meteor
 Examples of what you can do with the (similarly designed) Meteor driver.
-.It Pa /usr/ports/graphics/fxtv
+.It Pa /usr/pkgsrc/multimedia/fxtv
 A TV and Camera display program utilizing the bktr driver - requires that
 .Em The X Window System
 and
-.Em The Ports Collection
+.Em The pkgsrc Collection
 also be installed.
-.It Pa /usr/ports/misc/alevt
+.It Pa /usr/pkgsrc/multimedia/alevt
 A program to capture and display Teletext (VideoText) pages - requires that
 .Em The X Window System
 and
-.Em The Ports Collection
+.Em The pkgsrc Collection
 also be installed.
-.It Pa /usr/ports/audio/xmradio
-An FM Radio Tuner for cards which have an FM Radio tuner fitted. - requires that
+.It Pa /usr/pkgsrc/audio/xmradio
+An FM Radio Tuner for cards which have an FM Radio tuner fitted - requires that
 .Em The X Window System
 and
-.Em The Ports Collection
+.Em The pkgsrc Collection
 also be installed.
 It also requires
 .Em Motif
@@ -185,6 +201,6 @@ driver first appeared in
 This driver is based on the work of
 .An Jim Lowe Aq james@miller.cs.uwm.edu ,
 .An Mark Tinguely Aq tinguely@plains.nodak.edu ,
-.An Amancio Hasty Aq hasty@star\-gate.com ,
+.An Amancio Hasty Aq hasty@star-gate.com ,
 .An Roger Hardiman Aq roger@FreeBSD.org
 and a bunch of other people.