diff options
Diffstat (limited to 'docs/source/commandline')
-rw-r--r-- | docs/source/commandline/commandline-all.rst | 101 | ||||
-rw-r--r-- | docs/source/commandline/commandline-index.rst | 7 | ||||
-rw-r--r-- | docs/source/commandline/sdlconfig.rst | 29 |
3 files changed, 86 insertions, 51 deletions
diff --git a/docs/source/commandline/commandline-all.rst b/docs/source/commandline/commandline-all.rst index b2cd5ad2c64..9f058e10dff 100644 --- a/docs/source/commandline/commandline-all.rst +++ b/docs/source/commandline/commandline-all.rst @@ -775,24 +775,24 @@ OSD-related Options * - **Microsoft Windows** - win - dwrite - - none - auto - - - sdl [#UIFPSDLWindows]_. + - sdl [#UIFPSDLWindows]_ + - none * - **macOS** - - - - none - auto - osx - sdl + - none * - **Linux** - - - - none - auto - - sdl + - none .. rubric:: Footnotes @@ -816,26 +816,19 @@ Example: :stub-columns: 0 * - **Microsoft Windows** - - auto [#KBIPAutoWindows]_. + - auto [#KBIPAutoWindows]_ - rawinput - dinput - win32 + - sdl [#KBIPSDLWindows]_ - none - - sdl [#KBIPSDLWindows]_. * - **SDL (macOS and Linux)** - - auto [#KBIPAutoSDL]_. + - auto [#KBIPAutoSDL]_ - - - - - none - sdl - * - **Linux** - - auto [#KBIPAutoSDL]_. - - - - - - - none - - sdl .. rubric:: Footnotes @@ -868,26 +861,19 @@ Example: :stub-columns: 0 * - **Microsoft Windows** - - auto [#MIPAutoWindows]_. + - auto [#MIPAutoWindows]_ - rawinput - dinput - win32 + - sdl [#MIPSDLWindows]_ - none - - sdl [#MIPSDLWindows]_. * - **SDL (macOS and Linux)** - - auto [#MIPAutoSDL]_. + - auto [#MIPAutoSDL]_ - - - - - none - sdl - * - **Linux** - - auto [#MIPAutoSDL]_. - - - - - - - none - - sdl .. rubric:: Footnotes @@ -916,36 +902,37 @@ Example: :stub-columns: 0 * - **Microsoft Windows** - - auto [#LGIPAutoWindows]_. + - auto [#LGIPAutoWindows]_ - rawinput - win32 - - none - - + - sdl [#LGIPSDLWindows]_ - + - none * - **macOS** - - auto [#LGIPAutoSDL]_. - - + - auto [#LGIPAutoSDL]_ - - - none - + - sdl - + - none * - **Linux** - - auto [#LGIPAutoLinux]_. + - auto [#LGIPAutoSDL]_ - - - - none - - + - sdl - x11 + - none .. rubric:: Footnotes .. [#LGIPAutoWindows] On Windows, auto will try ``rawinput`` with fallback to ``win32``, or ``none`` if it doesn't find any. -.. [#LGIPAutoSDL] On non-Linux SDL, ``auto`` will default to ``none``. +.. [#LGIPSDLWindows] SDL support on Windows requires that you compile MAME with + the support in. By default SDL is not included in Windows + builds of MAME. -.. [#LGIPAutoLinux] On SDL/Linux, ``auto`` will default to ``x11``, or ``none`` - if it doesn't find any. +.. [#LGIPAutoSDL] On SDL, ``auto`` will default to ``sdl``. Example: .. code-block:: bash @@ -964,15 +951,15 @@ Example: :stub-columns: 0 * - **Microsoft Windows** - - auto [#JIPAutoWindows]_. + - auto [#JIPAutoWindows]_ - winhybrid - dinput - xinput - - sdlgame - - sdljoy + - sdlgame [#JIPSDLWindows]_ + - sdljoy [#JIPSDLWindows]_ - none * - **SDL** - - auto [#JIPAutoSDL]_. + - auto [#JIPAutoSDL]_ - - - @@ -984,6 +971,10 @@ Example: .. [#JIPAutoWindows] On Windows native, auto will default to ``winhybrid``. +.. [#JIPSDLWindows] SDL support on Windows requires that you compile MAME with + the support in. By default SDL is not included in Windows + builds of MAME. + .. [#JIPAutoSDL] On SDL, auto will default to ``sdlgame``. winhybrid @@ -2978,7 +2969,7 @@ Core Sound Options **-volume** / **-vol** *<value>* Sets the initial sound volume. It can be changed later with the user - interface (see Keys section). The volume is an attenuation in decibels: + interface (see Keys section). The volume is in decibels: e.g. "**-volume -12**" will start with -12 dB attenuation. Note that if the volume is changed in the user interface it will be saved to the configuration file for the system. The value from the configuration file @@ -3686,8 +3677,9 @@ Debugging Options Acts as a remote debugging server for the GNU debugger (GDB). Only a small subset of the CPUs emulated by MAME are supported. Use the :ref:`debugger_port <mame-commandline-debuggerport>` option to set the - listening port on the loopback interface. Supported on all platforms - with TCP socket support. + listening port and the + :ref:`debugger_host <mame-commandline-debuggerhost>` option to set the + address to bind to. Supported on all platforms with TCP socket support. Example: .. code-block:: bash @@ -3741,11 +3733,26 @@ Debugging Options mame ibm_5150 -watchdog 30 +.. _mame-commandline-debuggerhost: + +**-debugger_host** *<address>* + + Set the IP address to listen on to accept GDB connections when using the + GDB stub debugger module (see the + :ref:`debugger <mame-commandline-debugger>` option). + + The default is ``localhost``. + + Example: + .. code-block:: bash + + mame rfjet -debug -debugger gdbstub -debugger_host 0.0.0.0 + .. _mame-commandline-debuggerport: **-debugger_port** *<port>* - Set the TCP port number to listen on for GDB connections when using the GDB + Set the TCP port number to accept GDB connections on when using the GDB stub debugger module (see the :ref:`debugger <mame-commandline-debugger>` option). @@ -3989,7 +3996,7 @@ Core Misc Options Specifies the type of UI to use, either ``simple`` or ``cabinet``. - The default is Cabinet (**-ui cabinet**). + The default is cabinet (**-ui cabinet**). Example: .. code-block:: bash @@ -4025,9 +4032,9 @@ Core Misc Options **\-[no]ui_mouse** - Displays a mouse cursor when using the built-in UI for MAME. + Displays a mouse cursor when using the built-in MAME user interface. - The default is (**-noui_mouse**). + The default is ON (**-ui_mouse**). .. _mame-commandline-language: diff --git a/docs/source/commandline/commandline-index.rst b/docs/source/commandline/commandline-index.rst index 50500066d6f..cb6b9a7dfb4 100644 --- a/docs/source/commandline/commandline-index.rst +++ b/docs/source/commandline/commandline-index.rst @@ -298,6 +298,7 @@ Core Debugging Options | :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>` @@ -423,10 +424,12 @@ SDL Keyboard Mapping | :ref:`keymap_file <mame-scommandline-keymapfile>` -SDL Joystick Mapping +SDL Input Options ~~~~~~~~~~~~~~~~~~~~ -| :ref:`sixaxis <mame-scommandline-sixaxis>` +| :ref:`[no]enable_touch <mame-scommandline-enabletouch>` +| :ref:`[no]sixaxis <mame-scommandline-sixaxis>` +| :ref:`[no]dual_lightgun <mame-scommandline-duallightgun>` SDL Lightgun Mapping diff --git a/docs/source/commandline/sdlconfig.rst b/docs/source/commandline/sdlconfig.rst index eea4b959e60..a6f3a7d8e51 100644 --- a/docs/source/commandline/sdlconfig.rst +++ b/docs/source/commandline/sdlconfig.rst @@ -61,8 +61,16 @@ SDL Keyboard Mapping Keymap file name. Default is ``keymap.dat``. -SDL Joystick Mapping --------------------- +SDL Input Options +----------------- + +.. _mame-scommandline-enabletouch: + +**-enable_touch** + + Enable support for touch input. If this option is switched off, mouse input + simulated from touch devices will be used instead. Default is OFF + (**-noenable_touch**) .. _mame-scommandline-sixaxis: @@ -72,6 +80,23 @@ SDL Joystick Mapping undesirable behaviour with other controllers. Only affects the ``sdljoy`` joystick provider. Default is OFF (**-nosixaxis**) +.. _mame-scommandline-duallightgun: + +**-[no]dual_lightgun** / **-[no]dual** + + Controls whether or not MAME attempts to track two lightguns that appear as + a single mouse. This option requires the :ref:`lightgun option + <mame-commandline-nolightgun>` to be on and the :ref:`lightgunprovider + option <mame-commandline-lightgunprovider>` to be set to *sdl*. + + This option supports dual lightgun setups that work by setting the mouse + pointer location at the moment a lightgun trigger is activated. The primary + and secondary triggers on the first lightgun correspond to the first and + second mouse buttons, and the primary and secondary triggers on the second + lightgun correspond to the third and fourth mouse buttons. + + The default is OFF (**-nodual_lightgun**). + SDL Lightgun Mapping -------------------- |