summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/commandline/commandline-all.rst
diff options
context:
space:
mode:
author Vas Crabb <vas@vastheman.com>2024-08-27 04:17:23 +1000
committer Vas Crabb <vas@vastheman.com>2024-08-27 04:17:23 +1000
commit77d4cc347543aca6e07f0fd32c385c96d8d40808 (patch)
tree85c731ad495f0b68d53550b41f835aff7a18a924 /docs/source/commandline/commandline-all.rst
parent5395cbcea2ba20478753e121208aad75c0ae6605 (diff)
Cleaned up the mess from #12610:
* Command line options need to be documented. * Don't assume C strings returned as option values remain valid indefinitely. * Fixed wording for option description.
Diffstat (limited to 'docs/source/commandline/commandline-all.rst')
-rw-r--r--docs/source/commandline/commandline-all.rst22
1 files changed, 19 insertions, 3 deletions
diff --git a/docs/source/commandline/commandline-all.rst b/docs/source/commandline/commandline-all.rst
index fe093cc0d86..d83b401cc32 100644
--- a/docs/source/commandline/commandline-all.rst
+++ b/docs/source/commandline/commandline-all.rst
@@ -3677,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
@@ -3732,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).