[Scummvm-cvs-logs] CVS: scummvm README,1.184,1.185

Jonathan Gray khalek at users.sourceforge.net
Fri Oct 3 21:59:03 CEST 2003


Update of /cvsroot/scummvm/scummvm
In directory sc8-pr-cvs1:/tmp/cvs-serv31697

Modified Files:
	README 
Log Message:
update the update and consistently use number instead of int when describing config file options to be more user friendly

Index: README
===================================================================
RCS file: /cvsroot/scummvm/scummvm/README,v
retrieving revision 1.184
retrieving revision 1.185
diff -u -d -r1.184 -r1.185
--- README	4 Oct 2003 03:51:25 -0000	1.184
+++ README	4 Oct 2003 04:58:49 -0000	1.185
@@ -317,42 +317,42 @@
 ---- ---------------------
         scummvm [OPTIONS] [GAME]
 
-        [GAME]         - Short name of game to load. For example, 'monkey' for
+        [GAME]           - Short name of game to load. For example, 'monkey' for
                          Monkey Island. This can be either a known gameid, or
                          a pre-configured target.
 
-        -p<path>       - Path to where the game is installed. Default is CWD.
-        -x[num]        - Save game slot to load (default: autosave)
-        -f             - Full-screen mode. (-F forces window mode.)
-        -g<mode>       - Select graphics scaler. See below.
-        -e<mode>       - Select sound engine. See below.
-        -q<lang>       - Select language. See below.
-        -c<num>        - Drive to play CD audio from.  E.g., 0 is first drive.
-        -j[num]        - Enable input with joystick (default: 0 - 1st joystick)
-        -m<num>        - Set the music volume, 0-255.  Default is '192'
-        -o<num>        - Set the master volume, 0-255. Default is '192'
-        -s<num>        - Set the sfx volume, 0-255.    Default is '192'
-        -t<num>        - Set music tempo. 50-200. Default is '100' (percent)
-        -n             - Disable subtitles. Use with games that have voice.
-        -y             - Set talk speed ('yak option'). Default is '60'
-        -l<file>       - Load alternate configuration file
-        -w[file]       - Write configuration file
-        -v             - Show version information and exit
-        -z             - Display list of games
-        -b<num>        - Pass number to the boot script (boot param)
-        -d[num]        - Set debug verbosity to <num>
-        -u             - Dump scripts if a directory called 'dumps' exists in
-                         current directory
-        --platform=    - Specify version of game (amiga,atari-st,macintosh)
-        --multi-midi   - Enable combination Adlib and native MIDI
-        --native-mt32  - True Roland MT-32 (disable GM emulation)
-        --fullscreen   - Full-screen mode (same as -f)
-        --aspect-ratio - Enable aspect ratio correction
-        --demo-mode    - Start demo mode of Maniac Mansion (Classic version)
-        --floppy-intro - Use floppy version intro for Beneath a Steel Sky CD
+        -p<path>        - Path to where the game is installed. Default is CWD.
+        -x[num]         - Save game slot to load (default: autosave)
+        -f              - Full-screen mode. (-F forces window mode.)
+        -g<mode>        - Select graphics scaler. See below.
+        -e<mode>        - Select sound engine. See below.
+        -q<lang>        - Select language. See below.
+        -c<num>         - Drive to play CD audio from.  E.g., 0 is first drive.
+        -j[num]         - Enable input with joystick (default: 0 - 1st joystick)
+        -m<num>          - Set the music volume, 0-255.  Default is '192'
+        -o<num>         - Set the master volume, 0-255. Default is '192'
+        -s<num>         - Set the sfx volume, 0-255.    Default is '192'
+        -t<num>         - Set music tempo. 50-200. Default is '100' (percent)
+        -n              - Disable subtitles. Use with games that have voice.
+        -y              - Set talk speed ('yak option'). Default is '60'
+        -l<file>        - Load alternate configuration file
+        -w[file]        - Write configuration file
+        -v              - Show version information and exit
+        -z              - Display list of games
+        -b<num>         - Pass number to the boot script (boot param)
+        -d<num>         - Set debug verbosity to <num>
+        -u              - Dump scripts if a directory called 'dumps' exists in
+                          current directory
+        --platform=     - Specify version of game (amiga,atari-st,macintosh)
+        --multi-midi    - Enable combination Adlib and native MIDI
+        --native-mt32   - True Roland MT-32 (disable GM emulation)
+        --fullscreen    - Full-screen mode (same as -f)
+        --aspect-ratio  - Enable aspect ratio correction
+        --demo-mode     - Start demo mode of Maniac Mansion (Classic version)
+        --floppy-intro  - Use floppy version intro for Beneath a Steel Sky CD
 
-The meaning of long options can be inverted by prefixing them with "no-", e.g.
---no-aspect-ratio. This is useful if you want to override a setting in the
+The meaning of most long options can be inverted by prefixing them with "no-",
+e.g. --no-aspect-ratio. This is useful if you want to override a setting in the
 configuration file.
 
 The short game name ('game target') you see at the end of the command
@@ -789,8 +789,8 @@
         path            string   The path to where a game's data files are
         read_only       bool     If true, ScummVM will never try to overwrite
                                  the configuration file.
-        save_slot
-        savepath                 The path to where a game will store its
+        save_slot       number   The save game number to load on startup.
+        savepath        string   The path to where a game will store its
                                  savegames.
         versioninfo     string   The version of the ScummVM that created the
                                  configuration file.
@@ -812,25 +812,25 @@
                                  super2xsai, supereagle, advmame2x, advmame3x,
                                  hq2x, hq3x, tv2x, dotmatrix)
 
-        cdrom           int      Number of CD-ROM unit to use for audio. If
+        cdrom           number   Number of CD-ROM unit to use for audio. If
                                  negative, don't even try to access the CD-ROM.
-        joystick_num    int      Number of joystick device to use for input
-        master_volume   int      The master volume setting (0-255)
+        joystick_num    number   Number of joystick device to use for input
+        master_volume   number   The master volume setting (0-255)
         music_driver    string   The music engine to use.
-        music_volume    int      The music volume setting (0-255)
+        music_volume    number   The music volume setting (0-255)
         multi_midi      bool     If true, enable combination Adlib and native
                                  MIDI.
         native_mt32     bool     If true, disable GM emulation and assume that
                                  there is a true Roland MT-32 available.
-        sfx_volume      int      The sfx volume setting (0-255)
-        tempo           int      The music tempo (50-200) (default: 100)
+        sfx_volume      number   The sfx volume setting (0-255)
+        tempo           number   The music tempo (50-200) (default: 100)
 
         demo_mode       bool     Start demo in Maniac Mansion (Classic version)
         floppy_intro    bool     Use floppy version of introduction in Beneath
                                  a Steel Sky (CD version)
 
-        bootparam       int      Pass this number to the boot script
-        debuglevel      int      Enable debug output. The higher number, the
+        boot_param      number   Pass this number to the boot script
+        debug_level     number   Enable debug output. The higher number, the
                                  more verbose output.
 
 9.0 Compiling:





More information about the Scummvm-git-logs mailing list