.. _universal-command-line:

Universal Commandline Options
=============================


This section contains configuration options that are applicable to *all* MAME sub-builds (both SDL and Windows native).


Commands and Verbs
------------------

Commands include **mame** itself as well as various tools included with the MAME distribution such as **romcmp** and **srcclean**.

Verbs are actions to take upon something with the command (e.g. **mame -validate pacman** has *mame* as a command and *-validate* as a verb)



Patterns
--------

Many verbs support the use of *patterns*, which are either a system or device short name (e.g. **a2600**, **zorba_kbd**) or a glob pattern that matches either (e.g. **zorba_\***)

Depending on the command you're using the pattern with, pattern matching may match systems or systems and devices. It is advised to put quotes around your patterns to avoid having your shell try to expand them against filenames. (e.g. **mame -validate "pac\*"**)



Core Verbs
----------

.. _mame-commandline-help:

**-help** / **-h** / **-?**

	Displays current MAME version and copyright notice.

.. _mame-commandline-validate:

**-validate** / **-valid** [*<pattern>*]

	Performs internal validation on one or more drivers and devices in the
	system. Run this before submitting changes to ensure that you haven't
	violated any of the core system rules.

	If a pattern is specified, it will validate systems matching
	the pattern, otherwise it will validate all systems and devices.



Configuration Verbs
-------------------

.. _mame-commandline-createconfig:

**-createconfig** / **-cc**

	Creates the default mame.ini file. All the configuration options
	(not verbs) described below can be permanently changed by editing
	this configuration file.

.. _mame-commandline-showconfig:

**-showconfig** / **-sc**

	Displays the current configuration settings. If you route this to a
	file, you can use it as an INI file. For example, the command:

		**mame -showconfig >mame.ini**

	is equivalent to **-createconfig**.

.. _mame-commandline-showusage:

**-showusage** / **-su**

	Displays a summary of all the command line options. For options that
	are not mentioned here, the short summary given by "mame -showusage"
	is usually sufficient.



Frontend Verbs
--------------

Note: By default, all the '**-list**' verbs below write info to the screen. If you wish to write the info to a textfile instead, add this to the end of your command:

  **> filename**

...where 'filename' is the textfile's path and name (e.g., list.txt).

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.
|

.. _mame-commandline-listxml:

**-listxml** / **-lx** [*<pattern>*]

	List comprehensive details for all of the supported systems and drivers. The output is quite long, so it is usually better to redirect this into a file. The output is in XML format. By default all systems are listed; however, you can limit this list by specifying a *pattern* after the -listxml command.

.. _mame-commandline-listfull:

**-listfull** / **-ll** [*<pattern>*]

	Displays a list of system driver names and descriptions. By default all systems and devices are listed; however, you can limit this list by specifying a *pattern* after the **-listfull** command.

.. _mame-commandline-listsource:

**-listsource** / **-ls** [<*pattern>*]

	Displays a list of drivers and the names of the source files their system drivers are defined in. Useful for finding which driver a system runs on in order to fix bugs. By default all systems are listed; however, you can limit this list by specifying a *pattern* after the **-listsource** command.

.. _mame-commandline-listclones:

**-listclones** / **-lc** [<*pattern*>]

	Displays a list of clones. By default all clones are listed; however, you can limit this list by specifying a driver name or wildcard after the **-listsource** command.

.. _mame-commandline-listbrothers:

**-listbrothers** / **-lb** [<*pattern*>]

	Displays a list of '*brothers*', or rather, other sets which are located in the same sourcefile as the system name searched for.

.. _mame-commandline-listcrc:

**-listcrc** [<*pattern*>]

	Displays a full list of CRCs of all ROM images referenced by the specified pattern of system or device names. If no pattern is specified, the results will be *all* systems and devices.

.. _mame-commandline-listroms:

**-listroms** / **-lr** [<*pattern*>]

	Displays a list of ROM images referenced by the specified pattern of system or device names. If no pattern is specified, the results will be *all* systems and devices.

.. _mame-commandline-listsamples:

**-listsamples** [<*pattern*>]

	Displays a list of samples referenced by the specified pattern of system or device names. If no pattern is specified, the results will be *all* systems and devices.

.. _mame-commandline-verifyroms:

**-verifyroms** [<*pattern*>]

	Checks for invalid or missing ROM images. By default all drivers that have valid ZIP files or directories in the rompath are verified; however, you can limit this list by specifying a *pattern* after the **-verifyroms** command.

.. _mame-commandline-verifysamples:

**-verifysamples** [<*pattern*>]

	Checks for invalid or missing samples. By default all drivers that have valid ZIP files or directories in the samplepath are verified; however, you can limit this list by specifying a *pattern* after the **-verifyroms** command.

.. _mame-commandline-romident:

**-romident** [*path\\to\\romstocheck.zip*]

	Attempts to identify ROM files, if they are known to MAME, in the specified .zip file or directory. This command can be used to try and identify ROM sets taken from unknown boards. On exit, the errorlevel is returned as one of the following:

		* 0: means all files were identified
		* 7: means all files were identified except for 1 or more "non-ROM" files
		* 8: means some files were identified
		* 9: means no files were identified

.. _mame-commandline-listdevices:

**-listdevices** / **-ld** [<*pattern*>]

        Displays a list of all devices known to be hooked up to a system. The ":" is considered the system itself with the devices list being attached to give the user a better understanding of what the emulation is using. If slots are populated with devices, any additional slots those devices provide will be visible with **-listdevices** as well. For instance, installing a floppy controller into a PC will expose the disk drive slots.

.. _mame-commandline-listslots:

**-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:

**-listmedia** / **-lm** [<*pattern*>]

        List available media that the chosen system allows to be used. This includes media types (cartridge, cassette, diskette and more) as well as common file extensions which are supported.

.. _mame-commandline-listsoftware:

**-listsoftware** / **-lsoft** [<*pattern*>]

        Posts to screen all software lists which can be used by the entered *pattern* or system. Note that this is simply a copy/paste of the .XML file which reside in the HASH folder which are allowed to be used.

.. _mame-commandline-verifysoftware:

**-verifysoftware** / **-vsoft** [<*pattern*>]

	Checks for invalid or missing ROM images in your software lists. By default all drivers that have valid ZIP files or directories in the rompath are verified; however, you can limit this list by specifying a specific driver name or *pattern* after the -verifysoftware command.

.. _mame-commandline-getsoftlist:

**-getsoftlist** / **-glist** [<*pattern*>]

        Posts to screen a specific software list which matches with the system name provided.

.. _mame-commandline-verifysoftlist:

**-verifysoftlist** / **-vlist** [softwarelistname]

	Checks a specified software list for missing ROM images if files exist for issued softwarelistname. By default, all drivers that have valid ZIP files or directories in the rompath are verified; however, you can limit this list by specifying a specific softwarelistname (without .XML) after the -verifysoftlist command.


.. _osd-commandline-options:

OSD-related Options
-------------------

.. _mame-commandline-uimodekey:

**-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).

.. _mame-commandline-uifontprovider:

**\-uifontprovider**

	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**.

	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
	
	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
	
	The default is *auto*. On Windows, auto will try rawinput with fallback to dinput. On SDL, auto will default to sdl.

.. _mame-commandline-lightgunprovider:

**\-lightgunprovider**

	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

	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.

.. _mame-commandline-joystickprovider:

**\-joystickprovider**

	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
	
	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.



OSD CLI Options
---------------

.. _mame-commandline-listmidi:

**\-listmidi**

    Create a list of available MIDI I/O devices for use with emulation.

.. _mame-commandline-listnetwork:

**\-listnetwork**

	Create a list of available Network Adapters for use with emulation.



OSD Output Options
------------------

.. _mame-commandline-output:

**\-output**

	Chooses how MAME will handle processing of output notifiers.
	
	you can choose from: auto, none, console or network
	
	Note that network port is fixed at 8000.



Configuration Options
---------------------

.. _mame-commandline-noreadconfig:

**-[no]readconfig** / **-[no]rc**

	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)
		- horizont.ini   (for systems with horizontal monitor orientation)
		- arcade.ini     (for systems in source added with GAME() macro)
		- console.ini    (for systems in source added with CONS() macro)
		- computer.ini   (for systems in source added with COMP() macro)
		- othersys.ini   (for systems in source added with SYST() macro)
		- vector.ini     (for vector systems only)
		- <parent>.ini   (for clones only, may be called recursively)
		- <systemname>.ini

        (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*).



Core Search Path Options
------------------------

.. _mame-commandline-homepath:

**-homepath** *<path>*

	Specifies a path where the base 'plugins' folder is to be found. The default is '.' (that is, in the current working directory).

.. _mame-commandline-rompath:

**-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).

.. _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).

.. _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).

.. _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).

.. _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).

.. _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).

.. _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).

.. _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).

.. _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.

.. _mame-commandline-pluginspath:

**-pluginspath** *<path>*

	Specifies a list of paths within which to find Lua plugins for MAME.

.. _mame-commandline-languagepath:

**-languagepath** *<path>*

	Specifies a list of paths within which to find language files for localized UI text.

.. _mame-commandline-swpath:

**-swpath** *<path>*

	Specifies a path within which to find loose software to be used by emulation.
	

Core Output Directory Options
-----------------------------

.. _mame-commandline-cfgdirectory:

**-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.

.. _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.

.. _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.

.. _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.

.. _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.

.. _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.

.. _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.



Core State/Playback Options
---------------------------

.. _mame-commandline-norewind:

**-[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.
	
.. _mame-commandline-rewindcapacity:

**-rewind_capacity** *<value>*

	Sets the rewind capacity value, in megabytes. It is the total amount of memory rewind savestates can occupy. When capacity is hit, old savestates get erased as new ones are captured. Setting capacity lower than the current savestate size disables rewind. Values below 0 are automatically clamped to 0.

.. _mame-commandline-state:

**-state** *<slot>*

	Immediately after starting the specified system, will cause the save state in the specified <slot> to be loaded.

.. _mame-commandline-noautosave:

**-[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).

.. _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).

.. _mame-commandline-exitafterplayback:

**-exit_after_playback**

	Tells MAME to exit after finishing playback of the input file.

.. _mame-commandline-record:

**-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).

.. _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.

.. _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).

.. _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).

.. _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).

.. _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'.

.. _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*'.

.. _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*'.

.. _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*).

.. _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\\'.

.. _mame-commandline-noburnin:

**-[no]burnin**

	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*).



Core Performance Options
------------------------

.. _mame-commandline-noautoframeskip:

**-[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*).

.. _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.

.. _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.

.. _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*).

.. _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*).

.. _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.

.. _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*).

.. _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*".

.. _mame-commandline-bench:

**-bench** *[n]*

        Benchmark for *[n]* number of emulated seconds; implies the command string:

        **-str [n] -video none -sound none -nothrottle**



Core Rotation Options
---------------------

.. _mame-commandline-norotate:

| **-[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*).
|
|

.. _mame-commandline-noror:

.. _mame-commandline-norol:

| **-[no]ror**
| **-[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*).
|
|

.. _mame-commandline-noautoror:

.. _mame-commandline-noautorol:


| **-[no]autoror**
| **-[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**.
|
|

.. _mame-commandline-noflipx:

.. _mame-commandline-noflipy:


| **-[no]flipx**
| **-[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*).
|
|


Core Video Options
------------------

.. _mame-commandline-video:

**-video** *<bgfx|gdi|d3d|opengl|soft|accel|none>*

|
|   Specifies which video subsystem to use for drawing. Options here depend on the operating system and whether this is an SDL-compiled version of MAME.
|
|   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.
|
|   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.
|
|   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.
|
|   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*'.
|

.. _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*.

.. _mame-commandline-window:

**-[no]window** / **-[no]w**

	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*).

.. _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*).

	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.

.. _mame-commandline-waitvsync:

**-[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*).

	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.

.. _mame-commandline-syncrefresh:

**-[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*).

.. _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*.

	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*).

	This is supported with all video output types (bgfx, d3d, etc) on Windows and is **ONLY** supported with OpenGL on other platforms.

.. _mame-commandline-unevenstretch:

**-[no]unevenstretch**

	Allow non-integer stretch factors allowing for great window sizing flexability. The default is ON. (*-unevenstretch*)


Core Full Screen Options
------------------------

.. _mame-commandline-switchres:

**-[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*).


Core Per-Window Options
-----------------------

.. _mame-commandline-screen:

NOTE:  **Multiple Screens may fail to work correctly on some Mac machines as of right now.**

| **-screen** *<display>*
| **-screen0** *<display>*
| **-screen1** *<display>*
| **-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.
|
|	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.
|
|


.. _mame-commandline-aspect:

| **-aspect** *<width:height>* / **-screen_aspect** *<num:den>*
| **-aspect0** *<width:height>*
| **-aspect1** *<width:height>*
| **-aspect2** *<width:height>*
| **-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.
|
|	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.
|
|


.. _mame-commandline-resolution:

| **-resolution** *<widthxheight[@refresh]>* / **-r** *<widthxheight[@refresh]>*
| **-resolution0** *<widthxheight[@refresh]>* / **-r0** *<widthxheight[@refresh]>*
| **-resolution1** *<widthxheight[@refresh]>* / **-r1** *<widthxheight[@refresh]>*
| **-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*'.
|
|	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.
|
|


.. _mame-commandline-view:

| **-view** *<viewname>*
| **-view0** *<viewname>*
| **-view1** *<viewname>*
| **-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*'.
|
|	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.
|
|


Core Artwork Options
--------------------

.. _mame-commandline-noartworkcrop:

**-[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*).

.. _mame-commandline-nousebackdrops:

**-[no]use_backdrops** / **-[no]backdrop**

	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*).

.. _mame-commandline-nousebezels:

**-[no]use_bezels** / **-[no]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*).

.. _mame-commandline-nousemarquees:

**-[no]use_marquees** / **-[no]marquees**

	Enables/disables the display of marquees. The default is ON (*-use_marquees*).

.. _mame-commandline-fallbackartwork:

**-fallback_artwork**

	Specifies fallback artwork if no external artwork or internal driver layout is defined.

.. _mame-commandline-overrideartwork:

**-override_artwork**

	Specifies override artwork for external artwork and internal driver layout.



Core Screen Options
-------------------

.. _mame-commandline-brightness:

**-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*.

.. _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*.

.. _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*.

.. _mame-commandline-pausebrightness:

**-pause_brightness** *<value>*

	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.



Core Vector Options
-------------------

.. _mame-commandline-beamwidthmin:

**-beam_width_min** *<width>*

	Sets the vector beam minimum width.

.. _mame-commandline-beamwidthmax:

**-beam_width_max** *<width>*

	Sets the vector beam maximum width.

.. _mame-commandline-beamintensityweight:

**-beam_intensity_weight** *<weight>*

	Sets the vector beam intensity weight.

.. _mame-commandline-flicker:

**-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*.



Core Video OpenGL Debugging Options
-----------------------------------

These options are for compatibility in **-video opengl**. If you report rendering artifacts you may be asked to try messing with them by the devs, but normally they should be left at their defaults which results in the best possible video performance.

.. _mame-commandline-glforcepow2texture:

**-[no]gl_forcepow2texture**

	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*)

.. _mame-commandline-glvbo:

**-[no]gl_vbo**

    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*)


Core Video OpenGL GLSL Options
------------------------------


.. _mame-commandline-glglsl:

**-gl_glsl**

	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*)

.. _mame-commandline-glslshadermame:

|
| **-glsl_shader_mame0**
| **-glsl_shader_mame1**
| ...
| **-glsl_shader_mame9**
|

	Custom OpenGL GLSL shader set MAME bitmap in the provided slot (0-9); one can be applied to each slot.

	[todo: better details on usage at some point. See http://forums.bannister.org/ubbthreads.php?ubb=showflat&Number=100988#Post100988 ]



.. _mame-commandline-glslshaderscreen:

|
| **-glsl_shader_screen0**
| **-glsl_shader_screen1**
| ...
| **-glsl_shader_screen9**
|

	Custom OpenGL GLSL shader screen bitmap in the provided slot (0-9).

	[todo: better details on usage at some point. See http://forums.bannister.org/ubbthreads.php?ubb=showflat&Number=100988#Post100988 ]


.. _mame-commandline-glglslvidattr:

**-gl_glsl_vid_attr**

	Enable OpenGL GLSL handling of brightness and contrast. Better RGB system performance.  Default is *on*.


Core Sound Options
------------------

.. _mame-commandline-samplerate:

**-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*.

.. _mame-commandline-nosamples:

**-[no]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*.

.. _mame-commandline-sound:

**-sound** *<dsound|sdl|coreaudio|xaudio|portaudio|none>*

	Specifies which sound subsystem to use. '*none*' disables sound altogether.

	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.

.. _mame-commandline-audiolatency:

**-audio_latency** *<value>*

	This controls the amount of latency built into the audio streaming. By default MAME tries to keep the DirectSound audio buffer between 1/5 and 2/5 full. On some systems, this is pushing it too close to the edge, and you get poor sound sometimes. The latency parameter controls the lower threshold. The default is *1* (meaning lower=1/5 and upper=2/5). Set it to 2 (**-audio_latency 2**) to keep the sound buffer between 2/5 and 3/5 full. If you crank it up to 4, you can *definitely* notice audio lag.



Core Input Options
------------------

.. _mame-commandline-nocoinlockout:

**-[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*).

.. _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).

.. _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*).

.. _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*).

.. _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*).

.. _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*).

.. _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*).

.. _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*)

.. _mame-commandline-uiactive:

**-[no]ui_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*).

.. _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.

	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:

		+-------------+---------------------------------------------------------+
		| | 777888999 |                                                         |
		| | 777888999 | | Note that the numeric digits correspond to the keys   |
		| | 777888999 | | on a numeric keypad. So '7' maps to up+left, '4' maps |
		| | 444555666 | | to left, '5' maps to neutral, etc. In addition to the |
		| | 444555666 | | numeric values, you can specify the character 's',    |
		| | 444555666 | | which means "sticky". In this case, the value of the  |
		| | 111222333 | | map is the same as it was the last time a non-sticky  |
		| | 111222333 | | value was read.                                       |
		| | 111222333 |                                                         |
		+-------------+---------------------------------------------------------+

	To specify the map for this parameter, you can specify a string of rows separated by a '.' (which indicates the end of a row), like so:

 +-------------------------------------------------------------------------------------------+
 | 777888999.777888999.777888999.444555666.444555666.444555666.111222333.111222333.111222333 |
 +-------------------------------------------------------------------------------------------+

	However, this can be reduced using several shorthands supported by the <map> parameter. If information about a row is missing, then it is assumed that any missing data in columns 5-9 are left/right symmetric with data in columns 0-4; and any missing data in columns 0-4 is assumed to be copies of the previous data. The same logic applies to missing rows, except that up/down symmetry is assumed.

	By using these shorthands, the 81 character map can be simply specified by this 11 character string: 7778...4445

	Looking at the first row, 7778 is only 4 characters long. The 5th entry can't use symmetry, so it is assumed to be equal to the previous character '8'. The 6th character is left/right symmetric with the 4th character, giving an '8'. The 7th character is left/right symmetric with the 3rd character, giving a '9' (which is '7' with left/right flipped). Eventually this gives the full 777888999 string of the row.

	The second and third rows are missing, so they are assumed to be identical to the first row. The fourth row decodes similarly to the first row, producing 444555666. The fifth row is missing so it is assumed to be the same as the fourth.

	The remaining three rows are also missing, so they are assumed to be the up/down mirrors of the first three rows, giving three final rows of 111222333.

.. _mame-commandline-joystickdeadzone:

**-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*.

.. _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*.

.. _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*)

	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.

	In "natural keyboard" mode, MAME attempts to translate characters to keystrokes. The OS translates keystrokes to characters (similarly when you type into a text editor), and MAME attempts to translate these characters to emulated keystrokes.

	**There are a number of unavoidable limitations in "natural keyboard" mode:**

	* The emulated system driver and/or keyboard device or has to support it.
	* The selected keyboard *must* match the keyboard layout selected in the emulated OS!
	* Keystrokes that don't produce characters can't be translated. (e.g. pressing a modifier on its own such as **shift**, **ctrl**, or **alt**)
	* Holding a key until the character repeats will cause the emulated key to be pressed repeatedly as opposed to being held down.
	* Dead key sequences are cumbersome to use at best.
	* It won't work at all if IME edit is involved. (e.g. for Chinese/Japanese/Korean)

.. _mame-commandline-joystickcontradictory:

**-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*)

.. _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*.



Core Input Automatic Enable Options
-----------------------------------

.. _mame-commandline-paddledevice:

**\-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

.. _mame-commandline-pedaldevice:

**\-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

.. _mame-commandline-trackballdevice:

**\-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

.. _mame-commandline-positionaldevice:

**\-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

	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.



Debugging Options
-----------------

.. _mame-commandline-verbose:

**-[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*).

.. _mame-commandline-oslog:

**-[no]oslog**

	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*).

.. _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*).

.. _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*).

.. _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*).

.. _mame-commandline-watchdog:

**-watchdog** *<duration>* / **-wdog** *<duration>*

	Enables an internal watchdog timer that will automatically kill the MAME process if more than *<duration>* seconds passes without a frame update. Keep in mind that some systems sit for a while during load time without updating the screen, so *<duration>* should be long enough to cover that. 10-30 seconds on a modern system should be plenty in general. By default there is no watchdog.

.. _mame-commandline-debuggerfont:

**-debugger_font** *<fontname>* / **-dfont** *<fontname>*

	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*.

.. _mame-commandline-debuggerfontsize:

**-debugger_font_size** *<points>* / **-dfontsize** *<points>*

	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 Mac (Cocoa) default size is the system default size.


Core Communication Options
--------------------------

.. _mame-commandline-commlocalhost:

**-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*"

.. _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*".

.. _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*"

.. _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*".

.. _mame-commandline-commframesync:

**-[no]comm_framesync**

	Synchronize frames between the communications network. The default is OFF (*-nocomm_framesync*).



Core Misc Options
-----------------

.. _mame-commandline-drc:

**-[no]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*).

.. _mame-commandline-drcloguml:

**\-drc_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*).

.. _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*'.

.. _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*).

.. _mame-commandline-skipgameinfo:

**-[no]skip_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).

.. _mame-commandline-ui:

**-ui** *<type>*

	Specifies the type of UI to use, either 'simple' or 'cabinet'.  The default is Cabinet (*-ui cabinet*).

.. _mame-commandline-ramsize:

**-ramsize** *[n]*

	Allows you to change the default RAM size (if supported by driver).

.. _mame-commandline-confirmquit:

**\-confirm_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*).

.. _mame-commandline-language:

**-language** *<language>*

	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*).



Scripting Options
-----------------

.. _mame-commandline-autobootcommand:

**-autoboot_command** *"<command>"*

	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"

.. _mame-commandline-autobootdelay:

**-autoboot_delay** *[n]*

	Timer delay (in seconds) to trigger command execution on autoboot.

.. _mame-commandline-autobootscript:

**-autoboot_script** / **-script** *[filename.lua]*

	File containing scripting to execute after machine boot.

.. _mame-commandline-console:

**-[no]console**

	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*).

.. _mame-commandline-plugin:

**-plugin** *[plugin shortname]*

	A list of Lua Plugins to enable, comma separated.

.. _mame-commandline-noplugin:

**-noplugin** *[plugin shortname]*

	A list of Lua Plugins to disable, comma separated.



HTTP Server Options
-------------------
.. _mame-commandline-http:

**-[no]http**

	Enable HTTP server. The default is OFF (*-nohttp*).

.. _mame-commandline-httpport:

**-http_port** *[port]*

	Choose HTTP server port. The default is *8080*.

.. _mame-commandline-httproot:

**-http_root** *[rootfolder]*

	Choose HTTP server document root. The default os *web*.
