summaryrefslogtreecommitdiff
path: root/xc/programs/Xserver/hw/xfree86/doc/sgml/README.sgml
blob: 6127166fc7c8a6743246fd126f2874f2abd30390 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<!DOCTYPE linuxdoc PUBLIC "-//XFree86//DTD linuxdoc//EN" [
<!ENTITY % defs SYSTEM "defs.ent"> %defs;
<!ENTITY % onediff 'IGNORE'>	<!-- patch is a single diff file -->
<!ENTITY % twodiffs 'INCLUDE'>	<!-- patch is split into two diff files -->
]>


<article>

<title>README for XFree86&tm; &relvers;
<author>The XFree86 Project, Inc
<date>31 August 1999

<ident>
$XFree86: xc/programs/Xserver/hw/xfree86/doc/sgml/README.sgml,v 3.98 1999/08/31 09:09:56 dawes Exp $
</ident>

<abstract>

XFree86 is a port of X11R6.4 that supports several UNIX(R) and UNIX-like
operating systems on Intel and other platforms.

</abstract>

<toc>

<sect>What is XFree86 &relvers;?
<p>

XFree86 &relvers; is a ``work in progress'' snapshot of the XFree86 4.0
development code.  It is <![ %latersnap; [one of]]>
<![ %firstsnap; [the first]]>
in a series of snapshot releases leading up the the 4.0 release.  The
plan is to release a new snapshot every four to six weeks.  The target
audience for this release is developers and others who are comfortable
on the bleeding edge.  This release is not targeted at beginners.
Also, most end users will find life easier using our latest 3.3.x release.
While we welcome bug reports and feedback about this release, we don't
have the resources to provide user-level support for it.  If you're not
comfortable dealing with those sorts of things yourself, then the snapshot
releases are probably not for you.

This code is very much work in progress.  Many of the interfaces may
change without notice between now and the 4.0 release.  The
<htmlurl name="driver design" url="DESIGN.html"> has changed significantly
compared with the 3.3.x versions, and only a small number of drivers have
been converted so far.  That means that this release does not support a
wide range of video hardware.  Some of the drivers and new features are
well developed and reasonably stable, while others are not.

Information on this release's features and their status can be found in
the <htmlurl name="Release Notes" url="RELNOTES.html">.

<sect>Redistribution of the Snapshots
<p>

While the XFree86 <htmlurl name="License" url="LICENSE.html"> doesn't
prohibit vendors and others redistributing binaries of this release, we
don't recommend it.  We ask that if you do distribute such binaries,
you make it clear that people using then should contact you for support
and not XFree86.

<sect>Developers
<p>

If you would like to work on the development on XFree86 4.0, then it is
recommended that you <url name="join the XFree86 development team"
url="http://www.xfree86.org:/developer.html">.  That way you will have access
to the latest source and to other developers.

<sect>How to get XFree86 &relvers;
<p>

XFree86 &relvers; can be found at the <url name="XFree86 ftp server"
url="ftp://ftp.xfree86.org/pub/XFree86/snapshots/&relvers;/">, and at
mirrors of this server.  This snapshot is available primarily in source
form.  Binaries for some platforms may be made available at a later time.

The source for version &relvers; is split into three tarballs:
<tt>X&srcvers;src-1.tgz</tt>, <tt>X&srcvers;src-2.tgz</tt>,
<tt>X&srcvers;src-3.tgz</tt>.  The first contains everything except the
fonts and general X11 documentation.  It is sufficient for building
XFree86 is you already have a set of fonts.  The second contains the
fonts and the source for the general X11 documentation.  The third
contains the general X11 documentation in hardcopy format.

<![ %onediff; [
A source patch relative to version &prevrelvers; is also available.
The patch file is <tt>&prevrelvers;-&relvers;.diff.gz</tt>.  This 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>
gunzip &lt; &prevrelvers;-&relvers;.diff.gz | patch -p0 -E
</verb></tscreen>
]]>

<![ %twodiffs; [
A source patch relative to version &prevrelvers; is also available.
Because of its size, it is split into two parts.
The patch files are <tt>&prevrelvers;-&relvers;.diff1.gz</tt> and
<tt>&prevrelvers;-&relvers;.diff2.gz</tt>.  These patches should
be applied to a clean &prevrelvers; source tree, working from the directory
containing the <tt>xc/</tt> directory.  The patches should be applied by
running:

<tscreen><verb>
gunzip &lt; &prevrelvers;-&relvers;.diff1.gz | patch -p0 -E
gunzip &lt; &prevrelvers;-&relvers;.diff2.gz | patch -p0 -E
rm -fr xc/fonts/scaled/Type1/latin2
</verb></tscreen>
]]>

The contrib part of the distribution can be found in the following tarball:
<tt>X&srcvers;contrib.tgz</tt>.

To format the XFree86 documentation, the latest version of our doctools
package.  That is available as <tt>doctools-1.1.tgz</tt>.

<sect>Reporting Bugs
<p>

Bugs should be reported to <email>XFree86@XFree86.org</email>.  Before
reporting bugs, please check the X server log file, which can be found
at <tt>/var/log/XFree86.0.log</tt> on most platforms.  If you can't resolve
the problem yourself, send the entire log file with your bug report.  Please
don't edit out what you think might not be important.  The information
contained in the log file is there to make it easier for the developers
to determine what is going wrong when there are problems.



</article>