1
.\" $XdotOrg: xserver/xorg/hw/xfree86/doc/man/Xorg.man.pre,v 1.3 2005/07/04 18:41:01 ajax Exp $
2
.TH __xservername__ __appmansuffix__ __vendorversion__
4
__xservername__ - X11R6 X server
12
is a full featured X server that was originally designed for UNIX and
13
UNIX-like operating systems running on Intel x86 hardware. It now runs
14
on a wider range of hardware and OS platforms.
16
This work was derived from
18
by the X.Org Foundation.
19
The XFree86 4.4rc2 release was originally derived from
21
by Thomas Roell which was contributed to X11R5 by Snitily Graphics
22
Consulting Service. The
24
server architecture includes
25
among many other things a loadable module system derived from code
26
donated by Metro Link, Inc. The current __xservername__ release is compatible
31
operates under a wide range of operating systems and hardware platforms.
32
The Intel x86 (IA32) architecture is the most widely supported hardware
33
platform. Other hardware platforms include Compaq Alpha, Intel IA64,
34
SPARC and PowerPC. The most widely supported operating systems are the
35
free/OpenSource UNIX-like systems such as Linux, FreeBSD, NetBSD and
36
OpenBSD. Commercial UNIX operating systems such as Solaris (x86) and
37
UnixWare are also supported. Other supported operating systems include
38
LynxOS, and GNU Hurd. Darwin and Mac OS X are supported with the
39
XDarwin(1) X server. Win32/Cygwin is supported with the XWin X server.
41
.SH "NETWORK CONNECTIONS"
43
supports connections made using the following reliable
47
On most platforms, the "Local" connection type is a UNIX-domain socket.
48
On some System V platforms, the "local" connection types also include
49
STREAMS pipes, named pipes, and some other mechanisms.
57
is the display number. This connection type can be disabled with the
59
option (see the Xserver(1) man page for details).
60
.SH "ENVIRONMENT VARIABLES"
61
For operating systems that support local connections other than Unix
62
Domain sockets (SVR3 and SVR4), there is a compiled-in list specifying
63
the order in which local connections should be attempted. This list
64
can be overridden by the
66
environment variable described below. If the display name indicates a
67
best-choice connection should be made (e.g.
69
each connection mechanism is tried until a connection succeeds or no
70
more mechanisms are available. Note: for these OSs, the Unix Domain
71
socket connection is treated differently from the other local connection
72
types. To use it the connection must be made to
77
environment variable should contain a list of one more
78
more of the following:
89
which represent SVR4 Named Streams pipe, Old-style USL Streams pipe,
90
SCO XSight Streams pipe, and ISC Streams pipe, respectively. You can
91
select a single mechanism (e.g.
93
or an ordered list (e.g. \fIXLOCAL="NAMED:PTS:SCO"\fP).
94
his variable overrides the compiled-in defaults. For SVR4 it is
97
be the first preference connection. The default setting is
98
.IR PTS:NAMED:ISC:SCO .
100
To globally override the compiled-in defaults, you should define (and
106
globally. If you use startx(1) or xinit(1), the definition should be
109
file. If you use xdm(1), the definitions should be early on in the
110
.I __projectroot__/lib/X11/xdm/Xsession
114
supports several mechanisms for supplying/obtaining configuration and
115
run-time parameters: command line options, environment variables, the
116
__xconfigfile__(__filemansuffix__) configuration file, auto-detection, and
117
fallback defaults. When the same information is supplied in more than
118
one way, the highest precedence mechanism is used. The list of mechanisms
119
is ordered from highest precedence to lowest. Note that not all parameters
120
can be supplied via all methods. The available command line options
121
and environment variables (and some defaults) are described here and in
122
the Xserver(1) manual page. Most configuration file parameters, with
123
their defaults, are described in the __xconfigfile__(__filemansuffix__) manual
124
page. Driver and module specific configuration parameters are described
125
in the relevant driver or module manual page.
127
In addition to the normal server options described in the Xserver(1)
130
accepts the following command line switches:
134
specifies the Virtual Terminal device number which
136
will use. Without this option,
138
will pick the first available Virtual Terminal that it can locate. This
139
option applies only to platforms such as Linux, BSD, SVR3 and SVR4, that
140
have virtual terminal support.
142
.B \-allowMouseOpenFail
143
Allow the server to start up even if the mouse device can't be opened
144
or initialised. This is equivalent to the
145
.B AllowMouseOpenFail
146
__xconfigfile__(__filemansuffix__) file option.
148
.B \-allowNonLocalModInDev
149
Allow changes to keyboard and mouse settings from non-local clients.
150
By default, connections from non-local clients are not allowed to do
151
this. This is equivalent to the
152
.B AllowNonLocalModInDev
153
__xconfigfile__(__filemansuffix__) file option.
155
.B \-allowNonLocalXvidtune
156
Make the VidMode extension available to remote clients. This allows
157
the xvidtune client to connect from another host. This is equivalent
159
.B AllowNonLocalXvidtune
160
__xconfigfile__(__filemansuffix__) file option. By default non-local
161
connections are not allowed.
163
.BI \-bgamma " value"
164
Set the blue gamma correction.
166
must be between 0.1 and 10.
167
The default is 1.0. Not all drivers support this. See also the
175
No longer supported. Use
177
to set the color depth, and use
179
if you really need to force a non-default framebuffer (hardware) pixel
183
When this option is specified, the
185
server loads all video driver modules, probes for available hardware,
186
and writes out an initial __xconfigfile__(__filemansuffix__) file based on
187
what was detected. This option currently has some problems on some
188
platforms, but in most cases it is a good way to bootstrap the
189
configuration process. This option is only available when the server
190
is run as root (i.e, with real-uid 0).
192
.BI "\-crt /dev/tty" XX
193
SCO only. This is the same as the
195
option, and is provided for compatibility with the native SCO X server.
198
Sets the default color depth. Legal values are 1, 4, 8, 15, 16, and
199
24. Not all drivers support all values.
202
Disable dynamic modification of input device settings. This is equivalent
205
__xconfigfile__(__filemansuffix__) file option.
208
Disable the 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
__xconfigfile__(__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 __xconfigfile__(__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 __xconfigfile__(__filemansuffix__) file
299
.BI \-logfile " filename"
304
server log file. The default log file is
305
.BI __logdir__/__xservername__. 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
Set the internal pixmap format for depth 24 pixmaps to 24 bits per pixel.
339
The default is usually 32 bits per pixel. There is normally little
340
reason to use this option. Some client applications don't like this
341
pixmap format, even though it is a perfectly legal format. This is
344
__xconfigfile__(__filemansuffix__) file option.
347
Set the internal pixmap format for depth 24 pixmaps to 32 bits per pixel.
348
This is usually the default. This is equivalent to the
350
__xconfigfile__(__filemansuffix__) file option.
352
.BI \-pointer " pointer-name"
353
Use the __xconfigfile__(__filemansuffix__) file
357
as the core pointer. This option is ignored when the
359
section specifies a core pointer. In the absence of both a Layout
360
section and this option, the first relevant
362
section is used for the core pointer.
365
Causes the server to exit after the device probing stage. The
366
__xconfigfile__(__filemansuffix__) file is still used when this option is
367
given, so information that can be auto-detected should be commented out.
370
Suppress most informational messages at startup. The verbosity level
373
.BI \-rgamma " value"
374
Set the red gamma correction.
376
must be between 0.1 and 10. The default is 1.0. Not all drivers support
385
When this option is specified, the
387
server scans the PCI bus, and prints out some information about each
388
device that was detected. See also scanpci(1) and pcitweak(1).
390
.BI \-screen " screen-name"
391
Use the __xconfigfile__(__filemansuffix__) file
395
By default the screens referenced by the default
397
section are used, or the first
399
section when there are no
404
This is the same as the
406
option, and is included for compatibility reasons. It may be removed
407
in a future release, so the
409
option should be used instead.
412
Set RGB weighting at 16 bpp. The default is 565. This applies only to
413
those drivers which support 16 bpp.
415
.BR \-verbose " [\fIn\fP]"
416
Sets the verbosity level for information printed on stderr. If the
418
value isn't supplied, each occurrence of this option increments the
419
verbosity level. When the
421
value is supplied, the verbosity level is set to that value. The default
422
verbosity level is 0.
425
Print out the server version, patchlevel, release date, the operating
426
system/platform it was built on, and whether it includes module loader
430
Read the server configuration from
432
This option will work for any file when the server is run as root (i.e,
433
with real-uid 0), or for files relative to a directory in the config
434
search path for all other users.
439
server is normally configured to recognize various special combinations
440
of key presses that instruct the server to perform some action, rather
441
than just sending the key press event to a client application. The
442
default XKEYBOARD keymap defines the key combinations listed below.
443
The server also has these key combinations builtin to its event handler
444
for cases where the XKEYBOARD extension is not being used. When using
445
the XKEYBOARD extension, which key combinations perform which actions
446
is completely configurable.
448
For more information about when the builtin event handler
449
is used to recognize the special key combinations, see
450
the documentation on the
452
option in the __xconfigfile__(__filemansuffix__) man page.
454
The special combinations of key presses recognized directly
459
.B Ctrl+Alt+Backspace
460
Immediately kills the server -- no questions asked. This can be disabled
463
__xconfigfile__(__filemansuffix__) file option.
465
.B Ctrl+Alt+Keypad-Plus
466
Change video mode to next one specified in the configuration file.
467
This can be disabled with the
469
__xconfigfile__(__filemansuffix__) file option.
471
.B Ctrl+Alt+Keypad-Minus
472
Change video mode to previous one specified in the configuration file.
473
This can be disabled with the
475
__xconfigfile__(__filemansuffix__) file option.
477
.B Ctrl+Alt+Keypad-Multiply
478
Not treated specially by default. If the
479
.B AllowClosedownGrabs
480
__xconfigfile__(__filemansuffix__) file option is specified, this key sequence
481
kills clients with an active keyboard or mouse grab as well as killing any
482
application that may have locked the server, normally using the
483
XGrabServer(__libmansuffix__) Xlib function.
485
.B Ctrl+Alt+Keypad-Divide
486
Not treated specially by default. If the
487
.B AllowDeactivateGrabs
488
__xconfigfile__(__filemansuffix__) file option is specified, this key sequence
489
deactivates any active keyboard and mouse grabs.
492
For BSD and Linux systems with virtual terminal support, these keystroke
493
combinations are used to switch to virtual terminals 1 through 12,
494
respectively. This can be disabled with the
496
__xconfigfile__(__filemansuffix__) file option.
499
typically uses a configuration file called
501
for its initial setup.
502
Refer to the __xconfigfile__(__filemansuffix__) manual page for information
503
about the format of this file.
505
Starting with version 4.4,
507
has a mechanism for automatically generating a built-in configuration
510
file is present. The current version of this automatic configuration
511
mechanism works in three ways.
513
The first is via enhancements that have made many components of the
515
file optional. This means that information that can be probed or
516
reasonably deduced doesn't need to be specified explicitly, greatly
517
reducing the amount of built-in configuration information that needs to
518
be generated at run-time.
520
The second is to use an external utility called getconfig(1), when
521
available, to use meta-configuration information to generate a suitable
522
configuration for the primary video device. The meta-configuration
523
information can be updated to allow an existing installation to get the
524
best out of new hardware or to work around bugs that are found
527
The third is to have "safe" fallbacks for most configuration information.
528
This maximises the likelihood that the
530
server will start up in some usable configuration even when information
531
about the specific hardware is not available.
533
The automatic configuration support for __xservername__ is work in progress.
534
It is currently aimed at the most popular hardware and software platforms
535
supported by __xservername__. Enhancements are planned for future releases.
539
server config file can be found in a range of locations. These are
540
documented fully in the __xconfigfile__(__filemansuffix__) manual page. The
541
most commonly used locations are shown here.
543
.B /etc/X11/__xconfigfile__
544
Server configuration file.
546
.B /etc/X11/__xconfigfile__-4
547
Server configuration file.
549
.B /etc/__xconfigfile__
550
Server configuration file.
552
.B __projectroot__/etc/__xconfigfile__
553
Server configuration file.
555
.B __projectroot__/lib/X11/__xconfigfile__
556
Server configuration file.
558
.BI __logdir__/__xservername__. n .log
559
Server log file for display
562
.B __projectroot__/bin/\(**
565
.B __projectroot__/include/\(**
568
.B __projectroot__/lib/\(**
571
.B __projectroot__/lib/X11/fonts/\(**
574
.B __projectroot__/lib/X11/rgb.txt
575
Color names to RGB mapping.
577
.B __projectroot__/lib/X11/XErrorDB
578
Client error message database.
580
.B __projectroot__/lib/X11/app-defaults/\(**
581
Client resource specifications.
583
.B __projectroot__/man/man?/\(**
587
Initial access control list for display
590
X(__miscmansuffix__), Xserver(__appmansuffix__), xdm(__appmansuffix__), xinit(__appmansuffix__),
591
__xconfigfile__(__filemansuffix__), xorgconfig(__appmansuffix__), xorgcfg(__appmansuffix__), xvidtune(__appmansuffix__),
592
apm(__drivermansuffix__),
593
ati(__drivermansuffix__),
594
chips(__drivermansuffix__),
595
cirrus(__drivermansuffix__),
596
cyrix(__drivermansuffix__),
597
fbdev(__drivermansuffix__),
598
glide(__drivermansuffix__),
599
glint(__drivermansuffix__),
600
i128(__drivermansuffix__),
601
i740(__drivermansuffix__),
602
i810(__drivermansuffix__),
603
imstt(__drivermansuffix__),
604
mga(__drivermansuffix__),
605
neomagic(__drivermansuffix__),
606
nsc(__drivermansuffix__),
607
nv(__drivermansuffix__),
608
r128(__drivermansuffix__),
609
rendition(__drivermansuffix__),
610
s3virge(__drivermansuffix__),
611
siliconmotion(__drivermansuffix__),
612
sis(__drivermansuffix__),
613
sunbw2(__drivermansuffix__),
614
suncg14(__drivermansuffix__),
615
suncg3(__drivermansuffix__),
616
suncg6(__drivermansuffix__),
617
sunffb(__drivermansuffix__),
618
sunleo(__drivermansuffix__),
619
suntcx(__drivermansuffix__),
620
tdfx(__drivermansuffix__),
621
tga(__drivermansuffix__),
622
trident(__drivermansuffix__),
623
tseng(__drivermansuffix__),
624
v4l(__drivermansuffix__),
625
vesa(__drivermansuffix__),
626
vga(__drivermansuffix__),
627
vmware(__drivermansuffix__),
630
.IR <http://www.x.org> .
633
__xservername__ has many contributors world wide. The names of most of them
634
can be found in the documentation, CHANGELOG files in the source tree,
635
and in the actual source code.
637
__xservername__ was originally based on XFree86 4.4rc2.
638
That was originally based on \fIX386 1.2\fP by Thomas Roell, which
639
was contributed to the then X Consortium's X11R5 distribution by SGCS.
641
__xservername__ is released by the X.org Foundation.
643
The project that became XFree86 was originally founded in 1992 by
644
David Dawes, Glenn Lai, Jim Tsillas and David Wexelblat.
646
XFree86 was later integrated in the then X Consortium's X11R6 release
647
by a group of dedicated XFree86 developers, including the following:
651
Stuart Anderson \fIanderson@metrolink.com\fP
652
Doug Anson \fIdanson@lgc.com\fP
653
Gertjan Akkerman \fIakkerman@dutiba.twi.tudelft.nl\fP
654
Mike Bernson \fImike@mbsun.mlb.org\fP
655
Robin Cutshaw \fIrobin@XFree86.org\fP
656
David Dawes \fIdawes@XFree86.org\fP
657
Marc Evans \fImarc@XFree86.org\fP
658
Pascal Haible \fIhaible@izfm.uni-stuttgart.de\fP
659
Matthieu Herrb \fIMatthieu.Herrb@laas.fr\fP
660
Dirk Hohndel \fIhohndel@XFree86.org\fP
661
David Holland \fIdavidh@use.com\fP
662
Alan Hourihane \fIalanh@fairlite.demon.co.uk\fP
663
Jeffrey Hsu \fIhsu@soda.berkeley.edu\fP
664
Glenn Lai \fIglenn@cs.utexas.edu\fP
665
Ted Lemon \fImellon@ncd.com\fP
666
Rich Murphey \fIrich@XFree86.org\fP
667
Hans Nasten \fInasten@everyware.se\fP
668
Mark Snitily \fImark@sgcs.com\fP
669
Randy Terbush \fIrandyt@cse.unl.edu\fP
670
Jon Tombs \fItombs@XFree86.org\fP
671
Kees Verstoep \fIversto@cs.vu.nl\fP
672
Paul Vixie \fIpaul@vix.com\fP
673
Mark Weaver \fIMark_Weaver@brown.edu\fP
674
David Wexelblat \fIdwex@XFree86.org\fP
675
Philip Wheatley \fIPhilip.Wheatley@ColumbiaSC.NCR.COM\fP
676
Thomas Wolfram \fIwolf@prz.tu-berlin.de\fP
677
Orest Zborowski \fIorestz@eskimo.com\fP
681
__xservername__ source is available from the FTP server
682
\fI<ftp://ftp.x.org/>\fP, and from the X.org
683
server \fI<http://www.freedesktop.org/cvs/>\fP. Documentation and other
684
information can be found from the X.org web site
685
\fI<http://www.x.org/>\fP.
690
is copyright software, provided under licenses that permit modification
691
and redistribution in source and binary form without fee.
692
.B __xservername__ is copyright by numerous authors and
693
contributors from around the world. Licensing information can be found
695
.IR <http://www.x.org> .
696
Refer to the source code for specific copyright notices.
699
is a trademark of The XFree86 Project, Inc.
703
.B X Window System(TM)
704
are trademarks of The Open Group.
added
removed
hw/xfree86/doc/man/Xorg.man.pre
