summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorGravatarGravatar Firehawke <34792592+Firehawke@users.noreply.github.com>2019-01-02 10:05:21 -0700
committerGravatarGravatar Vas Crabb <cuavas@users.noreply.github.com>2019-01-03 04:05:21 +1100
commit6432d6603779cbb8bf5974eca36b88009d7cc429 (patch) (github)
tree8b83ab71cec65f4c00d228f670b85b4c631603d2 /docs
parent3d29b8927d5ad4140c69d00713f1e901bae6af97 (diff)
downloadmame-6432d6603779cbb8bf5974eca36b88009d7cc429.tar.bz2
mame-6432d6603779cbb8bf5974eca36b88009d7cc429.zip
Case sensitivity training for INI (nw) (#4455)
* Case sensitivity training for INI (nw) The world is not 100% Windows, so case sensitvity is needed. * Further standardization of the formatting (nw) More to go... * Pass 2 of new formatting wave (nw) More to go, though. * wave 3 of formatting cleanup (nw) Further adjustments and cleanups, including unwanted tabs. * Correct filtering instructions (nw)
Diffstat (limited to 'docs')
-rw-r--r--docs/source/advanced/bgfx.rst42
-rw-r--r--docs/source/advanced/devicemap.rst6
-rw-r--r--docs/source/advanced/glsl.rst11
-rw-r--r--docs/source/advanced/hlsl.rst6
-rw-r--r--docs/source/advanced/multiconfig.rst38
-rw-r--r--docs/source/advanced/paths.rst22
-rw-r--r--docs/source/advanced/shiftertoggle.rst6
-rw-r--r--docs/source/commandline/commandline-all.rst409
-rw-r--r--docs/source/commandline/sdlconfig.rst15
-rw-r--r--docs/source/commandline/windowsconfig.rst10
-rw-r--r--docs/source/initialsetup/installingmame.rst4
11 files changed, 284 insertions, 285 deletions
diff --git a/docs/source/advanced/bgfx.rst b/docs/source/advanced/bgfx.rst
index 5508ee01d53..72a61f6a546 100644
--- a/docs/source/advanced/bgfx.rst
+++ b/docs/source/advanced/bgfx.rst
@@ -23,17 +23,17 @@ Some older LCD displays used a native resolution of 1280x1024 and were a 5:4 asp
Getting Started with BGFX
-------------------------
-You will need to have followed the initial MAME setup instructions elsewhere in this manual before beginning. Official MAME distributions include BGFX as of 172, so you don't need to download any additional files.
+You will need to have followed the initial MAME setup instructions elsewhere in this manual before beginning. Official MAME distributions include BGFX as of MAME 0.172, so you don't need to download any additional files.
-Open your MAME.INI in your text editor of choice (e.g. Notepad), and make sure the following options are set correctly:
+Open your ``mame.ini`` in your text editor of choice (e.g. Notepad), and make sure the following options are set correctly:
-* **video bgfx**
+* ``video bgfx``
Now, you may want to take a moment to look below at the Configuration Settings section to see how to set up these next options.
-As referenced in :ref:`advanced-multi-CFG`, MAME has a order in which it processes INI files. The BGFX settings can be edited in MAME.INI, but to take full advantage of the power of MAME's config files, you'll want to copy the BGFX settings from MAME.INI to one of the other config files and make changes there.)
+As referenced in :ref:`advanced-multi-CFG`, MAME has a order in which it processes INI files. The BGFX settings can be edited in ``mame.ini``, but to take full advantage of the power of MAME's config files, you'll want to copy the BGFX settings from ``mame.ini`` to one of the other config files and make changes there.)
-In particular, you will want the **bgfx_screen_chains** to be specific to each game.
+In particular, you will want the ``bgfx_screen_chains`` to be specific to each game.
Save your .INI file(s) and you're ready to begin.
@@ -46,12 +46,12 @@ Configuration Settings
|
| **bgfx_backend**
|
-| Selects a rendering backend for BGFX to use. Possible choices include **d3d9**, **d3d11**, **opengl**, and **metal**. The default is **auto**, which will let MAME choose the best selection for you.
+| Selects a rendering backend for BGFX to use. Possible choices include ``d3d9``, ``d3d11``, ``opengl``, and ``metal``. The default is ``**auto**``, which will let MAME choose the best selection for you.
|
-| **d3d9** -- Direct3D 9.0 Renderer (Requires Windows XP or higher)
-| **d3d11** -- Direct3D 11.0 Renderer (Requires Windows Vista with D3D11 update or Windows 7 or higher)
-| **opengl** -- OpenGL Renderer (Requires OpenGL drivers, may work better on some poorly designed video cards, supported on Linux/Mac OS X)
-| **metal** -- Metal Apple Graphics API (Requires OS X 10.11 El Capitan or newer)
+| ``d3d9`` -- Direct3D 9.0 Renderer (Requires Windows XP or higher)
+| ``d3d11`` -- Direct3D 11.0 Renderer (Requires Windows Vista with D3D11 update or Windows 7 or higher)
+| ``opengl`` -- OpenGL Renderer (Requires OpenGL drivers, may work better on some poorly designed video cards, supported on Linux/Mac OS X)
+| ``metal`` -- Metal Apple Graphics API (Requires OS X 10.11 El Capitan or newer)
|
| **bgfx_debug**
|
@@ -59,13 +59,13 @@ Configuration Settings
|
| **bgfx_screen_chains**
|
-| This dictates how to handle BGFX rendering on a per-display basis. Possible choices include **hlsl**, **unfiltered**, and **default**.
+| This dictates how to handle BGFX rendering on a per-display basis. Possible choices include ``hlsl``, ``unfiltered``, and ``default``.
|
-| **default** -- default bilinear filterered output
-| **unfiltered** -- nearest neighbor unfiltered output
-| **hlsl** -- HLSL display simulation through shaders
+| ``default`` -- **default** bilinear filterered output
+| ``unfiltered`` -- nearest neighbor unfiltered output
+| ``hlsl`` -- HLSL display simulation through shaders
|
-| We make a distinction between emulated device screens (which we'll call a **screen**) and physical displays (which we'll call a **window**, set by **-numscreens**) here. We use colons (:) to seperate windows, and commas (,) to seperate screens. Commas always go on the outside of the chain (see House Mannequin example)
+| We make a distinction between emulated device screens (which we'll call a **screen**) and physical displays (which we'll call a **window**, set by ``-numscreens``) here. We use colons (:) to seperate windows, and commas (,) to seperate screens. Commas always go on the outside of the chain (see House Mannequin example)
|
| On a combination of a single window, single screen case, such as Pac-Man on one physical PC monitor, you can specify one entry like:
|
@@ -75,17 +75,17 @@ Configuration Settings
|
| On a single window, multiple screen game, such as Darius on one physical PC monitor, specify multiple entries (one per window) like:
|
-| **bgfx_screen_chains hlsl,hlsl,hlsl**
+| bgfx_screen_chains hlsl,hlsl,hlsl
|
| This also works with single screen games where you are mirroring the output to more than one physical display. For instance, you could set up Pac-Man to have one unfiltered output for use with video broadcasting while a second display is set up HLSL for playing on.
|
| On a mulitple window, multiple screen game, such as Darius on three physical PC monitors, specify multiple entries (one per window) like:
|
-| **bgfx_screen_chains hlsl:hlsl:hlsl**
+| ``bgfx_screen_chains hlsl:hlsl:hlsl``
|
| Another example game would be Taisen Hot Gimmick, which used two CRTs to show individual player hands to just that player. If using two windows (two physical displays):
|
-| **bgfx_screen_chains hlsl:hlsl**
+| ``bgfx_screen_chains hlsl:hlsl``
|
| One more special case is that Nichibutsu had a special cocktail mahjongg cabinet that used a CRT in the middle along with two LCD displays to show each player their hand. We would want the LCDs to be unfiltered and untouched as they were, while the CRT would be improved through HLSL. Since we want to give each player their own full screen display (two physical monitors) along with the LCD, we'll go with:
|
@@ -95,14 +95,14 @@ Configuration Settings
|
| If using only one window (one display), keep in mind the game still has three screens, so we would use:
|
-| **bgfx_screen_chains hlsl,unfiltered,unfiltered**
+| ``bgfx_screen_chains hlsl,unfiltered,unfiltered``
|
|
| Note that the commas are on the outside edges, and any colons are in the middle.
|
-| **bgfx_shadow_mask**
+| ``bgfx_shadow_mask``
|
-| This specifies the shadow mask effect PNG file. By default this is **slot-mask.png**.
+| This specifies the shadow mask effect PNG file. By default this is ``**slot-mask.png**``.
|
|
diff --git a/docs/source/advanced/devicemap.rst b/docs/source/advanced/devicemap.rst
index d1888090a93..38dcc3a2641 100644
--- a/docs/source/advanced/devicemap.rst
+++ b/docs/source/advanced/devicemap.rst
@@ -16,7 +16,7 @@ NOTE: This setting only take effect when added to the **ctrlr** config file.
The "device" attribute specifies the id of the device to match. It may also be a substring of the id. To see the list of available devices, enable verbose output and available devices will then be listed to the console at startup (more on this below).
-The "controller" attribute specifies the MAME controller ID. It is made up of a controller class (i.e. "JOYCODE", "GUNCODE", "MOUSECODE") and controller index. For example: "JOYCODE_1".
+The "controller" attribute specifies the MAME controller ID. It is made up of a controller class (i.e. ``JOYCODE``, ``GUNCODE``, ``MOUSECODE``) and controller index. For example: ``JOYCODE_1``.
Example
-------
@@ -36,11 +36,11 @@ Here's an example:
| </newseq>
| </port>
| ...
-|
+
In the above example, we have four device mappings specified:
-The first two mapdevice entries map player 1 and 2 lightguns to Gun 1 and Gun 2, respectively. We use a substring of the full raw device names to match each devices. Note that, since this is XML, we needed to escape the '&' using '&amp;'.
+The first two mapdevice entries map player 1 and 2 lightguns to Gun 1 and Gun 2, respectively. We use a substring of the full raw device names to match each devices. Note that, since this is XML, we needed to escape the ``&`` using ``&amp;``.
The last two mapdevices entries map player 1 and player 2 gamepad controllers to Joy 1 and Joy 2, respectively. In this case, these are XInput devices.
diff --git a/docs/source/advanced/glsl.rst b/docs/source/advanced/glsl.rst
index 033403cb150..d2cec7052c7 100644
--- a/docs/source/advanced/glsl.rst
+++ b/docs/source/advanced/glsl.rst
@@ -25,16 +25,16 @@ Getting Started with GLSL
You will need to have followed the initial MAME setup instructions elsewhere in this manual before beginning. Official MAME distributions include GLSL support by default, but do NOT include the GLSL shader files. You will need to obtain the shader files from third party online sources.
-Open your MAME.INI in your text editor of choice (e.g. Notepad), and make sure the following options are set correctly:
+Open your ``mame.ini`` in your text editor of choice (e.g. Notepad), and make sure the following options are set correctly:
-* **video opengl**
-* **filter 0**
+* ``video opengl``
+* ``filter 0``
The former is required because GLSL requires OpenGL support. The latter turns off extra filtering that interferes with GLSL output.
Lastly, one more edit will turn GLSL on:
-* **gl_glsl 1**
+* ``gl_glsl 1``
Save the .INI file and you're ready to begin.
@@ -54,7 +54,7 @@ Once you've found settings you like, write the numbers down on a notepad and exi
Configuration Editing
---------------------
-As referenced in :ref:`advanced-multi-CFG`, MAME has a order in which it processes INI files. The GLSL settings can be edited in MAME.INI, but to take full advantage of the power of MAME's config files, you'll want to copy the GLSL settings from MAME.INI to one of the other config files and make changes there.
+As referenced in :ref:`advanced-multi-CFG`, MAME has a order in which it processes INI files. The GLSL settings can be edited in ``mame.ini``, but to take full advantage of the power of MAME's config files, you'll want to copy the GLSL settings from mame.ini to one of the other config files and make changes there.
For instance, once you've found GLSL settings you think are appropriate for Neo Geo games, you can put those settings into neogeo.ini so that all Neo-Geo games will be able to take advantage of those settings without needing to add it to every game INI manually.
@@ -82,4 +82,3 @@ Configuration Settings
|
| Specifies screen to apply the shaders on.
|
-
diff --git a/docs/source/advanced/hlsl.rst b/docs/source/advanced/hlsl.rst
index 3fb25578e2e..3e22203df78 100644
--- a/docs/source/advanced/hlsl.rst
+++ b/docs/source/advanced/hlsl.rst
@@ -25,7 +25,7 @@ Getting Started with HLSL
You will need to have followed the initial MAME setup instructions elsewhere in this manual before beginning. Official MAME distributions include HLSL by default, so you don't need to download any additional files.
-Open your MAME.INI in your text editor of choice (e.g. Notepad), and make sure the following options are set correctly:
+Open your ``mame.ini`` in your text editor of choice (e.g. Notepad), and make sure the following options are set correctly:
* **video d3d**
* **filter 0**
@@ -56,9 +56,9 @@ Once you've found settings you like, write the numbers down on a notepad and exi
Configuration Editing
---------------------
-As referenced in :ref:`advanced-multi-CFG`, MAME has a order in which it processes INI files. The HLSL settings can be edited in MAME.INI, but to take full advantage of the power of MAME's config files, you'll want to copy the HLSL settings from MAME.INI to one of the other config files and make changes there.
+As referenced in :ref:`advanced-multi-CFG`, MAME has a order in which it processes INI files. The HLSL settings can be edited in ``mame.ini``, but to take full advantage of the power of MAME's config files, you'll want to copy the HLSL settings from mame.ini to one of the other config files and make changes there.
-For instance, once you've found HLSL settings you think are appropriate for Neo Geo games, you can put those settings into neogeo.ini so that all Neo-Geo games will be able to take advantage of those settings without needing to add it to every game INI manually.
+For instance, once you've found HLSL settings you think are appropriate for Neo Geo games, you can put those settings into ``neogeo.ini`` so that all Neo-Geo games will be able to take advantage of those settings without needing to add it to every game INI manually.
Configuration Settings
diff --git a/docs/source/advanced/multiconfig.rst b/docs/source/advanced/multiconfig.rst
index 3424f1fb4ee..48385781392 100644
--- a/docs/source/advanced/multiconfig.rst
+++ b/docs/source/advanced/multiconfig.rst
@@ -9,43 +9,43 @@ Order of Config Loading
-----------------------
1. The command line is parsed first, and any settings passed that way *will take priority over anything in an INI file*.
-2. **MAME.INI** (or other platform INI; e.g. **MESS.INI**) is parsed twice.
+2. ``mame.ini`` (or other platform INI; e.g. ``mess.ini``) is parsed twice.
The first pass may change various path settings, so the second pass is done to see if there is a valid config file at that new location (and if so, change settings using that file)
-3. **DEBUG.INI** if in debug mode.
+3. ``debug.ini`` if in debug mode.
This is an advanced config file, most people won't need to use it or be concerned by it.
-4. System-specific INI files where appropriate (e.g. **NEOGEO_NOSLOT.INI** or **CPS2.INI**)
- As an example, Street Fighter Alpha is a CPS2 game, and so **CPS2.INI** would be loaded here.
-5. Monitor orientation INI file (either **HORIZONT.INI** or **VERTICAL.INI**)
- Pac-Man, for one example, is a vertical monitor setup, so it would load **VERTICAL.INI**. Street Fighter Alpha is a horizontal game, so it loads **HORIZONT.INI**.
-6. System-type INI files (**ARCADE.INI**, **CONSOLE.INI**, **COMPUTER.INI**, or **OTHERSYS.INI**)
- Both Pac-Man and Street Fighter Alpha are arcade games, so **ARCADE.INI** would be loaded here. Atari 2600 would load **CONSOLE.INI**.
-7. Screen-type INI file (**VECTOR.INI** for vector games, **RASTER.INI** for raster games, **LCD.INI** for LCD games)
- Pac-Man and Street Fighter Alpha are raster, so **RASTER.INI** gets loaded here. Tempest is a vector monitor game, and **VECTOR.INI** would be loaded here.
+4. System-specific INI files where appropriate (e.g. ``neogeo_noslot.ini`` or ``cps2.ini``)
+ As an example, Street Fighter Alpha is a CPS2 game, and so ``cps2.ini`` would be loaded here.
+5. Monitor orientation INI file (either ``horizont.ini`` or ``vertical.ini``)
+ Pac-Man, for one example, is a vertical monitor setup, so it would load ``vertical.ini``. Street Fighter Alpha is a horizontal game, so it loads ``horizont.ini``.
+6. System-type INI files (``arcade.ini``, ``console.ini``, ``computer.ini``, or ``othersys.ini``)
+ Both Pac-Man and Street Fighter Alpha are arcade games, so ``arcade.ini`` would be loaded here. Atari 2600 would load ``console.ini``.
+7. Screen-type INI file (``vector.ini`` for vector games, ``raster.ini`` for raster games, ``lcd.ini`` for LCD games)
+ Pac-Man and Street Fighter Alpha are raster, so ``raster.ini`` gets loaded here. Tempest is a vector monitor game, and ``vector.ini`` would be loaded here.
8. Source INI files.
This is an advanced config file, most people won't need to use it and it can be safely ignored.
- MAME will attempt to load **SOURCE/SOURCEFILE.INI** and **SOURCEFILE.INI**, where sourcefile is the actual filename of the source code file.
+ MAME will attempt to load ``source/sourcefile.ini`` and ``sourcefile.ini``, where sourcefile is the actual filename of the source code file.
*mame -listsource <game>* will show the source file for a given game.
- For instance, Banpresto's Sailor Moon, Atlus's Dodonpachi, and Nihon System's Dangun Feveron all share a large amount of hardware and are grouped into the CAVE.C file, meaning they all parse **source/cave.ini**
+ For instance, Banpresto's Sailor Moon, Atlus's Dodonpachi, and Nihon System's Dangun Feveron all share a large amount of hardware and are grouped into the ``cave.c`` file, meaning they all parse ``source/cave.ini``
9. Parent INI file.
- For example, if running Pac-Man, which is a clone of Puck-Man, it'd be **PUCKMAN.INI**
+ For example, if running Pac-Man, which is a clone of Puck-Man, it'd be ``puckman.ini``
10. Driver INI file.
- Using our previous example of Pac-Man, this would be **PACMAN.INI**.
+ Using our previous example of Pac-Man, this would be ``pacman.ini``.
Examples of Config Loading Order
--------------------------------
-1. Alcon, which is the US clone of Slap Fight. (*mame alcon*)
- Command line, MAME.INI, VERTICAL.INI, ARCADE.INI, RASTER.INI, SLAPFGHT.INI, and lastly ALCON.INI (*remember command line parameters take precedence over all else!*)
+1. Alcon, which is the US clone of Slap Fight. (**mame alcon**)
+ Command line, mame.ini, vertical.ini, arcade.ini, raster.ini, slapfght.ini, and lastly alcon.ini (*remember command line parameters take precedence over all else!*)
-2. Super Street Fighter 2 Turbo (*mame ssf2t*)
- Command line, MAME.INI, HORIZONT.INI, ARCADE.INI, RASTER.INI, CPS2.INI, and lastly SSF2T.INI (*remember command line parameters take precedence over all else!*)
+2. Super Street Fighter 2 Turbo (**mame ssf2t**)
+ Command line, mame.ini, horizont.ini, arcade.ini, raster.ini, cps2.ini, and lastly ssf2t.ini (*remember command line parameters take precedence over all else!*)
Tricks to Make Life Easier
--------------------------
-Some users may have a wall-mounted or otherwise rotatable monitor, and may wish to actually play vertical games with the rotated display. The easiest way to accomplish this is to put your rotation modifiers into **VERTICAL.INI**, where they will only affect vertical games.
+Some users may have a wall-mounted or otherwise rotatable monitor, and may wish to actually play vertical games with the rotated display. The easiest way to accomplish this is to put your rotation modifiers into ``vertical.ini``, where they will only affect vertical games.
[todo: more practical examples]
diff --git a/docs/source/advanced/paths.rst b/docs/source/advanced/paths.rst
index da92e1bbbe9..d16247a42cb 100644
--- a/docs/source/advanced/paths.rst
+++ b/docs/source/advanced/paths.rst
@@ -9,20 +9,20 @@ Order of Path Loading
Let's use an example of the cheat file for AfterBurner 2 for Sega Genesis/MegaDrive (aburner2 in the megadrive softlist), and your cheatpath is set to "cheat" (as per the default) -- this is how MAME will search for that cheat file:
-1. cheat/megadriv/aburner2.xml
-2. cheat/megadriv.zip -> aburner2.xml
+1. ``cheat/megadriv/aburner2.xml``
+2. ``cheat/megadriv.zip`` -> ``aburner2.xml``
Notice that it checks for a .ZIP file first before a .7Z file.
-3. cheat/megadriv.zip -> <arbitrary path>/aburner2.xml
- It will look for the first (if any) aburner2.xml file it can find inside that zip, no matter what the path is.
-4. cheat.zip -> megadriv/aburner2.xml
+3. ``cheat/megadriv.zip`` -> ``<arbitrary path>/aburner2.xml``
+ It will look for the first (if any) ``aburner2.xml`` file it can find inside that zip, no matter what the path is.
+4. ``cheat.zip`` -> ``megadriv/aburner2.xml``
Now it is specifically looking for the file and folder combination, but inside the cheat.zip file.
-5. cheat.zip -> <arbitrary path>/megadriv/aburner2.xml
- Like before, except looking for the first (if any) aburner2.xml inside a megadriv folder inside the zip.
-6. cheat/megadriv.7z -> aburner2.xml
+5. ``cheat.zip`` -> ``<arbitrary path>/megadriv/aburner2.xml``
+ Like before, except looking for the first (if any) ``aburner2.xml`` inside a ``megadriv`` folder inside the zip.
+6. ``cheat/megadriv.7z`` -> ``aburner2.xml``
Now we start checking 7ZIP files.
-7. cheat/megadriv.7z -> <arbitrary path>/aburner2.xml
-8. cheat.7z -> megadriv/aburner2.xml
-9. cheat.7z -> <arbitrary path>/megadriv/aburner2.xml
+7. ``cheat/megadriv.7z`` -> ``<arbitrary path>/aburner2.xml``
+8. ``cheat.7z`` -> ``megadriv/aburner2.xml``
+9. ``cheat.7z`` -> ``<arbitrary path>/megadriv/aburner2.xml``
Similar to zip, except now 7ZIP files.
diff --git a/docs/source/advanced/shiftertoggle.rst b/docs/source/advanced/shiftertoggle.rst
index 9ea5214b980..1fbc96ba7b5 100644
--- a/docs/source/advanced/shiftertoggle.rst
+++ b/docs/source/advanced/shiftertoggle.rst
@@ -14,13 +14,13 @@ Disabling and Enabling Shifter Toggle
This example will use the game Spy Hunter (set *spyhunt*) to demonstrate the exact change needed:
-You will need to manually edit the game .CFG file in the CFG folder (e.g. *spyhunt.cfg*)
+You will need to manually edit the game .CFG file in the CFG folder (e.g. ``spyhunt.cfg``)
-Start by loading MAME with the game in question. In our case, that will be **mame64 spyhunt**.
+Start by loading MAME with the game in question. In our case, that will be **mame spyhunt**.
Set up the controls as you would please, including mapping the shifter. Exit MAME, open the .cfg file in your text editor of choice.
-Inside the *spyhunt.cfg* file, you will find the following for the input. The actual input code in the middle can and will vary depending on the controller number and what input you have mapped.
+Inside the ``spyhunt.cfg`` file, you will find the following for the input. The actual input code in the middle can and will vary depending on the controller number and what input you have mapped.
| **<port tag=":ssio:IP0" type="P1_BUTTON2" mask="16" defvalue="16">**
| <newseq type="standard">
diff --git a/docs/source/commandline/commandline-all.rst b/docs/source/commandline/commandline-all.rst
index b0eadb4903b..ef7fb663a33 100644
--- a/docs/source/commandline/commandline-all.rst
+++ b/docs/source/commandline/commandline-all.rst
@@ -54,7 +54,7 @@ Configuration Verbs
**-createconfig** / **-cc**
- Creates the default mame.ini file. All the configuration options
+ Creates the default ``mame.ini`` file. All the configuration options
(not verbs) described below can be permanently changed by editing
this configuration file.
@@ -92,7 +92,7 @@ Example:
| **mame -listcrc puckman > list.txt**
|
-| This creates (or overwrites if it's already there) list.txt and fills the file with the results of **-listcrc puckman**. In other words, the list of each ROM used in Puckman and the CRC for that ROM are written into that file.
+| This creates (or overwrites if it's already there) ``list.txt`` and fills the file with the results of **-listcrc puckman**. In other words, the list of each ROM used in Puckman and the CRC for that ROM are written into that file.
|
.. _mame-commandline-listxml:
@@ -177,9 +177,9 @@ Example:
**-listslots** / **-lslot** [<*pattern*>]
Show available slots and options for each slot (if available). Primarily used for MAME to allow control over internal plug-in cards, much like PCs needing video, sound and other expansion cards.
-
+
If slots are populated with devices, any additional slots those devices provide will be visible with **-listslots** as well. For instance, installing a floppy controller into a PC will expose the disk drive slots.
-
+
The slot name (e.g. **ctrl1**) can be used from the command line (**-ctrl1** in this case)
.. _mame-commandline-listmedia:
@@ -222,7 +222,7 @@ OSD-related Options
**-uimodekey** [*keystring*]
- Key used to toggle emulated keyboard on and off. Default setting is *SCRLOCK* on Windows, *Forward Delete* on Mac (use *FN-Delete* on laptop/compact keyboards).
+ Key used to toggle emulated keyboard on and off. Default setting is **SCRLOCK** on Windows, **Forward Delete** on Mac (use **FN-Delete** on laptop/compact keyboards).
.. _mame-commandline-uifontprovider:
@@ -230,32 +230,32 @@ OSD-related Options
Chooses provider for UI font.
- On Windows, you can choose from: **win**, **dwrite**, **none** or **auto**.
- On Mac, you can choose from: **osx** or **auto**.
- On other platforms, you can choose from: **sdl** or **auto**.
+ On Windows, you can choose from: ``win``, ``dwrite``, ``none`` or ``auto``.
+ On Mac, you can choose from: ``osx`` or ``auto``.
+ On other platforms, you can choose from: ``sdl`` or ``auto``.
- Default setting is *AUTO*.
+ Default setting is *auto*.
.. _mame-commandline-keyboardprovider:
**\-keyboardprovider**
Chooses how MAME will get keyboard input.
-
- On Windows, you can choose from: auto, rawinput, dinput, win32, or none
- On SDL, you can choose from: auto, sdl, none
-
+
+ On Windows, you can choose from: ``auto``, ``rawinput``, ``dinput``, ``win32``, or ``none``
+ On SDL, you can choose from: ``auto``, ``sdl``, ``none``
+
The default is *auto*. On Windows, auto will try rawinput with fallback to dinput. On SDL, auto will default to sdl.
-
+
.. _mame-commandline-mouseprovider:
**\-mouseprovider**
Chooses how MAME will get mouse input.
- On Windows, you can choose from: auto, rawinput, dinput, win32, or none
- On SDL, you can choose from: auto, sdl, none
-
+ On Windows, you can choose from: ``auto``, ``rawinput``, ``dinput``, ``win32``, or ``none``
+ On SDL, you can choose from: ``auto``, ``sdl``, ``none``
+
The default is *auto*. On Windows, auto will try rawinput with fallback to dinput. On SDL, auto will default to sdl.
.. _mame-commandline-lightgunprovider:
@@ -264,8 +264,8 @@ OSD-related Options
Chooses how MAME will get light gun input.
- On Windows, you can choose from: auto, rawinput, win32, or none
- On SDL, you can choose from: auto, x11 or none
+ On Windows, you can choose from: ``auto``, ``rawinput``, ``win32``, or ``none``
+ On SDL, you can choose from: ``auto``, ``x11`` or ``none``
The default is *auto*. On Windows, auto will try rawinput with fallback to win32, or none if it doesn't find any. On SDL/Linux, auto will default to x11, or none if it doesn't find any. On other SDL, auto will default to none.
@@ -275,12 +275,12 @@ OSD-related Options
Chooses how MAME will get joystick input.
- On Windows, you can choose from: auto, winhybrid, dinput, xinput, or none
- On SDL, you can choose from: auto, sdl, none
-
+ On Windows, you can choose from: ``auto, ``winhybrid``, ``dinput``, ``xinput``, or ``none``
+ On SDL, you can choose from: ``auto``, ``sdl``, ``none``
+
The default is *auto*. On Windows, auto will default to dinput.
-
- Note that Microsoft X-Box 360 and X-Box One controllers will be happiest with *winhybrid* or *xinput*. The *winhybrid* option supports a mix of DirectInput and XInput controllers at the same time. On SDL, auto will default to sdl.
+
+ Note that Microsoft XBox 360 and XBox One controllers will be happiest with ``winhybrid`` or ``xinput``. The ``winhybrid`` option supports a mix of DirectInput and XInput controllers at the same time. On SDL, auto will default to sdl.
@@ -309,9 +309,9 @@ OSD Output Options
**\-output**
Chooses how MAME will handle processing of output notifiers.
-
- you can choose from: auto, none, console or network
-
+
+ you can choose from: ``auto``, ``none``, ``console`` or ``network``
+
Note that network port is fixed at 8000.
@@ -326,7 +326,6 @@ Configuration Options
Enables or disables the reading of the config files. When enabled (which is the default), MAME reads the following config files in order:
- mame.ini
- - <mymame>.ini (i.e. if MAME was renamed mame060.exe, MAME parses mame060.ini here)
- debug.ini (if the debugger is enabled)
- <driver>.ini (based on the source filename of the driver)
- vertical.ini (for systems with vertical monitor orientation)
@@ -342,7 +341,7 @@ Configuration Options
(See :ref:`advanced-multi-CFG` for further details)
The settings in the later INIs override those in the earlier INIs.
- So, for example, if you wanted to disable overlay effects in the vector systems, you can create a vector.ini with the "effect none" line in it, and it will override whatever effect value you have in your mame.ini. The default is ON (*-readconfig*).
+ So, for example, if you wanted to disable overlay effects in the vector systems, you can create a ``vector.ini`` with the "effect none" line in it, and it will override whatever effect value you have in your ``mame.ini``. The default is ON (**-readconfig**).
@@ -359,55 +358,55 @@ Core Search Path Options
**-rompath** / **-rp** *<path>*
- Specifies a list of paths within which to find ROM or hard disk images. Multiple paths can be specified by separating them with semicolons. The default is 'roms' (that is, a directory "roms" in the same directory as the MAME executable).
+ Specifies a list of paths within which to find ROM or hard disk images. Multiple paths can be specified by separating them with semicolons. The default is ``roms`` (that is, a directory "roms" in the same directory as the MAME executable).
.. _mame-commandline-hashpath:
**-hashpath** *<path>*
- Specifies a list of paths within which to find Software List HASH files. Multiple paths can be specified by separating them with semicolons. The default is 'hash' (that is, a directory "roms" in the same directory as the MAME executable).
+ Specifies a list of paths within which to find Software List HASH files. Multiple paths can be specified by separating them with semicolons. The default is ``hash`` (that is, a directory "roms" in the same directory as the MAME executable).
.. _mame-commandline-samplepath:
**-samplepath** / **-sp** *<path>*
- Specifies a list of paths within which to find sample files. Multiple paths can be specified by separating them with semicolons. The default is 'samples' (that is, a directory "samples" in the same directory as the MAME executable).
+ Specifies a list of paths within which to find sample files. Multiple paths can be specified by separating them with semicolons. The default is ``samples`` (that is, a directory "samples" in the same directory as the MAME executable).
.. _mame-commandline-artpath:
**-artpath** *<path>* / **-artwork_directory** *<path>*
- Specifies a list of paths within which to find artwork files. Multiple paths can be specified by separating them with semicolons. The default is 'artwork' (that is, a directory "artwork" in the same directory as the MAME executable).
+ Specifies a list of paths within which to find artwork files. Multiple paths can be specified by separating them with semicolons. The default is ``artwork`` (that is, a directory "artwork" in the same directory as the MAME executable).
.. _mame-commandline-ctrlrpath:
**-ctrlrpath** / **-ctrlr_directory** *<path>*
- Specifies a list of paths within which to find controller-specific configuration files. Multiple paths can be specified by separating them with semicolons. The default is 'ctrlr' (that is, a directory "ctrlr" in the same directory as the MAME executable).
+ Specifies a list of paths within which to find controller-specific configuration files. Multiple paths can be specified by separating them with semicolons. The default is ``ctrlr`` (that is, a directory "ctrlr" in the same directory as the MAME executable).
.. _mame-commandline-inipath:
**-inipath** *<path>*
- Specifies a list of paths within which to find .INI files. Multiple paths can be specified by separating them with semicolons. The default is '.;ini' (that is, search in the current directory first, and then in the directory "ini" in the same directory as the MAME executable).
+ Specifies a list of paths within which to find .INI files. Multiple paths can be specified by separating them with semicolons. The default is ``.;ini`` (that is, search in the current directory first, and then in the directory "ini" in the same directory as the MAME executable).
.. _mame-commandline-fontpath:
**-fontpath** *<path>*
- Specifies a list of paths within which to find .BDF font files. Multiple paths can be specified by separating them with semicolons. The default is '.' (that is, search in the current working directory).
+ Specifies a list of paths within which to find .BDF font files. Multiple paths can be specified by separating them with semicolons. The default is ``.`` (that is, search in the current working directory).
.. _mame-commandline-cheatpath:
**-cheatpath** *<path>*
- Specifies a list of paths within which to find .XML cheat files. Multiple paths can be specified by separating them with semicolons. The default is 'cheat' (that is, a folder called 'cheat' located in the same directory as the as the MAME executable).
+ Specifies a list of paths within which to find .XML cheat files. Multiple paths can be specified by separating them with semicolons. The default is ``cheat`` (that is, a folder called 'cheat' located in the same directory as the as the MAME executable).
.. _mame-commandline-crosshairpath:
**-crosshairpath** *<path>*
- Specifies a list of paths within which to find crosshair files. Multiple paths can be specified by separating them with semicolons. The default is 'crsshair' (that is, a directory "crsshair" in the same directory as the MAME executable). If the crosshair is set to default in the menu, MAME will look for systemname\\cross#.png and then cross#.png in the specified crsshairpath, where # is the player number. Failing that, MAME will use built-in default crosshairs.
+ Specifies a list of paths within which to find crosshair files. Multiple paths can be specified by separating them with semicolons. The default is ``crsshair`` (that is, a directory "crsshair" in the same directory as the MAME executable). If the crosshair is set to default in the menu, MAME will look for ``systemname\\cross#.png`` and then cross#.png in the specified crsshairpath, where # is the player number. Failing that, MAME will use built-in default crosshairs.
.. _mame-commandline-pluginspath:
@@ -426,7 +425,7 @@ Core Search Path Options
**-swpath** *<path>*
Specifies a path within which to find loose software to be used by emulation.
-
+
Core Output Directory Options
-----------------------------
@@ -435,43 +434,43 @@ Core Output Directory Options
**-cfg_directory** *<path>*
- Specifies a single directory where configuration files are stored. Configuration files store user configurable settings that are read at startup and written when MAME exits. The default is 'cfg' (that is, a directory "cfg" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
+ Specifies a single directory where configuration files are stored. Configuration files store user configurable settings that are read at startup and written when MAME exits. The default is ``cfg`` (that is, a directory "cfg" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
.. _mame-commandline-nvramdirectory:
**-nvram_directory** *<path>*
- Specifies a single directory where NVRAM files are stored. NVRAM files store the contents of EEPROM and non-volatile RAM (NVRAM) for systems which used this type of hardware. This data is read at startup and written when MAME exits. The default is 'nvram' (that is, a directory "nvram" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
+ Specifies a single directory where NVRAM files are stored. NVRAM files store the contents of EEPROM and non-volatile RAM (NVRAM) for systems which used this type of hardware. This data is read at startup and written when MAME exits. The default is ``nvram`` (that is, a directory "nvram" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
.. _mame-commandline-inputdirectory:
**-input_directory** *<path>*
- Specifies a single directory where input recording files are stored. Input recordings are created via the -record option and played back via the -playback option. The default is 'inp' (that is, a directory "inp" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
+ Specifies a single directory where input recording files are stored. Input recordings are created via the -record option and played back via the -playback option. The default is ``inp`` (that is, a directory "inp" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
.. _mame-commandline-statedirectory:
**-state_directory** *<path>*
- Specifies a single directory where save state files are stored. Save state files are read and written either upon user request, or when using the -autosave option. The default is 'sta' (that is, a directory "sta" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
+ Specifies a single directory where save state files are stored. Save state files are read and written either upon user request, or when using the -autosave option. The default is ``sta`` (that is, a directory "sta" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
.. _mame-commandline-snapshotdirectory:
**-snapshot_directory** *<path>*
- Specifies a single directory where screen snapshots are stored, when requested by the user. The default is 'snap' (that is, a directory "snap" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
+ Specifies a single directory where screen snapshots are stored, when requested by the user. The default is ``snap`` (that is, a directory "snap" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
.. _mame-commandline-diffdirectory:
**-diff_directory** *<path>*
- Specifies a single directory where hard drive differencing files are stored. Hard drive differencing files store any data that is written back to a hard disk image, in order to preserve the original image. The differencing files are created at startup with a system with a hard disk image. The default is 'diff' (that is, a directory "diff" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
+ Specifies a single directory where hard drive differencing files are stored. Hard drive differencing files store any data that is written back to a hard disk image, in order to preserve the original image. The differencing files are created at startup with a system with a hard disk image. The default is ``diff`` (that is, a directory "diff" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
.. _mame-commandline-commentdirectory:
**-comment_directory** *<path>*
- Specifies a single directory where debugger comment files are stored. Debugger comment files are written by the debugger when comments are added to the disassembly for a system. The default is 'comments' (that is, a directory "comments" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
+ Specifies a single directory where debugger comment files are stored. Debugger comment files are written by the debugger when comments are added to the disassembly for a system. The default is ``comments`` (that is, a directory "comments" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
@@ -482,10 +481,10 @@ Core State/Playback Options
**-[no]rewind**
- When enabled and emulation is paused, automatically creates a save state in memory every time a frame is advanced. Rewind save states can then be loaded consecutively by pressing the rewind single step shortcut key (*Left Shift + Tilde by default*). The default rewind value is OFF (-norewind).
-
- If debugger is in a 'break' state, a save state is instead created every time step in, step over, or step out occurs. In that mode, rewind save states can be loaded by executing the debugger 'rewind'(or 'rw') command.
-
+ When enabled and emulation is paused, automatically creates a save state in memory every time a frame is advanced. Rewind save states can then be loaded consecutively by pressing the rewind single step shortcut key (**Left Shift + Tilde** by default). The default rewind value is OFF (**-norewind**).
+
+ If debugger is in a 'break' state, a save state is instead created every time step in, step over, or step out occurs. In that mode, rewind save states can be loaded by executing the debugger **rewind** (or **rw**) command.
+
.. _mame-commandline-rewindcapacity:
**-rewind_capacity** *<value>*
@@ -502,13 +501,13 @@ Core State/Playback Options
**-[no]autosave**
- When enabled, automatically creates a save state file when exiting MAME and automatically attempts to reload it when later starting MAME with the same system. This only works for systems that have explicitly enabled save state support in their driver. The default is OFF (-noautosave).
+ When enabled, automatically creates a save state file when exiting MAME and automatically attempts to reload it when later starting MAME with the same system. This only works for systems that have explicitly enabled save state support in their driver. The default is OFF (**-noautosave**).
.. _mame-commandline-playback:
**-playback** / **-pb** *<filename>*
- Specifies a file from which to play back a series of inputs. This feature does not work reliably for all systems, but can be used to watch a previously recorded game session from start to finish. In order to make things consistent, you should only record and playback with all configuration (.cfg), NVRAM (.nv), and memory card files deleted. The default is NULL (no playback).
+ Specifies a file from which to play back a series of inputs. This feature does not work reliably for all systems, but can be used to watch a previously recorded game session from start to finish. In order to make things consistent, you should only record and playback with all configuration (.cfg), NVRAM (.nv), and memory card files deleted. The default is ``NULL`` (no playback).
.. _mame-commandline-exitafterplayback:
@@ -520,79 +519,79 @@ Core State/Playback Options
**-record** / **-rec** *<filename>*
- Specifies a file to record all input from a session. This can be used to record a session for later playback. This feature does not work reliably for all systems, but can be used to watch a previously recorded session from start to finish. In order to make things consistent, you should only record and playback with all configuration (.cfg), NVRAM (.nv), and memory card files deleted. The default is NULL (no recording).
+ Specifies a file to record all input from a session. This can be used to record a session for later playback. This feature does not work reliably for all systems, but can be used to watch a previously recorded session from start to finish. In order to make things consistent, you should only record and playback with all configuration (.cfg), NVRAM (.nv), and memory card files deleted. The default is ``NULL`` (no recording).
.. _mame-commandline-recordtimecode:
**-record_timecode**
- Tells MAME to create a timecode file. It contains a line with elapsed times on each press of timecode shortcut key (*default is F12*). This option works only when recording mode is enabled (**-record** option). The file is saved in the *inp* folder. By default, no timecode file is saved.
+ Tells MAME to create a timecode file. It contains a line with elapsed times on each press of timecode shortcut key (default is **F12**). This option works only when recording mode is enabled (**-record** option). The file is saved in the ``inp`` folder. By default, no timecode file is saved.
.. _mame-commandline-mngwrite:
**-mngwrite** *<filename>*
- Writes each video frame to the given <filename> in MNG format, producing an animation of the session. Note that -mngwrite only writes video frames; it does not save any audio data. Use -wavwrite for that, and reassemble the audio/video using offline tools. The default is NULL (no recording).
+ Writes each video frame to the given <filename> in MNG format, producing an animation of the session. Note that -mngwrite only writes video frames; it does not save any audio data. Use -wavwrite for that, and reassemble the audio/video using offline tools. The default is ``NULL`` (no recording).
.. _mame-commandline-aviwrite:
**-aviwrite** *<filename>*
- Stream video and sound data to the given <filename> in AVI format, producing an animation of the session complete with sound. The default is NULL (no recording).
+ Stream video and sound data to the given <filename> in AVI format, producing an animation of the session complete with sound. The default is ``NULL`` (no recording).
.. _mame-commandline-wavwrite:
**-wavwrite** *<filename>*
- Writes the final mixer output to the given <filename> in WAV format, producing an audio recording of the session. The default is NULL (no recording).
+ Writes the final mixer output to the given <filename> in WAV format, producing an audio recording of the session. The default is ``NULL`` (no recording).
.. _mame-commandline-snapname:
**-snapname** *<name>*
Describes how MAME should name files for snapshots. <name> is a string that provides a template that is used to generate a filename.
-
- Three simple substitutions are provided: the / character represents the path separator on any target platform (even Windows); the string %g represents the driver name of the current system; and the string %i represents an incrementing index. If %i is omitted, then each snapshot taken will overwrite the previous one; otherwise, MAME will find the next empty value for %i and use that for a filename.
-
- The default is %g/%i, which creates a separate folder for each system, and names the snapshots under it starting with 0000 and increasing from there.
-
- In addition to the above, for drivers using different media, like carts or floppy disks, you can also use the %d_[media] indicator. Replace [media] with the media switch you want to use.
-
- A few examples: if you use 'mame robby -snapname foo/%g%i' snapshots will be saved as 'snaps\\foo\\robby0000.png' , 'snaps\\foo\\robby0001.png' and so on; if you use 'mame nes -cart robby -snapname %g/%d_cart' snapshots will be saved as 'snaps\\nes\\robby.png' ; if you use 'mame c64 -flop1 robby -snapname %g/%d_flop1/%i' snapshots will be saved as 'snaps\\c64\\robby\\0000.png'.
+
+ Three simple substitutions are provided: the / character represents the path separator on any target platform (even Windows); the string ``%g`` represents the driver name of the current system; and the string ``%i`` represents an incrementing index. If ``%i`` is omitted, then each snapshot taken will overwrite the previous one; otherwise, MAME will find the next empty value for ``%i`` and use that for a filename.
+
+ The default is ``%g/%i``, which creates a separate folder for each system, and names the snapshots under it starting with 0000 and increasing from there.
+
+ In addition to the above, for drivers using different media, like carts or floppy disks, you can also use the ``%d_[media]`` indicator. Replace [media] with the media switch you want to use.
+
+ A few examples: if you use ``mame robby -snapname foo/%g%i`` snapshots will be saved as ``snaps\\foo\\robby0000.png`` , ``snaps\\foo\\robby0001.png`` and so on; if you use **mame nes -cart robby -snapname %g/%d_cart** snapshots will be saved as ``snaps\\nes\\robby.png``; if you use **mame c64 -flop1 robby -snapname %g/%d_flop1/%i** snapshots will be saved as ``snaps\\c64\\robby\\0000.png``.
.. _mame-commandline-snapsize:
**-snapsize** *<width>x<height>*
- Hard-codes the size for snapshots and movie recording. By default, MAME will create snapshots at the system's current resolution in raw pixels, and will create movies at the system's starting resolution in raw pixels. If you specify this option, then MAME will create both snapshots and movies at the size specified, and will bilinear filter the result. Note that this size does not automatically rotate if the system is vertically oriented. The default is '*auto*'.
+ Hard-codes the size for snapshots and movie recording. By default, MAME will create snapshots at the system's current resolution in raw pixels, and will create movies at the system's starting resolution in raw pixels. If you specify this option, then MAME will create both snapshots and movies at the size specified, and will bilinear filter the result. Note that this size does not automatically rotate if the system is vertically oriented. The default is ``auto``.
.. _mame-commandline-snapview:
**-snapview** *<viewname>*
Specifies the view to use when rendering snapshots and movies. By default, both use a special 'internal' view, which renders a separate snapshot per screen or renders movies only of the first screen. By specifying this option, you can override this default behavior and select a single view that will apply to all snapshots and movies. Note that <viewname> does not need to be a perfect match; rather, it will select the first view whose name matches all the characters specified by <viewname>.
-
- For example, **-snapview native** will match the "Native (15:14)" view even though it is not a perfect match. <viewname> can also be 'auto', which selects the first view with all screens present. The default value is '*internal*'.
+
+ For example, **-snapview native** will match the "Native (15:14)" view even though it is not a perfect match. <viewname> can also be 'auto', which selects the first view with all screens present. The default value is ``internal``.
.. _mame-commandline-nosnapbilinear:
**-[no]snapbilinear**
- Specify if the snapshot or movie should have bilinear filtering applied. Shutting this off can make a difference in some performance while recording video to a file. The default is ON (*-snapbilinear*).
+ Specify if the snapshot or movie should have bilinear filtering applied. Shutting this off can make a difference in some performance while recording video to a file. The default is ON (**-snapbilinear**).
.. _mame-commandline-statename:
**-statename** *<name>*
Describes how MAME should store save state files, relative to the state_directory path. <name> is a string that provides a template that is used to generate a relative path.
-
- Two simple substitutions are provided: the / character represents the path separator on any target platform (even Windows); the string %g represents the driver name of the current system.
-
- The default is %g, which creates a separate folder for each system.
-
- In addition to the above, for drivers using different media, like carts or floppy disks, you can also use the %d_[media] indicator. Replace [media] with the media switch you want to use.
-
- A few examples: if you use 'mame robby -statename foo/%g' save states will be stored inside 'sta\\foo\\robby\\' ; if you use 'mame nes -cart robby -statename %g/%d_cart' save states will be stored inside 'sta\\nes\\robby\\' ; if you use 'mame c64 -flop1 robby -statename %g/%d_flop1' save states will be stored inside 'sta\\c64\\robby\\'.
+
+ Two simple substitutions are provided: the / character represents the path separator on any target platform (even Windows); the string ``%g`` represents the driver name of the current system.
+
+ The default is ``%g``, which creates a separate folder for each system.
+
+ In addition to the above, for drivers using different media, like carts or floppy disks, you can also use the ``%d_[media]`` indicator. Replace ``[media]`` with the media switch you want to use.
+
+ A few examples: if you use **mame robby -statename foo/%g** save states will be stored inside ``sta\\foo\\robby\\``; if you use **mame nes -cart robby -statename %g/%d_cart** save states will be stored inside ``sta\\nes\\robby\\``; if you use **mame c64 -flop1 robby -statename %g/%d_flop1** save states will be stored inside 'sta\\c64\\robby\\'.
.. _mame-commandline-noburnin:
@@ -600,7 +599,7 @@ Core State/Playback Options
Tracks brightness of the screen during play and at the end of emulation generates a PNG that can be used to simulate burn-in effects on other systems. The resulting PNG is created such that the least used-areas of the screen are fully white (since burned-in areas are darker, all other areas of the screen must be lightened a touch).
- The intention is that this PNG can be loaded via an artwork file with a low alpha (e.g, 0.1-0.2 seems to work well) and blended over the entire screen. The PNG files are saved in the snap directory under the systemname/burnin-<screen.name>.png. The default is OFF (*-noburnin*).
+ The intention is that this PNG can be loaded via an artwork file with a low alpha (e.g, 0.1-0.2 seems to work well) and blended over the entire screen. The PNG files are saved in the snap directory under the ``systemname/burnin-<screen.name>.png``. The default is OFF (**-noburnin**).
@@ -611,49 +610,49 @@ Core Performance Options
**-[no]autoframeskip** / **-[no]afs**
- Automatically determines the frameskip level while you're running the system, adjusting it constantly in a frantic attempt to keep the system running at full speed. Turning this on overrides the value you have set for -frameskip below. The default is OFF (*-noautoframeskip*).
+ Automatically determines the frameskip level while you're running the system, adjusting it constantly in a frantic attempt to keep the system running at full speed. Turning this on overrides the value you have set for -frameskip below. The default is OFF (**-noautoframeskip**).
.. _mame-commandline-frameskip:
**-frameskip** / **-fs** *<level>*
- Specifies the frameskip value. This is the number of frames out of every 12 to drop when running. For example, if you say -frameskip 2, then MAME will display 10 out of every 12 frames. By skipping those frames, you may be able to get full speed in a system that requires more horsepower than your computer has. The default value is **-frameskip 0**, which skips no frames.
+ Specifies the frameskip value. This is the number of frames out of every 12 to drop when running. For example, if you say **-frameskip 2**, then MAME will display 10 out of every 12 frames. By skipping those frames, you may be able to get full speed in a system that requires more horsepower than your computer has. The default value is **-frameskip 0**, which skips no frames.
.. _mame-commandline-secondstorun:
**-seconds_to_run** / **-str** *<seconds>*
- This option can be used for benchmarking and automated testing. It tells MAME to stop execution after a fixed number of seconds. By combining this with a fixed set of other command line options, you can set up a consistent environment for benchmarking MAME performance. In addition, upon exit, the **-str** option will write a screenshot called *final.png* to the system's snapshot directory.
+ This option can be used for benchmarking and automated testing. It tells MAME to stop execution after a fixed number of seconds. By combining this with a fixed set of other command line options, you can set up a consistent environment for benchmarking MAME performance. In addition, upon exit, the **-str** option will write a screenshot called ``final.png`` to the system's snapshot directory.
.. _mame-commandline-nothrottle:
**-[no]throttle**
- Configures the default thottling setting. When throttling is on, MAME attempts to keep the system running at the system's intended speed. When throttling is off, MAME runs the system as fast as it can. Note that the fastest speed is more often than not limited by your graphics card, especially for older systems. The default is ON (*-throttle*).
+ Configures the default thottling setting. When throttling is on, MAME attempts to keep the system running at the system's intended speed. When throttling is off, MAME runs the system as fast as it can. Note that the fastest speed is more often than not limited by your graphics card, especially for older systems. The default is ON (**-throttle**).
.. _mame-commandline-nosleep:
**-[no]sleep**
- Allows MAME to give time back to the system when running with -throttle. This allows other programs to have some CPU time, assuming that the system isn't taxing 100% of your CPU resources. This option can potentially cause hiccups in performance if other demanding programs are running. The default is ON (*-sleep*).
+ Allows MAME to give time back to the system when running with **-throttle**. This allows other programs to have some CPU time, assuming that the system isn't taxing 100% of your CPU resources. This option can potentially cause hiccups in performance if other demanding programs are running. The default is ON (**-sleep**).
.. _mame-commandline-speed:
**-speed** *<factor>*
- Changes the way MAME throttles the emulated system such that it runs at some multiplier of the original speed. A <factor> of 1.0 means to run the system at its normal speed. A <factor> of 0.5 means run at half speed, and a <factor> of 2.0 means run at 2x speed. Note that changing this value affects sound playback as well, which will scale in pitch accordingly. The internal resolution of the fraction is two decimalplaces, so a value of 1.002 is the same as 1.0. The default is 1.0.
+ Changes the way MAME throttles the emulated system such that it runs at some multiplier of the original speed. A <factor> of 1.0 means to run the system at its normal speed. A <factor> of 0.5 means run at half speed, and a <factor> of 2.0 means run at 2x speed. Note that changing this value affects sound playback as well, which will scale in pitch accordingly. The internal resolution of the fraction is two decimal places, so a value of 1.002 is the same as 1.0. The default is ``1.0``.
.. _mame-commandline-norefreshspeed:
**-[no]refreshspeed** / **-[no]rs**
- Allows MAME to dynamically adjust the system's speed such that it does not exceed the slowest refresh rate for any targeted monitors in your system. Thus, if you have a 60Hz monitor and run a system that is actually designed to run at 60.6Hz, MAME will dynamically change the speed down to 99% in order to prevent sound hiccups or other undesirable side effects of running at a slower refresh rate. The default is OFF (*-norefreshspeed*).
+ Allows MAME to dynamically adjust the system's speed such that it does not exceed the slowest refresh rate for any targeted monitors in your system. Thus, if you have a 60Hz monitor and run a system that is actually designed to run at 60.6Hz, MAME will dynamically change the speed down to 99% in order to prevent sound hiccups or other undesirable side effects of running at a slower refresh rate. The default is OFF (**-norefreshspeed**).
.. _mame-commandline-numprocessors:
**-numprocessors** *<auto|value>* / **-np** *<auto|value>*
- Specify the number of processors to use for work queues. Specifying "*auto*" will use the value reported by the system or environment variable **OSDPROCESSORS**. To avoid abuse, this value is internally limited to 4 times the number of processors reported by the system. The default is "*auto*".
+ Specify the number of processors to use for work queues. Specifying ``auto`` will use the value reported by the system or environment variable **OSDPROCESSORS**. To avoid abuse, this value is internally limited to 4 times the number of processors reported by the system. The default is ``auto``.
.. _mame-commandline-bench:
@@ -672,7 +671,7 @@ Core Rotation Options
| **-[no]rotate**
|
-| Rotate the system to match its normal state (horizontal/vertical). This ensures that both vertically and horizontally oriented systems show up correctly without the need to rotate your monitor. If you want to keep the system displaying 'raw' on the screen the way it would have in the arcade, turn this option OFF. The default is ON (*-rotate*).
+| Rotate the system to match its normal state (horizontal/vertical). This ensures that both vertically and horizontally oriented systems show up correctly without the need to rotate your monitor. If you want to keep the system displaying 'raw' on the screen the way it would have in the arcade, turn this option OFF. The default is ON (**-rotate**).
|
|
@@ -684,7 +683,7 @@ Core Rotation Options
| **-[no]rol**
|
|
-| Rotate the system screen to the right (clockwise) or left (counter-clockwise) relative to either its normal state (if **-rotate** is specified) or its native state (if **-norotate** is specified). The default for both of these options is OFF (*-noror -norol*).
+| Rotate the system screen to the right (clockwise) or left (counter-clockwise) relative to either its normal state (if **-rotate** is specified) or its native state (if **-norotate** is specified). The default for both of these options is OFF (**-noror -norol**).
|
|
@@ -697,7 +696,7 @@ Core Rotation Options
| **-[no]autorol**
|
|
-| These options are designed for use with pivoting screens that only pivot in a single direction. If your screen only pivots clockwise, use -autorol to ensure that the system will fill the screen either horizontally or vertically in one of the directions you can handle. If your screen only pivots counter-clockwise, use **-autoror**.
+| These options are designed for use with pivoting screens that only pivot in a single direction. If your screen only pivots clockwise, use **-autorol** to ensure that the system will fill the screen either horizontally or vertically in one of the directions you can handle. If your screen only pivots counter-clockwise, use **-autoror**.
|
|
@@ -710,7 +709,7 @@ Core Rotation Options
| **-[no]flipy**
|
|
-| Flip (mirror) the system screen either horizontally (-flipx) or vertically (-flipy). The flips are applied after the -rotate and -ror/-rol options are applied. The default for both of these options is OFF (*-noflipx -noflipy*).
+| Flip (mirror) the system screen either horizontally (**-flipx**) or vertically (**-flipy**). The flips are applied after the **-rotate** and **-ror**/**-rol** options are applied. The default for both of these options is OFF (**-noflipx -noflipy**).
|
|
@@ -727,50 +726,50 @@ Core Video Options
|
| Generally Available:
|
-| Using '**bgfx**' specifies the new hardware accelerated renderer.
-| Using '**opengl**' tells MAME to render video using OpenGL acceleration.
-| Using '**none**' displays no windows and does no drawing. This is primarily present for doing CPU benchmarks without the overhead of the video system.
+| Using ``bgfx`` specifies the new hardware accelerated renderer.
+| Using ``opengl`` tells MAME to render video using OpenGL acceleration.
+| Using ``none`` displays no windows and does no drawing. This is primarily present for doing CPU benchmarks without the overhead of the video system.
|
| On Windows:
|
-| Using '**gdi**' here, tells MAME to render video using older standard Windows graphics drawing calls. This is the slowest but most compatible option on older versions of Windows.
-| Using '**d3d**' tells MAME to use Direct3D for rendering. This produces the better quality output than gdi and enables additional rendering options. It is recommended if you have a semi-recent (2002+) video card or onboard Intel video of the HD3000 line or better.
+| Using ``gdi`` here, tells MAME to render video using older standard Windows graphics drawing calls. This is the slowest but most compatible option on older versions of Windows.
+| Using ``d3d`` tells MAME to use Direct3D for rendering. This produces the better quality output than ``gdi`` and enables additional rendering options. It is recommended if you have a semi-recent (2002+) video card or onboard Intel video of the HD3000 line or better.
|
| On other platforms (including SDL on Windows):
|
-| Using '**accel**' tells MAME to render video using SDL's 2D acceleration if possible.
-| Using '**soft**' uses software rendering for video output. This isn't as fast or as nice as OpenGL but will work on any platform.
+| Using ``accel`` tells MAME to render video using SDL's 2D acceleration if possible.
+| Using ``soft`` uses software rendering for video output. This isn't as fast or as nice as OpenGL but will work on any platform.
|
| Defaults:
|
-| The default on Windows is **d3d**.
-| The default for Mac OS X is '*opengl*' because OS X is guaranteed to have a compliant OpenGL stack.
-| The default on all other systems is '*soft*'.
+| The default on Windows is ``d3d``.
+| The default for Mac OS X is ``opengl`` because OS X is guaranteed to have a compliant OpenGL stack.
+| The default on all other systems is ``soft``.
|
.. _mame-commandline-numscreens:
**-numscreens** *<count>*
- Tells MAME how many output windows to create. For most systems, a single output window is all you need, but some systems originally used multiple screens (*e.g. Darius and PlayChoice-10 arcade machines*). Each screen (up to 4) has its own independent settings for physical monitor, aspect ratio, resolution, and view, which can be set using the options below. The default is *1*.
+ Tells MAME how many output windows to create. For most systems, a single output window is all you need, but some systems originally used multiple screens (*e.g. Darius and PlayChoice-10 arcade machines*). Each screen (up to 4) has its own independent settings for physical monitor, aspect ratio, resolution, and view, which can be set using the options below. The default is ``1``.
.. _mame-commandline-window:
**-[no]window** / **-[no]w**
- Run MAME in either a window or full screen. The default is OFF (*-nowindow*).
+ Run MAME in either a window or full screen. The default is OFF (**-nowindow**).
.. _mame-commandline-maximize:
**-[no]maximize** / **-[no]max**
- Controls initial window size in windowed mode. If it is set on, the window will initially be set to the maximum supported size when you start MAME. If it is turned off, the window will start out at the smallest supported size. This option only has an effect when the -window option is used. The default is ON (*-maximize*).
+ Controls initial window size in windowed mode. If it is set on, the window will initially be set to the maximum supported size when you start MAME. If it is turned off, the window will start out at the smallest supported size. This option only has an effect when the -window option is used. The default is ON (**-maximize**).
.. _mame-commandline-keepaspect:
**-[no]keepaspect** / **-[no]ka**
- Enables aspect ratio enforcement. When this option is on, the system's proper aspect ratio (generally 4:3 or 3:4) is enforced, so you get the system looking like it should. When running in a window with this option on, you can only resize the window to the proper aspect ratio, unless you are holding down the CONTROL key. By turning the option off, the aspect ratio is allowed to float. In full screen mode, this means that all systems will stretch to the full screen size (even vertical systems). In window mode, it means that you can freely resize the window without any constraints. The default is ON (*-keepaspect*).
+ Enables aspect ratio enforcement. When this option is on, the system's proper aspect ratio (generally 4:3 or 3:4) is enforced, so you get the system looking like it should. When running in a window with this option on, you can only resize the window to the proper aspect ratio, unless you are holding down the CONTROL key. By turning the option off, the aspect ratio is allowed to float. In full screen mode, this means that all systems will stretch to the full screen size (even vertical systems). In window mode, it means that you can freely resize the window without any constraints. The default is ON (**-keepaspect**).
The MAME team heavily suggests you leave this at default. Stretching systems beyond their original aspect ratio will mangle the appearance of the system in ways that no filtering or HLSL can repair.
@@ -778,7 +777,7 @@ Core Video Options
**-[no]waitvsync**
- Waits for the refresh period on your computer's monitor to finish before starting to draw video to your screen. If this option is off, MAME will just draw to the screen at any old time, even in the middle of a refresh cycle. This can cause "tearing" artifacts, where the top portion of the screen is out of sync with the bottom portion. Tearing is not noticeable on all systems, and some people hate it more than others. However, if you turn this option on, you will waste more of your CPU cycles waiting for the proper time to draw, so you will see a performance hit. You should only need to turn this on in windowed mode. In full screen mode, it is only needed if **-triplebuffer** does not remove the tearing, in which case you should use **-notriplebuffer -waitvsync**. Note that this option does not work with **-video gdi** mode. The default is OFF (*-nowaitvsync*).
+ Waits for the refresh period on your computer's monitor to finish before starting to draw video to your screen. If this option is off, MAME will just draw to the screen at any old time, even in the middle of a refresh cycle. This can cause "tearing" artifacts, where the top portion of the screen is out of sync with the bottom portion. Tearing is not noticeable on all systems, and some people hate it more than others. However, if you turn this option on, you will waste more of your CPU cycles waiting for the proper time to draw, so you will see a performance hit. You should only need to turn this on in windowed mode. In full screen mode, it is only needed if **-triplebuffer** does not remove the tearing, in which case you should use **-notriplebuffer -waitvsync**. Note that this option does not work with **-video gdi** mode. The default is OFF (**-nowaitvsync**).
Note that SDL-based MAME support for this option depends entirely on your operating system and video drivers; in general it will not work in windowed mode so **-video opengl** and fullscreen give the greatest chance of success.
@@ -786,29 +785,31 @@ Core Video Options
**-[no]syncrefresh**
- Enables speed throttling only to the refresh of your monitor. This means that the system's actual refresh rate is ignored; however, the sound code still attempts to keep up with the system's original refresh rate, so you may encounter sound problems. This option is intended mainly for those who have tweaked their video card's settings to provide carefully matched refresh rate options. Note that this option does not work with -video gdi mode. The default is OFF (*-nosyncrefresh*).
+ Enables speed throttling only to the refresh of your monitor. This means that the system's actual refresh rate is ignored; however, the sound code still attempts to keep up with the system's original refresh rate, so you may encounter sound problems. This option is intended mainly for those who have tweaked their video card's settings to provide carefully matched refresh rate options. Note that this option does not work with -video gdi mode. The default is OFF (**-nosyncrefresh**).
.. _mame-commandline-prescale:
**-prescale** *<amount>*
- Controls the size of the screen images when they are passed off to the graphics system for scaling. At the minimum setting of 1, the screen is rendered at its original resolution before being scaled. At higher settings, the screen is expanded by a factor of *<amount>* before being scaled. With **-video d3d**, this produces a less blurry image at the expense of some speed. The default is *1*.
+ Controls the size of the screen images when they are passed off to the graphics system for scaling. At the minimum setting of 1, the screen is rendered at its original resolution before being scaled. At higher settings, the screen is expanded by a factor of *<amount>* before being scaled. With **-video d3d**, this produces a less blurry image at the expense of some speed. The default is ``1``.
- This is supported with all video output types (bgfx, d3d, etc) on Windows and is **ONLY** supported with OpenGL on other platforms.
+ This is supported with all video output types (``bgfx``, ``d3d``, etc) on Windows and is **ONLY** supported with OpenGL on other platforms.
.. _mame-commandline-filter:
**-[no]filter** / **-[no]d3dfilter** / **-[no]flt**
- Enable bilinear filtering on the system screen graphics. When disabled, point filtering is applied, which is crisper but leads to scaling artifacts. If you don't like the filtered look, you are probably better off increasing the *-prescale* value rather than turning off filtering altogether. The default is ON (*-filter*).
+ Enable bilinear filtering on the system screen graphics. When disabled, point filtering is applied, which is crisper but leads to scaling artifacts. If you don't like the filtered look, you are probably better off increasing the **-prescale** value rather than turning off filtering altogether. The default is ON (**-filter**).
+
+ This is supported with OpenGL and D3D video on Windows and is **ONLY** supported with OpenGL on other platforms.
- This is supported with all video output types (bgfx, d3d, etc) on Windows and is **ONLY** supported with OpenGL on other platforms.
+ Use bgfx_screen_chains with BGFX to adjust filtering with that video system.
.. _mame-commandline-unevenstretch:
**-[no]unevenstretch**
- Allow non-integer stretch factors allowing for great window sizing flexability. The default is ON. (*-unevenstretch*)
+ Allow non-integer stretch factors allowing for great window sizing flexability. The default is ON. (**-unevenstretch**)
Core Full Screen Options
@@ -818,7 +819,7 @@ Core Full Screen Options
**-[no]switchres**
- Enables resolution switching. This option is required for the **-resolution\*** options to switch resolutions in full screen mode. On modern video cards, there is little reason to switch resolutions unless you are trying to achieve the "exact" pixel resolutions of the original systems, which requires significant tweaking. This option is also useful on LCD displays, since they run with a fixed resolution and switching resolutions on them is just silly. This option does not work with **-video gdi**. The default is OFF (*-noswitchres*).
+ Enables resolution switching. This option is required for the **-resolution\*** options to switch resolutions in full screen mode. On modern video cards, there is little reason to switch resolutions unless you are trying to achieve the "exact" pixel resolutions of the original systems, which requires significant tweaking. This option is also useful on LCD displays, since they run with a fixed resolution and switching resolutions on them is just silly. This option does not work with **-video gdi**. The default is OFF (**-noswitchres**).
Core Per-Window Options
@@ -834,7 +835,7 @@ NOTE: **Multiple Screens may fail to work correctly on some Mac machines as of
| **-screen2** *<display>*
| **-screen3** *<display>*
|
-| Specifies which physical monitor on your system you wish to have each window use by default. In order to use multiple windows, you must have increased the value of the **-numscreens** option. The name of each display in your system can be determined by running MAME with the -verbose option. The display names are typically in the format of: *\\\\.\\DISPLAYn*, where 'n' is a number from 1 to the number of connected monitors. The default value for these options is '*auto*', which means that the first window is placed on the first display, the second window on the second display, etc.
+| Specifies which physical monitor on your system you wish to have each window use by default. In order to use multiple windows, you must have increased the value of the **-numscreens** option. The name of each display in your system can be determined by running MAME with the -verbose option. The display names are typically in the format of: ``\\\\.\\DISPLAYn``, where 'n' is a number from 1 to the number of connected monitors. The default value for these options is ``auto``, which means that the first window is placed on the first display, the second window on the second display, etc.
|
| The **-screen0**, **-screen1**, **-screen2**, **-screen3** parameters apply to the specific window. The **-screen** parameter applies to all windows. The window-specific options override values from the all window option.
|
@@ -850,7 +851,7 @@ NOTE: **Multiple Screens may fail to work correctly on some Mac machines as of
| **-aspect3** *<width:height>*
|
|
-| Specifies the physical aspect ratio of the physical monitor for each window. In order to use multiple windows, you must have increased the value of the **-numscreens** option. The physical aspect ratio can be determined by measuring the width and height of the visible screen image and specifying them separated by a colon. The default value for these options is '*auto*', which means that MAME assumes the aspect ratio is proportional to the number of pixels in the desktop video mode for each monitor.
+| Specifies the physical aspect ratio of the physical monitor for each window. In order to use multiple windows, you must have increased the value of the **-numscreens** option. The physical aspect ratio can be determined by measuring the width and height of the visible screen image and specifying them separated by a colon. The default value for these options is ``auto``, which means that MAME assumes the aspect ratio is proportional to the number of pixels in the desktop video mode for each monitor.
|
| The **-aspect0**, **-aspect1**, **-aspect2**, **-aspect3** parameters apply to the specific window. The **-aspect** parameter applies to all windows. The window-specific options override values from the all window option.
|
@@ -865,9 +866,9 @@ NOTE: **Multiple Screens may fail to work correctly on some Mac machines as of
| **-resolution2** *<widthxheight[@refresh]>* / **-r2** *<widthxheight[@refresh]>*
| **-resolution3** *<widthxheight[@refresh]>* / **-r3** *<widthxheight[@refresh]>*
|
-| Specifies an exact resolution to run in. In full screen mode, MAME will try to use the specific resolution you request. The width and height are required; the refresh rate is optional. If omitted or set to 0, MAME will determine the mode automatically. For example, **-resolution 640x480** will force 640x480 resolution, but MAME is free to choose the refresh rate. Similarly, **-resolution 0x0@60** will force a 60Hz refresh rate, but allows MAME to choose the resolution. The string "*auto*" is also supported, and is equivalent to *0x0@0*. In window mode, this resolution is used as a maximum size for the window. This option requires the **-switchres** option as well in order to actually enable resolution switching with **-video d3d**. The default value for these options is '*auto*'.
+| Specifies an exact resolution to run in. In full screen mode, MAME will try to use the specific resolution you request. The width and height are required; the refresh rate is optional. If omitted or set to 0, MAME will determine the mode automatically. For example, **-resolution 640x480** will force 640x480 resolution, but MAME is free to choose the refresh rate. Similarly, **-resolution 0x0@60** will force a 60Hz refresh rate, but allows MAME to choose the resolution. The string ``auto`` is also supported, and is equivalent to ``0x0@0``. In window mode, this resolution is used as a maximum size for the window. This option requires the **-switchres** option as well in order to actually enable resolution switching with **-video d3d**. The default value for these options is ``auto``.
|
-| The **-resolution0**, **-resolution1**, **-resolution2**, **-resolution3** parameters apply to the specific window. The -resolution parameter applies to all windows. The window-specific options override values from the all window option.
+| The **-resolution0**, **-resolution1**, **-resolution2**, **-resolution3** parameters apply to the specific window. The **-resolution** parameter applies to all windows. The window-specific options override values from the all window option.
|
|
@@ -880,7 +881,7 @@ NOTE: **Multiple Screens may fail to work correctly on some Mac machines as of
| **-view2** *<viewname>*
| **-view3** *<viewname>*
|
-| Specifies the initial view setting for each window. The *<viewname>* does not need to be a perfect match; rather, it will select the first view whose name matches all the characters specified by *<viewname>*. For example, **-view native** will match the "*Native (15:14)*" view even though it is not a perfect match. The value '*auto*' is also supported, and requests that MAME perform a default selection. The default value for these options is '*auto*'.
+| Specifies the initial view setting for each window. The *<viewname>* does not need to be a perfect match; rather, it will select the first view whose name matches all the characters specified by *<viewname>*. For example, **-view native** will match the "*Native (15:14)*" view even though it is not a perfect match. The value ``auto`` is also supported, and requests that MAME perform a default selection. The default value for these options is ``auto``.
|
| The **-view0**, **-view1**, **-view2**, **-view3** parameters apply to the specific window. The **-view** parameter applies to all windows. The window-specific options override values from the all window option.
|
@@ -894,37 +895,37 @@ Core Artwork Options
**-[no]artwork_crop** / **-[no]artcrop**
- Enable cropping of artwork to the system screen area only. This works best with -video gdi or -video d3d, and means that vertically oriented systems running full screen can display their artwork to the left and right sides of the screen. This option can also be controlled via the Video Options menu in the user interface. The default is OFF (*-noartwork_crop*).
+ Enable cropping of artwork to the system screen area only. This works best with **-video gdi** or **-video d3d**, and means that vertically oriented systems running full screen can display their artwork to the left and right sides of the screen. This option can also be controlled via the Video Options menu in the user interface. The default is OFF **-noartwork_crop**.
.. _mame-commandline-nousebackdrops:
**-[no]use_backdrops** / **-[no]backdrop**
- Enables/disables the display of backdrops. The default is ON (*-use_backdrops*).
+ Enables/disables the display of backdrops. The default is ON (**-use_backdrops**).
.. _mame-commandline-nouseoverlays:
**-[no]use_overlays** / **-[no]overlay**
- Enables/disables the display of overlays. The default is ON (*-use_overlays*).
+ Enables/disables the display of overlays. The default is ON (**-use_overlays**).
.. _mame-commandline-nousebezels:
**-[no]use_bezels** / **-[no]bezels**
- Enables/disables the display of bezels. The default is ON (*-use_bezels*).
+ Enables/disables the display of bezels. The default is ON (**-use_bezels**).
.. _mame-commandline-nousecpanels:
**-[no]use_cpanels** / **-[no]cpanels**
- Enables/disables the display of control panels. The default is ON (*-use_cpanels*).
+ Enables/disables the display of control panels. The default is ON (**-use_cpanels**).
.. _mame-commandline-nousemarquees:
**-[no]use_marquees** / **-[no]marquees**
- Enables/disables the display of marquees. The default is ON (*-use_marquees*).
+ Enables/disables the display of marquees. The default is ON (**-use_marquees**).
.. _mame-commandline-fallbackartwork:
@@ -947,31 +948,31 @@ Core Screen Options
**-brightness** *<value>*
- Controls the default brightness, or black level, of the system screens. This option does not affect the artwork or other parts of the display. Using the MAME UI, you can individually set the brightness for each system screen; this option controls the initial value for all visible system screens. The standard value is 1.0. Selecting lower values (down to 0.1) will produce a darkened display, while selecting higher values (up to 2.0) will give a brighter display. The default is *1.0*.
+ Controls the default brightness, or black level, of the system screens. This option does not affect the artwork or other parts of the display. Using the MAME UI, you can individually set the brightness for each system screen; this option controls the initial value for all visible system screens. The standard value is ``1.0``. Selecting lower values (down to 0.1) will produce a darkened display, while selecting higher values (up to 2.0) will give a brighter display. The default is ``1.0``.
.. _mame-commandline-contrast:
**-contrast** *<value>*
- Controls the contrast, or white level, of the system screens. This option does not affect the artwork or other parts of the display. Using the MAME UI, you can individually set the contrast for each system screen; this option controls the initial value for all visible system screens. The standard value is 1.0. Selecting lower values (down to 0.1) will produce a dimmer display, while selecting higher values (up to 2.0) will give a more saturated display. The default is *1.0*.
+ Controls the contrast, or white level, of the system screens. This option does not affect the artwork or other parts of the display. Using the MAME UI, you can individually set the contrast for each system screen; this option controls the initial value for all visible system screens. The standard value is ``1.0``. Selecting lower values (down to 0.1) will produce a dimmer display, while selecting higher values (up to 2.0) will give a more saturated display. The default is ``1.0``.
.. _mame-commandline-gamma:
**-gamma** *<value>*
- Controls the gamma, which produces a potentially nonlinear black to white ramp, for the system screens. This option does not affect the artwork or other parts of the display. Using the MAME UI, you can individually set the gamma for each system screen; this option controls the initial value for all visible system screens. The standard value is 1.0, which gives a linear ramp from black to white. Selecting lower values (down to 0.1) will increase the nonlinearity toward black, while selecting higher values (up to 3.0) will push the nonlinearity toward white. The default is *1.0*.
+ Controls the gamma, which produces a potentially nonlinear black to white ramp, for the system screens. This option does not affect the artwork or other parts of the display. Using the MAME UI, you can individually set the gamma for each system screen; this option controls the initial value for all visible system screens. The standard value is ``1.0``, which gives a linear ramp from black to white. Selecting lower values (down to 0.1) will increase the nonlinearity toward black, while selecting higher values (up to 3.0) will push the nonlinearity toward white. The default is ``1.0``.
.. _mame-commandline-pausebrightness:
**-pause_brightness** *<value>*
- This controls the brightness level when MAME is paused. The default value is *0.65*.
+ This controls the brightness level when MAME is paused. The default value is ``0.65``.
.. _mame-commandline-effect:
**-effect** *<filename>*
- Specifies a single PNG file that is used as an overlay over any system screens in the video display. This PNG file is assumed to live in the root of one of the artpath directories. The pattern in the PNG file is repeated both horizontally and vertically to cover the entire system screen areas (but not any external artwork), and is rendered at the target resolution of the system image. For -video gdi and -video d3d modes, this means that one pixel in the PNG will map to one pixel on your output display. The RGB values of each pixel in the PNG are multiplied against the RGB values of the target screen. The default is '*none*', meaning no effect.
+ Specifies a single PNG file that is used as an overlay over any system screens in the video display. This PNG file is assumed to live in the root of one of the artpath directories. The pattern in the PNG file is repeated both horizontally and vertically to cover the entire system screen areas (but not any external artwork), and is rendered at the target resolution of the system image. For **-video gdi** and **-video d3d** modes, this means that one pixel in the PNG will map to one pixel on your output display. The RGB values of each pixel in the PNG are multiplied against the RGB values of the target screen. The default is ``none``, meaning no effect.
@@ -1000,7 +1001,7 @@ Core Vector Options
**-flicker** *<value>*
- Simulates a vector "flicker" effect, similar to a vector monitor that needs adjustment. This option requires a float argument in the range of 0.00 - 100.00 (0=none, 100=maximum). The default is *0*.
+ Simulates a vector "flicker" effect, similar to a vector monitor that needs adjustment. This option requires a float argument in the range of 0.00 - 100.00 (0=none, 100=maximum). The default is ``0``.
@@ -1013,25 +1014,25 @@ These options are for compatibility in **-video opengl**. If you report renderin
**-[no]gl_forcepow2texture**
- Always use only power-of-2 sized textures (default *off*)
+ Always use only power-of-2 sized textures (default ``off``)
.. _mame-commandline-glnotexturerect:
**-[no]gl_notexturerect**
- Don't use OpenGL GL_ARB_texture_rectangle (default *on*)
+ Don't use OpenGL GL_ARB_texture_rectangle (default ``on``)
.. _mame-commandline-glvbo:
**-[no]gl_vbo**
- Enable OpenGL VBO (Vertex Buffer Objects), if available (default *on*)
+ Enable OpenGL VBO (Vertex Buffer Objects), if available (default ``on``)
.. _mame-commandline-glpbo:
**-[no]gl_pbo**
- Enable OpenGL PBO (Pixel Buffer Objects), if available (default *on*)
+ Enable OpenGL PBO (Pixel Buffer Objects), if available (default ``on``)
Core Video OpenGL GLSL Options
@@ -1042,13 +1043,13 @@ Core Video OpenGL GLSL Options
**-gl_glsl**
- Enable OpenGL GLSL, if available (default *off*)
+ Enable OpenGL GLSL, if available (default ``off``)
.. _mame-commandline-glglslfilter:
**-gl_glsl_filter**
- Enable OpenGL GLSL filtering instead of FF filtering -- *0-plain, 1-bilinear, 2-bicubic* (default is *1*)
+ Enable OpenGL GLSL filtering instead of FF filtering -- *0-plain, 1-bilinear, 2-bicubic* (default is ``1``)
.. _mame-commandline-glslshadermame:
@@ -1083,7 +1084,7 @@ Core Video OpenGL GLSL Options
**-gl_glsl_vid_attr**
- Enable OpenGL GLSL handling of brightness and contrast. Better RGB system performance. Default is *on*.
+ Enable OpenGL GLSL handling of brightness and contrast. Better RGB system performance. Default is ``on``.
Core Sound Options
@@ -1093,37 +1094,37 @@ Core Sound Options
**-samplerate** *<value>* / **-sr** *<value>*
- Sets the audio sample rate. Smaller values (e.g. 11025) cause lower audio quality but faster emulation speed. Higher values (e.g. 48000) cause higher audio quality but slower emulation speed. The default is *48000*.
+ Sets the audio sample rate. Smaller values (e.g. 11025) cause lower audio quality but faster emulation speed. Higher values (e.g. 48000) cause higher audio quality but slower emulation speed. The default is ``48000``.
.. _mame-commandline-nosamples:
**-[no]samples**
- Use samples if available. The default is ON (*-samples*).
+ Use samples if available. The default is ON (**-samples**).
.. _mame-commandline-volume:
**-volume** / **-vol** *<value>*
- Sets the startup volume. It can later be changed with the user interface (see Keys section). The volume is an attenuation in dB: e.g., "**-volume -12**" will start with -12dB attenuation. The default is *0*.
+ Sets the startup volume. It can later be changed with the user interface (see Keys section). The volume is an attenuation in dB: e.g., "**-volume -12**" will start with -12dB attenuation. The default is ``0``.
.. _mame-commandline-sound:
-**-sound** *<dsound|coreaudio|sdl|xaudio2|portaudio|none>*
+**-sound** *<``dsound``|``coreaudio``|``sdl``|``xaudio2``|``portaudio``|``none``>*
- Specifies which sound subsystem to use. Selecting *none* disables sound output altogether (sound hardware is still emulated). On Windows, *dsound*, *xaudio2*, *portaudio* and *none* are available. On macOS, *coreaudio*, *sdl*, *portaudio* and *none* are available. On other operating systems, *sdl*, *portaudio* and *none* are available. (Special build options allow *sdl* to be used on Windows, or *portaudio* to be disabled.)
+ Specifies which sound subsystem to use. Selecting ``none`` disables sound output altogether (sound hardware is still emulated). On Windows, ``dsound``, ``xaudio2``, ``portaudio`` and ``none`` are available. On macOS, ``coreaudio``, ``sdl``, ``portaudio`` and ``none`` are available. On other operating systems, ``sdl``, ``portaudio`` and ``none`` are available. (Special build options allow ``sdl`` to be used on Windows, or ``portaudio`` to be disabled.)
- The default is *dsound* on Windows. On Mac, *coreaudio* is the default. On all other platforms, *sdl* is the default.
+ The default is ``dsound`` on Windows. On Mac, ``coreaudio`` is the default. On all other platforms, ``sdl`` is the default.
On Windows and Linux, *portaudio* is likely to give the lowest possible latency, where on Mac *coreaudio* provides the best results.
- When using the *sdl* sound subsystem, the audio API to use may be selected by setting the *SDL_AUDIODRIVER* environment variable. Available audio APIs depend on the operating system. On Windows, it may be necessary to set *SDL_AUDIODRIVER=directsound* if no sound output is produced by default.
+ When using the ``sdl`` sound subsystem, the audio API to use may be selected by setting the *SDL_AUDIODRIVER* environment variable. Available audio APIs depend on the operating system. On Windows, it may be necessary to set ``SDL_AUDIODRIVER=directsound`` if no sound output is produced by default.
.. _mame-commandline-audiolatency:
**-audio_latency** *<value>*
- The exact behavior depends on the selected audio output module. Smaller values provide less audio delay while requiring better system performance. Higher values increase audio delay but may help avoid buffer under-runs and audio interruptions. The default is *1*.
+ The exact behavior depends on the selected audio output module. Smaller values provide less audio delay while requiring better system performance. Higher values increase audio delay but may help avoid buffer under-runs and audio interruptions. The default is ``1``.
@@ -1135,67 +1136,67 @@ Core Input Options
**-[no]coin_lockout** / **-[no]coinlock**
- Enables simulation of the "coin lockout" feature that is implemented on a number of arcade game PCBs. It was up to the operator whether or not the coin lockout outputs were actually connected to the coin mechanisms. If this feature is enabled, then attempts to enter a coin while the lockout is active will fail and will display a popup message in the user interface (In debug mode). If this feature is disabled, the coin lockout signal will be ignored. The default is ON (*-coin_lockout*).
+ Enables simulation of the "coin lockout" feature that is implemented on a number of arcade game PCBs. It was up to the operator whether or not the coin lockout outputs were actually connected to the coin mechanisms. If this feature is enabled, then attempts to enter a coin while the lockout is active will fail and will display a popup message in the user interface (In debug mode). If this feature is disabled, the coin lockout signal will be ignored. The default is ON (**-coin_lockout**).
.. _mame-commandline-ctrlr:
**-ctrlr** *<controller>*
- Enables support for special controllers. Configuration files are loaded from the ctrlrpath. They are in the same format as the .cfg files that are saved, but only control configuration data is read from the file. The default is NULL (no controller file).
+ Enables support for special controllers. Configuration files are loaded from the ctrlrpath. They are in the same format as the .cfg files that are saved, but only control configuration data is read from the file. The default is ``NULL`` (no controller file).
.. _mame-commandline-nomouse:
**-[no]mouse**
- Controls whether or not MAME makes use of mouse controllers. When this is enabled, you will likely be unable to use your mouse for other purposes until you exit or pause the system. The default is OFF (*-nomouse*).
+ Controls whether or not MAME makes use of mouse controllers. When this is enabled, you will likely be unable to use your mouse for other purposes until you exit or pause the system. The default is OFF (**-nomouse**).
.. _mame-commandline-nojoystick:
**-[no]joystick** / **-[no]joy**
- Controls whether or not MAME makes use of joystick/gamepad controllers. When this is enabled, MAME will ask DirectInput about which controllers are connected. The default is OFF (*-nojoystick*).
+ Controls whether or not MAME makes use of joystick/gamepad controllers. When this is enabled, MAME will ask DirectInput about which controllers are connected. The default is OFF (**-nojoystick**).
.. _mame-commandline-nolightgun:
**-[no]lightgun** / **-[no]gun**
- Controls whether or not MAME makes use of lightgun controllers. Note that most lightguns map to the mouse, so using -lightgun and -mouse together may produce strange results. The default is OFF (*-nolightgun*).
+ Controls whether or not MAME makes use of lightgun controllers. Note that most lightguns map to the mouse, so using -lightgun and -mouse together may produce strange results. The default is OFF (**-nolightgun**).
.. _mame-commandline-nomultikeyboard:
**-[no]multikeyboard** / **-[no]multikey**
- Determines whether MAME differentiates between multiple keyboards. Some systems may report more than one keyboard; by default, the data from all of these keyboards is combined so that it looks like a single keyboard. Turning this option on will enable MAME to report keypresses on different keyboards independently. The default is OFF (*-nomultikeyboard*).
+ Determines whether MAME differentiates between multiple keyboards. Some systems may report more than one keyboard; by default, the data from all of these keyboards is combined so that it looks like a single keyboard. Turning this option on will enable MAME to report keypresses on different keyboards independently. The default is OFF (**-nomultikeyboard**).
.. _mame-commandline-nomultimouse:
**-[no]multimouse**
- Determines whether MAME differentiates between multiple mice. Some systems may report more than one mouse device; by default, the data from all of these mice is combined so that it looks like a single mouse. Turning this option on will enable MAME to report mouse movement and button presses on different mice independently. The default is OFF (*-nomultimouse*).
+ Determines whether MAME differentiates between multiple mice. Some systems may report more than one mouse device; by default, the data from all of these mice is combined so that it looks like a single mouse. Turning this option on will enable MAME to report mouse movement and button presses on different mice independently. The default is OFF (**-nomultimouse**).
.. _mame-commandline-nosteadykey:
**-[no]steadykey** / **-[no]steady**
- Some systems require two or more buttons to be pressed at exactly the same time to make special moves. Due to limitations in the keyboard hardware, it can be difficult or even impossible to accomplish that using the standard keyboard handling. This option selects a different handling that makes it easier to register simultaneous button presses, but has the disadvantage of making controls less responsive. The default is OFF (*-nosteadykey*)
+ Some systems require two or more buttons to be pressed at exactly the same time to make special moves. Due to limitations in the keyboard hardware, it can be difficult or even impossible to accomplish that using the standard keyboard handling. This option selects a different handling that makes it easier to register simultaneous button presses, but has the disadvantage of making controls less responsive. The default is OFF (**-nosteadykey**)
.. _mame-commandline-uiactive:
**-[no]ui_active**
- Enable user interface on top of emulated keyboard (if present). The default is OFF (*-noui_active*)
+ Enable user interface on top of emulated keyboard (if present). The default is OFF (**-noui_active**)
.. _mame-commandline-nooffscreenreload:
**-[no]offscreen_reload** / **-[no]reload**
- Controls whether or not MAME treats a second button input from a lightgun as a reload signal. In this case, MAME will report the gun's position as (0,MAX) with the trigger held, which is equivalent to an offscreen reload. This is only needed for games that required you to shoot offscreen to reload, and then only if your gun does not support off screen reloads. The default is OFF (*-nooffscreen_reload*).
+ Controls whether or not MAME treats a second button input from a lightgun as a reload signal. In this case, MAME will report the gun's position as (0,MAX) with the trigger held, which is equivalent to an offscreen reload. This is only needed for games that required you to shoot offscreen to reload, and then only if your gun does not support off screen reloads. The default is OFF (**-nooffscreen_reload**).
.. _mame-commandline-joystickmap:
**-joystick_map** *<map>* / **-joymap** *<map>*
- Controls how joystick values map to digital joystick controls. MAME accepts all joystick input from the system as analog data. For true analog joysticks, this needs to be mapped down to the usual 4-way or 8-way digital joystick values. To do this, MAME divides the analog range into a 9x9 grid. It then takes the joystick axis position (for X and Y axes only), maps it to this grid, and then looks up a translation from a joystick map. This parameter allows you to specify the map. The default is 'auto', which means that a standard 8-way, 4-way, or 4-way diagonal map is selected automatically based on the input port configuration of the current system.
+ Controls how joystick values map to digital joystick controls. MAME accepts all joystick input from the system as analog data. For true analog joysticks, this needs to be mapped down to the usual 4-way or 8-way digital joystick values. To do this, MAME divides the analog range into a 9x9 grid. It then takes the joystick axis position (for X and Y axes only), maps it to this grid, and then looks up a translation from a joystick map. This parameter allows you to specify the map. The default is ``auto``, which means that a standard 8-way, 4-way, or 4-way diagonal map is selected automatically based on the input port configuration of the current system.
Maps are defined as a string of numbers and characters. Since the grid is 9x9, there are a total of 81 characters necessary to define a complete map. Below is an example map for an 8-way joystick:
@@ -1231,19 +1232,19 @@ Core Input Options
**-joystick_deadzone** *<value>* / **-joy_deadzone** *<value>* / **-jdz** *<value>*
- If you play with an analog joystick, the center can drift a little. joystick_deadzone tells how far along an axis you must move before the axis starts to change. This option expects a float in the range of 0.0 to 1.0. Where 0 is the center of the joystick and 1 is the outer limit. The default is *0.3*.
+ If you play with an analog joystick, the center can drift a little. joystick_deadzone tells how far along an axis you must move before the axis starts to change. This option expects a float in the range of 0.0 to 1.0. Where 0 is the center of the joystick and 1 is the outer limit. The default is ``0.3``.
.. _mame-commandline-joysticksaturation:
**-joystick_saturation** *<value>* / **joy_saturation** *<value>* / **-jsat** *<value>*
- If you play with an analog joystick, the ends can drift a little, and may not match in the +/- directions. joystick_saturation tells how far along an axis movement change will be accepted before it reaches the maximum range. This option expects a float in the range of 0.0 to 1.0, where 0 is the center of the joystick and 1 is the outer limit. The default is *0.85*.
+ If you play with an analog joystick, the ends can drift a little, and may not match in the +/- directions. joystick_saturation tells how far along an axis movement change will be accepted before it reaches the maximum range. This option expects a float in the range of 0.0 to 1.0, where 0 is the center of the joystick and 1 is the outer limit. The default is ``0.85``.
.. _mame-commandline-natural:
**\-natural**
- Allows user to specify whether or not to use a natural keyboard or not. This allows you to start your system in a 'native' mode, depending on your region, allowing compatability for non-"QWERTY" style keyboards. The default is OFF (*-nonatural*)
+ Allows user to specify whether or not to use a natural keyboard or not. This allows you to start your system in a 'native' mode, depending on your region, allowing compatability for non-"QWERTY" style keyboards. The default is OFF (**-nonatural**)
In "emulated keyboard" mode (the default mode), MAME translates pressing/releasing host keys/buttons to emulated keystrokes. When you press/release a key/button mapped to an emulated key, MAME presses/releases the emulated key.
@@ -1262,13 +1263,13 @@ Core Input Options
**-joystick_contradictory**
- Enable contradictory direction digital joystick input at the same time such as **Left and Right** or **Up and Down** at the same time. The default is OFF (*-nojoystick_contradictory*)
+ Enable contradictory direction digital joystick input at the same time such as **Left and Right** or **Up and Down** at the same time. The default is OFF (**-nojoystick_contradictory**)
.. _mame-commandline-coinimpulse:
**-coin_impulse** *[n]*
- Set coin impulse time based on n (n<0 disable impulse, n==0 obey driver, 0<n set time n). Default is *0*.
+ Set coin impulse time based on n (n<0 disable impulse, n==0 obey driver, 0<n set time n). Default is ``0``.
@@ -1277,37 +1278,37 @@ Core Input Automatic Enable Options
.. _mame-commandline-paddledevice:
-**\-paddle_device** enable (none|keyboard|mouse|lightgun|joystick) if a paddle control is present
+**\-paddle_device** enable (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``) if a paddle control is present
.. _mame-commandline-adstickdevice:
-**\-adstick_device** enable (none|keyboard|mouse|lightgun|joystick) if an analog joystick control is present
+**\-adstick_device** enable (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``) if an analog joystick control is present
.. _mame-commandline-pedaldevice:
-**\-pedal_device** enable (none|keyboard|mouse|lightgun|joystick) if a pedal control is present
+**\-pedal_device** enable (``none``|``keyboard``|``mouse``|```lightgun``|``joystick``) if a pedal control is present
.. _mame-commandline-dialdevice:
-**\-dial_device** enable (none|keyboard|mouse|lightgun|joystick) if a dial control is present
+**\-dial_device** enable (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``) if a dial control is present
.. _mame-commandline-trackballdevice:
-**\-trackball_device** enable (none|keyboard|mouse|lightgun|joystick) if a trackball control is present
+**\-trackball_device** enable (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``) if a trackball control is present
.. _mame-commandline-lightgundevice:
-**\-lightgun_device** enable (none|keyboard|mouse|lightgun|joystick) if a lightgun control is present
+**\-lightgun_device** enable (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``) if a lightgun control is present
.. _mame-commandline-positionaldevice:
-**\-positional_device** enable (none|keyboard|mouse|lightgun|joystick) if a positional control is present
+**\-positional_device** enable (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``) if a positional control is present
.. _mame-commandline-mousedevice:
-**\-mouse_device** enable (none|keyboard|mouse|lightgun|joystick) if a mouse control is present
+**\-mouse_device** enable (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``) if a mouse control is present
- Each of these options controls autoenabling the mouse, joystick, or lightgun depending on the presence of a particular class of analog control for a particular system. For example, if you specify the option -paddle mouse, then any game that has a paddle control will automatically enable mouse controls just as if you had explicitly specified -mouse. Note that these controls override the values of -[no]mouse, -[no]joystick, etc.
+ Each of these options controls autoenabling the mouse, joystick, or lightgun depending on the presence of a particular class of analog control for a particular system. For example, if you specify the option **-paddle mouse**, then any game that has a paddle control will automatically enable mouse controls just as if you had explicitly specified **-mouse**. Note that these controls override the values of **-[no]mouse**, **-[no]joystick**, etc.
@@ -1318,37 +1319,37 @@ Debugging Options
**-[no]verbose** / **-[no]v**
- Displays internal diagnostic information. This information is very useful for debugging problems with your configuration. IMPORTANT: when reporting bugs, please run with **mame -verbose** and include the resulting information. The default is OFF (*-noverbose*).
+ Displays internal diagnostic information. This information is very useful for debugging problems with your configuration. IMPORTANT: when reporting bugs, please run with **mame -verbose** and include the resulting information. The default is OFF (**-noverbose**).
.. _mame-commandline-oslog:
**-[no]oslog**
- Output error.log data to the system debugger. The default is OFF (*-nooslog*).
+ Output error.log data to the system debugger. The default is OFF (**-nooslog**).
.. _mame-commandline-log:
**-[no]log**
- Creates a file called error.log which contains all of the internal log messages generated by the MAME core and system drivers. This can be used at the same time as -log to output the log data to both targets as well. The default is OFF (*-nolog*).
+ Creates a file called error.log which contains all of the internal log messages generated by the MAME core and system drivers. This can be used at the same time as **-log** to output the log data to both targets as well. The default is OFF (**-nolog**).
.. _mame-commandline-debug:
**-[no]debug**
- Activates the integrated debugger. By default, the debugger is entered by pressing the tilde (~) key during emulation. It is also entered immediately at startup. The default is OFF (*-nodebug*).
+ Activates the integrated debugger. By default, the debugger is entered by pressing the tilde (**~**) key during emulation. It is also entered immediately at startup. The default is OFF (**-nodebug**).
.. _mame-commandline-debugscript:
**-debugscript** *<filename>*
- Specifies a file that contains a list of debugger commands to execute immediately upon startup. The default is NULL (*no commands*).
+ Specifies a file that contains a list of debugger commands to execute immediately upon startup. The default is ``NULL`` (*no commands*).
.. _mame-commandline-updateinpause:
**-[no]update_in_pause**
- Enables updating of the main screen bitmap while the system is paused. This means that the VIDEO_UPDATE callback will be called repeatedly during pause, which can be useful for debugging. The default is OFF (*-noupdate_in_pause*).
+ Enables updating of the main screen bitmap while the system is paused. This means that the VIDEO_UPDATE callback will be called repeatedly during pause, which can be useful for debugging. The default is OFF (**-noupdate_in_pause**).
.. _mame-commandline-watchdog:
@@ -1362,9 +1363,9 @@ Debugging Options
Specifies the name of the font to use for debugger windows.
- The Windows default font is *Lucida Console*.
- The Mac (Cocoa) default font is system fixed-pitch font default (typically *Monaco*).
- The Qt default font is *Courier New*.
+ The Windows default font is ``Lucida Console``.
+ The Mac (Cocoa) default font is system fixed-pitch font default (typically ``Monaco``).
+ The Qt default font is ``Courier New``.
.. _mame-commandline-debuggerfontsize:
@@ -1372,8 +1373,8 @@ Debugging Options
Specifies the size of the font to use for debugger windows, in points.
- The Windows default size is *9* points.
- The Qt default size is *11* points.
+ The Windows default size is ``9`` points.
+ The Qt default size is ``11`` points.
The Mac (Cocoa) default size is the system default size.
@@ -1384,31 +1385,31 @@ Core Communication Options
**-comm_localhost** *<string>*
- Local address to bind to. This can be a traditional xxx.xxx.xxx.xxx address or a string containing a resolvable hostname. The default is value is "*0.0.0.0*"
+ Local address to bind to. This can be a traditional ``xxx.xxx.xxx.xxx`` address or a string containing a resolvable hostname. The default is value is "``0.0.0.0``"
.. _mame-commandline-commlocalport:
**-comm_localport** *<string>*
- Local port to bind to. This can be any traditional communications port as an unsigned 16-bit integer (0-65535). The default value is "*15122*".
+ Local port to bind to. This can be any traditional communications port as an unsigned 16-bit integer (0-65535). The default value is "``15122``".
.. _mame-commandline-commremotehost:
**-comm_remotehost** *<string>*
- Remote address to connect to. This can be a traditional xxx.xxx.xxx.xxx address or a string containing a resolvable hostname. The default is value is "*0.0.0.0*"
+ Remote address to connect to. This can be a traditional xxx.xxx.xxx.xxx address or a string containing a resolvable hostname. The default is value is "``0.0.0.0``"
.. _mame-commandline-commremoteport:
**-comm_remoteport** *<string>*
- Remote port to connect to. This can be any traditional communications port as an unsigned 16-bit integer (0-65535). The default value is "*15122*".
+ Remote port to connect to. This can be any traditional communications port as an unsigned 16-bit integer (0-65535). The default value is "``15122``".
.. _mame-commandline-commframesync:
**-[no]comm_framesync**
- Synchronize frames between the communications network. The default is OFF (*-nocomm_framesync*).
+ Synchronize frames between the communications network. The default is OFF (**-nocomm_framesync**).
@@ -1418,55 +1419,55 @@ Core Misc Options
.. _mame-commandline-drc:
**-[no]drc**
- Enable DRC (dynamic recompiler) CPU core if available for maximum speed. The default is ON (*-drc*).
+ Enable DRC (dynamic recompiler) CPU core if available for maximum speed. The default is ON (**-drc**).
.. _mame-commandline-drcusec:
**\-drc_use_c**
- Force DRC to use the C code backend. The default is OFF (*-nodrc_use_c*).
+ Force DRC to use the C code backend. The default is OFF (**-nodrc_use_c**).
.. _mame-commandline-drcloguml:
**\-drc_log_uml**
- Write DRC UML disassembly log. The default is OFF (*-nodrc_log_uml*).
+ Write DRC UML disassembly log. The default is OFF (**-nodrc_log_uml**).
.. _mame-commandline-drclognative:
**\-drc_log_native**
- write DRC native disassembly log. The default is OFF (*-nodrc_log_native*).
+ write DRC native disassembly log. The default is OFF (**-nodrc_log_native**).
.. _mame-commandline-bios:
**-bios** *<biosname>*
- Specifies the specific BIOS to use with the current system, for systems that make use of a BIOS. The **-listxml** output will list all of the possible BIOS names for a system. The default is '*default*'.
+ Specifies the specific BIOS to use with the current system, for systems that make use of a BIOS. The **-listxml** output will list all of the possible BIOS names for a system. The default is ``default``.
.. _mame-commandline-cheat:
**-[no]cheat** / **-[no]c**
- Activates the cheat menu with autofire options and other tricks from the cheat database, if present. The default is OFF (*-nocheat*).
+ Activates the cheat menu with autofire options and other tricks from the cheat database, if present. The default is OFF (**-nocheat**).
.. _mame-commandline-skipgameinfo:
**-[no]skip_gameinfo**
- Forces MAME to skip displaying the system info screen. The default is OFF (*-noskip_gameinfo*).
+ Forces MAME to skip displaying the system info screen. The default is OFF (**-noskip_gameinfo**).
.. _mame-commandline-uifont:
**-uifont** *<fontname>*
- Specifies the name of a font file to use for the UI font. If this font cannot be found or cannot be loaded, the system will fall back to its built-in UI font. On some platforms *fontname* can be a system font name instead of a BDF font file. The default is *default* (use the OSD-determined default font).
+ Specifies the name of a font file to use for the UI font. If this font cannot be found or cannot be loaded, the system will fall back to its built-in UI font. On some platforms *fontname* can be a system font name instead of a BDF font file. The default is ``default`` (use the OSD-determined default font).
.. _mame-commandline-ui:
**-ui** *<type>*
- Specifies the type of UI to use, either 'simple' or 'cabinet'. The default is Cabinet (*-ui cabinet*).
+ Specifies the type of UI to use, either ``simple`` or ``cabinet``. The default is Cabinet (**-ui cabinet**).
.. _mame-commandline-ramsize:
@@ -1478,25 +1479,25 @@ Core Misc Options
**\-confirm_quit**
- Display a Confirm Quit dialong to screen on exit, requiring one extra step to exit MAME. The default is OFF (*-noconfirm_quit*).
+ Display a Confirm Quit dialong to screen on exit, requiring one extra step to exit MAME. The default is OFF (**-noconfirm_quit**).
.. _mame-commandline-uimouse:
**\-ui_mouse**
- Displays a mouse cursor when using the built-in UI for MAME. The default is (*-noui_mouse*).
+ Displays a mouse cursor when using the built-in UI for MAME. The default is (**-noui_mouse**).
.. _mame-commandline-language:
**-language** *<language>*
- Specify a localization language found in the *languagepath* tree.
+ Specify a localization language found in the ``languagepath`` tree.
.. _mame-commandline-nvramsave:
**-[no]nvram_save**
- Save the NVRAM contents when exiting machine emulation. By turning this off, you can retain your previous NVRAM contents as any current changes made will not be saved. The default of ON (*-nvram_save*).
+ Save the NVRAM contents when exiting machine emulation. By turning this off, you can retain your previous NVRAM contents as any current changes made will not be saved. The default is ON (**-nvram_save**).
@@ -1509,7 +1510,7 @@ Scripting Options
Command string to execute after machine boot (in quotes " "). To issue a quote to the emulation, use """ in the string. Using **\\n** will issue a create a new line, issuing what was typed prior as a command.
- Example: -autoboot_command "load """$""",8,1\\n"
+ Example: **-autoboot_command "load """$""",8,1\\n"**
.. _mame-commandline-autobootdelay:
@@ -1527,13 +1528,13 @@ Scripting Options
**-[no]console**
- Enables emulator Lua Console window. The default of OFF (*-noconsole*).
+ Enables emulator Lua Console window. The default of OFF (**-noconsole**).
.. _mame-commandline-plugins:
**-plugins**
- Enable the use of Lua Plugins. The default is ON (*-plugins*).
+ Enable the use of Lua Plugins. The default is ON (**-plugins**).
.. _mame-commandline-plugin:
@@ -1555,16 +1556,16 @@ HTTP Server Options
**-[no]http**
- Enable HTTP server. The default is OFF (*-nohttp*).
+ Enable HTTP server. The default is OFF (**-nohttp**).
.. _mame-commandline-httpport:
**-http_port** *[port]*
- Choose HTTP server port. The default is *8080*.
+ Choose HTTP server port. The default is ``8080``.
.. _mame-commandline-httproot:
**-http_root** *[rootfolder]*
- Choose HTTP server document root. The default os *web*.
+ Choose HTTP server document root. The default is ``web``.
diff --git a/docs/source/commandline/sdlconfig.rst b/docs/source/commandline/sdlconfig.rst
index 09baeb85f3d..0da5f4c526e 100644
--- a/docs/source/commandline/sdlconfig.rst
+++ b/docs/source/commandline/sdlconfig.rst
@@ -23,13 +23,13 @@ Video Options
**-[no]centerh**
- Center horizontally within the view area. Default is ON (*-centerh*).
+ Center horizontally within the view area. Default is ON (**-centerh**).
.. _mame-scommandline-centerv:
**-[no]centerv**
- Center vertically within the view area. Default is ON (*-centerv*).
+ Center vertically within the view area. Default is ON (**-centerv**).
Video Soft-Specific Options
@@ -39,7 +39,7 @@ Video Soft-Specific Options
**-scalemode**
- Scale mode: none, async, yv12, yuy2, yv12x2, yuy2x2 (**-video soft** only). Default is '*none*'.
+ Scale mode: none, async, yv12, yuy2, yv12x2, yuy2x2 (**-video soft** only). Default is *none*.
SDL Keyboard Mapping
@@ -49,13 +49,13 @@ SDL Keyboard Mapping
**-keymap**
- Enable keymap. Default is OFF (*-nokeymap*)
+ Enable keymap. Default is OFF (**-nokeymap**)
.. _mame-scommandline-keymapfile:
**-keymap_file** *<file>*
-
- Keymap Filename. Default is '*keymap.dat*'.
+
+ Keymap Filename. Default is ``keymap.dat``.
SDL Joystick Mapping
@@ -77,7 +77,7 @@ Name of joystick mapped to a given joystick slot, default is *auto*.
**-sixaxis**
- Use special handling for PS3 SixAxis controllers. Default is OFF (*-nosixaxis*)
+ Use special handling for PS3 SixAxis controllers. Default is OFF (**-nosixaxis**)
SDL Low-level Driver Options
@@ -100,4 +100,3 @@ SDL Low-level Driver Options
**-gl_lib** *<driver>*
Alternative **libGL.so** to use; '*auto*' for system default
-
diff --git a/docs/source/commandline/windowsconfig.rst b/docs/source/commandline/windowsconfig.rst
index 81fcbc95807..85f555e9a21 100644
--- a/docs/source/commandline/windowsconfig.rst
+++ b/docs/source/commandline/windowsconfig.rst
@@ -28,25 +28,25 @@ Full screen options
**-[no]triplebuffer** / **-[no]tb**
- Enables or disables "triple buffering". Normally, MAME just draws directly to the screen, without any fancy buffering. But with this option enabled, MAME creates three buffers to draw to, and cycles between them in order. It attempts to keep things flowing such that one buffer is currently displayed, the second buffer is waiting to be displayed, and the third buffer is being drawn to. **-triplebuffer** will override **-waitvsync**, if the buffer is successfully created. This option does not work with **-video gdi**. The default is OFF (*-notriplebuffer*).
+ Enables or disables "triple buffering". Normally, MAME just draws directly to the screen, without any fancy buffering. But with this option enabled, MAME creates three buffers to draw to, and cycles between them in order. It attempts to keep things flowing such that one buffer is currently displayed, the second buffer is waiting to be displayed, and the third buffer is being drawn to. **-triplebuffer** will override **-waitvsync**, if the buffer is successfully created. This option does not work with **-video gdi**. The default is OFF (**-notriplebuffer**).
.. _mame-wcommandline-fullscreenbrightness:
**-full_screen_brightness** *<value>* / **-fsb** *<value>*
- Controls the brightness, or black level, of the entire display. The standard value is 1.0. Selecting lower values (down to 0.1) will produce a darkened display, while selecting higher values (up to 2.0) will give a brighter display. Note that not all video cards have hardware to support this option. This option does not work with **-video gdi**. The default is *1.0*.
+ Controls the brightness, or black level, of the entire display. The standard value is 1.0. Selecting lower values (down to 0.1) will produce a darkened display, while selecting higher values (up to 2.0) will give a brighter display. Note that not all video cards have hardware to support this option. This option does not work with **-video gdi**. The default is ``1.0``.
.. _mame-wcommandline-fullscreencontrast:
**-full_screen_contrast** *<value>* / **-fsc** *<value>*
- Controls the contrast, or white level, of the entire display. The standard value is 1.0. Selecting lower values (down to 0.1) will produce a dimmer display, while selecting higher values (up to 2.0) will give a more saturated display. Note that not all video cards have hardware to support this option. This option does not work with **-video gdi**. The default is *1.0*.
+ Controls the contrast, or white level, of the entire display. The standard value is 1.0. Selecting lower values (down to 0.1) will produce a dimmer display, while selecting higher values (up to 2.0) will give a more saturated display. Note that not all video cards have hardware to support this option. This option does not work with **-video gdi**. The default is ``1.0``.
.. _mame-wcommandline-fullscreengamma:
**-full_screen_gamma** *<value>* / **-fsg** *<value>*
- Controls the gamma, which produces a potentially nonlinear black to white ramp, for the entire display. The standard value is 1.0, which gives a linear ramp from black to white. Selecting lower values (down to 0.1) will increase the nonlinearity toward black, while selecting higher values (up to 3.0) will push the nonlinearity toward white. Note that not all video cards have hardware to support this option. This option does not work with **-video gdi**. The default is *1.0.*
+ Controls the gamma, which produces a potentially nonlinear black to white ramp, for the entire display. The standard value is 1.0, which gives a linear ramp from black to white. Selecting lower values (down to 0.1) will increase the nonlinearity toward black, while selecting higher values (up to 3.0) will push the nonlinearity toward white. Note that not all video cards have hardware to support this option. This option does not work with **-video gdi**. The default is ``1.0``.
@@ -57,4 +57,4 @@ Input device options
**-[no]dual_lightgun** / **-[no]dual**
- Controls whether or not MAME attempts to track two lightguns connected at the same time. This option requires -lightgun. This option is a hack for supporting certain older dual lightgun setups. If you have multiple lightguns connected, you will probably just need to enable -mouse and configure each lightgun independently. The default is *OFF* (*-nodual_lightgun*). \ No newline at end of file
+ Controls whether or not MAME attempts to track two lightguns connected at the same time. This option requires -lightgun. This option is a hack for supporting certain older dual lightgun setups. If you have multiple lightguns connected, you will probably just need to enable -mouse and configure each lightgun independently. The default is *OFF* (**-nodual_lightgun**).
diff --git a/docs/source/initialsetup/installingmame.rst b/docs/source/initialsetup/installingmame.rst
index 76aa4a51875..3ace07ade80 100644
--- a/docs/source/initialsetup/installingmame.rst
+++ b/docs/source/initialsetup/installingmame.rst
@@ -4,10 +4,10 @@ Installing MAME
Microsoft Windows
-----------------
-You simply have to download the latest binary archive available from http://www.mamedev.org and to extract its content to a folder. You will end up with many files (below you will find explanations about some of these), and in particular **MAME.EXE**. This is a command line program. The installation procedure ends here. Easy, isn't it?
+You simply have to download the latest binary archive available from http://www.mamedev.org and to extract its content to a folder. You will end up with many files (below you will find explanations about some of these), and in particular ``MAME.EXE``. This is a command line program. The installation procedure ends here. Easy, isn't it?
Other Operating Systems
-----------------------
-In this case, you can either look for pre-compiled (SDL)MAME binaries (e.g. in the repositories of your favorite Linux distro) which should simply extract all the needed files in a folder you choose, or compile the source code by yourself. In the latter case, see our section on :ref:`compiling-mame`.
+In this case, you can either look for pre-compiled (SDL)MAME binaries (e.g. in the repositories of your favorite Linux distro) which should simply extract all the needed files in a folder you choose, or compile the source code by yourself. In the latter case, see our section on :ref:`compiling-all`.