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 when running as root is
305
.BI __logdir__/Xorg. n .log
306
and for non root it is
307
.BI $XDG_DATA_HOME/xorg/Xorg. n .log
310
is the display number of the
312
server. The default may be in a different directory on some platforms.
313
This option is only available when the server is run as root (i.e, with
316
.BR \-logverbose " [\fIn\fP]"
317
Sets the verbosity level for information printed to the
319
server log file. If the
321
value isn't supplied, each occurrence of this option increments the log
322
file verbosity level. When the
324
value is supplied, the log file verbosity level is set to that value.
325
The default log file verbosity level is 3.
327
.BI \-modulepath " searchpath"
328
Set the module search path to
331
is a comma separated list of directories to search for
333
server modules. This option is only available when the server is run
334
as root (i.e, with real-uid 0).
337
Disable Silken Mouse support.
340
Disable the automatic switching on X server reset and shutdown to the
341
VT that was active when the server started, if supported by the OS.
344
Set the internal pixmap format for depth 24 pixmaps to 24 bits per pixel.
345
The default is usually 32 bits per pixel. There is normally little
346
reason to use this option. Some client applications don't like this
347
pixmap format, even though it is a perfectly legal format. This is
350
xorg.conf(__filemansuffix__) file option.
353
Set the internal pixmap format for depth 24 pixmaps to 32 bits per pixel.
354
This is usually the default. This is equivalent to the
356
xorg.conf(__filemansuffix__) file option.
358
.BI \-pointer " pointer-name"
359
Use the xorg.conf(__filemansuffix__) file
363
as the core pointer. This option is ignored when the
365
section specifies a core pointer. In the absence of both a Layout
366
section and this option, the first relevant
368
section is used for the core pointer.
371
Suppress most informational messages at startup. The verbosity level
374
.BI \-rgamma " value"
375
Set the red gamma correction.
377
must be between 0.1 and 10. The default is 1.0. Not all drivers support
386
Share virtual terminals with another X server, if supported by the OS.
388
.BI \-screen " screen-name"
389
Use the xorg.conf(__filemansuffix__) file
393
By default the screens referenced by the default
395
section are used, or the first
397
section when there are no
402
This is the same as the
404
option, and is included for compatibility reasons. It may be removed
405
in a future release, so the
407
option should be used instead.
409
.B \-showDefaultModulePath
410
Print out the default module path the server was compiled with.
412
.B \-showDefaultLibPath
413
Print out the path libraries should be installed to.
416
For each driver module installed, print out the list of options and their
420
Set RGB weighting at 16 bpp. The default is 565. This applies only to
421
those drivers which support 16 bpp.
423
.BR \-verbose " [\fIn\fP]"
424
Sets the verbosity level for information printed on stderr. If the
426
value isn't supplied, each occurrence of this option increments the
427
verbosity level. When the
429
value is supplied, the verbosity level is set to that value. The default
430
verbosity level is 0.
433
Print out the server version, patchlevel, release date, the operating
434
system/platform it was built on, and whether it includes module loader
440
server is normally configured to recognize various special combinations
441
of key presses that instruct the server to perform some action, rather
442
than just sending the key press event to a client application. These actions
443
depend on the XKB keymap loaded by a particular keyboard device and may or
444
may not be available on a given configuration.
446
The following key combinations are commonly part of the default XKEYBOARD
449
.B Ctrl+Alt+Backspace
450
Immediately kills the server -- no questions asked. It can be disabled by
453
xorg.conf(__filemansuffix__) file option to a TRUE value.
456
It should be noted that zapping is triggered by the
458
action in the keyboard map. This action is not part of the default keymaps
459
but can be enabled with the XKB option
460
.B \*qterminate:ctrl_alt_bksp\*q.
463
.B Ctrl+Alt+Keypad-Plus
464
Change video mode to next one specified in the configuration file.
465
This can be disabled with the
467
xorg.conf(__filemansuffix__) file option.
469
.B Ctrl+Alt+Keypad-Minus
470
Change video mode to previous one specified in the configuration file.
471
This can be disabled with the
473
xorg.conf(__filemansuffix__) file option.
476
For systems with virtual terminal support, these keystroke
477
combinations are used to switch to virtual terminals 1 through 12,
478
respectively. This can be disabled with the
480
xorg.conf(__filemansuffix__) file option.
483
typically uses a configuration file called
485
and configuration files with the suffix
487
in a directory called
489
for its initial setup.
490
Refer to the xorg.conf(__filemansuffix__) manual page for information
491
about the format of this file.
494
has a mechanism for automatically generating a built-in configuration
499
files are present. The current version of this automatic configuration
500
mechanism works in two ways.
502
The first is via enhancements that have made many components of the
504
file optional. This means that information that can be probed or
505
reasonably deduced doesn't need to be specified explicitly, greatly
506
reducing the amount of built-in configuration information that needs to
507
be generated at run-time.
509
The second is to have "safe" fallbacks for most configuration information.
510
This maximises the likelihood that the
512
server will start up in some usable configuration even when information
513
about the specific hardware is not available.
515
The automatic configuration support for Xorg is work in progress.
516
It is currently aimed at the most popular hardware and software platforms
517
supported by Xorg. Enhancements are planned for future releases.
521
server config files can be found in a range of locations. These are
522
documented fully in the xorg.conf(__filemansuffix__) manual page. The
523
most commonly used locations are shown here.
525
.B /etc/X11/xorg.conf
526
Server configuration file.
528
.B /etc/X11/xorg.conf-4
529
Server configuration file.
532
Server configuration file.
534
.B __projectroot__/etc/xorg.conf
535
Server configuration file.
537
.B __projectroot__/lib/X11/xorg.conf
538
Server configuration file.
540
.B /etc/X11/__xconfigdir__
541
Server configuration directory.
543
.B /etc/X11/__xconfigdir__-4
544
Server configuration directory.
546
.B /etc/__xconfigdir__
547
Server configuration directory.
549
.B __projectroot__/etc/__xconfigdir__
550
Server configuration directory.
552
.B __projectroot__/lib/X11/__xconfigdir__
553
Server configuration directory.
555
.BI __logdir__/Xorg. n .log
556
Server log file for display
559
.B __projectroot__/bin/\(**
562
.B __projectroot__/include/\(**
565
.B __projectroot__/lib/\(**
568
.B __datadir__/fonts/X11/\(**
571
.B __projectroot__/share/X11/XErrorDB
572
Client error message database.
574
.B __projectroot__/lib/X11/app-defaults/\(**
575
Client resource specifications.
577
.B __mandir__/man?/\(**
581
Initial access control list for display
584
X(__miscmansuffix__), Xserver(__appmansuffix__), xdm(__appmansuffix__), xinit(__appmansuffix__),
585
xorg.conf(__filemansuffix__), xvidtune(__appmansuffix__),
586
xkeyboard-config (__miscmansuffix__),
587
apm(__drivermansuffix__),
588
ati(__drivermansuffix__),
589
chips(__drivermansuffix__),
590
cirrus(__drivermansuffix__),
591
cyrix(__drivermansuffix__),
592
fbdev(__drivermansuffix__),
593
glide(__drivermansuffix__),
594
glint(__drivermansuffix__),
595
i128(__drivermansuffix__),
596
i740(__drivermansuffix__),
597
imstt(__drivermansuffix__),
598
intel(__drivermansuffix__),
599
mga(__drivermansuffix__),
600
neomagic(__drivermansuffix__),
601
nsc(__drivermansuffix__),
602
nv(__drivermansuffix__),
603
openchrome (__drivermansuffix__),
604
r128(__drivermansuffix__),
605
rendition(__drivermansuffix__),
606
s3virge(__drivermansuffix__),
607
siliconmotion(__drivermansuffix__),
608
sis(__drivermansuffix__),
609
sunbw2(__drivermansuffix__),
610
suncg14(__drivermansuffix__),
611
suncg3(__drivermansuffix__),
612
suncg6(__drivermansuffix__),
613
sunffb(__drivermansuffix__),
614
sunleo(__drivermansuffix__),
615
suntcx(__drivermansuffix__),
616
tdfx(__drivermansuffix__),
617
tga(__drivermansuffix__),
618
trident(__drivermansuffix__),
619
tseng(__drivermansuffix__),
620
v4l(__drivermansuffix__),
621
vesa(__drivermansuffix__),
622
vmware(__drivermansuffix__),
625
.IR <http://www.x.org> .
628
Xorg has many contributors world wide. The names of most of them
629
can be found in the documentation, ChangeLog files in the source tree,
630
and in the actual source code.
632
Xorg was originally based on XFree86 4.4rc2.
633
That was originally based on \fIX386 1.2\fP by Thomas Roell, which
634
was contributed to the then X Consortium's X11R5 distribution by SGCS.
636
Xorg is released by the X.Org Foundation.
638
The project that became XFree86 was originally founded in 1992 by
639
David Dawes, Glenn Lai, Jim Tsillas and David Wexelblat.
641
XFree86 was later integrated in the then X Consortium's X11R6 release
642
by a group of dedicated XFree86 developers, including the following:
646
Stuart Anderson \fIanderson@metrolink.com\fP
647
Doug Anson \fIdanson@lgc.com\fP
648
Gertjan Akkerman \fIakkerman@dutiba.twi.tudelft.nl\fP
649
Mike Bernson \fImike@mbsun.mlb.org\fP
650
Robin Cutshaw \fIrobin@XFree86.org\fP
651
David Dawes \fIdawes@XFree86.org\fP
652
Marc Evans \fImarc@XFree86.org\fP
653
Pascal Haible \fIhaible@izfm.uni-stuttgart.de\fP
654
Matthieu Herrb \fIMatthieu.Herrb@laas.fr\fP
655
Dirk Hohndel \fIhohndel@XFree86.org\fP
656
David Holland \fIdavidh@use.com\fP
657
Alan Hourihane \fIalanh@fairlite.demon.co.uk\fP
658
Jeffrey Hsu \fIhsu@soda.berkeley.edu\fP
659
Glenn Lai \fIglenn@cs.utexas.edu\fP
660
Ted Lemon \fImellon@ncd.com\fP
661
Rich Murphey \fIrich@XFree86.org\fP
662
Hans Nasten \fInasten@everyware.se\fP
663
Mark Snitily \fImark@sgcs.com\fP
664
Randy Terbush \fIrandyt@cse.unl.edu\fP
665
Jon Tombs \fItombs@XFree86.org\fP
666
Kees Verstoep \fIversto@cs.vu.nl\fP
667
Paul Vixie \fIpaul@vix.com\fP
668
Mark Weaver \fIMark_Weaver@brown.edu\fP
669
David Wexelblat \fIdwex@XFree86.org\fP
670
Philip Wheatley \fIPhilip.Wheatley@ColumbiaSC.NCR.COM\fP
671
Thomas Wolfram \fIwolf@prz.tu-berlin.de\fP
672
Orest Zborowski \fIorestz@eskimo.com\fP
676
Xorg source is available from the FTP server
677
\fI<ftp://ftp.x.org/>\fP, and from the X.Org
678
server \fI<http://gitweb.freedesktop.org/>\fP. Documentation and other
679
information can be found from the X.Org web site
680
\fI<http://www.x.org/>\fP.
685
is copyright software, provided under licenses that permit modification
686
and redistribution in source and binary form without fee.
687
.B Xorg is copyright by numerous authors and
688
contributors from around the world. Licensing information can be found
690
.IR <http://www.x.org> .
691
Refer to the source code for specific copyright notices.
694
is a trademark of The XFree86 Project, Inc.
698
.B X Window System(TM)
699
are trademarks of The Open Group.
added
removed
hw/xfree86/man/Xorg.man
