path: root/sgml/README.sgml

<!DOCTYPE linuxdoc PUBLIC "-//Xorg//DTD linuxdoc//EN" [
<!ENTITY % defs SYSTEM "defs.ent"> %defs;
<!ENTITY % onediff 'IGNORE'>	 <!-- patch is a single diff file -->
<!ENTITY % twodiffs 'IGNORE'>	 <!-- patch is split into two diff files -->
<!ENTITY % threediffs 'IGNORE'> <!-- patch is split into three diff files -->
<!ENTITY % fourdiffs 'IGNORE'> <!-- patch is split into four diff files -->
<!ENTITY % difftar 'IGNORE'> <!-- patch also contains a tarball -->
<!ENTITY % removefiles 'IGNORE'> <!-- patching requires removing some files -->
]>


<article>

<title>README for X11R&relvers;
<author>The X.Org Foundation
<date>&reldate;

<ident>
$Id$.
</ident>

<abstract>

X11R&relvers; is an Open Source version of the X Window System that
supports many UNIX(R) and UNIX-like operating systems (such as Linux,
FreeBSD, NetBSD, OpenBSD and Solaris x86) on Intel and other platforms.
This version is compatible with X11R&prevrelvers; and other X window
system implementations which support the X11R&majorvers; standard.

</abstract>

<toc>

<sect>What is X11R&relvers;?
<p>
<![ %updaterel [
X11R&relvers; is the &whichupdaterel; update to X11R&majorvers;,
the &whichfullrel; full release in the
<![ %earlyrel; [new]]>
X11R&relvers; series.


Update releases are taken from a stable/maintenance branch.  They are
designed to be installed on top of the full release that they are
updating.  They contain fixes for serious problems, most commonly
fixes for security issues, fixes for driver bugs, and fixes that improve
stability.
]]>

<![ %fullrel [
X11R&relvers; is the &whichfullrel; full release in the
<![ %earlyrel; [new]]>
X11R&majorvers; series.
]]>

<![ %snapshot [
X11R&relvers; is a pre-release snapshot of X11R&fullrelvers;.
<![ %relcandidate [
This snapshot is release candidate &rcnum; for version &fullrelvers;.
]]>
Pre-release snapshots are provided for beta testing.  You should only install
snapshots if you're comfortable dealing with possibly unstable beta-level
software.  If you find problems with this snapshot, you are encouraged
to report your findings to the public X.Org server mailing list:
<email>xorg@freedesktop.org</email>.

<![ %relcandidate [
X11R&relvers; is a feature-complete snapshot of X11R&fullrelvers;.
]]>
]]> 

<p>
X11R&relvers; is the current X.Org Foundation release series.
The core of X11R&relvers; is a modular X server.
<![ %fullrel [The &relvers; version is a new release that includes
additional hardware support, functional enhancements and bug fixes.]]>
<![ %haverelnotes [
Specific release enhancements can be viewed in the
<htmlurl name="Release Notes" url="RELNOTES.html">.
]]>

Most modern PC video hardware is supported in X11R&relvers;, and
most PC video hardware that isn't supported explicitly can be used with
the "vesa" driver.  The <htmlurl name="Release Notes" url="RELNOTES3.html">
has a table showing the drivers provided with X11R&relvers;, and links
to related documentation.

The X.Org Foundation X releases are produced by the X.Org Foundation.
The X.Org Foundation has been formed as a Delaware corporation organized to operate as a 
scientific charity under IRS code 501(c)(3) to chartered to develop and 
execute effective strategies which provide world-wide stewardship of the 
X Window System technology and standards. Membership in the X.Org 
Foundation is free to all participants. 
Applications for Membership are now being accepted, 
and active participants in the further development of the X Window 
Technology are invited to complete a
<url url="http://www.x.org/XOrg_Foundation_Membership.html" name="membership application">.
The X11R&relvers; codebase forms the second X window system release since
the formation of the X.org foundataion and includes code from the X
Consortium, the Open Group and the XFree86&trade; project.
This release is dedicated to the greater X community, developers
and users alike.

<![ %snapshot [
<sect>Redistribution of Snapshots
<p>

While the X.Org Foundation <htmlurl name="License" url="LICENSE.html"> doesn't
prohibit vendors and others redistributing binaries of this snapshot
release, we don't recommend including them in production releases.
]]>

<sect>Licensing
<p>

X Window System source code is covered by many licenses.  All of these licenses
have in common the fact that they do not impose significant conditions
on the modification or redistribution or either source code or binaries
beyond requiring one or more of the following:

<enum>
<item>Copyright and/or license notices are left intact.
<item>Copyright and/or license notices are reproduced verbatim in
	documentation accompanying binary distributions.
<item>Attributions are included with documentation accompanying binaries.
</enum>

Most of these licenses are based on the MIT, X Consortium, or BSD
(original and revised) licenses.  All of them are consistent with the
<htmlurl name="Open Source Definition"
url="http://www.opensource.org/docs/definition.php">, and most are
consistent with the Free Software Foundation's <htmlurl name="Free
Software Definition" url="http://www.fsf.org/philosophy/free-sw.html">.

Copyright and Licensing information for X, including the reproduction
of copyright and/or license notices and attributions required by some
of the licenses for binary distributions, can be found in the <htmlurl
name="License Document" url="LICENSE.html">.  If you find any omissions
in that document, please contact us with details at
<email>xf_board@x.org</email>.
While the current licenses are all open source licenses, the
X.Org Foundation is attempting, with time, to bring as much as 
possible of the code's licenses in the distribution into compliance with the 
<htmlurl name="Debian Free Software Guidelines" 
url="http://www.debian.org/social_contract#guidelines">.
<sect>Pointers to additional information
<p>

The documentation for this release can be found online at the <url
name="X.Org web site" url="http://wiki.x.org/">.
Information about binary distributions and the attendant installation
instructions can be found in the <htmlurl name="Installation Document"
url="Install.html">.

The X11 version numbering system (including historical information)
can be found in the <htmlurl name="Versions Document" url="Versions.html">.

Additional information may be available at the <url
name="X.Org Foundation Wiki" url="http://wiki.x.org/">.

<sect>The Public Mailing Lists
<p>
Current information about the X.Org Foundation public mailing lists 
is available on <url name="the X.Org mailing list page" url="http://www.x.org/XOrg_Foundation_Join_OpenLists.html"> and related desktop technology
mailing lists can be found on <url name="Freedesktop.org's mailing list page"
url="http://freedesktop.org/mailman/listinfo">.

<sect>Contributing to the X.Org Foundation's X efforts.
<p>
If you have any new work or enhancements/bug fixes for existing work,
please send them to <email>xorg@freedesktop.org</email> or to our <url
name="bug tracking system" url="http://bugzilla.freedesktop.org/"> using
the xorg component.  This will
ensure that they are included in future releases.

<sect>How to get X11R&relvers;
<p>
<![ %snapshot; [
X11R&relvers; can be found from the <url name="X.Org Foundation wiki at"
url="http://wiki.x.org">, and at
mirrors of this server.
]]>

<![ %release; [
X11R&relvers; can be found from the <url name="X.Org Foundation wiki at"
url="http://wiki.x.org">, and at
mirrors of this server.
Information about obtaining and installing
binary distributions of this release can be found in the
<htmlurl name="Installation Document" url="Install.html">.  Information about
obtaining the release in source form is given below.
]]>

<![ %updaterel; [
The source for version &relvers; is available as a patch relative to
&prevrelvers;.
The patch file is <tt>&prevrelvers;-&relvers;.diff.gz</tt>.

The patch
should be applied to a clean &prevrelvers; source tree, working from
the directory containing the <tt>xc/</tt> directory.  The patch should
be applied by running:

<tscreen><verb>
gzip -d &lt; &prevrelvers;-&relvers;.diff.gz | patch -p0 -E
</verb></tscreen>

Information about getting the source for &prevrelvers can be found in the
README file for that version, which can be found on the
<url name="X.Org foundation wiki" url="http://wiki.x.org">.
]]>

<![ %fullrel [
The source for version &fullrelvers; is split into seven tarballs:

<tscreen><verb>
X11R&fullrelvers;-src1.tar.gz
X11R&fullrelvers;-src2.tar.gz
X11R&fullrelvers;-src3.tar.gz
X11R&fullrelvers;-src4.tar.gz
X11R&fullrelvers;-src5.tar.gz
X11R&fullrelvers;-src6.tar.gz
X11R&fullrelvers;-src7.tar.gz
</verb></tscreen>

The first three contain everything
except the fonts and general X11 documentation.  Those three are sufficient
for building X11R&relvers; if you already have a set of fonts.  The fourth
and fifth contain the fonts.  The sixth contains the source for the
general X11 documentation.  The seventh contains the general X11
documentation in hardcopy format.

<![ %onediff; [
A source patch relative to version &prevfullrelvers; is also available.
The patch file is <tt>X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff.gz</tt>.
<![ %difftar; [
There is also a tarball that contains some files that have components that
can't be included in a diff.  It is
<tt>X11R&relvers;-&prevfullrelvers;-&fullrelvers;-diff0.tgz</tt>.
]]>
The patch
should be applied to a clean &prevfullrelvers; source tree, working from
the directory containing the <tt>xc/</tt> directory.  The patch should
be applied by running:

<tscreen><verb>
gzip -d &lt; X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff.gz | patch -p0 -E
</verb></tscreen>
<![ %difftar; [
<tscreen><verb>
gzip -d &lt; X11R&relvers;-&prevfullrelvers;-&fullrelvers;-diff0.tgz | tar vxf -
</verb></tscreen>
]]>
]]>

<![ %twodiffs; [
A source patch relative to version &prevfullrelvers; is also available.
Because of its size, it is split into two parts.  The patch files are
<tt>X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff1.gz</tt> and
<tt>X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff2.gz</tt>.
<![ %difftar; [
There is also a tarball that contains some files that have components that
can't be included in a diff.  It is <tt>X11R&relvers;-&prevfullrelvers;-&fullrelvers;-diff0.tgz</tt>.
]]>
These patches should
be applied to a clean &prevfullrelvers; source tree, working from the directory
containing the <tt>xc/</tt> directory.  The patches should be applied by
running:

<tscreen><verb>
gzip -d &lt; X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff1.gz | patch -p0 -E
gzip -d &lt; X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff2.gz | patch -p0 -E
</verb></tscreen>
<![ %difftar; [
<tscreen><verb>
gzip -d &lt; X11R&relvers;-&prevfullrelvers;-&fullrelvers;-diff0.tgz | tar vxf -
</verb></tscreen>
]]>
]]>

<![ %threediffs; [
A source patch relative to version &prevfullrelvers; is also available.
Because of its size, it is split into three parts.
The patch files are:

<tscreen><verb>
X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff1.gz
X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff2.gz
X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff3.gz
</verb></tscreen>

<![ %difftar; [
There is also a tarball that contains some files that have components that
can't be included in a diff.  It is
<tt>X11R&relvers;-&prevfullrelvers;-&fullrelvers;-diff0.tgz</tt>.
]]>
These patches should
be applied to a clean &prevfullrelvers; source tree, working from the directory
containing the <tt>xc/</tt> directory.  The patches should be applied by
running:

<tscreen><verb>
gzip -d &lt; X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff1.gz | patch -p0 -E
gzip -d &lt; X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff2.gz | patch -p0 -E
gzip -d &lt; X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff3.gz | patch -p0 -E
</verb></tscreen>
<![ %difftar; [
<tscreen><verb>
gzip -d &lt; X11R&relvers;-&prevfullrelvers;-&fullrelvers;-diff0.tgz | tar vxf -
</verb></tscreen>
]]>
]]>

<![ %fourdiffs; [
A source patch relative to version &prevfullrelvers; is also available.
Because of its size, it is split into four parts.
The patch files are:

<tscreen><verb>
X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff1.gz
X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff2.gz
X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff3.gz
X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff4.gz
</verb></tscreen>

<![ %difftar; [
There is also a tarball and a cleanup script that handle files that have
components that can't be included in a diff.  These are:

<tscreen><verb>
X11R&relvers;-&prevfullrelvers;-&fullrelvers;-diff0.tgz
X11R&relvers;-&prevfullrelvers;-&fullrelvers;-cleanup.sh
</verb></tscreen>

]]>
These patches should
be applied to a clean &prevfullrelvers; source tree, working from the directory
containing the <tt>xc/</tt> directory.  The patches should be applied by
running:

<tscreen><verb>
gzip -d &lt; X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff1.gz | patch -p0 -E
gzip -d &lt; X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff2.gz | patch -p0 -E
gzip -d &lt; X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff3.gz | patch -p0 -E
gzip -d &lt; X11R&relvers;-&prevfullrelvers;-&fullrelvers;.diff4.gz | patch -p0 -E
</verb></tscreen>
<![ %difftar; [
<tscreen><verb>
sh X11R&relvers;-&prevfullrelvers;-&fullrelvers;-cleanup.sh
gzip -d &lt; X11R&relvers;-&prevfullrelvers;-&fullrelvers;-diff0.tgz | tar vxf -
</verb></tscreen>
]]>
]]>

<!--
<![ %prevrelwasupdate; [
Patches might also be available relative to &prevrelvers;.  If so, the
instructions for applying them are the same, except that you should start 
with a clean &prevrelvers; source tree.
]]>
-->

To format the X11R&relvers; documentation use the latest version of our doctools
package available from the Xorg CVS repository's "doctools" module.
]]>  <!-- fullrel -->

The X source code for this and all releases/snapshots as well as
development versions can also be accessed via the Freedesktop.org 
CVS repository.
It's also possible to browse the <url name="freedesktop CVS repository"
url="http://cvs.freedesktop.org/">.  The CVS tag for this version is
"&reltag;".
<![ %notsnapshot [
The CVS tag for the stable branch for this release is "&relbranchtag;".
]]>
To check out the latest development version, don't specify any tag.


<sect>Reporting Bugs
<p>

Bugs should be reported to <url
name="bug tracking system" url="http://bugzilla.freedesktop.org/"> using
the xorg compoent.   Before
reporting bugs, please check the server log file, which can be
found at <tt>/var/log/Xorg.0.log</tt> on most platforms.  If you
can't resolve the problem yourself, send the entire log file with your
bug report but not the operating system core dump.  Do not edit  the
log file as our developers use it to reproduce and debug your problem.
Please attach it to your bug report.

</article>