[Scummvm-cvs-logs] CVS: docs/docbook manual.html,1.13,1.14 manual.pdf,1.13,1.14 manual.txt,1.12,1.13
Max Horn
fingolfin at users.sourceforge.net
Fri Dec 24 17:37:04 CET 2004
Update of /cvsroot/scummvm/docs/docbook
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv1685
Modified Files:
manual.html manual.pdf manual.txt
Log Message:
updated
Index: manual.html
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.html,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -d -r1.13 -r1.14
--- manual.html 24 Dec 2004 23:12:33 -0000 1.13
+++ manual.html 25 Dec 2004 01:35:55 -0000 1.14
@@ -23,105 +23,105 @@
<dd>
<dl>
<dt>1.1. <a href="#AEN7">What is ScummVM</a></dt>
-<dt>1.2. <a href="#AEN14">History</a></dt>
-<dt>1.3. <a href="#AEN17">Getting further help</a></dt>
-<dt>1.4. <a href="#AEN20">Reporting bugs</a></dt>
-<dt>1.5. <a href="#AEN46">Contacting the
+<dt>1.2. <a href="#AEN14">Reporting bugs</a></dt>
+<dt>1.3. <a href="#AEN40">Contacting the
developers</a></dt></dl></dd>
-<dt>2. <a href="#AEN50">Getting started</a></dt>
+<dt>2. <a href="#AEN46">Getting started</a></dt>
<dd>
<dl>
-<dt>2.1. <a href="#AEN52">How to get ScummVM</a></dt>
+<dt>2.1. <a href="#AEN48">Requirements</a></dt>
+<dt>2.2. <a href="#AEN83">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.2.1. <a href="#AEN86">Binaries</a></dt>
+<dt>2.2.2. <a href="#sec.compiling">Compiling from
source</a></dt></dl></dd>
-<dt>2.2. <a href="#AEN60">Installation</a></dt>
+<dt>2.3. <a href="#AEN121">Installation</a></dt>
<dd>
<dl>
-<dt>2.2.1. <a href="#AEN63">Unix-like (Linux, *BSD, Solaris,
+<dt>2.3.1. <a href="#AEN124">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.3.2. <a href="#AEN127">Windows</a></dt>
+<dt>2.3.3. <a href="#AEN130">Mac OS X</a></dt>
+<dt>2.3.4. <a href="#AEN133">Windows Mobile (WinCE / PocketPC /
+Smartphone)</a></dt>
+<dt>2.3.5. <a href="#AEN136">PalmOS</a></dt>
+<dt>2.3.6. <a href="#AEN139">Dreamcast</a></dt></dl></dd>
+<dt>2.4. <a href="#AEN142">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.4.1. <a href="#AEN153">Unix-like, Windows, Mac OS X</a></dt>
+<dt>2.4.2. <a href="#AEN156">WinCE / PocketPC</a></dt>
+<dt>2.4.3. <a href="#AEN159">Dreamcast</a></dt></dl></dd></dl></dd>
+<dt>3. <a href="#AEN162">Running and using ScummVM</a></dt>
<dd>
<dl>
-<dt>3.1. <a href="#AEN103">The launcher</a></dt>
+<dt>3.1. <a href="#AEN164">The launcher</a></dt>
<dd>
<dl>
-<dt>3.1.1. <a href="#AEN106">Adding/removing a game</a></dt>
-<dt>3.1.2. <a href="#AEN143">Configuring a game</a></dt>
-<dt>3.1.3. <a href="#AEN146">The (global) options
+<dt>3.1.1. <a href="#AEN167">Adding/removing a game</a></dt>
+<dt>3.1.2. <a href="#AEN204">Configuring a game</a></dt>
+<dt>3.1.3. <a href="#AEN207">The (global) options
dialog</a></dt></dl></dd>
-<dt>3.2. <a href="#AEN173">Command line options</a></dt>
-<dt>3.3. <a href="#AEN370">Hot Keys</a></dt>
-<dt>3.4. <a href="#AEN373">Saving and loading</a></dt>
-<dt>3.5. <a href="#AEN376">Using Macintosh games</a></dt>
-<dt>3.6. <a href="#AEN379">Multi-CD Games</a></dt>
+<dt>3.2. <a href="#AEN234">Command line options</a></dt>
+<dt>3.3. <a href="#AEN431">Hot Keys</a></dt>
+<dt>3.4. <a href="#AEN434">Saving and loading</a></dt>
+<dt>3.5. <a href="#AEN437">Using Macintosh games</a></dt>
+<dt>3.6. <a href="#AEN440">Multi-CD Games</a></dt>
<dd>
<dl>
-<dt>3.6.1. <a href="#AEN385">The Curse of Monkey Island</a></dt>
-<dt>3.6.2. <a href="#AEN389">Broken Sword 1</a></dt>
-<dt>3.6.3. <a href="#AEN394">Broken Sword
+<dt>3.6.1. <a href="#AEN446">The Curse of Monkey Island</a></dt>
+<dt>3.6.2. <a href="#AEN450">Broken Sword 1</a></dt>
+<dt>3.6.3. <a href="#AEN455">Broken Sword
2</a></dt></dl></dd></dl></dd>
-<dt>4. <a href="#AEN399">Configuration</a></dt>
+<dt>4. <a href="#AEN460">Configuration</a></dt>
<dd>
<dl>
-<dt>4.1. <a href="#AEN401">Using the launcher</a></dt>
-<dt>4.2. <a href="#AEN404">All config file switches in
+<dt>4.1. <a href="#AEN462">Using the launcher</a></dt>
+<dt>4.2. <a href="#AEN465">All config file switches in
detail</a></dt>
-<dt>4.3. <a href="#AEN407">Graphics Filters</a></dt>
-<dt>4.4. <a href="#AEN465">Music and Sound</a></dt>
+<dt>4.3. <a href="#AEN468">Graphics Filters</a></dt>
+<dt>4.4. <a href="#AEN526">Music and Sound</a></dt>
<dd>
<dl>
-<dt>4.4.1. <a href="#AEN468">Music drivers</a></dt>
-<dt>4.4.2. <a href="#AEN471">Using compressed audiofiles</a></dt>
-<dt>4.4.3. <a href="#AEN474">Volume settings</a></dt>
-<dt>4.4.4. <a href="#AEN477">Output sample
+<dt>4.4.1. <a href="#AEN529">Music drivers</a></dt>
+<dt>4.4.2. <a href="#AEN532">Using compressed audiofiles</a></dt>
+<dt>4.4.3. <a href="#AEN535">Volume settings</a></dt>
+<dt>4.4.4. <a href="#AEN538">Output sample
rate</a></dt></dl></dd></dl></dd>
<dt>A. <a href="#sec.supported-games">Supported Games</a></dt>
<dd>
<dl>
-<dt>A.1. <a href="#AEN487">LucasArts Games</a></dt>
-<dt>A.2. <a href="#AEN490">Humongous Games</a></dt>
-<dt>A.3. <a href="#AEN493">Adventure Soft Games</a></dt>
-<dt>A.4. <a href="#AEN496">Revolution Games</a></dt>
-<dt>A.5. <a href="#AEN499">Interactive Binary Illusions
+<dt>A.1. <a href="#AEN548">LucasArts Games</a></dt>
+<dt>A.2. <a href="#AEN551">Humongous Games</a></dt>
+<dt>A.3. <a href="#AEN554">Adventure Soft Games</a></dt>
+<dt>A.4. <a href="#AEN557">Revolution Games</a></dt>
+<dt>A.5. <a href="#AEN560">Interactive Binary Illusions
Games</a></dt>
-<dt>A.6. <a href="#AEN502">Other Games</a></dt></dl></dd>
-<dt>B. <a href="#AEN505">Tools</a></dt>
+<dt>A.6. <a href="#AEN563">Other Games</a></dt></dl></dd>
+<dt>B. <a href="#AEN566">Tools</a></dt>
<dd>
<dl>
-<dt>B.1. <a href="#AEN508">compress_san</a></dt>
-<dt>B.2. <a href="#AEN524">compress_scumm_sou</a></dt>
-<dt>B.3. <a href="#AEN529">queenrebuild</a></dt>
-<dt>B.4. <a href="#AEN534">compress_simon</a></dt>
-<dt>B.5. <a href="#AEN539">compress_sword1</a></dt>
-<dt>B.6. <a href="#AEN544">compress_sword2</a></dt></dl></dd>
-<dt>C. <a href="#AEN550">Credits</a></dt>
-<dt><a href="#AEN741">Glossary</a></dt></dl></div>
+<dt>B.1. <a href="#AEN569">compress_san</a></dt>
+<dt>B.2. <a href="#AEN585">compress_scumm_sou</a></dt>
+<dt>B.3. <a href="#AEN590">queenrebuild</a></dt>
+<dt>B.4. <a href="#AEN595">compress_simon</a></dt>
+<dt>B.5. <a href="#AEN600">compress_sword1</a></dt>
+<dt>B.6. <a href="#AEN605">compress_sword2</a></dt></dl></dd>
+<dt>C. <a href="#AEN611">Credits</a></dt>
+<dt><a href="#AEN802">Glossary</a></dt></dl></div>
<div class="LOT">
<dl class="LOT">
<dt><b>List of Examples</b></dt>
-<dt>3-1. <a href="#AEN358">Running Monkey Island, fullscreen, from
+<dt>3-1. <a href="#AEN419">Running Monkey Island, fullscreen, from
a hard disk (Win32)</a></dt>
-<dt>3-2. <a href="#AEN361">Running Full Throttle from CD,
+<dt>3-2. <a href="#AEN422">Running Full Throttle from CD,
fullscreen and with subtitles enabled (Win32)</a></dt>
-<dt>3-3. <a href="#AEN364">Running Monkey Island, fullscreen, from
+<dt>3-3. <a href="#AEN425">Running Monkey Island, fullscreen, from
a hard disk (Unix)</a></dt>
-<dt>3-4. <a href="#AEN367">Running Full Throttle from CD,
+<dt>3-4. <a href="#AEN428">Running Full Throttle from CD,
fullscreen and with subtitles enabled (Unix)</a></dt>
-<dt>B-1. <a href="#AEN520">Using compress_san</a></dt></dl></div>
+<dt>B-1. <a href="#AEN581">Using compress_san</a></dt></dl></div>
<div class="chapter">
<hr>
<h1><a name="AEN5"></a>Chapter 1. Introduction</h1>
@@ -147,17 +147,7 @@
and contribute a patch!</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN14">1.2. History</a></h2>
-<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="AEN17">1.3. Getting further
-help</a></h2>
-<p>TODO</p></div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN20">1.4. Reporting bugs</a></h2>
+<h2 class="section"><a name="AEN14">1.2. Reporting bugs</a></h2>
<p>
To report a bug, please create a <a href=
"http://sourceforge.net" target="_top">SourceForge account</a> and
follow the bugs link from our homepage. Please make sure the bug is
@@ -197,31 +187,122 @@
satisfies both you and us.</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN46">1.5. Contacting the
+<h2 class="section"><a name="AEN40">1.3. 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>
-<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>
+join and e-mail the scummvm-devel mailing list (see <a href=
+"http://lists.sourceforge.net/lists/listinfo/scummvm-devel"
+ target="_top">http://lists.sourceforge.net/lists/listinfo/scummvm-devel</a>).
+ Or chat with us on IRC: channel #scummvm on
+ irc.freenode.net.</p>
+<p>
Please do not ask us to support an unsupported game. We do
+<span class="emphasis"><i class="emphasis">not</i></span> generally
+add support for non-SCUMM games! Reverse engineering a completely
+new game without source is a long process, and our developers are
+all very busy as it is... so unless you work for a company
+interested in providing us with source code for one of your classic
+titles, please do not ask.</p></div></div>
<div class="chapter">
<hr>
-<h1><a name="AEN50"></a>Chapter 2. Getting started</h1>
+<h1><a name="AEN46"></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="AEN48">2.1. Requirements</a></h2>
+<p>
TODO: List Requirements (in terms of required/optional
+libraries, CPU power, memory, ... In particular it would be nice if
+we could e.g. say what PalmOS devices support ScummVM; not
+necessarily a list of all supported Palm models, but more a list of
+what OS you need how much memory, colors, etc.)</p>
+<p>ScummVM is known to run on the following systems:</p>
+<ul>
+<li>
+<p>Unix-like (Linux, *BSD, Solaris, etc.)</p></li>
+<li>
+<p>Windows</p></li>
+<li>
+<p>Mac OS X</p></li>
+<li>
+<p>Windows Mobile (WinCE / PocketPC / Smartphone)</p></li>
+<li>
+<p>PalmOS</p></li>
+<li>
+<p>Dreamcast</p></li></ul>
+<p>
Besides these, there have been many more inofficial ports
+in the past. Since they were not done by us, we can not say
+anything about their reliability, legality, or availability, nor
+can we provide support for them. Use them at your own risk!</p>
+<p>
Among those systems are:</p>
+<ul>
+<li>
+<p>MorphOS</p></li>
+<li>
+<p>GP32</p></li>
+<li>
+<p>Symbian based smartphones</p></li>
+<li>
+<p>XBox</p></li>
+<li>
+<p>PlayStation 2</p></li>
+<li>
+<p>RISC OS</p></li></ul>
+<p>
If you plan to compile ScummVM yourself, you will need
+certain additional libraries. More on that in the section
+ <a href="#sec.compiling">Section 2.2.2</a> (<a href=
+ "#sec.compiling"><i>Compiling from source</i></a>).</p></div>
+<div class="section">
+<hr>
+<h2 class="section"><a name="AEN83">2.2. How to get
ScummVM</a></h2>
+<p>
Basically you have two choices on how to get ScummVM:
+either you download one of the binaries we built for you (probably
+the most convenient way); or you can compiler it yourself from
+source. We strongly recommend to beginners to use our prebuilt
+binaries.</p>
<div class="section">
-<h3 class="section"><a name="AEN54">2.1.1. Binaries</a></h3>
-<p>TODO: list supported platforms; where to get binaries; list
-requirments (in terms of required/optional libraries, CPU power,
-memory, ...</p></div>
+<hr>
+<h3 class="section"><a name="AEN86">2.2.1. Binaries</a></h3>
+<p>
You can download ScummVM from our downloads page:
+ <a href="http://www.scummvm.org/downloads.php" target=
+ "_top">http://www.scummvm.org/downloads.php</a>. Go there with
+ your favorite web browser and download the binary for your
+ platform. If none is available, you may have to build ScummVM
+ yourself, refer to the next section for instructions on how to
+ do that.</p>
+<p>
We always ship prebuilt binaries of ScummVM for the
+following platforms (note that it can sometimes take a few days
+after a release for all binaries to be available):</p>
+<ul>
+<li>
+<p>Linux (Fedora Core)</p></li>
+<li>
+<p>Linux (Debian)</p></li>
+<li>
+<p>Windows</p></li>
+<li>
+<p>Mac OS X</p></li>
+<li>
+<p>Windows Mobile (WinCE / PocketPC / Smartphone)</p></li>
+<li>
+<p>PalmOS</p></li>
+<li>
+<p>Dreamcast</p></li></ul>
+<p>
In addition to these, we try to provide more binaries, but
+which depends mostly on how many volunteers we can find to help us
+out. In the past we have shipped binaries for these systems:</p>
+<ul>
+<li>
+<p>Linux (Mandrake)</p></li>
+<li>
+<p>Linux (Slackware)</p></li>
+<li>
+<p>Solaris</p></li>
+<li>
+<p>BeOS</p></li>
+<li>
+<p>MorphOS</p></li></ul></div>
<div class="section">
<hr>
-<h3 class="section"><a name="AEN57">2.1.2. Compiling from
+<h3 class="section"><a name="sec.compiling">2.2.2. Compiling from
source</a></h3>
<p>TODO: (with more detail than now); pointer to the to-be-written
"Developer's Guide to ScummVM" * List all required libs; where to
@@ -231,39 +312,39 @@
bad.</p></div></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN60">2.2. Installation</a></h2>
+<h2 class="section"><a name="AEN121">2.3. Installation</a></h2>
<p>TODO: Not sure whether we really need this section; most of it
should already be covered by the above section "How to get
ScummVM", I think?</p>
<div class="section">
<hr>
-<h3 class="section"><a name="AEN63">2.2.1. Unix-like (Linux, *BSD,
+<h3 class="section"><a name="AEN124">2.3.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="AEN127">2.3.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="AEN130">2.3.3. Mac OS X</a></h3>
<p>TODO</p></div>
<div class="section">
<hr>
-<h3 class="section"><a name="AEN72">2.2.4. WinCE /
-PocketPC</a></h3>
+<h3 class="section"><a name="AEN133">2.3.4. Windows Mobile (WinCE /
+PocketPC / Smartphone)</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="AEN136">2.3.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="AEN139">2.3.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="AEN142">2.4. 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
@@ -273,30 +354,30 @@
<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="AEN153">2.4.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="AEN156">2.4.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="AEN159">2.4.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="AEN162"></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="AEN164">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?
Also, handle that the launcher is not the same on all ports (e.g.
it is different on Dreamcast).</p>
<div class="section">
<hr>
-<h3 class="section"><a name="AEN106">3.1.1. Adding/removing a
+<h3 class="section"><a name="AEN167">3.1.1. Adding/removing a
game</a></h3>
<p>Adding a new game via the ScummVM launcher should hopefully be
quite straight forward.</p>
@@ -345,14 +426,14 @@
<br></div></li></ol></div>
<div class="section">
<hr>
-<h3 class="section"><a name="AEN143">3.1.2. Configuring a
+<h3 class="section"><a name="AEN204">3.1.2. Configuring a
game</a></h3>
<p>TODO: Explain how to edit the settings for a game in the
launcher; explain what those setting means, with refs to the
corresponding sections in this doc.</p></div>
<div class="section">
<hr>
-<h3 class="section"><a name="AEN146">3.1.3. The (global) options
+<h3 class="section"><a name="AEN207">3.1.3. The (global) options
dialog</a></h3>
<p>TODO: Explain the various settings in this dialog, with
screenshots.</p>
@@ -376,7 +457,7 @@
<br></div></div></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN173">3.2. Command line
+<h2 class="section"><a name="AEN234">3.2. Command line
options</a></h2>
<p><b class="command">scummvm</b> [<tt class=
"replaceable"><i>OPTIONS</i></tt>...] <tt class=
@@ -504,28 +585,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="AEN358"></a>
+<div class="example"><a name="AEN419"></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="AEN361"></a>
+<div class="example"><a name="AEN422"></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="AEN364"></a>
+<div class="example"><a name="AEN425"></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="AEN367"></a>
+<div class="example"><a name="AEN428"></a>
<p><b>Example 3-4. Running Full Throttle from CD, fullscreen and
with subtitles enabled (Unix)</b></p>
<pre class="screen">
@@ -534,26 +615,26 @@
</div></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN370">3.3. Hot Keys</a></h2>
+<h2 class="section"><a name="AEN431">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="AEN373">3.4. Saving and
+<h2 class="section"><a name="AEN434">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="AEN376">3.5. Using Macintosh
+<h2 class="section"><a name="AEN437">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="AEN379">3.6. Multi-CD Games</a></h2>
+<h2 class="section"><a name="AEN440">3.6. Multi-CD Games</a></h2>
<p>
In general, ScummVM does not deal very well with multi-CD
games. This is because ScummVM assumes everything about a game can
be found in one directory. Even if ScummVM does make some
@@ -578,7 +659,7 @@
most likely to find in stores now.</p>
<div class="section">
<hr>
-<h3 class="section"><a name="AEN385">3.6.1. The Curse of Monkey
+<h3 class="section"><a name="AEN446">3.6.1. The Curse of Monkey
Island</a></h3>
<p>
For this game, you'll need the comi.la0, comi.la1 and
comi.la2 files. The comi.la0 file can be found on either CD, but
@@ -590,7 +671,7 @@
identical.</p></div>
<div class="section">
<hr>
-<h3 class="section"><a name="AEN389">3.6.2. Broken Sword 1</a></h3>
+<h3 class="section"><a name="AEN450">3.6.2. Broken Sword 1</a></h3>
<p>
For this game, you'll need all of the files from the
clusters directories on both CDs. You will also need the speech.clu
files from the speech directories, but since they are not identical
@@ -606,7 +687,7 @@
them.</p></div>
<div class="section">
<hr>
-<h3 class="section"><a name="AEN394">3.6.3. Broken Sword 2</a></h3>
+<h3 class="section"><a name="AEN455">3.6.3. Broken Sword 2</a></h3>
<p>
For this game, you'll need all of the files from the
clusters directories on both CDs. (Actually, a few of them may not
be strictly necessary, but the ones that I'm uncertain about are
@@ -622,19 +703,19 @@
them.</p></div></div></div>
<div class="chapter">
<hr>
-<h1><a name="AEN399"></a>Chapter 4. Configuration</h1>
+<h1><a name="AEN460"></a>Chapter 4. Configuration</h1>
<div class="section">
-<h2 class="section"><a name="AEN401">4.1. Using the
+<h2 class="section"><a name="AEN462">4.1. Using the
launcher</a></h2>
<p>TODO</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN404">4.2. All config file switches
+<h2 class="section"><a name="AEN465">4.2. All config file switches
in detail</a></h2>
<p>TODO</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN407">4.3. Graphics Filters</a></h2>
+<h2 class="section"><a name="AEN468">4.3. Graphics Filters</a></h2>
<p>
ScummVM offers several anti-aliasing filters to attempt to
improve visual quality. These are the same filters used in many
other emulators, such as MAME. These filters take the original game
@@ -701,17 +782,17 @@
scalers will scale to 640x480 or 960x720.</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN465">4.4. Music and Sound</a></h2>
+<h2 class="section"><a name="AEN526">4.4. Music and Sound</a></h2>
<p>TODO</p>
<div class="section">
<hr>
-<h3 class="section"><a name="AEN468">4.4.1. Music drivers</a></h3>
+<h3 class="section"><a name="AEN529">4.4.1. Music drivers</a></h3>
<p>TODO: Music/midi drivers: list them all, with desc, and
explanations (current sections 7.0-7.5). Try to help the user in
choosing the "best" driver.</p></div>
<div class="section">
<hr>
-<h3 class="section"><a name="AEN471">4.4.2. Using compressed
+<h3 class="section"><a name="AEN532">4.4.2. Using compressed
audiofiles</a></h3>
<p>TODO: Corresponds to current section 7.6. --> Intro-section
which briefly mentions pros/cons of compressing your audio data;
@@ -723,14 +804,14 @@
I'd prefer if we joined these, to reduce duplications...</p></div>
<div class="section">
<hr>
-<h3 class="section"><a name="AEN474">4.4.3. Volume
+<h3 class="section"><a name="AEN535">4.4.3. Volume
settings</a></h3>
<p>TODO: Explain about the volume settings, what the values mean,
etc. The launcher, command line, config file sections all would
refer to here.</p></div>
<div class="section">
<hr>
-<h3 class="section"><a name="AEN477">4.4.4. Output sample
+<h3 class="section"><a name="AEN538">4.4.4. Output sample
rate</a></h3>
<p>
The output sample rate tells ScummVM how many sound
samples to play per channel per second. There is much that could be
@@ -767,37 +848,37 @@
supported precisely, where to get cutscene packs etc.</p>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN487">A.1. LucasArts Games</a></h2>
+<h2 class="section"><a name="AEN548">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="AEN490">A.2. Humongous Games</a></h2>
+<h2 class="section"><a name="AEN551">A.2. Humongous Games</a></h2>
<p>TODO</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN493">A.3. Adventure Soft
+<h2 class="section"><a name="AEN554">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="AEN496">A.4. Revolution Games</a></h2>
+<h2 class="section"><a name="AEN557">A.4. Revolution Games</a></h2>
<p>TODO: BASS, BS1, BS2</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN499">A.5. Interactive Binary
+<h2 class="section"><a name="AEN560">A.5. Interactive Binary
Illusions Games</a></h2>
<p>TODO: FOTAQ</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN502">A.6. Other Games</a></h2>
+<h2 class="section"><a name="AEN563">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="AEN505"></a>Appendix B. Tools</h1>
+<h1><a name="AEN566"></a>Appendix B. Tools</h1>
<p>TODO: Explain compress_sword2, compress_simon,
compress_scumm_sou, compress_san, etc. ; rescumm shouldn't have to
be explained anymore; not sure if descumm should be explained here,
@@ -805,7 +886,7 @@
debatable...</p>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN508">B.1. compress_san</a></h2>
+<h2 class="section"><a name="AEN569">B.1. compress_san</a></h2>
<p>TODO</p>
<p><b class="command">compress_san</b> <tt class=
"replaceable"><i>inputfile</i></tt> <tt class=
@@ -815,7 +896,7 @@
zlib for compressing FOBJ gfx chunks inside a san file. It also can
create ogg separate file with smush audio track (only COMI
currently supported).</p>
-<div class="example"><a name="AEN520"></a>
+<div class="example"><a name="AEN581"></a>
<p><b>Example B-1. Using compress_san</b></p>
<pre class="screen">
compress_san opening.san uncomp comp
@@ -828,7 +909,7 @@
been built with Ogg support enabled.</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN524">B.2.
+<h2 class="section"><a name="AEN585">B.2.
compress_scumm_sou</a></h2>
<p>TODO</p>
<p>Used to compress .sou files to .so3 (MP3), .sog (Vorbis), or
@@ -871,7 +952,7 @@
</div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN529">B.3. queenrebuild</a></h2>
+<h2 class="section"><a name="AEN590">B.3. queenrebuild</a></h2>
<p>TODO</p>
<p>Used to rebuild the datafile of Flight of the Amazon Queen, to
allow optional MP3/Ogg/FLAC compression.</p>
@@ -889,7 +970,7 @@
</div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN534">B.4. compress_simon</a></h2>
+<h2 class="section"><a name="AEN595">B.4. compress_simon</a></h2>
<p>TODO</p>
<p>Compresses Simon voc/wav files to MP3/Ogg/FLAC.</p>
<pre class="screen">
@@ -931,7 +1012,7 @@
</div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN539">B.5. compress_sword1</a></h2>
+<h2 class="section"><a name="AEN600">B.5. compress_sword1</a></h2>
<p>TODO</p>
<p>Used to compress Broken Sword 1's music and speech files using
mp3 or vorbis.</p>
@@ -955,7 +1036,7 @@
</div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN544">B.6. compress_sword2</a></h2>
+<h2 class="section"><a name="AEN605">B.6. compress_sword2</a></h2>
<p>TODO</p>
<p>Used to compress Broken Sword 2's music and speech .clu files to
.cl3 (MP3), .clg (Vorbis) or .clf (FLAC).</p>
@@ -1000,8 +1081,8 @@
</div></div>
<div class="appendix">
<hr>
-<h1><a name="AEN550"></a>Appendix C. Credits</h1>
-<div class="informaltable"><a name="AEN552"></a>
+<h1><a name="AEN611"></a>Appendix C. Credits</h1>
+<div class="informaltable"><a name="AEN613"></a>
<table border="0" frame="void" rules="none" class="CALSTABLE">
<col width="19" title="start">
<col width="151" title="name">
@@ -1252,7 +1333,7 @@
<tr>
<td colspan="3"> </td></tr></tbody></table></div></div>
<div class="GLOSSARY">
-<h1><a name="AEN741"></a>Glossary</h1>
+<h1><a name="AEN802"></a>Glossary</h1>
<p>TODO: (explaining abbreviations etc.). Like SCUMM, FOTAQ, COMI,
FOA, ITE, ...</p>
<dl>
Index: manual.pdf
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.pdf,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -d -r1.13 -r1.14
--- manual.pdf 24 Dec 2004 23:12:33 -0000 1.13
+++ manual.pdf 25 Dec 2004 01:35:55 -0000 1.14
@@ -33,408 +33,402 @@
<< /S /GoTo /D (4.2.1) >>
endobj
24 0 obj
-(1.2. History)
+(1.2. Reporting bugs)
endobj
25 0 obj
<< /S /GoTo /D (4.3.1) >>
endobj
28 0 obj
-(1.3. Getting further help)
[...9301 lines suppressed...]
+0000222578 00000 n
+0000222683 00000 n
+0000229330 00000 n
+0000238032 00000 n
+0000238073 00000 n
+0000238113 00000 n
+0000238344 00000 n
trailer
<<
-/Size 1050
-/Root 1048 0 R
-/Info 1049 0 R
+/Size 1111
+/Root 1109 0 R
+/Info 1110 0 R
>>
startxref
-232576
+238500
%%EOF
Index: manual.txt
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.txt,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -d -r1.12 -r1.13
--- manual.txt 24 Dec 2004 23:12:36 -0000 1.12
+++ manual.txt 25 Dec 2004 01:35:56 -0000 1.13
@@ -8,32 +8,33 @@
1. Introduction
1.1. What is ScummVM
- 1.2. History
- 1.3. Getting further help
- 1.4. Reporting bugs
- 1.5. Contacting the developers
+ 1.2. Reporting bugs
+ 1.3. Contacting the developers
2. Getting started
- 2.1. How to get ScummVM
+ 2.1. Requirements
+ 2.2. How to get ScummVM
- 2.1.1. Binaries
- 2.1.2. Compiling from source
+ 2.2.1. Binaries
+ 2.2.2. Compiling from source
- 2.2. Installation
+ 2.3. Installation
- 2.2.1. Unix-like (Linux, *BSD, Solaris, etc.)
- 2.2.2. Windows
- 2.2.3. Mac OS X
- 2.2.4. WinCE / PocketPC
- 2.2.5. PalmOS
- 2.2.6. Dreamcast
+ 2.3.1. Unix-like (Linux, *BSD, Solaris, etc.)
+ 2.3.2. Windows
+ 2.3.3. Mac OS X
+ 2.3.4. Windows Mobile (WinCE / PocketPC /
+ Smartphone)
- 2.3. First steps
+ 2.3.5. PalmOS
+ 2.3.6. Dreamcast
- 2.3.1. Unix-like, Windows, Mac OS X
- 2.3.2. WinCE / PocketPC
- 2.3.3. Dreamcast
+ 2.4. First steps
+
+ 2.4.1. Unix-like, Windows, Mac OS X
+ 2.4.2. WinCE / PocketPC
+ 2.4.3. Dreamcast
3. Running and using ScummVM
@@ -127,18 +128,7 @@
cannot donate, help and contribute a patch!
_________________________________________________________
-1.2. History
-
- TODO: Insert some information about the history of ScummVM:
- how it got started, how it evolved, etc.
- _________________________________________________________
-
-1.3. Getting further help
-
- TODO
- _________________________________________________________
-
-1.4. Reporting bugs
+1.2. Reporting bugs
To report a bug, please create a SourceForge account and
follow the bugs link from our homepage. Please make sure the
@@ -170,32 +160,104 @@
satisfies both you and us.
_________________________________________________________
-1.5. Contacting the developers
+1.3. Contacting the developers
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.
+ e-mail the scummvm-devel mailing list (see
+ http://lists.sourceforge.net/lists/listinfo/scummvm-devel). Or
+ chat with us on IRC: channel #scummvm on irc.freenode.net.
- 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).
+ Please do not ask us to support an unsupported game. We do not
+ generally add support for non-SCUMM games! Reverse engineering
+ a completely new game without source is a long process, and
+ our developers are all very busy as it is... so unless you
+ work for a company interested in providing us with source code
+ for one of your classic titles, please do not ask.
_________________________________________________________
Chapter 2. Getting started
-2.1. How to get ScummVM
+2.1. Requirements
-2.1.1. Binaries
+ TODO: List Requirements (in terms of required/optional
+ libraries, CPU power, memory, ... In particular it would be
+ nice if we could e.g. say what PalmOS devices support ScummVM;
+ not necessarily a list of all supported Palm models, but more
+ a list of what OS you need how much memory, colors, etc.)
- TODO: list supported platforms; where to get binaries; list
- requirments (in terms of required/optional libraries, CPU
- power, memory, ...
+ ScummVM is known to run on the following systems:
+
+ * Unix-like (Linux, *BSD, Solaris, etc.)
+ * Windows
+ * Mac OS X
+ * Windows Mobile (WinCE / PocketPC / Smartphone)
+ * PalmOS
+ * Dreamcast
+
+ Besides these, there have been many more inofficial ports in
+ the past. Since they were not done by us, we can not say
+ anything about their reliability, legality, or availability,
+ nor can we provide support for them. Use them at your own
+ risk!
+
+ Among those systems are:
+
+ * MorphOS
+ * GP32
+ * Symbian based smartphones
+ * XBox
+ * PlayStation 2
+ * RISC OS
+
+ If you plan to compile ScummVM yourself, you will need certain
+ additional libraries. More on that in the section Section
+ 2.2.2 (Compiling from source).
_________________________________________________________
-2.1.2. Compiling from source
+2.2. How to get ScummVM
+
+ Basically you have two choices on how to get ScummVM: either
+ you download one of the binaries we built for you (probably
+ the most convenient way); or you can compiler it yourself from
+ source. We strongly recommend to beginners to use our prebuilt
+ binaries.
+ _________________________________________________________
+
+2.2.1. Binaries
+
+ You can download ScummVM from our downloads page:
+ http://www.scummvm.org/downloads.php. Go there with your
+ favorite web browser and download the binary for your
+ platform. If none is available, you may have to build ScummVM
+ yourself, refer to the next section for instructions on how to
+ do that.
+
+ We always ship prebuilt binaries of ScummVM for the following
+ platforms (note that it can sometimes take a few days after a
+ release for all binaries to be available):
+
+ * Linux (Fedora Core)
+ * Linux (Debian)
+ * Windows
+ * Mac OS X
+ * Windows Mobile (WinCE / PocketPC / Smartphone)
+ * PalmOS
+ * Dreamcast
+
+ In addition to these, we try to provide more binaries, but
+ which depends mostly on how many volunteers we can find to
+ help us out. In the past we have shipped binaries for these
+ systems:
+
+ * Linux (Mandrake)
+ * Linux (Slackware)
+ * Solaris
+ * BeOS
+ * MorphOS
+ _________________________________________________________
+
+2.2.2. Compiling from source
TODO: (with more detail than now); pointer to the
to-be-written "Developer's Guide to ScummVM" * List all
@@ -205,44 +267,44 @@
(section 9.0) isn't too bad.
_________________________________________________________
-2.2. Installation
+2.3. Installation
TODO: Not sure whether we really need this section; most of it
should already be covered by the above section "How to get
ScummVM", I think?
_________________________________________________________
-2.2.1. Unix-like (Linux, *BSD, Solaris, etc.)
+2.3.1. Unix-like (Linux, *BSD, Solaris, etc.)
TODO
_________________________________________________________
-2.2.2. Windows
+2.3.2. Windows
TODO
_________________________________________________________
-2.2.3. Mac OS X
+2.3.3. Mac OS X
TODO
_________________________________________________________
-2.2.4. WinCE / PocketPC
+2.3.4. Windows Mobile (WinCE / PocketPC / Smartphone)
TODO
_________________________________________________________
-2.2.5. PalmOS
+2.3.5. PalmOS
TODO
_________________________________________________________
-2.2.6. Dreamcast
+2.3.6. Dreamcast
TODO
_________________________________________________________
-2.3. First steps
+2.4. First steps
TODO: (basic setup; how to add a game using the launcher and
the play it, getting a first game to run).
@@ -254,17 +316,17 @@
[launcher-empty.png]
_________________________________________________________
-2.3.1. Unix-like, Windows, Mac OS X
+2.4.1. Unix-like, Windows, Mac OS X
TODO
_________________________________________________________
-2.3.2. WinCE / PocketPC
+2.4.2. WinCE / PocketPC
TODO
_________________________________________________________
-2.3.3. Dreamcast
+2.4.3. Dreamcast
TODO
_________________________________________________________
More information about the Scummvm-git-logs
mailing list