README.xml 9.98 KB
Newer Older
1
2
3
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
                      "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
4
<!ENTITY % defs SYSTEM "defs.ent"> %defs;
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
5
]>
6

7
<article id='README'>
8

9
10
11
12
<articleinfo>

<title>README for X11R&relvers;</title>

13
<corpauthor><ulink url="https://www.x.org/wiki/XorgFoundation">
14
15
The X.Org Foundation
</ulink></corpauthor>
16

17
<pubdate>&reldate;</pubdate>
18
19
20

<abstract>

21
<para>
22
23
24
25
26
27
X11R&relvers; is an Open Source version of the X Window System that
supports many <trademark class="registered">UNIX</trademark> and UNIX-like
operating systems (such as Linux, FreeBSD, NetBSD, OpenBSD, and Solaris)
on a variety of platforms.  This version is compatible with
X11R&prevrelvers; and other X Window System implementations which support
the X11 standard.
28
</para>
29
30
31

</abstract>

32
</articleinfo>
33

34
<sect1 id='What_is_X11R&relvers;'>
35
<title>What is X11R&relvers;?</title>
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
36

37
<!-- We only do release notes for full releases now.
38
39
<![ %updaterel [
<para>
40
X11R&relvers; is the &whichupdaterel; update to X11R&majorvers;, the
41
42
43
44
45
46
47
48
49
&whichfullrel; full release in the <![ %earlyrel; [new]]> X11R&relvers;
series.
</para>
<para>
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.
</para>
Kevin E Martin's avatar
Kevin E Martin committed
50
51
52
]]>

<![ %minorrel [
53
-->
54
<para>
55
X11R&relvers; was the &whichfullrel; release in the X11R&majorvers; series.
56
</para>
57
<!--
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
58
59
60
]]>

<![ %snapshot [
61
<para>
Egbert Eich's avatar
Egbert Eich committed
62
X11R&relvers; is a pre-release snapshot of X11R&fullrelvers;.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
63
<![ %relcandidate [
64
This snapshot is a release candidate &rcnum; for version &fullrelvers;.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
65
]]>
66
67
68
69
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:
70
<email>xorg@lists.freedesktop.org</email>.
71
</para>
72
]]>
73
 -->
74

75
<para>
76
<!--
77
<![ %majorrel [
78
X11R&relvers; is the first release in the new X11R&majorvers; series.
79
80
81
82
83
84
85
The &relvers; version is a new major release that includes additional
hardware support, functional enhancements and bug fixes.
]]>
<![ %minorrel [
The &relvers; version is a new minor release that includes additional
hardware support, functional enhancements and bug fixes.
]]>
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
86
<![ %haverelnotes [
87
 -->
88
89
Specific release enhancements can be viewed in the <olink
targetdoc="ReleaseNotes" targetptr="ReleaseNotes">Release Notes</olink>.
90
<!--
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
91
]]>
92
 -->
93
</para>
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
94

95
<para>
Kevin E Martin's avatar
Kevin E Martin committed
96
Most modern PC video hardware is supported in this release, and most PC
97
video hardware that isn't supported explicitly can be used with the
98
99
"vesa" driver.  The <olink
targetdoc="ReleaseNotes" targetptr="ReleaseNotes">Release Notes</olink>
Kevin E Martin's avatar
Kevin E Martin committed
100
has a table showing the drivers provided with X11R&relvers;, and links to
Adam Jackson's avatar
Adam Jackson committed
101
related documentation.
102
</para>
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
103

104
<para>
Egbert Eich's avatar
Egbert Eich committed
105
The X.Org Foundation X releases are produced by the X.Org Foundation.
106
107
108
109
The X.Org Foundation is a member project of
<ulink url="https://spi-inc.org/">Software in the Public Interest (SPI)</ulink>,
which operates as a scientific charity under IRS code 501(c)(3).
The X.Org Foundation is chartered
110
111
112
113
114
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
115
<ulink
116
url="https://www.x.org/wiki/Membership"
117
118
>membership application</ulink>.  The X11R&relvers; release has been
produced by the many contributors to the X.Org community and members of
119
the X.Org Foundation and includes code from the X Consortium, the Open
120
121
122
Group and the <trademark class="registered">XFree86</trademark> Project.
This release is dedicated to the greater X community, developers and
users alike.
123
</para>
Egbert Eich's avatar
Egbert Eich committed
124

125
</sect1>
126

127
<!--
128
<![ %snapshot [
129
<sect1 id='Redistribution_of_Snapshots'>
130
131
<title>Redistribution of Snapshots</title>
<para>
132
133
While the X.Org Foundation <olink
targetdoc="License" targetptr="License>License</olink>
134
doesn't
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
135
136
prohibit vendors and others redistributing binaries of this snapshot
release, we don't recommend including them in production releases.
137
138
</para>
</sect1>
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
139
]]>
140
 -->
141

142
<sect1 id='Licensing'>
143
144
145
<title>Licensing</title>

<para>
146
147
148
149
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:
150
151
152
153
154
155
</para>

<para>

<orderedlist>
<listitem>
156

157
158
159
160
161
<para>
Copyright and/or license notices are left intact.
</para>
</listitem>
<listitem>
162

163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
<para>
Copyright and/or license notices are reproduced verbatim in
documentation accompanying binary distributions.
</para>
</listitem>
<listitem>

<para>
Attributions are included with documentation accompanying binaries.
</para>
</listitem>

</orderedlist>

</para>

<para>
180
181
Most of these licenses are based on the MIT, X Consortium, or BSD
(original and revised) licenses.  All of them are consistent with the
182
<ulink
183
url="https://www.opensource.org/docs/definition.php"
184
185
186
>Open Source Definition</ulink
>, and most are
consistent with the Free Software Foundation's <ulink
187
url="https://www.fsf.org/philosophy/free-sw.html"
188
189
190
191
192
>Free Software Definition</ulink
>.
</para>

<para>
Egbert Eich's avatar
Egbert Eich committed
193
Copyright and Licensing information for X, including the reproduction
194
of copyright and/or license notices and attributions required by some
195
196
197
198
of the licenses for binary distributions, can be found in the <olink
targetdoc="License" targetptr="License">License Document</olink>.
If you find any omissions in that document, please contact us with details at
<email>xorg@lists.x.org</email>.
Egbert Eich's avatar
Egbert Eich committed
199
While the current licenses are all open source licenses, the
200
201
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
202
<ulink url="https://www.debian.org/social_contract#guidelines"
203
>Debian Free Software Guidelines</ulink>.
204
</para>
205

206
</sect1>
207

208
<sect1 id='Pointers_to_additional_information'>
209
210
211
212
<title>Pointers to additional information</title>

<para>
The documentation for this release can be found online at the <ulink
213
url="https://www.x.org/">X.Org web site</ulink>.
214
215
216
</para>

<para>
Egbert Eich's avatar
Egbert Eich committed
217
The X11 version numbering system (including historical information)
218
219
can be found in the <olink targetdoc="Versions" targetptr="Versions">Versions
Document</olink>.
220
221
222
</para>

<para>
223
Additional information may be available at the <ulink url="https://wiki.x.org/"
224
225
>X.Org Foundation Wiki</ulink>.
</para>
226

227
</sect1>
228

229
<sect1 id='The_Public_Mailing_Lists'>
230
231
232
<title>The Public Mailing Lists</title>

<para>
233
Current information about the X.Org Foundation public mailing lists is
234
available on <ulink url="https://www.x.org/wiki/XorgMailingLists">the X.Org
235
mailing list page</ulink> and related desktop
236
technology mailing lists can be found on <ulink
237
url="https://freedesktop.org/mailman/listinfo/">Freedesktop.org's mailing list
238
239
240
241
page</ulink>.
</para>

</sect1>
242

243
<sect1 id='Contributing_to_the_X.Org_Foundations_X_efforts.'>
244
245
246
<title>Contributing to the X.Org Foundation's X efforts.</title>

<para>
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
247
If you have any new work or enhancements/bug fixes for existing work,
248
249
250
please submit them via
<ulink url="https://gitlab.freedesktop.org/xorg">the gitlab.freedesktop.org code management system</ulink>.
This will help ensure that they are included
251
252
in future releases.   More details on patch submission and review
process are available on the
253
<ulink url="https://www.x.org/wiki/Development/Documentation/SubmittingPatches">
254
SubmittingPatches</ulink> page of the X.Org wiki.
255
256
257
258
</para>

</sect1>

259
<sect1 id='How_to_get_the_release'>
260
<title>How to get the release</title>
261

262
<!--
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
263
<![ %snapshot; [
264
<para>
265
X11R&relvers; can be found from the <ulink url="https://wiki.x.org">X.Org
266
267
Foundation wiki</ulink>, and at mirrors of this server.
</para>
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
268
269
270
]]>

<![ %release; [
271
-->
272
<para>
Kevin E Martin's avatar
Kevin E Martin committed
273
Information about X11R&relvers; can be found from the
274
<ulink
275
url="https://wiki.x.org"
276
>X.Org Foundation wiki</ulink>, and at
Kevin E Martin's avatar
Kevin E Martin committed
277
mirrors of this server.
278
</para>
279
<!--
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
280
]]>
281
 -->
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
282

283
<sect2 id='X11R&relvers;'>
284
285
286
<title>X11R&relvers;</title>

<para>
287
288
X11R&relvers; was the &whichfullrel; release of the modular source code tree.
The source code has been split into nine logical modules: app, data, doc,
289
290
driver, font, lib. proto, util and xserver.  Each of these modules
contain one or more packages that can be configured, built and installed
291
separately.  Please see an X.Org release site for a complete
292
list of the tarballs.
293
</para>
294

295
296
<para>
For information on how to build the modular tree packages see the <ulink
297
url="https://wiki.x.org/wiki/ModularDevelopersGuide"
298
299
>Modular Developer's Guide</ulink
>.  This guide also
300
301
contains information for developers who want to help improve the modular
build system and modular code base.
302
</para>
303

304
305
</sect2>

306
<sect2 id='The_current_development_tree'>
307
308
309
<title>The current development tree</title>

<para>
Egbert Eich's avatar
Egbert Eich committed
310
The X source code for this and all releases/snapshots as well as
311
development versions can also be accessed via the Freedesktop.org git
312
repository.  It's also possible to browse the <ulink
313
url="https://gitlab.freedesktop.org/xorg/"
314
315
>freedesktop git repository</ulink
>.
316
</para>
317

318
<para>
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
319
To check out the latest development version, don't specify any tag.
320
321
322
</para>

</sect2>
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
323

324
</sect1>
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
325

326
<sect1 id='Reporting_Bugs'>
327
328
329
<title>Reporting Bugs</title>

<para>
330
Bugs should be reported to freedesktop.org's <ulink
331
332
url="https://gitlab.freedesktop.org/xorg/">code management system</ulink>.
Before
333
reporting bugs, please check the server log file, which can be found at
334
335
<filename>/var/log/Xorg.0.log</filename> on most platforms.  If you can't
resolve the problem yourself, send the entire log file with your bug report but
336
337
338
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.
339
340
341
</para>

</sect1>
342
343

</article>