BSD 4_3_Net_2 release

[unix-history] / usr / src / share / man / man4 / man4.hp300 / gb.4

diff --git a/usr/src/share/man/man4/man4.hp300/gb.4 b/usr/src/share/man/man4/man4.hp300/gb.4
index 8836105..3216ea5 100644 (file)
--- a/usr/src/share/man/man4/man4.hp300/gb.4
+++ b/usr/src/share/man/man4/man4.hp300/gb.4
@@ -1,143 +1,184 @@
-.\" Copyright (c) 1990 The Regents of the University of California.
+.\" Copyright (c) 1990, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to Berkeley by
 .\" the Systems Programming Group of the University of Utah Computer
 .\" Science Department.
 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to Berkeley by
 .\" the Systems Programming Group of the University of Utah Computer
 .\" Science Department.

+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.\"    @(#)gb.4        5.1 (Berkeley) 6/29/90
+.\"     @(#)gb.4       5.2 (Berkeley) 3/27/91

 .\"
 .\"

-.TH GB 4 "June 29, 1990"
-.UC 7
-.SH NAME
-gb \- HP98700 ``Gatorbox'' device interface
-.SH DESCRIPTION
-This driver is for the HP98700 and 98710 graphics devices, also known as
+.Dd March 27, 1991
+.Dt GB 4 hp300
+.Os
+.Sh NAME
+.Nm gb
+.Nd
+.Tn HP98700
+``Gatorbox'' device interface
+.Sh DESCRIPTION
+This driver is for the
+.Tn HP98700
+and 98710 graphics devices, also known as

 the Gatorbox.  The term ``Gator'' will often be used, and it is not to be
 the Gatorbox.  The term ``Gator'' will often be used, and it is not to be

-confused with ``Gator'' used in reference to an HP 9837 or 200/237 machine.
+confused with ``Gator'' used in reference to an
+.Tn HP
+9837 or 200/237 machine.

 Also, the term Gatorbox is used for the 98700 alone, with the 98701 frame
 buffer memory or with the 98710 accelerator installed.  This driver merely
 checks for the existence of the device and does minimal set up, as it is
 expected the applications will initialize the device to their requirements.
 Also, the term Gatorbox is used for the 98700 alone, with the 98701 frame
 buffer memory or with the 98710 accelerator installed.  This driver merely
 checks for the existence of the device and does minimal set up, as it is
 expected the applications will initialize the device to their requirements.

-.PP
+.Pp

 The 98700 can be used as the only graphics device on a system, in which case
 it will be used as the system console.  It can also be installed as a secondary
 The 98700 can be used as the only graphics device on a system, in which case
 it will be used as the system console.  It can also be installed as a secondary

-display device.  For the first case, the HP 98287A M.A.D. interface card
+display device.  For the first case, the
+.Tn HP
+.Tn 98287A M.A.D.
+interface card

 should be set to internal control space.  This will put the frame buffer at
 the DIO address 0x200000 and the control registers at 0x560000.
 At this address it will be the ``preferred'' console device (see
 should be set to internal control space.  This will put the frame buffer at
 the DIO address 0x200000 and the control registers at 0x560000.
 At this address it will be the ``preferred'' console device (see

-.IR cons (4)).
+.Xr cons 4 ) .

 For use as a secondary device,
 the 98287A should be set to frame buffer address 0x300000,
 and to an external select code.
 For use as a secondary device,
 the 98287A should be set to frame buffer address 0x300000,
 and to an external select code.

-.PP
+.Pp

 It should be noted that this configuration will conflict with the 98547
 display card which has a 2 megabyte frame buffer starting at address 0x200000.
 The 98700 should only be installed as a secondary device in a machine with a
 1 bit 98544 display card or 4 bit 98545 card.
 The
 It should be noted that this configuration will conflict with the 98547
 display card which has a 2 megabyte frame buffer starting at address 0x200000.
 The 98700 should only be installed as a secondary device in a machine with a
 1 bit 98544 display card or 4 bit 98545 card.
 The

-.I "98700H Installation Guide"
+.%T 98700H Installation Guide

 contains further configuration information.
 contains further configuration information.

-.PP
+.Pp

 The
 The

-.IR ioctl (2)
-calls supported by the BSD system for the Gatorbox are:
-.TP
-GRFIOCGINFO
+.Xr ioctl 2
+calls supported by the
+.Bx
+system for the Gatorbox are:
+.Bl -tag -width indent
+.It Dv GRFIOCGINFO

 Get Graphics Info
 Get Graphics Info

-.sp
+.Pp

 Get info about device, setting the entries in the
 Get info about device, setting the entries in the

-.I grfinfo
-structure, as defined in <hpdev/grfioctl.h>.
+.Em grfinfo
+structure, as defined in
+.Aq Pa hpdev/grfioctl.h .

 For the standard 98700, the number of planes should be 4.  The number of
 colors would therefore be 15, excluding black.  With the 98701 option installed
 there will be another 4 planes for a total of 8, giving 255 colors.
 For the standard 98700, the number of planes should be 4.  The number of
 colors would therefore be 15, excluding black.  With the 98701 option installed
 there will be another 4 planes for a total of 8, giving 255 colors.

-.TP
-GRFIOCON
+.It Dv GRFIOCON

 Graphics On
 Graphics On

-.sp
-Turn graphics on by enabling CRT output.  The screen will come on, displaying
+.Pp
+Turn graphics on by enabling
+.Tn CRT
+output.  The screen will come on, displaying

 whatever is in the frame buffer, using whatever colormap is in place.
 whatever is in the frame buffer, using whatever colormap is in place.

-.TP
-GRFIOCOFF
+.It Dv GRFIOCOFF

 Graphics Off
 Graphics Off

-.sp
-Turn graphics off by disabling output to the CRT.  The frame buffer contents
+.Pp
+Turn graphics off by disabling output to the
+.Tn CRT .
+The frame buffer contents

 are not affected.
 are not affected.

-.TP
-GRFIOCMAP
+.It Dv GRFIOCMAP

 Map Device to user space
 Map Device to user space

-.sp
+.Pp

 Map in control registers and framebuffer space. Once the device file is
 mapped, the frame buffer structure is accessible.
 The frame buffer structure describing the 98700
 Map in control registers and framebuffer space. Once the device file is
 mapped, the frame buffer structure is accessible.
 The frame buffer structure describing the 98700

-is given in <hpdev/grf_gbreg.h>.
-.TP
-GRFIOCUNMAP
+is given in
+.Aq Pa hpdev/grf_gbreg.h .
+.It Dv GRFIOCUNMAP

 Unmap Device
 Unmap Device

-.sp
+.Pp

 Unmap control registers and framebuffer space.
 Unmap control registers and framebuffer space.

-.PP
+.Pp

 For further information about the use of ioctl see the man page.
 For further information about the use of ioctl see the man page.

-.SH EXAMPLE
+.El
+.Sh EXAMPLE

 A small example of opening, mapping and using the device is given below.
 For more examples of the details on the behavior of the device, see the device
 dependent source files for the X Window System, in the
 A small example of opening, mapping and using the device is given below.
 For more examples of the details on the behavior of the device, see the device
 dependent source files for the X Window System, in the

-.I /usr/src/new/X/libhp.fb
+.Pa /usr/src/new/X/libhp.fb

 directory.
 directory.

-.DS
-{
-    struct gboxfb *gbox;
-    u_char *Addr, frame_buffer;
-    struct grfinfo gi;
-    int disp_fd;
+.Bd -literal -offset indent
+struct gboxfb *gbox;
+u_char *Addr, frame_buffer;
+struct grfinfo gi;
+int disp_fd;

 
 

-      disp_fd = open("/dev/grf0",1);
+disp_fd = open("/dev/grf0",1);

 
 

-      if (ioctl (disp_fd, GRFIOCGINFO, &gi) < 0) return -1;
+if (ioctl (disp_fd, GRFIOCGINFO, &gi) < 0) return -1;

 
 

-      (void) ioctl (disp_fd, GRFIOCON, 0);
+(void) ioctl (disp_fd, GRFIOCON, 0);

 
 

-      Addr = (u_char *) 0;
-      if (ioctl (disp_fd, GRFIOCMAP, &Addr) < 0) {
-           (void) ioctl (disp_fd, GRFIOCOFF, 0);
-           return -1;
-      }
-      gbox = (gboxfb *) Addr;                         /* Control Registers   */
-      frame_buffer = (u_char *) Addr + gi.gd_regsize; /* Frame buffer memory */
+Addr = (u_char *) 0;
+if (ioctl (disp_fd, GRFIOCMAP, &Addr) < 0) {
+(void) ioctl (disp_fd, GRFIOCOFF, 0);
+return -1;

 }
 }

-.DE
-.SH SEE ALSO
-ioctl(2), grf(4)
-.SH FILES
-/dev/grf?      BSD special file
-.br
-/dev/crt98700  HP-UX \fIstarbase\fP special file
-.SH ERRORS
-.TP 15
-[ENODEV]
+gbox = (gboxfb *) Addr;                         /* Control Registers   */
+frame_buffer = (u_char *) Addr + gi.gd_regsize; /* Frame buffer memory */
+.Ed
+.Sh FILES
+.Bl -tag -width /dev/crt98700 -compact
+.It Pa /dev/grf?
+.Bx
+special file
+.It Pa /dev/crt98700
+.Tn HP-UX
+.Em starbase
+special file
+.El
+.Sh DIAGNOSTICS
+None under
+.Bx .
+.Tn HP-UX
+The
+.Tn CE.utilities/Crtadjust
+programs must be used.
+.Sh ERRORS
+.Bl -tag -width [EINVAL]
+.It Bq Er ENODEV

 no such device.
 no such device.

-.TP 15
-[EBUSY]
+.It Bq Er EBUSY

 Another process has the device open.
 Another process has the device open.

-.TP 15
-[EINVAL]
+.It Bq Er EINVAL

 Invalid ioctl specification.
 Invalid ioctl specification.

-.SH DIAGNOSTICS
-None under BSD.
-.br
-HP-UX CE.utilities/Crtadjust programs must be used.
+.El
+.Sh SEE ALSO
+.Xr ioctl 2 ,
+.Xr grf 4
+.Sh HISTORY
+The
+.Nm
+driver
+.Ud