usr.sbin/iteconfig/iteconfig.8

   1 .\"     $NetBSD: iteconfig.8,v 1.11 2003/02/25 10:36:10 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1994 Christian E. Hopps
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"      This product includes software developed by Christian E. Hopps.
  17 .\" 4. The name of the author may not be used to endorse or promote products
  18 .\"    derived from this software without specific prior written permission
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  21 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  22 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  23 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  24 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  25 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  29 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\"
  32 .Dd February 3, 1994
  33 .Dt ITECONFIG 8
  34 .Os
  35 .Sh NAME
  36 .Nm iteconfig
  37 .Nd modify console attributes at run time
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl i
  41 .Op Fl f Ar file
  42 .Op Fl v Ar volume
  43 .Op Fl p Ar pitch
  44 .Op Fl t Ar msec
  45 .Op Fl w Ar width
  46 .Op Fl h Ar height
  47 .Op Fl d Ar depth
  48 .Op Fl x Ar offset
  49 .Op Fl y Ar offset
  50 .Op Ar color ...
  51 .Sh DESCRIPTION
  52 .Nm
  53 is used to modify or examine the attributes of the
  54 console bell and bitmapped console display.
  55 The console bell's volume, pitch, and count may be
  56 specified, as well as
  57 the bitmapped display's width, height, horizontal and
  58 vertical offset, pixel depth, and color map.
  59 .Pp
  60 The following flags are interpreted by
  61 .Nm :
  62 .Bl -tag -width indent
  63 .It Fl i
  64 After processing all other arguments,
  65 print information about the console's state.
  66 .It Fl f
  67 Open and use the terminal named by
  68 .Ar file
  69 rather than the default console
  70 .Pa /dev/ttye0 .
  71 .It Fl v
  72 Set the volume of the console bell to
  73 .Ar volume ,
  74 which must be between 0 and 63, inclusive.
  75 .It Fl p
  76 Set the pitch of the console bell to
  77 .Ar pitch ,
  78 which must be between 10 and 1399.
  79 .It Fl t
  80 Set the duration of the beep to
  81 .Ar msec
  82 milliseconds which must be between 1 and 5000 (5 seconds).
  83 .It Fl w
  84 Set the width of the console display to
  85 .Ar width
  86 pixel columns.
  87 .Ar Width
  88 must be a positive integer.
  89 .It Fl h
  90 Set the height of the console display to
  91 .Ar height
  92 pixel rows.
  93 .Ar Height
  94 must be a positive integer.
  95 .It Fl d
  96 Set the number of bitplanes the console view should use to
  97 .Ar depth .
  98 For example, if
  99 .Ar depth
 100 is 3 then 8 colors will be used.
 101 .It Fl x
 102 Set the horizontal offset of the console view on the monitor to
 103 .Ar offset
 104 pixel columns.  The horizontal offset may be a positive or a
 105 negative integer, positive being an offset to the right, negative
 106 to the left.
 107 .It Fl y
 108 Set the vertical offset of the console view on the monitor to
 109 .Ar offset
 110 pixel rows.  The vertical offset may be a positive or a negative
 111 integer, positive being an offset down, negative up.
 112 .El
 113 .Pp
 114 Any additional arguments will be interpreted as colors and will
 115 be used to supply the color values for the console view's
 116 color map, starting with the first entry in the map.  (See the
 117 .Sx COLOR SPECIFICATION
 118 section of this manual page for information on how to specify
 119 colors.)
 120 If more colors are supplied than are usable by the console
 121 view, a warning is printed and the extra colors are ignored.
 122 .Sh COLOR SPECIFICATION
 123 Colors are hexadecimal numbers which have one of the following
 124 formats:
 125 .Bl -tag -width "0xRRGGBB"
 126 .It Ar 0xRRGGBB
 127 .Ar RR ,
 128 .Ar GG ,
 129 and
 130 .Ar BB
 131 are taken to be eight-bit values specifying the
 132 intensities of the red, green and blue components, respectively,
 133 of the color to be used.  For example,
 134 .Li 0xff0000
 135 is bright red,
 136 .Li 0xffffff
 137 is white, and
 138 .Li 0x008080
 139 is dark cyan.
 140 .It Ar 0xGG
 141 .Ar GG
 142 is taken to be an eight-bit value specifying the intensity
 143 of grey to be used.  A value of
 144 .Li 0x00
 145 is black, a value of
 146 .Li 0xff
 147 is white, and a value of
 148 .Li 0x80
 149 is a grey
 150 approximately half way in between.
 151 .It Ar 0xM
 152 .Ar M
 153 is taken to be the one-bit monochrome value to be used.
 154 A value of
 155 .Li 0x1
 156 is black, and a value of
 157 .Li 0x0
 158 is white.
 159 .El
 160 .Sh BUGS
 161 The
 162 .Nm
 163 command is only available on the
 164 .Tn amiga
 165 and
 166 .Tn atari
 167 ports.