Skip to content

Commit

Permalink
docs: include documentation updates from wiki to man pages
Browse files Browse the repository at this point in the history
  • Loading branch information
philclifford committed May 14, 2024
1 parent b565cef commit ad5e626
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 15 deletions.
19 changes: 14 additions & 5 deletions README-135-confoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,15 +135,24 @@ So you can generate your own MAC addresses with:

Quickemu supports USB redirection via SPICE pass-through and host
pass-through.
Quickemu supports USB redirection via SPICE pass-through and host pass-through.

**NOTE!** When a USB device is redirected from the host, it will not be usable by host operating system until the guest redirection is stopped. Therefore, do not redirect the input devices, such as the keyboard and mouse, as it will be difficult (or impossible) to revert the situation.

#### SPICE redirection (recommended)

Using SPICE for USB pass-through is easiest as it doesn't require any
elevated permission:
Using SPICE for USB pass-through is easiest as it doesn't require any elevated permission:

Both `spicy` from [spice-gtk](https://www.spice-space.org/spice-gtk.html) (*Input -> Select USB Devices for redirection*) and `remote-viewer` from [virt-viewer](https://gitlab.com/virt-viewer/virt-viewer) (*File -> USB device selection*) support this feature.

- Start Quickemu with `--display spice` and then
- Select `Input` -\> `Select USB Device for redirection` from the menu to choose which device(s) you want to attach to the guest.
- **`spicy` (default)
- **Select `Input` -\> `Select USB Device for redirection` from the menu to choose which device(s) you want to attach to the guest.
- **`remote-viewer`
- **Select `File` -\> `USB device selection` from the menu to choose which device(s) you want to attach to the guest.

* Start Quickemu with `--display spice` and then
* select `Input` -\> `Select USB Device for redirection` from the menu to
choose which device(s) you want to attach to the guest.
To ensure that this functionality works as expected, make sure that you have installed the necessary SPICE Guest Tools on the virtual machine.

##### Enabling SPICE redirection on NixOS

Expand Down
17 changes: 8 additions & 9 deletions quickemu.1-10-macOSguests.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


``` shell
quickget macos catalina
quickemu --vm macos-catalina.conf
quickget macos big-sur
quickemu --vm macos-big-sur.conf
```

macOS `mojave`, `catalina`, `big-sur`, `monterey`, `ventura` and
Expand Down Expand Up @@ -76,13 +76,13 @@ The default macOS configuration looks like this:

``` shell
guest_os="macos"
img="macos-catalina/RecoveryImage.img"
disk_img="macos-catalina/disk.qcow2"
macos_release="catalina"
img="macos- big-sur/RecoveryImage.img"
disk_img="macos- big-sur/disk.qcow2"
macos_release=" big-sur"
```

- `guest_os="macos"` instructs Quickemu to optimise for macOS.
- `macos_release="catalina"` instructs Quickemu to optimise for a
- `macos_release=" big-sur"` instructs Quickemu to optimise for a
particular macOS release.
- For example VirtIO Network and Memory Ballooning are available
in Big Sur and newer, but not previous releases.
Expand All @@ -94,9 +94,8 @@ macos_release="catalina"
There are some considerations when running macOS via Quickemu.

- Supported macOS releases:
- High Sierra
- Mojave
- Catalina **(Recommended)**
- Catalina
- Big Sur
- Monterey
- Ventura
Expand All @@ -111,7 +110,7 @@ There are some considerations when running macOS via Quickemu.
- USB host and SPICE pass-through is:
- UHCI (USB 2.0) on macOS Catalina and earlier.
- XHCI (USB 3.0) on macOS Big Sur and newer.
- Display resolution can only be changed via macOS System Preferences.
- Display resolution can be changed via `quickemu` using `--width` and `--height` command line arguments.
- **Full Duplex audio requires [VoodooHDA OC](https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB audio-device to the macOS guest VM**.
- NOTE! [Gatekeeper](https://disable-gatekeeper.github.io/) and [System Integrity Protection (SIP)](https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection) need to be disabled to install VoodooHDA OC
- File sharing between guest and host is available via [virtio-9p](https://wiki.qemu.org/Documentation/9psetup) and [SPICE
Expand Down
2 changes: 1 addition & 1 deletion quickemu_conf.1-01-spiceheadless.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
The following features are available while using the SPICE protocol:

- Copy/paste between the guest and host
- Host file sharing to the guest
- Host file sharing with the guest
- USB device redirection

To use SPICE add `--display spice` to the Quickemu invocation, this
Expand Down

0 comments on commit ad5e626

Please sign in to comment.