diff options
Diffstat (limited to 'docs/source/commandline/commandline-index.rst')
-rw-r--r-- | docs/source/commandline/commandline-index.rst | 106 |
1 files changed, 69 insertions, 37 deletions
diff --git a/docs/source/commandline/commandline-index.rst b/docs/source/commandline/commandline-index.rst index b2caa063d14..cb6b9a7dfb4 100644 --- a/docs/source/commandline/commandline-index.rst +++ b/docs/source/commandline/commandline-index.rst @@ -1,33 +1,36 @@ .. _index-commandline: -Commandline Index -================= +Command-line Index +================== -This is a complete index of all commandline options and commands for MAME, suitable for quickly finding a given command. +This is a complete index of all command-line options and verbs for MAME, +suitable for quickly finding a given option. -Universal Commandline Options ------------------------------ -This section contains configuration options that are applicable to *all* MAME sub-builds (both SDL and Windows native). +Universal Command-line Options +------------------------------ +This section contains configuration options that are applicable to *all* MAME +configurations (including both SDL and Windows native). -Core Commands -~~~~~~~~~~~~~ + +Core Verbs +~~~~~~~~~~ | :ref:`help <mame-commandline-help>` | :ref:`validate <mame-commandline-validate>` -Configuration Commands -~~~~~~~~~~~~~~~~~~~~~~ +Configuration Verbs +~~~~~~~~~~~~~~~~~~~ | :ref:`createconfig <mame-commandline-createconfig>` | :ref:`showconfig <mame-commandline-showconfig>` | :ref:`showusage <mame-commandline-showusage>` -Frontend Commands -~~~~~~~~~~~~~~~~~ +Frontend Verbs +~~~~~~~~~~~~~~ | :ref:`listxml <mame-commandline-listxml>` | :ref:`listfull <mame-commandline-listfull>` @@ -36,6 +39,7 @@ Frontend Commands | :ref:`listbrothers <mame-commandline-listbrothers>` | :ref:`listcrc <mame-commandline-listcrc>` | :ref:`listroms <mame-commandline-listroms>` +| :ref:`listbios <mame-commandline-listbios>` | :ref:`listsamples <mame-commandline-listsamples>` | :ref:`verifyroms <mame-commandline-verifyroms>` | :ref:`verifysamples <mame-commandline-verifysamples>` @@ -53,15 +57,19 @@ OSD-related Options ~~~~~~~~~~~~~~~~~~~ | :ref:`uimodekey <mame-commandline-uimodekey>` +| :ref:`controller_map <mame-commandline-controllermap>` +| :ref:`background_input <mame-commandline-backgroundinput>` | :ref:`uifontprovider <mame-commandline-uifontprovider>` | :ref:`keyboardprovider <mame-commandline-keyboardprovider>` | :ref:`mouseprovider <mame-commandline-mouseprovider>` | :ref:`lightgunprovider <mame-commandline-lightgunprovider>` | :ref:`joystickprovider <mame-commandline-joystickprovider>` +| :ref:`midiprovider <mame-commandline-midiprovider>` +| :ref:`networkprovider <mame-commandline-networkprovider>` -OSD CLI Options -~~~~~~~~~~~~~~~ +OSD CLI Verbs +~~~~~~~~~~~~~ | :ref:`listmidi <mame-commandline-listmidi>` | :ref:`listnetwork <mame-commandline-listnetwork>` @@ -117,9 +125,8 @@ Core State/Playback Options | :ref:`state <mame-commandline-state>` | :ref:`[no]autosave <mame-commandline-noautosave>` | :ref:`playback <mame-commandline-playback>` -| :ref:`exit_after_playback <mame-commandline-exitafterplayback>` +| :ref:`[no]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>` @@ -143,6 +150,7 @@ Core Performance Options | :ref:`[no]refreshspeed <mame-commandline-norefreshspeed>` | :ref:`numprocessors <mame-commandline-numprocessors>` | :ref:`bench <mame-commandline-bench>` +| :ref:`[no]lowlatency <mame-commandline-lowlatency>` Core Rotation Options @@ -211,6 +219,7 @@ Core Vector Options | :ref:`beam_width_min <mame-commandline-beamwidthmin>` | :ref:`beam_width_max <mame-commandline-beamwidthmax>` | :ref:`beam_intensity_weight <mame-commandline-beamintensityweight>` +| :ref:`beam_dot_size <mame-commandline-beamdotsize>` | :ref:`flicker <mame-commandline-flicker>` @@ -226,19 +235,18 @@ Core Video OpenGL Debugging Options Core Video OpenGL GLSL Options ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -| :ref:`gl_glsl <mame-commandline-glglsl>` +| :ref:`[no]gl_glsl <mame-commandline-glglsl>` | :ref:`gl_glsl_filter <mame-commandline-glglslfilter>` | :ref:`glsl_shader_mame[0-9] <mame-commandline-glslshadermame>` | :ref:`glsl_shader_screen[0-9] <mame-commandline-glslshaderscreen>` -| :ref:`gl_glsl_vid_attr <mame-commandline-glglslvidattr>` Core Sound Options ~~~~~~~~~~~~~~~~~~ - | :ref:`samplerate <mame-commandline-samplerate>` | :ref:`[no]samples <mame-commandline-nosamples>` +| :ref:`[no]compressor <mame-commandline-nocompressor>` | :ref:`volume <mame-commandline-volume>` | :ref:`sound <mame-commandline-sound>` | :ref:`audio_latency <mame-commandline-audiolatency>` @@ -260,8 +268,9 @@ Core Input Options | :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:`joystick_threshold <mame-commandline-joystickthreshold>` +| :ref:`[no]natural <mame-commandline-natural>` +| :ref:`[no]joystick_contradictory <mame-commandline-joystickcontradictory>` | :ref:`coin_impulse <mame-commandline-coinimpulse>` @@ -285,9 +294,12 @@ Core Debugging Options | :ref:`[no]oslog <mame-commandline-oslog>` | :ref:`[no]log <mame-commandline-log>` | :ref:`[no]debug <mame-commandline-debug>` +| :ref:`debugger <mame-commandline-debugger>` | :ref:`debugscript <mame-commandline-debugscript>` | :ref:`[no]update_in_pause <mame-commandline-updateinpause>` | :ref:`watchdog <mame-commandline-watchdog>` +| :ref:`debugger_host <mame-commandline-debuggerhost>` +| :ref:`debugger_port <mame-commandline-debuggerport>` | :ref:`debugger_font <mame-commandline-debuggerfont>` | :ref:`debugger_font_size <mame-commandline-debuggerfontsize>` @@ -306,23 +318,23 @@ 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:`[no]drc_use_c <mame-commandline-drcusec>` +| :ref:`[no]drc_log_uml <mame-commandline-drcloguml>` +| :ref:`[no]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:`ui <mame-commandline-ui>` | :ref:`ramsize <mame-commandline-ramsize>` -| :ref:`confirm_quit <mame-commandline-confirmquit>` -| :ref:`ui_mouse <mame-commandline-uimouse>` +| :ref:`[no]confirm_quit <mame-commandline-confirmquit>` +| :ref:`[no]ui_mouse <mame-commandline-uimouse>` | :ref:`language <mame-commandline-language>` | :ref:`[no]nvram_save <mame-commandline-nvramsave>` Scripting Options ------------------ +~~~~~~~~~~~~~~~~~ | :ref:`autoboot_command <mame-commandline-autobootcommand>` | :ref:`autoboot_delay <mame-commandline-autobootdelay>` @@ -334,15 +346,26 @@ Scripting Options HTTP Server Options -------------------- +~~~~~~~~~~~~~~~~~~~ | :ref:`http <mame-commandline-http>` | :ref:`http_port <mame-commandline-httpport>` | :ref:`http_root <mame-commandline-httproot>` -Windows-Specific Commandline Options ------------------------------------- +PortAudio Options +~~~~~~~~~~~~~~~~~ + +| :ref:`pa_api <mame-commandline-paapi>` +| :ref:`pa_device <mame-commandline-padevice>` +| :ref:`pa_latency <mame-commandline-palatency>` + + +Windows-Specific Command-line Options +------------------------------------- + +This section contains configuration options that are specific to the native +(non-SDL) Windows version of MAME. Windows Performance Options @@ -367,16 +390,18 @@ 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-Specific Command-line Options +--------------------------------- + +This section contains configuration options that are specific to any build +supported by SDL (including Windows when built with SDL instead of native). SDL Performance Options ~~~~~~~~~~~~~~~~~~~~~~~ -| :ref:`sdlvideofps <mame-scommandline-sdlvideofps>` +| :ref:`[no]sdlvideofps <mame-scommandline-sdlvideofps>` SDL Video Options @@ -399,11 +424,18 @@ SDL Keyboard Mapping | :ref:`keymap_file <mame-scommandline-keymapfile>` -SDL Joystick Mapping +SDL Input Options +~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]enable_touch <mame-scommandline-enabletouch>` +| :ref:`[no]sixaxis <mame-scommandline-sixaxis>` +| :ref:`[no]dual_lightgun <mame-scommandline-duallightgun>` + + +SDL Lightgun Mapping ~~~~~~~~~~~~~~~~~~~~ -| :ref:`joyidx <mame-scommandline-joyidx>` -| :ref:`sixaxis <mame-scommandline-sixaxis>` +| :ref:`lightgun_index <mame-scommandline-lightgunindex>` SDL Low-level Driver Options |