docs: include documentation updates from wiki to man pages
This commit is contained in:
parent
f6b5d684d4
commit
304d459ddb
|
@ -1 +1 @@
|
||||||
Subproject commit b565cefbfc9a94cd699da6c5fa9c59c1c1646dbb
|
Subproject commit ad5e62630e999fa03cc8289bba2351f7fd758703
|
|
@ -818,8 +818,8 @@ check the Discussions
|
||||||
creates a virtual machine configuration.
|
creates a virtual machine configuration.
|
||||||
.IP
|
.IP
|
||||||
.EX
|
.EX
|
||||||
quickget macos catalina
|
quickget macos big\-sur
|
||||||
quickemu \-\-vm macos\-catalina.conf
|
quickemu \-\-vm macos\-big\-sur.conf
|
||||||
.EE
|
.EE
|
||||||
.PP
|
.PP
|
||||||
macOS \f[CR]mojave\f[R], \f[CR]catalina\f[R], \f[CR]big\-sur\f[R],
|
macOS \f[CR]mojave\f[R], \f[CR]catalina\f[R], \f[CR]big\-sur\f[R],
|
||||||
|
@ -920,15 +920,15 @@ The default macOS configuration looks like this:
|
||||||
.IP
|
.IP
|
||||||
.EX
|
.EX
|
||||||
guest_os=\[dq]macos\[dq]
|
guest_os=\[dq]macos\[dq]
|
||||||
img=\[dq]macos\-catalina/RecoveryImage.img\[dq]
|
img=\[dq]macos\- big\-sur/RecoveryImage.img\[dq]
|
||||||
disk_img=\[dq]macos\-catalina/disk.qcow2\[dq]
|
disk_img=\[dq]macos\- big\-sur/disk.qcow2\[dq]
|
||||||
macos_release=\[dq]catalina\[dq]
|
macos_release=\[dq] big\-sur\[dq]
|
||||||
.EE
|
.EE
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
\f[CR]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
|
\f[CR]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
|
||||||
macOS.
|
macOS.
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
\f[CR]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to
|
\f[CR]macos_release=\[dq] big\-sur\[dq]\f[R] instructs Quickemu to
|
||||||
optimise for a particular macOS release.
|
optimise for a particular macOS release.
|
||||||
.RS 2
|
.RS 2
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
|
@ -944,11 +944,9 @@ There are some considerations when running macOS via Quickemu.
|
||||||
Supported macOS releases:
|
Supported macOS releases:
|
||||||
.RS 2
|
.RS 2
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
High Sierra
|
|
||||||
.IP \[bu] 2
|
|
||||||
Mojave
|
Mojave
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
Catalina \f[B](Recommended)\f[R]
|
Catalina
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
Big Sur
|
Big Sur
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
|
@ -1001,7 +999,8 @@ UHCI (USB 2.0) on macOS Catalina and earlier.
|
||||||
XHCI (USB 3.0) on macOS Big Sur and newer.
|
XHCI (USB 3.0) on macOS Big Sur and newer.
|
||||||
.RE
|
.RE
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
Display resolution can only be changed via macOS System Preferences.
|
Display resolution can be changed via \f[CR]quickemu\f[R] using
|
||||||
|
\f[CR]\-\-width\f[R] and \f[CR]\-\-height\f[R] command line arguments.
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
\f[B]Full Duplex audio requires \c
|
\f[B]Full Duplex audio requires \c
|
||||||
.UR https://github.com/chris1111/VoodooHDA-OC
|
.UR https://github.com/chris1111/VoodooHDA-OC
|
||||||
|
|
|
@ -552,8 +552,8 @@ for solutions or ask for help there** 🛟
|
||||||
virtual machine configuration.
|
virtual machine configuration.
|
||||||
|
|
||||||
``` shell
|
``` shell
|
||||||
quickget macos catalina
|
quickget macos big-sur
|
||||||
quickemu --vm macos-catalina.conf
|
quickemu --vm macos-big-sur.conf
|
||||||
```
|
```
|
||||||
|
|
||||||
macOS `mojave`, `catalina`, `big-sur`, `monterey`, `ventura` and
|
macOS `mojave`, `catalina`, `big-sur`, `monterey`, `ventura` and
|
||||||
|
@ -625,13 +625,13 @@ The default macOS configuration looks like this:
|
||||||
|
|
||||||
``` shell
|
``` shell
|
||||||
guest_os="macos"
|
guest_os="macos"
|
||||||
img="macos-catalina/RecoveryImage.img"
|
img="macos- big-sur/RecoveryImage.img"
|
||||||
disk_img="macos-catalina/disk.qcow2"
|
disk_img="macos- big-sur/disk.qcow2"
|
||||||
macos_release="catalina"
|
macos_release=" big-sur"
|
||||||
```
|
```
|
||||||
|
|
||||||
- `guest_os="macos"` instructs Quickemu to optimise for macOS.
|
- `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.
|
particular macOS release.
|
||||||
- For example VirtIO Network and Memory Ballooning are available in
|
- For example VirtIO Network and Memory Ballooning are available in
|
||||||
Big Sur and newer, but not previous releases.
|
Big Sur and newer, but not previous releases.
|
||||||
|
@ -643,9 +643,8 @@ macos_release="catalina"
|
||||||
There are some considerations when running macOS via Quickemu.
|
There are some considerations when running macOS via Quickemu.
|
||||||
|
|
||||||
- Supported macOS releases:
|
- Supported macOS releases:
|
||||||
- High Sierra
|
|
||||||
- Mojave
|
- Mojave
|
||||||
- Catalina **(Recommended)**
|
- Catalina
|
||||||
- Big Sur
|
- Big Sur
|
||||||
- Monterey
|
- Monterey
|
||||||
- Ventura
|
- Ventura
|
||||||
|
@ -667,7 +666,8 @@ There are some considerations when running macOS via Quickemu.
|
||||||
- USB host and SPICE pass-through is:
|
- USB host and SPICE pass-through is:
|
||||||
- UHCI (USB 2.0) on macOS Catalina and earlier.
|
- UHCI (USB 2.0) on macOS Catalina and earlier.
|
||||||
- XHCI (USB 3.0) on macOS Big Sur and newer.
|
- 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
|
- **Full Duplex audio requires [VoodooHDA
|
||||||
OC](https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB
|
OC](https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB
|
||||||
audio-device to the macOS guest VM**.
|
audio-device to the macOS guest VM**.
|
||||||
|
|
|
@ -228,14 +228,51 @@ So you can generate your own MAC addresses with:
|
||||||
.SS USB redirection
|
.SS USB redirection
|
||||||
Quickemu supports USB redirection via SPICE pass\-through and host
|
Quickemu supports USB redirection via SPICE pass\-through and host
|
||||||
pass\-through.
|
pass\-through.
|
||||||
|
Quickemu supports USB redirection via SPICE pass\-through and host
|
||||||
|
pass\-through.
|
||||||
|
.PP
|
||||||
|
\f[B]NOTE!\f[R] 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.
|
||||||
.SS SPICE redirection (recommended)
|
.SS SPICE redirection (recommended)
|
||||||
Using SPICE for USB pass\-through is easiest as it doesn\[aq]t require
|
Using SPICE for USB pass\-through is easiest as it doesn\[aq]t require
|
||||||
any elevated permission:
|
any elevated permission:
|
||||||
|
.PP
|
||||||
|
Both \f[CR]spicy\f[R] from \c
|
||||||
|
.UR https://www.spice-space.org/spice-gtk.html
|
||||||
|
spice\-gtk
|
||||||
|
.UE \c
|
||||||
|
\ (\f[I]Input \-> Select USB Devices for redirection\f[R]) and
|
||||||
|
\f[CR]remote\-viewer\f[R] from \c
|
||||||
|
.UR https://gitlab.com/virt-viewer/virt-viewer
|
||||||
|
virt\-viewer
|
||||||
|
.UE \c
|
||||||
|
\ (\f[I]File \-> USB device selection\f[R]) support this feature.
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
Start Quickemu with \f[CR]\-\-display spice\f[R] and then
|
Start Quickemu with \f[CR]\-\-display spice\f[R] and then
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
select \f[CR]Input\f[R] \-> \f[CR]Select USB Device for redirection\f[R]
|
Select \f[CR]Input\f[R] \-> \f[CR]Select USB Device for redirection\f[R]
|
||||||
from the menu to choose which device(s) you want to attach to the guest.
|
from the menu to choose which device(s) you want to attach to the guest.
|
||||||
|
.IP \[bu] 2
|
||||||
|
**\f[CR]spicy\f[R] (default)
|
||||||
|
.RS 2
|
||||||
|
.IP \[bu] 2
|
||||||
|
**Select \f[CR]Input\f[R] \->
|
||||||
|
\f[CR]Select USB Device for redirection\f[R] from the menu to choose
|
||||||
|
which device(s) you want to attach to the guest.
|
||||||
|
.RE
|
||||||
|
.IP \[bu] 2
|
||||||
|
**\f[CR]remote\-viewer\f[R]
|
||||||
|
.RS 2
|
||||||
|
.IP \[bu] 2
|
||||||
|
**Select \f[CR]File\f[R] \-> \f[CR]USB device selection\f[R] from the
|
||||||
|
menu to choose which device(s) you want to attach to the guest.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
To ensure that this functionality works as expected, make sure that you
|
||||||
|
have installed the necessary SPICE Guest Tools on the virtual machine.
|
||||||
.SS Enabling SPICE redirection on NixOS
|
.SS Enabling SPICE redirection on NixOS
|
||||||
On NixOS, if you encounter this error:
|
On NixOS, if you encounter this error:
|
||||||
.IP
|
.IP
|
||||||
|
|
|
@ -241,16 +241,37 @@ So you can generate your own MAC addresses with:
|
||||||
### USB redirection
|
### USB redirection
|
||||||
|
|
||||||
Quickemu supports USB redirection via SPICE pass-through and host
|
Quickemu supports USB redirection via SPICE pass-through and host
|
||||||
pass-through.
|
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)
|
#### SPICE redirection (recommended)
|
||||||
|
|
||||||
Using SPICE for USB pass-through is easiest as it doesn't require any
|
Using SPICE for USB pass-through is easiest as it doesn't require any
|
||||||
elevated permission:
|
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
|
- Start Quickemu with `--display spice` and then
|
||||||
- select `Input` -\> `Select USB Device for redirection` from the menu
|
- Select `Input` -\> `Select USB Device for redirection` from the menu
|
||||||
to choose which device(s) you want to attach to the guest.
|
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.
|
||||||
|
|
||||||
|
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
|
##### Enabling SPICE redirection on NixOS
|
||||||
|
|
||||||
|
|
|
@ -384,8 +384,8 @@ check the Discussions
|
||||||
creates a virtual machine configuration.
|
creates a virtual machine configuration.
|
||||||
.IP
|
.IP
|
||||||
.EX
|
.EX
|
||||||
quickget macos catalina
|
quickget macos big\-sur
|
||||||
quickemu \-\-vm macos\-catalina.conf
|
quickemu \-\-vm macos\-big\-sur.conf
|
||||||
.EE
|
.EE
|
||||||
.PP
|
.PP
|
||||||
macOS \f[CR]mojave\f[R], \f[CR]catalina\f[R], \f[CR]big\-sur\f[R],
|
macOS \f[CR]mojave\f[R], \f[CR]catalina\f[R], \f[CR]big\-sur\f[R],
|
||||||
|
@ -486,15 +486,15 @@ The default macOS configuration looks like this:
|
||||||
.IP
|
.IP
|
||||||
.EX
|
.EX
|
||||||
guest_os=\[dq]macos\[dq]
|
guest_os=\[dq]macos\[dq]
|
||||||
img=\[dq]macos\-catalina/RecoveryImage.img\[dq]
|
img=\[dq]macos\- big\-sur/RecoveryImage.img\[dq]
|
||||||
disk_img=\[dq]macos\-catalina/disk.qcow2\[dq]
|
disk_img=\[dq]macos\- big\-sur/disk.qcow2\[dq]
|
||||||
macos_release=\[dq]catalina\[dq]
|
macos_release=\[dq] big\-sur\[dq]
|
||||||
.EE
|
.EE
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
\f[CR]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
|
\f[CR]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
|
||||||
macOS.
|
macOS.
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
\f[CR]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to
|
\f[CR]macos_release=\[dq] big\-sur\[dq]\f[R] instructs Quickemu to
|
||||||
optimise for a particular macOS release.
|
optimise for a particular macOS release.
|
||||||
.RS 2
|
.RS 2
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
|
@ -510,11 +510,9 @@ There are some considerations when running macOS via Quickemu.
|
||||||
Supported macOS releases:
|
Supported macOS releases:
|
||||||
.RS 2
|
.RS 2
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
High Sierra
|
|
||||||
.IP \[bu] 2
|
|
||||||
Mojave
|
Mojave
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
Catalina \f[B](Recommended)\f[R]
|
Catalina
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
Big Sur
|
Big Sur
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
|
@ -567,7 +565,8 @@ UHCI (USB 2.0) on macOS Catalina and earlier.
|
||||||
XHCI (USB 3.0) on macOS Big Sur and newer.
|
XHCI (USB 3.0) on macOS Big Sur and newer.
|
||||||
.RE
|
.RE
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
Display resolution can only be changed via macOS System Preferences.
|
Display resolution can be changed via \f[CR]quickemu\f[R] using
|
||||||
|
\f[CR]\-\-width\f[R] and \f[CR]\-\-height\f[R] command line arguments.
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
\f[B]Full Duplex audio requires \c
|
\f[B]Full Duplex audio requires \c
|
||||||
.UR https://github.com/chris1111/VoodooHDA-OC
|
.UR https://github.com/chris1111/VoodooHDA-OC
|
||||||
|
|
|
@ -286,8 +286,8 @@ for solutions or ask for help there** 🛟
|
||||||
virtual machine configuration.
|
virtual machine configuration.
|
||||||
|
|
||||||
``` shell
|
``` shell
|
||||||
quickget macos catalina
|
quickget macos big-sur
|
||||||
quickemu --vm macos-catalina.conf
|
quickemu --vm macos-big-sur.conf
|
||||||
```
|
```
|
||||||
|
|
||||||
macOS `mojave`, `catalina`, `big-sur`, `monterey`, `ventura` and
|
macOS `mojave`, `catalina`, `big-sur`, `monterey`, `ventura` and
|
||||||
|
@ -359,13 +359,13 @@ The default macOS configuration looks like this:
|
||||||
|
|
||||||
``` shell
|
``` shell
|
||||||
guest_os="macos"
|
guest_os="macos"
|
||||||
img="macos-catalina/RecoveryImage.img"
|
img="macos- big-sur/RecoveryImage.img"
|
||||||
disk_img="macos-catalina/disk.qcow2"
|
disk_img="macos- big-sur/disk.qcow2"
|
||||||
macos_release="catalina"
|
macos_release=" big-sur"
|
||||||
```
|
```
|
||||||
|
|
||||||
- `guest_os="macos"` instructs Quickemu to optimise for macOS.
|
- `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.
|
particular macOS release.
|
||||||
- For example VirtIO Network and Memory Ballooning are available in
|
- For example VirtIO Network and Memory Ballooning are available in
|
||||||
Big Sur and newer, but not previous releases.
|
Big Sur and newer, but not previous releases.
|
||||||
|
@ -377,9 +377,8 @@ macos_release="catalina"
|
||||||
There are some considerations when running macOS via Quickemu.
|
There are some considerations when running macOS via Quickemu.
|
||||||
|
|
||||||
- Supported macOS releases:
|
- Supported macOS releases:
|
||||||
- High Sierra
|
|
||||||
- Mojave
|
- Mojave
|
||||||
- Catalina **(Recommended)**
|
- Catalina
|
||||||
- Big Sur
|
- Big Sur
|
||||||
- Monterey
|
- Monterey
|
||||||
- Ventura
|
- Ventura
|
||||||
|
@ -401,7 +400,8 @@ There are some considerations when running macOS via Quickemu.
|
||||||
- USB host and SPICE pass-through is:
|
- USB host and SPICE pass-through is:
|
||||||
- UHCI (USB 2.0) on macOS Catalina and earlier.
|
- UHCI (USB 2.0) on macOS Catalina and earlier.
|
||||||
- XHCI (USB 3.0) on macOS Big Sur and newer.
|
- 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
|
- **Full Duplex audio requires [VoodooHDA
|
||||||
OC](https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB
|
OC](https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB
|
||||||
audio-device to the macOS guest VM**.
|
audio-device to the macOS guest VM**.
|
||||||
|
|
Loading…
Reference in New Issue