Author: branden Date: 2004-06-23 13:43:38 -0500 (Wed, 23 Jun 2004) New Revision: 1561
Modified: trunk/debian/CHANGESETS trunk/debian/TODO trunk/debian/changelog trunk/debian/local/FAQ.xhtml Log: Add "How to Use this Document" and "Acknowledgements" sections to FAQ. Modified: trunk/debian/CHANGESETS =================================================================== --- trunk/debian/CHANGESETS 2004-06-23 17:31:33 UTC (rev 1560) +++ trunk/debian/CHANGESETS 2004-06-23 18:43:38 UTC (rev 1561) @@ -44,4 +44,7 @@ server, if possible. 1557, 1558 +Add "How to Use this Document" and "Acknowledgements" sections to FAQ. + 1561 + vim:set ai et sts=4 sw=4 tw=80: Modified: trunk/debian/TODO =================================================================== --- trunk/debian/TODO 2004-06-23 17:31:33 UTC (rev 1560) +++ trunk/debian/TODO 2004-06-23 18:43:38 UTC (rev 1561) @@ -17,7 +17,6 @@ 4.3.0.dfsg.1-6 -------------- -* Add "How to Use This Document" and "Acknowledgements" sections to FAQ. * Update FAQ entry about X Window System history to reflect developments over the past year with x.org, freedesktop.org, and The XFree86 Project, Inc. * Add FAQ entry describing Debian's plans in the X department. Modified: trunk/debian/changelog =================================================================== --- trunk/debian/changelog 2004-06-23 17:31:33 UTC (rev 1560) +++ trunk/debian/changelog 2004-06-23 18:43:38 UTC (rev 1561) @@ -26,12 +26,14 @@ * Enhance xlibs package's bug script to report compiled XKB data for X server, if possible. + * Add "How to Use this Document" and "Acknowledgements" sections to FAQ. + Changes by Fabio Massimo Di Nitto: * Update French debconf template translations (thanks, Christian Perrier). (Closes: #255464) - -- Branden Robinson <[EMAIL PROTECTED]> Tue, 22 Jun 2004 16:36:05 -0500 + -- Branden Robinson <[EMAIL PROTECTED]> Wed, 23 Jun 2004 13:42:30 -0500 xfree86 (4.3.0.dfsg.1-5) unstable; urgency=low Modified: trunk/debian/local/FAQ.xhtml =================================================================== --- trunk/debian/local/FAQ.xhtml 2004-06-23 17:31:33 UTC (rev 1560) +++ trunk/debian/local/FAQ.xhtml 2004-06-23 18:43:38 UTC (rev 1561) @@ -39,6 +39,7 @@ <h2><a href="#copyright">Copyright and License</a></h2> <h2><a href="#moreinfo">Further Information</a></h2> +<h2><a href="#howto">How to Use this Document</a></h2> <h2><a href="#genquest">General Questions</a></h2> <ul> <li><a href="#defxwinsys">What is the X Window System?</a></li> @@ -137,6 +138,7 @@ <li><a href="#didservercrash">How can I tell if it's the X server crashing, or my X session exiting abnormally?</a></li> </ul> +<h2><a href="#acknowledgements">Acknowledgements</a></h2> <h2><a id="copyright">Copyright and License</a></h2> @@ -215,6 +217,90 @@ Debian's XFree86 packages, check out the <a href="http://people.debian.org/~branden/xsf/">X Strike Force</a>.</p> +<h2><a id="howto">How to Use this Document</a></h2> + +<p>As with many similar documents, this FAQ uses visual markup to indicate words +used in particular contexts. Unfortunately, much of this markup is lost in +plain-text or non-visual representations. Nevertheless, the author thinks it is +important to have a plain-text version of this FAQ available, for in the event +that the graphical browsers available to the user can only be run in the X +environment, and if the user is having trouble configuring the X environment, he +or she would otherwise be presented with a catch-22 when turning to this FAQ for +help.</p> + +<p>If you are reading the plain-text version of this FAQ and have access to a +computer with a graphical Web browser (or, at least, a browser capable of +sophisticated text rendering, using different colors and typefaces within an +XHTML document), please consult the XHTML version instead. On Debian systems +with the <code class="package">xfree86-common</code> package installed, you can +find this FAQ at <a +href="file:///usr/share/doc/xfree86-common/FAQ.xhtml">file:///usr/share/doc/xfree86-common/FAQ.xhtml</a>.</p> + +<p>A copy of this FAQ is also maintained on the Web; you can generally find the +most up-to-date version at <a +href="http://necrotic.deadbeast.net/xsf/XFree86/trunk/debian/local/FAQ.xhtml">http://necrotic.deadbeast.net/xsf/XFree86/trunk/debian/local/FAQ.xhtml</a>. +(If you're curious, this is from a nightly snapshot of the <a +href="http://subversion.tigris.org">Subversion</a> repository where the Debian +<code class="package">xfree86</code> source package is maintained.)</p> + +<p>The following table summarizes the semantic usage of visual markup in this +document:</p> + +<table border="1"> + <thead> + <tr> + <td>concept</td> + <td>representation</td> + <td>examples</td> + </tr> + </thead> + <tbody> + <tr> + <td>keyboard input</td> + <td>gray background</td> + <td><kbd>CTRL-ALT-BACKSPACE</kbd>, <kbd>apt-get install + x-window-system</kbd></td> + </tr> + <tr> + <td>command name</td> + <td>olive text</td> + <td><code class="command">xdpyinfo</code>, <code + class="command">xterm</code></td> + </tr> + <tr> + <td>file specification</td> + <td>purple text</td> + <td><code class="filespec">/etc/X11/XF86Config-4</code>, <code + class="filespec">/var/log/XFree86.0.log</code></td> + </tr> + <tr> + <td>Debian package name</td> + <td>blue-green text</td> + <td><code class="package">xserver-xfree86</code>, <code + class="package">xterm</code></td> + </tr> + <tr> + <td>manual page</td> + <td>underlined text</td> + <td><code class="manpage">man(1)</code>, <code + class="manpage">xterm(1x)</code></td> + </tr> + <tr> + <td>other literal (e.g., mailing list)</td> + <td>dark red text</td> + <td><code class="other">debian-legal</code>, <code + class="other">debian-user</code></td> + </tr> + </tbody> +</table> + +<p>I welcome suggestions for improving the utility and accessibility of this +document; the best way to communicate this is by filing a <code +class="other">wishlist</code>-severity bug report against the <code +class="package">xfree86-common</code> package. I recommend the <code +class="command">reportbug</code> command from the Debian package of the same +name for all bug reports.</p> + <h2><a id="genquest" class="bigtext">General Questions</a></h2> <h3><a id="defxwinsys">What is the X Window System?</a></h3> @@ -2225,6 +2311,12 @@ "'core pointer' ..."-question</a> above for more information on how to deal with this.</p> +<h2><a id="acknowledgements">Acknowledgements</a></h2> + +<p>The author would like to thank Andreas Metzler, Guillem Jover, Ingo Saitz, +Osamu Aoki, Matthew Arnison, Colin Walters, and "ulisses" for their +contributions to this document.</p> + <hr /> <p class="x-small">$Id$</p> </body>