thirdparty/scummvm
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

DOCS: Adding engine and debugflag-related CLI options (#4331)

Browse source
This commit is contained in:
Thunderforge 2022-10-13 17:46:46 -05:00 • committed by GitHub
parent 972a6aed9b
commit 88e4fe24c6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
doc/docportal/advanced_topics/command_line.rst
View file

@ -128,6 +128,7 @@ Short options are listed where they are available.
``--engine-speed=NUM``,,"Sets frames per second limit (0 - 100) for Grim Fandango or Escape from Monkey Island (default: 60)." ``--engine-speed=NUM``,,"Sets frames per second limit (0 - 100) for Grim Fandango or Escape from Monkey Island (default: 60)."
``--dump-scripts``,``-u``,"Enables script dumping if a directory called 'dumps' exists in the current directory" ``--dump-scripts``,``-u``,"Enables script dumping if a directory called 'dumps' exists in the current directory"
``--enable-gs``,,":ref:`Enables Roland GS mode for MIDI playback <gs>`" ``--enable-gs``,,":ref:`Enables Roland GS mode for MIDI playback <gs>`"
``--engine=ID``,,"In combination with ``--list-games`` or ``--list-all-games`` only lists games for this engine"
``--extrapath=PATH``,,":ref:`Extra path to additional game data <extra>`" ``--extrapath=PATH``,,":ref:`Extra path to additional game data <extra>`"
``--iconspath=PATH``,,":ref:`Path to additional icons for the launcher grid view <iconspath>`" ``--iconspath=PATH``,,":ref:`Path to additional icons for the launcher grid view <iconspath>`"
``--filtering``,,":ref:`Forces filtered graphics mode <filtering>`" ``--filtering``,,":ref:`Forces filtered graphics mode <filtering>`"
@ -139,6 +140,10 @@ Short options are listed where they are available.
``--joystick=NUM``,,"Enables joystick input (default: 0 = first joystick)" ``--joystick=NUM``,,"Enables joystick input (default: 0 = first joystick)"
``--language``,``-q``,":ref:`Selects language <lang>` (en, de, fr, it, pt, es, jp, zh, kr, se, gb, hb, ru, cz)" ``--language``,``-q``,":ref:`Selects language <lang>` (en, de, fr, it, pt, es, jp, zh, kr, se, gb, hb, ru, cz)"
``--list-audio-devices``,,"Lists all available audio devices" ``--list-audio-devices``,,"Lists all available audio devices"
``--list-engines``,,"Display list of supported engines and exit"
``--list-all-engines``,,"Display list of all detection engines and exit"
``--list-debugflags=engine``,,"Display list of engine specified debugflags. If ``engine=global`` or engine is not specified, then it will list global debugflags."
``--list-all-debugflags``,,"Display list of all engine specified debugflags"
``--list-saves --game=TARGET``,,"Displays a list of saved games for the game (TARGET) specified" ``--list-saves --game=TARGET``,,"Displays a list of saved games for the game (TARGET) specified"
``--list-targets``,``-t``,"Displays list of configured targets and exits" ``--list-targets``,``-t``,"Displays list of configured targets and exits"
``--list-themes``,,"Displays list of all usable GUI themes" ``--list-themes``,,"Displays list of all usable GUI themes"
@ -171,4 +176,4 @@ Short options are listed where they are available.
``--md5mac``,,"Shows MD5 hash for both the resource fork and data fork of the file given by ``--md5-path=PATH``. If ``--md5-length=NUM`` is passed then it shows the MD5 hash of the first or last ``NUM`` bytes of each fork." ``--md5mac``,,"Shows MD5 hash for both the resource fork and data fork of the file given by ``--md5-path=PATH``. If ``--md5-length=NUM`` is passed then it shows the MD5 hash of the first or last ``NUM`` bytes of each fork."
``--md5-path=PATH``,,"Used with ``--md5`` or ```--md5mac`` to specify path of file to calculate MD5 hash of (default: ./scummvm)" ``--md5-path=PATH``,,"Used with ``--md5`` or ```--md5mac`` to specify path of file to calculate MD5 hash of (default: ./scummvm)"
``--md5-length=NUM``,,"Used with ``--md5`` or ```--md5mac`` to specify the number of bytes to be hashed. If ``NUM`` is 0, MD5 hash of the whole file is calculated. Of ``NUM`` is negative, the MD5 hash is calculated from the tail. Is overriden if passed with ``--md5-engine`` option. (default: 0)" ``--md5-length=NUM``,,"Used with ``--md5`` or ```--md5mac`` to specify the number of bytes to be hashed. If ``NUM`` is 0, MD5 hash of the whole file is calculated. Of ``NUM`` is negative, the MD5 hash is calculated from the tail. Is overriden if passed with ``--md5-engine`` option. (default: 0)"
``--md5-engine=ENGINE_ID``,,"Used with ``--md5`` to specify engine of game for which hash is to be calculated. Overrides ``--md5-length`` if passed with it" ``--md5-engine=ENGINE_ID``,,"Used with ``--md5`` to specify the engine for which number of bytes to be hashed must be calculated. This option overrides ``--md5-length`` if used along with it. Use ``--list-engines`` to find all engineIds."