Add man page for the bktr driver.

PR:		5954
Submitted by:	wlloyd@mpd.ca (with tweaks from reviewer)
This commit is contained in:
Jordan K. Hubbard 1998-03-09 10:56:22 +00:00
parent 3e8e255152
commit 593616c9ef
3 changed files with 164 additions and 2 deletions

80
share/man/man4/bktr.4 Normal file
View File

@ -0,0 +1,80 @@
.\"
.\" $Id$
.\"
.Dd January 28, 1998
.br
.in +0.5i
.Dt BKTR 4 i386
.Os FreeBSD 2.2
.Sh NAME
.Nm brooktree
.Nd video capture driver
.Sh SYNOPSIS
.Nm device bktr0
.Sh DESCRIPTION
The
.Nm bktr
driver provides support for PCI
.Em video
capture on low cost, high performance boards. The driver is heavily based on
the Matrox Meteor driver. The bktr driver should support most video cards
based on the
.Em Brooktree Bt848 Video Capture Chip.
.Pp
Specifically, the following cards are known to work:
.br
.Em Hauppage Wincast TV
.br
.Em STB TV PCI Television Tuner
.br
.Em Miro PC TV
.br
.Em Intel Smart Video Recorder III
.Pp
The driver currently supports the following features:
.br
.in +0.5i
PCI to PCI dma transfer
.br
clipping
.br
yuv
.br
rgb16
.br
rgb24
.br
rgb32
.in -0.5i
.Pp
The following kernel parameters may be used to further configure the driver:
.Pp
.Em options "BROOKTREE_ALLOC_PAGES=xxx"
specifies the number of contiguous pages to allocate when successfully
probed. The default number of pages allocated by the kernel is 216.
This means that there are (216*4096) bytes available for use.
.Pp
.Sh AUTHOR
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
and a bunch of other people.
.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
A display program utilizing the bktr driver - requires that
.Em The X Window System
and
.Em The Ports Collection
also be installed.
.El
.Sh SEE ALSO
.Xr meteor 4
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 2.2 .

View File

@ -1,6 +1,7 @@
# $Id: Makefile,v 1.71 1998/01/30 00:43:16 jkh Exp $
# $Id: Makefile,v 1.72 1998/02/18 13:50:19 msmith Exp $
MAN4= aha.4 ahb.4 ahc.4 aic.4 alog.4 apm.4 ar.4 asc.4 bt.4 cx.4 cy.4 de.4 \
MAN4= aha.4 ahb.4 ahc.4 aic.4 alog.4 apm.4 ar.4 asc.4 bktr.4 bt.4 \
cx.4 cy.4 de.4 \
dgb.4 ed.4 eg.4 el.4 ep.4 ex.4 gsc.4 fdc.4 fe.4 fxp.4 ie.4 io.4 \
joy.4 keyboard.4 labpc.4 le.4 lnc.4 lp.4 lpt.4 matcd.4 mcd.4 mem.4 \
meteor.4 mouse.4 mse.4 mtio.4 nca.4 ncr.4 npx.4 \
@ -17,6 +18,7 @@ MLINKS+= alog.4 ../alog.4
MLINKS+= apm.4 ../apm.4
MLINKS+= ar.4 ../ar.4
MLINKS+= asc.4 ../asc.4
MLINKS+= bktr.4 ../bktr.4
MLINKS+= bt.4 ../bt.4
MLINKS+= cx.4 ../cx.4
MLINKS+= cy.4 ../cy.4

View File

@ -0,0 +1,80 @@
.\"
.\" $Id$
.\"
.Dd January 28, 1998
.br
.in +0.5i
.Dt BKTR 4 i386
.Os FreeBSD 2.2
.Sh NAME
.Nm brooktree
.Nd video capture driver
.Sh SYNOPSIS
.Nm device bktr0
.Sh DESCRIPTION
The
.Nm bktr
driver provides support for PCI
.Em video
capture on low cost, high performance boards. The driver is heavily based on
the Matrox Meteor driver. The bktr driver should support most video cards
based on the
.Em Brooktree Bt848 Video Capture Chip.
.Pp
Specifically, the following cards are known to work:
.br
.Em Hauppage Wincast TV
.br
.Em STB TV PCI Television Tuner
.br
.Em Miro PC TV
.br
.Em Intel Smart Video Recorder III
.Pp
The driver currently supports the following features:
.br
.in +0.5i
PCI to PCI dma transfer
.br
clipping
.br
yuv
.br
rgb16
.br
rgb24
.br
rgb32
.in -0.5i
.Pp
The following kernel parameters may be used to further configure the driver:
.Pp
.Em options "BROOKTREE_ALLOC_PAGES=xxx"
specifies the number of contiguous pages to allocate when successfully
probed. The default number of pages allocated by the kernel is 216.
This means that there are (216*4096) bytes available for use.
.Pp
.Sh AUTHOR
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
and a bunch of other people.
.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
A display program utilizing the bktr driver - requires that
.Em The X Window System
and
.Em The Ports Collection
also be installed.
.El
.Sh SEE ALSO
.Xr meteor 4
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 2.2 .