From 6919e71608b7ff0db99c57fbb3abd7e0220f0fd0 Mon Sep 17 00:00:00 2001 From: Bastien Bouclet Date: Sun, 3 Nov 2019 10:03:13 +0100 Subject: DOC: Update the documentation for engineId --- README.md | 15 ++++++++------- dists/scummvm.6 | 12 +++++++----- 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 116f2fc4f9..fe93564b6e 100644 --- a/README.md +++ b/README.md @@ -1360,7 +1360,7 @@ arguments -- see the next section. Usage: scummvm [OPTIONS]... [GAME] - [GAME] Short name of game to load. For example, 'monkey' + [GAME] Short name of game to load. For example, 'scumm:monkey' for Monkey Island. This can be either a built-in gameid, or a user configured target. @@ -1368,6 +1368,7 @@ arguments -- see the next section. -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 + --list-engines Display list of suppported engines and exit --list-saves Display a list of saved games for the target specified with --game=TARGET, or all targets if none is specified -a, --add Add all games from current or specified directory. @@ -1461,17 +1462,17 @@ Examples: - Win32: Running Monkey Island, fullscreen, from a hard disk: `C:\Games\LucasArts\scummvm.exe -f -pC:\Games\LucasArts\monkey\ - monkey` + scumm:monkey` Running Full Throttle from CD, fullscreen and with subtitles enabled: - `C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ ft` + `C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ scumm:ft` - Unix: Running Monkey Island, fullscreen, from a hard disk: - `/path/to/scummvm -f -p/games/LucasArts/monkey/ monkey` + `/path/to/scummvm -f -p/games/LucasArts/monkey/ scumm:monkey` Running Full Throttle from CD, fullscreen and with subtitles enabled: - `/path/to/scummvm -f -n -p/cdrom/resource/ ft` + `/path/to/scummvm -f -n -p/cdrom/resource/ scumm:ft` ### 5.2) Global Menu @@ -1549,7 +1550,7 @@ They are: To select a graphics filter, select it in the Launcher, or pass its name via the '-g' option to scummvm, for example: - scummvm -gadvmame2x monkey2 + scummvm -gadvmame2x scumm:monkey2 Note \#1: Not all backends support all (or even any) of the filters listed above; some may support additional ones. The filters listed above @@ -2114,7 +2115,7 @@ depending on your operating system and configuration. To select a sound driver, select it in the Launcher, or pass its name via the `-e` option to scummvm, for example: -`scummvm -eadlib monkey2` +`scummvm -eadlib scumm:monkey2` ### 7.1) AdLib emulation diff --git a/dists/scummvm.6 b/dists/scummvm.6 index fed024ce2d..efde6f348a 100644 --- a/dists/scummvm.6 +++ b/dists/scummvm.6 @@ -14,7 +14,7 @@ is an interpreter that will play graphic adventure games based on a variety of game engines. .Pp -\fIGAME\fR is a short name of game to load. For example, \fImonkey\fR for +\fIGAME\fR is a short name of game to load. For example, \fIscumm:monkey\fR for Monkey Island. This can be either a built-in gameid, or a user configured target. .Sh OPTIONS @@ -36,6 +36,8 @@ Display a brief help text and exit. Display list of supported games and exit. .It Fl t, -list-targets Display list of configured targets and exit. +.It Fl t, -list-engines +Display list of suppported engines and exit. .It Fl -list-saves Display a list of saved games for the target specified with \fB--game=\fITARGET\fR or all targets if none is specified. @@ -61,7 +63,7 @@ Use alternate configuration file. Path to where the game is installed. .It Fl x, -save-slot= Ns Ar [SLOT] Saved game slot to load (default: autosave). -.It Fl f, -fulscreen +.It Fl f, -fullscreen Force full-screen mode. .It Fl F, -no-fullscreen Force windowed mode. @@ -296,15 +298,15 @@ Running the builtin game launcher: .Pp Running Day of the Tentacle specifying the path: .Pp -.Dl $ scummvm -p /usr/local/share/games/tentacle tentacle +.Dl $ scummvm -p /usr/local/share/games/tentacle scumm:tentacle .Pp Running The Dig with advmame2x filter with subtitles: .Pp -.Dl $ scummvm -g advmame2x -n dig +.Dl $ scummvm -g advmame2x -n scumm:dig .Pp Running the Italian version of Maniac Mansion fullscreen: .Pp -.Dl $ scummvm -q it -f maniac +.Dl $ scummvm -q it -f scumm:maniac .Sh SEE ALSO More information can be found in the \fIREADME\fR and on the website .Pa https://www.scummvm.org . -- cgit v1.2.3