diff options
Diffstat (limited to 'docs/source/commandline/commandline-index.rst')
-rw-r--r-- | docs/source/commandline/commandline-index.rst | 400 |
1 files changed, 400 insertions, 0 deletions
diff --git a/docs/source/commandline/commandline-index.rst b/docs/source/commandline/commandline-index.rst new file mode 100644 index 00000000000..267c82e8aad --- /dev/null +++ b/docs/source/commandline/commandline-index.rst @@ -0,0 +1,400 @@ +.. _index-commandline: + +Commandline Index +================= + +This is a complete index of all commandline options and commands for MAME, suitable for quickly finding a given command. + +Universal Commandline Options +----------------------------- + +This section contains configuration options that are applicable to *all* MAME sub-builds (both SDL and Windows native). + + +Core Commands +~~~~~~~~~~~~~ + +| :ref:`help <mame-commandline-help>` +| :ref:`validate <mame-commandline-validate>` + + +Configuration Commands +~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`createconfig <mame-commandline-createconfig>` +| :ref:`showconfig <mame-commandline-showconfig>` +| :ref:`showusage <mame-commandline-showusage>` + + +Frontend Commands +~~~~~~~~~~~~~~~~~ + +| :ref:`listxml <mame-commandline-listxml>` +| :ref:`listfull <mame-commandline-listfull>` +| :ref:`listsource <mame-commandline-listsource>` +| :ref:`listclones <mame-commandline-listclones>` +| :ref:`listbrothers <mame-commandline-listbrothers>` +| :ref:`listcrc <mame-commandline-listcrc>` +| :ref:`listroms <mame-commandline-listroms>` +| :ref:`listsamples <mame-commandline-listsamples>` +| :ref:`verifyroms <mame-commandline-verifyroms>` +| :ref:`verifysamples <mame-commandline-verifysamples>` +| :ref:`romident <mame-commandline-romident>` +| :ref:`listdevices <mame-commandline-listdevices>` +| :ref:`listslots <mame-commandline-listslots>` +| :ref:`listmedia <mame-commandline-listmedia>` +| :ref:`listsoftware <mame-commandline-listsoftware>` +| :ref:`verifysoftware <mame-commandline-verifysoftware>` +| :ref:`getsoftlist <mame-commandline-getsoftlist>` +| :ref:`verifysoftlist <mame-commandline-verifysoftlist>` + + +OSD-related Options +~~~~~~~~~~~~~~~~~~~ + +| :ref:`uimodekey <mame-commandline-uimodekey>` +| :ref:`uifontprovider <mame-commandline-uifontprovider>` +| :ref:`menu <mame-commandline-menu>` +| :ref:`keyboardprovider <mame-commandline-keyboardprovider>` +| :ref:`mouseprovider <mame-commandline-mouseprovider>` +| :ref:`lightgunprovider <mame-commandline-lightgunprovider>` +| :ref:`joystickprovider <mame-commandline-joystickprovider>` + + +OSD CLI Options +~~~~~~~~~~~~~~~ + +| :ref:`listmidi <mame-commandline-listmidi>` +| :ref:`listnetwork <mame-commandline-listnetwork>` + + +OSD Output Options +~~~~~~~~~~~~~~~~~~ + +| :ref:`output <mame-commandline-output>` + + +Configuration Options +~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`noreadconfig <mame-commandline-noreadconfig>` + + +Core Search Path Options +~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`rompath <mame-commandline-rompath>` +| :ref:`hashpath <mame-commandline-hashpath>` +| :ref:`samplepath <mame-commandline-samplepath>` +| :ref:`artpath <mame-commandline-artpath>` +| :ref:`ctrlrpath <mame-commandline-ctrlrpath>` +| :ref:`inipath <mame-commandline-inipath>` +| :ref:`fontpath <mame-commandline-fontpath>` +| :ref:`cheatpath <mame-commandline-cheatpath>` +| :ref:`crosshairpath <mame-commandline-crosshairpath>` +| :ref:`pluginspath <mame-commandline-pluginspath>` +| :ref:`languagepath <mame-commandline-languagepath>` + + +Core Output Directory Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`cfg_directory <mame-commandline-cfgdirectory>` +| :ref:`nvram_directory <mame-commandline-nvramdirectory>` +| :ref:`input_directory <mame-commandline-inputdirectory>` +| :ref:`state_directory <mame-commandline-statedirectory>` +| :ref:`snapshot_directory <mame-commandline-snapshotdirectory>` +| :ref:`diff_directory <mame-commandline-diffdirectory>` +| :ref:`comment_directory <mame-commandline-commentdirectory>` + + +Core State/Playback Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]rewind / rewind<mame-commandline-norewind>` +| :ref:`rewind_capacity <mame-commandline-rewindcapacity>` +| :ref:`state <mame-commandline-state>` +| :ref:`[no]autosave <mame-commandline-noautosave>` +| :ref:`playback <mame-commandline-playback>` +| :ref:`exit_after_playback <mame-commandline-exitafterplayback>` +| :ref:`record <mame-commandline-record>` +| :ref:`record_timecode <mame-commandline-recordtimecode>` +| :ref:`mngwrite <mame-commandline-mngwrite>` +| :ref:`aviwrite <mame-commandline-aviwrite>` +| :ref:`wavwrite <mame-commandline-wavwrite>` +| :ref:`snapname <mame-commandline-snapname>` +| :ref:`snapsize <mame-commandline-snapsize>` +| :ref:`snapview <mame-commandline-snapview>` +| :ref:`[no]snapbilinear <mame-commandline-nosnapbilinear>` +| :ref:`statename <mame-commandline-statename>` +| :ref:`[no]burnin <mame-commandline-noburnin>` + + +Core Performance Options +~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]autoframeskip <mame-commandline-noautoframeskip>` +| :ref:`frameskip <mame-commandline-frameskip>` +| :ref:`seconds_to_run <mame-commandline-secondstorun>` +| :ref:`[no]throttle <mame-commandline-nothrottle>` +| :ref:`[no]sleep <mame-commandline-nosleep>` +| :ref:`speed <mame-commandline-speed>` +| :ref:`[no]refreshspeed <mame-commandline-norefreshspeed>` +| :ref:`numprocessors <mame-commandline-numprocessors>` +| :ref:`bench <mame-commandline-bench>` + + +Core Rotation Options +~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]rotate <mame-commandline-norotate>` +| :ref:`[no]ror <mame-commandline-noror>` +| :ref:`[no]rol <mame-commandline-norol>` +| :ref:`[no]autoror <mame-commandline-noautoror>` +| :ref:`[no]autorol <mame-commandline-noautorol>` +| :ref:`[no]flipx <mame-commandline-noflipx>` +| :ref:`[no]flipy <mame-commandline-noflipy>` + + +Core Video Options +~~~~~~~~~~~~~~~~~~ + +| :ref:`video <mame-commandline-video>` +| :ref:`numscreens <mame-commandline-numscreens>` +| :ref:`[no]window <mame-commandline-window>` +| :ref:`[no]maximize <mame-commandline-maximize>` +| :ref:`[no]keepaspect <mame-commandline-keepaspect>` +| :ref:`[no]waitvsync <mame-commandline-waitvsync>` +| :ref:`[no]syncrefresh <mame-commandline-syncrefresh>` +| :ref:`prescale <mame-commandline-prescale>` +| :ref:`[no]filter <mame-commandline-filter>` +| :ref:`[no]unevenstretch <mame-commandline-unevenstretch>` + + +Core Full Screen Options +~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]switchres <mame-commandline-switchres>` + + +Core Per-Window Video Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`screen <mame-commandline-screen>` +| :ref:`aspect <mame-commandline-aspect>` +| :ref:`resolution <mame-commandline-resolution>` +| :ref:`view <mame-commandline-view>` + + +Core Artwork Options +~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]artwork_crop <mame-commandline-noartworkcrop>` +| :ref:`[no]use_backdrops <mame-commandline-nousebackdrops>` +| :ref:`[no]use_overlays <mame-commandline-nouseoverlays>` +| :ref:`[no]use_bezels <mame-commandline-nousebezels>` +| :ref:`[no]use_cpanels <mame-commandline-nousecpanels>` +| :ref:`[no]use_marquees <mame-commandline-nousemarquees>` + + +Core Screen Options +~~~~~~~~~~~~~~~~~~~ + +| :ref:`brightness <mame-commandline-brightness>` +| :ref:`contrast <mame-commandline-contrast>` +| :ref:`gamma <mame-commandline-gamma>` +| :ref:`pause_brightness <mame-commandline-pausebrightness>` +| :ref:`effect <mame-commandline-effect>` + + +Core Vector Options +~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]antialias <mame-commandline-noantialias>` +| :ref:`beam <mame-commandline-beam>` +| :ref:`flicker <mame-commandline-flicker>` + + +Core Sound Options +~~~~~~~~~~~~~~~~~~ + + +| :ref:`samplerate <mame-commandline-samplerate>` +| :ref:`[no]samples <mame-commandline-nosamples>` +| :ref:`volume <mame-commandline-volume>` +| :ref:`sound <mame-commandline-sound>` +| :ref:`audio_latency <mame-commandline-audiolatency>` + + +Core Input Options +~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]coin_lockout <mame-commandline-nocoinlockout>` +| :ref:`ctrlr <mame-commandline-ctrlr>` +| :ref:`[no]mouse <mame-commandline-nomouse>` +| :ref:`[no]joystick <mame-commandline-nojoystick>` +| :ref:`[no]lightgun <mame-commandline-nolightgun>` +| :ref:`[no]multikeyboard <mame-commandline-nomultikeyboard>` +| :ref:`[no]multimouse <mame-commandline-nomultimouse>` +| :ref:`[no]steadykey <mame-commandline-nosteadykey>` +| :ref:`[no]ui_active <mame-commandline-uiactive>` +| :ref:`[no]offscreen_reload <mame-commandline-nooffscreenreload>` +| :ref:`joystick_map <mame-commandline-joystickmap>` +| :ref:`joystick_deadzone <mame-commandline-joystickdeadzone>` +| :ref:`joystick_saturation <mame-commandline-joysticksaturation>` +| :ref:`natural <mame-commandline-natural>` +| :ref:`joystick_contradictory <mame-commandline-joystickcontradictory>` +| :ref:`coin_impulse <mame-commandline-coinimpulse>` + + +Core Input Automatic Enable Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`paddle_device <mame-commandline-paddledevice>` +| :ref:`adstick_device <mame-commandline-adstickdevice>` +| :ref:`pedal_device <mame-commandline-pedaldevice>` +| :ref:`dial_device <mame-commandline-dialdevice>` +| :ref:`trackball_device <mame-commandline-trackballdevice>` +| :ref:`lightgun_device <mame-commandline-lightgundevice>` +| :ref:`positional_device <mame-commandline-positionaldevice>` +| :ref:`mouse_device <mame-commandline-mousedevice>` + + +Core Debugging Options +~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]verbose <mame-commandline-verbose>` +| :ref:`[no]oslog <mame-commandline-oslog>` +| :ref:`[no]log <mame-commandline-log>` +| :ref:`[no]debug <mame-commandline-debug>` +| :ref:`debugscript <mame-commandline-debugscript>` +| :ref:`[no]update_in_pause <mame-commandline-updateinpause>` +| :ref:`watchdog <mame-commandline-watchdog>` + + +Core Communication Options +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`comm_localhost <mame-commandline-commlocalhost>` +| :ref:`comm_localport <mame-commandline-commlocalport>` +| :ref:`comm_remotehost <mame-commandline-commremotehost>` +| :ref:`comm_remoteport <mame-commandline-commremoteport>` + + +Core Misc Options +~~~~~~~~~~~~~~~~~ + +| :ref:`[no]drc <mame-commandline-drc>` +| :ref:`drc_use_c <mame-commandline-drcusec>` +| :ref:`drc_log_uml <mame-commandline-drcloguml>` +| :ref:`drc_log_native <mame-commandline-drclognative>` +| :ref:`bios <mame-commandline-bios>` +| :ref:`[no]cheat <mame-commandline-cheat>` +| :ref:`[no]skip_gameinfo <mame-commandline-skipgameinfo>` +| :ref:`uifont <mame-commandline-uifont>` +| :ref:`ramsize <mame-commandline-ramsize>` +| :ref:`confirm_quit <mame-commandline-confirmquit>` +| :ref:`ui_mouse <mame-commandline-uimouse>` +| :ref:`autoboot_command <mame-commandline-autobootcommand>` +| :ref:`autoboot_delay <mame-commandline-autobootdelay>` +| :ref:`autoboot_script <mame-commandline-autobootscript>` +| :ref:`language <mame-commandline-language>` + + +Windows-Specific Commandline Options +------------------------------------ + +Windows Debugging options +~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`debugger_font <mame-wcommandline-debuggerfont>` +| :ref:`debugger_font_size <mame-wcommandline-debuggerfontsize>` + + +Windows Performance Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`priority <mame-wcommandline-priority>` +| :ref:`profile <mame-wcommandline-profile>` + + +Windows Full Screen Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]triplebuffer <mame-wcommandline-triplebuffer>` +| :ref:`full_screen_brightness <mame-wcommandline-fullscreenbrightness>` +| :ref:`full_screen_contrast <mame-wcommandline-fullscreencontrast>` +| :ref:`full_screen_gamma <mame-wcommandline-fullscreengamma>` + + +Windows Input Device Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]dual_lightgun <mame-wcommandline-duallightgun>` + + +SDL-Specific Commandline Options +-------------------------------- + +This section contains configuration options that are specific to any build supported by SDL (including Windows where compiled as SDL instead of native). + + +SDL Performance Options +~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`sdlvideofps <mame-scommandline-sdlvideofps>` + + +SDL Video Options +~~~~~~~~~~~~~~~~~ + +| :ref:`[no]centerh <mame-scommandline-centerh>` +| :ref:`[no]centerv <mame-scommandline-centerv>` + + +SDL Video Soft-Specific Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`scalemode <mame-scommandline-scalemode>` + + +SDL Video OpenGL Debugging Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]gl_forcepow2texture <mame-scommandline-glforcepow2texture>` +| :ref:`[no]gl_notexturerect <mame-scommandline-glnotexturerect>` +| :ref:`[no]gl_vbo <mame-scommandline-glvbo>` +| :ref:`[no]gl_pbo <mame-scommandline-glpbo>` + + +SDL Video OpenGL GLSL Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`gl_glsl <mame-scommandline-glglsl>` +| :ref:`gl_glsl_filter <mame-scommandline-glglslfilter>` +| :ref:`glsl_shader_mame[0-9] <mame-scommandline-glslshadermame>` +| :ref:`glsl_shader_screen[0-9] <mame-scommandline-glslshaderscreen>` +| :ref:`gl_glsl_vid_attr <mame-scommandline-glglslvidattr>` + + +SDL Keyboard Mapping +~~~~~~~~~~~~~~~~~~~~ + +| :ref:`keymap <mame-scommandline-keymap>` +| :ref:`keymap_file <mame-scommandline-keymapfile>` + + +SDL Joystick Mapping +~~~~~~~~~~~~~~~~~~~~ + +| :ref:`joyidx <mame-scommandline-joyidx>` +| :ref:`sixaxis <mame-scommandline-sixaxis>` + + +SDL Low-level Driver Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`videodriver <mame-scommandline-videodriver>` +| :ref:`audiodriver <mame-scommandline-audiodriver>` +| :ref:`gl_lib <mame-scommandline-gllib>` + |