usr.sbin/pcvt/vgaio/vgaio.8

   1 .\"
   2 .\" Copyright (c) 1994 Joerg Wunsch
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" This program is free software.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by Joerg Wunsch
  19 .\" 4. The name of the developer may not be used to endorse or promote
  20 .\"    products derived from this software without specific prior written
  21 .\"    permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  24 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  25 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  26 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  28 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  32 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33 .\"
  34 .\" $FreeBSD: src/usr.sbin/pcvt/vgaio/vgaio.8,v 1.6.2.7 2003/03/11 22:31:30 trhodes Exp $
  35 .\" $DragonFly: src/usr.sbin/pcvt/vgaio/Attic/vgaio.8,v 1.2 2003/06/17 04:29:59 dillon Exp $
  36 .\" -hm updated 31.12.94
  37 .\"
  38 .Dd December 31, 1994
  39 .Dt VGAIO 8
  40 .Os
  41 .Sh NAME
  42 .Nm vgaio
  43 .Nd perform input/output on a Video Graphics Array
  44 .Sh SYNOPSIS
  45 .Nm
  46 .Op Fl d
  47 .Sh DESCRIPTION
  48 .Ss Purpose
  49 The
  50 .Nm
  51 utility
  52 is used to perform register-level input/output on a Video Graphics Array.
  53 Since some of the sequences required to access those registers are very
  54 silly,
  55 .Nm
  56 cares of all the things necessary and allows the user to access the
  57 registers of several register groups with their symbolic names.
  58 .Ss Options
  59 .Bl -tag -width 10n -offset indent
  60 .It Fl d
  61 Turn on the grammar parser debugger.
  62 .El
  63 .Ss Command language
  64 The command language of
  65 .Nm
  66 constitutes of some very simple tokens and rules.
  67 Commands are executed
  68 line by line as they are entered.
  69 Each line may contain any number of
  70 semicolon-separated input/output commands.
  71 .Pp
  72 Symbolic register names look like:
  73 .Pp
  74 .D1 Ao Em reggroup Ac Ns Aq Em regnumber
  75 .Pp
  76 with
  77 .Aq Em regnumber
  78 being any hexadecimal number
  79 (without a leading
  80 .Em 0x ) ,
  81 and
  82 .Aq Em reggroup
  83 one of the strings
  84 .Dq Em ar ,
  85 .Dq Em cr ,
  86 .Dq Em gr ,
  87 .Dq Em mi ,
  88 or
  89 .Dq Em sr ,
  90 standing for the
  91 .Em Attribute controller ,
  92 .Em CRT controller ,
  93 .Em Graphics controller ,
  94 .Em Miscellaneous Output Register ,
  95 or
  96 .Em Timing sequencer ,
  97 respectively.
  98 .Pp
  99 An input instruction has the form
 100 .Pp
 101 .D1 Ao Em regname Ac \&?
 102 .Pp
 103 and will cause
 104 .Nm
 105 to output a line like
 106 .Bd -ragged -offset indent
 107 .Aq Em regname
 108 .No = 0x Ns Aq Em number
 109 .Ed
 110 .Pp
 111 An output instruction looks like
 112 .Bd -ragged -offset indent
 113 .Ao Em regname Ac =
 114 .Aq Em number
 115 .Ed
 116 .Pp
 117 Spaces or Tabs between the
 118 .Aq Em reggroup ,
 119 the
 120 .Aq Em regnumber ,
 121 or any of the other tokens are ignored.
 122 They are not required anyway.
 123 .Pp
 124 The
 125 .Dq Em mi
 126 needs a single unused argument to satisfy the syntax :-) (-hm).
 127 .Ss Access control
 128 The caller must have uid 0 in order to gain the required access to
 129 the IO registers.
 130 .Sh HISTORY
 131 This program is considered
 132 .Dq hackware .
 133 It has been developed in order to simplify the process of developing other
 134 software that needs to program the Video Graphics Array.
 135 .Pp
 136 Remember, to use this program, your kernel has to be compiled with XSERVER
 137 being defined!
 138 .Sh AUTHORS
 139 The program has been contributed by
 140 .An J\(:org Wunsch ,
 141 Dresden
 142 .Aq joerg_wunsch@uriah.sax.de .