From 7e7bf0cfc297dc3c2988f1381af5fd07111e9b52 Mon Sep 17 00:00:00 2001 From: RichardG867 Date: Mon, 31 Jan 2022 21:12:41 -0300 Subject: [PATCH] Add toolbar documentation --- index.rst | 1 + usage/menubar.rst | 8 +++----- usage/toolbar.rst | 42 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 46 insertions(+), 5 deletions(-) create mode 100644 usage/toolbar.rst diff --git a/index.rst b/index.rst index 894bacc..60b39e0 100644 --- a/index.rst +++ b/index.rst @@ -26,6 +26,7 @@ Contents usage/gettingstarted usage/menubar + usage/toolbar usage/statusbar settings/index diff --git a/usage/menubar.rst b/usage/menubar.rst index 5e1890c..f5bf585 100644 --- a/usage/menubar.rst +++ b/usage/menubar.rst @@ -11,16 +11,14 @@ Action * **Hard Reset:** force a reset of the emulated machine. Requires confirmation, which can be disabled by checking the *Don't show this message again* box. * **Ctrl+Alt+Del:** send a *Ctrl+Alt+Del* key combination to the emulated machine. You can alternatively press *Ctrl+F12* to send that combination. * **Ctrl+Alt+Esc:** send a *Ctrl+Alt+Esc* key combination to the emulated machine. -* **Pause:** pause emulation. Uncheck this option to resume emulation. - -.. note:: Emulation is automatically paused when the emulated machine enters ACPI sleep mode. - +* **Pause:** pause emulation of the machine. Uncheck this option to resume emulation. * **Exit:** quit 86Box. Requires confirmation, which can be disabled by checking the *Don't show this message again* box. View ---- * **Hide status bar:** hides the :doc:`status bar ` at the bottom of the window. +* **Hide toolbar:** hides the :doc:`toolbar ` below the menu bar. * **Resizeable window:** allow the 86Box window to be freely resized. Unchecking this option will also return the window to its normal size. * **Remember size & position:** automatically save the size and position of the 86Box window to the emulated machine's configuration file. * **Renderer:** select a graphical renderer for the emulated display. @@ -69,7 +67,7 @@ This menu lists all storage drives attached to the emulated machine, and provide Tools ----- -* **Settings:** open the :doc:`Settings <../settings/index>` window. +* **Settings:** open the :doc:`Settings <../settings/index>` window to configure the emulated machine. * **Update status bar icons:** enable the activity lights on :doc:`status bar ` icons. Unchecking this option may improve emulation performance on low-end host systems. * **Preferences:** open the *Preferences* window, which provides the following options: diff --git a/usage/toolbar.rst b/usage/toolbar.rst new file mode 100644 index 0000000..2f74996 --- /dev/null +++ b/usage/toolbar.rst @@ -0,0 +1,42 @@ +.. include:: /include.rst + +Toolbar +======= + +The toolbar located at the top of the 86Box window (right below the :doc:`menu bar `) has two purposes: it provides quick actions for the emulated machine on its left hand side, and displays status information on its right hand side. + +|pause| |run| Pause/resume execution +------------------------------------ + +Pause emulation of the machine. Press again to resume emulation. + +.. note:: Emulation is automatically paused when the emulated machine enters ACPI sleep mode. + +|hard_reset| Hard reset +----------------------- + +Force a reset of the emulated machine. Requires confirmation, which can be disabled by checking the *Don't show this message again* box. + +|acpi_shutdown| ACPI shutdown +----------------------------- + +Initiate a clean shutdown of the emulated machine. Only available on machines with ACPI soft power off capability. + +|send_cad| |send_cae| Press Ctrl+Alt+Del/Ctrl+Alt+Esc +------------------------------------------------------- + +Send a *Ctrl+Alt+Del* (left-most icon) or *Ctrl+Alt+Esc* (right-most icon) key combination to the emulated machine. You can alternatively press *Ctrl+F12* to send a *Ctrl+Alt+Del* combination. + +|settings| Settings +------------------- + +Open the :doc:`Settings <../settings/index>` window to configure the emulated machine. + +Status area +----------- + +The right hand side of the toolbar displays status information, such as: + +* **Emulation speed** in percentage. If this number stays consistently below 100%, your host system is not keeping up with emulating the configured hardware. +* **Mouse state** (captured or released) if a :ref:`mouse ` is enabled. +* **Pause indicator** if emulation is paused.