import NVIDIA-FreeBSD-x86-180.29
[nvidia.git] / x11 / man / nvidia-xconfig.1
1 .\" Copyright (C) 2005 NVIDIA Corporation.
2 .\"
3 .\" WARNING: THIS FILE IS AUTO-GENERATED!  Edit nvidia-xconfig.1.m4 instead.
4 .TH nvidia-xconfig 1 2005-08-19 "nvidia-xconfig 1.0"
5 .SH NAME
6 nvidia-xconfig \- manipulate X configuration files for the NVIDIA driver
7 .SH SYNOPSIS
8 .B nvidia-xconfig
9 [
10 .I options
11 ]
12 .SH DESCRIPTION
13 .PP
14 .B nvidia-xconfig
15 is a tool intended to provide basic control over configuration options available in the NVIDIA X driver.
16 .PP
17 .B nvidia-xconfig
18 performs its operations in several steps:
19 .TP
20 1)
21 The system X configuration file is found and read into memory.
22 If no configuration file can be found,
23 .B nvidia-xconfig
24 generates one from scratch using default settings; in this case, 
25 .B nvidia-xconfig 
26 will automatically determine the name of the X 
27 configuration file to create:
28 .I /etc/X11/xorg.conf
29 if the X server
30 in use is X.org or 
31 .I /etc/X11/XF86Config
32 if the X server in use is XFree86.
33 .TP
34 2)
35 The configuration in memory is modified to support the NVIDIA driver.
36 This consists of changing the display driver to "nvidia", removing the commands to load the "GLcore" and "dri" modules, and adding the command to load the "glx" module.
37 .TP
38 3)
39 The configuration in memory is modified according to the options specified on the command line.
40 Please see the NVIDIA README for a description of the NVIDIA X configuration file options.
41 Note that
42 .B nvidia-xconfig 
43 does not perform any validation of the X configuration file options requested on the command line;
44 X configuration file option validation is left for the NVIDIA X driver.
45 .TP
46 4)
47 The configuration is written back to the file from which it was read.
48 A backup of the original configuration is created with "\.backup" appended.
49 For example, if your X configuration is
50 .I /etc/X11/xorg.conf
51 then
52 .B nvidia-xconfig
53 will copy it to
54 .I /etc/X11/xorg.conf.backup
55 before writing the new configuration.
56 The
57 .B \-\-post\-tree (\-T)
58 option can be used to print the new configuration to standard out in tree form instead.  This option is useful to see what
59 .B nvidia-xconfig
60 will do while leaving the original configuration intact.
61 .SH OPTIONS
62 .TP
63 .BI "\-c " "XCONFIG" ", \-\-xconfig=" "XCONFIG"
64 Use 
65 .I XCONFIG
66 as the input X config file; if this option is not specified, then the same search path used by the X server will be used to find the X configuration file.
67 .TP
68 .BI "\-o " "OUTPUT-XCONFIG" ", \-\-output-xconfig=" "OUTPUT-XCONFIG"
69 Use 
70 .I OUTPUT\-XCONFIG
71 as the output X configuration file; if this option is not specified, then the input X configuration filename will also be used as the output X configuration filename.
72 .TP
73 .BI "\-s, \-\-silent"
74 Run silently; no messages will be printed to stdout, except for warning and error messages to stderr.
75 .TP
76 .BI "\-t, \-\-tree"
77 Read the X configuration file, print to stdout the X configuration data in a tree format, and exit.
78 .TP
79 .BI "\-v, \-\-version"
80 Print the nvidia\-xconfig version and exit.
81 .TP
82 .BI "\-h, \-\-help"
83 Print usage information for the common commandline options and exit.
84 .TP
85 .BI "\-A, \-\-advanced-help"
86 Print usage information for the common commandline options as well as the advanced options, and then exit.
87 .SH "ADVANCED OPTIONS"
88 .TP
89 .BI "\-\-acpid-socket-path=" "ACPID-SOCKET-PATH" ", \-\-no\-acpid-socket-path"
90 Set this option to specify an alternate path to the Linux ACPI daemon (acpid)'s socket, which the NVIDIA X driver will use to connect to acpid.
91 .TP
92 .BI "\-\-add-argb-glx-visuals, \-\-no\-add-argb-glx-visuals"
93 Enables or disables support for OpenGL rendering into 32\-bit ARGB windows and pixmaps.
94 .TP
95 .BI "\-\-allow-dfp-stereo, \-\-no\-allow-dfp-stereo"
96 Enable or disable the "AllowDFPStereo" X configuration option.
97 .TP
98 .BI "\-\-allow-glx-with-composite, \-\-no\-allow-glx-with-composite"
99 Enable or disable the "AllowGLXWithComposite" X configuration option.
100 .TP
101 .BI "\-\-bandwidth-test, \-\-no\-bandwidth-test"
102 Disable or enable the "NoBandWidthTest" X configuration option.
103 .TP
104 .BI "\-\-cool-bits=" "COOL-BITS" ", \-\-no\-cool-bits"
105 Enable or disable the "Coolbits" X configuration option. Setting this option will enable support in the NV\-CONTROL X extension for manipulating GPU clock settings. Default value is 0.
106 WARNING: this may cause system damage and void warranties.
107 .TP
108 .BI "\-\-composite, \-\-no\-composite"
109 Enable or disable the "Composite" X extension.
110 .TP
111 .BI "\-\-connect-to-acpid, \-\-no\-connect-to-acpid"
112 Enable or disable the "ConnectToAcpid" X configuration option.  If this option is set, the NVIDIA X driver will attempt to connect to the Linux ACPI daemon (acpid).  Set this option to off to prevent the X driver from attempting to connect to acpid.
113 .TP
114 .BI "\-\-constant-dpi, \-\-no\-constant-dpi"
115 Enable or disable the "ConstantDPI" X configuration option, which controls whether the NVIDIA X driver maintains a constant dots per inch (DPI) value by recomputing the reported size in millimeters of the X screen when XRandR changes the size in pixels of the X screen.
116 .TP
117 .BI "\-\-custom-edid=" "CUSTOM-EDID" ", \-\-no\-custom-edid"
118 Enable or disable the  "CustomEDID" X configuration option; setting this option forces the X driver to use the EDID specified.This option is a semicolon\-separated list of pairs of display device names and filename pairs; e.g "CRT\-0:\tmp\edid.bin". Note that a display device name must always be specified even if only one EDID is specified. 
119 .TP
120 .BI "\-\-dac-8bit, \-\-no\-dac-8bit"
121 Most Quadro parts by default use a 10 bit color look up table (LUT) by default; setting this option to TRUE forces these graphics chips to use an 8 bit (LUT).
122 .TP
123 .BI "\-d " "DEPTH" ", \-\-depth=" "DEPTH"
124 Set the default depth to 
125 .I DEPTH
126 ; valid values for 
127 .I DEPTH
128 are 8, 15, 16, 24, and 30.
129 .TP
130 .BI "\-\-disable-glx-root-clipping, \-\-no\-disable-glx-root-clipping"
131 Disable or enable clipping OpenGL rendering to the root window via the "DisableGLXRootClipping" X configuration option.
132 .TP
133 .BI "\-\-damage-events, \-\-no\-damage-events"
134 Use OS\-level events to notify the X server when a direct\-rendering client has performed rendering that needs to be composited to the screen.  Improves performance when using GLX with the composite extension.
135 .TP
136 .BI "\-\-dynamic-twinview, \-\-no\-dynamic-twinview"
137 Enable or disable support for dynamically configuring TwinView.
138 .TP
139 .BI "\-\-preserve-driver-name"
140 By default nvidia\-xconfig changes the  display  driver  to "nvidia" for all configured X screens; this option preserves the existing driver name of each X screen.
141 .TP
142 .BI "\-\-enable-acpi-hotkeys, \-\-no\-enable-acpi-hotkeys"
143 The "EnableACPIHotkeys" option can be specified to override the NVIDIA X driver's default decision to enable or disable ACPI display change hotkey events.
144 .TP
145 .BI "\-a, \-\-enable-all-gpus"
146 Configure an X screen on every GPU in the system.
147 .TP
148 .BI "\-\-exact-mode-timings-dvi, \-\-no\-exact-mode-timings-dvi"
149 Forces the initialization of the X server with the exact timings specified in the ModeLine.
150 .TP
151 .BI "\-E " "FILE" ", \-\-extract-edids-from-file=" "FILE"
152 Extract any raw EDID byte blocks contained in the specified X log file 
153 .I LOG
154 ; raw EDID bytes are printed by the NVIDIA X driver to the X log as hexidecimal when verbose logging is enabled with the "\-logverbose 6" X server commandline option.  Any extracted EDIDs are then written as binary data to individual files.  These files can later be used by the NVIDIA X driver through the "CustomEDID" X configuration option.
155 .TP
156 .BI "\-\-extract-edids-output-file=" "FILENAME"
157 When the '\-\-extract\-edids\-from\-log' option is used, nvidia\-xconfig writes any extracted EDID to a file, typically "edid.bin" in the current directory.  Use this option to specify an alternate filename.  Note that nvidia\-xconfig, if necessary, will append a unique number to the EDID filename, to avoid overwriting existing files (e.g., "edid.bin.1" if "edid.bin" already exists).
158 .TP
159 .BI "\-\-flip, \-\-no\-flip"
160 Enable or disable OpenGL flipping
161 .TP
162 .BI "\-\-force-generate"
163 Force generation of a new X config file, ignoring any existing system X config file.  This is not typically recommended, as things like the mouse protocol, keyboard layout, font paths, etc, are setup by your Unix distribution.  While nvidia\-xconfig can attempt to infer these values, it is best to use your Unix distribution's X config file for the basis of anything that nvidia\-xconfig creates.
164 .TP
165 .BI "\-\-force-stereo-flipping, \-\-no\-force-stereo-flipping"
166 Normally, stereo flipping is only performed when a stereo drawable is visible. This option forces stereo flipping even when no stereo drawables are visible.
167 .TP
168 .BI "\-\-handle-special-keys=" "WHEN" ", \-\-no\-handle-special-keys"
169 Specify when the X server should use the builtin keyboard handler to process special key combinations (such as Ctrl+Alt+Backspace); see the X configuration man page for details.  The value of 
170 .I WHEN
171 can be 'Always', 'Never', or 'WhenNeeded'.
172 .TP
173 .BI "\-\-include-implicit-metamodes, \-\-no\-include-implicit-metamodes"
174 Enable or disable the "IncludeImplicitMetaModes" X configuration option.
175 .TP
176 .BI "\-\-keyboard=" "KEYBOARD"
177 When generating a new X configuration file (which happens when no system X configuration file can be found, or the '\-\-force\-generate' option is specified), use 
178 .I KEYBOARD
179 as the keyboard type, rather than attempting to probe the system for the keyboard type.  For a list of possible keyboard types, see the '\-\-keyboard\-list' option.
180 .TP
181 .BI "\-\-keyboard-driver=" "DRIVER"
182 In most cases nvidia\-xconfig can automatically determine the correct keyboard driver to use (either 'kbd' or 'keyboard'). Use this option to override what nvidia\-xconfig detects. Typically, if you are using an X.Org X server, use 'kdb'; if you are using an XFree86 X server, use 'keyboard'.
183 .TP
184 .BI "\-\-keyboard-list"
185 Print to stdout the available keyboard types recognized by the '\-\-keyboard' option, and then exit.
186 .TP
187 .BI "\-\-layout=" "LAYOUT"
188 The nvidia\-xconfig utility operates on a Server Layout within the X configuration file.  If this option is specified, the layout named 
189 .I LAYOUT
190 in the X configuration file will be used.  If this option is not specified, the first Server Layout in the X configuration file is used.
191 .TP
192 .BI "\-\-load-kernel-module, \-\-no\-load-kernel-module"
193 Allow or disallow NVIDIA Linux X driver module to load the NVIDIA Linux kernel module automatically.
194 .TP
195 .BI "\-\-logo, \-\-no\-logo"
196 Disable or enable the "NoLogo" X configuration option.
197 .TP
198 .BI "\-\-logo-path=" "PATH" ", \-\-no\-logo-path"
199 Set the path to the PNG file to be used as the logo splash screen at X server startup.
200 .TP
201 .BI "\-\-mode=" "MODE" ""
202 Add the specified mode to the mode list.
203 .TP
204 .BI "\-\-mode-debug, \-\-no\-mode-debug"
205 Enable or disable the "ModeDebug" X configuration option; when enabled, this option causes the X driver to print verbose details about mode validation to the X log file.
206 .TP
207 .BI "\-\-mode-list=" "MODELIST"
208 Remove all existing modes from the X configuration's modelist and add the one(s) specified in the 
209 .I MODELIST
210 string.
211 .TP
212 .BI "\-\-remove-mode=" "MODE"
213 Remove the specified mode from the mode list.
214 .TP
215 .BI "\-\-mouse=" "MOUSE"
216 When generating a new X configuration file (which happens when no system X configuration file can be found, or the '\-\-force\-generate' option is specified), use 
217 .I MOUSE
218 as the mouse type, rather than attempting to probe the system for the mouse type.  For a list of possible mouse types, see the '\-\-mouse\-list' option.
219 .TP
220 .BI "\-\-mouse-list"
221 Print to stdout the available mouse types recognized by the '\-\-mouse' option, and then exit.
222 .TP
223 .BI "\-\-multigpu=" "MULTIGPU" ", \-\-no\-multigpu"
224 Enable or disable MultiGPU.  Valid values for 
225 .I MULTIGPU
226 are 'Off', 'On', 'Auto', 'AFR', 'SFR', 'AA'.
227 .TP
228 .BI "\-\-multisample-compatibility, \-\-no\-multisample-compatibility"
229 Enable or disable the use of separate front and back multisample buffers.
230 .TP
231 .BI "\-\-nvagp=" "NVAGP" ", \-\-no\-nvagp"
232 Set the NvAGP X config option value.  Possible values are 0 (no AGP), 1 (NVIDIA's AGP), 2 (AGPGART), 3 (try AGPGART, then try NVIDIA's AGP); these values can also be specified as 'none', 'nvagp', 'agpgart', or 'any'.
233 .TP
234 .BI "\-\-nvidia-cfg-path=" "PATH"
235 The nvidia\-cfg library is used to communicate with the NVIDIA kernel module to query basic properties of every GPU in the system.  This library is typically only used by nvidia\-xconfig when configuring multiple X screens.  This option tells nvidia\-xconfig where to look for this library (in case it cannot find it on its own).  This option should normally not be needed.
236 .TP
237 .BI "\-\-only-one-x-screen"
238
239 .TP
240 .BI "\-\-overlay, \-\-no\-overlay"
241 Enable or disable the "Overlay" X configuration option.
242 .TP
243 .BI "\-\-cioverlay, \-\-no\-cioverlay"
244 Enable or disable the color index overlay.
245 .TP
246 .BI "\-\-overlay-default-visual, \-\-no\-overlay-default-visual"
247 Enable or disable the "OverlayDefaultVisual" X configuration option.
248 .TP
249 .BI "\-\-transparent-index=" "INDEX" ", \-\-no\-transparent-index"
250 Pixel to use as transparent when using color index overlays.  Valid values for 
251 .I TRANSPARENT\-INDEX
252 are 0\-255.
253 .TP
254 .BI "\-T, \-\-post-tree"
255 Like the '\-\-tree' option, but goes through the full process of applying any user requested updates to the X configuration, before printing the final configuration to stdout in a tree format.  Effectively, this option just causes the configuration to be printed to stdout as a tree instead of writing the results to file.
256 .TP
257 .BI "\-\-power-connector-check, \-\-no\-power-connector-check"
258 Disable or enable the "NoPowerConnectorCheck" X configuration option.
259 .TP
260 .BI "\-\-probe-all-gpus, \-\-no\-probe-all-gpus"
261 Disable or enable the "ProbeAllGpus" X configuration option.
262 .TP
263 .BI "\-\-query-gpu-info"
264 Print information about all recognized NVIDIA GPUs in the system.
265 .TP
266 .BI "\-\-randr-rotation, \-\-no\-randr-rotation"
267 Enable or disable the "RandRRotation" X configuration option.
268 .TP
269 .BI "\-\-render-accel, \-\-no\-render-accel"
270 Enable or disable the "RenderAccel" X configuration option.
271 .TP
272 .BI "\-\-render-extension, \-\-no\-render-extension"
273 Disable or enable the "NoRenderExtension" X configuration option.
274 .TP
275 .BI "\-\-rotate=" "ROTATE" ", \-\-no\-rotate"
276 Enable or disable the "Rotate" X configuration option.  Valid values for 
277 .I ROTATE
278 are 'normal', 'left', 'CCW', 'inverted', 'right', and 'CW'.  Rotation can be disabled 
279 .TP
280 .BI "\-\-screen=" "SCREEN"
281 The nvidia\-xconfig utility operates on one or more screens within a Server Layout in the X configuration file.  If this option is specified, the screen named 
282 .I SCREEN
283 in the X configuration file will be used.  If this option is not specified, all screens within the selected Server Layout in the X configuration file will be used used.
284 .TP
285 .BI "\-\-separate-x-screens, \-\-no\-separate-x-screens"
286 A GPU that supports multiple simultaneous display devices can either drive these display devices in TwinView, or as separate X screens.  When the '\-\-separate\-x\-screens' option is specified, each GPU on which an X screen is currently configured will be updated to have two X screens configured.  The '\-\-no\-separate\-x\-screens' option will remove the second configured X screen on each GPU.  Please see the NVIDIA README description of "Separate X Screens on One GPU" for further details.
287 .TP
288 .BI "\-\-sli=" "SLI" ", \-\-no\-sli"
289 Enable or disable SLI.  Valid values for 
290 .I SLI
291 are 'Off', 'On', 'Auto', 'AFR', 'SFR', 'AA', 'AFRofAA'.
292 .TP
293 .BI "\-\-stereo=" "STEREO" ", \-\-no\-stereo"
294 Enable or disable the stereo mode.  Valid values for 
295 .I STEREO
296 are: 1 (DCC glasses), 2 (Blueline glasses), 3 (Onboard stereo), 4 (TwinView clone mode stereo), 5 (SeeReal digital flat panel), 6 (Sharp3D digital flat panel).
297 .TP
298 .BI "\-\-tv-standard=" "TV-STANDARD" ", \-\-no\-tv-standard"
299 Enable or disable the "TVStandard" X configuration option. Valid values for "TVStandard" are: "PAL\-B", "PAL\-D", "PAL\-G", "PAL\-H", "PAL\-I", "PAL\-K1", "PAL\-M", "PAL\-N", "PAL\-NC", "NTSC\-J", "NTSC\-M", "HD480i", "HD480p", "HD720p", "HD1080i", "HD1080p", "HD576i", "HD576p".
300 .TP
301 .BI "\-\-tv-out-format=" "TV-OUT-FORMAT" ", \-\-no\-tv-out-format"
302 Enable or disable the "TVOutFormat" X configuration option. Valid values for "TVOutFormat" are: "SVIDEO" and "COMPOSITE".
303 .TP
304 .BI "\-\-tv-over-scan=" "TV-OVER-SCAN" ", \-\-no\-tv-over-scan"
305 Enable or disable the "TVOverScan" X configuration option. Valid values are decimal values in the range 1.0 and 0.0.
306 .TP
307 .BI "\-\-twinview, \-\-no\-twinview"
308 Enable or disable TwinView.
309 .TP
310 .BI "\-\-twinview-orientation=" "ORIENTATION" ", \-\-no\-twinview-orientation"
311 Specify the TwinViewOrientation.  Valid values for 
312 .I ORIENTATION
313 are: "RightOf" (the default), "LeftOf", "Above", "Below", or "Clone".
314 .TP
315 .BI "\-\-twinview-xinerama-info, \-\-no\-twinview-xinerama-info"
316 Prohibits providing Xinerama information when in TwinView.
317 .TP
318 .BI "\-\-twinview-xinerama-info-order=" "TWINVIEW-XINERAMA-INFO-ORDER" ", \-\-no\-twinview-xinerama-info-order"
319 Enable or disable the "TwinViewXineramaInfoOrder" X configuration option.  
320 .I TWINVIEW\-XINERAMA\-INFO\-ORDER
321 is a comma\-separated list of display device names that describe the order in which TwinViewXineramaInfo should be reported.  E.g., "CRT, DFP, TV".
322 .TP
323 .BI "\-\-ubb, \-\-no\-ubb"
324 Enable or disable the "UBB" X configuration option.
325 .TP
326 .BI "\-\-use-edid, \-\-no\-use-edid"
327 Enable or disable use of the EDID (Extended Display Identification Data) from your display device(s).  The EDID will be used for driver operations such as building lists of available modes, determining valid frequency ranges, and computing the DPI (Dots Per Inch).  This option defaults to TRUE (the NVIDIA X driver will use the EDID, when available).  It is NOT recommended that you use this option to globally disable use of the EDID; instead, use '\-\-no\-use\-edid\-freqs' or '\-\-no\-use\-edid\-dpi' to disable specific uses of the EDID.
328 .TP
329 .BI "\-\-use-edid-dpi, \-\-no\-use-edid-dpi"
330 Enable or disable use of the physical size information in the display device's EDID, if any, to compute the DPI (Dots Per Inch) of the X screen.  This option defaults to TRUE (the NVIDIA X driver uses the EDID's physical size, when available, to compute the DPI).
331 .TP
332 .BI "\-\-use-edid-freqs, \-\-no\-use-edid-freqs"
333 Enable or disable use of the HorizSync and VertRefresh ranges given in a display device's EDID, if any.  EDID provided range information will override the HorizSync and VertRefresh ranges specified in the Monitor section.  This option defaults to TRUE (the NVIDIA X driver will use frequency information from the EDID, when available).
334 .TP
335 .BI "\-\-use-int10-module, \-\-no\-use-int10-module"
336 Enable use of the X Int10 module to soft\-boot all secondary cards, rather than POSTing the cards through the NVIDIA kernel module.
337 .TP
338 .BI "\-\-use-display-device=" "DISPLAY-DEVICE" ", \-\-no\-use-display-device"
339 Force the X driver to use the display device specified.
340 .TP
341 .BI "\-\-use-events, \-\-no\-use-events"
342 Enable or disable "UseEvents" X configuration option. Setting this option will enable the X driver to use the system events in some cases when it is waiting for the hardware. With this option X driver sets an event handler and waits for the hardware through the poll() system call. This option defaults to FALSE.
343 .TP
344 .BI "\-\-virtual=" "WIDTHxHEIGHT" ", \-\-no\-virtual"
345 Specify the virtual screen resolution.
346 .TP
347 .BI "\-\-x-prefix=" "X-PREFIX"
348 The X installation prefix; the default is /usr/X11R6/.  Only under rare circumstances should this option be needed.
349 .TP
350 .BI "\-\-xinerama, \-\-no\-xinerama"
351 Enable or disable Xinerama.
352 .TP
353 .BI "\-\-xvmc-uses-textures, \-\-no\-xvmc-uses-textures"
354 Forces XvMC to use the 3D engine for XvMCPutSurface requests rather than the video overlay.
355 .SH EXAMPLES
356 .TP
357 .B nvidia-xconfig
358 Reads an existing X config file and adapts it to use the NVIDIA driver.
359 If no X config file can be found, a new one is created at /etc/X11/XF86Config with default settings.
360 .TP
361 .B nvidia-xconfig \-\-post\-tree \-\-twinview
362 Reads the existing X configuration file, adds the TwinView option, and then prints the resulting config file to standard out in tree form.
363 The configuration file is not modified.
364 .TP
365 .B nvidia-xconfig \-\-enable\-all\-gpus
366 Examines the system and configures an X screen for each display device it finds.
367 .TP
368 .BI "nvidia-xconfig \-\-mode=" 1600x1200
369 Adds a 1600x1200 mode to an existing X configuration.
370 .TP
371 .BI "nvidia-xconfig \-\-mode-list=" "1600x1200 1280x1024"
372 Removes any existing modes from the X configuration file, replacing them with "1600x1200" and "1280x1024".
373 .TP
374 .B nvidia-xconfig \-\-only\-one\-x\-screen \-\-sli=Auto
375 Configures the X server to have just one X screen that will use SLI when available.
376 .\" .SH FILES
377 .\" .I /etc/X11/XF86Config
378 .\" .I /etc/X11/xorg.conf
379 .SH AUTHOR
380 Aaron Plattner
381 .br
382 NVIDIA Corporation
383 .SH "SEE ALSO"
384 .BR nvidia-settings (1),
385 .I /usr/share/doc/NVIDIA_GLX-1.0/README.txt
386 .SH COPYRIGHT
387 Copyright \(co 2005 NVIDIA Corporation.