summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/debugger/image.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/debugger/image.rst')
-rw-r--r--docs/source/debugger/image.rst97
1 files changed, 57 insertions, 40 deletions
diff --git a/docs/source/debugger/image.rst b/docs/source/debugger/image.rst
index d52c3ed3f43..f02388062a7 100644
--- a/docs/source/debugger/image.rst
+++ b/docs/source/debugger/image.rst
@@ -1,63 +1,80 @@
.. _debugger-image-list:
-Image Debugger Commands
-=======================
+Media Image Debugger Commands
+=============================
+:ref:`debugger-command-images`
+ lists all image devices and mounted media images
+:ref:`debugger-command-mount`
+ mounts a media image file to an image device
+:ref:`debugger-command-unmount`
+ unmounts the media image from a device
-You can also type **help <command>** for further details on each command in the MAME Debugger interface.
-| :ref:`debugger-command-images` -- lists all image devices and mounted files
-| :ref:`debugger-command-mount` -- mounts file to named device
-| :ref:`debugger-command-unmount` -- unmounts file from named device
-
-
- .. _debugger-command-images:
+.. _debugger-command-images:
images
------
-| **images**
-|
-| Used to display list of available image devices.
-|
-| Examples:
-|
-| images
-|
-| Show list of devices and mounted files for current driver.
+**images**
+
+Lists the instance names for media images devices in the system and the
+currently mounted media images, if any. Brief instance names, as
+allowed for command line media options, are listed. Mounted software
+list items are displayed as the list name, software item short name, and
+part name, separated by colons; other mounted images are displayed as
+file names.
+
+Example:
+``images``
+ Lists image device instance names and mounted media.
- .. _debugger-command-mount:
+Back to :ref:`debugger-image-list`
+
+
+.. _debugger-command-mount:
mount
-----
-| **mount <device>,<filename>**
-|
-| Mount <filename> to image <device>.
-|
-| <filename> can be softlist item or full path to file.
-|
-| Examples:
-|
-| mount cart,aladdin
-|
-| Mounts softlist item aladdin on cart device.
+**mount <instance>,<filename>**
+
+Mounts a file on a media device. The device may be specified by its
+instance name or brief instance name, as allowed for command line media
+options.
+Some media devices allow software list items to be mounted using this
+command by supplying the short name of the software list item in place
+of a filename for the **<filename>** parameter.
- .. _debugger-command-unmount:
+Examples:
+
+``mount flop1,os1xutls.td0``
+ Mount the file **os1xutls.td0** on the media device with instance
+ name **flop1**.
+``mount cart,10yard``
+ Mount the software list item with short name **10yard** on the media
+ device with instance name **cart**.
+
+Back to :ref:`debugger-image-list`
+
+
+.. _debugger-command-unmount:
unmount
-------
-| **unmount <device>**
-|
-| Unmounts file from image <device>.
-|
-| Examples:
-|
-| unmount cart
-|
-| Unmounts any file mounted on device named cart.
+**unmount <instance>**
+
+Unmounts the mounted media image (if any) from a device. The device may
+be specified by its instance name or brief instance name, as allowed for
+command line media options.
+
+Examples:
+unmount cart
+ Unmounts any media image mounted on the device with instance name
+ **cart**.
+Back to :ref:`debugger-image-list`