1xorg.conf(5)                  File Formats Manual                 xorg.conf(5)
2
3
4

NAME

6       xorg.conf - Configuration File for Xorg
7

INTRODUCTION

9       Xorg  supports several mechanisms for supplying/obtaining configuration
10       and run-time parameters: command line options,  environment  variables,
11       the   xorg.conf   configuration   file,  auto-detection,  and  fallback
12       defaults.  When the same information is supplied in more than one  way,
13       the  highest  precedence  mechanism is used.  The list of mechanisms is
14       ordered from highest precedence to lowest.  Note that not  all  parame‐
15       ters  can  be  supplied  via  all  methods.  The available command line
16       options and environment variables (and some defaults) are described  in
17       the  Xserver(1)  and  Xorg(1)  manual  pages.   Most configuration file
18       parameters, with their defaults, are described below.  Driver and  mod‐
19       ule  specific  configuration  parameters  are described in the relevant
20       driver or module manual page.
21

DESCRIPTION

23       Xorg uses a configuration file called xorg.conf for its initial  setup.
24       This  configuration  file  is searched for in the following places when
25       the server is started as a normal user:
26
27           /etc/X11/<cmdline>
28           /usr/etc/X11/<cmdline>
29           /etc/X11/$XORGCONFIG
30           /usr/etc/X11/$XORGCONFIG
31           /etc/X11/xorg.conf-4
32           /etc/X11/xorg.conf
33           /etc/xorg.conf
34           /usr/etc/X11/xorg.conf.<hostname>
35           /usr/etc/X11/xorg.conf-4
36           /usr/etc/X11/xorg.conf
37           /usr/lib/X11/xorg.conf.<hostname>
38           /usr/lib/X11/xorg.conf-4
39           /usr/lib/X11/xorg.conf
40
41       where <cmdline> is a relative path (with no ".." components)  specified
42       with  the -config command line option, $XORGCONFIG is the relative path
43       (with no ".." components) specified by that environment  variable,  and
44       <hostname> is the machine's hostname as reported by gethostname(3).
45
46       When  the  Xorg  server  is started by the "root" user, the config file
47       search locations are as follows:
48
49           <cmdline>
50           /etc/X11/<cmdline>
51           /usr/etc/X11/<cmdline>
52           $XORGCONFIG
53           /etc/X11/$XORGCONFIG
54           /usr/etc/X11/$XORGCONFIG
55           $HOME/xorg.conf
56           /etc/X11/xorg.conf-4
57           /etc/X11/xorg.conf
58           /etc/xorg.conf
59           /usr/etc/X11/xorg.conf.<hostname>
60           /usr/etc/X11/xorg.conf-4
61           /usr/etc/X11/xorg.conf
62           /usr/lib/X11/xorg.conf.<hostname>
63           /usr/lib/X11/xorg.conf-4
64           /usr/lib/X11/xorg.conf
65
66       where <cmdline> is the path specified with  the  -config  command  line
67       option  (which  may  be  absolute or relative), $XORGCONFIG is the path
68       specified by that environment variable (absolute or relative), $HOME is
69       the  path  specified  by  that  environment  variable (usually the home
70       directory), and <hostname> is the machine's  hostname  as  reported  by
71       gethostname(3).
72
73       The  xorg.conf  file  is  composed of a number of sections which may be
74       present in any order.  Each section has the form:
75
76           Section  "SectionName"
77               SectionEntry
78               ...
79           EndSection
80
81       The section names are:
82
83           Files          File pathnames
84           ServerFlags    Server flags
85           Module         Dynamic module loading
86           InputDevice    Input device description
87           Device         Graphics device description
88           VideoAdaptor   Xv video adaptor description
89           Monitor        Monitor description
90           Modes          Video modes descriptions
91           Screen         Screen configuration
92           ServerLayout   Overall layout
93           DRI            DRI-specific configuration
94           Vendor         Vendor-specific configuration
95
96       The following obsolete section names are still recognised for  compati‐
97       bility  purposes.   In new config files, the InputDevice section should
98       be used instead.
99
100           Keyboard       Keyboard configuration
101           Pointer        Pointer/mouse configuration
102
103       The old XInput section is no longer recognised.
104
105       The ServerLayout sections are at the highest level.  They bind together
106       the input and output devices that will be used in a session.  The input
107       devices are described in the InputDevice sections.  Output devices usu‐
108       ally consist of multiple independent components (e.g., a graphics board
109       and a monitor).  These multiple components are bound  together  in  the
110       Screen  sections, and it is these that are referenced by the ServerLay‐
111       out section.  Each Screen section binds together a graphics board and a
112       monitor.  The graphics boards are described in the Device sections, and
113       the monitors are described in the Monitor sections.
114
115       Config file keywords  are  case-insensitive,  and  "_"  characters  are
116       ignored.   Most strings (including Option names) are also case-insensi‐
117       tive, and insensitive to white space and "_" characters.
118
119       Each config file entry usually takes up a  single  line  in  the  file.
120       They  consist  of  a keyword, which is possibly followed by one or more
121       arguments, with the number and types of the arguments depending on  the
122       keyword.  The argument types are:
123
124           Integer     an integer number in decimal, hex or octal
125           Real        a floating point number
126           String      a string enclosed in double quote marks (")
127
128       Note:  hex  integer values must be prefixed with "0x", and octal values
129       with "0".
130
131       A special keyword called Option may be used to provide  free-form  data
132       to  various  components of the server.  The Option keyword takes either
133       one or two string arguments.  The first is the  option  name,  and  the
134       optional  second  argument  is  the  option  value.  Some commonly used
135       option value types include:
136
137           Integer     an integer number in decimal, hex or octal
138           Real        a floating point number
139           String      a sequence of characters
140           Boolean     a boolean value (see below)
141           Frequency   a frequency value (see below)
142
143       Note that all Option values, not just  strings,  must  be  enclosed  in
144       quotes.
145
146       Boolean  options  may optionally have a value specified.  When no value
147       is specified, the option's value is TRUE.  The following boolean option
148       values are recognised as TRUE:
149
150           1, on, true, yes
151
152       and the following boolean option values are recognised as FALSE:
153
154           0, off, false, no
155
156       If  an  option  name  is  prefixed  with "No", then the option value is
157       negated.
158
159       Example: the following option entries are equivalent:
160
161           Option "Accel"   "Off"
162           Option "NoAccel"
163           Option "NoAccel" "On"
164           Option "Accel"   "false"
165           Option "Accel"   "no"
166
167       Frequency option values consist of a real  number  that  is  optionally
168       followed by one of the following frequency units:
169
170           Hz, k, kHz, M, MHz
171
172       When  the  unit  name  is omitted, the correct units will be determined
173       from the value and the expectations of the  appropriate  range  of  the
174       value.  It is recommended that the units always be specified when using
175       frequency option values to avoid any errors in determining the value.
176

FILES SECTION

178       The Files section is used to specify some path names  required  by  the
179       server.  Some of these paths can also be set from the command line (see
180       Xserver(1) and Xorg(1)).  The command line settings override the values
181       specified  in  the  config file.  The Files section is optional, as are
182       all of the entries that may appear in it.
183
184       The entries that can appear in this section are:
185
186       FontPath "path"
187              sets the search path for fonts.  This path is a comma  separated
188              list  of  font  path elements which the Xorg server searches for
189              font databases.  Multiple FontPath entries may be specified, and
190              they  will  be concatenated to build up the fontpath used by the
191              server.  Font path elements may  be  either  absolute  directory
192              paths,  or  a  font  server identifier.  Font server identifiers
193              have the form:
194
195                  <trans>/<hostname>:<port-number>
196
197              where <trans> is the transport type to use  to  connect  to  the
198              font  server  (e.g.,  unix  for UNIX-domain sockets or tcp for a
199              TCP/IP connection), <hostname> is the hostname  of  the  machine
200              running  the  font  server, and <port-number> is the port number
201              that the font server is listening on (usually 7100).
202
203              When this entry is not specified in the config file, the  server
204              falls  back to the compiled-in default font path, which contains
205              the following font path elements:
206
207                  /usr/lib/X11/fonts/misc/
208                  /usr/lib/X11/fonts/TTF/
209                  /usr/lib/X11/fonts/Type1/
210                  /usr/lib/X11/fonts/75dpi/
211                  /usr/lib/X11/fonts/100dpi/
212
213              The recommended font path contains the following font path  ele‐
214              ments:
215
216                  /usr/lib/X11/fonts/local/
217                  /usr/lib/X11/fonts/misc/
218                  /usr/lib/X11/fonts/75dpi/:unscaled
219                  /usr/lib/X11/fonts/100dpi/:unscaled
220                  /usr/lib/X11/fonts/Type1/
221                  /usr/lib/X11/fonts/Speedo/
222                  /usr/lib/X11/fonts/75dpi/
223                  /usr/lib/X11/fonts/100dpi/
224
225              Font path elements that are found to be invalid are removed from
226              the font path when the server starts up.
227
228       RGBPath "path"
229              sets the path name for the RGB color database.  When this  entry
230              is  not  specified  in the config file, the server falls back to
231              the compiled-in default RGB path, which is:
232
233                  /usr/share/X11/rgb
234
235       Note that an implicit .txt is added to this path if the server was com‐
236       piled to use text rather than binary format RGB color databases.
237
238       ModulePath "path"
239              sets  the  search  path  for loadable Xorg server modules.  This
240              path is a comma separated list of  directories  which  the  Xorg
241              server searches for loadable modules loading in the order speci‐
242              fied.  Multiple ModulePath entries may be  specified,  and  they
243              will be concatenated to build the module search path used by the
244              server.
245

SERVERFLAGS SECTION

247       In addition to options specific to this section (described below),  the
248       ServerFlags section is used to specify some global Xorg server options.
249       All of the entries in this section are Options, although  for  compati‐
250       bility  purposes  some  of  the old style entries are still recognised.
251       Those old style entries are not documented here, and using them is dis‐
252       couraged.  The ServerFlags section is optional, as are the entries that
253       may be specified in it.
254
255       Options specified in this section (with the exception of the  "Default‐
256       ServerLayout"  Option)  may  be  overridden by Options specified in the
257       active ServerLayout section.  Options with command line equivalents are
258       overridden  when  their  command  line equivalent is used.  The options
259       recognised by this section are:
260
261       Option "DefaultServerLayout"  "layout-id"
262              This specifies the default ServerLayout section to  use  in  the
263              absence of the -layout command line option.
264
265       Option "NoTrapSignals"  "boolean"
266              This  prevents  the  Xorg  server from trapping a range of unex‐
267              pected fatal signals and exiting  cleanly.   Instead,  the  Xorg
268              server  will  die  and  drop core where the fault occurred.  The
269              default behaviour is for the Xorg server to  exit  cleanly,  but
270              still  drop  a core file.  In general you never want to use this
271              option unless you are debugging an Xorg server problem and  know
272              how to deal with the consequences.
273
274       Option "DontVTSwitch"  "boolean"
275              This  disallows  the  use  of the Ctrl+Alt+Fn sequence (where Fn
276              refers to one of the numbered function keys).  That sequence  is
277              normally used to switch to another "virtual terminal" on operat‐
278              ing systems  that  have  this  feature.   When  this  option  is
279              enabled,  that key sequence has no special meaning and is passed
280              to clients.  Default: off.
281
282       Option "DontZap"  "boolean"
283              This disallows the use of the Ctrl+Alt+Backspace sequence.  That
284              sequence  is  normally  used to terminate the Xorg server.  When
285              this option is enabled, that key sequence has no special meaning
286              and is passed to clients.  Default: off.
287
288       Option "DontZoom"  "boolean"
289              This   disallows   the   use  of  the  Ctrl+Alt+Keypad-Plus  and
290              Ctrl+Alt+Keypad-Minus sequences.  These sequences allows you  to
291              switch  between video modes.  When this option is enabled, those
292              key sequences have no special meaning and are passed to clients.
293              Default: off.
294
295       Option "DisableVidModeExtension"  "boolean"
296              This  disables  the  parts  of the VidMode extension used by the
297              xvidtune client that can be used  to  change  the  video  modes.
298              Default: the VidMode extension is enabled.
299
300       Option "AllowNonLocalXvidtune"  "boolean"
301              This  allows the xvidtune client (and other clients that use the
302              VidMode extension) to connect from another host.  Default: off.
303
304       Option "DisableModInDev"  "boolean"
305              This disables the parts of the Xorg-Misc extension that  can  be
306              used  to modify the input device settings dynamically.  Default:
307              that functionality is enabled.
308
309       Option "AllowNonLocalModInDev"  "boolean"
310              This allows a client to connect from  another  host  and  change
311              keyboard  and  mouse  settings  in the running server.  Default:
312              off.
313
314       Option "AllowMouseOpenFail"  "boolean"
315              This allows the server to start up  even  if  the  mouse  device
316              can't be opened/initialised.  Default: false.
317
318       Option "VTInit"  "command"
319              Runs  command  after  the VT used by the server has been opened.
320              The command string is passed to "/bin/sh -c", and  is  run  with
321              the  real  user's  id  with stdin and stdout set to the VT.  The
322              purpose of this option is to allow system dependent VT initiali‐
323              sation commands to be run.  This option should rarely be needed.
324              Default: not set.
325
326       Option "VTSysReq"  "boolean"
327              enables the SYSV-style VT switch sequence for  non-SYSV  systems
328              which support VT switching.  This sequence is Alt-SysRq followed
329              by a function key (Fn).  This prevents the Xorg server  trapping
330              the  keys  used  for the default VT switch sequence, which means
331              that clients can access them.  Default: off.
332
333       Option "XkbDisable" "boolean"
334              disable/enable the XKEYBOARD extension.  The  -kb  command  line
335              option  overrides  this  config  file  option.   Default: XKB is
336              enabled.
337
338       Option "BlankTime"  "time"
339              sets the inactivity  timeout  for  the  blanking  phase  of  the
340              screensaver.   time  is  in  minutes.  This is equivalent to the
341              Xorg server's `-s' flag, and the value can be  changed  at  run-
342              time with xset(1).  Default: 10 minutes.
343
344       Option "StandbyTime"  "time"
345              sets  the  inactivity  timeout  for  the "standby" phase of DPMS
346              mode.  time is in minutes, and the value can be changed at  run-
347              time  with xset(1).  Default: 20 minutes.  This is only suitable
348              for VESA DPMS compatible monitors, and may not be  supported  by
349              all video drivers.  It is only enabled for screens that have the
350              "DPMS" option set (see the MONITOR section below).
351
352       Option "SuspendTime"  "time"
353              sets the inactivity timeout for  the  "suspend"  phase  of  DPMS
354              mode.   time is in minutes, and the value can be changed at run-
355              time with xset(1).  Default: 30 minutes.  This is only  suitable
356              for  VESA  DPMS compatible monitors, and may not be supported by
357              all video drivers.  It is only enabled for screens that have the
358              "DPMS" option set (see the MONITOR section below).
359
360       Option "OffTime"  "time"
361              sets  the  inactivity  timeout for the "off" phase of DPMS mode.
362              time is in minutes, and the value can  be  changed  at  run-time
363              with  xset(1).   Default: 40 minutes.  This is only suitable for
364              VESA DPMS compatible monitors, and may not be supported  by  all
365              video  drivers.   It  is  only enabled for screens that have the
366              "DPMS" option set (see the MONITOR section below).
367
368       Option "Pixmap"  "bpp"
369              This sets the pixmap format to use for depth 24.  Allowed values
370              for  bpp  are  24 and 32.  Default: 32 unless driver constraints
371              don't allow this (which is  rare).   Note:  some  clients  don't
372              behave well when this value is set to 24.
373
374       Option "PC98"  "boolean"
375              Specify  that  the  machine  is  a Japanese PC-98 machine.  This
376              should not be enabled for anything other than the  Japanese-spe‐
377              cific PC-98 architecture.  Default: auto-detected.
378
379       Option "NoPM"  "boolean"
380              Disables something to do with power management events.  Default:
381              PM enabled on platforms that support it.
382
383       Option "Xinerama"  "boolean"
384              enable or disable XINERAMA extension. Default is disabled.
385
386       Option "AllowDeactivateGrabs" "boolean"
387              This option enables the use of  the  Ctrl+Alt+Keypad-Divide  key
388              sequence  to  deactivate  any  active  keyboard and mouse grabs.
389              Default: off.
390
391       Option "AllowClosedownGrabs" "boolean"
392              This option enables the use of the Ctrl+Alt+Keypad-Multiply  key
393              sequence  to  kill clients with an active keyboard or mouse grab
394              as well as killing any application  that  may  have  locked  the
395              server,   normally   using  the  XGrabServer(3)  Xlib  function.
396              Default: off.
397              Note that the options AllowDeactivateGrabs  and  AllowClosedown‐
398              Grabs  will  allow  users  to  remove  the  grab  used by screen
399              saver/locker programs.  An API was written to such cases. If you
400              enable  this  option,  make  sure  your  screen  saver/locker is
401              updated.
402
403       Option "HandleSpecialKeys" "when"
404              This option controls when the server uses the builtin handler to
405              process  special  key combinations (such as Ctrl+Alt+Backspace).
406              Normally the XKEYBOARD extension keymaps will  provide  mappings
407              for each of the special key combinations, so the builtin handler
408              is not needed unless the XKEYBOARD extension is  disabled.   The
409              value of when can be Always, Never, or WhenNeeded.  Default: Use
410              the builtin handler only if needed.  The server  will  scan  the
411              keymap  for a mapping to the Terminate action and, if found, use
412              XKEYBOARD for processing actions, otherwise the builtin  handler
413              will be used.
414
415       Option "AIGLX" "boolean"
416              enable or disable AIGLX. AIGLX is enabled by default.
417
418       Option "IgnoreABI" "boolean"
419              Allow  modules  built  for a different, potentially incompatible
420              version of the X server to load. Disabled by default.
421

MODULE SECTION

423       The Module section is used to specify which Xorg server modules  should
424       be  loaded.   This  section is ignored when the Xorg server is built in
425       static form.  The types of modules normally loaded in this section  are
426       Xorg server extension modules, and font rasteriser modules.  Most other
427       module types are loaded automatically when they are  needed  via  other
428       mechanisms.   The Module section is optional, as are all of the entries
429       that may be specified in it.
430
431       Entries in this section may be in two forms.   The first and most  com‐
432       monly  used  form  is an entry that uses the Load keyword, as described
433       here:
434
435       Load  "modulename"
436              This instructs the server to load the module called  modulename.
437              The  module name given should be the module's standard name, not
438              the module file name.  The standard name is case-sensitive,  and
439              does  not  include the "lib" prefix, or the ".a", ".o", or ".so"
440              suffixes.
441
442              Example: the Type 1 font rasteriser can be loaded with the  fol‐
443              lowing entry:
444
445                  Load "type1"
446
447       The  second  form  of  entry  is a SubSection, with the subsection name
448       being the module name, and the contents of the SubSection being Options
449       that are passed to the module when it is loaded.
450
451       Example:  the  extmod  module  (which contains a miscellaneous group of
452       server extensions) can be loaded, with the XFree86-DGA  extension  dis‐
453       abled by using the following entry:
454
455           SubSection "extmod"
456              Option  "omit XFree86-DGA"
457           EndSubSection
458
459       Modules  are searched for in each directory specified in the ModulePath
460       search path, and in the drivers, input, extensions, fonts, and internal
461       subdirectories  of  each  of  those  directories.  In addition to this,
462       operating system specific subdirectories of all the above are  searched
463       first if they exist.
464
465       To  see  what  font and extension modules are available, check the con‐
466       tents of the following directories:
467
468           /usr/lib/modules/fonts
469           /usr/lib/modules/extensions
470
471       The "bitmap" font modules is loaded automatically.  It  is  recommended
472       that  at  very  least  the  "extmod" extension module be loaded.  If it
473       isn't some commonly used server extensions (like the  SHAPE  extension)
474       will not be available.
475

INPUTDEVICE SECTION

477       The  config  file  may  have multiple InputDevice sections.  There will
478       normally be at least two: one for the core (primary) keyboard, and  one
479       of the core pointer.  If either of these two is missing, a default con‐
480       figuration for the missing ones will be used.   Currently  the  default
481       configuration may not work as expected on all platforms.
482
483       InputDevice sections have the following format:
484
485           Section "InputDevice"
486               Identifier "name"
487               Driver     "inputdriver"
488               options
489               ...
490           EndSection
491
492       The  Identifier and Driver entries are required in all InputDevice sec‐
493       tions.  All other entries are optional.
494
495       The Identifier entry specifies the unique name for this  input  device.
496       The Driver entry specifies the name of the driver to use for this input
497       device.  When using  the  loadable  server,  the  input  driver  module
498       "inputdriver"  will  be loaded for each active InputDevice section.  An
499       InputDevice section is considered active if  it  is  referenced  by  an
500       active  ServerLayout  section,  if it is referenced by the -keyboard or
501       -pointer command line options, or if it is selected implicitly  as  the
502       core  pointer or keyboard device in the absence of such explicit refer‐
503       ences.  The  most  commonly  used  input  drivers  are  "keyboard"  and
504       "mouse".
505
506       In  the absence of an explicitly specified core input device, the first
507       InputDevice marked as CorePointer (or CoreKeyboard) is used.  If  there
508       is  no  match  there,  the  first InputDevice that uses the "mouse" (or
509       "keyboard" or "kbd") driver is used.  The  final  fallback  is  to  use
510       built-in default configurations.
511
512       InputDevice  sections  recognise some driver-independent Options, which
513       are described here.  See the individual input driver manual pages for a
514       description of the device-specific options.
515
516       Option "CorePointer"
517              When  this  is  set,  the  input device is installed as the core
518              (primary) pointer  device.   There  must  be  exactly  one  core
519              pointer.  If this option is not set here, or in the ServerLayout
520              section, or from the -pointer  command  line  option,  then  the
521              first  input  device  that  is  capable  of being used as a core
522              pointer will be selected as the core pointer.   This  option  is
523              implicitly set when the obsolete Pointer section is used.
524
525       Option "CoreKeyboard"
526              When  this  is  set,  the input device is to be installed as the
527              core (primary) keyboard device.  There must be exactly one  core
528              keyboard.   If  this option is not set here, in the ServerLayout
529              section, or from the -keyboard command  line  option,  then  the
530              first  input device that is capable of being used as a core key‐
531              board will be selected as the core  keyboard.   This  option  is
532              implicitly set when the obsolete Keyboard section is used.
533
534       Option "AlwaysCore"  "boolean"
535
536       Option "SendCoreEvents"  "boolean"
537              Both of these options are equivalent, and when enabled cause the
538              input device to always report core events.  This  can  be  used,
539              for  example,  to allow an additional pointer device to generate
540              core pointer events (like moving the cursor, etc).
541
542       Option "HistorySize"  "number"
543           Sets the motion history size.  Default: 0.
544
545       Option "SendDragEvents"  "boolean"
546              ???
547

DEVICE SECTION

549       The config file may have multiple Device sections.  There  must  be  at
550       least one, for the video card being used.
551
552       Device sections have the following format:
553
554           Section "Device"
555               Identifier "name"
556               Driver     "driver"
557               entries
558               ...
559           EndSection
560
561       The  Identifier and Driver entries are required in all Device sections.
562       All other entries are optional.
563
564       The Identifier entry  specifies  the  unique  name  for  this  graphics
565       device.   The  Driver entry specifies the name of the driver to use for
566       this graphics device.  When using the loadable server, the driver  mod‐
567       ule  "driver"  will be loaded for each active Device section.  A Device
568       section is considered active if it is referenced by  an  active  Screen
569       section.
570
571       Device  sections recognise some driver-independent entries and Options,
572       which are described here.  Not all drivers make use  of  these  driver-
573       independent entries, and many of those that do don't require them to be
574       specified because the information is auto-detected.  See the individual
575       graphics  driver  manual  pages for further information about this, and
576       for a description of the device-specific options.  Note  that  most  of
577       the Options listed here (but not the other entries) may be specified in
578       the Screen section instead of here in the Device section.
579
580       BusID  "bus-id"
581              This specifies the bus  location  of  the  graphics  card.   For
582              PCI/AGP    cards,    the    bus-id    string    has   the   form
583              PCI:bus:device:function (e.g., "PCI:1:0:0" might be  appropriate
584              for an AGP card).  This field is usually optional in single-head
585              configurations when using the primary graphics card.  In  multi-
586              head  configurations, or when using a secondary graphics card in
587              a single-head configuration, this entry is mandatory.  Its  main
588              purpose  is to make an unambiguous connection between the device
589              section and the hardware it is representing.   This  information
590              can  usually be found by running the Xorg server with the -scan‐
591              pci command line option.
592
593       Screen  number
594              This option is mandatory for cards where a single PCI entity can
595              drive more than one display (i.e., multiple CRTCs sharing a sin‐
596              gle graphics accelerator and video memory).  One Device  section
597              is  required  for each head, and this parameter determines which
598              head each of the Device sections applies to.  The  legal  values
599              of  number  range  from  0  to one less than the total number of
600              heads per entity.  Most drivers require that the primary  screen
601              (0) be present.
602
603       Chipset  "chipset"
604              This  usually  optional  entry specifies the chipset used on the
605              graphics board.  In  most  cases  this  entry  is  not  required
606              because  the  drivers  will  probe the hardware to determine the
607              chipset type.  Don't specify it unless the driver-specific docu‐
608              mentation recommends that you do.
609
610       Ramdac  "ramdac-type"
611              This  optional  entry  specifies  the type of RAMDAC used on the
612              graphics board.  This is only used by a few of the drivers,  and
613              in  most cases it is not required because the drivers will probe
614              the hardware to determine the RAMDAC type where possible.  Don't
615              specify  it  unless the driver-specific documentation recommends
616              that you do.
617
618       DacSpeed  speed
619
620       DacSpeed  speed-8 speed-16 speed-24 speed-32
621              This optional entry specifies the RAMDAC speed rating (which  is
622              usually printed on the RAMDAC chip).  The speed is in MHz.  When
623              one value is given, it applies to all framebuffer  pixel  sizes.
624              When  multiple  values  are  give, they apply to the framebuffer
625              pixel sizes 8, 16, 24 and 32 respectively.  This is not used  by
626              many drivers, and only needs to be specified when the speed rat‐
627              ing of the RAMDAC is different from the  defaults  built  in  to
628              driver,  or  when  the  driver  can't  auto-detect  the  correct
629              defaults.  Don't specify it unless the driver-specific  documen‐
630              tation recommends that you do.
631
632       Clocks  clock ...
633              specifies the pixel that are on your graphics board.  The clocks
634              are in MHz, and may be specified as  a  floating  point  number.
635              The value is stored internally to the nearest kHz.  The ordering
636              of the clocks is important.  It must match the  order  in  which
637              they  are selected on the graphics board.  Multiple Clocks lines
638              may be specified, and each is concatenated  to  form  the  list.
639              Most  drivers do not use this entry, and it is only required for
640              some older boards with non-programmable clocks.   Don't  specify
641              this  entry  unless the driver-specific documentation explicitly
642              recommends that you do.
643
644       ClockChip  "clockchip-type"
645              This optional entry is used to specify the clock  chip  type  on
646              graphics boards which have a programmable clock generator.  Only
647              a few  Xorg  drivers  support  programmable  clock  chips.   For
648              details, see the appropriate driver manual page.
649
650       VideoRam  mem
651              This  optional  entry  specifies the amount of video ram that is
652              installed on the graphics board. This is measured in kBytes.  In
653              most  cases  this is not required because the Xorg server probes
654              the graphics board to determine this quantity.  The  driver-spe‐
655              cific documentation should indicate when it might be needed.
656
657       BiosBase  baseaddress
658              This optional entry specifies the base address of the video BIOS
659              for the VGA board.  This address is normally auto-detected,  and
660              should  only  be  specified if the driver-specific documentation
661              recommends it.
662
663       MemBase  baseaddress
664              This optional entry specifies  the  memory  base  address  of  a
665              graphics board's linear frame buffer.  This entry is not used by
666              many drivers, and it should only be specified if the driver-spe‐
667              cific documentation recommends it.
668
669       IOBase  baseaddress
670              This  optional  entry specifies the IO base address.  This entry
671              is not used by many drivers, and it should only be specified  if
672              the driver-specific documentation recommends it.
673
674       ChipID  id
675              This  optional  entry  specifies a numerical ID representing the
676              chip type.  For PCI cards, it is usually the  device  ID.   This
677              can be used to override the auto-detection, but that should only
678              be done when the driver-specific documentation recommends it.
679
680       ChipRev  rev
681              This optional entry specifies the chip  revision  number.   This
682              can be used to override the auto-detection, but that should only
683              be done when the driver-specific documentation recommends it.
684
685       TextClockFreq  freq
686              This optional entry specifies the pixel clock frequency that  is
687              used  for  the regular text mode.  The frequency is specified in
688              MHz.  This is rarely used.
689
690       Options
691              Option flags may be specified in  the  Device  sections.   These
692              include  driver-specific options and driver-independent options.
693              The former are described in the  driver-specific  documentation.
694              Some  of the latter are described below in the section about the
695              Screen section, and they may also be included here.
696
697

VIDEOADAPTOR SECTION

699       Nobody wants to say how this works.  Maybe nobody knows ...
700
701

MONITOR SECTION

703       The config file may have multiple Monitor sections.  There should  nor‐
704       mally  be  at least one, for the monitor being used, but a default con‐
705       figuration will be created when one isn't specified.
706
707       Monitor sections have the following format:
708
709           Section "Monitor"
710               Identifier "name"
711               entries
712               ...
713           EndSection
714
715       The only mandatory entry in a Monitor section is the Identifier entry.
716
717       The Identifier entry specifies the unique name for this  monitor.   The
718       Monitor  section  provides  information about the specifications of the
719       monitor, monitor-specific Options,  and  information  about  the  video
720       modes  to  use  with  the  monitor.  Specifying video modes is optional
721       because the server now has a built-in  list  of  VESA  standard  modes.
722       When  modes  are  specified explicitly in the Monitor section (with the
723       Modes, ModeLine, or UseModes keywords), built-in modes  with  the  same
724       names  are not included.  Built-in modes with different names are, how‐
725       ever, still implicitly included.
726
727       The entries that may be used in Monitor sections are described below.
728
729       VendorName  "vendor"
730              This optional entry specifies the monitor's manufacturer.
731
732       ModelName  "model"
733              This optional entry specifies the monitor's model.
734
735       HorizSync  horizsync-range
736              gives the range(s) of horizontal sync frequencies  supported  by
737              the  monitor.   horizsync-range may be a comma separated list of
738              either discrete values or ranges of values.  A range  of  values
739              is two values separated by a dash.  By default the values are in
740              units of kHz.  They may be specified in MHz or Hz if MHz  or  Hz
741              is added to the end of the line.  The data given here is used by
742              the Xorg server to determine if video modes are within the spec‐
743              ifications of the monitor.  This information should be available
744              in the monitor's handbook.  If this entry is omitted, a  default
745              range of 28-33kHz is used.
746
747       VertRefresh  vertrefresh-range
748              gives  the range(s) of vertical refresh frequencies supported by
749              the monitor.  vertrefresh-range may be a comma separated list of
750              either  discrete  values or ranges of values.  A range of values
751              is two values separated by a dash.  By default the values are in
752              units  of Hz.  They may be specified in MHz or kHz if MHz or kHz
753              is added to the end of the line.  The data given here is used by
754              the Xorg server to determine if video modes are within the spec‐
755              ifications of the monitor.  This information should be available
756              in  the monitor's handbook.  If this entry is omitted, a default
757              range of 43-72Hz is used.
758
759       DisplaySize  width height
760              This optional entry gives the width and height, in  millimetres,
761              of  the  picture  area  of the monitor. If given this is used to
762              calculate the horizontal and vertical pitch (DPI) of the screen.
763
764       Gamma  gamma-value
765
766       Gamma  red-gamma green-gamma blue-gamma
767              This is an optional entry that can be used to specify the  gamma
768              correction  for  the  monitor.   It may be specified as either a
769              single value or as three separate RGB values.  The values should
770              be  in  the  range 0.1 to 10.0, and the default is 1.0.  Not all
771              drivers are capable of using this information.
772
773       UseModes  "modesection-id"
774              Include the set of modes listed in the Modes section called mod‐
775              esection-id.  This make all of the modes defined in that section
776              available for use by this monitor.
777
778       Mode  "name"
779              This is an optional multi-line entry that can be used to provide
780              definitions for video modes for the monitor.  In most cases this
781              isn't necessary because the built-in set of VESA standard  modes
782              will  be  sufficient.  The Mode keyword indicates the start of a
783              multi-line video mode description.  The mode description is ter‐
784              minated with the EndMode keyword.  The mode description consists
785              of the following entries:
786
787              DotClock  clock
788                  is the dot (pixel) clock rate to be used for the mode.
789
790              HTimings  hdisp hsyncstart hsyncend htotal
791                  specifies the horizontal timings for the mode.
792
793              VTimings  vdisp vsyncstart vsyncend vtotal
794                  specifies the vertical timings for the mode.
795
796              Flags  "flag" ...
797                  specifies an optional set of mode flags, each of which is  a
798                  separate  string  in  double  quotes.  "Interlace" indicates
799                  that the mode is interlaced.  "DoubleScan" indicates a  mode
800                  where  each  scanline is doubled.  "+HSync" and "-HSync" can
801                  be  used  to  select  the  polarity  of  the  HSync  signal.
802                  "+VSync"  and "-VSync" can be used to select the polarity of
803                  the VSync signal.  "Composite" can be used to  specify  com‐
804                  posite  sync on hardware where this is supported.  Addition‐
805                  ally, on some hardware, "+CSync" and "-CSync" may be used to
806                  select the composite sync polarity.
807
808              HSkew  hskew
809                  specifies  the  number  of pixels (towards the right edge of
810                  the screen) by which the display  enable  signal  is  to  be
811                  skewed.   Not all drivers use this information.  This option
812                  might become necessary to override the  default  value  sup‐
813                  plied  by  the  server  (if any).  "Roving" horizontal lines
814                  indicate this value needs to be increased.  If the last  few
815                  pixels on a scan line appear on the left of the screen, this
816                  value should be decreased.
817
818              VScan  vscan
819                  specifies the number of times each scanline  is  painted  on
820                  the  screen.   Not all drivers use this information.  Values
821                  less than 1 are treated as 1, which is the default.   Gener‐
822                  ally,  the  "DoubleScan"  Flag  mentioned above doubles this
823                  value.
824
825       ModeLine  "name" mode-description
826              This entry is a more compact version of the Mode entry,  and  it
827              also  can  be used to specify video modes for the monitor.  is a
828              single line format for specifying video modes.   In  most  cases
829              this  isn't  necessary because the built-in set of VESA standard
830              modes will be sufficient.
831
832              The mode-description is in four sections,  the  first  three  of
833              which  are mandatory.  The first is the dot (pixel) clock.  This
834              is a single number specifying the pixel clock rate for the  mode
835              in MHz.  The second section is a list of four numbers specifying
836              the horizontal timings.  These numbers  are  the  hdisp,  hsync‐
837              start, hsyncend, and htotal values.  The third section is a list
838              of four numbers specifying the vertical timings.  These  numbers
839              are  the  vdisp,  vsyncstart,  vsyncend, and vtotal values.  The
840              final section is a list of flags specifying  other  characteris‐
841              tics  of  the mode.  Interlace indicates that the mode is inter‐
842              laced.  DoubleScan indicates a mode where each scanline is  dou‐
843              bled.   +HSync  and -HSync can be used to select the polarity of
844              the HSync signal.  +VSync and -VSync can be used to  select  the
845              polarity  of the VSync signal.  Composite can be used to specify
846              composite sync on hardware where this is  supported.   Addition‐
847              ally,  on some hardware, +CSync and -CSync may be used to select
848              the composite sync polarity.  The HSkew and VScan  options  men‐
849              tioned  above  in  the  Modes entry description can also be used
850              here.
851
852       Option "DPMS"  "bool"
853              This option controls whether the server should enable  the  DPMS
854              extension  for power management for this screen.  The default is
855              to enable the extension.
856
857       Option "SyncOnGreen"  "bool"
858              This option controls whether the video  card  should  drive  the
859              sync  signal on the green color pin.  Not all cards support this
860              option, and most monitors do not require  it.   The  default  is
861              off.
862
863       Option "TargetRefresh"  "rate"
864              This optional entry specifies the vertical refresh rate that the
865              server should aim for when selecting video modes.  Without  this
866              option,  the  default  is  to  prefer  modes with higher refresh
867              rates.
868
869

MODES SECTION

871       The config file may have multiple Modes sections, or none.  These  sec‐
872       tions  provide  a  way of defining sets of video modes independently of
873       the Monitor sections.  Monitor sections  may  include  the  definitions
874       provided  in  these  sections  by  using the UseModes keyword.  In most
875       cases the Modes sections are not necessary because the built-in set  of
876       VESA standard modes will be sufficient.
877
878       Modes sections have the following format:
879
880           Section "Modes"
881               Identifier "name"
882               entries
883               ...
884           EndSection
885
886       The  Identifier  entry  specifies  the unique name for this set of mode
887       descriptions.  The other entries permitted in Modes  sections  are  the
888       Mode  and ModeLine entries that are described above in the Monitor sec‐
889       tion.
890

SCREEN SECTION

892       The config file may have multiple Screen sections.  There  must  be  at
893       least  one,  for  the  "screen"  being used.  A "screen" represents the
894       binding of a graphics device (Device section) and  a  monitor  (Monitor
895       section).   A Screen section is considered "active" if it is referenced
896       by an active ServerLayout  section  or  by  the  -screen  command  line
897       option.  If neither of those is present, the first Screen section found
898       in the config file is considered the active one.
899
900       Screen sections have the following format:
901
902           Section "Screen"
903               Identifier "name"
904               Device     "devid"
905               Monitor    "monid"
906               entries
907               ...
908               SubSection "Display"
909                  entries
910                  ...
911               EndSubSection
912               ...
913           EndSection
914
915       The Identifier and  Device  entries  are  mandatory.   All  others  are
916       optional.
917
918       The  Identifier  entry  specifies the unique name for this screen.  The
919       Screen section provides  information  specific  to  the  whole  screen,
920       including screen-specific Options.  In multi-head configurations, there
921       will be multiple active  Screen  sections,  one  for  each  head.   The
922       entries available for this section are:
923
924       Device  "device-id"
925              This mandatory entry specifies the Device section to be used for
926              this screen.  This is what ties a specific graphics  card  to  a
927              screen.   The  device-id  must  match the Identifier of a Device
928              section in the config file.
929
930       Monitor  "monitor-id"
931              specifies which monitor description  is  to  be  used  for  this
932              screen.   If a Monitor name is not specified, a default configu‐
933              ration is used.  Currently the  default  configuration  may  not
934              function as expected on all platforms.
935
936       VideoAdaptor  "xv-id"
937              specifies  an  optional  Xv video adaptor description to be used
938              with this screen.
939
940       DefaultDepth  depth
941              specifies which color depth the server should  use  by  default.
942              The -depth command line option can be used to override this.  If
943              neither is specified, the default depth is driver-specific,  but
944              in most cases is 8.
945
946       DefaultFbBpp  bpp
947              specifies  which  framebuffer  layout  to  use  by default.  The
948              -fbbpp command line option can be used  to  override  this.   In
949              most  cases  the  driver  will  chose the best default value for
950              this.  The only case where there is even a choice in this  value
951              is  for  depth 24, where some hardware supports both a packed 24
952              bit framebuffer layout and a sparse 32 bit framebuffer layout.
953
954       Options
955              Various Option flags may be specified  in  the  Screen  section.
956              Some  are  driver-specific and are described in the driver docu‐
957              mentation.  Others are driver-independent, and  will  eventually
958              be described here.
959
960       Option "Accel"
961              Enables  XAA  (X  Acceleration  Architecture),  a mechanism that
962              makes video cards' 2D hardware  acceleration  available  to  the
963              Xorg server.  This option is on by default, but it may be neces‐
964              sary to turn it off if there are bugs in the driver.  There  are
965              many  options to disable specific accelerated operations, listed
966              below.  Note that disabling an operation will have no effect  if
967              the operation is not accelerated (whether due to lack of support
968              in the hardware or in the driver).
969
970       Option "BiosLocation" "address"
971              Set the location of the BIOS  for  the  Int10  module.  One  may
972              select  a  BIOS of another card for posting or the legacy V_BIOS
973              range located at 0xc0000 or an  alternative  address  (BUS_ISA).
974              This  is only useful under very special circumstances and should
975              be used with extreme care.
976
977       Option "InitPrimary" "boolean"
978              Use the Int10 module to initialize the  primary  graphics  card.
979              Normally,  only  secondary cards are soft-booted using the Int10
980              module, as the primary card has already been initialized by  the
981              BIOS at boot time.  Default: false.
982
983       Option "NoInt10" "boolean"
984              Disables  the Int10 module, a module that uses the int10 call to
985              the BIOS of the graphics card to initialize it. Default: false.
986
987       Option "NoMTRR"
988              Disables MTRR (Memory Type Range Register) support, a feature of
989              modern  processors which can improve video performance by a fac‐
990              tor of up to 2.5.  Some hardware has  buggy  MTRR  support,  and
991              some  video  drivers  have  been  known to exhibit problems when
992              MTRR's are used.
993
994       Option "XaaNoCPUToScreenColorExpandFill"
995              Disables accelerated rectangular  expansion  blits  from  source
996              patterns  stored  in  system memory (using a memory-mapped aper‐
997              ture).
998
999       Option "XaaNoColor8x8PatternFillRect"
1000              Disables accelerated fills of a rectangular region with a  full-
1001              color pattern.
1002
1003       Option "XaaNoColor8x8PatternFillTrap"
1004              Disables  accelerated fills of a trapezoidal region with a full-
1005              color pattern.
1006
1007       Option "XaaNoDashedBresenhamLine"
1008              Disables accelerated dashed Bresenham line draws.
1009
1010       Option "XaaNoDashedTwoPointLine"
1011              Disables accelerated dashed line  draws  between  two  arbitrary
1012              points.
1013
1014       Option "XaaNoImageWriteRect"
1015              Disables  accelerated  transfers  of full-color rectangular pat‐
1016              terns from system memory to video memory (using a  memory-mapped
1017              aperture).
1018
1019       Option "XaaNoMono8x8PatternFillRect"
1020              Disables  accelerated fills of a rectangular region with a mono‐
1021              chrome pattern.
1022
1023       Option "XaaNoMono8x8PatternFillTrap"
1024              Disables accelerated fills of a trapezoidal region with a  mono‐
1025              chrome pattern.
1026
1027       Option "XaaNoOffscreenPixmaps"
1028              Disables  accelerated  draws  into  pixmaps  stored in offscreen
1029              video memory.
1030
1031       Option "XaaNoPixmapCache"
1032              Disables caching of patterns in offscreen video memory.
1033
1034       Option "XaaNoScanlineCPUToScreenColorExpandFill"
1035              Disables accelerated rectangular  expansion  blits  from  source
1036              patterns stored in system memory (one scan line at a time).
1037
1038       Option "XaaNoScanlineImageWriteRect"
1039              Disables  accelerated  transfers  of full-color rectangular pat‐
1040              terns from system memory to video memory (one  scan  line  at  a
1041              time).
1042
1043       Option "XaaNoScreenToScreenColorExpandFill"
1044              Disables  accelerated  rectangular  expansion  blits from source
1045              patterns stored in offscreen video memory.
1046
1047       Option "XaaNoScreenToScreenCopy"
1048              Disables accelerated copies of rectangular regions from one part
1049              of video memory to another part of video memory.
1050
1051       Option "XaaNoSolidBresenhamLine"
1052              Disables accelerated solid Bresenham line draws.
1053
1054       Option "XaaNoSolidFillRect"
1055              Disables accelerated solid-color fills of rectangles.
1056
1057       Option "XaaNoSolidFillTrap"
1058              Disables accelerated solid-color fills of Bresenham trapezoids.
1059
1060       Option "XaaNoSolidHorVertLine"
1061              Disables accelerated solid horizontal and vertical line draws.
1062
1063       Option "XaaNoSolidTwoPointLine"
1064              Disables  accelerated  solid  line  draws  between two arbitrary
1065              points.
1066
1067       Each Screen section may optionally contain one or more Display  subsec‐
1068       tions.   Those  subsections  provide depth/fbbpp specific configuration
1069       information, and the one chosen depends on the depth and/or fbbpp  that
1070       is  being  used  for  the  screen.   The  Display  subsection format is
1071       described in the section below.
1072
1073

DISPLAY SUBSECTION

1075       Each  Screen  section  may  have  multiple  Display  subsections.   The
1076       "active"  Display subsection is the first that matches the depth and/or
1077       fbbpp values being used, or failing that, the first that has neither  a
1078       depth  or fbbpp value specified.  The Display subsections are optional.
1079       When there isn't one that matches the depth and/or fbbpp  values  being
1080       used,  all the parameters that can be specified here fall back to their
1081       defaults.
1082
1083       Display subsections have the following format:
1084
1085               SubSection "Display"
1086                   Depth  depth
1087                   entries
1088                   ...
1089               EndSubSection
1090
1091       Depth  depth
1092              This entry specifies what colour depth the Display subsection is
1093              to  be used for.  This entry is usually specified, but it may be
1094              omitted to create a match-all Display subsection or when wishing
1095              to  match  only against the FbBpp parameter.  The range of depth
1096              values that are allowed depends on the driver.  Most driver sup‐
1097              port  8,  15, 16 and 24.  Some also support 1 and/or 4, and some
1098              may support other values (like 30).  Note: depth means the  num‐
1099              ber  of  bits in a pixel that are actually used to determine the
1100              pixel colour.  32 is not a valid  depth  value.   Most  hardware
1101              that  uses  32  bits  per pixel only uses 24 of them to hold the
1102              colour information, which means that the colour depth is 24, not
1103              32.
1104
1105       FbBpp  bpp
1106              This entry specifies the framebuffer format this Display subsec‐
1107              tion is to be used for.  This entry is only needed when  provid‐
1108              ing depth 24 configurations that allow a choice between a 24 bpp
1109              packed framebuffer format and a 32bpp sparse framebuffer format.
1110              In most cases this entry should not be used.
1111
1112       Weight  red-weight green-weight blue-weight
1113              This  optional  entry specifies the relative RGB weighting to be
1114              used for a screen is being used at depth  16  for  drivers  that
1115              allow  multiple  formats.   This  may also be specified from the
1116              command line with the -weight option (see Xorg(1)).
1117
1118       Virtual  xdim ydim
1119              This optional entry specifies the virtual screen  resolution  to
1120              be  used.   xdim  must  be a multiple of either 8 or 16 for most
1121              drivers, and a multiple of 32 when running in  monochrome  mode.
1122              The  given  value  will be rounded down if this is not the case.
1123              Video modes which are too large for the specified  virtual  size
1124              will  be  rejected.   If  this entry is not present, the virtual
1125              screen resolution will be set to accommodate all the valid video
1126              modes  given in the Modes entry.  Some drivers/hardware combina‐
1127              tions do not support virtual screens.  Refer to the  appropriate
1128              driver-specific documentation for details.
1129
1130       ViewPort  x0 y0
1131              This  optional  entry  sets the upper left corner of the initial
1132              display.  This is only relevant when the virtual screen  resolu‐
1133              tion is different from the resolution of the initial video mode.
1134              If this entry is not given, then the  initial  display  will  be
1135              centered in the virtual display area.
1136
1137       Modes  "mode-name" ...
1138              This  optional  entry  specifies the list of video modes to use.
1139              Each mode-name specified must be in double  quotes.   They  must
1140              correspond  to  those specified or referenced in the appropriate
1141              Monitor section (including implicitly referenced  built-in  VESA
1142              standard  modes).   The  server will delete modes from this list
1143              which don't satisfy various requirements.  The first valid  mode
1144              in  this list will be the default display mode for startup.  The
1145              list of valid modes is  converted  internally  into  a  circular
1146              list.    It  is  possible  to  switch  to  the  next  mode  with
1147              Ctrl+Alt+Keypad-Plus and to the previous mode with Ctrl+Alt+Key‐
1148              pad-Minus.   When  this entry is omitted, the valid modes refer‐
1149              enced by the appropriate Monitor section will be used.   If  the
1150              Monitor  section  contains  no modes, then the selection will be
1151              taken from the built-in VESA standard modes.
1152
1153       Visual  "visual-name"
1154              This optional entry sets the default root visual type.  This may
1155              also  be specified from the command line (see the Xserver(1) man
1156              page).  The visual types available for depth 8 are  (default  is
1157              PseudoColor):
1158
1159                  StaticGray
1160                  GrayScale
1161                  StaticColor
1162                  PseudoColor
1163                  TrueColor
1164                  DirectColor
1165
1166              The  visual  type  available  for  the  depths 15, 16 and 24 are
1167              (default is TrueColor):
1168
1169                  TrueColor
1170                  DirectColor
1171
1172              Not all drivers support DirectColor at these depths.
1173
1174              The visual types available for the depth 4 are (default is Stat‐
1175              icColor):
1176
1177                  StaticGray
1178                  GrayScale
1179                  StaticColor
1180                  PseudoColor
1181
1182              The  visual type available for the depth 1 (monochrome) is Stat‐
1183              icGray.
1184
1185       Black  red green blue
1186              This optional entry allows the "black" colour to  be  specified.
1187              This is only supported at depth 1.  The default is black.
1188
1189       White  red green blue
1190              This  optional  entry allows the "white" colour to be specified.
1191              This is only supported at depth 1.  The default is white.
1192
1193       Options
1194              Option flags may be specified in the Display subsections.  These
1195              may   include  driver-specific  options  and  driver-independent
1196              options.  The former are described in the driver-specific  docu‐
1197              mentation.   Some  of the latter are described above in the sec‐
1198              tion about the Screen section, and they  may  also  be  included
1199              here.
1200

SERVERLAYOUT SECTION

1202       The  config  file  may  have multiple ServerLayout sections.  A "server
1203       layout" represents the binding of one or more screens (Screen sections)
1204       and one or more input devices (InputDevice sections) to form a complete
1205       configuration.  In multi-head configurations,  it  also  specifies  the
1206       relative  layout  of  the  heads.  A ServerLayout section is considered
1207       "active" if it is referenced by the -layout command line option  or  by
1208       an  Option  "DefaultServerLayout" entry in the ServerFlags section (the
1209       former takes precedence over the latter).  If  those  options  are  not
1210       used,  the  first ServerLayout section found in the config file is con‐
1211       sidered the active one.  If no ServerLayout sections are  present,  the
1212       single  active  screen and two active (core) input devices are selected
1213       as described in the relevant sections above.
1214
1215       ServerLayout sections have the following format:
1216
1217           Section "ServerLayout"
1218               Identifier   "name"
1219               Screen       "screen-id"
1220               ...
1221               InputDevice  "idev-id"
1222               ...
1223               options
1224               ...
1225           EndSection
1226
1227       Each ServerLayout section must have an Identifier entry  and  at  least
1228       one Screen entry.
1229
1230       The  Identifier entry specifies the unique name for this server layout.
1231       The ServerLayout section provides information  specific  to  the  whole
1232       session,  including  session-specific Options.  The ServerFlags options
1233       (described above) may be specified here, and ones given  here  override
1234       those given in the ServerFlags section.
1235
1236       The entries that may be used in this section are described here.
1237
1238       Screen  screen-num "screen-id" position-information
1239              One of these entries must be given for each screen being used in
1240              a session.  The screen-id field is mandatory, and specifies  the
1241              Screen  section  being  referenced.   The  screen-num  field  is
1242              optional, and may be used to specify the screen number in multi-
1243              head  configurations.   When  this field is omitted, the screens
1244              will be numbered in the order that they are listed in.  The num‐
1245              bering  starts  from  0, and must be consecutive.  The position-
1246              information field describes the way multiple screens  are  posi‐
1247              tioned.  There are a number of different ways that this informa‐
1248              tion can be provided:
1249
1250              x y
1251
1252              Absolute  x y
1253                  These both specify that the upper left corner's  coordinates
1254                  are  (x,y).   The  Absolute keyword is optional.  Some older
1255                  versions of Xorg (4.2 and earlier) don't recognise the Abso‐
1256                  lute keyword, so it's safest to just specify the coordinates
1257                  without it.
1258
1259              RightOf   "screen-id"
1260
1261              LeftOf    "screen-id"
1262
1263              Above     "screen-id"
1264
1265              Below     "screen-id"
1266
1267              Relative  "screen-id" x y
1268                  These give the screen's location relative to another screen.
1269                  The first four position the screen immediately to the right,
1270                  left, above or below the other screen.  When positioning  to
1271                  the  right  or  left, the top edges are aligned.  When posi‐
1272                  tioning above or below, the left  edges  are  aligned.   The
1273                  Relative  form  specifies  the offset of the screen's origin
1274                  (upper left  corner)  relative  to  the  origin  of  another
1275                  screen.
1276
1277       InputDevice  "idev-id" "option" ...
1278              One of these entries should be given for each input device being
1279              used in a session.  Normally at least two are required, one each
1280              for  the  core pointer and keyboard devices.  If either of those
1281              is missing, suitable InputDevice entries are searched for  using
1282              the  method  described  above  in  the INPUTDEVICE section.  The
1283              idev-id field is mandatory, and specifies the name of the Input‐
1284              Device  section being referenced.  Multiple option fields may be
1285              specified, each in double quotes.  The  options  permitted  here
1286              are  any  that  may  also  be given in the InputDevice sections.
1287              Normally only session-specific input  device  options  would  be
1288              used here.  The most commonly used options are:
1289
1290                  "CorePointer"
1291                  "CoreKeyboard"
1292                  "SendCoreEvents"
1293
1294              and  the  first two should normally be used to indicate the core
1295              pointer and core keyboard devices respectively.
1296
1297       Options
1298              In addition to  the  following,  any  option  permitted  in  the
1299              ServerFlags  section  may also be specified here.  When the same
1300              option appears in both places, the value  given  here  overrides
1301              the one given in the ServerFlags section.
1302
1303       Option "IsolateDevice"  "bus-id"
1304              Restrict  device  resets to the specified bus-id.  See the BusID
1305              option (described in DEVICE SECTION, above) for  the  format  of
1306              the  bus-id  parameter.   This  option  overrides SingleCard, if
1307              specified.  At present, only PCI devices can be isolated in this
1308              manner.
1309
1310       Option "SingleCard"  "boolean"
1311              As  IsolateDevice, except that the bus ID of the first device in
1312              the layout is used.
1313
1314       Here is an example of a ServerLayout section for a dual headed configu‐
1315       ration with two mice:
1316
1317           Section "ServerLayout"
1318               Identifier  "Layout 1"
1319               Screen      "MGA 1"
1320               Screen      "MGA 2" RightOf "MGA 1"
1321               InputDevice "Keyboard 1" "CoreKeyboard"
1322               InputDevice "Mouse 1"    "CorePointer"
1323               InputDevice "Mouse 2"    "SendCoreEvents"
1324               Option      "BlankTime"  "5"
1325           EndSection
1326

DRI SECTION

1328       This  optional  section  is  used  to  provide some information for the
1329       Direct Rendering Infrastructure.  Details about the format of this sec‐
1330       tion can be found on-line at <http://dri.freedesktop.org/>.
1331

VENDOR SECTION

1333       The optional Vendor section may be used to provide vendor-specific con‐
1334       figuration information.  Multiple Vendor sections may be  present,  and
1335       they  may  contain  an Identifier entry and multiple Option flags.  The
1336       data therein is not used in this release.
1337

FILES

1339       For an example  of  an  xorg.conf  file,  see  the  file  installed  as
1340       /usr/lib/X11/xorg.conf.eg.
1341

SEE ALSO

1343       X(7),  Xserver(1),  Xorg(1),  apm(4),  chips(4),  cirrus(4),  cyrix(4),
1344       fbdev(4), glide(4),  glint(4),  i128(4),  i740(4),  i810(4),  imstt(4),
1345       mga(4),   neomagic(4),   nv(4),   r128(4),   rendition(4),   savage(4),
1346       s3virge(4), siliconmotion(4), sis(4), sunbw2(4), suncg14(4), suncg3(4),
1347       suncg6(4),  sunffb(4),  sunleo(4),  suntcx(4),  tdfx(4),  tga(4),  tri‐
1348       dent(4), tseng(4), v4l(4), vesa(4), vga(4), vmware(4),
1349

AUTHORS

1351       This   manual   page   was   largely   rewritten   by    David    Dawes
1352       <dawes@xfree86.org>.
1353
1354
1355
1356X Version 11                  xorg-server 1.3.0.0                 xorg.conf(5)
Impressum