]> git.lizzy.rs Git - plan9front.git/blob - sys/man/3/vga
audiohda: fix syntax error
[plan9front.git] / sys / man / 3 / vga
1 .TH VGA 3 
2 .SH NAME
3 vga \- VGA controller device
4 .SH SYNOPSIS
5 .nf
6 .B bind #v /dev
7
8 .B /dev/vgactl
9 .fi
10 .SH DESCRIPTION
11 The VGA device allows configuration of a graphics controller
12 on a PC.
13 .B Vgactl
14 allows control over higher-level settings such as display height, width, depth,
15 controller and hardware-cursor type.
16 Along with the I/O-port registers
17 provided by
18 .IR arch (3),
19 it is used to implement configuration and setup of VGA controller cards.
20 This is usually performed by
21 .IR vga (8).
22 .PP
23 Writing strings to 
24 .B vgactl
25 configures the VGA device.
26 The following are valid commands.
27 .TP
28 .BI size " X" x Y x "Z chan"
29 Set the size of the screen image to be
30 .I X 
31 pixels wide
32 and
33 .I Y 
34 pixels high.
35 Each pixel is 
36 .I Z 
37 bits as specified by 
38 .IR chan ,
39 whose format is described in
40 .IR image (6).
41 .TP
42 .BI actualsize " X" x Y
43 Set the physical size of the display to be
44 .I X
45 pixels wide by
46 .I Y 
47 pixels high.
48 This message is optional;
49 it is used to accommodate displays that require the
50 in-memory screen image to have certain alignment properties.
51 For example, a 1400x1050 screen with a 1408x1050 in-memory image
52 will use 
53 .B "size 1408x1050
54 but
55 .BR "actualsize 1400x1050" .
56 .TP
57 .BI tilt " value"
58 Set the tilt of the screen,
59 altering the screen's orientation.
60 The
61 .I value
62 can be one of:
63 .BR none ,
64 .BR left ,
65 .B inverted
66 and
67 .BR right .
68 .TP
69 .BI type " ctlr"
70 Set the type of VGA controller being used.
71 .I Ctlr
72 is one of 
73 .BR 3dfx ,
74 .BR ark200pv ,
75 .BR clgd542x ,
76 .BR clgd546x ,
77 .BR ct65545 ,
78 .BR cyber938x ,
79 .BR et4000 ,
80 .BR geode ,
81 .BR hiqvideo ,
82 .BR i81x ,
83 .BR igfx ,
84 .BR mach64xx ,
85 .BR mga2164w ,
86 .BR mga4xx ,
87 .BR neomagic ,
88 .BR nvidia ,
89 .BR radeon ,
90 .BR s3 ,
91 .BR t2r4
92 and
93 .BR vmware .
94 .IP
95 Note that this list does not indicate the full set of VGA chips
96 supported. For example,
97 .B s3
98 includes the 86C801/5, 86C928, Vision864, and Vision964.
99 It is the job of
100 .IR vga (8)
101 to recognize which particular chip is being used and to initialize it
102 appropriately.
103 .TP
104 .BI hwgc " gc"
105 Set the type of hardware graphics cursor being used.
106 .I Gc
107 is one of
108 .BR soft ,
109 .BR 3dfxhwgc ,
110 .BR ark200pvhwgc ,
111 .BR bt485hwgc ,
112 .BR clgd542xhwgc ,
113 .BR clgd546xhwgc ,
114 .BR ct65545hwgc ,
115 .BR cyber938xhwgc ,
116 .BR et4000hwgc ,
117 .BR geodehwgc ,
118 .BR hiqvideohwgc ,
119 .BR i81xhwgc ,
120 .BR igfxhwgc ,
121 .BR mga2164whwgc ,
122 .BR mach64xxhwgc ,
123 .BR neomagichwgc ,
124 .BR nvidiahwgc ,
125 .BR radeonhwgc ,
126 .BR rgb524hwgc ,
127 .BR s3hwgc ,
128 .BR t2r4hwgc ,
129 .BR tvp3020hwgc ,
130 .BR tvp3026hwgc
131 and
132 .BR vmwarehwgc .
133 A value of
134 .B off
135 disables the cursor.
136 .TP
137 .BI palettedepth " d"
138 Set the number of bits of precision used by the 
139 VGA palette to 
140 .IR d ,
141 which must be either 
142 .B 6
143 or
144 .BR 8 .
145 .TP
146 .BI hwaccel " mode"
147 Depending on whether
148 .I mode
149 is 
150 .B on
151 or
152 .BR off ,
153 enable or disable whether hardware acceleration
154 (currently for rectangle filling and moving)
155 used by the graphics engine.
156 The default setting is
157 .BR on .
158 .TP
159 .BI softscreen " mode"
160 Depending on whether
161 .I mode
162 is 
163 .B on
164 or
165 .BR off ,
166 enable or disable shadow framebuffer to reduce
167 slow bus reads. Enabling
168 .BI softscreen
169 disables hardware acceleration. The default setting is
170 .BR off
171 except for the
172 .BR vesa
173 driver. 
174 .TP
175 .BI hwblank " mode"
176 Depending on whether
177 .I mode
178 is
179 .B on
180 or
181 .BR off ,
182 enable or disable the use of DPMS blanking
183 (see
184 .IR mouse (3)).
185 .TP
186 .BI linear " size align"
187 Use a linear screen aperture of size
188 .I size
189 aligned on an
190 .IR align -byte
191 boundary.
192 .TP
193 .B drawinit
194 Initialize the graphics hardware.
195 This must be sent after setting the
196 .BR type .
197 .PP
198 Reading
199 .B vgactl
200 returns the current settings, one per line.
201 .SH EXAMPLES
202 The following disables hardware acceleration.
203 .IP
204 .EX
205 echo hwaccel off > /dev/vgactl
206 .EE
207 .SH SOURCE
208 .B /sys/src/9/pc/devvga.c
209 .SH SEE ALSO
210 .IR arch (3),
211 .IR vga (8)
212 .SH BUGS
213 The hardware graphics cursor on the
214 .B et4000
215 does not work in 2x8-bit mode.