The X Server Configuration HOWTO

Sven Vermeulen  Author
Joshua Saddler  Author

Updated October 2, 2009

1.  What is the X Window Server?

Graphical vs Command-Line

The average user may be frightened at the thought of having to type in commands. Why wouldn't he be able to point and click his way through the freedom provided by Gentoo (and Linux in general)? Well, *big smile*, of course you are able to do this. :-) Linux offers a wide variety of flashy user interfaces and environments which you can install on top of your existing installation.

This is one of the biggest surprises new users come across: a graphical user interface is nothing more than an application which runs on your system. It is not part of the Linux kernel or any other internals of the system. It is a powerful tool that fully enables the graphical abilities of your workstation.

As standards are important, a standard for drawing and moving windows on a screen, interacting with the user through mouse, keyboard and other basic, yet important aspects has been created and named the X Window System, commonly abbreviated as X11 or just X. It is used on Unix, Linux and Unix-like operating systems throughout the world.

The application that provides Linux users with the ability to run graphical user interfaces and that uses the X11 standard is Xorg-X11, a fork of the XFree86 project. XFree86 has decided to use a license that might not be compatible with the GPL license; the use of Xorg is therefore recommended. The official Portage tree does not provide an XFree86 package anymore.

The X.org Project

The X.org project created and maintains a freely redistributable, open-source implementation of the X11 system. It is an open source X11-based desktop infrastructure.

Xorg provides an interface between your hardware and the graphical software you want to run. Besides that, Xorg is also fully network-aware, meaning you are able to run an application on one system while viewing it on a different one.

2.  Installing Xorg

Before installing Xorg you have to configure two important variables in the /etc/make.conf file.

The first one is VIDEO_CARDS. This is used to set the video drivers that you intend to use and is usually based on the kind and brand of card you have. The most common settings are nvidia for Nvidia cards or fglrx for ATI Radeon cards. Those are the proprietary drivers from Nvidia and ATI respectively. If you would like to use the open source versions, use nv rather than nvidia in the variable, but bear in mind that using this driver means no 3D acceleration at all. The free radeon and radeonhd drivers for ATI cards support 3D acceleration on older Radeons but don't yet support all the features of the newer ones. VIDEO_CARDS may contain more than one driver, in this case list of them should be separated with spaces.

The second variable is INPUT_DEVICES and is used to determine which drivers are to be built for input devices. In most cases setting it to keyboard mouse should work just fine. If you use alternative input devices, such as a Synaptics touchpad for a laptop, be sure to add it to INPUT_DEVICES.

Now you should decide which drivers you will use and add necessary settings to the /etc/make.conf file:

Code Listing 2.1: Sample make.conf entries

(For mouse and keyboard support)
INPUT_DEVICES="keyboard mouse"
(For Nvidia cards)
VIDEO_CARDS="nvidia"
(OR, for ATI Radeon cards)
VIDEO_CARDS="fglrx"

More instructions on how to configure nVidia and ATI cards can be found in Gentoo Linux nVidia Guide and in Gentoo Linux ATI FAQ. If you don't know which drivers you should choose, refer to these guides for more information.

Note: If the suggested settings don't work for you, you should run emerge -pv xorg-server, check all the options available and choose those which apply to your system. The example is for the amd64 architecture and xorg-server-1.2.

Code Listing 2.2: Displaying all the driver options available

# emerge -pv xorg-server

These are the packages that would be merged, in order:

Calculating dependencies... done!
[ebuild   R   ] x11-base/xorg-server-1.2.0-r3  USE="dri nptl xorg (-3dfx) -debug
-dmx -ipv6 -kdrive -minimal -sdl -xprint" INPUT_DEVICES="keyboard mouse -acecad
-aiptek -calcomp -citron -digitaledge -dmc -dynapro -elo2300 -elographics -evdev
-fpit -hyperpen -jamstudio -joystick -magellan -microtouch -mutouch -palmax
-penmount -spaceorb -summa -synaptics -tek4957 -ur98 -vmmouse -void -wacom"
VIDEO_CARDS="nvidia -apm -ark -chips -cirrus -cyrix -dummy -epson -fbdev -fglrx
-glint -i128 (-i740) -i810 (-impact) (-imstt) -mach64 -mga -neomagic (-newport)
(-nsc) -nv -r128 -radeon -rendition -s3 -s3virge -savage -siliconmotion -sis
-sisusb (-sunbw2) (-suncg14) (-suncg3) (-suncg6) (-sunffb) (-sunleo) (-suntcx)
-tdfx -tga -trident -tseng -v4l -vesa -vga -via -vmware -voodoo" 0 kB

After setting all the necessary variables you can install the Xorg package.

Code Listing 2.3: Installing Xorg

# emerge xorg-server

Note: You could install the xorg-x11 metapackage instead of the more lightweight xorg-server. Functionally, xorg-x11 and xorg-server are the same. However, xorg-x11 brings in many more packages that you probably don't need, such as a huge assortment of fonts in many different languages. They're not necessary for a working desktop.

When the installation is finished, you might need to re-initialise some environment variables before you continue. Just run env-update followed by source /etc/profile and you're all set.

Code Listing 2.4: Re-initialising the environment variables

# env-update
# source /etc/profile

3.  Configuring Xorg

The xorg.conf File

The configuration file of Xorg is called xorg.conf and it resides in /etc/X11. Xorg provides an example configuration as /etc/X11/xorg.conf.example which you can use to create your own configuration. It is heavily commented, but if you are in need of more documentation regarding the syntax, don't hesitate to read the man page:

Code Listing 3.1: Reading the xorg.conf man page

# man 5 xorg.conf

Happy reading for those of you willing to. We surely don't so we'll continue with checking out how we can create the file automatically.

Default: Automatic Generation of xorg.conf

Xorg itself is able to guess most parameters for you. In most cases, you will only have to change some lines to get the resolution you want up and running. If you are interested in more in-depth tweaking, be sure to check the resources at the end of this chapter. But first, let us generate a (hopefully working) Xorg configuration file.

Code Listing 3.2: Generating an xorg.conf file

# Xorg -configure

Be sure to read the last lines printed on your screen when Xorg has finished probing your hardware. If it tells you it failed at some point, you're forced to manually write an xorg.conf file. Assuming that it didn't fail, it will have told you that it has written /root/xorg.conf.new ready for you to test. So let's test. :)

Code Listing 3.3: Testing the xorg.conf.new file

# X -config /root/xorg.conf.new

If all goes well, you should see a simple black and white pattern. Verify if your mouse works correctly and if the resolution is good. If you received errors about "/dev/mouse", try changing your mouse device to /dev/input/mice in the "InputDevice" section of xorg.conf. You might not be able to deduce the exact resolution, but you should be able to see if it's too low. You can exit any time by pressing Ctrl-Alt-Backspace.

Alternative: Semi-Automatic Generation of xorg.conf

Xorg provides a tool called xorgconfig which will ask you for various information regarding your system (graphical adapter, keyboard, ...). Based on your input it will create a xorg.conf file.

Code Listing 3.4: Semi-Automatic Generation of xorg.conf

# xorgconfig

Another tool, also provided by Xorg, is xorgcfg, which will first attempt to run Xorg -configure and then start the X server for more final tweaking.

Code Listing 3.5: Using xorgcfg

# xorgcfg
(In case X crashes or the configuration fails, try:)
# xorgcfg -textmode

Copying over xorg.conf

Let us copy over the xorg.conf.new to /etc/X11/xorg.conf now, so we won't have to continuously run X -config -- typing just X or startx is easier. :)

Code Listing 3.6: Copying over xorg.conf

# cp /root/xorg.conf.new /etc/X11/xorg.conf

Using startx

Now try startx to start up your X server. startx is a script that executes an X session, that is, it starts the X servers and some graphical applications on top of it. It decides which applications to run using the following logic:

Code Listing 3.7: Starting X

# startx

If you see an ugly, loathsome, repulsive, deformed window manager, that's twm. To finish the twm session, type in exit or Ctrl-D in the upcoming xterms. You can also kill the X session using the Ctrl-Alt-Backspace combination. This will however make X exit disgracefully -- something that you might not always want. It doesn't hurt though. :)

4.  Tweaking xorg.conf

Setting your Resolution

If you feel that the screen resolution is wrong, you will need to check two sections in your configuration. First of all, you have the Screen section which lists the resolutions, if any that your X server will run at. By default, this section might not list any resolutions at all. If this is the case, Xorg will estimate the resolutions based on the information in the second section, Monitor.

What happens is that Xorg checks the settings of HorizSync and VertRefresh in the Monitor section to compute valid resolutions. For now, leave these settings as-is. Only when the changes to the Screen section (which we will describe in a minute) don't work, then you will need to look up the specs for your monitor and fill in the correct values. You can also use a tool that searches for your monitor's specs, such as sys-apps/ddcxinfo-knoppix.

Warning: Do not "just" change the values of these two monitor related variables without consulting the technical specifications of your monitor. Setting incorrect values lead to out-of-sync errors at best and smoked up screens at worst.

Now let us change the resolutions. In the next example from /etc/X11/xorg.conf we add the Modes lines and the DefaultDepth so that our X server starts with 24 bits at 1024x768 by default. Don't mind the given strings -- they are examples and will most likely differ from the settings on your system.

Code Listing 4.1: Changing the Screen section in /etc/X11/xorg.conf

Section "Screen"
  Identifier  "Default Screen"
  Device    "S3 Inc. ProSavage KN133 [Twister K]"
  Monitor   "Generic Monitor"
  DefaultDepth  24
  # Skipping some text to improve readability
  SubSection "Display"
    Depth   24
    Modes   "1024x768"
  EndSubSection
EndSection

Run X (startx) to discover it uses the resolution you want. :)

Configuring your Keyboard

To setup X to use an international keyboard, search for the InputDevice section that configures the keyboard and add the XkbLayout option to point to the keyboard layout you want. As an example, we show you how to apply for the Belgian layout. Just substitute the country-keycode with yours:

Code Listing 4.2: Changing the keyboard layout

Section "InputDevice"
  Identifier  "Generic Keyboard"
  Driver    "keyboard"
  Option    "CoreKeyboard"
  Option    "XkbRules"  "xorg"
  Option    "XkbModel"  "pc105"
  Option    "XkbLayout" "be"
EndSection

Configuring your Mouse

If your mouse isn't working, you will first need to find out if it is detected by the kernel at all. Mice are (device-wise) seen as /dev/input/mouse0 (or /dev/input/mice if you want to use several mice). In some cases /dev/psaux is used. In either case you can check if the devices do represent your mouse by checking the output of those files when you move your mouse. You will usually see some junk on your screen. To end the session press Ctrl-C.

Code Listing 4.3: Checking the device files

# cat /dev/input/mouse0
(Don't forget to press Ctrl-C to end this)

If your mouse isn't detected, verify if all the necessary modules are loaded.

If your mouse is detected, fill in the device in the appropriate InputDevice section. In the next example you'll see we also set two other options: Protocol (which lists the mouse protocol to be used -- most users will use PS/2 or IMPS/2) and ZAxisMapping (which allows for the mousewheel (if applicable) to be used).

Code Listing 4.4: Changing the mouse settings in Xorg

Section "InputDevice"
  Identifier  "TouchPad Mouse"
  Driver    "mouse"
  Option    "CorePointer"
  Option    "Device"    "/dev/input/mouse0"
  Option    "Protocol"    "IMPS/2"
  Option    "ZAxisMapping"    "4 5"
EndSection

Run startx and be happy about the result. :) Congratulations, you now (hopefully) have a working Xorg on your system. The next step is to remove this ugly lightweight window manager and use a high-feature one (or even a desktop environment) such as KDE or GNOME, but that's not part of this guide. :)

5.  Resources

Creating and Tweaking xorg.conf

First of all, man xorg.conf provides a quick yet complete reference about the syntax used by the configuration file. Be sure to have it open on a terminal near you when you edit your configuration file!

Also, be sure to look at /etc/X11/xorg.conf.example; you may wish to copy this and use it as a foundation for writing your own xorg.conf.

You may find the X.org FAQ provided on their website, in addition to their other documentation.

There are also many online resources on editing xorg.conf. We only list few of them here, be sure to Google for more. :) As xorg.conf and XF86Config (the configuration file for the XFree86 project) use the same syntax for most configuration options and more information about XF86Config is available, we'll list those resources as well.

Other resources

More information about installing and configuring various graphical desktop environments and applications can be found in the Gentoo Desktop Documentation Resources section of our documentation.

If you're upgrading to xorg-server-1.5 from an earlier version, then be sure to read the migration guide.