From fc65043a8a60d6a3cac5e3c27633cb20ebc6a721 Mon Sep 17 00:00:00 2001 From: RichardG867 Date: Sun, 16 Oct 2022 00:45:46 -0300 Subject: [PATCH] Documentation update for v3.8 --- hardware/network.rst | 12 ++++++------ settings/network.rst | 21 +++++++++++++-------- settings/ports.rst | 2 +- settings/removable.rst | 2 +- settings/sound.rst | 2 +- usage/menubar.rst | 8 ++++++-- usage/statusbar.rst | 10 +++++++--- 7 files changed, 35 insertions(+), 22 deletions(-) diff --git a/hardware/network.rst b/hardware/network.rst index b5c408a..5c337de 100644 --- a/hardware/network.rst +++ b/hardware/network.rst @@ -8,14 +8,14 @@ SLiRP SLiRP creates a private network with a virtual router, allowing the emulated machine to reach the host, its network and the Internet; on the other hand, the host and other devices on its network cannot reach the emulated machine, unless :ref:`port forwarding ` is configured. This is similar to the **NAT** mode on other emulators and virtualizers. -The virtual router provides automatic IP configuration to the emulated machine through DHCP. If that is not an option, use the following static IP settings: +The virtual router provides automatic IP configuration to the emulated machine through DHCP. If that is not an option, use the following static IP settings, replacing *x* with 2, 3, 4 or 5 for the first, second, third or fourth network card to use SLiRP respectively: -* **IP address:** 10.0.2.15 +* **IP address:** 10.0.\ *x*\ .15 * **Subnet mask:** 255.255.255.0 -* **Default gateway:** 10.0.2.2 -* **DNS server:** 10.0.2.3 +* **Default gateway:** 10.0.\ *x*\ .2 +* **DNS server:** 10.0.\ *x*\ .3 -The host can be reached through IP address 10.0.2.2, while other devices on the host's network can be reached through their normal IP addresses. +The host can be reached through IP address 10.0.\ *x*\ .2, while other devices on the host's network can be reached through their normal IP addresses. .. note:: SLiRP is only capable of routing TCP and UDP traffic. Other protocols such as IPX and NetBEUI can only be used with :ref:`hardware/network:PCap` networking. @@ -24,7 +24,7 @@ PCap PCap connects directly to one of the host's network adapters. The emulated machine must be configured as if it were a real machine on your network. This is similar to the **Bridge** mode on other emulators and virtualizers. -This mode requires `Npcap `_ (or another WinPcap-compatible driver) to be installed on the host. Only **wired Ethernet network connections** are compatible; Wi-Fi and other connections will not work at all, as they do not allow PCap to listen for packets bound to the emulated machine's MAC address. +This mode requires `Npcap `_ (or another WinPcap-compatible driver) to be installed on the host. Only **wired Ethernet network connections** are compatible; Wi-Fi and other connections will not work at all, as they do not allow PCap to listen for packets bound to the emulated card's MAC address. Private PCap network ^^^^^^^^^^^^^^^^^^^^ diff --git a/settings/network.rst b/settings/network.rst index 44446a1..1d50f35 100644 --- a/settings/network.rst +++ b/settings/network.rst @@ -5,26 +5,31 @@ The **Network** page contains settings related to the emulated machine's network connectivity. -Network type ------------- +Network Interface Controllers +----------------------------- -Network emulation mode to use. See :doc:`../hardware/network` for more information on these. +Network interface cards to emulate. Up to 4 independent network cards are supported. + +Mode +^^^^ + +Network emulation mode to use on this card. See :doc:`../hardware/network` for more information on these. * **None:** disable networking. * **PCap:** connects directly to a host network adapter. Similar to the **Bridge** mode on other emulators and virtualizers. * **SLiRP:** creates a private network with a virtual router. Similar to the **NAT** mode on other emulators and virtualizers. -PCap device ------------ +Interface +^^^^^^^^^ -Host network adapter to use for PCap mode. If no adapters appear on this list, make sure that: +Host network adapter to use for PCap mode on this card. If no adapters appear on this list, make sure that: * A WinPcap-compatible driver is installed; * The installed driver is compatible with your version of Windows; * At least one compatible (wired) network adapter is present. -Network adapter ---------------- +Adapter +^^^^^^^ Network card to emulate. Only cards supported by the machine's expansion buses will be listed. diff --git a/settings/ports.rst b/settings/ports.rst index d36a978..b033bc4 100644 --- a/settings/ports.rst +++ b/settings/ports.rst @@ -45,6 +45,6 @@ Enable emulation of serial ports ranging from COM1 to COM4. Any ports not provid Parallel port 1-4 ----------------- -Enable emulation of parallel ports ranging from LPT1 to LPT3. Any ports not provided by the machine's motherboard will be emulated as generic ISA or VLB parallel cards. +Enable emulation of parallel ports ranging from LPT1 to LPT4. Any ports not provided by the machine's motherboard will be emulated as generic ISA or VLB parallel cards. .. note:: The 4th parallel port is not widely supported. It is located at I/O port 268h. diff --git a/settings/removable.rst b/settings/removable.rst index 4825f02..40c1ae1 100644 --- a/settings/removable.rst +++ b/settings/removable.rst @@ -12,7 +12,7 @@ Up to four Magneto-Optical and four Iomega ZIP disk drives can be attached to th * **Bus:** storage bus to attach the drive to. ATAPI (IDE) and SCSI are supported. * **Channel**/**ID:** where to attach the drive on the selected storage bus. See :ref:`settings/hdd:Adding a new disk` for more information. -* **Type** (MO only): drive model to identify as. A list of drive models to choose from is provided. Each model supports different types of MO media, while the `86BOX` model supports all types. +* **Type** (MO only): drive model to identify as. A list of drive models to choose from is provided. Each model supports different types of MO media, while the *86BOX* model supports all types. * **ZIP 250** (ZIP only): enable the drive to read and write 250 MB ZIP disks. MO / ZIP disk images can be inserted and removed through the :ref:`status bar ` or :ref:`Media menu `. diff --git a/settings/sound.rst b/settings/sound.rst index 6693729..7e0d961 100644 --- a/settings/sound.rst +++ b/settings/sound.rst @@ -72,4 +72,4 @@ Use the 32-bit floating point (instead of 16-bit integer) data type for audio ou FM synth driver --------------- -OPL2/3 emulation back-end to use. **Nuked** is the default, while **YMFM** may improve emulation performance at the cost of accuracy. \ No newline at end of file +OPL2/3 emulation back-end to use. **Nuked** is the default, while **YMFM** may improve emulation performance at the cost of accuracy. diff --git a/usage/menubar.rst b/usage/menubar.rst index 6dbda9a..89dd703 100644 --- a/usage/menubar.rst +++ b/usage/menubar.rst @@ -46,6 +46,9 @@ View * **Window scale factor:** scale the emulated display to half (*0.5x*), normal (*1x*), 50% larger (*1.5x*) or double (*2x*) sizes. * **Filter method:** select the filtering method (*Nearest* or *Linear*) to be used when scaling the emulated display. * **HiDPI scaling:** automatically scale the emulated display to real size if your host system has a HiDPI display. This option can be used alongside *Window scale factor* above. + +.. note:: If HiDPI scaling is disabled on a host with a HiDPI display, the emulated display's size may be off by one pixel due to an integer scaling limitation. + * **Fullscreen:** enter full screen mode. Press *Ctrl+Alt+Page Down* to go back to windowed mode. You can also enter full screen mode by pressing *Ctrl+Alt+Page Up*. * **Fullscreen stretch mode:** select the picture mode to use when in full screen mode. @@ -66,7 +69,7 @@ View Media ----- -This menu lists all storage drives attached to the emulated machine, and provides the same controls that are accessible by clicking the respective drive's icon on the :doc:`status bar `. +This menu lists all storage drives and network cards attached to the emulated machine, and provides the same controls that are accessible by clicking the respective device's icon on the :doc:`status bar `. Tools ----- @@ -77,7 +80,7 @@ Tools .. note:: Integration requires the Discord desktop app, running on x86 or x64 Windows, ``x86_64`` Linux or Intel macOS. Discord does not provide integration support for other operating systems / architectures or the browser app. Additionally, integration will not be available on Windows if the included ``discord_game_sdk.dll`` file is missing from the 86Box directory. -* **Take screenshot:** take a screenshot of the emulated display. Screenshots are saved as .png images in the ``screenshots`` subdirectory found in the emulated machine's directory. +* **Take screenshot:** take a screenshot of the emulated display. Screenshots are saved as .png images in the ``screenshots`` subdirectory found in the emulated machine's directory, which can be opened with the **Open screenshots folder** option below. * **Sound gain:** open the :ref:`sound gain control `, which is also accessible through the status bar. * **Preferences:** open the *Preferences* window, which provides the following options: @@ -87,6 +90,7 @@ Tools * **Select media images from program working directory:** if checked, starts any file open/save prompts on the emulated machine's directory. This option is particularly useful for macOS users. * **MCA devices**: open the *MCA devices* window, which lists the IDs and required `Adapter Definition Files `_ of all Micro Channel devices installed on the emulated machine. This option will only be available when emulating a Micro Channel Architecture-based machine. +* **Open screenshots folder**: open the host system's file browser on the directory where screenshots of this emulated machine are saved. Help ---- diff --git a/usage/statusbar.rst b/usage/statusbar.rst index 9c187b6..58c5023 100644 --- a/usage/statusbar.rst +++ b/usage/statusbar.rst @@ -35,6 +35,7 @@ A 3.5" or 5.25" floppy icon will appear for each configured :ref:`floppy drive < * **New image:** create a new disk image file. Opens the *New Image* window, which lets you select the image size and where to save the file. * **Existing image:** insert a :ref:`disk image file ` into this drive. Dragging and dropping an image file on the icon will also load it. * **Existing image (Write-protected):** insert a disk image file into this drive as a read-only disk. +* A history of the last few images that were loaded into this drive. Click on an entry to load it back. * **Export to 86F:** convert the currently-inserted disk image file to 86Box's :doc:`../dev/formats/86f` surface image format. You will be asked where to save the converted file. * **Eject:** remove the currently-inserted disk from this drive. @@ -44,9 +45,10 @@ A 3.5" or 5.25" floppy icon will appear for each configured :ref:`floppy drive < A CD icon will appear for each configured :ref:`CD-ROM drive `. * **Mute:** mute any :ref:`hardware/diskimages:CD audio` played through this drive's analog output. CD audio is unmuted by default on the first configured CD-ROM drive. -* **Empty:** remove any disc inserted into this drive. -* **Reload previous image:** reinsert the last disc image file selected through the *Image* option. * **Image:** insert a :ref:`CD-ROM or DVD-ROM disc image file ` into this drive. Dragging and dropping an image file on the icon will also load it. +* **Folder:** insert a virtual CD-ROM or DVD-ROM with the contents of a host folder into this drive. Dragging and dropping a folder on the icon will also load it. +* A history of the last few images or folders that were loaded into this drive. Click on an entry to load it back. +* **Eject:** remove any disc inserted into this drive. |zip| |mo| ZIP and MO drives ---------------------------- @@ -67,7 +69,9 @@ A hard disk icon will appear for each configured :doc:`hard disk bus <../setting |network| Network ----------------- -This icon will appear if :doc:`networking <../settings/network>` is enabled. No options are available. +A network icon will appear for each configured :doc:`network card <../settings/network>`. + +* **Connected:** connect this card to its network. Network cards with link state detection support will report a disconnected cable if this option is unchecked. |sound| Sound -------------