import NVIDIA-FreeBSD-x86-190.42
[nvidia.git] / doc / html / appendix-b.html
CommitLineData
8b1b599b
SS
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<meta name="generator" content=
5"HTML Tidy for FreeBSD (vers 1 September 2005), see www.w3.org">
6<meta http-equiv="Content-Type" content=
7"text/html; charset=us-ascii">
5b34fd86 8<title>Appendix&nbsp;B.&nbsp;X Config Options</title>
8b1b599b
SS
9<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
10<link rel="start" href="index.html" title=
11"NVIDIA Accelerated FreeBSD Graphics Driver README and Installation Guide">
5b34fd86
SS
12<link rel="up" href="part-02.html" title=
13"Part&nbsp;II.&nbsp;Appendices">
14<link rel="prev" href="appendix-a.html" title=
15"Appendix&nbsp;A.&nbsp;Supported NVIDIA GPU Products">
16<link rel="next" href="appendix-c.html" title=
17"Appendix&nbsp;C.&nbsp;Display Device Names">
8b1b599b
SS
18</head>
19<body>
20<div class="navheader">
21<table width="100%" summary="Navigation header">
22<tr>
5b34fd86
SS
23<th colspan="3" align="center">Appendix&nbsp;B.&nbsp;X Config
24Options</th>
8b1b599b
SS
25</tr>
26<tr>
27<td width="20%" align="left"><a accesskey="p" href=
5b34fd86
SS
28"appendix-a.html">Prev</a>&nbsp;</td>
29<th width="60%" align="center">Part&nbsp;II.&nbsp;Appendices</th>
8b1b599b 30<td width="20%" align="right">&nbsp;<a accesskey="n" href=
5b34fd86 31"appendix-c.html">Next</a></td>
8b1b599b
SS
32</tr>
33</table>
34<hr></div>
35<div class="appendix" lang="en">
36<div class="titlepage">
37<div>
38<div>
5b34fd86
SS
39<h2 class="title"><a name="xconfigoptions" id=
40"xconfigoptions"></a>Appendix&nbsp;B.&nbsp;X Config Options</h2>
8b1b599b
SS
41</div>
42</div>
43</div>
5b34fd86
SS
44<p>The following driver options are supported by the NVIDIA X
45driver. They may be specified either in the Screen or Device
46sections of the X config file.</p>
47<div class="variablelist">
48<p class="title"><b>X Config Options</b></p>
49<dl>
50<dt><a name="NvAGP" id="NvAGP"></a><span class="term"><code class=
51"computeroutput">Option "NvAGP" "integer"</code></span></dt>
52<dd>
53<p>Configure AGP support. Integer argument can be one of:</p>
8b1b599b
SS
54<div class="informaltable">
55<table summary="(no summary available)" border="0">
56<colgroup>
57<col>
58<col></colgroup>
59<thead>
60<tr>
5b34fd86
SS
61<th>Value</th>
62<th>Behavior</th>
8b1b599b
SS
63</tr>
64</thead>
65<tbody>
66<tr>
5b34fd86
SS
67<td>0</td>
68<td>disable AGP</td>
8b1b599b
SS
69</tr>
70<tr>
5b34fd86
SS
71<td>1</td>
72<td>use NVIDIA internal AGP support, if possible</td>
8b1b599b
SS
73</tr>
74<tr>
5b34fd86
SS
75<td>2</td>
76<td>use AGPGART, if possible</td>
8b1b599b
SS
77</tr>
78<tr>
5b34fd86
SS
79<td>3</td>
80<td>use any AGP support (try AGPGART, then NVIDIA AGP)</td>
8b1b599b 81</tr>
5b34fd86
SS
82</tbody>
83</table>
84</div>
85<p>Note that NVIDIA internal AGP support cannot work if AGPGART is
86either statically compiled into your kernel or is built as a module
87and loaded into your kernel. See <a href="chapter-11.html" title=
88"Chapter&nbsp;11.&nbsp;Configuring AGP">Chapter&nbsp;11,
89<i>Configuring AGP</i></a> for details. Default: 3.</p>
90</dd>
91<dt><a name="NoLogo" id="NoLogo"></a><span class=
92"term"><code class="computeroutput">Option "NoLogo"
93"boolean"</code></span></dt>
94<dd>
95<p>Disable drawing of the NVIDIA logo splash screen at X startup.
96Default: the logo is drawn for screens with depth 24.</p>
97</dd>
98<dt><a name="LogoPath" id="LogoPath"></a><span class=
99"term"><code class="computeroutput">Option "LogoPath"
100"string"</code></span></dt>
101<dd>
102<p>Sets the path to the PNG file to be used as the logo splash
103screen at X startup. If the PNG file specified has a bKGD
104(background color) chunk, then the screen is cleared to the color
105it specifies. Otherwise, the screen is cleared to black. The logo
106file must be owned by root and must not be writable by a non-root
107group. Note that a logo is only displayed for screens with depth
10824. Default: The built-in NVIDIA logo is used.</p>
109</dd>
110<dt><a name="RenderAccel" id="RenderAccel"></a><span class=
111"term"><code class="computeroutput">Option "RenderAccel"
112"boolean"</code></span></dt>
113<dd>
114<p>Enable or disable hardware acceleration of the RENDER extension.
115Default: hardware acceleration of the RENDER extension is
116enabled.</p>
117</dd>
118<dt><a name="NoRenderExtension" id=
119"NoRenderExtension"></a><span class="term"><code class=
120"computeroutput">Option "NoRenderExtension"
121"boolean"</code></span></dt>
122<dd>
123<p>Disable the RENDER extension. Other than recompiling it, the X
124server does not seem to have another way of disabling this.
125Fortunately, we can control this from the driver so we export this
126option. This is useful in depth 8 where RENDER would normally steal
127most of the default colormap. Default: RENDER is offered when
128possible.</p>
129</dd>
130<dt><a name="UBB" id="UBB"></a><span class="term"><code class=
131"computeroutput">Option "UBB" "boolean"</code></span></dt>
132<dd>
133<p>Enable or disable the Unified Back Buffer on Quadro-based GPUs
134(Quadro4 NVS excluded); see <a href="chapter-19.html" title=
135"Chapter&nbsp;19.&nbsp;Configuring Flipping and UBB">Chapter&nbsp;19,
136<i>Configuring Flipping and UBB</i></a> for a description of UBB.
137This option has no effect on non-Quadro GPU products. Default: UBB
138is on for Quadro GPUs.</p>
139</dd>
140<dt><a name="NoFlip" id="NoFlip"></a><span class=
141"term"><code class="computeroutput">Option "NoFlip"
142"boolean"</code></span></dt>
143<dd>
144<p>Disable OpenGL flipping; see <a href="chapter-19.html" title=
145"Chapter&nbsp;19.&nbsp;Configuring Flipping and UBB">Chapter&nbsp;19,
146<i>Configuring Flipping and UBB</i></a> for a description. Default:
147OpenGL will swap by flipping when possible.</p>
148</dd>
149<dt><a name="Dac8Bit" id="Dac8Bit"></a><span class=
150"term"><code class="computeroutput">Option "Dac8Bit"
151"boolean"</code></span></dt>
152<dd>
153<p>Most Quadro products by default use a 10-bit color look-up table
154(LUT); setting this option to TRUE forces these GPUs to use an
1558-bit (LUT). Default: a 10-bit LUT is used, when available.</p>
156</dd>
157<dt><a name="Overlay" id="Overlay"></a><span class=
158"term"><code class="computeroutput">Option "Overlay"
159"boolean"</code></span></dt>
160<dd>
161<p>Enables RGB workstation overlay visuals. This is only supported
162on Quadro GPUs (Quadro NVS GPUs excluded) in depth 24. This option
163causes the server to advertise the SERVER_OVERLAY_VISUALS root
164window property and GLX will report single- and double-buffered,
165Z-buffered 16-bit overlay visuals. The transparency key is pixel
1660x0000 (hex). There is no gamma correction support in the overlay
167plane. This feature requires XFree86 version 4.2.0 or newer, or the
168X.Org X server. When the X screen is either wider than 2046 pixels
169or taller than 2047, the overlay may be emulated with a substantial
170performance penalty. RGB workstation overlays are not supported
171when the Composite extension is enabled.</p>
172<p>UBB must be enabled when overlays are enabled (this is the
173default behavior).</p>
174</dd>
175<dt><a name="CIOverlay" id="CIOverlay"></a><span class=
176"term"><code class="computeroutput">Option "CIOverlay"
177"boolean"</code></span></dt>
178<dd>
179<p>Enables Color Index workstation overlay visuals with identical
cfb7e7a6
SS
180restrictions to Option "Overlay" above. This option causes the
181server to advertise the SERVER_OVERLAY_VISUALS root window
182property. Some of the visuals advertised that way may be listed in
183the main plane (layer 0) for compatibility purposes. They however
184belong to the overlay (layer 1). The server will offer visuals both
185with and without a transparency key. These are depth 8 PseudoColor
186visuals. Enabling Color Index overlays on X servers older than
187XFree86 4.3 will force the RENDER extension to be disabled due to
188bugs in the RENDER extension in older X servers. Color Index
189workstation overlays are not supported when the Composite extension
190is enabled. Default: off.</p>
5b34fd86
SS
191<p>UBB must be enabled when overlays are enabled (this is the
192default behavior).</p>
193</dd>
194<dt><a name="TransparentIndex" id=
195"TransparentIndex"></a><span class="term"><code class=
196"computeroutput">Option "TransparentIndex"
197"integer"</code></span></dt>
198<dd>
199<p>When color index overlays are enabled, use this option to choose
200which pixel is used for the transparent pixel in visuals featuring
201transparent pixels. This value is clamped between 0 and 255 (Note:
202some applications such as Alias's Maya require this to be zero in
203order to work correctly). Default: 0.</p>
204</dd>
205<dt><a name="OverlayDefaultVisual" id=
206"OverlayDefaultVisual"></a><span class="term"><code class=
207"computeroutput">Option "OverlayDefaultVisual"
208"boolean"</code></span></dt>
209<dd>
210<p>When overlays are used, this option sets the default visual to
211an overlay visual thereby putting the root window in the overlay.
212This option is not recommended for RGB overlays. Default: off.</p>
213</dd>
214<dt><a name="EmulatedOverlaysTimerMs" id=
215"EmulatedOverlaysTimerMs"></a><span class="term"><code class=
216"computeroutput">Option "EmulatedOverlaysTimerMs"
217"integer"</code></span></dt>
218<dd>
219<p>Enables the use of a timer within the X server to perform the
220updates to the emulated overlay or CI overlay. This option can be
221used to improve the performance of the emulated or CI overlays by
222reducing the frequency of the updates. The value specified
223indicates the desired number of milliseconds between overlay
224updates. To disable the use of the timer either leave the option
225unset or set it to 0. Default: off.</p>
226</dd>
227<dt><a name="EmulatedOverlaysThreshold" id=
228"EmulatedOverlaysThreshold"></a><span class="term"><code class=
229"computeroutput">Option "EmulatedOverlaysThreshold"
230"boolean"</code></span></dt>
231<dd>
232<p>Enables the use of a threshold within the X server to perform
233the updates to the emulated overlay or CI overlay. The emulated or
234CI overlay updates can be deferred but this threshold will limit
235the number of deferred OpenGL updates allowed before the overlay is
236updated. This option can be used to trade off performance and
237animation quality. Default: on.</p>
238</dd>
239<dt><a name="EmulatedOverlaysThresholdValue" id=
240"EmulatedOverlaysThresholdValue"></a><span class=
241"term"><code class="computeroutput">Option
242"EmulatedOverlaysThresholdValue" "integer"</code></span></dt>
243<dd>
244<p>Controls the threshold used in updating the emulated or CI
245overlays. This is used in conjunction with the
246EmulatedOverlaysThreshold option to trade off performance and
247animation quality. Higher values for this option favor performance
248over quality. Setting low values of this option will not cause the
249overlay to be updated more often than the frequence specified by
250the EmulatedOverlaysTimerMs option. Default: 5.</p>
251</dd>
252<dt><a name="RandRRotation" id="RandRRotation"></a><span class=
253"term"><code class="computeroutput">Option "RandRRotation"
254"boolean"</code></span></dt>
255<dd>
256<p>Enable rotation support for the XRandR extension. This allows
257use of the XRandR X server extension for configuring the screen
258orientation through rotation. This feature is supported using depth
25924. This requires an X.Org X 6.8.1 or newer X server. This feature
260does not work with hardware overlays; emulated overlays will be
261used instead at a substantial performance penalty. See <a href=
262"chapter-16.html" title=
263"Chapter&nbsp;16.&nbsp;Using the XRandR Extension">Chapter&nbsp;16,
264<i>Using the XRandR Extension</i></a> for details. Default:
265off.</p>
266</dd>
267<dt><a name="Rotate" id="Rotate"></a><span class=
268"term"><code class="computeroutput">Option "Rotate"
269"string"</code></span></dt>
270<dd>
271<p>Enable static rotation support. Unlike the RandRRotation option
272above, this option takes effect as soon as the X server is started
273and will work with older versions of X. This feature is supported
274using depth 24. This feature does not work with hardware overlays;
275emulated overlays will be used instead at a substantial performance
276penalty. This option is not compatible with the RandR extension.
277Valid rotations are "normal", "left", "inverted", and "right".
278Default: off.</p>
279</dd>
280<dt><a name="AllowDDCCI" id="AllowDDCCI"></a><span class=
281"term"><code class="computeroutput">Option "AllowDDCCI"
282"boolean"</code></span></dt>
283<dd>
284<p>Enables DDC/CI support in the NV-CONTROL X extension. DDC/CI is
285a mechanism for communication between your computer and your
286display device. This can be used to set the values normally
287controlled through your display device's On Screen Display. See the
288DDC/CI NV-CONTROL attributes in <code class=
289"filename">NVCtrl.h</code> and functions in <code class=
290"filename">NVCtrlLib.h</code> in the <span><strong class=
291"command">nvidia-settings</strong></span> source code. Default: off
292(DDC/CI is disabled).</p>
293<p>Note that support for DDC/CI within the NVIDIA X driver's
294NV-CONTROL extension is deprecated, and will be removed in a future
295release. Other mechanisms for DDC/CI, such as the kernel i2c
296subsystem on Linux, are preferred over NV-CONTROL's DDC/CI
297support.</p>
298<p>If you would prefer that the NVIDIA X driver's NV-CONTROL X
299extension not remove DDC/CI support, please make your concerns
300known my emailing <code class="email">&lt;<a href=
301"mailto:linux-bugs@nvidia.com">linux-bugs@nvidia.com</a>&gt;</code>.</p>
302</dd>
303<dt><a name="SWCursor" id="SWCursor"></a><span class=
304"term"><code class="computeroutput">Option "SWCursor"
305"boolean"</code></span></dt>
306<dd>
307<p>Enable or disable software rendering of the X cursor. Default:
308off.</p>
309</dd>
310<dt><a name="HWCursor" id="HWCursor"></a><span class=
311"term"><code class="computeroutput">Option "HWCursor"
312"boolean"</code></span></dt>
313<dd>
314<p>Enable or disable hardware rendering of the X cursor. Default:
315on.</p>
316</dd>
317<dt><a name="CursorShadow" id="CursorShadow"></a><span class=
318"term"><code class="computeroutput">Option "CursorShadow"
319"boolean"</code></span></dt>
320<dd>
321<p>Enable or disable use of a shadow with the hardware accelerated
322cursor; this is a black translucent replica of your cursor shape at
323a given offset from the real cursor. Default: off (no cursor
324shadow).</p>
325</dd>
326<dt><a name="CursorShadowAlpha" id=
327"CursorShadowAlpha"></a><span class="term"><code class=
328"computeroutput">Option "CursorShadowAlpha"
329"integer"</code></span></dt>
330<dd>
331<p>The alpha value to use for the cursor shadow; only applicable if
332CursorShadow is enabled. This value must be in the range [0, 255]
333-- 0 is completely transparent; 255 is completely opaque. Default:
33464.</p>
335</dd>
336<dt><a name="CursorShadowXOffset" id=
337"CursorShadowXOffset"></a><span class="term"><code class=
338"computeroutput">Option "CursorShadowXOffset"
339"integer"</code></span></dt>
340<dd>
341<p>The offset, in pixels, that the shadow image will be shifted to
342the right from the real cursor image; only applicable if
343CursorShadow is enabled. This value must be in the range [0, 32].
344Default: 4.</p>
345</dd>
346<dt><a name="CursorShadowYOffset" id=
347"CursorShadowYOffset"></a><span class="term"><code class=
348"computeroutput">Option "CursorShadowYOffset"
349"integer"</code></span></dt>
350<dd>
351<p>The offset, in pixels, that the shadow image will be shifted
352down from the real cursor image; only applicable if CursorShadow is
353enabled. This value must be in the range [0, 32]. Default: 2.</p>
354</dd>
355<dt><a name="ConnectedMonitor" id=
356"ConnectedMonitor"></a><span class="term"><code class=
357"computeroutput">Option "ConnectedMonitor"
358"string"</code></span></dt>
359<dd>
360<p>Allows you to override what the NVIDIA kernel module detects is
361connected to your graphics card. This may be useful, for example,
362if you use a KVM (keyboard, video, mouse) switch and you are
363switched away when X is started. In such a situation, the NVIDIA
364kernel module cannot detect which display devices are connected,
365and the NVIDIA X driver assumes you have a single CRT.</p>
366<p>Valid values for this option are "CRT" (cathode ray tube), "DFP"
367(digital flat panel), or "TV" (television); if using TwinView, this
368option may be a comma-separated list of display devices; e.g.:
369"CRT, CRT" or "CRT, DFP".</p>
370<p>It is generally recommended to not use this option, but instead
371use the "UseDisplayDevice" option.</p>
372<p>NOTE: anything attached to a 15 pin VGA connector is regarded by
373the driver as a CRT. "DFP" should only be used to refer to digital
374flat panels connected via a DVI port.</p>
375<p>Default: string is NULL (the NVIDIA driver will detect the
376connected display devices).</p>
377</dd>
378<dt><a name="UseDisplayDevice" id=
379"UseDisplayDevice"></a><span class="term"><code class=
380"computeroutput">Option "UseDisplayDevice"
381"string"</code></span></dt>
382<dd>
383<p>The "UseDisplayDevice" X configuration option is a list of one
384or more display devices, which limits the display devices the
385NVIDIA X driver will consider for an X screen. The display device
386names used in the option may be either specific (with a numeric
387suffix; e.g., "DFP-1") or general (without a numeric suffix; e.g.,
388"DFP").</p>
389<p>When assigning display devices to X screens, the NVIDIA X driver
390walks through the list of all (not already assigned) display
391devices detected as connected. When the "UseDisplayDevice" X
392configuration option is specified, the X driver will only consider
393connected display devices which are also included in the
394"UseDisplayDevice" list. This can be thought of as a "mask" against
395the connected (and not already assigned) display devices.</p>
396<p>Note the subtle difference between this option and the
397"ConnectedMonitor" option: the "ConnectedMonitor" option overrides
398which display devices are actually detected, while the
399"UseDisplayDevice" option controls which of the detected display
400devices will be used on this X screen.</p>
401<p>Of the list of display devices considered for this X screen
402(either all connected display devices, or a subset limited by the
403"UseDisplayDevice" option), the NVIDIA X driver first looks at
404CRTs, then at DFPs, and finally at TVs. For example, if both a CRT
405and a DFP are connected, by default the X driver would assign the
406CRT to this X screen. However, by specifying:</p>
407<pre class="screen">
408 Option "UseDisplayDevice" "DFP"
409</pre>
410<p>the X screen would use the DFP instead. Or, if CRT-0, DFP-0, and
411DFP-1 are connected and TwinView is enabled, the X driver would
412assign CRT-0 and DFP-0 to the X screen. However, by specifying:</p>
413<pre class="screen">
414 Option "UseDisplayDevice" "CRT-0, DFP-1"
415</pre>
416<p>the X screen would use CRT-0 and DFP-1 instead.</p>
417<p>Additionally, the special value "none" can be specified for the
418"UseDisplayDevice" option. When this value is given, any
419programming of the display hardware is disabled. The NVIDIA driver
420will not perform any mode validation or mode setting for this X
421screen. This is intended for use in conjunction with CUDA or in
422remote graphics solutions such as VNC or Hewlett Packard's Remote
423Graphics Software (RGS). This functionality is only available on
424Quadro and Tesla GPUs.</p>
425<p>Note the following restrictions for setting the
426"UseDisplayDevice" to "none":</p>
427<div class="itemizedlist">
428<ul type="disc">
429<li>
430<p>OpenGL SyncToVBlank will have no effect.</p>
431</li>
432<li>
433<p>None of Stereo, Overlay, CIOverlay, or SLI are allowed when
434"UseDisplayDevice" is set to "none".</p>
435</li>
436</ul>
437</div>
438<p></p>
439</dd>
440<dt><a name="UseEdidFreqs" id="UseEdidFreqs"></a><span class=
441"term"><code class="computeroutput">Option "UseEdidFreqs"
442"boolean"</code></span></dt>
443<dd>
444<p>This option controls whether the NVIDIA X driver will use the
445HorizSync and VertRefresh ranges given in a display device's EDID,
446if any. When UseEdidFreqs is set to True, EDID-provided range
447information will override the HorizSync and VertRefresh ranges
448specified in the Monitor section. If a display device does not
449provide an EDID, or the EDID does not specify an hsync or vrefresh
450range, then the X server will default to the HorizSync and
451VertRefresh ranges specified in the Monitor section of your X
452config file. These frequency ranges are used when validating modes
453for your display device.</p>
454<p>Default: True (EDID frequencies will be used)</p>
455</dd>
456<dt><a name="UseEDID" id="UseEDID"></a><span class=
457"term"><code class="computeroutput">Option "UseEDID"
458"boolean"</code></span></dt>
459<dd>
460<p>By default, the NVIDIA X driver makes use of a display device's
461EDID, when available, during construction of its mode pool. The
462EDID is used as a source for possible modes, for valid frequency
463ranges, and for collecting data on the physical dimensions of the
464display device for computing the DPI (see <a href="appendix-e.html"
465title="Appendix&nbsp;E.&nbsp;Dots Per Inch">Appendix&nbsp;E,
466<i>Dots Per Inch</i></a>). However, if you wish to disable the
467driver's use of the EDID, you can set this option to False:</p>
468<pre class="screen">
469 Option "UseEDID" "FALSE"
470</pre>
471<p>Note that, rather than globally disable all uses of the EDID,
472you can individually disable each particular use of the EDID;
473e.g.,</p>
474<pre class="screen">
475 Option "UseEDIDFreqs" "FALSE"
476 Option "UseEDIDDpi" "FALSE"
477 Option "ModeValidation" "NoEdidModes"
478</pre>
479<p>Default: True (use EDID).</p>
480</dd>
481<dt><a name="UseInt10Module" id="UseInt10Module"></a><span class=
482"term"><code class="computeroutput">Option "UseInt10Module"
483"boolean"</code></span></dt>
484<dd>
485<p>Enable use of the X Int10 module to soft-boot all secondary
486cards, rather than POSTing the cards through the NVIDIA kernel
487module. Default: off (POSTing is done through the NVIDIA kernel
488module).</p>
489</dd>
490<dt><a name="TwinView" id="TwinView"></a><span class=
491"term"><code class="computeroutput">Option "TwinView"
492"boolean"</code></span></dt>
493<dd>
494<p>Enable or disable TwinView. See <a href="chapter-12.html" title=
495"Chapter&nbsp;12.&nbsp;Configuring TwinView">Chapter&nbsp;12,
496<i>Configuring TwinView</i></a> for details. Default: off (TwinView
497is disabled).</p>
498</dd>
499<dt><a name="TwinViewOrientation" id=
500"TwinViewOrientation"></a><span class="term"><code class=
501"computeroutput">Option "TwinViewOrientation"
502"string"</code></span></dt>
503<dd>
504<p>Controls the relationship between the two display devices when
505using TwinView. Takes one of the following values: "RightOf"
506"LeftOf" "Above" "Below" "Clone". See <a href="chapter-12.html"
507title="Chapter&nbsp;12.&nbsp;Configuring TwinView">Chapter&nbsp;12,
508<i>Configuring TwinView</i></a> for details. Default: string is
509NULL.</p>
510</dd>
511<dt><a name="SecondMonitorHorizSync" id=
512"SecondMonitorHorizSync"></a><span class="term"><code class=
513"computeroutput">Option "SecondMonitorHorizSync"
514"range(s)"</code></span></dt>
515<dd>
516<p>This option is like the HorizSync entry in the Monitor section,
517but is for the second monitor when using TwinView. See <a href=
518"chapter-12.html" title=
519"Chapter&nbsp;12.&nbsp;Configuring TwinView">Chapter&nbsp;12,
520<i>Configuring TwinView</i></a> for details. Default: none.</p>
521</dd>
522<dt><a name="SecondMonitorVertRefresh" id=
523"SecondMonitorVertRefresh"></a><span class="term"><code class=
524"computeroutput">Option "SecondMonitorVertRefresh"
525"range(s)"</code></span></dt>
526<dd>
527<p>This option is like the VertRefresh entry in the Monitor
528section, but is for the second monitor when using TwinView. See
529<a href="chapter-12.html" title=
530"Chapter&nbsp;12.&nbsp;Configuring TwinView">Chapter&nbsp;12,
531<i>Configuring TwinView</i></a> for details. Default: none.</p>
532</dd>
533<dt><a name="MetaModes" id="MetaModes"></a><span class=
534"term"><code class="computeroutput">Option "MetaModes"
535"string"</code></span></dt>
536<dd>
537<p>This option describes the combination of modes to use on each
538monitor when using TwinView. See <a href="chapter-12.html" title=
539"Chapter&nbsp;12.&nbsp;Configuring TwinView">Chapter&nbsp;12,
540<i>Configuring TwinView</i></a> for details. Default: string is
541NULL.</p>
542</dd>
543<dt><a name="NoTwinViewXineramaInfo" id=
544"NoTwinViewXineramaInfo"></a><span class="term"><code class=
545"computeroutput">Option "NoTwinViewXineramaInfo"
546"boolean"</code></span></dt>
547<dd>
548<p>When in TwinView, the NVIDIA X driver normally provides a
549Xinerama extension that X clients (such as window managers) can use
550to discover the current TwinView configuration, such as where each
551display device is positioned within the X screen. Some window
552mangers get confused by this information, so this option is
553provided to disable this behavior. Default: false (TwinView
554Xinerama information is provided).</p>
555<p>Due to bugs in some older software, TwinView Xinerama
556information is not provided by default on X.Org 7.1 and older when
557the X server is started with only one display device connected.</p>
558</dd>
559<dt><a name="TwinViewXineramaInfoOrder" id=
560"TwinViewXineramaInfoOrder"></a><span class="term"><code class=
561"computeroutput">Option "TwinViewXineramaInfoOrder"
562"string"</code></span></dt>
563<dd>
564<p>When the NVIDIA X driver provides TwinViewXineramaInfo (see the
565NoTwinViewXineramaInfo X config option), it by default reports the
566currently enabled display devices in the order "CRT, DFP, TV". The
567TwinViewXineramaInfoOrder X config option can be used to override
568this order.</p>
569<p>The option string is a comma-separated list of display device
570names. The display device names can either be general (e.g, "CRT",
571which identifies all CRTs), or specific (e.g., "CRT-1", which
572identifies a particular CRT). Not all display devices need to be
573identified in the option string; display devices that are not
574listed will be implicitly appended to the end of the list, in their
575default order.</p>
576<p>Note that TwinViewXineramaInfoOrder tracks all display devices
577that could possibly be connected to the GPU, not just the ones that
578are currently enabled. When reporting the Xinerama information, the
579NVIDIA X driver walks through the display devices in the order
580specified, only reporting enabled display devices.</p>
581<p>Examples:</p>
582<pre class="screen">
583 "DFP"
584 "TV, DFP"
585 "DFP-1, DFP-0, TV, CRT"
586</pre>
587<p>In the first example, any enabled DFPs would be reported first
588(any enabled CRTs or TVs would be reported afterwards). In the
589second example, any enabled TVs would be reported first, then any
590enabled DFPs (any enabled CRTs would be reported last). In the last
591example, if DFP-1 were enabled, it would be reported first, then
592DFP-0, then any enabled TVs, and then any enabled CRTs; finally,
593any other enabled DFPs would be reported.</p>
594<p>Default: "CRT, DFP, TV"</p>
595</dd>
596<dt><a name="TwinViewXineramaInfoOverride" id=
597"TwinViewXineramaInfoOverride"></a><span class="term"><code class=
598"computeroutput">Option "TwinViewXineramaInfoOverride"
599"string"</code></span></dt>
600<dd>
601<p>This option overrides the values reported by NVIDIA's TwinView
602Xinerama implementation. This disregards the actual display devices
603used by the X screen and any order specified in
604TwinViewXineramaInfoOrder.</p>
605<p>The option string is interpreted as a comma-separated list of
606regions, specified as '[width]x[height]+[x-offset]+[y-offset]'. The
607regions' sizes and offsets are not validated against the X screen
608size, but are directly reported to any Xinerama client.</p>
609<p>Examples:</p>
610<pre class="screen">
611 "1600x1200+0+0, 1600x1200+1600+0"
612 "1024x768+0+0, 1024x768+1024+0, 1024x768+0+768, 1024x768+1024+768"
613</pre>
614<p></p>
615</dd>
616<dt><a name="TVStandard" id="TVStandard"></a><span class=
617"term"><code class="computeroutput">Option "TVStandard"
618"string"</code></span></dt>
619<dd>
620<p>See <a href="chapter-15.html" title=
621"Chapter&nbsp;15.&nbsp;Configuring TV-Out">Chapter&nbsp;15,
622<i>Configuring TV-Out</i></a> for details on configuring
623TV-out.</p>
624</dd>
625<dt><a name="TVOutFormat" id="TVOutFormat"></a><span class=
626"term"><code class="computeroutput">Option "TVOutFormat"
627"string"</code></span></dt>
628<dd>
629<p>See <a href="chapter-15.html" title=
630"Chapter&nbsp;15.&nbsp;Configuring TV-Out">Chapter&nbsp;15,
631<i>Configuring TV-Out</i></a> for details on configuring
632TV-out.</p>
633</dd>
634<dt><a name="TVOverScan" id="TVOverScan"></a><span class=
635"term"><code class="computeroutput">Option "TVOverScan" "Decimal
636value in the range 0.0 to 1.0"</code></span></dt>
637<dd>
638<p>Valid values are in the range 0.0 through 1.0; See <a href=
639"chapter-15.html" title=
640"Chapter&nbsp;15.&nbsp;Configuring TV-Out">Chapter&nbsp;15,
641<i>Configuring TV-Out</i></a> for details on configuring
642TV-out.</p>
643</dd>
644<dt><a name="Stereo" id="Stereo"></a><span class=
645"term"><code class="computeroutput">Option "Stereo"
646"integer"</code></span></dt>
647<dd>
648<p>Enable offering of quad-buffered stereo visuals on Quadro.
649Integer indicates the type of stereo equipment being used:</p>
650<div class="informaltable">
651<table summary="(no summary available)" border="0">
652<colgroup>
653<col>
654<col></colgroup>
655<thead>
8b1b599b 656<tr>
5b34fd86
SS
657<th>Value</th>
658<th>Equipment</th>
8b1b599b 659</tr>
5b34fd86
SS
660</thead>
661<tbody>
8b1b599b 662<tr>
5b34fd86
SS
663<td>1</td>
664<td>DDC glasses. The sync signal is sent to the glasses via the DDC
665signal to the monitor. These usually involve a passthrough cable
666between the monitor and the graphics card. This mode is not
667available on G8xGL and higher GPUs.</td>
8b1b599b
SS
668</tr>
669<tr>
5b34fd86
SS
670<td>2</td>
671<td>"Blueline" glasses. These usually involve a passthrough cable
672between the monitor and graphics card. The glasses know which eye
673to display based on the length of a blue line visible at the bottom
674of the screen. When in this mode, the root window dimensions are
675one pixel shorter in the Y dimension than requested. This mode does
676not work with virtual root window sizes larger than the visible
677root window size (desktop panning). This mode is not available on
678G8xGL and higher GPUs.</td>
8b1b599b
SS
679</tr>
680<tr>
5b34fd86
SS
681<td>3</td>
682<td>Onboard stereo support. This is usually only found on
683professional cards. The glasses connect via a DIN connector on the
684back of the graphics card.</td>
05d5f840
SS
685</tr>
686<tr>
5b34fd86
SS
687<td>4</td>
688<td>TwinView clone mode stereo (also known as "passive" stereo). On
689graphics cards that support TwinView, the left eye is displayed on
690the first display, and the right eye is displayed on the second
691display. This is normally used in conjunction with special
692projectors to produce 2 polarized images which are then viewed with
693polarized glasses. To use this stereo mode, you must also configure
694TwinView in clone mode with the same resolution, panning offset,
695and panning domains on each display.</td>
05d5f840
SS
696</tr>
697<tr>
5b34fd86
SS
698<td>5</td>
699<td>Vertical interlaced stereo mode, for use with SeeReal Stereo
700Digital Flat Panels.</td>
8b1b599b
SS
701</tr>
702<tr>
5b34fd86
SS
703<td>6</td>
704<td>Color interleaved stereo mode, for use with Sharp3D Stereo
705Digital Flat Panels.</td>
8b1b599b
SS
706</tr>
707<tr>
5b34fd86
SS
708<td>7</td>
709<td>Horizontal interlaced stereo mode, for use with Arisawa,
710Hyundai, Zalman, Pavione, and Miracube Digital Flat Panels.</td>
05d5f840
SS
711</tr>
712<tr>
5b34fd86
SS
713<td>8</td>
714<td>Checkerboard pattern stereo mode, for use with 3D DLP Display
715Devices.</td>
05d5f840
SS
716</tr>
717<tr>
5b34fd86
SS
718<td>9</td>
719<td>Inverse checkerboard pattern stereo mode, for use with 3D DLP
720Display Devices.</td>
05d5f840 721</tr>
5b34fd86
SS
722</tbody>
723</table>
724</div>
725<p>Stereo is only available on Quadro cards. Stereo options 1, 2,
726and 3 (also known as "active" stereo) may be used with TwinView if
727all modes within each MetaMode have identical timing values. See
728<a href="chapter-18.html" title=
729"Chapter&nbsp;18.&nbsp;Programming Modes">Chapter&nbsp;18,
730<i>Programming Modes</i></a> for suggestions on making sure the
731modes within your MetaModes are identical. The identical ModeLine
732requirement is not necessary for Stereo options 4 through 9
733("passive" stereo). Default: 0 (Stereo is not enabled).</p>
734<p>UBB must be enabled when stereo is enabled (this is the default
735behavior).</p>
736<p>Stereo options 1, 2, and 3 ("active" stereo) can be enabled on
737digital display devices (connected via DVI, HDMI, or DisplayPort).
738However, some digital display devices might not behave as desired
739with active stereo:</p>
740<div class="itemizedlist">
741<ul type="disc">
742<li>
743<p>Some digital display devices may not be able to toggle pixel
744colors quickly enough when flipping between eyes on every
745vblank.</p>
746</li>
747<li>
748<p>Some digital display devices may have an optical polarization
749that interferes with stereo goggles.</p>
750</li>
751<li>
752<p>Active stereo requires high refresh rates, because a vertical
753refresh is needed to display each eye. Some digital display devices
754have a low refresh rate, which will result in flickering when used
755for active stereo.</p>
756</li>
757<li>
758<p>Some digital display devices might internally convert from other
759refresh rates to their native refresh rate (e.g., 60Hz), resulting
760in incompatible rates between the stereo glasses and stereo
761displayed on screen.</p>
762</li>
763</ul>
764</div>
765<p></p>
766<p>Stereo applies to an entire X screen, so it will apply to all
767display devices on that X screen, whether or not they all support
768the selected Stereo mode.</p>
769<p>Stereo options 7, 8, and 9 are only supported on G8xGL and
770higher GPUs.</p>
771<p>Multi-GPU cards (such as the Quadro FX 4500 X2) provide a single
772connector for onboard stereo support (option 3), which is tied to
773the bottommost GPU. In order to synchronize onboard stereo with the
774other GPU, you must use a G-Sync device (see <a href=
775"chapter-25.html" title=
776"Chapter&nbsp;25.&nbsp;Configuring Frame Lock and Genlock">Chapter&nbsp;25,
777<i>Configuring Frame Lock and Genlock</i></a> for details).</p>
778</dd>
779<dt><a name="ForceStereoFlipping" id=
780"ForceStereoFlipping"></a><span class="term"><code class=
781"computeroutput">Option "ForceStereoFlipping"
782"boolean"</code></span></dt>
783<dd>
784<p>Stereo flipping is the process by which left and right eyes are
785displayed on alternating vertical refreshes. Normally, stereo
786flipping is only performed when a stereo drawable is visible. This
787option forces stereo flipping even when no stereo drawables are
788visible.</p>
789<p>This is to be used in conjunction with the "Stereo" option. If
790"Stereo" is 0, the "ForceStereoFlipping" option has no effect. If
791otherwise, the "ForceStereoFlipping" option will force the behavior
792indicated by the "Stereo" option, even if no stereo drawables are
793visible. This option is useful in a multiple-screen environment in
794which a stereo application is run on a different screen than the
795stereo master.</p>
796<p>Possible values:</p>
797<div class="informaltable">
798<table summary="(no summary available)" border="0">
799<colgroup>
800<col>
801<col></colgroup>
802<thead>
05d5f840 803<tr>
5b34fd86
SS
804<th>Value</th>
805<th>Behavior</th>
05d5f840 806</tr>
5b34fd86
SS
807</thead>
808<tbody>
05d5f840 809<tr>
5b34fd86
SS
810<td>0</td>
811<td>Stereo flipping is not forced. The default behavior as
812indicated by the "Stereo" option is used.</td>
05d5f840
SS
813</tr>
814<tr>
5b34fd86
SS
815<td>1</td>
816<td>Stereo flipping is forced. Stereo is running even if no stereo
817drawables are visible. The stereo mode depends on the value of the
818"Stereo" option.</td>
05d5f840 819</tr>
5b34fd86
SS
820</tbody>
821</table>
822</div>
823<p>Default: 0 (Stereo flipping is not forced). Note that active
824stereo is not supported on digital flat panels.</p>
825</dd>
826<dt><a name="XineramaStereoFlipping" id=
827"XineramaStereoFlipping"></a><span class="term"><code class=
828"computeroutput">Option "XineramaStereoFlipping"
829"boolean"</code></span></dt>
830<dd>
831<p>By default, when using Stereo with Xinerama, all physical X
832screens having a visible stereo drawable will stereo flip. Use this
833option to allow only one physical X screen to stereo flip at a
834time.</p>
835<p>This is to be used in conjunction with the "Stereo" and
836"Xinerama" options. If "Stereo" is 0 or "Xinerama" is 0, the
837"XineramaStereoFlipping" option has no effect.</p>
838<p>If you wish to have all X screens stereo flip all the time, see
839the "ForceStereoFlipping" option.</p>
840<p>Possible values:</p>
841<div class="informaltable">
842<table summary="(no summary available)" border="0">
843<colgroup>
844<col>
845<col></colgroup>
846<thead>
05d5f840 847<tr>
5b34fd86
SS
848<th>Value</th>
849<th>Behavior</th>
8b1b599b 850</tr>
5b34fd86
SS
851</thead>
852<tbody>
8b1b599b 853<tr>
5b34fd86
SS
854<td>0</td>
855<td>Stereo flipping is enabled on one X screen at a time. Stereo is
856enabled on the first X screen having the stereo drawable.</td>
8b1b599b
SS
857</tr>
858<tr>
5b34fd86
SS
859<td>1</td>
860<td>Stereo flipping in enabled on all X screens.</td>
8b1b599b 861</tr>
5b34fd86
SS
862</tbody>
863</table>
864</div>
865<p>Default: 1 (Stereo flipping is enabled on all X screens).</p>
866</dd>
867<dt><a name="NoBandWidthTest" id="NoBandWidthTest"></a><span class=
868"term"><code class="computeroutput">Option "NoBandWidthTest"
869"boolean"</code></span></dt>
870<dd>
871<p>As part of mode validation, the X driver tests if a given mode
872fits within the hardware's memory bandwidth constraints. This
873option disables this test. Default: false (the memory bandwidth
874test is performed).</p>
875</dd>
876<dt><a name="IgnoreDisplayDevices" id=
877"IgnoreDisplayDevices"></a><span class="term"><code class=
878"computeroutput">Option "IgnoreDisplayDevices"
879"string"</code></span></dt>
880<dd>
881<p>This option tells the NVIDIA kernel module to completely ignore
882the indicated classes of display devices when checking which
883display devices are connected. You may specify a comma-separated
884list containing any of "CRT", "DFP", and "TV". For example:</p>
885<pre class="screen">
886Option "IgnoreDisplayDevices" "DFP, TV"
887</pre>
888<p>will cause the NVIDIA driver to not attempt to detect if any
889digital flat panels or TVs are connected. This option is not
890normally necessary; however, some video BIOSes contain incorrect
891information about which display devices may be connected, or which
892i2c port should be used for detection. These errors can cause long
893delays in starting X. If you are experiencing such delays, you may
894be able to avoid this by telling the NVIDIA driver to ignore
895display devices which you know are not connected. NOTE: anything
896attached to a 15 pin VGA connector is regarded by the driver as a
897CRT. "DFP" should only be used to refer to digital flat panels
898connected via a DVI port.</p>
899</dd>
900<dt><a name="MultisampleCompatibility" id=
901"MultisampleCompatibility"></a><span class="term"><code class=
902"computeroutput">Option "MultisampleCompatibility"
903"boolean"</code></span></dt>
904<dd>
905<p>Enable or disable the use of separate front and back multisample
906buffers. Enabling this will consume more memory but is necessary
907for correct output when rendering to both the front and back
908buffers of a multisample or FSAA drawable. This option is necessary
909for correct operation of SoftImage XSI. Default: false (a single
910multisample buffer is shared between the front and back
911buffers).</p>
912</dd>
913<dt><a name="NoPowerConnectorCheck" id=
914"NoPowerConnectorCheck"></a><span class="term"><code class=
915"computeroutput">Option "NoPowerConnectorCheck"
916"boolean"</code></span></dt>
917<dd>
918<p>The NVIDIA X driver will abort X server initialization if it
919detects that a GPU that requires an external power connector does
920not have an external power connector plugged in. This option can be
921used to bypass this test. Default: false (the power connector test
922is performed).</p>
923</dd>
924<dt><a name="XvmcUsesTextures" id=
925"XvmcUsesTextures"></a><span class="term"><code class=
926"computeroutput">Option "XvmcUsesTextures"
927"boolean"</code></span></dt>
928<dd>
929<p>Forces XvMC to use the 3D engine for XvMCPutSurface requests
930rather than the video overlay. Default: false (video overlay is
931used when available).</p>
932</dd>
933<dt><a name="AllowGLXWithComposite" id=
934"AllowGLXWithComposite"></a><span class="term"><code class=
935"computeroutput">Option "AllowGLXWithComposite"
936"boolean"</code></span></dt>
937<dd>
938<p>Enables GLX even when the Composite X extension is loaded.
939ENABLE AT YOUR OWN RISK. OpenGL applications will not display
940correctly in many circumstances with this setting enabled.</p>
941<p>This option is intended for use on X.Org X servers older than
942X11R6.9.0. On X11R6.9.0 or newer X servers, the NVIDIA OpenGL
943implementation interacts properly by default with the Composite X
944extension and this option should not be needed. However, on
945X11R6.9.0 or newer X servers, support for GLX with Composite can be
946disabled by setting this option to False.</p>
947<p>Default: false (GLX is disabled when Composite is enabled on X
948servers older than X11R6.9.0).</p>
949</dd>
950<dt><a name="UseCompositeWrapper" id=
951"UseCompositeWrapper"></a><span class="term"><code class=
952"computeroutput">Option "UseCompositeWrapper"
953"boolean"</code></span></dt>
954<dd>
955<p>Enables the X server's "composite wrapper", which performs
956coordinate translations necessary for the Composite extension.</p>
957<p>Default: false (the NVIDIA X driver performs its own coordinate
958translation).</p>
959</dd>
960<dt><a name="AddARGBGLXVisuals" id=
961"AddARGBGLXVisuals"></a><span class="term"><code class=
962"computeroutput">Option "AddARGBGLXVisuals"
963"boolean"</code></span></dt>
964<dd>
965<p>Adds a 32-bit ARGB visual for each supported OpenGL
966configuration. This allows applications to use OpenGL to render
967with alpha transparency into 32-bit windows and pixmaps. This
968option requires the Composite extension. Default: ARGB GLX visuals
969are enabled on X servers new enough to support them when the
970Composite extension is also enabled.</p>
971</dd>
972<dt><a name="DisableGLXRootClipping" id=
973"DisableGLXRootClipping"></a><span class="term"><code class=
974"computeroutput">Option "DisableGLXRootClipping"
975"boolean"</code></span></dt>
976<dd>
977<p>If enabled, no clipping will be performed on rendering done by
978OpenGL in the root window. This option is deprecated. It is needed
979by older versions of OpenGL-based composite managers that draw the
980contents of redirected windows directly into the root window using
981OpenGL. Most OpenGL-based composite managers have been updated to
982support the Composite Overlay Window, a feature introduced in Xorg
983release 7.1. Using the Composite Overlay Window is the preferred
984method for performing OpenGL-based compositing.</p>
985</dd>
986<dt><a name="DamageEvents" id="DamageEvents"></a><span class=
987"term"><code class="computeroutput">Option "DamageEvents"
988"boolean"</code></span></dt>
989<dd>
990<p>Use OS-level events to efficiently notify X when a client has
991performed direct rendering to a window that needs to be composited.
992This will significantly improve performance and interactivity when
993using GLX applications with a composite manager running. It will
994also affect applications using GLX when rotation is enabled. This
995option is currently incompatible with SLI and Multi-GPU modes and
996will be disabled if either are used. Enabled by default.</p>
997</dd>
998<dt><a name="ExactModeTimingsDVI" id=
999"ExactModeTimingsDVI"></a><span class="term"><code class=
1000"computeroutput">Option "ExactModeTimingsDVI"
1001"boolean"</code></span></dt>
1002<dd>
1003<p>Forces the initialization of the X server with the exact timings
1004specified in the ModeLine. Default: false (for DVI devices, the X
1005server initializes with the closest mode in the EDID list).</p>
1006</dd>
1007<dt><a name="Coolbits" id="Coolbits"></a><span class=
1008"term"><code class="computeroutput">Option "Coolbits"
1009"integer"</code></span></dt>
1010<dd>
1011<p>Enables various unsupported features, such as support for GPU
1012clock manipulation in the NV-CONTROL X extension. This option
1013accepts a bit mask of features to enable.</p>
5b34fd86
SS
1014<p>WARNING: this may cause system damage and void warranties. This
1015utility can run your computer system out of the manufacturer's
1016design specifications, including, but not limited to: higher system
1017voltages, above normal temperatures, excessive frequencies, and
1018changes to BIOS that may corrupt the BIOS. Your computer's
1019operating system may hang and result in data loss or corrupted
1020images. Depending on the manufacturer of your computer system, the
1021computer system, hardware and software warranties may be voided,
1022and you may not receive any further manufacturer support. NVIDIA
1023does not provide customer service support for the Coolbits option.
1024It is for these reasons that absolutely no warranty or guarantee is
1025either express or implied. Before enabling and using, you should
1026determine the suitability of the utility for your intended use, and
1027you shall assume all responsibility in connection therewith.</p>
cfb7e7a6
SS
1028<p>When "1" (Bit 0) is set in the "Coolbits" option value, the
1029nvidia-settings utility will contain a page labeled "Clock
1030Frequencies" through which clock settings can be manipulated.
1031"Coolbits" is only available on GeForce FX, Quadro FX and newer
1032desktop GPUs. On GeForce FX and newer mobile GPUs, limited clock
1033manipulation support is available when "1" is set in the "Coolbits"
1034option value: clocks can be lowered relative to the default
1035settings; overclocking is not supported due to the thermal
1036constraints of notebook designs.</p>
5b34fd86
SS
1037<p>When "2" (Bit 1) is set in the "Coolbits" option value, the
1038NVIDIA driver will attempt to initialize SLI when using GPUs with
1039different amounts of video memory.</p>
cfb7e7a6
SS
1040<p>When "4" (Bit 2) is set in the "Coolbits" option value, the
1041nvidia-settings Thermal Monitor page will allow configuration of
1042GPU fan speed, on graphics boards with programmable fan
1043capability.</p>
5b34fd86
SS
1044<p>The default for this option is 0 (unsupported features are
1045disabled).</p>
1046</dd>
1047<dt><a name="MultiGPU" id="MultiGPU"></a><span class=
1048"term"><code class="computeroutput">Option "MultiGPU"
1049"string"</code></span></dt>
1050<dd>
1051<p>This option controls the configuration of Multi-GPU rendering in
1052supported configurations.</p>
1053<div class="informaltable">
1054<table summary="(no summary available)" border="0">
1055<colgroup>
1056<col>
1057<col></colgroup>
1058<thead>
8b1b599b 1059<tr>
5b34fd86
SS
1060<th>Value</th>
1061<th>Behavior</th>
8b1b599b 1062</tr>
5b34fd86
SS
1063</thead>
1064<tbody>
8b1b599b 1065<tr>
5b34fd86
SS
1066<td>0, no, off, false, Single</td>
1067<td>Use only a single GPU when rendering</td>
8b1b599b
SS
1068</tr>
1069<tr>
5b34fd86
SS
1070<td>1, yes, on, true, Auto</td>
1071<td>Enable Multi-GPU and allow the driver to automatically select
1072the appropriate rendering mode.</td>
8b1b599b
SS
1073</tr>
1074<tr>
5b34fd86
SS
1075<td>AFR</td>
1076<td>Enable Multi-GPU and use the Alternate Frame Rendering
1077mode.</td>
8b1b599b
SS
1078</tr>
1079<tr>
5b34fd86
SS
1080<td>SFR</td>
1081<td>Enable Multi-GPU and use the Split Frame Rendering mode.</td>
8b1b599b
SS
1082</tr>
1083<tr>
5b34fd86
SS
1084<td>AA</td>
1085<td>Enable Multi-GPU and use antialiasing. Use this in conjunction
1086with full scene antialiasing to improve visual quality.</td>
8b1b599b 1087</tr>
5b34fd86
SS
1088</tbody>
1089</table>
1090</div>
1091<p></p>
1092</dd>
1093<dt><a name="SLI" id="SLI"></a><span class="term"><code class=
1094"computeroutput">Option "SLI" "string"</code></span></dt>
1095<dd>
1096<p>This option controls the configuration of SLI rendering in
1097supported configurations.</p>
1098<div class="informaltable">
1099<table summary="(no summary available)" border="0">
1100<colgroup>
1101<col>
1102<col></colgroup>
1103<thead>
8b1b599b 1104<tr>
5b34fd86
SS
1105<th>Value</th>
1106<th>Behavior</th>
8b1b599b 1107</tr>
5b34fd86
SS
1108</thead>
1109<tbody>
8b1b599b 1110<tr>
5b34fd86
SS
1111<td>0, no, off, false, Single</td>
1112<td>Use only a single GPU when rendering</td>
05d5f840
SS
1113</tr>
1114<tr>
5b34fd86
SS
1115<td>1, yes, on, true, Auto</td>
1116<td>Enable SLI and allow the driver to automatically select the
1117appropriate rendering mode.</td>
05d5f840
SS
1118</tr>
1119<tr>
5b34fd86
SS
1120<td>AFR</td>
1121<td>Enable SLI and use the Alternate Frame Rendering mode.</td>
05d5f840
SS
1122</tr>
1123<tr>
5b34fd86
SS
1124<td>SFR</td>
1125<td>Enable SLI and use the Split Frame Rendering mode.</td>
8b1b599b
SS
1126</tr>
1127<tr>
5b34fd86
SS
1128<td>AA</td>
1129<td>Enable SLI and use SLI Antialiasing. Use this in conjunction
1130with full scene antialiasing to improve visual quality.</td>
8b1b599b
SS
1131</tr>
1132<tr>
5b34fd86
SS
1133<td>AFRofAA</td>
1134<td>Enable SLI and use SLI Alternate Frame Rendering of
1135Antialiasing mode. Use this in conjunction with full scene
1136antialiasing to improve visual quality. This option is only valid
1137for SLI configurations with 4 GPUs.</td>
8b1b599b
SS
1138</tr>
1139</tbody>
1140</table>
1141</div>
1142<p></p>
5b34fd86
SS
1143</dd>
1144<dt><a name="TripleBuffer" id="TripleBuffer"></a><span class=
1145"term"><code class="computeroutput">Option "TripleBuffer"
1146"boolean"</code></span></dt>
1147<dd>
1148<p>Enable or disable the use of triple buffering. If this option is
1149enabled, OpenGL windows that sync to vblank and are double-buffered
1150will be given a third buffer. This decreases the time an
1151application stalls while waiting for vblank events, but increases
1152latency slightly (delay between user input and displayed
1153result).</p>
1154</dd>
1155<dt><a name="DPI" id="DPI"></a><span class="term"><code class=
1156"computeroutput">Option "DPI" "string"</code></span></dt>
1157<dd>
1158<p>This option specifies the Dots Per Inch for the X screen; for
1159example:</p>
1160<pre class="screen">
1161 Option "DPI" "75 x 85"
1162</pre>
1163<p>will set the horizontal DPI to 75 and the vertical DPI to 85. By
1164default, the X driver will compute the DPI of the X screen from the
1165EDID of any connected display devices. See <a href=
1166"appendix-e.html" title=
1167"Appendix&nbsp;E.&nbsp;Dots Per Inch">Appendix&nbsp;E, <i>Dots Per
1168Inch</i></a> for details. Default: string is NULL (disabled).</p>
1169</dd>
1170<dt><a name="UseEdidDpi" id="UseEdidDpi"></a><span class=
1171"term"><code class="computeroutput">Option "UseEdidDpi"
1172"string"</code></span></dt>
1173<dd>
1174<p>By default, the NVIDIA X driver computes the DPI of an X screen
1175based on the physical size of the display device, as reported in
1176the EDID, and the size in pixels of the first mode to be used on
1177the display device. If multiple display devices are used by the X
1178screen, then the NVIDIA X screen will choose which display device
1179to use. This option can be used to specify which display device to
1180use. The string argument can be a display device name, such as:</p>
1181<pre class="screen">
1182 Option "UseEdidDpi" "DFP-0"
1183</pre>
1184<p>or the argument can be "FALSE" to disable use of EDID-based DPI
1185calculations:</p>
1186<pre class="screen">
1187 Option "UseEdidDpi" "FALSE"
1188</pre>
1189<p>See <a href="appendix-e.html" title=
1190"Appendix&nbsp;E.&nbsp;Dots Per Inch">Appendix&nbsp;E, <i>Dots Per
1191Inch</i></a> for details. Default: string is NULL (the driver
1192computes the DPI from the EDID of a display device and selects the
1193display device).</p>
1194</dd>
1195<dt><a name="ConstantDPI" id="ConstantDPI"></a><span class=
1196"term"><code class="computeroutput">Option "ConstantDPI"
1197"boolean"</code></span></dt>
1198<dd>
1199<p>By default on X.Org 6.9 or newer X servers, the NVIDIA X driver
1200recomputes the size in millimeters of the X screen whenever the
1201size in pixels of the X screen is changed using XRandR, such that
1202the DPI remains constant.</p>
1203<p>This behavior can be disabled (which means that the size in
1204millimeters will not change when the size in pixels of the X screen
1205changes) by setting the "ConstantDPI" option to "FALSE"; e.g.,</p>
1206<pre class="screen">
1207 Option "ConstantDPI" "FALSE"
1208</pre>
1209<p>ConstantDPI defaults to True.</p>
1210<p>On X servers older than X.Org 6.9, the NVIDIA X driver cannot
1211change the size in millimeters of the X screen. Therefore the DPI
1212of the X screen will change when XRandR changes the size in pixels
1213of the X screen. The driver will behave as if ConstantDPI was
1214forced to FALSE.</p>
1215</dd>
1216<dt><a name="CustomEDID" id="CustomEDID"></a><span class=
1217"term"><code class="computeroutput">Option "CustomEDID"
1218"string"</code></span></dt>
1219<dd>
1220<p>This option forces the X driver to use the EDID specified in a
1221file rather than the display's EDID. You may specify a semicolon
cfb7e7a6
SS
1222separated list of display names and filename pairs. Valid display
1223device names include "CRT-0", "CRT-1", "DFP-0", "DFP-1", "TV-0",
1224"TV-1", or one of the generic names "CRT", "DFP", "TV", which apply
1225the EDID to all devices of the specified type. Additionally, if SLI
1226Mosaic is enabled, this name can be prefixed by a GPU name (e.g.,
1227"GPU-0.CRT-0"). The file contains a raw EDID (e.g., a file
1228generated by nvidia-settings).</p>
5b34fd86
SS
1229<p>For example:</p>
1230<pre class="screen">
1231 Option "CustomEDID" "CRT-0:/tmp/edid1.bin; DFP-0:/tmp/edid2.bin"
1232</pre>
1233<p>will assign the EDID from the file /tmp/edid1.bin to the display
1234device CRT-0, and the EDID from the file /tmp/edid2.bin to the
1235display device DFP-0. Note that a display device name must always
1236be specified even if only one EDID is specified.</p>
1237<p>Caution: Specifying an EDID that doesn't exactly match your
1238display may damage your hardware, as it allows the driver to
1239specify timings beyond the capabilities of your display. Use with
1240care.</p>
1241</dd>
cfb7e7a6
SS
1242<dt><a name="IgnoreEDIDChecksum" id=
1243"IgnoreEDIDChecksum"></a><span class="term"><code class=
1244"computeroutput">Option "IgnoreEDIDChecksum"
1245"string"</code></span></dt>
1246<dd>
1247<p>This option forces the X driver to accept an EDID even if the
1248checksum is invalid. You may specify a comma separated list of
1249display names. Valid display device names include "CRT-0", "CRT-1",
1250"DFP-0", "DFP-1", "TV-0", "TV-1", or one of the generic names
1251"CRT", "DFP", "TV", which ignore the EDID checksum on all devices
1252of the specified type. Additionally, if SLI Mosaic is enabled, this
1253name can be prefixed by a GPU name (e.g., "GPU-0.CRT-0").</p>
1254<p>For example:</p>
1255<pre class="screen">
1256 Option "IgnoreEDIDChecksum" "CRT, DFP-0"
1257</pre>
1258<p>will cause the nvidia driver to ignore the EDID checksum for all
1259CRT monitors and the displays DFP-0 and TV-0.</p>
1260<p>Caution: An invalid EDID checksum may indicate a corrupt EDID. A
1261corrupt EDID may have mode timings beyond the capabilities of your
1262display, and using it could damage your hardware. Use with
1263care.</p>
1264</dd>
5b34fd86
SS
1265<dt><a name="ModeValidation" id="ModeValidation"></a><span class=
1266"term"><code class="computeroutput">Option "ModeValidation"
1267"string"</code></span></dt>
1268<dd>
1269<p>This option provides fine-grained control over each stage of the
1270mode validation pipeline, disabling individual mode validation
1271checks. This option should only very rarely be used.</p>
1272<p>The option string is a semicolon-separated list of
1273comma-separated lists of mode validation arguments. Each list of
1274mode validation arguments can optionally be prepended with a
1275display device name.</p>
1276<pre class="screen">
1277 "&lt;dpy-0&gt;: &lt;tok&gt;, &lt;tok&gt;; &lt;dpy-1&gt;: &lt;tok&gt;, &lt;tok&gt;, &lt;tok&gt;; ..."
1278</pre>
1279<p></p>
1280<p>Possible arguments:</p>
1281<div class="itemizedlist">
1282<ul type="disc">
1283<li>
1284<p>"AllowNon60HzDFPModes": some lower quality TMDS encoders are
1285only rated to drive DFPs at 60Hz; the driver will determine when
1286only 60Hz DFP modes are allowed. This argument disables this stage
1287of the mode validation pipeline.</p>
1288</li>
1289<li>
1290<p>"NoMaxPClkCheck": each mode has a pixel clock; this pixel clock
1291is validated against the maximum pixel clock of the hardware (for a
1292DFP, this is the maximum pixel clock of the TMDS encoder, for a
1293CRT, this is the maximum pixel clock of the DAC). This argument
1294disables the maximum pixel clock checking stage of the mode
1295validation pipeline.</p>
1296</li>
1297<li>
1298<p>"NoEdidMaxPClkCheck": a display device's EDID can specify the
1299maximum pixel clock that the display device supports; a mode's
1300pixel clock is validated against this pixel clock maximum. This
1301argument disables this stage of the mode validation pipeline.</p>
1302</li>
1303<li>
1304<p>"AllowInterlacedModes": interlaced modes are not supported on
1305all NVIDIA GPUs; the driver will discard interlaced modes on GPUs
1306where interlaced modes are not supported; this argument disables
1307this stage of the mode validation pipeline.</p>
1308</li>
1309<li>
1310<p>"NoMaxSizeCheck": each NVIDIA GPU has a maximum resolution that
1311it can drive; this argument disables this stage of the mode
1312validation pipeline.</p>
1313</li>
1314<li>
1315<p>"NoHorizSyncCheck": a mode's horizontal sync is validated
1316against the range of valid horizontal sync values; this argument
1317disables this stage of the mode validation pipeline.</p>
1318</li>
1319<li>
1320<p>"NoVertRefreshCheck": a mode's vertical refresh rate is
1321validated against the range of valid vertical refresh rate values;
1322this argument disables this stage of the mode validation
1323pipeline.</p>
1324</li>
1325<li>
1326<p>"NoWidthAlignmentCheck": the alignment of a mode's visible width
1327is validated against the capabilities of the GPU; normally, a
1328mode's visible width must be a multiple of 8. This argument
1329disables this stage of the mode validation pipeline.</p>
1330</li>
1331<li>
1332<p>"NoDFPNativeResolutionCheck": when validating for a DFP, a
1333mode's size is validated against the native resolution of the DFP;
1334this argument disables this stage of the mode validation
1335pipeline.</p>
1336</li>
1337<li>
1338<p>"NoVirtualSizeCheck": if the X configuration file requests a
1339specific virtual screen size, a mode cannot be larger than that
1340virtual size; this argument disables this stage of the mode
1341validation pipeline.</p>
1342</li>
1343<li>
1344<p>"NoVesaModes": when constructing the mode pool for a display
1345device, the X driver uses a built-in list of VESA modes as one of
1346the mode sources; this argument disables use of these built-in VESA
1347modes.</p>
1348</li>
1349<li>
1350<p>"NoEdidModes": when constructing the mode pool for a display
1351device, the X driver uses any modes listed in the display device's
1352EDID as one of the mode sources; this argument disables use of
1353EDID-specified modes.</p>
1354</li>
1355<li>
1356<p>"NoXServerModes": when constructing the mode pool for a display
1357device, the X driver uses the built-in modes provided by the core
1358XFree86/Xorg X server as one of the mode sources; this argument
1359disables use of these modes. Note that this argument does not
1360disable custom ModeLines specified in the X config file; see the
1361"NoCustomModes" argument for that.</p>
1362</li>
1363<li>
1364<p>"NoCustomModes": when constructing the mode pool for a display
1365device, the X driver uses custom ModeLines specified in the X
1366config file (through the "Mode" or "ModeLine" entries in the
1367Monitor Section) as one of the mode sources; this argument disables
1368use of these modes.</p>
1369</li>
1370<li>
1371<p>"NoPredefinedModes": when constructing the mode pool for a
1372display device, the X driver uses additional modes predefined by
1373the NVIDIA X driver; this argument disables use of these modes.</p>
1374</li>
1375<li>
1376<p>"NoUserModes": additional modes can be added to the mode pool
1377dynamically, using the NV-CONTROL X extension; this argument
1378prohibits user-specified modes via the NV-CONTROL X extension.</p>
1379</li>
1380<li>
1381<p>"NoExtendedGpuCapabilitiesCheck": allow mode timings that may
1382exceed the GPU's extended capability checks.</p>
1383</li>
1384<li>
1385<p>"ObeyEdidContradictions": an EDID may contradict itself by
1386listing a mode as supported, but the mode may exceed an
1387EDID-specified valid frequency range (HorizSync, VertRefresh, or
1388maximum pixel clock). Normally, the NVIDIA X driver prints a
1389warning in this scenario, but does not invalidate an EDID-specified
1390mode just because it exceeds an EDID-specified valid frequency
1391range. However, the "ObeyEdidContradictions" argument instructs the
1392NVIDIA X driver to invalidate these modes.</p>
1393</li>
1394<li>
1395<p>"NoTotalSizeCheck": allow modes in which the individual visible
1396or sync pulse timings exceed the total raster size.</p>
1397</li>
1398<li>
1399<p>"DoubleScanPriority": on GPUs older than G80, doublescan modes
1400are sorted before non-doublescan modes of the same resolution for
1401purposes of mode pool sorting; but on G80 and later GPUs,
1402doublescan modes are sorted after non-doublescan modes of the same
1403resolution. This token inverts that priority (i.e., doublescan
1404modes will be sorted after on pre-G80 GPUs, and sorted before on
1405G80 and later GPUs).</p>
1406</li>
1407<li>
1408<p>"NoDualLinkDVICheck": for mode timings used on dual link DVI
1409DFPs, the driver must perform additional checks to ensure that the
1410correct pixels are sent on the correct link. For some of these
1411checks, the driver will invalidate the mode timings; for other
1412checks, the driver will implicitly modify the mode timings to meet
1413the GPU's dual link DVI requirements. This token disables this dual
1414link DVI checking.</p>
1415</li>
cfb7e7a6
SS
1416<li>
1417<p>"NoDisplayPortBandwidthCheck": for mode timings used on
1418DisplayPort devices, the driver must verify that the DisplayPort
1419link can be configured to carry enough bandwidth to support a given
1420mode's pixel clock. For example, some DisplayPort-to-VGA adapters
1421only support 2 DisplayPort lanes, limiting the resolutions they can
1422display. This token disables this DisplayPort bandwidth check.</p>
1423</li>
5b34fd86
SS
1424</ul>
1425</div>
1426<p></p>
1427<p>Examples:</p>
1428<pre class="screen">
1429 Option "ModeValidation" "NoMaxPClkCheck"
1430</pre>
1431<p>disable the maximum pixel clock check when validating modes on
1432all display devices.</p>
1433<pre class="screen">
1434 Option "ModeValidation" "CRT-0: NoEdidModes, NoMaxPClkCheck; DFP-0: NoVesaModes"
1435</pre>
1436<p>do not use EDID modes and do not perform the maximum pixel clock
1437check on CRT-0, and do not use VESA modes on DFP-0.</p>
1438</dd>
1439<dt><a name="ModeDebug" id="ModeDebug"></a><span class=
1440"term"><code class="computeroutput">Option "ModeDebug"
1441"boolean"</code></span></dt>
1442<dd>
1443<p>This option causes the X driver to print verbose details about
1444mode validation to the X log file. Note that this option is applied
1445globally: setting this option to TRUE will enable verbose mode
1446validation logging for all NVIDIA X screens in the X server.</p>
1447</dd>
1448<dt><a name="UseEvents" id="UseEvents"></a><span class=
1449"term"><code class="computeroutput">Option "UseEvents"
1450"boolean"</code></span></dt>
1451<dd>
1452<p>Enables the use of system events in some cases when the X driver
1453is waiting for the hardware. The X driver can briefly spin through
1454a tight loop when waiting for the hardware. With this option the X
1455driver instead sets an event handler and waits for the hardware
1456through the <span><strong class="command">poll()</strong></span>
1457system call. Default: the use of the events is disabled.</p>
1458</dd>
1459<dt><a name="FlatPanelProperties" id=
1460"FlatPanelProperties"></a><span class="term"><code class=
1461"computeroutput">Option "FlatPanelProperties"
1462"string"</code></span></dt>
1463<dd>
1464<p>This option requests particular properties for all or a subset
1465of the connected flat panels.</p>
1466<p>The option string is a semicolon-separated list of
1467comma-separated property=value pairs. Each list of property=value
1468pairs can optionally be prepended with a flat panel name.</p>
1469<pre class="screen">
1470 "&lt;DFP-0&gt;: &lt;property=value&gt;, &lt;property=value&gt;; &lt;DFP-1&gt;: &lt;property=value&gt;; ..."
1471</pre>
1472<p></p>
1473<p>Recognized properties:</p>
1474<div class="itemizedlist">
1475<ul type="disc">
1476<li>
1477<p>"Scaling": controls the flat panel scaling mode; possible values
1478are: 'Default' (the driver will use whichever scaling state is
1479current), 'Native' (the driver will use the flat panel's scaler, if
1480possible), 'Scaled' (the driver will use the NVIDIA GPU's scaler,
1481if possible), 'Centered' (the driver will center the image, if
1482possible), and 'aspect-scaled' (the X driver will scale with the
1483NVIDIA GPU's scaler, but keep the aspect ratio correct).</p>
1484</li>
1485<li>
1486<p>"Dithering": controls the flat panel dithering mode; possible
1487values are: 'Default' (the driver will decide when to dither),
1488'Enabled' (the driver will always dither, if possible), and
1489'Disabled' (the driver will never dither).</p>
1490</li>
1491</ul>
1492</div>
1493<p></p>
1494<p>Examples:</p>
1495<pre class="screen">
1496 Option "FlatPanelProperties" "Scaling = Centered"
1497</pre>
1498<p>set the flat panel scaling mode to centered on all flat
1499panels.</p>
1500<pre class="screen">
1501 Option "FlatPanelProperties" "DFP-0: Scaling = Centered; DFP-1: Scaling = Scaled, Dithering = Enabled"
1502</pre>
1503<p>set DFP-0's scaling mode to centered, set DFP-1's scaling mode
1504to scaled and its dithering mode to enabled.</p>
1505</dd>
1506<dt><a name="ProbeAllGpus" id="ProbeAllGpus"></a><span class=
1507"term"><code class="computeroutput">Option "ProbeAllGpus"
1508"boolean"</code></span></dt>
1509<dd>
1510<p>When the NVIDIA X driver initializes, it probes all GPUs in the
1511system, even if no X screens are configured on them. This is done
1512so that the X driver can report information about all the system's
1513GPUs through the NV-CONTROL X extension. This option can be set to
1514FALSE to disable this behavior, such that only GPUs with X screens
1515configured on them will be probed. Default: all GPUs in the system
1516are probed.</p>
1517</dd>
1518<dt><a name="DynamicTwinView" id="DynamicTwinView"></a><span class=
1519"term"><code class="computeroutput">Option "DynamicTwinView"
1520"boolean"</code></span></dt>
1521<dd>
1522<p>Enable or disable support for dynamically configuring TwinView
1523on this X screen. When DynamicTwinView is enabled (the default),
1524the refresh rate of a mode (reported through XF86VidMode or XRandR)
1525does not correctly report the refresh rate, but instead is a unique
1526number such that each MetaMode has a different value. This is to
1527guarantee that MetaModes can be uniquely identified by XRandR.</p>
1528<p>When DynamicTwinView is disabled, the refresh rate reported
1529through XRandR will be accurate, but NV-CONTROL clients such as
1530nvidia-settings will not be able to dynamically manipulate the X
1531screen's MetaModes. TwinView can still be configured from the X
1532config file when DynamicTwinView is disabled.</p>
1533<p>Default: DynamicTwinView is enabled.</p>
1534</dd>
1535<dt><a name="IncludeImplicitMetaModes" id=
1536"IncludeImplicitMetaModes"></a><span class="term"><code class=
1537"computeroutput">Option "IncludeImplicitMetaModes"
1538"boolean"</code></span></dt>
1539<dd>
1540<p>When the X server starts, a mode pool is created per display
1541device, containing all the mode timings that the NVIDIA X driver
1542determined to be valid for the display device. However, the only
1543MetaModes that are made available to the X server are the ones
1544explicitly requested in the X configuration file.</p>
1545<p>It is convenient for fullscreen applications to be able to
1546change between the modes in the mode pool, even if a given target
1547mode was not explicitly requested in the X configuration file.</p>
1548<p>To facilitate this, the NVIDIA X driver will, if only one
1549display device is in use when the X server starts, implicitly add
1550MetaModes for all modes in the display device's mode pool. This
1551makes all the modes in the mode pool available to full screen
1552applications that use the XF86VidMode or XRandR X extensions.</p>
1553<p>To prevent this behavior, and only add MetaModes that are
1554explicitly requested in the X configuration file, set this option
1555to FALSE.</p>
1556<p>Default: IncludeImplicitMetaModes is enabled.</p>
1557</dd>
1558<dt><a name="AllowIndirectPixmaps" id=
1559"AllowIndirectPixmaps"></a><span class="term"><code class=
1560"computeroutput">Option "AllowIndirectPixmaps"
1561"boolean"</code></span></dt>
1562<dd>
1563<p>Some graphics cards have more video memory than can be mapped at
1564once by the CPU (generally only 256 MB of video memory can be
1565CPU-mapped). On graphics cards based on G80 and higher with such a
1566memory configuration, this option allows the driver to place more
1567pixmaps in video memory which will improve hardware rendering
1568performance but will slow down software rendering. On some systems,
1569up to 768 megabytes of virtual address space will be reserved in
1570the X server for indirect pixmap access. This virtual memory does
1571not consume any physical resources.</p>
1572<p>Default: on (indirect pixmaps will be used, when available).</p>
1573</dd>
1574<dt><a name="OnDemandVBlankInterrupts" id=
1575"OnDemandVBlankInterrupts"></a><span class="term"><code class=
1576"computeroutput">Option "OnDemandVBlankInterrupts"
1577"boolean"</code></span></dt>
1578<dd>
1579<p>Normally, VBlank interrupts are generated on every vertical
1580refresh of every display device connected to the GPU(s) installed
1581in a given system. This experimental option enables on-demand
1582VBlank control, allowing the driver to enable VBlank interrupt
1583generation only when it is required. This can help conserve
1584power.</p>
1585<p>Default: off (on-demand VBlank control is disabled).</p>
1586</dd>
1587<dt><a name="PixmapCacheSize" id="PixmapCacheSize"></a><span class=
1588"term"><code class="computeroutput">Option "PixmapCacheSize"
1589"size"</code></span></dt>
1590<dd>
1591<p>This option controls how much video memory is reserved for
1592pixmap allocations. When the option is specified, <code class=
1593"computeroutput">size</code> specifies the number of bytes to use
1594for the pixmap cache. Reserving this memory improves performance
1595when pixmaps are created and destroyed rapidly, but prevents this
1596memory from being used by OpenGL. When this cache is disabled or
1597space in the cache is exhausted, the driver will still allocate
1598pixmaps in video memory but pixmap creation and deletion
1599performance will not be improved.</p>
1600<p>NOTE: This option is deprecated in favor of the
1601PixmapCacheRoundSizeKB nvidia-settings attribute and will be
1602removed in a future driver release.</p>
1603<p>Example: <code class="computeroutput">Option "PixmapCacheSize"
1604"1048576"</code> will allocate one megabyte for the pixmap
1605cache.</p>
1606<p>Default: off (no memory is reserved specifically for
1607pixmaps).</p>
1608</dd>
1609<dt><a name="AllowSHMPixmaps" id="AllowSHMPixmaps"></a><span class=
1610"term"><code class="computeroutput">Option "AllowSHMPixmaps"
1611"boolean"</code></span></dt>
1612<dd>
1613<p>This option controls whether applications can use the MIT-SHM X
1614extension to create pixmaps whose contents are shared between the X
1615server and the client. These pixmaps prevent the NVIDIA driver from
1616performing a number of optimizations and degrade performance in
1617many circumstances.</p>
1618<p>Disabling this option disables only shared memory pixmaps.
1619Applications can still use the MIT-SHM extension to transfer data
1620to the X server through shared memory using XShmPutImage.</p>
1621<p>Default: off (shared memory pixmaps are not allowed).</p>
1622</dd>
1623<dt><a name="InitializeWindowBackingPixmaps" id=
1624"InitializeWindowBackingPixmaps"></a><span class=
1625"term"><code class="computeroutput">Option
1626"InitializeWindowBackingPixmaps" "boolean"</code></span></dt>
1627<dd>
1628<p>This option controls whether the NVIDIA X Driver initializes
1629newly created redirected windows using the contents of their parent
1630window if the X server doesn't do it. Leaving redirected windows
1631uninitialized may cause new windows to flash with black or random
1632colors when some compositing managers are running.</p>
1633<p>This option will have no effect on X servers that already
1634initialize redirected window contents. In most distributions, the X
1635server is patched to skip that initialization. In this case, it is
1636recommended to leave this option on for a better user
1637experience.</p>
1638<p>Default: on (redirected windows are initialized).</p>
1639</dd>
1640<dt><a name="AllowUnofficialGLXProtocol" id=
1641"AllowUnofficialGLXProtocol"></a><span class="term"><code class=
1642"computeroutput">Option "AllowUnofficialGLXProtocol"
1643"boolean"</code></span></dt>
1644<dd>
1645<p>By default, the NVIDIA GLX implementation will not expose GLX
1646protocol for GL commands if the protocol is not considered
1647complete. Protocol could be considered incomplete for a number of
1648reasons. The implementation could still be under development and
1649contain known bugs, or the protocol specification itself could be
1650under development or going through review. If users would like to
1651test the server-side portion of such protocol when using indirect
1652rendering, they can enable this option. If any X screen enables
1653this option, it will enable protocol on all screens in the
1654server.</p>
1655<p>When an NVIDIA GLX client is used, the related environment
1656variable <a href=
1657"chapter-10.html#unofficialprotoenv">__GL_ALLOW_UNOFFICIAL_PROTOCOL</a>
1658will need to be set as well to enable support in the client.</p>
1659</dd>
1660<dt><a name="PanAllDisplays" id="PanAllDisplays"></a><span class=
1661"term"><code class="computeroutput">Option "PanAllDisplays"
1662"boolean"</code></span></dt>
1663<dd>
1664<p>When this option is enabled, all displays in the current
1665MetaMode will pan as the pointer is moved. If disabled, only the
1666displays whose panning domain contains the pointer (at its new
1667location) are panned.</p>
1668<p>Default: enabled (all displays are panned when the pointer is
1669moved).</p>
1670</dd>
cfb7e7a6
SS
1671<dt><a name="GvoDataFormat" id="GvoDataFormat"></a><span class=
1672"term"><code class="computeroutput">Option "GvoDataFormat"
1673"string"</code></span></dt>
1674<dd>
1675<p>This option controls the initial configuration of SDI (GVO)
1676device's output data format.</p>
1677<div class="informaltable">
1678<table summary="(no summary available)" border="0">
1679<colgroup>
1680<col></colgroup>
1681<thead>
1682<tr>
1683<th>Valid Values</th>
1684</tr>
1685</thead>
1686<tbody>
1687<tr>
1688<td>R8G8B8_To_YCrCb444</td>
1689</tr>
1690<tr>
1691<td>R8G8B8_To_YCrCb422</td>
1692</tr>
1693<tr>
1694<td>X8X8X8_To_PassThru444</td>
1695</tr>
1696</tbody>
1697</table>
1698</div>
1699<p></p>
1700<p>Default: R8G8B8_To_YCrCb444.</p>
1701</dd>
1702<dt><a name="GvoSyncMode" id="GvoSyncMode"></a><span class=
1703"term"><code class="computeroutput">Option "GvoSyncMode"
1704"string"</code></span></dt>
1705<dd>
1706<p>This option controls the initial synchronization mode of the SDI
1707(GVO) device.</p>
1708<div class="informaltable">
1709<table summary="(no summary available)" border="0">
1710<colgroup>
1711<col>
1712<col></colgroup>
1713<thead>
1714<tr>
1715<th>Value</th>
1716<th>Behavior</th>
1717</tr>
1718</thead>
1719<tbody>
1720<tr>
1721<td>FreeRunning</td>
1722<td>The SDI output will be synchronized with the timing chosen from
1723the SDI signal format list.</td>
1724</tr>
1725<tr>
1726<td>GenLock</td>
1727<td>SDI output will be synchronized with the external sync signal
1728(if present/detected) with pixel accuracy.</td>
1729</tr>
1730<tr>
1731<td>FrameLock</td>
1732<td>SDI output will be synchronized with the external sync signal
1733(if present/detected) with frame accuracy.</td>
1734</tr>
1735</tbody>
1736</table>
1737</div>
1738<p></p>
1739<p>Default: FreeRunning (Will not lock to an input signal).</p>
1740</dd>
1741<dt><a name="GvoSyncSource" id="GvoSyncSource"></a><span class=
1742"term"><code class="computeroutput">Option "GvoSyncSource"
1743"string"</code></span></dt>
1744<dd>
1745<p>This option controls the initial synchronization source (type)
1746of the SDI (GVO) device. Note that the GvoSyncMode should be set to
1747either GenLock or FrameLock for this option to take effect.</p>
1748<div class="informaltable">
1749<table summary="(no summary available)" border="0">
1750<colgroup>
1751<col>
1752<col></colgroup>
1753<thead>
1754<tr>
1755<th>Value</th>
1756<th>Behavior</th>
1757</tr>
1758</thead>
1759<tbody>
1760<tr>
1761<td>Composite</td>
1762<td>Interpret sync source as composite.</td>
1763</tr>
1764<tr>
1765<td>SDI</td>
1766<td>Interpret sync source as SDI.</td>
1767</tr>
1768</tbody>
1769</table>
1770</div>
1771<p></p>
1772<p>Default: SDI.</p>
1773</dd>
5b34fd86
SS
1774</dl>
1775</div>
1776<p></p>
8b1b599b
SS
1777</div>
1778<div class="navfooter">
1779<hr>
1780<table width="100%" summary="Navigation footer">
1781<tr>
1782<td width="40%" align="left"><a accesskey="p" href=
5b34fd86 1783"appendix-a.html">Prev</a>&nbsp;</td>
8b1b599b 1784<td width="20%" align="center"><a accesskey="u" href=
5b34fd86 1785"part-02.html">Up</a></td>
8b1b599b 1786<td width="40%" align="right">&nbsp;<a accesskey="n" href=
5b34fd86 1787"appendix-c.html">Next</a></td>
8b1b599b
SS
1788</tr>
1789<tr>
1790<td width="40%" align="left" valign="top">
5b34fd86 1791Appendix&nbsp;A.&nbsp;Supported NVIDIA GPU Products&nbsp;</td>
8b1b599b
SS
1792<td width="20%" align="center"><a accesskey="h" href=
1793"index.html">Home</a></td>
1794<td width="40%" align="right" valign="top">
5b34fd86 1795&nbsp;Appendix&nbsp;C.&nbsp;Display Device Names</td>
8b1b599b
SS
1796</tr>
1797</table>
1798</div>
1799</body>
1800</html>