source: x/installing/xorg7.xml@ 4a1f001

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;
]>

<sect1 id="xorg7" xreflabel="X.org-&xorg7-version;">
  <?dbhtml filename="xorg7.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
<!--    <keywordset>
      <keyword role="package">X11R&xorg7-version;-src.tar</keyword>
      <keyword role="ftpdir">Xorg7</keyword>
    </keywordset>
########## Need a way to fix this on the mirrors ##########
##### Maybe a single tarball is the way to handle it ######
-->


  </sect1info>

  <title>Xorg-&xorg7-version;</title>

  <indexterm zone="xorg7">
    <primary sortas="a-xorg7">Xorg</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Xorg</title>

    <para><application>Xorg</application> is a freely redistributable,
    open-source implementation of the <application>X</application> Window
    System. This system provides a client/server interface between display
    hardware (the mouse, keyboard, and video displays) and the desktop
    environment, while also providing both the windowing infrastructure and a
    standardized application interface (API).</para>

    <bridgehead renderas="sect3">Xorg Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="fontconfig"/>,
    <xref linkend="libdrm"/>,
    <xref linkend="libpng"/>, and
    <xref linkend="pkgconfig"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="linux-pam"/></para>

    <bridgehead renderas="sect3">Xorg Download and Installation
    Instructions</bridgehead>

    <para>With the modular build system, it is no longer possible to download
    the entire package in a single file.  In fact, there may be as many as
    280 files that need to be fetched from the download location.  To assist
    with such a large task, it is strongly recommended to install
    <xref linkend="wget"/> for downloading the needed files.  A complete
    <application>wget</application> script is available for each section at
    <ulink
    url="http://anduin.linuxfromscratch.org/sources/BLFS/svn/x/wget/"/>.</para>

    <para>Given the number of packages available, deciding which packages you
    need to install for your particular setup may seem a bit overwhelming at
    first.  Take a look at<ulink
    url="http://lists.x.org/archives/xorg-modular/2005-November/000801.html">
    this thread</ulink> to get an idea of what you will need.  If you are
    unsure, you should install all packages at the cost of extra
    disk space.</para>

    <note>
      <para>The installed size of <application>Xorg</application> can
      be reduced considerably by installing only the packages that you will
      need and use. However, the BLFS book cannot account for all dependencies
      and build options for individual <application>Xorg</application>
      packages.  The instructions assume that all packages have been built
      from a particular group unless otherwise noted. A
      <ulink url="http://wiki.linuxfromscratch.org/blfs/wiki/Xorg-7.0.0">
      wiki</ulink> page containing dependency information, for users who wish
      to cut down on the installed size of <application>Xorg</application>, is
      under development.  You are encouraged to add to these
      pages if you discover additional information that may be helpful to
      other users.</para>
    </note>

    <para>Additionally, because of the large number of repetitive commands,
    you are encouraged to script the build.  For most sections, you can use
    the following commands to compile and install all packages in your build
    directory:</para>

<screen>for package in *.tar.bz2
do
  packagedir=`echo $package | sed 's/.tar.bz2//'`
  tar -xf $package &amp;&amp;
  cd $packagedir &amp;&amp;
  ./configure $XORG_CONFIG &amp;&amp;
  make &amp;&amp;
  make install
  if [ $? -ne 0 ]; then
    break #stop the build if the previous command failed
  fi
  cd .. &amp;&amp;
  rm -rf $packagedir
done 2&gt;&amp;1 | tee -a ../xorg-compile.log #log the entire loop</screen>

  </sect2>

  <sect2>
    <title>Setting up the Xorg Build Environment</title>

      <para>First, you'll need to create a working directory:</para>

<screen><userinput>mkdir xc &amp;&amp;
cd xc</userinput></screen>

    <para>As with previous releases of the X Window System, it may be
    desirable to install <application>Xorg</application> into an alternate
    prefix.  This is no longer common practice among Linux distributions.
    The common installation prefix for <application>Xorg</application> on
    Linux is <filename class="directory">/usr</filename>.  There is no
    standard alternate prefix, nor is there any exception in the current
    revision of the Filesystem Hierarchy Standard for Release 7 of the X
    Window System.  Alan Coopersmith of Sun Microsystems, has recently
    stated "At Sun, we were using
    <filename class="directory">/usr/X11</filename> and plan to stick with
    it."  Only the <filename class="directory">/opt/*</filename> prefix or
    the <filename class="directory">/usr</filename> prefix adhere to the
    current FHS guidelines.</para>

    <para>Choose your installation prefix, and set the
    <envar>XORG_PREFIX</envar> variable with the following
    command:</para>

<screen><userinput>export XORG_PREFIX="<replaceable>[/usr]</replaceable>"</userinput></screen>

    <para>Throughout these instructions, you will use the same three
    <command>configure</command> switches for all of the packages.  Create the
    <envar>XORG_CONFIG</envar> variable to use for substitution:</para>

<screen><userinput>export XORG_CONFIG="--prefix=$XORG_PREFIX --sysconfdir=/etc --localstatedir=/var"</userinput></screen>

    <note>
      <para>If you've decided to use an alternate prefix, be sure to add
      <filename class="directory"><replaceable>[/usr]</replaceable>/lib/pkgconfig</filename>
      to your <envar>PKG_CONFIG_PATH</envar> variable.</para>
    </note>

  </sect2>

  <sect2>
    <title>Xorg Protocol Headers</title>

    <indexterm zone="xorg7">
      <primary sortas="a-xorg7-proto">Xorg Protocol Headers</primary>
    </indexterm>

      <para>The <application>Xorg</application> protocol headers provide the
      header files required to build the system, and to allow other
      applications to build against the installed X Window system.</para>

      <para><application>Xorg</application> Proto packages can be downloaded
      individually from <ulink
      url="http://xorg.freedesktop.org/releases/individual/proto/"/>.</para>

    <sect3 role="installation">
      <title>Installation of Xorg Protocol Headers</title>

      <para>Install the <application>Xorg</application> protocol headers
      by running the following commands for each package to be installed.</para>

<screen><userinput>./configure $XORG_CONFIG</userinput></screen>

      <para>Now as the <systemitem class="username">root</systemitem>
      user:</para>

<screen><userinput role="root">make install</userinput></screen>

    </sect3>

  </sect2>

  <sect2>
    <title>Xorg Utilities</title>

    <indexterm zone="xorg7">
      <primary sortas="a-xorg7-data">Xorg Utilities</primary>
    </indexterm>

      <para>The <application>Xorg</application> utility packages provide
      needed utilities, not for the <application>Xorg</application>
      installation itself, but for other applications that make use of
      legacy X11R6 installation methods.</para>

      <para><application>Xorg</application> Utility packages can be downloaded
      individually from <ulink
      url="http://xorg.freedesktop.org/releases/individual/util/"/>.</para>

    <sect3 role="installation">
      <title>Installation of Xorg Utilities</title>

      <para>First install the <application>xorg-cf-files</application> package
      with the following commands:</para>

<screen><userinput>sed -i "s@/usr/X11R6@$XORG_PREFIX@" site.def &amp;&amp;
sed -i "s@/usr/X11R6@$XORG_PREFIX@" X11.tmpl &amp;&amp;
./configure $XORG_CONFIG --with-config-dir=$XORG_PREFIX/lib/X11/config &amp;&amp;
make</userinput></screen>

      <para>Now as the <systemitem class="username">root</systemitem>
      user:</para>

<screen><userinput role="root">make install</userinput></screen>

      <para>Next, install the <application>Imake</application> package with
      these commands:</para>

<screen><userinput>./configure $XORG_CONFIG --with-config-dir=$XORG_PREFIX/lib/X11/config &amp;&amp;
make</userinput></screen>

      <para>Now as the <systemitem class="username">root</systemitem>
      user:</para>

<screen><userinput role="root">make install</userinput></screen>


      <para>Finally, build the three remaining packages with the standard build
      commands:</para>


<screen><userinput>./configure $XORG_CONFIG &amp;&amp;
make</userinput></screen>

      <para>Now as the <systemitem class="username">root</systemitem>
      user:</para>

<screen><userinput role="root">make install</userinput></screen>

    </sect3>

  </sect2>

  <sect2>
    <title>Xorg Libraries</title>

    <indexterm zone="xorg7">
      <primary sortas="a-xorg7-lib">Xorg Libraries</primary>
    </indexterm>

      <para>The <application>Xorg</application> libraries provide library
      routines that are used within all X Window applications.</para>

      <para><application>Xorg</application> Library packages can be downloaded
      individually from <ulink
      url="http://xorg.freedesktop.org/releases/individual/lib/"/>.</para>

    <sect3>
      <title>Meeting Library Dependencies</title>

      <para>These 17 libraries must be built first, in the order provided,
      to cover the dependencies of the other library packages:</para>

<screen>xtrans-1.0.0
libXau-1.0.0
libXdmcp-1.0.0
libX11-1.0.0
libXext-1.0.0
libICE-1.0.0
libSM-1.0.0
libXt-1.0.0
libXmu-1.0.0
libXpm-3.5.4.2
libXp-1.0.0
libXfixes-3.0.1.2
libXrender-0.9.0.2
libfontenc-1.0.1
libxkbfile-1.0.2
libXprintUtil-1.0.1
libXv-1.0.1</screen>

    </sect3>

    <sect3 role="installation">
      <title>Installation of Xorg Libraries</title>

      <para>Install the libraries by running the following commands for each
      of the chosen packages:</para>

<screen><userinput>./configure $XORG_CONFIG &amp;&amp;
make</userinput></screen>

      <para>Now as the <systemitem class="username">root</systemitem>
      user:</para>

<screen><userinput role="root">make install</userinput></screen>

    </sect3>

    <sect3 role="configuration">
      <title>Configuration of Xorg Libraries</title>

        <para>If you've chosen to install <application>Xorg</application> into
        <filename class="directory">/usr</filename>, then no further
        configuration is necessary and you can skip the rest of this section.
        If you've opted for an alternate prefix, you should create two symlinks
        to satisfy the expected environment of several packages.
        Execute the following commands as the root user:</para>

<screen role="root"><userinput>ln -sv $XORG_PREFIX/lib/X11 /usr/lib/X11 &amp;&amp;
ln -sv $XORG_PREFIX/include/X11 /usr/include/X11</userinput></screen>

        <para>As with other library directories, as the root user you must add
        <filename class="directory">$XORG_PREFIX/lib</filename> to
        <filename>/etc/ld.so.conf</filename> and execute
        <command>/sbin/ldconfig</command>.</para>

    </sect3>

  </sect2>

  <sect2>
    <title>Xorg Data</title>

    <indexterm zone="xorg7">
      <primary sortas="a-xorg7-data">Xorg Data</primary>
    </indexterm>

      <para>The <application>Xorg</application> data packages provide
      static data such as images and keymaps to the
      <application>Xorg</application> applications.</para>

      <para><application>Xorg</application> Data packages can be downloaded
      individually from <ulink
      url="http://xorg.freedesktop.org/releases/individual/data/"/>.</para>

    <sect3 role="installation">
      <title>Installation of Xorg Data</title>

      <para>First, install the xbitmap package by running the following
      commands:</para>

<screen><userinput>./configure $XORG_CONFIG &amp;&amp;
make</userinput></screen>

      <para>Now as the <systemitem class="username">root</systemitem>
      user:</para>

<screen><userinput role="root">make install</userinput></screen>

      <note>
        <para>At this point, you should continue to the applications
        installation.  After the applications installation has completed, you
        can use the same instructions above to install the xcursor-themes and
        xkb-data packages.</para>
      </note>

    </sect3>

  </sect2>

  <sect2>
    <title>Xorg Applications</title>

    <indexterm zone="xorg7">
      <primary sortas="a-xorg7-app">Xorg Applications</primary>
    </indexterm>

    <note>
      <para>You must install <xref linkend="mesalib"/> before you install
      Xorg Applications.</para>
    </note>

      <para>The <application>Xorg</application> applications provide the
      expected applications available in previous X Window
      implementations.</para>

      <para><application>Xorg</application> applications can be downloaded
      individually from <ulink
      url="http://xorg.freedesktop.org/releases/individual/app/"/>.</para>

    <sect3 role="installation">
      <title>Installation of Xorg Applications</title>

      <para>Install the applications by running the following commands for each
      chosen package:</para>

<screen><userinput>./configure $XORG_CONFIG &amp;&amp;
make</userinput></screen>

      <para>Now as the <systemitem class="username">root</systemitem>
      user:</para>

<screen><userinput role="root">make install</userinput></screen>

      <note>
        <para>The luit package should not be compiled at this point.  You
        should install the luit application after the fonts have been
        installed.</para>
      </note>

      <note>
        <para>Remember to return to the data packages and install the
        xcursor-themes and xkb-data packages.</para>
      </note>

</sect3>

    <sect3 role="installation">

      <title>Installation of luit</title>

      <para>A patch is required to fix a race condition in
      <application>luit</application> that was discovered shortly after
      release.  Download the patch from
      <ulink url="&patch-root;/luit-1.0.1-race-1.patch"/>.</para>

      <para>Install luit with the following commands:</para>

<screen><userinput>patch -Np1 -i luit_1.0.1-race-1.patch &amp;&amp;
./configure $XORG_CONFIG &amp;&amp;
make</userinput></screen>

      <para>Now as the <systemitem class="username">root</systemitem>
      user:</para>

<screen><userinput role="root">make install</userinput></screen>

    </sect3>

  </sect2>

  <sect2>
    <title>Xorg Fonts</title>

    <indexterm zone="xorg7">
      <primary sortas="a-xorg7-fonts">Xorg Fonts</primary>
    </indexterm>

      <para>The <application>Xorg</application> font packages provide
      needed fonts to the <application>Xorg</application> applications.</para>

      <para><application>Xorg</application> Font packages can be downloaded
      individually from <ulink
      url="http://xorg.freedesktop.org/releases/individual/font/"/>.</para>

    <sect3 role="installation">
      <title>Installation of Xorg Fonts</title>

      <para>Run the following commands for each package:</para>

      <note>
        <para>You should install encodings and font-util before all
        other font packages.</para>
      </note>


<screen><userinput>./configure $XORG_CONFIG</userinput></screen>

      <para>Now as the <systemitem class="username">root</systemitem>
      user:</para>

<screen><userinput role="root">make install</userinput></screen>

      <note>
        <para>If you haven't done so, and intend to install
        <application>luit</application>, do so now.</para>
      </note>

    </sect3>

  </sect2>

  <sect2>
    <title>Xorg Server</title>

    <indexterm zone="xorg7">
      <primary sortas="a-xorg7-server">Xorg Server</primary>
    </indexterm>

    <para>The <application>Xorg</application> Server is the core
    of the X Window system.</para>

      <para>The Xorg Server is a single download.  Get it from
      <ulink url="http://xorg.freedesktop.org/releases/individual/xserver/xorg-server-X11R7.0-1.0.2.tar.bz2"/>.</para>

    <sect3 role="installation">
      <title>Installation of Xorg Server</title>

      <note>
        <para>You must have the <application>Mesa</application> source
        directory available when building the
        <application>Xorg-server</application>.</para>
      </note>

      <para>Install the server by running the following commands:</para>

<screen><userinput>./configure $XORG_CONFIG \
    --with-mesa-source='../../Mesa-&mesalib-version;' \
    --with-fontdir=$XORG_PREFIX/lib/X11/fonts \
    --with-module-dir=$XORG_PREFIX/lib/X11/modules &amp;&amp;
make</userinput></screen>

      <para>Now as the <systemitem class="username">root</systemitem>
      user:</para>

<screen><userinput role="root">make install</userinput></screen>

    </sect3>

  </sect2>

  <sect2>
    <title>Xorg Drivers</title>

    <indexterm zone="xorg7">
      <primary sortas="a-xorg7-driver">Xorg Drivers</primary>
    </indexterm>

      <para>The <application>Xorg</application> drivers provide the means
      for the xserver to take advantage of installed hardware.</para>

      <para><application>Xorg</application> Driver packages can be downloaded
      individually from <ulink
      url="http://xorg.freedesktop.org/releases/individual/driver/"/>.</para>

    <sect3 role="installation">
      <title>Installation of Xorg Drivers</title>

      <warning><para>It is very important not to build display drivers that
      cannot be used with your hardware.  For instance, do not build Sun drivers
      for an x86 PC as the Sun drivers will expect to see SPARC symbols
      exported from the kernel.  Failure to follow this warning will result
      in a display lockup, which requires a hard reboot, when configuring
      <application>Xorg</application> for the first time.</para></warning>

      <para>Install the drivers by running the following commands for each
      package:</para>

<screen><userinput>./configure $XORG_CONFIG \
    --with-xorg-module-dir=$XORG_PREFIX/lib/X11/modules &amp;&amp;
make</userinput></screen>

      <para>Now as the <systemitem class="username">root</systemitem>
      user:</para>

<screen><userinput role="root">make install</userinput></screen>

    </sect3>

  </sect2>

  <sect2 role="configuration" id='xorg7-config'>
    <title>Configuring Xorg</title>

    <para>As the <systemitem class="username">root</systemitem> user ensure you
    have executed <command>ldconfig</command> and
    create the <filename>xorg.conf</filename> file with:</para>

<screen><userinput>cd ~ &amp;&amp;
Xorg -configure</userinput></screen>

    <para>The screen will go black and you may hear some clicking of the monitor.
    This command will create a file, <filename>xorg.conf.new</filename>, in your
    home directory.</para>

    <indexterm zone="xorg7 xorg7-config">
      <primary sortas="e-etc-X11-xorg-conf">/etc/X11/xorg.conf</primary>
    </indexterm>

    <para>Edit <filename>xorg.conf.new</filename> to suit your system. The
    details of the file are located in the xorg.conf man page. Some things
    you may want to do are:</para>

    <itemizedlist>
      <listitem>
        <para>Section "Files". Change the order of the font paths searched.
        You may want to put 100dpi fonts ahead of 75dpi fonts if your system
        normally comes up closer to 100 dots per inch. You may want to remove
        some font directories completely.</para>
      </listitem>
      <listitem>
        <para>Section "Module". If you are going to install NVidia
        drivers, remove the "dri" line.</para>
      </listitem>
      <listitem>
        <para>Sections "InputDevice". You may want to change the
        keyboard autorepeat rate by adding
        <option>Option "Autorepeat" "250 30"</option>.</para>
      </listitem>
      <listitem>
        <para>Section "Monitor". Specify the <option>VertRefresh</option>
        and <option>HorizSync</option> values if the system does not
        automatically detect the monitor and its values.</para>
      </listitem>
      <listitem>
        <para>Section "Device". You may want to set some of the options
        available for your selected video driver. A description of the driver
        parameters is in the man page for your driver.</para>
      </listitem>
      <listitem><para>Section "Screen". Add a DefaultDepth statement such as:
        <option>DefaultDepth 24</option>. In the SubSection for your
        default depth, add a modes line such as:
        <option>Modes "1600x1200" "1280x1024" "1024x768"</option>. The first
        mode listed will normally be the starting resolution.</para>
      </listitem>
    </itemizedlist>

    <para>Test the system with:</para>

<screen><userinput>X -config ~/xorg.conf.new</userinput></screen>

    <para>You will only get a gray background with an X-shaped mouse cursor,
    but it confirms the system is working. Exit with
    <keycap>Control+Alt+Backspace</keycap>. If the system does not work, take
    a look at <filename>/var/log/Xorg.0.log</filename> to see what went
    wrong.</para>

    <para>As the <systemitem class="username">root</systemitem> user, move
    the configuration file to its final location:</para>

<screen role="root"><userinput>mv ~/xorg.conf.new /etc/X11/xorg.conf</userinput></screen>

    <para>As the <systemitem class="username">root</systemitem> user, create
    <filename>.xinitrc</filename>:</para>

<screen><userinput>cat &gt; ~/.xinitrc &lt;&lt; "EOF"
<literal># Begin .xinitrc file
xterm  -g 80x40+0+0   &amp;
xclock -g 100x100-0+0 &amp;
twm</literal>
EOF</userinput></screen>

    <para>This provides an initial screen with a small clock that is
    managed by a simple window manager, Tab Window Manager. For details of
    <command>twm</command>, see the man page.</para>

    <note>
      <para>The above file is the default configuration for Xorg.  Xorg's
      distribution no longer includes <command>xterm</command>, and as such the
      <command>startx</command> command will fail if you have not yet
      installed <xref linkend="xterm2"/>.</para>
    </note>

    <indexterm zone="xorg7 xorg7-config">
      <primary sortas="e-AA.xinitrc">~/.xinitrc</primary>
    </indexterm>

    <note>
      <para>When needed, <application>Xorg</application> creates the directory
      <filename class='directory'>/tmp/.ICE-unix</filename> if it does not
      exist. If this directory is not owned by
      <systemitem class="username">root</systemitem>,
      <application>Xorg</application> delays startup by a few seconds and also
      appends a warning to the logfile. This also affects startup of other
      applications. To improve performance, it is advisable to manually create
      the directory before <application>Xorg</application> uses it. Add the
      file creation to <filename>/etc/sysconfig/createfiles</filename> that is
      sourced by the <filename>/etc/rc.d/init.d/cleanfs</filename> startup
      script.</para>

<screen role="root"><userinput>cat &gt;&gt; /etc/sysconfig/createfiles &lt;&lt; "EOF"
<literal>/tmp/.ICE-unix dir 1777 root root</literal>
EOF</userinput></screen>
    </note>

    <indexterm zone="xorg7 xorg7-config">
      <primary
      sortas="e-etc-sysconfig-createfiles">/etc/sysconfig/createfiles</primary>
    </indexterm>

    <para>Start <application>X</application> with:</para>

<screen><userinput>startx</userinput></screen>

    <para>and a basic functional <application>X Window
    System</application> should be displayed.</para>

    <para>At this point, you should check out <xref linkend='x-setup'/> for
    the necessary configuration to make <application>X</application> fully
    functional. Additionally, you can have a look at <xref linkend='x-config'/>
    for information on fine tuning your <application>X</application>
    configuration.</para>

    <para>For a list of the package contents and a description of the commands,
    see the sections in the <xref linkend='xfree86-contents'/>.</para>

  </sect2>

</sect1>