[Scummvm-cvs-logs] CVS: docs/docbook manual.html,1.4,1.5 manual.pdf,1.4,1.5 manual.txt,1.3,1.4 manual.xml,1.5,1.6

Max Horn fingolfin at users.sourceforge.net
Sat Dec 4 17:38:29 CET 2004


Update of /cvsroot/scummvm/docs/docbook
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv5980

Modified Files:
	manual.html manual.pdf manual.txt manual.xml 
Log Message:
minor changes

Index: manual.html
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- manual.html	5 Dec 2004 00:45:43 -0000	1.4
+++ manual.html	5 Dec 2004 01:37:22 -0000	1.5
@@ -26,80 +26,80 @@
 <dt>1.2. <a href="#AEN16">History</a></dt>
 <dt>1.3. <a href="#AEN19">Getting further help</a></dt>
 <dt>1.4. <a href="#AEN22">Reporting bugs</a></dt>
-<dt>1.5. <a href="#AEN47">Contacting the
+<dt>1.5. <a href="#AEN48">Contacting the
 developers</a></dt></dl></dd>
-<dt>2. <a href="#AEN50">Getting started</a></dt>
+<dt>2. <a href="#AEN52">Getting started</a></dt>
 <dd>
 <dl>
-<dt>2.1. <a href="#AEN52">How to get ScummVM</a></dt>
+<dt>2.1. <a href="#AEN54">How to get ScummVM</a></dt>
 <dd>
 <dl>
-<dt>2.1.1. <a href="#AEN54">Binaries</a></dt>
-<dt>2.1.2. <a href="#AEN57">Compiling from
+<dt>2.1.1. <a href="#AEN56">Binaries</a></dt>
+<dt>2.1.2. <a href="#AEN59">Compiling from
 source</a></dt></dl></dd>
-<dt>2.2. <a href="#AEN60">Installation</a></dt>
+<dt>2.2. <a href="#AEN62">Installation</a></dt>
 <dd>
 <dl>
-<dt>2.2.1. <a href="#AEN63">Unix-like (Linux, *BSD, Solaris,
+<dt>2.2.1. <a href="#AEN65">Unix-like (Linux, *BSD, Solaris,
 etc.)</a></dt>
-<dt>2.2.2. <a href="#AEN66">Windows</a></dt>
-<dt>2.2.3. <a href="#AEN69">Mac OS X</a></dt>
-<dt>2.2.4. <a href="#AEN72">WinCE / PocketPC</a></dt>
-<dt>2.2.5. <a href="#AEN75">PalmOS</a></dt>
-<dt>2.2.6. <a href="#AEN78">Dreamcast</a></dt></dl></dd>
-<dt>2.3. <a href="#AEN81">First steps</a></dt>
+<dt>2.2.2. <a href="#AEN68">Windows</a></dt>
+<dt>2.2.3. <a href="#AEN71">Mac OS X</a></dt>
+<dt>2.2.4. <a href="#AEN74">WinCE / PocketPC</a></dt>
+<dt>2.2.5. <a href="#AEN77">PalmOS</a></dt>
+<dt>2.2.6. <a href="#AEN80">Dreamcast</a></dt></dl></dd>
+<dt>2.3. <a href="#AEN83">First steps</a></dt>
 <dd>
 <dl>
-<dt>2.3.1. <a href="#AEN92">Unix-like, Windows, Mac OS X</a></dt>
-<dt>2.3.2. <a href="#AEN95">WinCE / PocketPC</a></dt>
-<dt>2.3.3. <a href="#AEN98">Dreamcast</a></dt></dl></dd></dl></dd>
-<dt>3. <a href="#AEN101">Running and using ScummVM</a></dt>
+<dt>2.3.1. <a href="#AEN94">Unix-like, Windows, Mac OS X</a></dt>
+<dt>2.3.2. <a href="#AEN97">WinCE / PocketPC</a></dt>
+<dt>2.3.3. <a href="#AEN100">Dreamcast</a></dt></dl></dd></dl></dd>
+<dt>3. <a href="#AEN103">Running and using ScummVM</a></dt>
 <dd>
 <dl>
-<dt>3.1. <a href="#AEN103">The launcher</a></dt>
-<dt>3.2. <a href="#AEN106">Command line options</a></dt>
-<dt>3.3. <a href="#AEN303">Hot Keys</a></dt>
-<dt>3.4. <a href="#AEN306">Saving and loading</a></dt>
-<dt>3.5. <a href="#AEN309">Using Macintosh games</a></dt>
-<dt>3.6. <a href="#AEN312">Multi-CD Games</a></dt></dl></dd>
-<dt>4. <a href="#AEN315">Configuration</a></dt>
+<dt>3.1. <a href="#AEN105">The launcher</a></dt>
+<dt>3.2. <a href="#AEN108">Command line options</a></dt>
+<dt>3.3. <a href="#AEN305">Hot Keys</a></dt>
+<dt>3.4. <a href="#AEN308">Saving and loading</a></dt>
+<dt>3.5. <a href="#AEN311">Using Macintosh games</a></dt>
+<dt>3.6. <a href="#AEN314">Multi-CD Games</a></dt></dl></dd>
+<dt>4. <a href="#AEN317">Configuration</a></dt>
 <dd>
 <dl>
-<dt>4.1. <a href="#AEN317">Using the launcher</a></dt>
-<dt>4.2. <a href="#AEN320">All config file switches in
+<dt>4.1. <a href="#AEN319">Using the launcher</a></dt>
+<dt>4.2. <a href="#AEN322">All config file switches in
 detail</a></dt>
-<dt>4.3. <a href="#AEN323">Graphics Filters</a></dt>
-<dt>4.4. <a href="#AEN326">Music and Sound</a></dt></dl></dd>
+<dt>4.3. <a href="#AEN325">Graphics Filters</a></dt>
+<dt>4.4. <a href="#AEN328">Music and Sound</a></dt></dl></dd>
 <dt>A. <a href="#sec.supported-games">Supported Games</a></dt>
 <dd>
 <dl>
-<dt>A.1. <a href="#AEN332">LucasArts Games</a></dt>
-<dt>A.2. <a href="#AEN335">Humongous Games</a></dt>
-<dt>A.3. <a href="#AEN338">Adventure Soft Games</a></dt>
-<dt>A.4. <a href="#AEN341">Revolution Games</a></dt>
-<dt>A.5. <a href="#AEN344">Interactive Binary Illusions
+<dt>A.1. <a href="#AEN334">LucasArts Games</a></dt>
+<dt>A.2. <a href="#AEN337">Humongous Games</a></dt>
+<dt>A.3. <a href="#AEN340">Adventure Soft Games</a></dt>
+<dt>A.4. <a href="#AEN343">Revolution Games</a></dt>
+<dt>A.5. <a href="#AEN346">Interactive Binary Illusions
 Games</a></dt>
-<dt>A.6. <a href="#AEN347">Other Games</a></dt></dl></dd>
-<dt>B. <a href="#AEN350">Tools</a></dt>
+<dt>A.6. <a href="#AEN349">Other Games</a></dt></dl></dd>
+<dt>B. <a href="#AEN352">Tools</a></dt>
 <dd>
 <dl>
-<dt>B.1. <a href="#AEN353">compress_san</a></dt>
-<dt>B.2. <a href="#AEN356">extract</a></dt>
-<dt>B.3. <a href="#AEN359">simon2mp3</a></dt>
-<dt>B.4. <a href="#AEN362">sword2mp3</a></dt></dl></dd>
-<dt>C. <a href="#AEN365">Credits</a></dt>
-<dt><a href="#AEN536">Glossary</a></dt>
-<dt><a href="#AEN559">Index</a></dt></dl></div>
+<dt>B.1. <a href="#AEN355">compress_san</a></dt>
+<dt>B.2. <a href="#AEN358">extract</a></dt>
+<dt>B.3. <a href="#AEN361">simon2mp3</a></dt>
+<dt>B.4. <a href="#AEN364">sword2mp3</a></dt></dl></dd>
+<dt>C. <a href="#AEN367">Credits</a></dt>
+<dt><a href="#AEN538">Glossary</a></dt>
+<dt><a href="#AEN561">Index</a></dt></dl></div>
 <div class="LOT">
 <dl class="LOT">
 <dt><b>List of Examples</b></dt>
-<dt>3-1. <a href="#AEN291">Running Monkey Island, fullscreen, from
+<dt>3-1. <a href="#AEN293">Running Monkey Island, fullscreen, from
 a hard disk (Win32)</a></dt>
-<dt>3-2. <a href="#AEN294">Running Full Throttle from CD,
+<dt>3-2. <a href="#AEN296">Running Full Throttle from CD,
 fullscreen and with subtitles enabled (Win32)</a></dt>
-<dt>3-3. <a href="#AEN297">Running Monkey Island, fullscreen, from
+<dt>3-3. <a href="#AEN299">Running Monkey Island, fullscreen, from
 a hard disk (Unix)</a></dt>
-<dt>3-4. <a href="#AEN300">Running Full Throttle from CD,
+<dt>3-4. <a href="#AEN302">Running Full Throttle from CD,
 fullscreen and with subtitles enabled (Unix)</a></dt></dl></div>
 <div class="chapter">
 <hr>
@@ -127,7 +127,8 @@
 <div class="section">
 <hr>
 <h2 class="section"><a name="AEN16">1.2. History</a></h2>
-<p>TODO</p></div>
+<p>TODO: Insert some information about the history of ScummVM: how
+it got started, how it evolved, etc.</p></div>
 <div class="section">
 <hr>
 <h2 class="section"><a name="AEN19">1.3. Getting further
@@ -143,13 +144,14 @@
 CVS version. Also check the known bugs list (below) and
 compatibility listing for that game, to ensure the issue is not
 already known.</p>
-<p>
Also do not report bugs on games that are not listed as
-being completable in <a href="#sec.supported-games">Appendix A</a>
-(<a href="#sec.supported-games"><i>Supported Games</i></a>), or in
-the online <a href="http://www.scummvm.org/compatibility.php"
-target="_top">compatibility list</a>. We <span class=
-"emphasis"><i class="emphasis">know</i></span> those games have
-bugs.</p>
+<p>
Also, please do not report bugs on games that are not
+listed as being completable in <a href=
+"#sec.supported-games">Appendix A</a> (<a href=
+"#sec.supported-games"><i>Supported Games</i></a>), or in the
+online <a href="http://www.scummvm.org/compatibility.php"
+   target="_top">compatibility list</a>. We already <span class=
+   "emphasis"><i class="emphasis">know</i></span> those games have
+   bugs.</p>
 <p>
Please include the following information:</p>
 <ul>
 <li>
@@ -168,65 +170,71 @@
 <li>
 <p>If this bug only occurred recently, please note the last version
 without the bug, and the first version including the bug. That way
-we can fix it quicker by looking at the changes
-made.</p></li></ul></div>
+we can fix it quicker by looking at the changes made.</p></li></ul>
+<p>
This should only take you a little time but will make it
+much easier for us to process your bug report in a way that
+satisfies both you and us.</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN47">1.5. Contacting the
+<h2 class="section"><a name="AEN48">1.5. Contacting the
 developers</a></h2>
 <p>
The easiest way to contact the ScummVM team is by
 submitting bug reports or commenting in our forums. You can also
 join and e-mail the scummvm-devel mailing list, or chat with us on
 irc (#scummvm on irc.freenode.net) Please do not ask us to support
-an unsupported game - read our homepages FAQ first.</p></div></div>
+an unsupported game -- read our homepages FAQ first.</p>
+<p>
 TODO: Be a bit more verbose here: explain how to find/use
+the scummvm-devel list; and directly point at the FAQ entry in
+question (or maybe insert the response in here, or add the FAQ to
+the manual).</p></div></div>
 <div class="chapter">
 <hr>
-<h1><a name="AEN50"></a>Chapter 2. Getting started</h1>
+<h1><a name="AEN52"></a>Chapter 2. Getting started</h1>
 <div class="section">
-<h2 class="section"><a name="AEN52">2.1. How to get
+<h2 class="section"><a name="AEN54">2.1. How to get
 ScummVM</a></h2>
 <div class="section">
-<h3 class="section"><a name="AEN54">2.1.1. Binaries</a></h3>
+<h3 class="section"><a name="AEN56">2.1.1. Binaries</a></h3>
 <p>TODO: list supported platforms</p></div>
 <div class="section">
 <hr>
-<h3 class="section"><a name="AEN57">2.1.2. Compiling from
+<h3 class="section"><a name="AEN59">2.1.2. Compiling from
 source</a></h3>
 <p>TODO: (with more detail than now); pointer to the to-be-written
 "Developer's Guide to ScummVM"</p></div></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN60">2.2. Installation</a></h2>
+<h2 class="section"><a name="AEN62">2.2. Installation</a></h2>
 <p>TODO</p>
 <div class="section">
 <hr>
-<h3 class="section"><a name="AEN63">2.2.1. Unix-like (Linux, *BSD,
+<h3 class="section"><a name="AEN65">2.2.1. Unix-like (Linux, *BSD,
 Solaris, etc.)</a></h3>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h3 class="section"><a name="AEN66">2.2.2. Windows</a></h3>
+<h3 class="section"><a name="AEN68">2.2.2. Windows</a></h3>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h3 class="section"><a name="AEN69">2.2.3. Mac OS X</a></h3>
+<h3 class="section"><a name="AEN71">2.2.3. Mac OS X</a></h3>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h3 class="section"><a name="AEN72">2.2.4. WinCE /
+<h3 class="section"><a name="AEN74">2.2.4. WinCE /
 PocketPC</a></h3>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h3 class="section"><a name="AEN75">2.2.5. PalmOS</a></h3>
+<h3 class="section"><a name="AEN77">2.2.5. PalmOS</a></h3>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h3 class="section"><a name="AEN78">2.2.6. Dreamcast</a></h3>
+<h3 class="section"><a name="AEN80">2.2.6. Dreamcast</a></h3>
 <p>TODO</p></div></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN81">2.3. First steps</a></h2>
+<h2 class="section"><a name="AEN83">2.3. First steps</a></h2>
 <p>TODO: (basic setup; how to add a game using the launcher and the
 play it, getting a first game to run).</p>
 <p>Note: We use the default launcher GUI on many systems, but some
@@ -236,29 +244,29 @@
 <p><img src="img/launcher-empty.png" align="center"></p></div>
 <div class="section">
 <hr>
-<h3 class="section"><a name="AEN92">2.3.1. Unix-like, Windows, Mac
+<h3 class="section"><a name="AEN94">2.3.1. Unix-like, Windows, Mac
 OS X</a></h3>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h3 class="section"><a name="AEN95">2.3.2. WinCE /
+<h3 class="section"><a name="AEN97">2.3.2. WinCE /
 PocketPC</a></h3>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h3 class="section"><a name="AEN98">2.3.3. Dreamcast</a></h3>
+<h3 class="section"><a name="AEN100">2.3.3. Dreamcast</a></h3>
 <p>TODO</p></div></div></div>
 <div class="chapter">
 <hr>
-<h1><a name="AEN101"></a>Chapter 3. Running and using ScummVM</h1>
+<h1><a name="AEN103"></a>Chapter 3. Running and using ScummVM</h1>
 <div class="section">
-<h2 class="section"><a name="AEN103">3.1. The launcher</a></h2>
+<h2 class="section"><a name="AEN105">3.1. The launcher</a></h2>
 <p>TODO: Explain the launcher and how to use it (even though I hope
 that it's pretty much straightforward); including
 screenshots?</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN106">3.2. Command line
+<h2 class="section"><a name="AEN108">3.2. Command line
 options</a></h2>
 <p><b class="command">scummvm</b> [<tt class=
 "replaceable"><i>OPTIONS</i></tt>...] <tt class=
@@ -386,28 +394,28 @@
 and game names at <a href=
 "http://www.scummvm.org/compatibility.php" target=
 "_top">http://www.scummvm.org/compatibility.php</a></p>
-<div class="example"><a name="AEN291"></a>
+<div class="example"><a name="AEN293"></a>
 <p><b>Example 3-1. Running Monkey Island, fullscreen, from a hard
 disk (Win32)</b></p>
 <pre class="screen">
 C:\Games\LucasArts\scummvm.exe -f -pC:\Games\LucasArts\monkey\ monkey
 </pre>
 </div>
-<div class="example"><a name="AEN294"></a>
+<div class="example"><a name="AEN296"></a>
 <p><b>Example 3-2. Running Full Throttle from CD, fullscreen and
 with subtitles enabled (Win32)</b></p>
 <pre class="screen">
 C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ ft
 </pre>
 </div>
-<div class="example"><a name="AEN297"></a>
+<div class="example"><a name="AEN299"></a>
 <p><b>Example 3-3. Running Monkey Island, fullscreen, from a hard
 disk (Unix)</b></p>
 <pre class="screen">
 /path/to/scummvm -f -p/games/LucasArts/monkey/ monkey
 </pre>
 </div>
-<div class="example"><a name="AEN300"></a>
+<div class="example"><a name="AEN302"></a>
 <p><b>Example 3-4. Running Full Throttle from CD, fullscreen and
 with subtitles enabled (Unix)</b></p>
 <pre class="screen">
@@ -416,46 +424,46 @@
 </div></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN303">3.3. Hot Keys</a></h2>
+<h2 class="section"><a name="AEN305">3.3. Hot Keys</a></h2>
 <p>TODO: This also has to cover platform specific
 details...</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN306">3.4. Saving and
+<h2 class="section"><a name="AEN308">3.4. Saving and
 loading</a></h2>
 <p>TODO: Where savegames are stored; autosaves; how to save/load in
 the various games (i.e. F5 in SCUMM games); including screenshots,
 maybe?</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN309">3.5. Using Macintosh
+<h2 class="section"><a name="AEN311">3.5. Using Macintosh
 games</a></h2>
 <p>TODO: How to access the HFS disks from a non-mac; maybe point to
 rescumm, although this shouldn't be necessary anymore
 now.</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN312">3.6. Multi-CD Games</a></h2>
+<h2 class="section"><a name="AEN314">3.6. Multi-CD Games</a></h2>
 <p>TODO</p></div></div>
 <div class="chapter">
 <hr>
-<h1><a name="AEN315"></a>Chapter 4. Configuration</h1>
+<h1><a name="AEN317"></a>Chapter 4. Configuration</h1>
 <div class="section">
-<h2 class="section"><a name="AEN317">4.1. Using the
+<h2 class="section"><a name="AEN319">4.1. Using the
 launcher</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN320">4.2. All config file switches
+<h2 class="section"><a name="AEN322">4.2. All config file switches
 in detail</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN323">4.3. Graphics Filters</a></h2>
+<h2 class="section"><a name="AEN325">4.3. Graphics Filters</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN326">4.4. Music and Sound</a></h2>
+<h2 class="section"><a name="AEN328">4.4. Music and Sound</a></h2>
 <p>TODO</p></div></div>
 <div class="appendix">
 <hr>
@@ -466,61 +474,61 @@
 supported precisely, where to get cutscene packs etc.</p>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN332">A.1. LucasArts Games</a></h2>
+<h2 class="section"><a name="AEN334">A.1. LucasArts Games</a></h2>
 <p>TODO: Add a list of all LEC SCUMM games here, with note
 regarding which variants we (don't) support, pointers to special
 problems (how to deal with the mac versions if you are on a PC, for
 example), etc.</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN335">A.2. Humongous Games</a></h2>
+<h2 class="section"><a name="AEN337">A.2. Humongous Games</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN338">A.3. Adventure Soft
+<h2 class="section"><a name="AEN340">A.3. Adventure Soft
 Games</a></h2>
 <p>TODO: Simon 1, Simon 2 (and their many variants)</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN341">A.4. Revolution Games</a></h2>
+<h2 class="section"><a name="AEN343">A.4. Revolution Games</a></h2>
 <p>TODO: BASS, BS1, BS2</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN344">A.5. Interactive Binary
+<h2 class="section"><a name="AEN346">A.5. Interactive Binary
 Illusions Games</a></h2>
 <p>TODO: FOTAQ</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN347">A.6. Other Games</a></h2>
+<h2 class="section"><a name="AEN349">A.6. Other Games</a></h2>
 <p>TODO: Tell people here regarding support for additional games
 (FAQ); maybe point at FreeSCI, Dosbox, others</p></div></div>
 <div class="appendix">
 <hr>
-<h1><a name="AEN350"></a>Appendix B. Tools</h1>
+<h1><a name="AEN352"></a>Appendix B. Tools</h1>
 <p>TODO: Explain sword2mp3, simon2mp3, extract, compress_san, etc.
 ; rescumm shouldn't have to be explained anymore; not sure if
 descumm should be explained here, it seems more fit for the dev
 guide, but that's probably debatable...</p>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN353">B.1. compress_san</a></h2>
+<h2 class="section"><a name="AEN355">B.1. compress_san</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN356">B.2. extract</a></h2>
+<h2 class="section"><a name="AEN358">B.2. extract</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN359">B.3. simon2mp3</a></h2>
+<h2 class="section"><a name="AEN361">B.3. simon2mp3</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN362">B.4. sword2mp3</a></h2>
+<h2 class="section"><a name="AEN364">B.4. sword2mp3</a></h2>
 <p>TODO</p></div></div>
 <div class="appendix">
 <hr>
-<h1><a name="AEN365"></a>Appendix C. Credits</h1>
-<div class="informaltable"><a name="AEN367"></a>
+<h1><a name="AEN367"></a>Appendix C. Credits</h1>
+<div class="informaltable"><a name="AEN369"></a>
 <table border="0" frame="void" rules="none" class="CALSTABLE">
 <col width="19" title="start">
 <col width="151" title="name">
@@ -749,7 +757,7 @@
 reimplement that it is today. Feel free to drop us a line and tell
 us what you think, guys!</p></div>
 <div class="GLOSSARY">
-<h1><a name="AEN536"></a>Glossary</h1>
+<h1><a name="AEN538"></a>Glossary</h1>
 <p>TODO: (explaining abbreviations etc.). Like SCUMM, FOTAQ, COMI,
 FOA, ITE, ...</p>
 <dl>
@@ -772,7 +780,7 @@
 <p>TODO</p></dd></dl></div>
 <div class="index">
 <hr>
-<h1><a name="AEN559"></a>Index</h1>
+<h1><a name="AEN561"></a>Index</h1>
 <p>TODO: Note that docbook can be used to automate the generation
 of an index!</p></div></div>
 </body>

Index: manual.pdf
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.pdf,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- manual.pdf	5 Dec 2004 00:45:43 -0000	1.4
+++ manual.pdf	5 Dec 2004 01:37:22 -0000	1.5
@@ -538,392 +538,392 @@
 /Border[0 0 0]/H/I/C[1 0 0]
 /Rect [143.462 616.848 264.537 625.759]
 /Subtype /Link
-/A << /S /GoTo /D (46) >>
+/A << /S /GoTo /D (47) >>
 >> endobj
 258 0 obj <<
 /Type /Annot
 /Border[0 0 0]/H/I/C[1 0 0]
 /Rect [533.001 616.848 537.983 625.759]
 /Subtype /Link
[...4079 lines suppressed...]
+0000133031 00000 n 
+0000133117 00000 n 
+0000138325 00000 n 
+0000143757 00000 n 
+0000143796 00000 n 
+0000143834 00000 n 
+0000144061 00000 n 
 trailer
 <<
-/Size 745
-/Root 743 0 R
-/Info 744 0 R
+/Size 746
+/Root 744 0 R
+/Info 745 0 R
 >>
 startxref
-143943
+144216
 %%EOF

Index: manual.txt
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.txt,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- manual.txt	5 Dec 2004 00:45:43 -0000	1.3
+++ manual.txt	5 Dec 2004 01:37:24 -0000	1.4
@@ -142,7 +142,8 @@
 
 1.2. History
 
-   TODO
+   TODO: Insert some information about the history of ScummVM: how it got
+   started, how it evolved, etc.
 
      ----------------------------------------------------------------------
 
@@ -160,9 +161,9 @@
    known bugs list (below) and compatibility listing for that game, to ensure
    the issue is not already known.
 
-   
Also do not report bugs on games that are not listed as being completable
-   in Appendix A (Supported Games), or in the online compatibility list. We
-   know those games have bugs.
+   
Also, please do not report bugs on games that are not listed as being
+   completable in Appendix A (Supported Games), or in the online
+   compatibility list. We already know those games have bugs.
 
    
Please include the following information:
 
@@ -182,6 +183,9 @@
        without the bug, and the first version including the bug. That way we
        can fix it quicker by looking at the changes made.
 
+   
This should only take you a little time but will make it much easier for
+   us to process your bug report in a way that satisfies both you and us.
+
      ----------------------------------------------------------------------
 
 1.5. Contacting the developers
@@ -189,9 +193,13 @@
    
The easiest way to contact the ScummVM team is by submitting bug reports
    or commenting in our forums. You can also join and e-mail the
    scummvm-devel mailing list, or chat with us on irc (#scummvm on
-   irc.freenode.net) Please do not ask us to support an unsupported game -
+   irc.freenode.net) Please do not ask us to support an unsupported game --
    read our homepages FAQ first.
 
+   
 TODO: Be a bit more verbose here: explain how to find/use the
+   scummvm-devel list; and directly point at the FAQ entry in question (or
+   maybe insert the response in here, or add the FAQ to the manual).
+
      ----------------------------------------------------------------------
 
                            Chapter 2. Getting started

Index: manual.xml
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- manual.xml	5 Dec 2004 00:45:43 -0000	1.5
+++ manual.xml	5 Dec 2004 01:37:24 -0000	1.6
@@ -46,7 +46,8 @@
 
     <section>
       <title>History</title>
-      <para>TODO</para>
+      <para>TODO: Insert some information about the history of ScummVM:
+      how it got started, how it evolved, etc.</para>
     </section>
 
     <section>
@@ -57,15 +58,18 @@
     <section>
       <title>Reporting bugs</title>
       <para>
-To report a bug, please create a <ulink url="http://sourceforge.net">SourceForge account</ulink> and follow the bugs
-link from our homepage. Please make sure the bug is reproducible, and
+To report a bug, please create a <ulink url="http://sourceforge.net">SourceForge account</ulink>
+and follow the bugs link from our homepage. Please make sure the bug is reproducible, and
 still occurs in the latest daily build/current CVS version. Also check
 the known bugs list (below) and compatibility listing for that game, to
 ensure the issue is not already known.
       </para>
 
       <para>
-Also do not report bugs on games that are not listed as being completable in <xref linkend="sec.supported-games"/> (<xref linkend="sec.supported-games" endterm="sec.title.supported-games"/>), or in the online <ulink url="http://www.scummvm.org/compatibility.php">compatibility list</ulink>. We <emphasis>know</emphasis> those games have bugs.
+Also, please do not report bugs on games that are not listed as being completable in
+<xref linkend="sec.supported-games"/> (<xref linkend="sec.supported-games" endterm="sec.title.supported-games"/>),
+or in the online <ulink url="http://www.scummvm.org/compatibility.php">compatibility list</ulink>.
+We already <emphasis>know</emphasis> those games have bugs.
       </para>
 
       <para>
@@ -83,6 +87,10 @@
           the bug. That way we can fix it quicker by looking at the
           changes made.</para></listitem>
       </itemizedlist>
+      <para>
+This should only take you a little time but will make it much easier for 
+us to process your bug report in a way that satisfies both you and us. 
+      </para>
     </section>
 
     <section>
@@ -91,9 +99,14 @@
 The easiest way to contact the ScummVM team is by submitting bug reports or
 commenting in our forums. You can also join and e-mail the scummvm-devel
 mailing list, or chat with us on irc (#scummvm on irc.freenode.net)
-Please do not ask us to support an unsupported game - read our homepages
+Please do not ask us to support an unsupported game -- read our homepages
 FAQ first.
       </para>
+      <para>
+      TODO: Be a bit more verbose here: explain how to find/use the scummvm-devel list;
+      and directly point at the FAQ entry in question (or maybe insert the response in
+      here, or add the FAQ to the manual).
+      </para>
     </section>
   </chapter>
 





More information about the Scummvm-git-logs mailing list