Xorg/Guide

Xorg is the X Window server which allows users to have a graphical environment at their fingertips. This HOWTO explains what Xorg is, how to install it and what the various configuration options are.

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, 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.

Installing Xorg
Before you can install Xorg, you need to prepare your system for it. First, we'll set up the kernel to support input devices and video cards. Then we'll prepare so that the right drivers and Xorg packages are built and installed.

Input driver support
By default, Xorg uses, a generic input driver. You'll need to activate support for  by making a change to your kernel configuration. Read the Kernel Configuration Guide if you don't know how to setup your kernel.

Kernel modesetting
Modern open-source video drivers rely on kernel modesetting (KMS). KMS provides an improved graphical boot with less flickering, faster user switching, a built-in framebuffer console, seamless switching from the console to Xorg, and other features. KMS conflicts with legacy framebuffer drivers, which must remain disabled in your kernel configuration.

First, prepare your kernel for KMS. You need to do this step regardless of which Xorg video driver you're using.

Next, configure your kernel to use the proper KMS driver for your video card. Intel, nVidia, and AMD/ATI are the most common cards, so follow code listing for your card below.

For Intel cards:

For nVidia cards:

For newer AMD/ATI cards (RadeonHD 2000 and up), you will need to emerge or. Once you have installed one of these packages, configure your kernel as detailed in the firmware section of Radeon page:

Now that you're done setting up KMS, continue with preparing in the next section.

make.conf configuration
Now that your kernel is prepared, you have to configure two important variables in the file before you can install Xorg.

The first variable is. This is used to set the video drivers that you intend to use and is usually based on the kind of video card you have. The most common settings are  for nVidia cards or   for ATI cards. Both have actively developed, well-supported open-source drivers.

The  driver may be used for desktops or laptops with common Intel integrated graphics chipsets.

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

Now you should decide which drivers you will use and add necessary settings to the file:

Sample make.conf entries

If the suggested settings don't work for you, you should run, check all the options available and choose those which apply to your system. This example is for a system with a keyboard, mouse, Synaptics touchpad, and a Radeon video card.

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

First of all, make sure udev is in your USE flags:

Next, install Xorg:

When the installation is finished, you will need to re-initialise some environment variables before you continue:

Configuring Xorg
The X server is designed to work out-of-the-box, with no need to manually edit Xorg's configuration files. It should detect and configure devices such as displays, keyboards, and mice.

You should first try using startx without editing any configuration files. If Xorg won't start, or there's some other problem, then you'll need to manually configure Xorg as shown in the next section.

The xorg.conf.d directory
The configuration files of Xorg are stored in. Each file is given a unique name and ends in. If the filenames start with a number, then Xorg will read the files in numeric order. will be read before, and so on. You don't have to give them numbers, but it may help you organize them.

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


 * If a file named exists in the home directory, it will execute the commands listed there.


 * Otherwise, it will read the value of the XSESSION variable and will execute one of the sessions available in accordingly. You can set the value of XSESSION in  to make it a default for all the users on the system. For example, as root, run  . This will create the  file and set the default X session to Xfce. Remember to run   after changing.

If you haven't yet installed a window manager, all you'll see is a black screen. Since this can also be a sign that something's wrong, you may want to emerge  and   only to test X.

Once those two programs are installed, run  again. A few  windows should appear, making it easier to verify that X is working correctly. Once you're satisfied with the results, run  as root to get rid of the testing packages. You won't need them once you've setup a proper desktop environment.

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 that your X server will run at. 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.

Now let us change the resolution. In the next example from we add the   line so that our X server starts at 1440x900 by default. The  in the   section must match the name of your monitor, which can be obtained by running. You'll need to  just long enough to get this information. The argument after the monitor name (in the  section) must match the   in the   section.

Run X to discover it uses the resolution you want.

Multiple monitors
You can configure more than one monitor in. All you have to do is give each monitor an identifer, then list its physical position, such as "RightOf" or "Above" another monitor. The following example shows how to configure a DVI and a VGA monitor, with the VGA monitor as the right-hand screen:

Configuring your keyboard
To setup X to use an international keyboard, you just have to create the appropriate config file in. This example features a Czech keyboard layout:

The "terminate" command lets you kill the X session by using the Ctrl-Alt-Backspace key combination. This will, however, make X exit disgracefully -- something that you might not always want. It can be useful when programs have frozen your display entirely, or when you're configuring and tweaking your Xorg environment. Be careful when killing your desktop with this key combination -- most programs really don't like it when you end them this way, and you may lose some (or all) of what you were working on.

Finishing up
Run  and be happy about the result. Congratulations, you now (hopefully) have a working Xorg on your system. The next step is to install a useful window manager or desktop environment such as KDE, GNOME, or Xfce, but that's not part of this guide. Information on installing these desktop environments can be found in our Gentoo Desktop Documentation Resources.

Creating and editing config files
First of all,  and   provide quick yet complete references about the syntax used by these configuration files. Be sure to have them open on a terminal when you edit your configuration files!

There are also many online resources on editing config files in. We only list few of them here; be sure to use your favorite search engine to find more.

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  1.9 from an earlier version, then be sure to read the migration guide.

X.org provides many FAQs on their website, in addition to their other documentation.

Acknowledgements
We would like to thank the following authors and editors for their contributions to this guide:


 * swift


 * nightmorph