Xorg.man (19798B)
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. 3 .ds q \N'34' 4 .TH Xorg @appmansuffix@ @vendorversion@ 5 .SH NAME 6 Xorg - X11R7 X server 7 .SH SYNOPSIS 8 .B Xorg 9 .RI [\fB:\fP display ] 10 .RI [ option 11 .IR ... ] 12 .SH DESCRIPTION 13 .B Xorg 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. 17 .PP 18 This work was derived by the X.Org Foundation from the XFree86 Project's 19 .I "XFree86\ 4.4rc2" 20 release. 21 The XFree86 release was originally derived from 22 .I "X386\ 1.2" 23 by Thomas Roell which was contributed to X11R5 by Snitily Graphics 24 Consulting Service. 25 .SH PLATFORMS 26 .PP 27 .B Xorg 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. 38 .PP 39 .SH "NETWORK CONNECTIONS" 40 .B Xorg 41 supports connections made using the following reliable 42 byte-streams: 43 .TP 4 44 .I "Local" 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. See the 48 "LOCAL CONNECTIONS" section of X(@miscmansuffix@) for details. 49 .TP 4 50 .I TCP/IP 51 .B Xorg 52 listens on port 53 .RI 6000+ n , 54 where 55 .I n 56 is the display number. This connection type is usually disabled by default, 57 but may be enabled with the 58 .B \-listen 59 option (see the Xserver(1) man page for details). 60 .SH OPTIONS 61 .B Xorg 62 supports several mechanisms for supplying/obtaining configuration and 63 run-time parameters: command line options, environment variables, the 64 xorg.conf(@filemansuffix@) configuration files, auto-detection, and 65 fallback defaults. When the same information is supplied in more than 66 one way, the highest precedence mechanism is used. The list of mechanisms 67 is ordered from highest precedence to lowest. Note that not all parameters 68 can be supplied via all methods. The available command line options 69 and environment variables (and some defaults) are described here and in 70 the Xserver(@appmansuffix@) manual page. Most configuration file 71 parameters, with their defaults, are described in the 72 xorg.conf(@filemansuffix@) manual page. Driver and module specific 73 configuration parameters are described in the relevant driver or module 74 manual page. 75 .PP 76 In addition to the normal server options described in the 77 Xserver(@appmansuffix@) manual page, 78 .B Xorg 79 accepts the following command line switches: 80 .TP 8 81 .BI vt XX 82 .I XX 83 specifies the Virtual Terminal device number which 84 .B Xorg 85 will use. Without this option, 86 .B Xorg 87 will pick the first available Virtual Terminal that it can locate. This 88 option applies only to platforms that have virtual terminal support, such 89 as Linux, BSD, OpenSolaris, SVR3, and SVR4. 90 .TP 91 .B \-allowMouseOpenFail 92 Allow the server to start up even if the mouse device can't be opened 93 or initialised. This is equivalent to the 94 .B AllowMouseOpenFail 95 xorg.conf(@filemansuffix@) file option. 96 .TP 8 97 .B \-allowNonLocalXvidtune 98 Make the VidMode extension available to remote clients. This allows 99 the xvidtune client to connect from another host. This is equivalent 100 to the 101 .B AllowNonLocalXvidtune 102 xorg.conf(@filemansuffix@) file option. By default non-local 103 connections are not allowed. 104 .TP 8 105 .BI \-bgamma " value" 106 Set the blue gamma correction. 107 .I value 108 must be between 0.1 and 10. 109 The default is 1.0. Not all drivers support this. See also the 110 .BR \-gamma , 111 .BR \-rgamma , 112 and 113 .B \-ggamma 114 options. 115 .TP 8 116 .BI \-bpp " n" 117 No longer supported. Use 118 .B \-depth 119 to set the color depth, and use 120 .B \-fbbpp 121 if you really need to force a non-default framebuffer (hardware) pixel 122 format. 123 .TP 8 124 .BI \-config " file" 125 Read the server configuration from 126 .IR file . 127 This option will work for any file when the server is run as root (i.e, 128 with real-uid 0), or for files relative to a directory in the config 129 search path for all other users. 130 .TP 8 131 .BI \-configdir " directory" 132 Read the server configuration files from 133 .IR directory . 134 This option will work for any directory when the server is run as root 135 (i.e, with real-uid 0), or for directories relative to a directory in the 136 config directory search path for all other users. 137 .TP 8 138 .B \-configure 139 When this option is specified, the 140 .B Xorg 141 server loads all video driver modules, probes for available hardware, 142 and writes out an initial xorg.conf(@filemansuffix@) file based on 143 what was detected. This option currently has some problems on some 144 platforms, but in most cases it is a good way to bootstrap the 145 configuration process. This option is only available when the server 146 is run as root (i.e, with real-uid 0). 147 .TP 8 148 .BI "\-crt /dev/tty" XX 149 SCO only. This is the same as the 150 .B vt 151 option, and is provided for compatibility with the native SCO X server. 152 .TP 8 153 .BI \-depth " n" 154 Sets the default color depth. Legal values are 1, 4, 8, 15, 16, and 155 24. Not all drivers support all values. 156 .TP 8 157 .B \-disableVidMode 158 Disable the parts of the VidMode extension (used by the xvidtune 159 client) that can be used to change the video modes. This is equivalent 160 to the 161 .B DisableVidModeExtension 162 xorg.conf(@filemansuffix@) file option. 163 .TP 8 164 .B \-fbbpp \fIn\fP 165 Sets the number of framebuffer bits per pixel. You should only set this 166 if you're sure it's necessary; normally the server can deduce the correct 167 value from 168 .B \-depth 169 above. Useful if you want to run a depth 24 configuration with a 24 170 bpp framebuffer rather than the (possibly default) 32 bpp framebuffer 171 (or vice versa). Legal values are 1, 8, 16, 24, 32. Not all drivers 172 support all values. 173 .TP 8 174 .BI \-gamma " value" 175 Set the gamma correction. 176 .I value 177 must be between 0.1 and 10. The default is 1.0. This value is applied 178 equally to the R, G and B values. Those values can be set independently 179 with the 180 .BR \-rgamma , 181 .BR \-bgamma , 182 and 183 .B \-ggamma 184 options. Not all drivers support this. 185 .TP 8 186 .BI \-ggamma " value" 187 Set the green gamma correction. 188 .I value 189 must be between 0.1 and 10. The default is 1.0. Not all drivers support 190 this. See also the 191 .BR \-gamma , 192 .BR \-rgamma , 193 and 194 .B \-bgamma 195 options. 196 .TP 8 197 .B \-ignoreABI 198 The 199 .B Xorg 200 server checks the ABI revision levels of each module that it loads. It 201 will normally refuse to load modules with ABI revisions that are newer 202 than the server's. This is because such modules might use interfaces 203 that the server does not have. When this option is specified, mismatches 204 like this are downgraded from fatal errors to warnings. This option 205 should be used with care. 206 .TP 8 207 .B \-isolateDevice \fIbus\-id\fP 208 Restrict device resets to the device at 209 .IR bus\-id . 210 The 211 .I bus\-id 212 string has the form 213 .IB bustype : bus : device : function 214 (e.g., \(oqPCI:1:0:0\(cq). 215 At present, only isolation of PCI devices is supported; i.e., this option 216 is ignored if 217 .I bustype 218 is anything other than \(oqPCI\(cq. 219 .TP 8 220 .B \-keeptty 221 Prevent the server from detaching its initial controlling terminal. If you 222 want to use systemd-logind integration you must specify this option. 223 Not all platforms support (or can use) this option. 224 .TP 8 225 .BI \-keyboard " keyboard-name" 226 Use the xorg.conf(@filemansuffix@) file 227 .B InputDevice 228 section called 229 .I keyboard-name 230 as the core keyboard. This option is ignored when the 231 .B Layout 232 section specifies a core keyboard. In the absence of both a Layout 233 section and this option, the first relevant 234 .B InputDevice 235 section is used for the core keyboard. 236 .TP 8 237 .BI \-layout " layout-name" 238 Use the xorg.conf(@filemansuffix@) file 239 .B Layout 240 section called 241 .IR layout-name . 242 By default the first 243 .B Layout 244 section is used. 245 .TP 8 246 .BI \-logfile " filename" 247 Use the file called 248 .I filename 249 as the 250 .B Xorg 251 server log file. The default log file when running as root is 252 .BI @logdir@/Xorg. n .log 253 and for non root it is 254 .BI $XDG_DATA_HOME/xorg/Xorg. n .log 255 where 256 .I n 257 is the display number of the 258 .B Xorg 259 server. The default may be in a different directory on some platforms. 260 This option is only available when the server is run as root (i.e, with 261 real-uid 0). 262 .TP 8 263 .BR \-logverbose " [\fIn\fP]" 264 Sets the verbosity level for information printed to the 265 .B Xorg 266 server log file. If the 267 .I n 268 value isn't supplied, each occurrence of this option increments the log 269 file verbosity level. When the 270 .I n 271 value is supplied, the log file verbosity level is set to that value. 272 The default log file verbosity level is 3. 273 .TP 8 274 .BI \-modulepath " searchpath" 275 Set the module search path to 276 .IR searchpath . 277 .I searchpath 278 is a comma separated list of directories to search for 279 .B Xorg 280 server modules. This option is only available when the server is run 281 as root (i.e, with real-uid 0). 282 .TP 8 283 .B \-noautoBindGPU 284 Disable automatically setting secondary GPUs up as output sinks and offload 285 sources. This is equivalent to setting the 286 .B AutoBindGPU 287 xorg.conf(__filemansuffix__) file option. To 288 .B false. 289 .TP 8 290 .B \-nosilk 291 Disable Silken Mouse support. 292 .TP 8 293 .B \-novtswitch 294 Disable the automatic switching on X server reset and shutdown to the 295 VT that was active when the server started, if supported by the OS. 296 .TP 8 297 .BI \-pointer " pointer-name" 298 Use the xorg.conf(@filemansuffix@) file 299 .B InputDevice 300 section called 301 .I pointer-name 302 as the core pointer. This option is ignored when the 303 .B Layout 304 section specifies a core pointer. In the absence of both a Layout 305 section and this option, the first relevant 306 .B InputDevice 307 section is used for the core pointer. 308 .TP 8 309 .B \-quiet 310 Suppress most informational messages at startup. The verbosity level 311 is set to zero. 312 .TP 8 313 .BI \-rgamma " value" 314 Set the red gamma correction. 315 .I value 316 must be between 0.1 and 10. The default is 1.0. Not all drivers support 317 this. See also the 318 .BR \-gamma , 319 .BR \-bgamma , 320 and 321 .B \-ggamma 322 options. 323 .TP 8 324 .B \-sharevts 325 Share virtual terminals with another X server, if supported by the OS. 326 .TP 8 327 .BI \-screen " screen-name" 328 Use the xorg.conf(@filemansuffix@) file 329 .B Screen 330 section called 331 .IR screen-name . 332 By default the screens referenced by the default 333 .B Layout 334 section are used, or the first 335 .B Screen 336 section when there are no 337 .B Layout 338 sections. 339 .TP 8 340 .B \-showconfig 341 This is the same as the 342 .B \-version 343 option, and is included for compatibility reasons. It may be removed 344 in a future release, so the 345 .B \-version 346 option should be used instead. 347 .TP 8 348 .B \-showDefaultModulePath 349 Print out the default module path the server was compiled with. 350 .TP 8 351 .B \-showDefaultLibPath 352 Print out the path libraries should be installed to. 353 .TP 8 354 .B \-showopts 355 For each driver module installed, print out the list of options and their 356 argument types. 357 .TP 8 358 .BI \-weight " nnn" 359 Set RGB weighting at 16 bpp. The default is 565. This applies only to 360 those drivers which support 16 bpp. 361 .TP 8 362 .BR \-verbose " [\fIn\fP]" 363 Sets the verbosity level for information printed on stderr. If the 364 .I n 365 value isn't supplied, each occurrence of this option increments the 366 verbosity level. When the 367 .I n 368 value is supplied, the verbosity level is set to that value. The default 369 verbosity level is 0. 370 .TP 8 371 .B \-version 372 Print out the server version, patchlevel, release date, the operating 373 system/platform it was built on, and whether it includes module loader 374 support. 375 .SH "KEYBOARD" 376 .PP 377 The 378 .B Xorg 379 server is normally configured to recognize various special combinations 380 of key presses that instruct the server to perform some action, rather 381 than just sending the key press event to a client application. These actions 382 depend on the XKB keymap loaded by a particular keyboard device and may or 383 may not be available on a given configuration. 384 .PP 385 The following key combinations are commonly part of the default XKEYBOARD 386 keymap. 387 .TP 8 388 .B Ctrl+Alt+Backspace 389 Immediately kills the server -- no questions asked. It can be disabled by 390 setting the 391 .B DontZap 392 xorg.conf(@filemansuffix@) file option to a TRUE value. 393 .PP 394 .RS 8 395 It should be noted that zapping is triggered by the 396 .B Terminate_Server 397 action in the keyboard map. This action is not part of the default keymaps 398 but can be enabled with the XKB option 399 .B \*qterminate:ctrl_alt_bksp\*q. 400 .RE 401 .TP 8 402 .B Ctrl+Alt+Keypad-Plus 403 Change video mode to next one specified in the configuration file. 404 This can be disabled with the 405 .B DontZoom 406 xorg.conf(@filemansuffix@) file option. 407 .TP 8 408 .B Ctrl+Alt+Keypad-Minus 409 Change video mode to previous one specified in the configuration file. 410 This can be disabled with the 411 .B DontZoom 412 xorg.conf(@filemansuffix@) file option. 413 .TP 8 414 .B Ctrl+Alt+F1...F12 415 For systems with virtual terminal support, these keystroke 416 combinations are used to switch to virtual terminals 1 through 12, 417 respectively. This can be disabled with the 418 .B DontVTSwitch 419 xorg.conf(@filemansuffix@) file option. 420 .SH CONFIGURATION 421 .B Xorg 422 typically uses a configuration file called 423 .B xorg.conf 424 and configuration files with the suffix 425 .I .conf 426 in a directory called 427 .B @xconfigdir@ 428 for its initial setup. 429 Refer to the xorg.conf(@filemansuffix@) manual page for information 430 about the format of this file. 431 .PP 432 .B Xorg 433 has a mechanism for automatically generating a built-in configuration 434 at run-time when no 435 .B xorg.conf 436 file or 437 .B @xconfigdir@ 438 files are present. The current version of this automatic configuration 439 mechanism works in two ways. 440 .PP 441 The first is via enhancements that have made many components of the 442 .B xorg.conf 443 file optional. This means that information that can be probed or 444 reasonably deduced doesn't need to be specified explicitly, greatly 445 reducing the amount of built-in configuration information that needs to 446 be generated at run-time. 447 .PP 448 The second is to have "safe" fallbacks for most configuration information. 449 This maximises the likelihood that the 450 .B Xorg 451 server will start up in some usable configuration even when information 452 about the specific hardware is not available. 453 .PP 454 The automatic configuration support for Xorg is work in progress. 455 It is currently aimed at the most popular hardware and software platforms 456 supported by Xorg. Enhancements are planned for future releases. 457 .SH FILES 458 The 459 .B Xorg 460 server config files can be found in a range of locations. These are 461 documented fully in the xorg.conf(@filemansuffix@) manual page. The 462 most commonly used locations are shown here. 463 .TP 30 464 .B /etc/X11/xorg.conf 465 Server configuration file. 466 .TP 30 467 .B /etc/X11/xorg.conf-4 468 Server configuration file. 469 .TP 30 470 .B /etc/xorg.conf 471 Server configuration file. 472 .TP 30 473 .B @projectroot@/etc/xorg.conf 474 Server configuration file. 475 .TP 30 476 .B @projectroot@/lib/X11/xorg.conf 477 Server configuration file. 478 .TP 30 479 .B /etc/X11/@xconfigdir@ 480 Server configuration directory. 481 .TP 30 482 .B /etc/X11/@xconfigdir@-4 483 Server configuration directory. 484 .TP 30 485 .B /etc/@xconfigdir@ 486 Server configuration directory. 487 .TP 30 488 .B @projectroot@/etc/@xconfigdir@ 489 Server configuration directory. 490 .TP 30 491 .B @projectroot@/lib/X11/@xconfigdir@ 492 Server configuration directory. 493 .TP 30 494 .BI @logdir@/Xorg. n .log 495 Server log file for display 496 .IR n . 497 .TP 30 498 .B @projectroot@/bin/\(** 499 Client binaries. 500 .TP 30 501 .B @projectroot@/include/\(** 502 Header files. 503 .TP 30 504 .B @projectroot@/lib/\(** 505 Libraries. 506 .TP 30 507 .B @datadir@/fonts/X11/\(** 508 Fonts. 509 .TP 30 510 .B @projectroot@/share/X11/XErrorDB 511 Client error message database. 512 .TP 30 513 .B @projectroot@/lib/X11/app-defaults/\(** 514 Client resource specifications. 515 .TP 30 516 .B @mandir@/man?/\(** 517 Manual pages. 518 .TP 30 519 .BI /etc/X n .hosts 520 Initial access control list for display 521 .IR n . 522 .SH "SEE ALSO" 523 X(@miscmansuffix@), Xserver(@appmansuffix@), xdm(@appmansuffix@), xinit(@appmansuffix@), 524 xorg.conf(@filemansuffix@), xvidtune(@appmansuffix@), 525 xkeyboard-config (@miscmansuffix@), 526 apm(@drivermansuffix@), 527 ati(@drivermansuffix@), 528 chips(@drivermansuffix@), 529 cirrus(@drivermansuffix@), 530 cyrix(@drivermansuffix@), 531 fbdev(@drivermansuffix@), 532 glide(@drivermansuffix@), 533 glint(@drivermansuffix@), 534 i128(@drivermansuffix@), 535 i740(@drivermansuffix@), 536 imstt(@drivermansuffix@), 537 intel(@drivermansuffix@), 538 mga(@drivermansuffix@), 539 neomagic(@drivermansuffix@), 540 nsc(@drivermansuffix@), 541 nv(@drivermansuffix@), 542 openchrome (@drivermansuffix@), 543 r128(@drivermansuffix@), 544 rendition(@drivermansuffix@), 545 s3virge(@drivermansuffix@), 546 siliconmotion(@drivermansuffix@), 547 sis(@drivermansuffix@), 548 sunbw2(@drivermansuffix@), 549 suncg14(@drivermansuffix@), 550 suncg3(@drivermansuffix@), 551 suncg6(@drivermansuffix@), 552 sunffb(@drivermansuffix@), 553 sunleo(@drivermansuffix@), 554 suntcx(@drivermansuffix@), 555 tdfx(@drivermansuffix@), 556 tga(@drivermansuffix@), 557 trident(@drivermansuffix@), 558 tseng(@drivermansuffix@), 559 v4l(@drivermansuffix@), 560 vesa(@drivermansuffix@), 561 vmware(@drivermansuffix@), 562 .br 563 Web site 564 .IR <https://www.x.org> . 565 566 .SH AUTHORS 567 Xorg has many contributors world wide. The names of most of them 568 can be found in the documentation, ChangeLog files in the source tree, 569 and in the actual source code. 570 .PP 571 Xorg was originally based on XFree86 4.4rc2. 572 That was originally based on \fIX386 1.2\fP by Thomas Roell, which 573 was contributed to the then X Consortium's X11R5 distribution by SGCS. 574 .PP 575 Xorg is released by the X.Org Foundation. 576 .PP 577 The project that became XFree86 was originally founded in 1992 by 578 David Dawes, Glenn Lai, Jim Tsillas and David Wexelblat. 579 .PP 580 XFree86 was later integrated in the then X Consortium's X11R6 release 581 by a group of dedicated XFree86 developers, including the following: 582 .PP 583 .RS 4 584 .nf 585 Stuart Anderson \fIanderson@metrolink.com\fP 586 Doug Anson \fIdanson@lgc.com\fP 587 Gertjan Akkerman \fIakkerman@dutiba.twi.tudelft.nl\fP 588 Mike Bernson \fImike@mbsun.mlb.org\fP 589 Robin Cutshaw \fIrobin@XFree86.org\fP 590 David Dawes \fIdawes@XFree86.org\fP 591 Marc Evans \fImarc@XFree86.org\fP 592 Pascal Haible \fIhaible@izfm.uni-stuttgart.de\fP 593 Matthieu Herrb \fIMatthieu.Herrb@laas.fr\fP 594 Dirk Hohndel \fIhohndel@XFree86.org\fP 595 David Holland \fIdavidh@use.com\fP 596 Alan Hourihane \fIalanh@fairlite.demon.co.uk\fP 597 Jeffrey Hsu \fIhsu@soda.berkeley.edu\fP 598 Glenn Lai \fIglenn@cs.utexas.edu\fP 599 Ted Lemon \fImellon@ncd.com\fP 600 Rich Murphey \fIrich@XFree86.org\fP 601 Hans Nasten \fInasten@everyware.se\fP 602 Mark Snitily \fImark@sgcs.com\fP 603 Randy Terbush \fIrandyt@cse.unl.edu\fP 604 Jon Tombs \fItombs@XFree86.org\fP 605 Kees Verstoep \fIversto@cs.vu.nl\fP 606 Paul Vixie \fIpaul@vix.com\fP 607 Mark Weaver \fIMark_Weaver@brown.edu\fP 608 David Wexelblat \fIdwex@XFree86.org\fP 609 Philip Wheatley \fIPhilip.Wheatley@ColumbiaSC.NCR.COM\fP 610 Thomas Wolfram \fIwolf@prz.tu-berlin.de\fP 611 Orest Zborowski \fIorestz@eskimo.com\fP 612 .fi 613 .RE 614 .PP 615 Xorg source is available from the FTP server 616 \fI<ftp://ftp.x.org/>\fP, and from the X.Org 617 server \fI<https://gitlab.freedesktop.org/xorg/>\fP. Documentation and other 618 information can be found from the X.Org web site 619 \fI<https://www.x.org/>\fP. 620 621 .SH LEGAL 622 .PP 623 .B Xorg 624 is copyright software, provided under licenses that permit modification 625 and redistribution in source and binary form without fee. 626 .B Xorg is copyright by numerous authors and 627 contributors from around the world. Licensing information can be found 628 at 629 .IR <https://www.x.org> . 630 Refer to the source code for specific copyright notices. 631 .PP 632 .B XFree86(TM) 633 is a trademark of The XFree86 Project, Inc. 634 .PP 635 .B X11(TM) 636 and 637 .B X Window System(TM) 638 are trademarks of The Open Group.