[Scummvm-cvs-logs] SF.net SVN: scummvm: [25049] docs/trunk/docbook/manual.xml

fingolfin at users.sourceforge.net fingolfin at users.sourceforge.net
Sun Jan 7 23:27:37 CET 2007


Revision: 25049
          http://scummvm.svn.sourceforge.net/scummvm/?rev=25049&view=rev
Author:   fingolfin
Date:     2007-01-07 14:27:36 -0800 (Sun, 07 Jan 2007)

Log Message:
-----------
Synced manual.xml a bit with our README, and made some minor enhancements

Modified Paths:
--------------
    docs/trunk/docbook/manual.xml

Modified: docs/trunk/docbook/manual.xml
===================================================================
--- docs/trunk/docbook/manual.xml	2007-01-07 22:20:13 UTC (rev 25048)
+++ docs/trunk/docbook/manual.xml	2007-01-07 22:27:36 UTC (rev 25049)
@@ -42,29 +42,42 @@
     <section>
       <title>What is ScummVM</title>
       <simpara>
-ScummVM is a collection of interpreters, capable of emulating several
-adventure game engines. ScummVM mainly supports games created using 
-SCUMM (Script Creation Utility for Maniac Mansion), used in various
-LucasArts games such as Monkey Island, Day of the Tentacle, and others.
+ScummVM is a program which allows you to run certain classic graphical
+point-and-click adventure games, provided you already have their data
+files. The clever part about this: ScummVM just replaces the
+executables shipped with the game, allowing you to play them on
+systems for which they were never designed!
       </simpara>
 
       <simpara>
-ScummVM also contains interpreters for several non-SCUMM games. Currently
-these are Beneath a Steel Sky, Broken Sword 1 & 2, Flight of the Amazon Queen
-and Simon the Sorcerer 1 & 2.
+Some of the adventures ScummVM supports include Adventure Soft's Simon
+the Sorcerer 1 and 2; Revolution's Beneath A Steel Sky, Broken Sword 1
+and Broken Sword 2; Flight of the Amazon Queen; Wyrmkeep's Inherit the
+Earth; Coktel Vision's Gobliiins; Westwood Studios' The Legend of
+Kyrandia and games based on LucasArts' SCUMM (Script Creation Utility
+for Maniac Mansion) system such as Monkey Island, Day of the Tentacle,
+Sam and Max and more. You can find a thorough list with details on
+which games are supported and how well on the compatibility
+page. ScummVM is continually improving, so check back often.
       </simpara>
 
       <simpara>
+Among the systems on which you can play those games are Windows,
+Linux, Mac OS X, Dreamcast, PocketPC, PalmOS, AmigaOS, BeOS, OS/2,
+PSP, PS2, SymbianOS/EPOC and many more.
+      </simpara>
+
+      <simpara>
 At this time ScummVM should be considered beta software, and is still
 under heavy development. Be aware that whilst we attempt to make sure
-that many games can be completed with few major bugs, crashes can happen. 
+that many games can be completed with few major bugs, crashes can happen.
       </simpara>
 
       <simpara>
-If you enjoy ScummVM feel free to donate using the PayPal button on the
-<ulink url="http://www.scummvm.org">ScummVM homepage</ulink>. This will
-help us buy utilities needed to develop ScummVM easier and quicker. If
-you cannot donate, help and contribute a patch!
+If you enjoy ScummVM feel free to
+<ulink url="http://sourceforge.net/donate/index.php?group_id=37116">donate some money</ulink>
+to help us. This will help us buy utilities needed to develop ScummVM
+easier and quicker. If you cannot donate, help and contribute a patch!
       </simpara>
 
     </section>
@@ -84,14 +97,17 @@
     </section>
 -->
 
-    <section>
-      <title>Reporting bugs</title>
+    <section id="sec.reporting-bugs">
+      <title id="sec.title.reporting-bugs">Reporting bugs</title>
       <simpara>
-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.
+To report a bug, please create a <ulink url="http://sourceforge.net">SourceForge account</ulink>,
+then use our <ulink url="http://sourceforge.net/tracker/?group_id=37116&atid=418820">bug tracker</ulink>
+to file a report (you can also reach it via the "Bug Tracking" link from
+<ulink url="http://www.scummvm.org">our homepage</ulink>.
+Please make sure the bug is reproducible, and still occurs in the latest
+daily build/current CVS version. Also check the list of known bugs
+(below) and the <ulink url="http://www.scummvm.org/compatibility.php">compatibility list on our website</ulink>
+for that game, to ensure the issue is not already known.
       </simpara>
 
       <simpara>
@@ -125,17 +141,16 @@
     <section>
       <title>Contacting the developers</title>
       <simpara>
-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 (see <ulink url="http://lists.sourceforge.net/lists/listinfo/scummvm-devel"/>).
-Or chat with us on IRC: channel #scummvm on irc.freenode.net.
+The easiest way to contact the ScummVM team is by submitting bug reports
+(see <xref linkend="sec.reporting-bugs"/>) or by using our
+<ulink url="http://forums.scummvm.org">forums</ulink>.
+You can also join and email the scummvm-devel mailing list (see
+<ulink url="http://lists.sourceforge.net/lists/listinfo/scummvm-devel"/>).
+Or chat with us on IRC (channel #scummvm on irc.freenode.net).
       </simpara>
       <simpara>
-Please do not ask us to support an unsupported game.
-We do <emphasis>not</emphasis> 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.
+Please do not ask us to support an unsupported game -- read 
+<ulink url="http://www.scummvm.org/faq.php">our FAQ</ulink> for an explanation.
       </simpara>
     </section>
   </chapter>
@@ -182,13 +197,13 @@
 
       <simpara>
       If you plan to compile ScummVM yourself, you will need certain additional libraries.
-      More on that in the section <xref linkend="sec.compiling"/> (<xref linkend="sec.compiling" endterm="sec.title.compiling"/>).
+      More on that in <xref linkend="sec.compiling"/>.
       </simpara>
 
     </section>
 
     <section>
-      <title>How to get ScummVM</title>
+      <title>How to obtain ScummVM</title>
       <simpara>
       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);
@@ -213,8 +228,12 @@
         <listitem><simpara>Windows</simpara></listitem>
         <listitem><simpara>Mac OS X</simpara></listitem>
         <listitem><simpara>Windows Mobile (WinCE / PocketPC / Smartphone)</simpara></listitem>
-        <listitem><simpara>PalmOS</simpara></listitem>
+        <listitem><simpara>Symbian</simpara></listitem>
         <listitem><simpara>Dreamcast</simpara></listitem>
+        <listitem><simpara>PlayStation 2</simpara></listitem>
+        <listitem><simpara>PlayStation Portable</simpara></listitem>
+        <listitem><simpara>Nintendo DS</simpara></listitem>
+        <listitem><simpara>GP2X</simpara></listitem>
         </itemizedlist>
 
         <simpara>
@@ -227,7 +246,9 @@
         <listitem><simpara>Linux (Slackware)</simpara></listitem>
         <listitem><simpara>Solaris</simpara></listitem>
         <listitem><simpara>BeOS</simpara></listitem>
+        <listitem><simpara>AmigaOS 4</simpara></listitem>
         <listitem><simpara>MorphOS</simpara></listitem>
+        <listitem><simpara>OS/2</simpara></listitem>
         </itemizedlist>
       </section>
 
@@ -306,7 +327,7 @@
       it, getting a first game to run).
       </simpara>
       <simpara>Note: We use the default launcher GUI on many systems, but
-      some have their own custom launcher, so we'll want to have a separate
+      some have their own custom launcher, so we will want to have a separate
       section with different screen shots for those.
       </simpara>
 
@@ -583,21 +604,35 @@
         <varlistentry>
         <term>-g</term><term>--gfx-mode=<replaceable>MODE</replaceable></term>
         <listitem>
-        <simpara>Select graphics scaler (see also section 5.3)</simpara>
+        <simpara>Select graphics scaler (see also <xref linkend="sec.graphics-filter"/>)</simpara>
         </listitem>
         </varlistentry>
 
         <varlistentry>
+        <term>--gui-theme=<replaceable>THEME</replaceable></term>
+        <listitem>
+        <simpara>Select GUI theme (default, modern, classic)</simpara>
+        </listitem>
+        </varlistentry>
+
+        <varlistentry>
+        <term>--themepath=<replaceable>PATH</replaceable></term>
+        <listitem>
+        <simpara>Path to where GUI themes are stored</simpara>
+        </listitem>
+        </varlistentry>
+
+        <varlistentry>
         <term>-e</term><term>--music-driver=<replaceable>MODE</replaceable></term>
         <listitem>
-        <simpara>Select music driver (see also section 7.0)</simpara>
+        <simpara>Select music driver (see also <xref linkend="sec.music-driver"/>)</simpara>
         </listitem>
         </varlistentry>
 
         <varlistentry>
         <term>-q</term><term>--language=<replaceable>LANG</replaceable></term>
         <listitem>
-        <simpara>Select language (see also section 5.2)</simpara>
+        <simpara>Select language (see also section <xref linkend="sec.TODO"/>)</simpara>
         </listitem>
         </varlistentry>
 
@@ -623,6 +658,13 @@
         </varlistentry>
 
         <varlistentry>
+        <term>--midi-gain=<replaceable>NUM</replaceable></term>
+        <listitem>
+        <simpara>Set the gain for MIDI playback, 0-1000 (default:100) (only supported by some MIDI drivers)</simpara>
+        </listitem>
+        </varlistentry>
+
+        <varlistentry>
         <term>-n</term><term>--subtitles</term>
         <listitem>
         <simpara>Enable subtitles (use with games that have voice)</simpara>
@@ -651,7 +693,6 @@
         </listitem>
         </varlistentry>
 
-
         <varlistentry>
         <term>--cdrom=<replaceable>NUM</replaceable></term>
         <listitem>
@@ -662,15 +703,16 @@
         <varlistentry>
         <term>--joystick<optional>=<replaceable>NUM</replaceable></optional></term>
         <listitem>
-        <simpara>Enable input with joystick (default: 0 = first joystick)</simpara>
+        <simpara>Enable joystick input (default: 0 = first joystick)</simpara>
         </listitem>
         </varlistentry>
 
         <varlistentry>
         <term>--platform=<replaceable>WORD</replaceable></term>
         <listitem>
-        <simpara>Specify version of game (allowed values: amiga,
-                           atari, fmtowns, mac, pc, windows)</simpara>
+        <simpara>Specify version of game (allowed values: 3do, acorn,
+                           amiga, atari, c64, fmtowns, mac, nes, pc, segacd,
+                           windows)</simpara>
         </listitem>
         </varlistentry>
 
@@ -706,10 +748,20 @@
         <term>--aspect-ratio</term>
         <listitem>
         <simpara>Enable aspect ratio correction</simpara>
+        <!-- TODO: Explain this either here or link to an explanation -->
         </listitem>
         </varlistentry>
 
+        <varlistentry>
+        <term>--render-mode=<replaceable>MODE</replaceable></term>
+        <listitem>
+        <simpara>Enable additional render modes (cga, ega, hercGreen,
+                           hercAmber, amiga)</simpara>
+        <!-- TODO: Explain this either here or link to an explanation -->
+        </listitem>
+        </varlistentry>
 
+
         <varlistentry>
         <term>--alt-intro</term>
         <listitem>
@@ -723,6 +775,7 @@
         <listitem>
         <simpara>Enable copy protection in SCUMM games, when
                            ScummVM disables it by default.</simpara>
+        <!-- TODO: Add link to the copy protection section -->
         </listitem>
         </varlistentry>
 
@@ -751,16 +804,17 @@
       </variablelist>
 
       <simpara>
-      The meaning of most long options (that is, those starting with a double-dash)
-      can be inverted by prefixing them with "no-". For example, --no-aspect-ratio
-      will turn aspectio ratio correction off.
+The meaning of most long options (that is, those options starting with a
+double-dash) can be inverted by prefixing them with "no-". For example,
+--no-aspect-ratio will turn aspectio ratio correction off. This is useful
+if you want to override a setting in the configuration file.
       </simpara>
       
       <simpara>
-      The short game name ('game target') you see at the end of the command
-      line is very important. A short list is contained at the top of this
-      file. You can also get the current list of games and game names at
-              <ulink url="http://www.scummvm.org/compatibility.php"/>
+The short game name ('game target') you see at the end of the command
+line specifies which game is started. It either corresponds to an arbitrary
+user defined target (from the configuration file), or to a built-in gameid.
+A brief list of the latter can be found in <xref linkend="sec.supported-games"/>.
       </simpara>
 
 
@@ -831,12 +885,12 @@
       <section>
         <title>The Curse of Monkey Island</title>
         <simpara>
-        For this game, you'll need the comi.la0, comi.la1 and comi.la2 files. The
+        For this game, you will need the comi.la0, comi.la1 and comi.la2 files. The
         comi.la0 file can be found on either CD, but since they are identical it
         doesn't matter which one of them you use.
         </simpara>
         <simpara>
-        In addition, you'll need a resource subdirectory with all of the files from the
+        In addition, you will need a resource subdirectory with all of the files from the
         resource subdirectories on both CDs. Some of the files appear on both CDs, but
         again they're identical.
         </simpara>
@@ -845,9 +899,9 @@
       <section>
         <title>Broken Sword 1</title>
         <simpara>
-        For this game, you'll need all of the files from the clusters directories on
+        For this game, you will 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 you'll need to rename them speech1.clu and
+        but since they are not identical you will need to rename them speech1.clu and
         speech2.clu for CD 1 and 2 respectively.
         </simpara>
         <simpara>
@@ -865,7 +919,7 @@
       <section>
         <title>Broken Sword 2</title>
         <simpara>
-        For this game, you'll need all of the files from the clusters directories on
+        For this game, you will 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 all fairly small.) You will need to rename the
         speech.clu and music.clu files speech1.clu, speech2.clu, music1.clu and
@@ -899,17 +953,17 @@
       <simpara>TODO</simpara>
     </section>
 
-    <section>
-      <title>Graphics Filters</title>
+    <section id="sec.graphics-filter">
+      <title id="sec.title.graphics-filter">Graphics Filters</title>
       <simpara>
-      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 graphics, and scale it by a 
-      certain fixed factor (usually 2x or 3x) before displaying them to you.
-      So for example, if the game originally run at a resolution of 320x200
-      (typical for most of the SCUMM games), then using a filter with scale
-      factor 2x will effectively yield 640x400 graphics. Likewise with a 
-      3x filter you'll get 960x600.
+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 graphics, and scale it by a
+certain fixed factor (usually 2x or 3x) before displaying them to you.
+So for example, if the game originally run at a resolution of 320x200
+(typical for most of the SCUMM games), then using a filter with scale
+factor 2x will effectively yield 640x400 graphics. Likewise with a
+3x filter you will get 960x600.
       </simpara>
       
       <simpara>
@@ -983,18 +1037,20 @@
       </simpara>
       <screen>  scummvm -g advmame2x monkey2</screen>
       <simpara>
-      Note #1: Not all backends support all or any filters. The ones listed above
-      are for the default SDL backend.
+Note #1: Not all backends support all (or even any) of the filters listed above;
+some may support additional ones. The filters listed above are those supported
+by the default SDL backend.
       </simpara>
       <simpara>
-      Note #2: Filters can be very slow when ScummVM is compiled in a debug
-      configuration without optimizations. And there is always a speed impact when
-      using any form of anti-aliasing/linear filtering.
+Note #2: Filters can be very slow when ScummVM is compiled in a debug
+configuration without optimizations. And there is always a speed impact when
+using any form of anti-aliasing/linear filtering.
       </simpara>
       <simpara>
-      Note #3: The FM-TOWNS version of Zak (zaktowns target) uses an original 
-      resolution of 320x240 - hence for this game scalers will scale to 
-      640x480 or 960x720.
+Note #3: The FM-TOWNS version of Zak McKracken uses an original resolution
+of 320x240, hence for this game scalers will scale to 640x480 or 960x720.
+Likewise, games that originally were using 640x480 (such as COMI or Broken Sword)
+will be scaled to 1280x960 and 1920x1440.
       </simpara>
     </section>
 
@@ -1002,8 +1058,9 @@
       <title>Music and Sound</title>
       <simpara>TODO
       </simpara>
-      <section>
-        <title>Music drivers</title>
+
+      <section id="sec.music-driver">
+        <title id="sec.title.music-driver">Music drivers</title>
         <simpara>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.
@@ -1054,7 +1111,7 @@
         <simpara>
         When using the Adlib, FM Towns, PC Speaker or IBM PCjr music drivers, ScummVM
         is responsible for generating the samples. Usually 22050 Hz will be plenty for
-        these, but there is at least one piece of Adlib music in Beneath a Steeel Sky
+        these, but there is at least one piece of Adlib music in Beneath a Steel Sky
         that will sound a lot better at 44100 Hz.
         </simpara>
         <simpara>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




More information about the Scummvm-git-logs mailing list