← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/vnc4/gutsy

« back to all changes in this revision

Viewing changes to unix/xc/programs/Xserver/hw/xfree86/drivers/siliconmotion/siliconmotion.man

  • Committer: Bazaar Package Importer
  • Author(s): Ola Lundqvist
  • Date: 2006-05-15 20:35:17 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060515203517-l4lre1ku942mn26k
Tags: 4.1.1+X4.3.0-10
* Correction of critical security issue. Thanks to Martin Kogler
  <e9925248@student.tuwien.ac.at> that informed me about the issue,
  and provided the patch.
  This flaw was originally found by Steve Wiseman of intelliadmin.com.
* Applied patch from Javier Kohen <jkohen@users.sourceforge.net> that
  inform the user that only 8 first characters of the password will
  actually be used when typing more than 8 characters, closes:
  #355619.

Show diffs side-by-side

added added

removed removed

Lines of Context:
unix/xc/programs/Xserver/hw/xfree86/drivers/siliconmotion/siliconmotion.man
 
1
.\" Header:   //Mercury/Projects/archives/XFree86/4.0/siliconmotion.cpp-arc   1.4   29 Nov 2000 14:12:56   Frido  $
 
2
.\" $XFree86: xc/programs/Xserver/hw/xfree86/drivers/siliconmotion/siliconmotion.man,v 1.4 2001/12/20 21:35:38 eich Exp $
 
3
.\" shorthand for double quote that works everywhere.
 
4
.ds q \N'34'
 
5
.TH siliconmotion __drivermansuffix__ __vendorversion__
 
6
.SH NAME
 
7
siliconmotion \- Silicon Motion video driver
 
8
.SH SYNOPSIS
 
9
.B "Section \*qDevice\*q"
 
10
.br
 
11
.BI "  Identifier \*q"  devname \*q
 
12
.br
 
13
.B  "  Driver \*qsiliconmotion\*q"
 
14
.br
 
15
\ \ ...
 
16
.br
 
17
\ \ [
 
18
.B "Option"
 
19
"optionname" ["optionvalue"]]
 
20
.br
 
21
.B EndSection
 
22
.SH DESCRIPTION
 
23
.B siliconmotion 
 
24
is an XFree86 driver for Silicon Motion based video cards.  The driver is fully
 
25
accelerated, and provides support for the following framebuffer depths:
 
26
8, 16, and 24.  All
 
27
visual types are supported for depth 8, and TrueColor
 
28
visuals are supported for the other depths.
 
29
.SH SUPPORTED HARDWARE
 
30
The
 
31
.B siliconmotion
 
32
driver supports PCI and AGP video cards based on the following Silicon Motion chips:
 
33
.TP 12
 
34
.B Lynx
 
35
SM910
 
36
.TP 12
 
37
.B LynxE
 
38
SM810
 
39
.TP 12
 
40
.B Lynx3D
 
41
SM820
 
42
.TP 12
 
43
.B LynxEM
 
44
SM710
 
45
.TP 12
 
46
.B LynxEM+
 
47
SM712
 
48
.TP 12
 
49
.B Lynx3DM
 
50
SM720
 
51
.SH CONFIGURATION DETAILS
 
52
Please refer to XF86Config(__filemansuffix__) for general configuration
 
53
details.  This section only covers configuration details specific to this
 
54
driver.  All options names are case and white space insensitive when
 
55
parsed by the server, for example,  "lynxe" and "LynxE" are equivalent.
 
56
.PP
 
57
The driver auto-detects the chipset type, but the following
 
58
.B ChipSet
 
59
names may optionally be specified in the config file
 
60
.B \*qDevice\*q
 
61
section, and will override the auto-detection:
 
62
.PP
 
63
.RS 4
 
64
"lynx", "lynxe", "lynx3d", "lynxem", "lynxem+", "lynx3dm".
 
65
.RE
 
66
 
 
67
.PP
 
68
The following Cursor
 
69
.B Options
 
70
are supported:
 
71
.TP
 
72
.BI "Option \*qHWCursor\*q \*q" boolean \*q
 
73
Enable or disable the HW cursor.  Default: on.
 
74
.TP
 
75
.BI "Option \*qSWCursor\*q \*q" boolean \*q
 
76
Inverse of "HWCursor".  Default: off.
 
77
 
 
78
.PP
 
79
The following display
 
80
.B Options
 
81
are supported:
 
82
.TP
 
83
.BI "Option \*qShadowFB\*q \*q" boolean \*q
 
84
Use shadow framebuffer.  Default: off.
 
85
.TP
 
86
.BI "Option \*qRotate\*q \*qCW\*q"
 
87
.TP
 
88
.BI "Option \*qRotate\*q \*qCCW\*q"
 
89
Rotate the screen CW - clockwise or CCW - counter clockwise.
 
90
Uses ShadowFB.  Default: no rotation.
 
91
.TP
 
92
.BI "Option \*qVideoKey\*q \*q" integer \*q
 
93
Set the video color key.  Default: a little off full blue.
 
94
.TP
 
95
.BI "Option \*qByteSwap\*q \*q" boolean \*q
 
96
Turn on byte swapping for capturing using SMI demo board.  Default: off.
 
97
.TP
 
98
.BI "Option \*qInterlaced\*q \*q" boolean \*q
 
99
Turn on interlaced video capturing.  Default: off.
 
100
.TP
 
101
.BI "Option \*qUseBIOS\*q \*q" boolean \*q
 
102
Use the BIOS to set the modes. This is used for custom panel timings.
 
103
Default: on.
 
104
.TP
 
105
.BI "Option \*qZoomOnLCD\*q \*q" boolean \*q
 
106
Allow changing resolution on LCD (Ctrl-Alt-Plus and Ctrl-Alt-Minus).
 
107
Default: off.
 
108
 
 
109
.PP
 
110
The following video memory
 
111
.B Options
 
112
are supported:
 
113
.TP
 
114
.BI "Option \*qset_mclk\*q \*q" integer \*q
 
115
sets the memory clock, where
 
116
.I integer
 
117
is in kHz, and
 
118
.I integer
 
119
<= 100000.  Default: probe the memory clock value,
 
120
and use it at server start.
 
121
 
 
122
 
 
123
.PP
 
124
The following acceleration and graphics engine
 
125
.B Options
 
126
are supported:
 
127
.TP
 
128
.B "Option \*qNoAccel\*q"
 
129
Disable acceleration.  Very useful for determining if the
 
130
driver has problems with drawing and acceleration routines.  This is the first
 
131
option to try if your server runs but you see graphic corruption on the screen.
 
132
Using it decreases performance, as it uses software emulation for drawing
 
133
operations the video driver can accelerate with hardware.
 
134
Default: acceleration is enabled.
 
135
.TP
 
136
.B "Option \*qfifo_aggressive\*q"
 
137
.TP
 
138
.B "Option \*qfifo_moderate\*q"
 
139
.TP
 
140
.B "Option \*qfifo_conservative\*q"
 
141
alter the settings
 
142
for the threshold at which the pixel FIFO takes over the internal 
 
143
memory bus to refill itself. The smaller this threshold, the better
 
144
the acceleration performance of the card. You may try the fastest 
 
145
setting
 
146
.RB ( "fifo_aggressive" )
 
147
and move down if you encounter pixel corruption.
 
148
The optimal setting will probably depend on dot-clock and on color 
 
149
depth. Note that specifying any of these options will also alter other
 
150
memory settings which may increase performance, so trying
 
151
.B "fifo_conservative"
 
152
will in most cases be a slight benefit (this uses the chip defaults).
 
153
If pixel corruption or transient streaking is observed during drawing
 
154
operations then removing any fifo options is recommended.  Default: none.
 
155
 
 
156
.PP
 
157
The following PCI bus
 
158
.B Options
 
159
are supported:
 
160
.TP
 
161
.BI "Option \*qpci_burst\*q \*q" boolean \*q
 
162
will enable PCI burst mode. This should work on all but a
 
163
few broken PCI chipsets, and will increase performance.  Default: off.
 
164
.TP
 
165
.BI "Option \*qpci_retry\*q \*q" boolean \*q
 
166
will allow the driver to rely on PCI Retry to program the 
 
167
ViRGE registers. 
 
168
.B "pci_burst"
 
169
must be enabled for this to work. 
 
170
This will increase performance, especially for small fills/blits, 
 
171
because the driver does not have to poll the ViRGE before sending it 
 
172
commands to make sure it is ready. It should work on most 
 
173
recent PCI chipsets.  Default: off.
 
174
 
 
175
.PP
 
176
The following additional
 
177
.B Options
 
178
are supported:
 
179
.TP
 
180
.BI "Option \*qShowCache\*q \*q" boolean \*q
 
181
Enable or disable viewing offscreen cache memory.  A
 
182
development debug option.  Default: off.
 
183
 
 
184
.SH SEE ALSO
 
185
XFree86(1), XF86Config(__filemansuffix__), xf86config(1), Xserver(1), X(__miscmansuffix__)
 
186
 
 
187
.SH SUPPORT
 
188
For assistance with this driver, or XFree86 in general, check the XFree86 web
 
189
site at http://www.xfree86.org.  A FAQ is available on the web site at
 
190
http://www.xfree86.org/FAQ/.  If you find a problem with XFree86 or have a
 
191
question not answered in the FAQ please use our bug report form available on
 
192
the web site or send mail to XFree86@XFree86.org.  When reporting problems
 
193
with the driver send as much detail as possible, including chipset type, a 
 
194
server output log, and operating system specifics.
 
195
 
 
196
.SH AUTHORS
 
197
Kevin Brosius, 
 
198
Matt Grossman, 
 
199
Harald Koenig,
 
200
Sebastien Marineau,
 
201
Mark Vojkovich,
 
202
Frido Garritsen,
 
203
Corvin Zahn.