components/x11/xorg-docs/src/README.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>README for X11R7.7</title><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot_9276" /><meta name="description" content="X11R7.7 is an Open Source version of the X Window System that supports many UNIX and UNIX-like operating systems (such as Linux, FreeBSD, NetBSD, OpenBSD, and Solaris) on a variety of platforms. This version is compatible with X11R7.6 and other X Window System implementations which support the X11 standard." /><style xmlns="" type="text/css">/*
   4  * Copyright (c) 2011 Gaetan Nadon
   5  * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the next
  15  * paragraph) shall be included in all copies or substantial portions of the
  16  * Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  24  * DEALINGS IN THE SOFTWARE.
  25  */
  26
  27 /*
  28  * Shared stylesheet for X.Org documentation translated to HTML format
  29  * http://www.sagehill.net/docbookxsl/UsingCSS.html
  30  * http://www.w3schools.com/css/default.asp
  31  * https://addons.mozilla.org/en-US/firefox/addon/web-developer/developers
  32  * https://addons.mozilla.org/en-US/firefox/addon/font-finder/
  33  */
  34
  35 /*
  36  * The sans-serif fonts are considered more legible on a computer screen
  37  * http://dry.sailingissues.com/linux-equivalents-verdana-arial.html
  38  *
  39  */
  40 body {
  41   font-family: "Bitstream Vera Sans", "DejaVu Sans", Tahoma, Geneva, Arial, Sans-serif;
  42   /* In support of using "em" font size unit, the w3c recommended method */
  43   font-size: 100%;
  44 }
  45
  46 /*
  47  * Selection: all elements requiring mono spaced fonts.
  48  *
  49  * The family names attempt to match the proportionally spaced font
  50  * family names such that the same font name is used for both.
  51  * We'd like to use Bitstream, for example, in both proportionally and
  52  * mono spaced font text.
  53  */
  54 .command,
  55 .errorcode,
  56 .errorname,
  57 .errortype,
  58 .filename,
  59 .funcsynopsis,
  60 .function,
  61 .parameter,
  62 .programlisting,
  63 .property,
  64 .screen,
  65 .structname,
  66 .symbol,
  67 .synopsis,
  68 .type
  69 {
  70   font-family:  "Bitstream Vera Sans Mono", "DejaVu Sans Mono", Courier, "Liberation Mono", Monospace;
  71 }
  72
  73 /*
  74  * Books have a title page, a preface, some chapters and appendices,
  75  * a glossary, an index and a bibliography, in that order.
  76  *
  77  * An Article has no preface and no chapters. It has sections, appendices,
  78  * a glossary, an index and a bibliography.
  79  */
  80
  81 /*
  82  * Selection: book main title and subtitle
  83  */
  84 div.book>div.titlepage h1.title,
  85 div.book>div.titlepage h2.subtitle {
  86   text-align: center;
  87 }
  88
  89 /*
  90  * Selection: article main title and subtitle
  91  */
  92 div.article>div.titlepage h2.title,
  93 div.article>div.titlepage h3.subtitle,
  94 div.article>div.sect1>div.titlepage h2.title,
  95 div.article>div.section>div.titlepage h2.title {
  96   text-align: center;
  97 }
  98
  99 /*
 100  * Selection: various types of authors and collaborators, individuals or corporate
 101  *
 102  * These authors are not always contained inside an authorgroup.
 103  * They can be contained inside a lot of different parent types where they might
 104  * not be centered.
 105  * Reducing the margin at the bottom makes a visual separation between authors
 106  * We specify here the ones on the title page, others may be added based on merit.
 107  */
 108 div.titlepage .authorgroup,
 109 div.titlepage .author,
 110 div.titlepage .collab,
 111 div.titlepage .corpauthor,
 112 div.titlepage .corpcredit,
 113 div.titlepage .editor,
 114 div.titlepage .othercredit {
 115   text-align: center;
 116   margin-bottom: 0.25em;
 117 }
 118
 119 /*
 120  * Selection: the affiliation of various types of authors and collaborators,
 121  * individuals or corporate.
 122  */
 123 div.titlepage .affiliation {
 124   text-align: center;
 125 }
 126
 127 /*
 128  * Selection: product release information (X Version 11, Release 7)
 129  *
 130  * The releaseinfo element can be contained inside a lot of different parent
 131  * types where it might not be centered.
 132  * We specify here the one on the title page, others may be added based on merit.
 133  */
 134 div.titlepage p.releaseinfo {
 135   font-weight: bold;
 136   text-align: center;
 137 }
 138
 139 /*
 140  * Selection: publishing date
 141  */
 142 div.titlepage .pubdate {
 143   text-align: center;
 144 }
 145
 146 /*
 147  * The legal notices are displayed in smaller sized fonts
 148  * Justification is only supported in IE and therefore not requested.
 149  *
 150  */
 151 .legalnotice {
 152   font-size: small;
 153   font-style: italic;
 154 }
 155
 156 /*
 157  * For documentation having multiple licenses, the copyright and legalnotice
 158  * elements sequence cannot instantiated multiple times.
 159  * The copyright notice and license text are therefore coded inside a legalnotice
 160  * element. The role attribute on the paragraph is used to allow styling of the
 161  * copyright notice text which should not be italicized.
 162  */
 163 p.multiLicensing {
 164   font-style: normal;
 165   font-size: medium;
 166 }
 167
 168 /*
 169  * Selection: book or article main ToC title
 170  * A paragraph is generated for the title rather than a level 2 heading.
 171  * We do not want to select chapters sub table of contents, only the main one
 172  */
 173 div.book>div.toc>p,
 174 div.article>div.toc>p {
 175   font-size: 1.5em;
 176   text-align: center;
 177 }
 178
 179 /*
 180  * Selection: major sections of a book or an article
 181  *
 182  * Unlike books, articles do not have a titlepage element for appendix.
 183  * Using the selector "div.titlepage h2.title" would be too general.
 184  */
 185 div.book>div.preface>div.titlepage h2.title,
 186 div.book>div.chapter>div.titlepage h2.title,
 187 div.article>div.sect1>div.titlepage h2.title,
 188 div.article>div.section>div.titlepage h2.title,
 189 div.book>div.appendix>div.titlepage h2.title,
 190 div.article>div.appendix h2.title,
 191 div.glossary>div.titlepage h2.title,
 192 div.index>div.titlepage h2.title,
 193 div.bibliography>div.titlepage h2.title {
 194    /* Add a border top over the major parts, just like printed books */
 195    /* The Gray color is already used for the ruler over the main ToC. */
 196   border-top-style: solid;
 197   border-top-width: 2px;
 198   border-top-color: Gray;
 199   /* Put some space between the border and the title */
 200   padding-top: 0.2em;
 201   text-align: center;
 202 }
 203
 204 /*
 205  * A Screen is a verbatim environment for displaying text that the user might
 206  * see on a computer terminal. It is often used to display the results of a command.
 207  *
 208  * http://www.css3.info/preview/rounded-border/
 209  */
 210 .screen {
 211   background: #e0ffff;
 212   border-width: 1px;
 213   border-style: solid;
 214   border-color: #B0C4DE;
 215   border-radius: 1.0em;
 216   /* Browser's vendor properties prior to CSS 3 */
 217   -moz-border-radius: 1.0em;
 218   -webkit-border-radius: 1.0em;
 219   -khtml-border-radius: 1.0em;
 220   margin-left: 1.0em;
 221   margin-right: 1.0em;
 222   padding: 0.5em;
 223 }
 224
 225 /*
 226  * Emphasis program listings with a light shade of gray similar to what
 227  * DocBook XSL guide does: http://www.sagehill.net/docbookxsl/ProgramListings.html
 228  * Found many C API docs on the web using like shades of gray.
 229  */
 230 .programlisting {
 231   background: #F4F4F4;
 232   border-width: 1px;
 233   border-style: solid;
 234   border-color: Gray;
 235   padding: 0.5em;
 236 }
 237
 238 /*
 239  * Emphasis functions synopsis using a darker shade of gray.
 240  * Add a border such that it stands out more.
 241  * Set the padding so the text does not touch the border.
 242  */
 243 .funcsynopsis, .synopsis {
 244   background: #e6e6fa;
 245   border-width: 1px;
 246   border-style: solid;
 247   border-color: Gray;
 248   clear: both;
 249   margin: 0.5em;
 250   padding: 0.25em;
 251 }
 252
 253 /*
 254  * Selection: paragraphs inside synopsis
 255  *
 256  * Removes the default browser margin, let the container set the padding.
 257  * Paragraphs are not always used in synopsis
 258  */
 259 .funcsynopsis p,
 260 .synopsis p {
 261   margin: 0;
 262   padding: 0;
 263 }
 264
 265 /*
 266  * Selection: variable lists, informal tables and tables
 267  *
 268  * Note the parameter name "variablelist.as.table" in xorg-xhtml.xsl
 269  * A table with rows and columns is constructed inside div.variablelist
 270  *
 271  * Set the left margin so it is indented to the right
 272  * Display informal tables with single line borders
 273  */
 274 table {
 275   margin-left: 0.5em;
 276   border-collapse: collapse;
 277 }
 278
 279 /*
 280  * Selection: paragraphs inside tables
 281  *
 282  * Removes the default browser margin, let the container set the padding.
 283  * Paragraphs are not always used in tables
 284  */
 285 td p {
 286   margin: 0;
 287   padding: 0;
 288 }
 289
 290 /*
 291  * Add some space between the left and right column.
 292  * The vertical alignment helps the reader associate a term
 293  * with a multi-line definition.
 294  */
 295 td, th {
 296   padding-left: 1.0em;
 297   padding-right: 1.0em;
 298   vertical-align: top;
 299 }
 300
 301 .warning {
 302   border: 1px solid red;
 303   background: #FFFF66;
 304   padding-left: 0.5em;
 305 }
 306 </style></head><body><div class="article"><div class="titlepage"><div><div><h2 class="title"><a id="README"></a>README for X11R7.7</h2></div><div><h3 class="corpauthor"><a class="ulink" href="http://www.x.org/wiki/XorgFoundation" target="_top">
 307 The X.Org Foundation
 308 </a></h3></div><div><p class="pubdate">April 2012</p></div><div><div class="abstract"><p>
 309 X11R7.7 is an Open Source version of the X Window System that
 310 supports many <span class="trademark">UNIX</span>® and UNIX-like
 311 operating systems (such as Linux, FreeBSD, NetBSD, OpenBSD, and Solaris)
 312 on a variety of platforms.  This version is compatible with
 313 X11R7.6 and other X Window System implementations which support
 314 the X11 standard.
 315 </p></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="sect1"><a href="#What_is_X11R7.7">What is X11R7.7?</a></span></dt><dt><span class="sect1"><a href="#Licensing">Licensing</a></span></dt><dt><span class="sect1"><a href="#Pointers_to_additional_information">Pointers to additional information</a></span></dt><dt><span class="sect1"><a href="#The_Public_Mailing_Lists">The Public Mailing Lists</a></span></dt><dt><span class="sect1"><a href="#Contributing_to_the_X.Org_Foundations_X_efforts.">Contributing to the X.Org Foundation's X efforts.</a></span></dt><dt><span class="sect1"><a href="#How_to_get_the_release">How to get the release</a></span></dt><dd><dl><dt><span class="sect2"><a href="#X11R7.7">X11R7.7</a></span></dt><dt><span class="sect2"><a href="#The_current_development_tree">The current development tree</a></span></dt></dl></dd><dt><span class="sect1"><a href="#Reporting_Bugs">Reporting Bugs</a></span></dt></dl></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="What_is_X11R7.7"></a>What is X11R7.7?</h2></div></div></div><p>
 316 X11R7.7 is the eighth release in the X11R7 series.
 317 </p><p>
 318
 319 Specific release enhancements can be viewed in the <a href="ReleaseNotes.html#ReleaseNotes" class="olink">Release Notes</a>.
 320
 321 </p><p>
 322 Most modern PC video hardware is supported in this release, and most PC
 323 video hardware that isn't supported explicitly can be used with the
 324 "vesa" driver.  The <a href="ReleaseNotes.html#ReleaseNotes" class="olink">Release Notes</a>
 325 has a table showing the drivers provided with X11R7.7, and links to
 326 related documentation.
 327 </p><p>
 328 The X.Org Foundation X releases are produced by the X.Org Foundation.
 329 The X.Org Foundation has been formed as a Delaware corporation organized
 330 to operate as a scientific charity under IRS code 501(c)(3) chartered
 331 to develop and execute effective strategies which provide world-wide
 332 stewardship of the X Window System technology and standards. Membership
 333 in the X.Org Foundation is free to all participants. Applications for
 334 Membership are now being accepted, and active participants in the
 335 further development of the X Window Technology are invited to complete a
 336 <a class="ulink" href="http://www.x.org/wiki/Membership" target="_top">membership application</a>.  The X11R7.7 release has been
 337 produced by the many contributors to the X.Org community and members of
 338 the X.Org Foundation and includes code from the X Consortium, the Open
 339 Group and the <span class="trademark">XFree86</span>® Project.
 340 This release is dedicated to the greater X community, developers and
 341 users alike.
 342 </p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Licensing"></a>Licensing</h2></div></div></div><p>
 343 X Window System source code is covered by many licenses.  All of these
 344 licenses have in common the fact that they do not impose significant
 345 conditions on the modification or redistribution or either source code
 346 or binaries beyond requiring one or more of the following:
 347 </p><p>
 348
 349 </p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p>
 350 Copyright and/or license notices are left intact.
 351 </p></li><li class="listitem"><p>
 352 Copyright and/or license notices are reproduced verbatim in
 353 documentation accompanying binary distributions.
 354 </p></li><li class="listitem"><p>
 355 Attributions are included with documentation accompanying binaries.
 356 </p></li></ol></div><p>
 357
 358 </p><p>
 359 Most of these licenses are based on the MIT, X Consortium, or BSD
 360 (original and revised) licenses.  All of them are consistent with the
 361 <a class="ulink" href="http://www.opensource.org/docs/definition.php" target="_top">Open Source Definition</a>, and most are
 362 consistent with the Free Software Foundation's <a class="ulink" href="http://www.fsf.org/philosophy/free-sw.html" target="_top">Free Software Definition</a>.
 363 </p><p>
 364 Copyright and Licensing information for X, including the reproduction
 365 of copyright and/or license notices and attributions required by some
 366 of the licenses for binary distributions, can be found in the <a href="License.html#License" class="olink">License Document</a>.
 367 If you find any omissions in that document, please contact us with details at
 368 <code class="email">&lt;<a class="email" href="mailto:xorg@lists.x.org">xorg@lists.x.org</a>&gt;</code>.
 369 While the current licenses are all open source licenses, the
 370 X.Org Foundation is attempting, with time, to bring as much as
 371 possible of the code's licenses in the distribution into compliance with the
 372 <a class="ulink" href="http://www.debian.org/social_contract#guidelines" target="_top">Debian Free Software Guidelines</a>.
 373 </p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Pointers_to_additional_information"></a>Pointers to additional information</h2></div></div></div><p>
 374 The documentation for this release can be found online at the <a class="ulink" href="http://www.x.org/" target="_top">X.Org web site</a>.
 375 </p><p>
 376 The X11 version numbering system (including historical information)
 377 can be found in the <a href="Versions.html#Versions" class="olink">Versions
 378 Document</a>.
 379 </p><p>
 380 Additional information may be available at the <a class="ulink" href="http://wiki.x.org/" target="_top">X.Org Foundation Wiki</a>.
 381 </p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="The_Public_Mailing_Lists"></a>The Public Mailing Lists</h2></div></div></div><p>
 382 Current information about the X.Org Foundation public mailing lists is
 383 available on <a class="ulink" href="http://www.x.org/wiki/XorgMailingLists" target="_top">the X.Org
 384 mailing list page</a> and related desktop
 385 technology mailing lists can be found on <a class="ulink" href="http://freedesktop.org/mailman/listinfo" target="_top">Freedesktop.org's mailing list
 386 page</a>.
 387 </p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Contributing_to_the_X.Org_Foundations_X_efforts."></a>Contributing to the X.Org Foundation's X efforts.</h2></div></div></div><p>
 388 If you have any new work or enhancements/bug fixes for existing work,
 389 please send them as git format patches to
 390 <code class="email">&lt;<a class="email" href="mailto:xorg-devel@lists.freedesktop.org">xorg-devel@lists.freedesktop.org</a>&gt;</code> or to our
 391 <a class="ulink" href="https://bugs.freedesktop.org/" target="_top">bug tracking system</a>
 392 using the xorg component.  This will help ensure that they are included
 393 in future releases.   More details on patch submission and review
 394 process are available on the
 395 <a class="ulink" href="http://www.x.org/wiki/Development/Documentation/SubmittingPatches" target="_top">
 396 SubmittingPatches</a> page of the X.Org wiki.
 397 </p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="How_to_get_the_release"></a>How to get the release</h2></div></div></div><p>
 398 Information about X11R7.7 can be found from the
 399 <a class="ulink" href="http://wiki.x.org" target="_top">X.Org Foundation wiki</a>, and at
 400 mirrors of this server.
 401 </p><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="X11R7.7"></a>X11R7.7</h3></div></div></div><p>
 402 This is the eighth release of the new modular source code tree.  The
 403 source code has been split into nine logical modules: app, data, doc,
 404 driver, font, lib. proto, util and xserver.  Each of these modules
 405 contain one or more packages that can be configured, built and installed
 406 separately.  Please see an X11R7.7 release site for a complete
 407 list of the tarballs.
 408 </p><p>
 409 For information on how to build the modular tree packages see the <a class="ulink" href="http://wiki.x.org/wiki/ModularDevelopersGuide" target="_top">Modular Developer's Guide</a>.  This guide also
 410 contains information for developers who want to help improve the modular
 411 build system and modular code base.
 412 </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="The_current_development_tree"></a>The current development tree</h3></div></div></div><p>
 413 The X source code for this and all releases/snapshots as well as
 414 development versions can also be accessed via the Freedesktop.org git
 415 repository.  It's also possible to browse the <a class="ulink" href="http://cgit.freedesktop.org/xorg/" target="_top">freedesktop git repository</a>.
 416 </p><p>
 417 To check out the latest development version, don't specify any tag.
 418 </p></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Reporting_Bugs"></a>Reporting Bugs</h2></div></div></div><p>
 419 Bugs should be reported to freedesktop.org's <a class="ulink" href="https://bugs.freedesktop.org/" target="_top">bug tracking system</a>
 420 using the xorg component.  Before
 421 reporting bugs, please check the server log file, which can be found at
 422 <code class="filename">/var/log/Xorg.0.log</code> on most platforms.  If you can't
 423 resolve the problem yourself, send the entire log file with your bug report but
 424 not the operating system core dump.  Do not edit the log file as our
 425 developers use it to reproduce and debug your problem.  Please attach it
 426 to your bug report.
 427 </p></div></div></body></html>