Add toolbar documentation

This commit is contained in:
RichardG867
2022-01-31 21:12:41 -03:00
parent 3fc1fcc32c
commit 7e7bf0cfc2
3 changed files with 46 additions and 5 deletions

View File

@@ -26,6 +26,7 @@ Contents
usage/gettingstarted
usage/menubar
usage/toolbar
usage/statusbar
settings/index

View File

@@ -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 <statusbar>` at the bottom of the window.
* **Hide toolbar:** hides the :doc:`toolbar <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 <statusbar>` icons. Unchecking this option may improve emulation performance on low-end host systems.
* **Preferences:** open the *Preferences* window, which provides the following options:

42
usage/toolbar.rst Normal file
View File

@@ -0,0 +1,42 @@
.. include:: /include.rst
Toolbar
=======
The toolbar located at the top of the 86Box window (right below the :doc:`menu bar <menubar>`) 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 <settings/input:Mouse>` is enabled.
* **Pause indicator** if emulation is paused.