1 .\" $XdotOrg: xserver/xorg/hw/xfree86/doc/man/Xorg.man.pre,v 1.3 2005/07/04 18:41:01 ajax Exp $
2 .\" shorthand for double quote that works everywhere.
4 .TH Xorg __appmansuffix__ __vendorversion__
14 is a full featured X server that was originally designed for UNIX and
15 UNIX-like operating systems running on Intel x86 hardware. It now runs
16 on a wider range of hardware and OS platforms.
18 This work was derived by the X.Org Foundation from the XFree86 Project's
21 The XFree86 release was originally derived from
23 by Thomas Roell which was contributed to X11R5 by Snitily Graphics
28 operates under a wide range of operating systems and hardware platforms.
29 The Intel x86 (IA32) architecture is the most widely supported hardware
30 platform. Other hardware platforms include Compaq Alpha, Intel IA64, AMD64,
31 SPARC and PowerPC. The most widely supported operating systems are the
32 free/OpenSource UNIX-like systems such as Linux, FreeBSD, NetBSD,
33 OpenBSD, and Solaris. Commercial UNIX operating systems such as
34 UnixWare are also supported. Other supported operating systems include
35 GNU Hurd. Mac OS X is supported with the
36 Xquartz(__appmansuffix__) X server. Win32/Cygwin is supported with the
37 XWin(__appmansuffix__) X server.
39 .SH "NETWORK CONNECTIONS"
41 supports connections made using the following reliable
45 On most platforms, the "Local" connection type is a UNIX-domain socket.
46 On some System V platforms, the "local" connection types also include
47 STREAMS pipes, named pipes, and some other mechanisms.
55 is the display number. This connection type can be disabled with the
57 option (see the Xserver(1) man page for details).
58 .SH "ENVIRONMENT VARIABLES"
59 For operating systems that support local connections other than Unix
60 Domain sockets (SVR3 and SVR4), there is a compiled-in list specifying
61 the order in which local connections should be attempted. This list
62 can be overridden by the
64 environment variable described below. If the display name indicates a
65 best-choice connection should be made (e.g.
67 each connection mechanism is tried until a connection succeeds or no
68 more mechanisms are available. Note: for these OSs, the Unix Domain
69 socket connection is treated differently from the other local connection
70 types. To use it the connection must be made to
75 environment variable should contain a list of one more
76 more of the following:
87 which represent SVR4 Named Streams pipe, Old-style USL Streams pipe,
88 SCO XSight Streams pipe, and ISC Streams pipe, respectively. You can
89 select a single mechanism (e.g.
91 or an ordered list (e.g. \fIXLOCAL="NAMED:PTS:SCO"\fP).
92 his variable overrides the compiled-in defaults. For SVR4 it is
95 be the first preference connection. The default setting is
96 .IR PTS:NAMED:ISC:SCO .
98 To globally override the compiled-in defaults, you should define (and
104 globally. If you use startx(1) or xinit(1), the definition should be
107 file. If you use xdm(1), the definitions should be early on in the
108 .I __projectroot__/lib/X11/xdm/Xsession
112 supports several mechanisms for supplying/obtaining configuration and
113 run-time parameters: command line options, environment variables, the
114 xorg.conf(__filemansuffix__) configuration files, auto-detection, and
115 fallback defaults. When the same information is supplied in more than
116 one way, the highest precedence mechanism is used. The list of mechanisms
117 is ordered from highest precedence to lowest. Note that not all parameters
118 can be supplied via all methods. The available command line options
119 and environment variables (and some defaults) are described here and in
120 the Xserver(__appmansuffix__) manual page. Most configuration file
121 parameters, with their defaults, are described in the
122 xorg.conf(__filemansuffix__) manual page. Driver and module specific
123 configuration parameters are described in the relevant driver or module
126 In addition to the normal server options described in the
127 Xserver(__appmansuffix__) manual page,
129 accepts the following command line switches:
133 specifies the Virtual Terminal device number which
135 will use. Without this option,
137 will pick the first available Virtual Terminal that it can locate. This
138 option applies only to platforms that have virtual terminal support, such
139 as Linux, BSD, OpenSolaris, SVR3, and SVR4.
141 .B \-allowMouseOpenFail
142 Allow the server to start up even if the mouse device can't be opened
143 or initialised. This is equivalent to the
144 .B AllowMouseOpenFail
145 xorg.conf(__filemansuffix__) file option.
147 .B \-allowNonLocalXvidtune
148 Make the VidMode extension available to remote clients. This allows
149 the xvidtune client to connect from another host. This is equivalent
151 .B AllowNonLocalXvidtune
152 xorg.conf(__filemansuffix__) file option. By default non-local
153 connections are not allowed.
155 .BI \-bgamma " value"
156 Set the blue gamma correction.
158 must be between 0.1 and 10.
159 The default is 1.0. Not all drivers support this. See also the
167 No longer supported. Use
169 to set the color depth, and use
171 if you really need to force a non-default framebuffer (hardware) pixel
175 Read the server configuration from
177 This option will work for any file when the server is run as root (i.e,
178 with real-uid 0), or for files relative to a directory in the config
179 search path for all other users.
181 .BI \-configdir " directory"
182 Read the server configuration files from
184 This option will work for any directory when the server is run as root
185 (i.e, with real-uid 0), or for directories relative to a directory in the
186 config directory search path for all other users.
189 When this option is specified, the
191 server loads all video driver modules, probes for available hardware,
192 and writes out an initial xorg.conf(__filemansuffix__) file based on
193 what was detected. This option currently has some problems on some
194 platforms, but in most cases it is a good way to bootstrap the
195 configuration process. This option is only available when the server
196 is run as root (i.e, with real-uid 0).
198 .BI "\-crt /dev/tty" XX
199 SCO only. This is the same as the
201 option, and is provided for compatibility with the native SCO X server.
204 Sets the default color depth. Legal values are 1, 4, 8, 15, 16, and
205 24. Not all drivers support all values.
208 Disable the parts of the VidMode extension (used by the xvidtune
209 client) that can be used to change the video modes. This is equivalent
211 .B DisableVidModeExtension
212 xorg.conf(__filemansuffix__) file option.
215 Sets the number of framebuffer bits per pixel. You should only set this
216 if you're sure it's necessary; normally the server can deduce the correct
219 above. Useful if you want to run a depth 24 configuration with a 24
220 bpp framebuffer rather than the (possibly default) 32 bpp framebuffer
221 (or vice versa). Legal values are 1, 8, 16, 24, 32. Not all drivers
225 Swap the default values for the black and white pixels.
228 Set the gamma correction.
230 must be between 0.1 and 10. The default is 1.0. This value is applied
231 equally to the R, G and B values. Those values can be set independently
237 options. Not all drivers support this.
239 .BI \-ggamma " value"
240 Set the green gamma correction.
242 must be between 0.1 and 10. The default is 1.0. Not all drivers support
253 server checks the ABI revision levels of each module that it loads. It
254 will normally refuse to load modules with ABI revisions that are newer
255 than the server's. This is because such modules might use interfaces
256 that the server does not have. When this option is specified, mismatches
257 like this are downgraded from fatal errors to warnings. This option
258 should be used with care.
260 .B \-isolateDevice \fIbus\-id\fP
261 Restrict device resets to the device at
266 .IB bustype : bus : device : function
267 (e.g., \(oqPCI:1:0:0\(cq).
268 At present, only isolation of PCI devices is supported; i.e., this option
271 is anything other than \(oqPCI\(cq.
274 Prevent the server from detaching its initial controlling terminal.
275 This option is only useful when debugging the server. Not all platforms
276 support (or can use) this option.
278 .BI \-keyboard " keyboard-name"
279 Use the xorg.conf(__filemansuffix__) file
283 as the core keyboard. This option is ignored when the
285 section specifies a core keyboard. In the absence of both a Layout
286 section and this option, the first relevant
288 section is used for the core keyboard.
290 .BI \-layout " layout-name"
291 Use the xorg.conf(__filemansuffix__) file
299 .BI \-logfile " filename"
304 server log file. The default log file is
305 .BI __logdir__/Xorg. n .log
306 on most platforms, where
308 is the display number of the
310 server. The default may be in a different directory on some platforms.
311 This option is only available when the server is run as root (i.e, with
314 .BR \-logverbose " [\fIn\fP]"
315 Sets the verbosity level for information printed to the
317 server log file. If the
319 value isn't supplied, each occurrence of this option increments the log
320 file verbosity level. When the
322 value is supplied, the log file verbosity level is set to that value.
323 The default log file verbosity level is 3.
325 .BI \-modulepath " searchpath"
326 Set the module search path to
329 is a comma separated list of directories to search for
331 server modules. This option is only available when the server is run
332 as root (i.e, with real-uid 0).
335 Disable Silken Mouse support.
338 Disable the automatic switching on X server reset and shutdown to the
339 VT that was active when the server started, if supported by the OS.
342 Set the internal pixmap format for depth 24 pixmaps to 24 bits per pixel.
343 The default is usually 32 bits per pixel. There is normally little
344 reason to use this option. Some client applications don't like this
345 pixmap format, even though it is a perfectly legal format. This is
348 xorg.conf(__filemansuffix__) file option.
351 Set the internal pixmap format for depth 24 pixmaps to 32 bits per pixel.
352 This is usually the default. This is equivalent to the
354 xorg.conf(__filemansuffix__) file option.
356 .BI \-pointer " pointer-name"
357 Use the xorg.conf(__filemansuffix__) file
361 as the core pointer. This option is ignored when the
363 section specifies a core pointer. In the absence of both a Layout
364 section and this option, the first relevant
366 section is used for the core pointer.
369 Suppress most informational messages at startup. The verbosity level
372 .BI \-rgamma " value"
373 Set the red gamma correction.
375 must be between 0.1 and 10. The default is 1.0. Not all drivers support
384 Share virtual terminals with another X server, if supported by the OS.
386 .BI \-screen " screen-name"
387 Use the xorg.conf(__filemansuffix__) file
391 By default the screens referenced by the default
393 section are used, or the first
395 section when there are no
400 This is the same as the
402 option, and is included for compatibility reasons. It may be removed
403 in a future release, so the
405 option should be used instead.
407 .B \-showDefaultModulePath
408 Print out the default module path the server was compiled with.
410 .B \-showDefaultLibPath
411 Print out the path libraries should be installed to.
414 For each driver module installed, print out the list of options and their
418 Set RGB weighting at 16 bpp. The default is 565. This applies only to
419 those drivers which support 16 bpp.
421 .BR \-verbose " [\fIn\fP]"
422 Sets the verbosity level for information printed on stderr. If the
424 value isn't supplied, each occurrence of this option increments the
425 verbosity level. When the
427 value is supplied, the verbosity level is set to that value. The default
428 verbosity level is 0.
431 Print out the server version, patchlevel, release date, the operating
432 system/platform it was built on, and whether it includes module loader
438 server is normally configured to recognize various special combinations
439 of key presses that instruct the server to perform some action, rather
440 than just sending the key press event to a client application. These actions
441 depend on the XKB keymap loaded by a particular keyboard device and may or
442 may not be available on a given configuration.
444 The following key combinations are commonly part of the default XKEYBOARD
447 .B Ctrl+Alt+Backspace
448 Immediately kills the server -- no questions asked. It can be disabled by
451 xorg.conf(__filemansuffix__) file option to a TRUE value.
454 It should be noted that zapping is triggered by the
456 action in the keyboard map. This action is not part of the default keymaps
457 but can be enabled with the XKB option
458 .B \*qterminate:ctrl_alt_bksp\*q.
461 .B Ctrl+Alt+Keypad-Plus
462 Change video mode to next one specified in the configuration file.
463 This can be disabled with the
465 xorg.conf(__filemansuffix__) file option.
467 .B Ctrl+Alt+Keypad-Minus
468 Change video mode to previous one specified in the configuration file.
469 This can be disabled with the
471 xorg.conf(__filemansuffix__) file option.
474 For systems with virtual terminal support, these keystroke
475 combinations are used to switch to virtual terminals 1 through 12,
476 respectively. This can be disabled with the
478 xorg.conf(__filemansuffix__) file option.
481 typically uses a configuration file called
483 and configuration files with the suffix
485 in a directory called
487 for its initial setup.
488 Refer to the xorg.conf(__filemansuffix__) manual page for information
489 about the format of this file.
492 has a mechanism for automatically generating a built-in configuration
497 files are present. The current version of this automatic configuration
498 mechanism works in two ways.
500 The first is via enhancements that have made many components of the
502 file optional. This means that information that can be probed or
503 reasonably deduced doesn't need to be specified explicitly, greatly
504 reducing the amount of built-in configuration information that needs to
505 be generated at run-time.
507 The second is to have "safe" fallbacks for most configuration information.
508 This maximises the likelihood that the
510 server will start up in some usable configuration even when information
511 about the specific hardware is not available.
513 The automatic configuration support for Xorg is work in progress.
514 It is currently aimed at the most popular hardware and software platforms
515 supported by Xorg. Enhancements are planned for future releases.
519 server config files can be found in a range of locations. These are
520 documented fully in the xorg.conf(__filemansuffix__) manual page. The
521 most commonly used locations are shown here.
523 .B /etc/X11/xorg.conf
524 Server configuration file.
526 .B /etc/X11/xorg.conf-4
527 Server configuration file.
530 Server configuration file.
532 .B __projectroot__/etc/xorg.conf
533 Server configuration file.
535 .B __projectroot__/lib/X11/xorg.conf
536 Server configuration file.
538 .B /etc/X11/__xconfigdir__
539 Server configuration directory.
541 .B /etc/X11/__xconfigdir__-4
542 Server configuration directory.
544 .B /etc/__xconfigdir__
545 Server configuration directory.
547 .B __projectroot__/etc/__xconfigdir__
548 Server configuration directory.
550 .B __projectroot__/lib/X11/__xconfigdir__
551 Server configuration directory.
553 .BI __logdir__/Xorg. n .log
554 Server log file for display
557 .B __projectroot__/bin/\(**
560 .B __projectroot__/include/\(**
563 .B __projectroot__/lib/\(**
566 .B __datadir__/fonts/X11/\(**
569 .B __projectroot__/share/X11/XErrorDB
570 Client error message database.
572 .B __projectroot__/lib/X11/app-defaults/\(**
573 Client resource specifications.
575 .B __mandir__/man?/\(**
579 Initial access control list for display
582 X(__miscmansuffix__), Xserver(__appmansuffix__), xdm(__appmansuffix__), xinit(__appmansuffix__),
583 xorg.conf(__filemansuffix__), xvidtune(__appmansuffix__),
584 xkeyboard-config (__miscmansuffix__),
585 apm(__drivermansuffix__),
586 ati(__drivermansuffix__),
587 chips(__drivermansuffix__),
588 cirrus(__drivermansuffix__),
589 cyrix(__drivermansuffix__),
590 fbdev(__drivermansuffix__),
591 glide(__drivermansuffix__),
592 glint(__drivermansuffix__),
593 i128(__drivermansuffix__),
594 i740(__drivermansuffix__),
595 imstt(__drivermansuffix__),
596 intel(__drivermansuffix__),
597 mga(__drivermansuffix__),
598 neomagic(__drivermansuffix__),
599 nsc(__drivermansuffix__),
600 nv(__drivermansuffix__),
601 openchrome (__drivermansuffix__),
602 r128(__drivermansuffix__),
603 rendition(__drivermansuffix__),
604 s3virge(__drivermansuffix__),
605 siliconmotion(__drivermansuffix__),
606 sis(__drivermansuffix__),
607 sunbw2(__drivermansuffix__),
608 suncg14(__drivermansuffix__),
609 suncg3(__drivermansuffix__),
610 suncg6(__drivermansuffix__),
611 sunffb(__drivermansuffix__),
612 sunleo(__drivermansuffix__),
613 suntcx(__drivermansuffix__),
614 tdfx(__drivermansuffix__),
615 tga(__drivermansuffix__),
616 trident(__drivermansuffix__),
617 tseng(__drivermansuffix__),
618 v4l(__drivermansuffix__),
619 vesa(__drivermansuffix__),
620 vmware(__drivermansuffix__),
623 .IR <http://www.x.org> .
626 Xorg has many contributors world wide. The names of most of them
627 can be found in the documentation, ChangeLog files in the source tree,
628 and in the actual source code.
630 Xorg was originally based on XFree86 4.4rc2.
631 That was originally based on \fIX386 1.2\fP by Thomas Roell, which
632 was contributed to the then X Consortium's X11R5 distribution by SGCS.
634 Xorg is released by the X.Org Foundation.
636 The project that became XFree86 was originally founded in 1992 by
637 David Dawes, Glenn Lai, Jim Tsillas and David Wexelblat.
639 XFree86 was later integrated in the then X Consortium's X11R6 release
640 by a group of dedicated XFree86 developers, including the following:
644 Stuart Anderson \fIanderson@metrolink.com\fP
645 Doug Anson \fIdanson@lgc.com\fP
646 Gertjan Akkerman \fIakkerman@dutiba.twi.tudelft.nl\fP
647 Mike Bernson \fImike@mbsun.mlb.org\fP
648 Robin Cutshaw \fIrobin@XFree86.org\fP
649 David Dawes \fIdawes@XFree86.org\fP
650 Marc Evans \fImarc@XFree86.org\fP
651 Pascal Haible \fIhaible@izfm.uni-stuttgart.de\fP
652 Matthieu Herrb \fIMatthieu.Herrb@laas.fr\fP
653 Dirk Hohndel \fIhohndel@XFree86.org\fP
654 David Holland \fIdavidh@use.com\fP
655 Alan Hourihane \fIalanh@fairlite.demon.co.uk\fP
656 Jeffrey Hsu \fIhsu@soda.berkeley.edu\fP
657 Glenn Lai \fIglenn@cs.utexas.edu\fP
658 Ted Lemon \fImellon@ncd.com\fP
659 Rich Murphey \fIrich@XFree86.org\fP
660 Hans Nasten \fInasten@everyware.se\fP
661 Mark Snitily \fImark@sgcs.com\fP
662 Randy Terbush \fIrandyt@cse.unl.edu\fP
663 Jon Tombs \fItombs@XFree86.org\fP
664 Kees Verstoep \fIversto@cs.vu.nl\fP
665 Paul Vixie \fIpaul@vix.com\fP
666 Mark Weaver \fIMark_Weaver@brown.edu\fP
667 David Wexelblat \fIdwex@XFree86.org\fP
668 Philip Wheatley \fIPhilip.Wheatley@ColumbiaSC.NCR.COM\fP
669 Thomas Wolfram \fIwolf@prz.tu-berlin.de\fP
670 Orest Zborowski \fIorestz@eskimo.com\fP
674 Xorg source is available from the FTP server
675 \fI<ftp://ftp.x.org/>\fP, and from the X.Org
676 server \fI<http://gitweb.freedesktop.org/>\fP. Documentation and other
677 information can be found from the X.Org web site
678 \fI<http://www.x.org/>\fP.
683 is copyright software, provided under licenses that permit modification
684 and redistribution in source and binary form without fee.
685 .B Xorg is copyright by numerous authors and
686 contributors from around the world. Licensing information can be found
688 .IR <http://www.x.org> .
689 Refer to the source code for specific copyright notices.
692 is a trademark of The XFree86 Project, Inc.
696 .B X Window System(TM)
697 are trademarks of The Open Group.