diff --git a/doc/docportal/advanced_topics/command_line.rst b/doc/docportal/advanced_topics/command_line.rst index c64a1e3debb..4577e25ad12 100755 --- a/doc/docportal/advanced_topics/command_line.rst +++ b/doc/docportal/advanced_topics/command_line.rst @@ -48,7 +48,7 @@ To launch ScummVM, enter the path to ScummVM. Optionally, follow this with any o .. panels:: :column: col-lg-12 - The following examples assume that the path to ScummVM is ``C:\Games\LucasArts\scummvm.exe``. + The following examples assume that the path to ScummVM is ``C:``Games``LucasArts``scummvm.exe``. ^^^^ @@ -56,7 +56,7 @@ To launch ScummVM, enter the path to ScummVM. Optionally, follow this with any o .. code-block:: - C:\Games\LucasArts\scummvm.exe -f monkey + C:``Games``LucasArts``scummvm.exe -f monkey @@ -64,7 +64,7 @@ To launch ScummVM, enter the path to ScummVM. Optionally, follow this with any o .. code-block:: - C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ft + C:``Games``LucasArts``scummvm.exe -f -n -pD:``resource``ft .. tabbed:: Linux/Unix @@ -107,60 +107,60 @@ Short options are listed where they are available. :header-rows: 1 Option,Short,Description - \--add,-a,"Adds all games from current or specified directory. + ``--add``,``-a``,"Adds all games from current or specified directory. - If \--game=NAME is passed, only the game with id NAME is added. See also \--detect. Use \--path=PATH before -a or \--add to specify a directory." - \--alt-intro, ,":ref:`Uses alternative intro for CD versions `" - \--aspect-ratio,,":ref:`Enables aspect ratio correction `" - \--auto-detect,,"Displays a list of games from current or specified directory and starts the first one. Use \--path=PATH before \--auto-detect to specify a directory." - \--boot-param=NUM,-b,"Pass number to the boot script (boot param)" - \--cdrom=DRIVE,,"CD drive to play CD audio from; can either be a drive, path, or numeric index (default: 0 = best choice drive)" - \--config=FILE,-c,"Uses alternate configuration file" - \--copy-protection,,"Enables copy protection" - \--debug-channels-only,,"Shows only the specified debug channels" - \--debugflags=FLAGS,,"Enables engine specific debug flags" - \--debuglevel=NUM,-d,"Sets debug verbosity level" - \--demo-mode,,"Starts demo mode of Maniac Mansion or The 7th Guest" - \--detect,,"Displays a list of games with their ID from current or specified directory without adding it to the config. Use \--path=PATH before \--detect to specify a directory." - \--dimuse-tempo=NUM,,"Sets internal Digital iMuse tempo (10 - 100) per second (default: 10)" - \--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 `" - \--extrapath=PATH,,":ref:`Extra path to additional game data `" - \--filtering,,":ref:`Forces filtered graphics mode `" - \--fullscreen,-f,":ref:`Forces full-screen mode `" - \--game=NAME,,"In combination with \--add or \--detect only adds or attempts to detect the :ref:`game with id NAME `." - \--gfx-mode,-g,":ref:`Selects graphics mode `" - \--gui-theme=THEME,,":ref:`Selects GUI theme `" - \--help,-h,"Displays a brief help text and exit" - \--joystick=NUM,,"Enables joystick input (default: 0 = first joystick)" - \--language,-q,":ref:`Selects language ` (en, de, fr, it, pt, es, jp, zh, kr, se, gb, hb, ru, cz)" - \--list-audio-devices,,"Lists all available audio devices" - \--list-saves --game=TARGET,,"Displays a list of saved games for the game (TARGET) specified" - \--list-targets,-t,"Displays list of configured targets and exit" - \--list-themes,,"Displays list of all usable GUI themes" - --midi-gain=NUM,,":ref:`Sets the gain for MIDI playback `. 0-1000 (default: 100). Only supported by some MIDI drivers" - \--multi-midi,,":ref:`Enables combination AdLib and native MIDI `" - \--music-driver=MODE,-e,":ref:`Selects preferred music device `" - \--music-volume=NUM,-m,":ref:`Sets the music volume `, 0-255 (default: 192)" - \--native-mt32,,":ref:`True Roland MT-32 (disables GM emulation) `" - \--no-filtering,,"Forces unfiltered graphics mode" - \--no-fullscreen,-F,"Forces windowed mode" - \--opl-driver=DRIVER,,":ref:`Selects AdLib (OPL) emulator `" - \--output-rate=RATE,,"Selects output sample rate in Hz" - \--path=PATH,-p,"Sets path to where the game is installed" - \--platform=STRING,,":ref:`Specifes platform of game `. Allowed values: 2gs, 3do, acorn, amiga, atari, c64, fmtowns, nes, mac, pc pc98, pce, segacd, wii, windows." - \--recursive,,"In combination with \--add or \--detect recurses down all subdirectories" - \--render-mode=MODE,,":ref:`Enables additional render modes `" - \--save-slot=NUM,-x,"Specifies the saved game slot to load (default: autosave)" - \--savepath=PATH,,":ref:`Specifies path to where saved games are stored `" - \--sfx-volume=NUM,-s,":ref:`Sets the sfx volume `, 0-255 (default: 192)" - \--soundfont=FILE,,":ref:`Selects the SoundFont for MIDI playback. `. Only supported by some MIDI drivers." - \--speech-volume=NUM,-r,":ref:`Sets the speech volume `, 0-255 (default: 192)" - \--subtitles,-n,":ref:`Enables subtitles `" - \--talkspeed=NUM,,":ref:`Sets talk speed for games ` (default: 60)" - \--tempo=NUM,,"Sets music tempo (in percent, 50-200) for SCUMM games (default: 100)" - \--themepath=PATH,,":ref:`Specifies path to where GUI themes are stored `" - \--version,-v,"Displays ScummVM version information and exits" + If ``--game=NAME`` is passed, only the game with id NAME is added. See also ``--detect``. Use ``--path=PATH`` before ``-a`` or ``--add`` to specify a directory." + ``--alt-intro``, ,":ref:`Uses alternative intro for CD versions `" + ``--aspect-ratio``,,":ref:`Enables aspect ratio correction `" + ``--auto-detect``,,"Displays a list of games from the current or specified directory and starts the first game. Use ``--path=PATH`` before ``--auto-detect`` to specify a directory." + ``--boot-param=NUM``,``-b``,"Pass number to the boot script (`boot param `_)." + ``--cdrom=DRIVE``,,"Sets the CD drive to play CD audio from. This can be a drive, path, or numeric index (default: 0)" + ``--config=FILE``,``-c``,"Uses alternate configuration file" + ``--copy-protection``,,"Enables copy protection" + ``--debug-channels-only``,,"Shows only the specified debug channels" + ``--debugflags=FLAGS``,,"Enables engine specific debug flags" + ``--debuglevel=NUM``,``-d``,"Sets debug verbosity level" + ``--demo-mode``,,"Starts demo mode of Maniac Mansion or The 7th Guest" + ``--detect``,,"Displays a list of games with their game id from the current or specified directory. This does not add the game to the games list. Use ``--path=PATH`` before ``--detect`` to specify a directory." + ``--dimuse-tempo=NUM``,,"Sets internal Digital iMuse tempo (10 - 100) per second (default: 10)" + ``--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 `" + ``--extrapath=PATH``,,":ref:`Extra path to additional game data `" + ``--filtering``,,":ref:`Forces filtered graphics mode `" + ``--fullscreen``,``-f``,":ref:`Forces full-screen mode `" + ``--game=NAME``,,"In combination with ``--add`` or ``--detect`` only adds or attempts to detect the :ref:`game with id NAME `." + ``--gfx-mode``,``-g``,":ref:`Selects graphics mode `" + ``--gui-theme=THEME``,,":ref:`Selects GUI theme `" + ``--help``,``-h``,"Displays a brief help text and exit" + ``--joystick=NUM``,,"Enables joystick input (default: 0 = first joystick)" + ``--language``,``-q``,":ref:`Selects language ` (en, de, fr, it, pt, es, jp, zh, kr, se, gb, hb, ru, cz)" + ``--list-audio-devices``,,"Lists all available audio devices" + ``--list-saves --game=TARGET``,,"Displays a list of saved games for the game (TARGET) specified" + ``--list-targets``,``-t``,"Displays list of configured targets and exit" + ``--list-themes``,,"Displays list of all usable GUI themes" + ``--midi-gain=NUM``,,":ref:`Sets the gain for MIDI playback `. 0-1000 (default: 100). Only supported by some MIDI drivers" + ``--multi-midi``,,":ref:`Enables combination AdLib and native MIDI `" + ``--music-driver=MODE``,``-e``,":ref:`Selects preferred music device `" + ``--music-volume=NUM``,``-m``,":ref:`Sets the music volume `, 0-255 (default: 192)" + ``--native-mt32``,,":ref:`True Roland MT-32 (disables GM emulation) `" + ``--no-filtering``,,"Forces unfiltered graphics mode" + ``--no-fullscreen``,``-F``,"Forces windowed mode" + ``--opl-driver=DRIVER``,,":ref:`Selects AdLib (OPL) emulator `" + ``--output-rate=RATE``,,"Selects output sample rate in Hz" + ``--path=PATH``,``-p``,"Sets path to where the game is installed" + ``--platform=STRING``,,":ref:`Specifes platform of game `. Allowed values: 2gs, 3do, acorn, amiga, atari, c64, fmtowns, nes, mac, pc pc98, pce, segacd, wii, windows." + ``--recursive``,,"In combination with ``--add or ``--detect`` recurses down all subdirectories" + ``--render-mode=MODE``,,":ref:`Enables additional render modes `" + ``--save-slot=NUM``,``-x``,"Specifies the saved game slot to load (default: autosave)" + ``--savepath=PATH``,,":ref:`Specifies path to where saved games are stored `" + ``--sfx-volume=NUM``,``-s``,":ref:`Sets the sfx volume `, 0-255 (default: 192)" + ``--soundfont=FILE``,,":ref:`Selects the SoundFont for MIDI playback. `. Only supported by some MIDI drivers." + ``--speech-volume=NUM``,``-r``,":ref:`Sets the speech volume `, 0-255 (default: 192)" + ``--subtitles``,``-n``,":ref:`Enables subtitles `" + ``--talkspeed=NUM``,,":ref:`Sets talk speed for games ` (default: 60)" + ``--tempo=NUM``,,"Sets music tempo (in percent, 50-200) for SCUMM games (default: 100)" + ``--themepath=PATH``,,":ref:`Specifies path to where GUI themes are stored `" + ``--version``,``-v``,"Displays ScummVM version information and exits" diff --git a/doc/docportal/advanced_topics/configuration_file.rst b/doc/docportal/advanced_topics/configuration_file.rst index b443607efd2..052b9db50de 100755 --- a/doc/docportal/advanced_topics/configuration_file.rst +++ b/doc/docportal/advanced_topics/configuration_file.rst @@ -5,7 +5,7 @@ Configuration file The configuration file provides a way to edit both global and game-specific settings. It is a text file containing configuration keywords and parameters. -Settings are also accessible directly from :doc:`the Launcher <../using_scummvm/the_launcher>`. See :doc:`../using_scummvm/how_to_settings`. +Settings are also accessible directly from the Launcher. See :doc:`../use_scummvm/how_to_settings`. Location ========== @@ -77,13 +77,13 @@ The configuration file saves to different default locations, depending on the pl .. panels:: :column: col-lg-12 mb-2 - We follow the XDG Base Directory Specification, so by default the configuration file can be found at ``/~.config/scummvm/scummvm.ini``, but its location may vary depending on the value of the ``XDG_CONFIG_HOME`` environment variable. + We follow the XDG Base Directory Specification, so by default the configuration file is found at ``/~.config/scummvm/scummvm.ini``, but its location may vary depending on the value of the ``XDG_CONFIG_HOME`` environment variable. If ScummVM was installed using Snap, the configuration file can be found at ``~/snap/scummvm/current/.config/scummvm/scummvm.ini`` .. note:: - ``.config`` is a hidden directory. To view it use ``ls -a`` on the command line. Ff you are using a GUI file manager, use the keyboard shortcut :kbd:`Ctrl + H`. + ``.config`` is a hidden directory. To view it use ``ls -a`` on the command line, or, if you are using a GUI file manager, press :kbd:`Ctrl + H`. @@ -151,7 +151,7 @@ There are many recognized configuration keywords. In the table below, each keywo :widths: 35 15 25 25 :header-rows: 1 - Keyword,Type,Default,Description or Available options + Keyword,Type,Default,Description/Options alsa_port,number,, ":ref:`alt_intro `",boolean,false, ":ref:`altamigapalette `",boolean,false, @@ -169,7 +169,7 @@ There are many recognized configuration keywords. In the table below, each keywo ":ref:`autosave_period `", integer, 300s auto_savenames,boolean,false ":ref:`bilinear_filtering `",boolean,false, - boot_param,number,none, + `boot_param `_,number,none, ":ref:`bright_palette `",boolean,true, cdrom,number,, ":ref:`color `",boolean,, @@ -192,8 +192,8 @@ There are many recognized configuration keywords. In the table below, each keywo ":ref:`enable_high_resolution_graphics `",boolean,true, ":ref:`enable_hq_video `",boolean,true, ":ref:`enable_larryscale `",boolean,true, - ":ref:`enable_video_upscale `",boolean,true, ":ref:`enable_reporter `",boolean,false,RISC OS only. + ":ref:`enable_video_upscale `",boolean,true, ":ref:`enable_tts `",boolean,false, ":ref:`extrapath `",string,None," path" ":ref:`fade_style `",boolean,true, @@ -368,7 +368,7 @@ There are many recognized configuration keywords. In the table below, each keywo - 22050 - 44100" ":ref:`platform `",string,, - ":ref:`portaits_on, `",boolean,true, + ":ref:`portaits_on `",boolean,true, ":ref:`prefer_digitalsfx `",boolean,true, ":ref:`render_mode `",string,," - hercGreen @@ -394,7 +394,7 @@ There are many recognized configuration keywords. In the table below, each keywo ":ref:`ShowItemCosts `",boolean,false, ":ref:`silver_cursors `",boolean,false, ":ref:`sitcom `",boolean,false, - ":ref:`skip_support `",boolean,true, + ":ref:`skip_support `",boolean,true, ":ref:`skiphallofrecordsscenes `",boolean,false, ":ref:`smooth_scrolling `",boolean,true, ":ref:`speech_mute `",boolean,false, @@ -414,7 +414,7 @@ There are many recognized configuration keywords. In the table below, each keywo ":ref:`transparentdialogboxes `",boolean,false, ":ref:`tts_enabled `",boolean,false, ":ref:`tts_narrator `",boolean,false, - ":ref:`use_cdaudio `",boolean,true, + use_cdaudio,boolean,true, versioninfo,string,, ":ref:`window_style