updated README and usage/help text

svn-id: r10976

2 files changed, 81 insertions, 75 deletions

diff --git a/README b/README
index b482bcb6ac..d13fbcd368 100644
--- a/README
+++ b/README
@@ -314,40 +314,49 @@ arguments - see the next section.
 5.1) Command Line Options:
 ---- ---------------------
 
-THIS NEEDS TO BE UPDATED
-        scummvm [OPTIONS] [GAME]
-
-        [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'
-        -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
+  Usage: scummvm [OPTIONS]... [GAME]
+
+  [GAME]                   Short name of game to load. For example, 'monkey'
+                           for Monkey Island. This can be either a built-in
+                           gameid, or a user configured target.
+
+  -v, --version            Display ScummVM version information and exit
+  -h, --help               Display a brief help text and exit
+  -z, --list-games         Display list of supported games and exit
+  -t, --list-targets       Display list of configured targets and exit
+
+  -p, --path=PATH          Path to where the game is installed
+  -x, --save-slot[=NUM]    Save game slot to load (default: autosave)
+  -f, --fullscreen         Force full-screen mode
+  -F, --no-fullscreen      Force windowed mode
+  -g, --gfx-mode=MODE      Select graphics scaler (see also section 5.3)
+  -e, --music-driver=MODE  Select music driver (see also section 7.0)
+  -q, --language=LANG      Select language (see also section 5.2)
+  -m, --music-volume=NUM   Set the music volume, 0-255 (default: 192)
+  -o, --master-volume=NUM  Set the master volume, 0-255 (default: 192)
+  -s, --sfx-volume=NUM     Set the sfx volume, 0-255 (default: 192)
+  -n, --nosubtitles        Disable subtitles (use with games that have voice)
+  -b, --boot-param=NUM     Pass number to the boot script (boot param)
+  -d, --debuglevel=NUM     Set debug verbosity level
+  -u, --dump-scripts       Enable script dumping if a directory called 'dumps'
+                           exists in the current directory
+
+  --cdrom=NUM              CD drive to play CD audio from (default: 0 = first
+                           drive)
+  --joytick[=NUM]          Enable input with joystick (default: 0 = first
+                           joystick)
+  --platform=WORD          Specify version of game (allowed values: amiga,
+                           atari, mac, pc)
+  --multi-midi             Enable combination Adlib and native MIDI
+  --native-mt32            True Roland MT-32 (disable GM emulation)
+  --aspect-ratio           Enable aspect ratio correction
+
+  --floppy-intro           Use floppy version intro for Beneath a Steel Sky CD
+  --demo-mode              Start demo mode of Maniac Mansion (Classic version)
+  --tempo=NUM              Set music tempo (in percent, 50-200) for SCUMM games
+                           (default: 100)
+  --talkspeed=NUM          Set talk speed for SCUMM games (default: 60)
+
 
 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
diff --git a/base/gameDetector.cpp b/base/gameDetector.cpp
index 1b16e28c85..00038c3093 100644
--- a/base/gameDetector.cpp
+++ b/base/gameDetector.cpp
@@ -43,55 +43,52 @@ static const char USAGE_STRING[] = "NoUsageString"; // save more data segment sp
 #else
 static const char USAGE_STRING[] = 
 	"ScummVM - Graphical Adventure Game Interpreter\n"
-	"New USAGE_STRING is missing here!\n" 
-/*	"Syntax:\n"
-	"  scummvm [OPTIONS] [game]\n"
-	"Options:\n"
-	"  -p<path>       - Look for game in <path>\n"
-	"  -x[num]        - Load this savegame (default: 0 - autosave)\n"
-	"  -f             - Full-screen mode (-F forces window mode.)\n"
-	"  -g<mode>       - Graphics mode (normal,2x,3x,2xsai,super2xsai,supereagle,\n"
-	"                   advmame2x,advmame3x,hq2x,hq3x,tv2x,dotmatrix)\n"
-	"  -e<mode>       - Set music engine (see README for details)\n"
-	"  -q<lang>       - Specify language (en,de,fr,it,pt,es,jp,zh,kr,se,gb,hb,ru)\n"
+	"Usage: scummvm [OPTIONS]... [GAME]\n"
+	"  -v, --version            Display ScummVM version information and exit\n"
+	"  -h, --help               Display a brief help text and exit\n"
+	"  -z, --list-games         Display list of supported games and exit\n"
+	"  -t, --list-targets       Display list of configured targets and exit\n"
 	"\n"
-	"  -c<num>        - Use cdrom <num> for cd audio\n"
-	"  -j[num]        - Enable input with joystick (default: 0 - first joystick)\n"
-	"  -m<num>        - Set music volume to <num> (0-255)\n"
-	"  -o<num>        - Set master volume to <num> (0-255)\n"
-	"  -s<num>        - Set sfx volume to <num> (0-255)\n"
-#ifndef DISABLE_SCUMM
-	"  -t<num>        - Set music tempo (50-200, default 100%%)\n"
-#endif
-	"\n"
-	"  -n             - No subtitles for speech\n"
-#ifndef DISABLE_SCUMM
-	"  -y             - Set text speed (default: 60)\n"
-#endif
+	"  -p, --path=PATH          Path to where the game is installed\n"
+	"  -x, --save-slot[=NUM]    Save game slot to load (default: autosave)\n"
+	"  -f, --fullscreen         Force full-screen mode\n"
+	"  -F, --no-fullscreen      Force windowed mode\n"
+	"  -g, --gfx-mode=MODE      Select graphics scaler (normal,2x,3x,2xsai,\n"
+	"                           super2xsai,supereagle,advmame2x,advmame3x,hq2x,\n"
+	"                           hq3x,tv2x,dotmatrix)\n"
+	"  -e, --music-driver=MODE  Select music driver (see README for details)\n"
+	"  -q, --language=LANG      Select language (en,de,fr,it,pt,es,jp,zh,kr,se,gb,hb,ru)\n"
+	"  -m, --music-volume=NUM   Set the music volume, 0-255 (default: 192)\n"
+	"  -o, --master-volume=NUM  Set the master volume, 0-255 (default: 192)\n"
+	"  -s, --sfx-volume=NUM     Set the sfx volume, 0-255 (default: 192)\n"
+	"  -n, --nosubtitles        Disable subtitles (use with games that have voice)\n"
+	"  -b, --boot-param=NUM     Pass number to the boot script (boot param)\n"
+	"  -d, --debuglevel=NUM     Set debug verbosity level\n"
+	"  -u, --dump-scripts       Enable script dumping if a directory called 'dumps'\n"
+	"                           exists in the current directory\n"
 	"\n"
-	"  -v             - Show version info and exit\n"
-	"  -h             - Display this text and exit\n"
-	"  -z             - Display list of supported games\n"
+	"  --cdrom=NUM              CD drive to play CD audio from (default: 0 = first\n"
+	"                           drive)\n"
+	"  --joytick[=NUM]          Enable input with joystick (default: 0 = first\n"
+	"                           joystick)\n"
+	"  --platform=WORD          Specify version of game (allowed values: amiga,\n"
+	"                           atari, mac, pc)\n"
+	"  --multi-midi             Enable combination Adlib and native MIDI\n"
+	"  --native-mt32            True Roland MT-32 (disable GM emulation)\n"
+	"  --aspect-ratio           Enable aspect ratio correction\n"
 	"\n"
-	"  -b<num>        - Pass number to the boot script (boot param)\n"
-	"  -d[num]        - Enable debug output (debug level [0])\n"
-	"  -u             - Dump scripts\n"
-	"\n"
-	"  --platform=    - Specify version of game (amiga,atari-st,macintosh)\n"
-	"  --multi-midi   - Enable combination Adlib and native MIDI\n"
-	"  --native-mt32  - True Roland MT-32 (disable GM emulation)\n"
-	"  --fullscreen   - Full-screen mode (same as -f)\n"
-	"  --aspect-ratio - Enable aspect ratio correction\n"
-#ifndef DISABLE_SCUMM
-	"  --demo-mode    - Start demo mode of Maniac Mansion (Classic version)\n"
-#endif
 #ifndef DISABLE_SKY
-	"  --floppy-intro - Use floppy version intro for Beneath a Steel Sky CD\n"
+	"  --floppy-intro           Use floppy version intro for Beneath a Steel Sky CD\n"
+#endif
+#ifndef DISABLE_SCUMM
+	"  --demo-mode              Start demo mode of Maniac Mansion (Classic version)\n"
+	"  --tempo=NUM              Set music tempo (in percent, 50-200) for SCUMM games\n"
+	"                           (default: 100)\n"
+	"  --talkspeed=NUM          Set talk speed for SCUMM games (default: 60)\n"
 #endif
 	"\n"
 	"The meaning of long options can be inverted by prefixing them with \"no-\",\n"
 	"e.g. \"--no-aspect-ratio\".\n"
-*/
 ;
 #endif