Expand PMF_FN_* macros.
[netbsd-mini2440.git] / usr.sbin / grfconfig / grfconfig.8
blob1e2c3e86ce909b13630d31edf44f0ecfc31f345b
1 .\"     $NetBSD: grfconfig.8,v 1.15 2008/04/30 13:11:02 martin Exp $
2 .\"
3 .\" Copyright (c) 1997 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Ezra Story and Bernd Ernesti.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
29 .\"
30 .Dd October 7, 1994
31 .Dt GRFCONFIG 8 amiga
32 .Os
33 .Sh NAME
34 .Nm grfconfig
35 .Nd alter grf device screen mode definitions at run time
36 .Sh SYNOPSIS
37 .Nm
38 .Op Fl r
39 .Ar device
40 .Op Ar file
41 .Sh DESCRIPTION
42 .Nm
43 is used to change or view the screen mode definition list contained
44 in a grf device.  You may alter the console screen definition as well
45 as the definitions for the graphic screen.  The console will automatically
46 reinitialize itself to the new screen mode.
47 .Pp
48 The following flags and arguments are interpreted by
49 .Nm :
50 .Bl -tag -width indent
51 .It Fl r
52 Print out a raw listing of the mode definitions instead of the
53 pretty list normally shown.
54 .It Ar device
55 The grf device to manipulate.  This argument is required.
56 .It Ar file
57 The file which contains the mode definitions.  If this argument
58 is not specified,
59 .Nm
60 will print out of a list of the modes currently loaded into
61 the grf device.
62 .El
63 .Sh MODE DEFINITION FILE
64 The mode definitions are taken from a file which has lines of the format:
65 .Pp
66 num clk wid hi dep hbs hss hse ht vbs vss vse vt flags
67 .Pp
68 .Bl -tag -width indent
69 .It Ar num
70 The mode number or 'c' for the console mode.
71 .It Ar clk
72 The pixel clock in Hz.
73 .It Ar wid
74 The screen mode's width.
75 .It Ar hi
76 The screen mode's height.
77 .It Ar dep
78 The bitdepth of the mode. Use 4 for a text console mode.
79 .It Ar hbs hss hse ht
80 The horizontal timing parameters for the mode in pixel values.  All the
81 values are relative to the end of the horizontal blank (beginning of the
82 displayed area).
83 .It Ar vbs vss vse vt
84 The vertical timing parameters for the mode in line values.  All the
85 values are relative to the end of vertical blank (beginning of the displayed
86 area).
87 .It Ar flags
88 By default every mode uses negative horizontal and vertical sync pulses,
89 it is non-interlaced and does not use scandoubling.
90 .Pp
91 .Bl -tag -width sync-on-green -offset indent
92 .It default
93 Use the default flags: -hsync -vsync
94 .It doublescan
95 Doublescan mode
96 .It interlace
97 Interlace mode
98 .It +hsync
99 Positive horizontal sync pulses
100 .It -hsync
101 Negative horizontal sync pulses
102 .It +vsync
103 Positive vertical sync pulses
104 .It -vsync
105 Negative vertical sync pulses
106 .It sync-on-green
107 Composite sync on green
111 .Bd -literal
112  ------------------------------------------------------
113  |                           ^                        |
114  |                          vse                       |
115  |      (0,0)                                         |
116  |        *-----------------------------------        |
117  |        |                  ^        ^      |        |
118  |        |                 vbe       !      |        |
119  |        |                           !      |        |
120  |        |                           !      |        |
121  |\*[Lt]-hse   |\*[Lt]-hbe                      !      |\*[Lt]-hbs   |      |      |
122  |        |                           !      |   hss-\*[Gt]| hse-\*[Gt]| hbe-\*[Gt]|
123  |        |                          hi      |        |      |      |
124  |        |                           !      |        |
125  |        |                           !      |        |
126  |        |\*[Lt]============ wid =========+=====\*[Gt]|        |
127  |        |                           !      |        |
128  |        |                           !      |        |
129  |        |                           !      |        |
130  |        |                           v      |        |
131  |        ------------------------------------        |
132  |                           ^                        |
133  |                          vbs                       |
134  |                                                    |
135  ------------------------------------------------------
136                              ^
137                             vss
138                         - ------- -
139                              ^
140                             vse
141                         - ------- -
142                              ^
143                             vbe
145 .Sh SEE ALSO
146 .Xr console 4 ,
147 .Xr grfcl 4 ,
148 .Xr grfcv 4 ,
149 .Xr grfcv3d 4 ,
150 .Xr grfet 4 ,
151 .Xr grfrh 4 ,
152 .Xr grfrt 4 ,
153 .Xr grful 4 ,
154 .Xr iteconfig 8
155 .Sh HISTORY
158 command first appeared in
159 .Nx 1.0 .
161 The mode definition file changed two times.
164 .Nx 1.0
165 all horizontal values were videoclock cycle values instead of pixel values:
167  num clk      wid hi  dep hbs hss hse hbe ht  vbs vss vse vbe  vt
169  1   31000000 640 480  8   80  86  96 102 104 480 489 492  517  520
170  2   31000000 640 480  8   80  86  96 102 104 240 244 246  258  260
171  3   31000000 640 480  8   80  86  96 102 104 960 978 984 1034 1040
174 .Nx 1.1
176 .Nx 1.2 :
178  num clk      wid hi  dep hbs hss hse hbe ht  vbs vss vse vbe  vt
180  1   31000000 640 480  8  640 688 768 816 832 480 489 492  517  520
181  2   31000000 640 480  8  640 688 768 816 832 240 244 246  258  260
182  3   31000000 640 480  8  640 688 768 816 832 960 978 984 1034 1040
184 the vertical values were used to select the interlace or doublescan mode.
185 All vertical values were half the width for the interlace mode and twice
186 the width for the doublescan mode.
188 Beginning with
189 .Nx 1.3 :
191  num clk      wid hi  dep hbs hss hse ht  vbs vss vse vt  flags
193  1   31000000 640 480  8  640 688 768 832 480 489 492 520 default
194  2   31000000 640 480  8  640 688 768 832 480 489 492 520 interlace
195  3   31000000 640 480  8  640 688 768 832 480 489 492 520 doublescan
196  4   31000000 640 480  8  640 688 768 832 480 489 492 520 +hsync +vsync
198 hbe and vbe are computed in the grf drivers.
199 .Sh BUGS
201 can not set the modes for
202 .Pa /dev/grf1 ,
203 .Pa /dev/grf2
205 .Pa /dev/grf4
206 and it will not work for
207 .Pa /dev/grf0 .