chore: regenerated docs

includes revised Windows changes and aligned usage() output
This commit is contained in:
Phil Clifford 2023-11-10 21:06:23 +00:00 committed by Martin Wimpress
parent b232bbfcfe
commit acca8cc224
8 changed files with 441 additions and 164 deletions

View file

@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 3.1.8
.\" Automatically generated by Pandoc 3.1.9
.\"
.TH "QUICKGET" "1" "October 24, 2023" "quickget" "Quickget User Manual"
.TH "QUICKGET" "1" "November 10, 2023" "quickget" "Quickget User Manual"
.SH NAME
quickget - download and prepare materials for building a quickemu VM
.SH SYNOPSIS
@ -147,7 +147,7 @@ All the official Ubuntu flavours are supported, just replace
.IP \[bu] 2
\f[CR]haiku\f[R] (Haiku)
.IP \[bu] 2
\f[CR]holoiso\f[R] (HoloISO)
\f[CR]holoiso\f[R] (SteamOS HoloISO)
.IP \[bu] 2
\f[CR]kali\f[R] (Kali)
.IP \[bu] 2
@ -394,21 +394,32 @@ Monterey
Ventura
.RE
.IP \[bu] 2
\f[CR]quickemu\f[R] will automatically download the required
OpenCore (https://github.com/acidanthera/OpenCorePkg) bootloader and
OVMF firmware from OSX-KVM (https://github.com/kholia/OSX-KVM).
\f[CR]quickemu\f[R] will automatically download the required \c
.UR https://github.com/acidanthera/OpenCorePkg
OpenCore
.UE \c
\ bootloader and OVMF firmware from \c
.UR https://github.com/kholia/OSX-KVM
OSX-KVM
.UE \c
\&.
.IP \[bu] 2
Optimised by default, but no GPU acceleration is available.
.RS 2
.IP \[bu] 2
Host CPU vendor is detected and guest CPU is optimised accordingly.
.IP \[bu] 2
VirtIO Block
Media (https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is used
for the system disk where supported.
\c
.UR https://www.kraxel.org/blog/2019/06/macos-qemu-guest/
VirtIO Block Media
.UE \c
\ is used for the system disk where supported.
.IP \[bu] 2
VirtIO \f[CR]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used
for the mouse.
\c
.UR http://philjordan.eu/osx-virt/
VirtIO \f[CR]usb-tablet\f[R]
.UE \c
\ is used for the mouse.
.IP \[bu] 2
VirtIO Network (\f[CR]virtio-net\f[R]) is supported and enabled on macOS
Big Sur and newer but previous releases use \f[CR]vmxnet3\f[R].
@ -427,19 +438,33 @@ XHCI (USB 3.0) on macOS Big Sur and newer.
.IP \[bu] 2
Display resolution can only be changed via macOS System Preferences.
.IP \[bu] 2
\f[B]Full Duplex audio requires VoodooHDA
OC (https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB
audio-device to the macOS guest VM\f[R].
\f[B]Full Duplex audio requires \c
.UR https://github.com/chris1111/VoodooHDA-OC
VoodooHDA OC
.UE \c
\ or pass-through a USB audio-device to the macOS guest VM\f[R].
.IP \[bu] 2
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
\c
.UR https://disable-gatekeeper.github.io/
Gatekeeper
.UE \c
\ and \c
.UR
https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection
System Integrity Protection (SIP)
.UE \c
\ need to be disabled to install VoodooHDA OC
.IP \[bu] 2
File sharing between guest and host is available via
virtio-9p (https://wiki.qemu.org/Documentation/9psetup) and SPICE
webdavd (https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24).
File sharing between guest and host is available via \c
.UR https://wiki.qemu.org/Documentation/9psetup
virtio-9p
.UE \c
\ and \c
.UR https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24
SPICE webdavd
.UE \c
\&.
.IP \[bu] 2
Copy/paste via SPICE agent is \f[B]not available on macOS\f[R].
.SS macOS App Store
@ -458,17 +483,28 @@ sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
.EE
.PP
Now reboot, and the App Store should work.
.SS Windows 10 & 11 Guests
\f[CR]quickget\f[R] can download
Windows10 (https://www.microsoft.com/software-download/windows10) and
Windows 11 (https://www.microsoft.com/software-download/windows11)
automatically and create an optimised virtual machine configuration.
This configuration also includes the VirtIO drivers for
Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/).
.SS Windows 8, 10 & 11 Guests
\f[CR]quickget\f[R] can download \c
.UR https://www.microsoft.com/software-download/windows10
Windows10
.UE \c
\ and \c
.UR https://www.microsoft.com/software-download/windows11
Windows 11
.UE \c
\ automatically and create an optimised virtual machine configuration.
This configuration also includes the \c
.UR https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/
VirtIO drivers for Windows
.UE \c
\&.
.PP
Windows 8.1 is also supported but doesn\[cq]t feature any automated
installation or driver optimisation.
.IP
.EX
quickget windows 11
quickemu --vm windows-11-22H2.conf
quickemu --vm windows-11.conf
.EE
.IP \[bu] 2
Complete the installation as you normally would.
@ -492,7 +528,7 @@ disk_img=\[dq]windows-11/disk.qcow2\[dq]
iso=\[dq]windows-11/windows-11.iso\[dq]
fixed_iso=\[dq]windows-11/virtio-win.iso\[dq]
tpm=\[dq]on\[dq]
secureboot=\[dq]on\[dq]
secureboot=\[dq]off\[dq]
.EE
.IP \[bu] 2
\f[CR]guest_os=\[dq]windows\[dq]\f[R] instructs \f[CR]quickemu\f[R] to
@ -506,10 +542,13 @@ software emulated TPM device using \f[CR]swtpm\f[R].
.SH AUTHORS
Written by Martin Wimpress.
.SH BUGS
Submit bug reports online at:
<https://github.com/quickemu-project/quickemu/issues>
Submit bug reports online at: \c
.UR https://github.com/quickemu-project/quickemu/issues
.UE \c
.SH SEE ALSO
Full sources at: <https://github.com/quickemu-project/quickemu>
Full sources at: \c
.UR https://github.com/quickemu-project/quickemu
.UE \c
.PP
quickemu(1), quickemu_conf(1), quickgui(1)
.SH AUTHORS