2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH FBCONF_XORG 1M "Jan 26, 2009"
8 fbconf_xorg \- configure frame buffer devices for Xorg
12 \fB/usr/lib/fbconfig/fbconf_xorg\fR [\fB-dev\fR \fIdevice-file\fR]
13 [\fB-file\fR machine | system | \fIconfig-path\fR]
14 [\fB-res\fR \fIvideo-mode\fR [nocheck | noconfirm]]
15 [\fIdevice-specific-options\fR]
16 [\fB-defaults\fR] [\fB-prconf\fR] [\fB-predid\fR [raw] [parsed]] [\fB-propt\fR]
21 \fB/usr/lib/fbconfig/fbconf_xorg\fR [\fB-dev\fR \fIdevice-file\fR] [\fB-prconf\fR] [\fB-propt\fR]
26 \fB/usr/lib/fbconfig/fbconf_xorg\fR [\fB-dev\fR \fIdevice-file\fR] [\fB-help\fR] [\fB-res\fR ?]
31 For \fBkfb\fR devices:
36 \fB/usr/lib/fbconfig/fbconf_xorg\fR [\fB-dev\fR \fIdevice-file\fR]
37 [\fB-file\fR machine | system | \fIconfig-path\fR]
38 [\fB-res\fR \fIvideo-mode\fR [nocheck | noconfirm]]
39 [\fB-deflinear\fR true | false] [\fB-defoverlay\fR true | false]
40 [\fB-deftransparent\fR true | false]
41 [\fB-doublehigh\fR enable | disable]
42 [\fB-g\fR \fIgamma-correction-value\fR]
43 [\fB-multisample\fR available | disable | forceon]
44 [-\fBoffset\fR \fIx-val\fR \fIy-val\fR] [\fB-samples\fR 1 | 2 | 4 | 8 | 16 ]
45 [\fB-slave\fR disable | multiview] [\fB-stereo\fR true | false]
46 [\fB-defaults\fR] [\fB-prconf\fR] [\fB-predid\fR [raw] [parsed]] [\fB-propt\fR]
52 The \fBfbconf_xorg\fR utility configures Frame Buffer devices and some of the
53 X11 window system defaults for Xorg by updating the \fBxorg.conf\fR
57 The first \fBfbconf_xorg\fR command form shown in the \fBSYNOPSIS\fR section
58 stores the specified option values in the \fBxorg.conf\fR configuration file.
59 These settings are used to initialize the frame buffer device the next time the
60 window system is run on that device. The persistence of these settings across
61 window system sessions and system reboots is determined by the \fBxorg.conf\fR
65 The second and third command forms display information, and do not alter the
66 \fBxorg.conf\fR file. The presence of the \fB-help\fR and/or \fB-res\fR \fB?\fR
67 options will cause any other option (not shown in the third form) to be
71 You can configure only one frame buffer device at a time. To configure multiple
72 devices, invoke the \fBfbconf_xorg\fR utility separately for each device.
75 Only frame buffer device options can be specified with \fBfbconf_xorg\fR. Use
76 the normal window system options to specify default depth (see
77 \fBsvccfg\fR(1M)), default visual class, and so forth. Specify these as device
78 modifiers on the command line. See\fI Xserver(1)\fR, part of the OpenWindows,
79 not the SunOS, man page collection.
82 You can specify which \fBxorg.conf\fR file to open. By default,
83 \fBfbconf_xorg\fR opens the machine-specific file, \fB/etc/X11/xorg.conf\fR.
84 Use the \fB-file\fR option to specify an alternate file. For example, the
85 system-global file, \fB/usr/X11/xorg.conf\fR, can be opened instead.
88 These standard \fBxorg.conf\fR files can be written only by the superuser or
89 someone with the Primary Administrator role. Consequently, the
90 \fBfbconf_xorg\fR program is run with setuid root permission.
94 The following options are supported for all frame buffer devices:
102 Sets configuration options for the specified device to their default values.
103 This does not affect the \fB-res\fR video mode setting. See the device-specific
104 portions of the \fBDEFAULTS\fR section below.
110 \fB\fB-dev\fR \fIdevice-file\fR\fR
114 Specifies the frame buffer device by either its full pathname or simple
115 filename (for example, \fB/dev/fbs/kfb0\fR or \fBkfb0\fR). Pathnames of
116 installed devices can be displayed using the \fB-list\fR option to
117 \fBfbconfig\fR(1M). If the \fB-dev\fR option is omitted, the default device,
118 \fB/dev/fb\fR, is used.
124 \fB\fB-file\fR \fBmachine\fR | \fBsystem\fR | \fIconfig-path\fR\fR
128 Specifies which \fBxorg.conf\fR file to open. If \fBmachine\fR is specified,
129 the machine-specific \fB/etc/X11/xorg.conf\fR file is opened. If system is
130 specified, the global \fB/usr/X11/xorg.conf\fR file is opened. The absolute
131 pathname of a configuration file can be used instead. If the specified file
132 does not exist and is to be updated, it will be created. The file system that
133 will contain the \fBxorg.conf\fR file must be writeable by someone with
134 superuser-like privileges. This option has no effect unless other options are
135 specified. The default is \fBmachine\fR.
145 Display the \fBfbconf_xorg\fR command line options that are supported in
146 conjunction with the frame buffer device, along with a brief explanation of
147 each option. The frame buffer device can be specified using the \fB-dev\fR
158 Display the current configuration for the frame buffer device and attached
159 display device(s). The frame buffer device can be specified using the
162 The \fB-prconf\fR output might resemble:
166 Monitor/Resolution Information:
167 Monitor manufacturer: SUN
169 Serial Number: 12212555
170 Manufacture date: 2000, week 9
172 Monitor dimensions: 36x29 cm
174 Monitor preferred resolution: SUNW_STD_1280x1024x60
175 Monitor supported resolutions from EDID: SUNW_STD_1280x1024x60,
176 SUNW_STD_1280x1024x76, 1152x900x66, VESA_STD_1280x1024x75,
177 VESA_STD_1280x1024x60, SUNW_STD_1152x900x66,
178 VESA_STD_720x400x70, VESA_STD_640x480x60,
179 VESA_STD_640x480x67, VESA_STD_640x480x72,
180 VESA_STD_640x480x75, VESA_STD_800x600x56,
181 VESA_STD_800x600x60, VESA_STD_800x600x72,
182 VESA_STD_800x600x75, VESA_STD_832x624x75,
183 VESA_STD_1024x768x60, VESA_STD_1024x768x70, 1024x768x75
184 Current resolution setting: FALLBACK_1152x900x66
186 Framelock Configuration:
197 \fB\fB-predid\fR [\fBraw\fR] [\fBparsed\fR]\fR
201 Display the E-EDID (Enhanced Extended Display Identification Data) information
202 obtained from the display device(s), which must be online, connected to the
203 frame buffer. The frame buffer device can be specified using the \fB-dev\fR
204 option. The output will be raw hexadecimal and/or human-readable (parsed) text.
205 The default is parsed.
207 The \fB-predid\fR raw output might resemble:
211 --- EDID Data for /dev/fbs/kfb0 ---
213 Block 0: EDID Base Block
214 0x00: 00 FF FF FF FF FF FF 00 04 43 06 F2 01 00 00 00
215 0x10: 01 11 01 04 0F 2B 20 78 2B 9C 68 A0 57 4A 9B 26
216 0x20: 12 48 4C FF FF 80 A9 59 A9 4F A9 4A A9 45 81 99
217 0x30: 81 80 61 59 45 59 48 3F 40 30 62 B0 32 40 40 C0
218 0x40: 13 00 AB 40 11 00 00 1E 00 00 00 FD 00 32 5A 1E
219 0x50: 6E 17 04 11 00 C8 90 00 50 3C 00 00 00 F7 00 0A
220 0x60: F7 0F 03 87 C0 00 00 00 00 00 00 00 00 00 00 FC
221 0x70: 00 41 42 43 20 4C 43 44 32 31 0A 20 20 20 00 0B
235 Display all option settings for the frame buffer device, either as they
236 currently are or as they will be represented in the \fBxorg.conf\fR
237 configuration file when \fBfbconf_xorg\fR completes. The device can be
238 specified using the \fB-dev\fR option, and the file using the \fB-file\fR
241 The \fB-propt\fR output might resemble:
245 --- Graphics Configuration for /dev/fbs/kfb0 ---
247 xorg.conf: machine -- /etc/X11/xorg.conf
248 Screen section: "kfb0"
249 Device section: "kfb0"
250 Monitor section: "kfb0"
252 Video Mode: SUNW_STD_1280x1024x76
255 Multisample Information:
256 Multisample Mode: Disable
262 Offset/Overlap: [0, 0]
265 Default Visual: Non-Linear Normal Visual
266 Gamma Correction Value: Using gamma value 2.22
276 \fB\fB-res\fR \fB?\fR\fR
280 Display a list of video modes that can be used with the \fB-res\fR
281 \fIvideo-mode\fR option.
283 The \fB?\fR argument may need to be escaped or placed in quotes (\e?, "?",
284 or '?'), to protect it from misinterpretation by the shell.
286 The \fB-res\fR \fB?\fR output might resemble:
290 Video modes accepted by the -res option:
293 SUNW_STD_1920x1200x75
294 SUNW_STD_1920x1200x70
295 SUNW_DIG_1920x1200x60
296 SUNW_STD_1920x1080x72
297 SUNW_DIG_1920x1080x60
300 VESA_STD_640x480x75 [1]
301 VESA_STD_640x480x72 [1]
302 VESA_STD_640x480x60 [1]
304 [1] Resolution is supported by monitor
305 [2] Preferred resolution for monitor
310 Abbreviations such as "\fB1280x1024x75\fR" might also be used.
316 \fB\fB-res\fR \fIvideo-mode\fR [\fBnocheck\fR | \fBnoconfirm\fR]\fR
320 Set the video mode for the display device that is connected to the frame buffer
323 A list of video modes can be displayed using the \fB-res\fR \fB?\fR option.
325 The basic format of a video-mode is \fIwidth\fRx\fIheight\fRx\fIrate\fR, where:
330 \fIwidth\fR is the screen width in pixels.
336 \fIheight\fR is the screen height in pixels.
342 \fIrate\fR is the vertical frequency of the screen refresh.
344 A video-mode argument may have an \fB@\fR (at sign) instead of \fBx\fR
345 preceding the refresh rate. For instance, \fB1280x1024x76\fR and
346 \fB1280x1024@76\fR are equivalent.
348 A video-mode name may carry additional information, as with
349 \fBSUNW_STD_1280x1024x76\fR.
351 The \fB-res\fR argument, \fBauto\fR, represents the video mode that is
352 currently programmed into the device. The argument, \fBnone\fR, is a synonym
355 Note that some video modes might be inappropriate for certain frame buffer
356 devices and/or display devices.
358 The \fB-res\fR option accepts suboption keywords following the video-mode
367 The \fBnocheck\fR suboption causes the video-mode argument to be accepted,
368 regardless of whether it is supported by the currently attached monitor,
369 whether it is known within the current configuration, and so forth. Note that
370 using an unchecked, inappropriate video mode can leave the system without
371 usable video output. This suboption is useful if a different monitor is to be
372 connected to the frame buffer device. This suboption also implies
379 \fB\fBnoconfirm\fR\fR
383 If the video-mode argument is unable to be validated, the default action is to
384 display a warning message and ask the user whether to continue. The
385 \fBnoconfirm\fR suboption suppresses this confirmation request. This suboption
386 is useful when \fBfbconf_xorg\fR is being run from a shell script.
393 The following device-specific options are supported for certain frame buffer
394 devices. Unless specified otherwise, these options do not take effect until the
395 user logs out and back in.
399 \fB\fB-deflinear\fR \fBtrue\fR | \fBfalse\fR\fR
403 This option selects the default X visual. Two types of visuals are supported,
404 linear and nonlinear. Linear visuals are gamma corrected. Nonlinear visuals are
407 If the value of this option is \fBtrue\fR, the default visual is set to default
408 depth 24 and the default class is \fBTrueColor\fR with gamma correction
409 enabled. If \fBfalse\fR, a nonlinear visual that satisfies the other default
410 visual selection options, such as the default depth and default class, is
411 chosen as the default visual.
413 The \fB-deflinear\fR, \fB-defoverlay\fR, and \fB-deftransparent\fR options each
414 select the default X visual. Only one of these may be enabled at a time.
415 Enabling one causes the others to be disabled.
421 \fB\fB-defoverlay\fR \fBtrue\fR | \fBfalse\fR\fR
425 This option selects the default X visual. The \fBkfb\fR device provides an
426 8-bit PseudoColor visual whose pixels are disjoint from the rest of the
427 visuals. This is called the overlay visual. Windows created in this visual will
428 not damage windows created in other visuals. The converse, however, is not
429 true: Windows created in other visuals will damage overlay windows.
431 If the value of this option is \fBtrue\fR, the overlay visual is the default
432 visual. The default depth is 8-bit and the default class is PseudoColor. If
433 \fBfalse\fR, the non-overlay visual that satisfies the other default visual
434 selection options, such as the default depth and the default class, is chosen
435 as the default visual.
437 The \fB-deflinear\fR, \fB-defoverlay\fR, and \fB-deftransparent\fR options each
438 select the default X visual. Only one of these may be enabled at a time.
439 Enabling one causes the others to be disabled.
445 \fB\fB-deftransparent\fR \fBtrue\fR | \fBfalse\fR\fR
449 This option selects the default X visual. The \fBkfb\fR device provides an
450 8-bit PseudoColor visual whose pixels are disjoint from the rest of the
451 visuals. This is called the overlay visual. Windows created in this visual will
452 not damage windows created in other visuals.
454 If the value of this option is \fBtrue\fR, the overlay visual used as the
455 default is a transparent overlay visual. A visual with transparency supports a
456 colormap with 255 colors and one transparent pixel. The default depth is 8-bit
457 and the default class is PseudoColor. If \fBfalse\fR, the nonoverlay visual
458 that satisfies the other default visual selection options, such as the default
459 depth and the default class, is chosen as the default visual.
461 The \fB-deflinear\fR, \fB-defoverlay\fR, and \fB-deftransparent\fR options each
462 select the default X visual. Only one of these may be enabled at a time.
463 Enabling one causes the others to be disabled.
469 \fB\fB-doublehigh\fR \fBenable\fR | \fBdisable\fR\fR
473 Configures the two outputs of the frame buffer device into one vertical virtual
474 display. The default is \fBdisable\fR. The \fB-doublewide\fR and
475 \fB-doublehigh\fR options are mutually exclusive. Enabling one causes the other
482 \fB\fB-doublewide\fR \fBenable\fR | \fBdisable\fR\fR
486 Configures the two outputs of the frame buffer device into one horizontal
487 virtual display. The default is \fBdisable\fR. The \fB-doublewide\fR and
488 \fB-doublehigh\fR options are mutually exclusive. Enabling one causes the other
495 \fB\fB-g\fR \fIgamma-correction-value\fR\fR
499 Sets the gamma correction value. All linear visuals provide gamma correction.
500 The gamma correction value should be in the range, \fB0.1\fR to \fB10.0\fR. The
501 default is \fB2.22\fR. This option can be used while the window system is
502 running. Changing the gamma correction value affects all of the windows
503 displayed by linear visuals.
509 \fB\fB-gfile\fR \fIgamma-correction-file\fR\fR
513 Loads the gamma correction table from the file specified by
514 \fIgamma-correction-file\fR. This text file specifies the gamma correction
515 values for the R, G, and B channels. Three consecutive values form an RGB
516 triplet. For a \fBkfb\fR device, there must be exactly 256 RGB triplets. A
517 value may be represented in hexadecimal, decimal, or octal format (for example,
518 \fB0x3FF\fR, \fB1023\fR, or \fB01777\fR, respectively). Values are separated by
519 one or more whitespace or new line characters. Comments begin with a hash sign
520 character (\fB#\fR) and end at the end of the line.
522 You can load the gamma correction table with this option while the window
523 system is running. The new gamma correction affects all the windows being
524 displayed using the linear visuals. When gamma correction is done using a
525 user-specified table, the gamma correction value (\fB-g\fR) is undefined. By
526 default, the window system assumes a gamma correction value of \fB2.22\fR and
527 loads the gamma table it creates corresponding to this value.
529 The following is an example of a \fIgamma-correction-file\fR file:
533 # Gamma Correction Table
549 \fB\fB-multisample\fR \fBavailable\fR | \fBdisable\fR | \fBforceon\fR\fR
553 If set to disable, no multisample is possible. If set to available, multisample
554 is possible but is selected on a per-window basis using a library interface. If
555 set to \fBforceon\fR, all Sun OpenGL windows are rendered using multisampling.
556 To query the number of samples used, specify the \fB-propt\fR option or run the
557 \fBxglinfo\fR utility. The \fBxglinfo\fR utility can return the number of
558 multisamples if \fB-multisample\fR is set to available. The default is
559 \fBdisable\fR. \fBxglinfo\fR is described in the \fBxglinfo(1)\fR man page, in
560 the Sun OpenGL man page collection.
566 \fB\fB-offset\fR \fIx-val\fR \fIy-val\fR\fR
570 Adjusts the position of the specified stream by the value specified. This
571 option is only implemented in \fB-doublewide\fR and \fB-doublehigh\fR modes.
572 For \fB-doublewide\fR, use the \fIx-val\fR to position the rightmost stream.
573 Negative is left (overlaps with the left stream). For \fB-doublehigh\fR, use
574 the \fIy-val\fR to position the bottom stream. Negative is up (overlaps with
575 top stream). The default is \fB[0,0]\fR.
581 \fB\fB-samples\fR \fB1\fR | \fB2\fR | \fB4\fR | \fB8\fR | \fB16\fR\fR
585 Requests the number of samples to compute per display pixel. The requested
586 number of samples per pixel is used if \fB-multisample\fR is not disabled and
587 resources exist for the request. To query the number of samples used, specify
588 the \fB-propt\fR option or run the \fBxglinfo\fR utility. The \fBxglinfo\fR
589 utility can return the number of multisamples after you specify the option
590 \fB-multisample\fR available. The default is \fB4\fR.
596 \fB\fB-slave\fR \fBdisable\fR | \fBmultiview\fR\fR
600 If you set the \fBmultiview\fR argument for the \fB-slave\fR option, the device
601 synchronizes video with a master through the multiview genlock ribbon cable.
602 The system should be powered off whenever connecting or disconnecting this
603 cable. Both devices should be running the same resolution and the option should
604 be issued when the window system is running. The default is \fBdisable\fR.
610 Certain options have implied default arguments. The default argument is used
611 when the option is not present on the \fBfbconf_xorg\fR command line. For
612 instance, a default argument for \fB-dev\fR is \fB/dev/fb\fR.
615 Options that set configuration state do not have implied defaults. The
616 \fB-res\fR option is one example. If a configuration option is omitted from the
617 \fBfbconf_xorg\fR command line, the corresponding \fBxorg.conf\fR configuration
618 setting will remain unchanged. The exception is that if configuration options
619 are mutually exclusive, setting one will automatically unset each of the
620 others. An example is \fB-deflinear\fR, \fB-defoverlay\fR, and
621 \fB-deftransparent\fR.
624 If a configuration setting is not present in the configura tion file when the
625 window system is run, a default value will be used. For instance, the default
626 state associated with \fB-res\fR is \fBauto\fR. A setting might not be present
627 in the file, or the file itself might not exist, until \fBfbconf_xorg\fR has
628 been invoked with the corresponding command line option.
631 The \fB-defaults\fR option sets the default values for most configuration
635 Options and their defaults are shown below.
638 Device-independent defaults:
642 Option Default Argument
654 \fBkfb\fR-specific defaults:
658 Option Default State or -defaults Value
661 -deftransparent false
676 \fBExample 1 \fRSwitching the Resolution of the Monitor Type
679 The following example sets the video mode for the monitor on the
680 \fB/dev/fbs/kfb0\fR device to 1280 x 1024 at 76 Hz:
685 example% \fBfbconf_xorg -dev kfb0 -res 1280x1024x76\fR
693 The following exit values are returned:
701 Execution completed successfully.
711 Invalid command line usage.
732 Symbolic link to the default frame buffer device.
738 \fB\fB/dev/fbs/kfb\fIn\fR\fR\fR
742 Device special file for a \fBkfb\fR frame buffer
748 \fB\fB/usr/lib/fbconfig/SunModes_xorg.conf\fR\fR
752 Video mode definitions included in new configuration files.
758 See \fBattributes\fR(5) for descriptions of the following attributes:
766 ATTRIBUTE TYPE ATTRIBUTE VALUE
768 Interface Stability Uncommitted
774 \fBfbconfig\fR(1M), \fBsvccfg\fR(1M), \fBattributes\fR(5), \fBkfb\fR(7D),
778 See the \fIXorg(1)\fR and \fIXserver(1)\fR man pages in the X Server man page
779 collection and the \fIxglinfo(1)\fR man page in the Sun OpenGL man page