--- xml/htdocs/doc/en/xorg-config.xml	2004/05/14 15:15:08	1.2
+++ xml/htdocs/doc/en/xorg-config.xml	2007/06/09 12:40:12	1.22
@@ -1,6 +1,6 @@
 <?xml version='1.0' encoding='UTF-8'?>
 
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xorg-config.xml,v 1.2 2004/05/14 15:15:08 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xorg-config.xml,v 1.22 2007/06/09 12:40:12 jkt Exp $ -->
 
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
@@ -19,11 +19,11 @@
 </abstract>
 
 <!-- The content of this document is licensed under the CC-BY-SA license -->
-<!-- See http://creativecommons.org/licenses/by-sa/1.0 -->
+<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
 <license/>
 
-<version>1.1</version>
-<date>May 10, 2004</date>
+<version>1.16</version>
+<date>2007-06-09</date>
 
 <chapter>
 <title>What is the X Window Server?</title>
@@ -48,7 +48,7 @@
 
 <p>
 As standards are important, a standard for drawing and moving windows on a
-screen, interacting with the user through mouse and keyboard and other basic yet
+screen, interacting with the user through mouse, keyboard and other basic, yet
 important aspects has been created and named the <e>X Window System</e>,
 commonly abbreviated as <e>X11</e> or just <e>X</e>. It is used on Unix, Linux
 and Unix-like operating systems throughout the world.
@@ -58,10 +58,8 @@
 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. Note
-though that the differences between Xorg and XFree86 are currently very slim; if
-you know one, you know the other. XFree86 versions prior to 4.4 are available
-through Portage as well.
+compatible with the GPL license; the use of Xorg is therefore recommended. 
+The official Portage tree does not provide an XFree86 package anymore.
 </p>
 
 </body>
@@ -72,8 +70,8 @@
 
 <p>
 The <uri link="http://www.x.org">X.org</uri> project created and
-maintains a freely redistributable open-source implementation of the X11 system.
-It is an open source X11-based desktop infrastructure. 
+maintains a freely redistributable, open-source implementation of the X11
+system. It is an open source X11-based desktop infrastructure. 
 </p>
 
 <p>
@@ -86,6 +84,7 @@
 </body>
 </section>
 </chapter>
+
 <chapter>
 <title>Installing Xorg</title>
 <section>
@@ -98,18 +97,92 @@
 though, so you might want to grab a snack while you are waiting.
 </p>
 
+<p>
+Before installing Xorg you have to configure two important variables in the
+<path>/etc/make.conf</path> file.
+</p>
+
+<p>
+The first one is <c>VIDEO_CARDS</c>. 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 <c>nvidia</c> for Nvidia cards or <c>fglrx</c> 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 <c>nv</c>
+rather than <c>nvidia</c> in the variable, but bear in mind that using this
+driver means no 3d acceleration at all. The free <c>radeon</c> driver for ATI
+cards supports full 3D acceleration on older Radeons but doesn't work at all
+with the newer ones. <c>VIDEO_CARDS</c> may contain more than one driver, in
+this case list of them should be separated with spaces.
+</p>
+
+<p>
+The second variable is <c>INPUT_DEVICES</c> and is used to determine which
+drivers are to be built for input devices. In most cases setting it to
+<c>keyboard mouse</c> should work just fine.
+</p>
+
+<p>
+Now you should decide which drivers you will use and add necessary settings to
+the <path>/etc/make.conf</path> file:
+</p>
+
+<pre caption="Sample make.conf entries">
+<comment>(For mouse and keyboard support)</comment>
+INPUT_DEVICES="keyboard mouse"
+<comment>(For Nvidia cards)</comment>
+VIDEO_CARDS="nvidia"
+<comment>(OR, for ATI Radeon cards)</comment>
+VIDEO_CARDS="fglrx"
+</pre>
+
+<p>
+More instructions on how to configure Nvidia and ATI cards can be found in
+<uri link="/doc/en/nvidia-guide.xml">Gentoo Linux nVidia Guide</uri> and in
+<uri link="/doc/en/ati-faq.xml">Gentoo Linux ATI FAQ</uri>. If you don't know
+which drivers you should choose, refer to these guides for more information.
+</p>
+
+<note>
+If the suggested settings don't work for you, you should run <c>emerge -pv
+xorg-x11</c>, check all the options available and choose those which
+apply to your system. In different versions of Xorg and on different
+architectures displaying these variables can be done with <c>emerge -pv
+xorg-server</c> command rather than the one above. The example is for x86
+architecture and xorg-x11-7.0.
+</note>
+
+<pre caption="Displaying all the driver options available">
+# <i>emerge -pv xorg-x11</i>
+
+These are the packages that would be merged, in order:
+
+Calculating dependencies... done!
+[ebuild   R   ] x11-base/xorg-x11-7.0-r1  USE="-3dfx" INPUT_DEVICES="keyboard
+mouse -acecad -aiptek -calcomp -citron -digitaledge -dmc -dynapro -elo2300
+-elographics -evdev -fpit -hyperpen -jamstudio -joystick -magellan -magictouch
+-microtouch -mutouch -palmax -penmount -spaceorb -summa -synaptics -tek4957
+-ur98 -vmmouse -void -wacom" VIDEO_CARDS="nvidia -apm -ark -chips -cirrus
+-cyrix -dummy -fbdev -fglrx -glint -i128 -i740 -i810 -imstt -mach64 -mga
+-neomagic -nsc -nv -r128 -radeon -rendition -s3 -s3virge -savage -siliconmotion
+-sis -sisusb -tdfx -tga -trident -tseng -v4l -vesa -vga -via -vmware -voodoo" 0
+kB
+</pre>
+
+<p>
+After setting all the necessary variables you can install the Xorg package.
+</p>
+
 <pre caption="Installing Xorg">
 # <i>emerge xorg-x11</i>
 </pre>
 
 <p>
-When the installation is finished, you might need to reinitialise some
+When the installation is finished, you might need to re-initialise some
 environment variables before you continue. Just run <c>env-update</c> followed
-by <c>source /etc/profile</c> and you're all set. This doesn't harm your system
-in any way.
+by <c>source /etc/profile</c> and you're all set.
 </p>
 
-<pre caption="Reinitialising the environment variables">
+<pre caption="Re-initialising the environment variables">
 # <i>env-update</i>
 # <i>source /etc/profile</i>
 </pre>
@@ -167,18 +240,16 @@
 </p>
 
 <pre caption="Testing the xorg.conf.new file">
-# <i>Xorg -config /root/xorg.conf.new</i>
+# <i>X -config /root/xorg.conf.new</i>
 </pre>
 
 <p>
-If all goes well, you should see an ugly, loathsome, repulsive, deformed
-window manager called <c>twm</c>, probably the smallest window manager
-available. Try moving your mouse and see if your keyboard and such is working.
-In the next section we will optimize our <path>xorg.conf</path> so it fits your
-hardware. Now go into one of the terminals you see on your screen and type in
-<c>exit</c> (or press Ctrl-D) until Xorg shuts down. If you are unable to
-use your mouse to focus the terminals, you can also press Ctrl-Alt-Backspace to
-kill the X server.
+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 <c>/dev/input/mice</c> in
+the "InputDevice" section of <path>xorg.conf</path>. 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.
 </p>
 
 </body>
@@ -197,39 +268,81 @@
 # <i>xorgconfig</i>
 </pre>
 
+<p>
+Another tool, also provided by Xorg, is <c>xorgcfg</c>, which will first
+attempt to run <c>Xorg -configure</c> and then start the X server for more
+final tweaking.
+</p>
+
+<pre caption="Using xorgcfg">
+# <i>xorgcfg</i>
+<comment>(In case X crashes or the configuration fails, try:)</comment>
+# <i>xorgcfg -textmode</i>
+</pre>
+
 </body>
 </section>
-</chapter>
-<chapter>
-<title>Tweaking xorg.conf</title>
 <section>
 <title>Copying over xorg.conf</title>
 <body>
 
 <p>
-Let us first copy over the <path>xorg.conf.new</path> to
-<path>/etc/X11/xorg.conf</path> so we won't have to continuously run <c>Xorg
--config</c> -- typing <c>startx</c> is far more easy :)
+Let us copy over the <path>xorg.conf.new</path> to
+<path>/etc/X11/xorg.conf</path> now, so we won't have to continuously run
+<c>X -config</c> -- typing just <c>X</c> or <c>startx</c> is far more easy :)
 </p>
 
 <pre caption="Copying over xorg.conf">
 # <i>cp /root/xorg.conf.new /etc/X11/xorg.conf</i>
 </pre>
 
+</body>
+</section>
+<section id="using_startx">
+<title>Using startx</title>
+<body>
+
 <p>
-Now run <c>startx</c> to start up your X server. It will use the freshly copied
-file as its configuration file. To finish the X session, type in <c>exit</c> 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 :)
+Now try <c>startx</c> to start up your X server.  <c>startx</c> is a script
+that executes an <e>X session</e>, 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:
 </p>
 
+<ul>
+  <li>
+    If a file named <path>.xinitrc</path> exists in the home directory, it will
+    execute the commands listed there.
+  </li>
+  <li>
+    Otherwise, it will read the value of the XSESSION variable and will execute
+    one of the sessions available in <path>/etc/X11/Sessions/</path>
+    accordingly (you can set the value of XSESSION in <path>/etc/rc.conf</path>
+    to make it a default for all the users on the system).
+  </li>
+<li>
+    If all of the above fail, it will fall back to a simple window manager,
+    usually <c>twm</c>.
+  </li>
+</ul>
+
 <pre caption="Starting X">
 # <i>startx</i>
 </pre>
 
+<p>
+If you see an ugly, loathsome, repulsive, deformed window manager, that's
+<c>twm</c>. To finish the twm session, type in <c>exit</c> 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 :)
+</p>
+
 </body>
 </section>
+</chapter>
+<chapter>
+<title>Tweaking xorg.conf</title>
 <section>
 <title>Setting your Resolution</title>
 <body>
@@ -237,7 +350,7 @@
 <p>
 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 <e>Screen</e> section
-which lists the resolutions - if any - that your X server will run at. By
+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, <e>Monitor</e>.
@@ -254,7 +367,7 @@
 </p>
 
 <warn>
-Do <b>not</b> "just" change the values of these two monitor-related variables
+Do <b>not</b> "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.
@@ -264,7 +377,7 @@
 Now let us change the resolutions. In the next example from
 <path>/etc/X11/xorg.conf</path> we add the <c>Modes</c> lines and the
 <c>DefaultDepth</c> 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
+default. Don't mind the given strings -- they are examples and will most likely
 differ from the settings on your system.
 </p>
 
@@ -304,7 +417,7 @@
   Identifier  "Generic Keyboard"
   Driver    "keyboard"
   Option    "CoreKeyboard"
-  Option    "XkbRules"  "xfree86"
+  Option    "XkbRules"  "xorg"
   Option    "XkbModel"  "pc105"
   <i>Option    "XkbLayout" "be"</i>
 EndSection
@@ -318,15 +431,17 @@
 
 <p>
 If your mouse isn't working, you will first need to find out if it is detected
-by the kernel at all. PS/2 mice are (device-wise) seen as 
-<path>/dev/psaux</path>. Other mice (like USBs) are seen as
-<path>/dev/input</path> (or <path>/dev/input/mice</path>). 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. To end the session press <c>Ctrl-C</c>.
+by the kernel at all. Mice are (device-wise) seen as
+<path>/dev/input/mouse0</path> (or <path>/dev/input/mice</path> if you want to
+use several mice). In some cases <path>/dev/psaux</path> 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
+<c>Ctrl-C</c>.
 </p>
 
 <pre caption="Checking the device files">
-# <i>cat /dev/input</i>
+# <i>cat /dev/input/mouse0</i>
 <comment>(Don't forget to press Ctrl-C to end this)</comment>
 </pre>
 
@@ -337,8 +452,8 @@
 <p>
 If your mouse is detected, fill in the device in the appropriate 
 <e>InputDevice</e> section. In the next example you'll see we also set two other
-options: <c>Protocol</c> (which lists the mouse protocol to be used - most users
-will use PS/2 or IMPS/2) and <c>ZAxisMapping</c> (which allows for the 
+options: <c>Protocol</c> (which lists the mouse protocol to be used -- most
+users will use PS/2 or IMPS/2) and <c>ZAxisMapping</c> (which allows for the
 mousewheel (if applicable) to be used).
 </p>
 
@@ -347,7 +462,7 @@
   Identifier  "TouchPad Mouse"
   Driver    "mouse"
   Option    "CorePointer"
-  <i>Option    "Device"    "/dev/psaux"</i>
+  <i>Option    "Device"    "/dev/input/mouse0"</i>
   <i>Option    "Protocol"    "IMPS/2"</i>
   <i>Option    "ZAxisMapping"    "4 5"</i>
 EndSection
@@ -404,5 +519,24 @@
 
 </body>
 </section>
+<section>
+<title>Other resources</title>
+<body>
+
+<p>
+If you want to update your system from the old monolithic Xorg to the newer,
+modular Xorg 7, you should refer to the <uri
+link="/proj/en/desktop/x/x11/modular-x-howto.xml">Migrating to Modular X
+HOWTO</uri>.
+</p>
+
+<p>
+More information about configuring different packages to work in X environment
+can be found in the <uri link="/doc/en/?catid=desktop">Gentoo Desktop
+Documentation Resources</uri> section of our documentation.
+</p>
+
+</body>
+</section>
 </chapter>
 </guide>