mirror of
https://github.com/oSoWoSo/DistroHopper.git
synced 2024-08-14 22:46:53 +00:00
chore: regenerated docs
includes revised Windows changes and aligned usage() output
This commit is contained in:
Phil Clifford
Martin Wimpress
parent
b232bbfcfe
commit
acca8cc224
8 changed files with 441 additions and 164 deletions
|
|
@ -273,7 +273,7 @@ with your preferred flavour.
|
|||
- `gentoo` (Gentoo)
|
||||
- `ghostbsd` (GhostBSD)
|
||||
- `haiku` (Haiku)
|
||||
- `holoiso` (HoloISO)
|
||||
- `holoiso` (SteamOS HoloISO)
|
||||
- `kali` (Kali)
|
||||
- `kdeneon` (KDE Neon)
|
||||
- `kolibrios` (KolibriOS)
|
||||
|
|
@ -491,8 +491,8 @@ 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/).
|
||||
|
||||
Windows 8.1 is also supported but doesn't feature any automated installation or
|
||||
driver optimisation.
|
||||
Windows 8.1 is also supported but doesn't feature any automated
|
||||
installation or driver optimisation.
|
||||
|
||||
``` bash
|
||||
quickget windows 11
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Subproject commit 15b126e5b583a02074da11c189c8bc9b9247c8a0
|
||||
Subproject commit d9beb09f107f1d97d548d0524926e8246aa5c119
|
||||
441
docs/quickemu.1
441
docs/quickemu.1
|
|
@ -1,6 +1,6 @@
|
|||
.\" Automatically generated by Pandoc 3.1.8
|
||||
.\" Automatically generated by Pandoc 3.1.9
|
||||
.\"
|
||||
.TH "QUICKEMU" "1" "October 24, 2023" "quickemu" "Quickemu User Manual"
|
||||
.TH "QUICKEMU" "1" "November 10, 2023" "quickemu" "Quickemu User Manual"
|
||||
.SH NAME
|
||||
quickemu - A quick VM builder and manager
|
||||
.SH SYNOPSIS
|
||||
|
|
@ -88,8 +88,15 @@ Windows\f[R].
|
|||
.IP \[bu] 2
|
||||
\f[B]Windows\f[R] 10 and 11 including TPM 2.0
|
||||
.IP \[bu] 2
|
||||
Ubuntu (https://ubuntu.com/desktop) and all the \f[B]official Ubuntu
|
||||
flavours (https://ubuntu.com/download/flavours)\f[R]
|
||||
\c
|
||||
.UR https://ubuntu.com/desktop
|
||||
Ubuntu
|
||||
.UE \c
|
||||
\ and all the \f[B]\c
|
||||
.UR https://ubuntu.com/download/flavours
|
||||
official Ubuntu flavours
|
||||
.UE \c
|
||||
\f[R]
|
||||
.IP \[bu] 2
|
||||
\f[B]Over 360 operating system editions are supported!\f[R]
|
||||
.IP \[bu] 2
|
||||
|
|
@ -99,8 +106,11 @@ VirtIO-webdavd file sharing for Linux and Windows guests
|
|||
.IP \[bu] 2
|
||||
VirtIO-9p file sharing for Linux and macOS guests
|
||||
.IP \[bu] 2
|
||||
QEMU Guest Agent support (https://wiki.qemu.org/Features/GuestAgent);
|
||||
provides access to a system-level agent via standard QMP commands
|
||||
\c
|
||||
.UR https://wiki.qemu.org/Features/GuestAgent
|
||||
QEMU Guest Agent support
|
||||
.UE \c
|
||||
; provides access to a system-level agent via standard QMP commands
|
||||
.IP \[bu] 2
|
||||
Samba file sharing for Linux, macOS and Windows guests (\f[I]if
|
||||
\f[CI]smbd\f[I] is installed on the host\f[R])
|
||||
|
|
@ -123,70 +133,164 @@ EFI (with or without SecureBoot) and Legacy BIOS boot
|
|||
.IP \[bu] 2
|
||||
Graphical user interfaces available
|
||||
.PP
|
||||
Quickemu is a wrapper for the excellent QEMU (https://www.qemu.org/)
|
||||
that attempts to automatically \f[I]\[lq]do the right thing\[rq]\f[R],
|
||||
Quickemu is a wrapper for the excellent \c
|
||||
.UR https://www.qemu.org/
|
||||
QEMU
|
||||
.UE \c
|
||||
\ that attempts to automatically \f[I]\[lq]do the right thing\[rq]\f[R],
|
||||
rather than expose exhaustive configuration options.
|
||||
.PP
|
||||
We have a Discord for this project:
|
||||
[IMAGE: Discord (https://img.shields.io/discord/712850672223125565?color=0C306A&label=WimpysWorld%20Discord&logo=Discord&logoColor=ffffff&style=flat-square)] (https://discord.gg/sNmz3uw)
|
||||
We have a Discord for this project: \c
|
||||
.UR https://discord.gg/sNmz3uw
|
||||
[IMAGE: \c
|
||||
.UR
|
||||
https://img.shields.io/discord/712850672223125565?color=0C306A&label=WimpysWorld%20Discord&logo=Discord&logoColor=ffffff&style=flat-square
|
||||
Discord
|
||||
.UE \c
|
||||
]
|
||||
.UE \c
|
||||
.PP
|
||||
See this (old) video where I explain some of my motivations for creating
|
||||
Quickemu.
|
||||
.PP
|
||||
[IMAGE: Replace VirtualBox with Bash &
|
||||
QEMU (https://img.youtube.com/vi/AOTYWEgw0hI/0.jpg)] (https://www.youtube.com/watch?v=AOTYWEgw0hI)
|
||||
\c
|
||||
.UR https://www.youtube.com/watch?v=AOTYWEgw0hI
|
||||
[IMAGE: \c
|
||||
.UR https://img.youtube.com/vi/AOTYWEgw0hI/0.jpg
|
||||
Replace VirtualBox with Bash & QEMU
|
||||
.UE \c
|
||||
]
|
||||
.UE \c
|
||||
.SS Requirements
|
||||
.IP \[bu] 2
|
||||
QEMU (https://www.qemu.org/) (\f[I]6.0.0 or newer\f[R]) \f[B]with GTK,
|
||||
SDL, SPICE & VirtFS support\f[R]
|
||||
\c
|
||||
.UR https://www.qemu.org/
|
||||
QEMU
|
||||
.UE \c
|
||||
\ (\f[I]6.0.0 or newer\f[R]) \f[B]with GTK, SDL, SPICE & VirtFS
|
||||
support\f[R]
|
||||
.IP \[bu] 2
|
||||
bash (https://www.gnu.org/software/bash/) (\f[I]4.0 or newer\f[R])
|
||||
\c
|
||||
.UR https://www.gnu.org/software/bash/
|
||||
bash
|
||||
.UE \c
|
||||
\ (\f[I]4.0 or newer\f[R])
|
||||
.IP \[bu] 2
|
||||
Coreutils (https://www.gnu.org/software/coreutils/)
|
||||
\c
|
||||
.UR https://www.gnu.org/software/coreutils/
|
||||
Coreutils
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
EDK II (https://github.com/tianocore/edk2)
|
||||
\c
|
||||
.UR https://github.com/tianocore/edk2
|
||||
EDK II
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
grep (https://www.gnu.org/software/grep/)
|
||||
\c
|
||||
.UR https://www.gnu.org/software/grep/
|
||||
grep
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
jq (https://stedolan.github.io/jq/)
|
||||
\c
|
||||
.UR https://stedolan.github.io/jq/
|
||||
jq
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
LSB (https://wiki.linuxfoundation.org/lsb/start)
|
||||
\c
|
||||
.UR https://wiki.linuxfoundation.org/lsb/start
|
||||
LSB
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
procps (https://gitlab.com/procps-ng/procps)
|
||||
\c
|
||||
.UR https://gitlab.com/procps-ng/procps
|
||||
procps
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
python3 (https://www.python.org/)
|
||||
\c
|
||||
.UR https://www.python.org/
|
||||
python3
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
macrecovery (https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macrecovery)
|
||||
\c
|
||||
.UR
|
||||
https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macrecovery
|
||||
macrecovery
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
mkisofs (http://cdrtools.sourceforge.net/private/cdrecord.html)
|
||||
\c
|
||||
.UR http://cdrtools.sourceforge.net/private/cdrecord.html
|
||||
mkisofs
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
usbutils (https://github.com/gregkh/usbutils)
|
||||
\c
|
||||
.UR https://github.com/gregkh/usbutils
|
||||
usbutils
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
util-linux (https://github.com/karelzak/util-linux)
|
||||
\c
|
||||
.UR https://github.com/karelzak/util-linux
|
||||
util-linux
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
sed (https://www.gnu.org/software/sed/)
|
||||
\c
|
||||
.UR https://www.gnu.org/software/sed/
|
||||
sed
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
socat (http://www.dest-unreach.org/socat/)
|
||||
\c
|
||||
.UR http://www.dest-unreach.org/socat/
|
||||
socat
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
spicy (https://gitlab.freedesktop.org/spice/spice-gtk)
|
||||
\c
|
||||
.UR https://gitlab.freedesktop.org/spice/spice-gtk
|
||||
spicy
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
swtpm (https://github.com/stefanberger/swtpm)
|
||||
\c
|
||||
.UR https://github.com/stefanberger/swtpm
|
||||
swtpm
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
Wget (https://www.gnu.org/software/wget/)
|
||||
\c
|
||||
.UR https://www.gnu.org/software/wget/
|
||||
Wget
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
xdg-user-dirs (https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)
|
||||
\c
|
||||
.UR https://www.freedesktop.org/wiki/Software/xdg-user-dirs/
|
||||
xdg-user-dirs
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
xrandr (https://gitlab.freedesktop.org/xorg/app/xrandr)
|
||||
\c
|
||||
.UR https://gitlab.freedesktop.org/xorg/app/xrandr
|
||||
xrandr
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
zsync (http://zsync.moria.org.uk/)
|
||||
\c
|
||||
.UR http://zsync.moria.org.uk/
|
||||
zsync
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
unzip (http://www.info-zip.org/UnZip.html)
|
||||
\c
|
||||
.UR http://www.info-zip.org/UnZip.html
|
||||
unzip
|
||||
.UE \c
|
||||
.SS Installing Requirements
|
||||
For Ubuntu, Arch and nixos systems the
|
||||
ppa (https://launchpad.net/~flexiondotorg/+archive/ubuntu/quickemu),
|
||||
AUR (https://aur.archlinux.org/packages/quickemu) or
|
||||
nix (https://github.com/NixOS/nixpkgs/tree/master/pkgs/development/quickemu)
|
||||
packaging will take care of the dependencies.
|
||||
For Ubuntu, Arch and nixos systems the \c
|
||||
.UR https://launchpad.net/~flexiondotorg/+archive/ubuntu/quickemu
|
||||
ppa
|
||||
.UE \c
|
||||
, \c
|
||||
.UR https://aur.archlinux.org/packages/quickemu
|
||||
AUR
|
||||
.UE \c
|
||||
\ or \c
|
||||
.UR
|
||||
https://github.com/NixOS/nixpkgs/tree/master/pkgs/development/quickemu
|
||||
nix
|
||||
.UE \c
|
||||
\ packaging will take care of the dependencies.
|
||||
For other host distributions or operating systems it will be necessary
|
||||
to install the above requirements or their equivalents.
|
||||
.PP
|
||||
|
|
@ -206,9 +310,11 @@ sudo dnf install qemu bash coreutils edk2-tools grep jq lsb procps python3 genis
|
|||
.PP
|
||||
MacOS:
|
||||
.PP
|
||||
This is a work in progress (see issue
|
||||
248 (https://github.com/quickemu-project/quickemu/issues/248) for other
|
||||
steps and changes that may enable running on MacOS)
|
||||
This is a work in progress (see \c
|
||||
.UR https://github.com/quickemu-project/quickemu/issues/248
|
||||
issue 248
|
||||
.UE \c
|
||||
\ for other steps and changes that may enable running on MacOS)
|
||||
.IP
|
||||
.EX
|
||||
brew install qemu bash coreutils grep jq python\[at]3.10 cdrtools gnu-sed spice-gtk wget zsync
|
||||
|
|
@ -218,13 +324,33 @@ brew install qemu bash coreutils grep jq python\[at]3.10 cdrtools gnu-sed spice-
|
|||
While \f[CR]quickemu\f[R] and \f[CR]quickget\f[R] are designed for the
|
||||
terminal, a graphical user interface is also available:
|
||||
.IP \[bu] 2
|
||||
\f[B]Quickgui (https://github.com/quickgui/quickgui)\f[R] by Mark
|
||||
Johnson (https://github.com/marxjohnson) and Yannick
|
||||
Mauray (https://github.com/ymauray).
|
||||
\f[B]\c
|
||||
.UR https://github.com/quickgui/quickgui
|
||||
Quickgui
|
||||
.UE \c
|
||||
\f[R] by \c
|
||||
.UR https://github.com/marxjohnson
|
||||
Mark Johnson
|
||||
.UE \c
|
||||
\ and \c
|
||||
.UR https://github.com/ymauray
|
||||
Yannick Mauray
|
||||
.UE \c
|
||||
\&.
|
||||
.PP
|
||||
Many thanks to Luke Wesley-Holley (https://github.com/Lukewh) and
|
||||
Philipp Kiemle (https://github.com/daPhipz) for creating the
|
||||
\f[B]Quickemu icons (https://github.com/Lukewh/quickemu-icons)\f[R] 🎨
|
||||
Many thanks to \c
|
||||
.UR https://github.com/Lukewh
|
||||
Luke Wesley-Holley
|
||||
.UE \c
|
||||
\ and \c
|
||||
.UR https://github.com/daPhipz
|
||||
Philipp Kiemle
|
||||
.UE \c
|
||||
\ for creating the \f[B]\c
|
||||
.UR https://github.com/Lukewh/quickemu-icons
|
||||
Quickemu icons
|
||||
.UE \c
|
||||
\f[R] 🎨
|
||||
.SS Quickgui for Ubuntu
|
||||
.IP
|
||||
.EX
|
||||
|
|
@ -356,7 +482,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
|
||||
|
|
@ -603,21 +729,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].
|
||||
|
|
@ -636,19 +773,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
|
||||
|
|
@ -667,17 +818,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.
|
||||
|
|
@ -701,7 +863,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
|
||||
|
|
@ -720,6 +882,7 @@ Usage
|
|||
quickemu --vm ubuntu.conf
|
||||
|
||||
You can also pass optional parameters
|
||||
--access : Enable remote spice access support. \[aq]local\[aq] (default), \[aq]remote\[aq], \[aq]clientipaddress\[aq]
|
||||
--braille : Enable braille support. Requires SDL.
|
||||
--delete-disk : Delete the disk image and EFI variables
|
||||
--delete-vm : Delete the entire VM and it\[aq]s configuration
|
||||
|
|
@ -820,81 +983,147 @@ Useful reference that assisted the development of Quickemu.
|
|||
General
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
QEMU\[cq]s documentation! (https://qemu.readthedocs.io/en/latest/)
|
||||
\c
|
||||
.UR https://qemu.readthedocs.io/en/latest/
|
||||
QEMU\[cq]s documentation!
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines>
|
||||
\c
|
||||
.UR https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://www.kraxel.org/blog/2020/01/qemu-sound-audiodev/>
|
||||
\c
|
||||
.UR https://www.kraxel.org/blog/2020/01/qemu-sound-audiodev/
|
||||
.UE \c
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
macOS
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
<https://www.nicksherlock.com/2020/06/installing-macos-big-sur-on-proxmox/>
|
||||
\c
|
||||
.UR
|
||||
https://www.nicksherlock.com/2020/06/installing-macos-big-sur-on-proxmox/
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://passthroughpo.st/mac-os-adds-early-support-for-virtio-qemu/>
|
||||
\c
|
||||
.UR https://passthroughpo.st/mac-os-adds-early-support-for-virtio-qemu/
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://github.com/kholia/OSX-KVM>
|
||||
\c
|
||||
.UR https://github.com/kholia/OSX-KVM
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://github.com/thenickdude/KVM-Opencore>
|
||||
\c
|
||||
.UR https://github.com/thenickdude/KVM-Opencore
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macrecovery>
|
||||
\c
|
||||
.UR
|
||||
https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macrecovery
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://www.kraxel.org/blog/2017/09/running-macos-as-guest-in-kvm/>
|
||||
\c
|
||||
.UR https://www.kraxel.org/blog/2017/09/running-macos-as-guest-in-kvm/
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://www.nicksherlock.com/2017/10/passthrough-of-advanced-cpu-features-for-macos-high-sierra-guests/>
|
||||
\c
|
||||
.UR
|
||||
https://www.nicksherlock.com/2017/10/passthrough-of-advanced-cpu-features-for-macos-high-sierra-guests/
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<http://philjordan.eu/osx-virt/>
|
||||
\c
|
||||
.UR http://philjordan.eu/osx-virt/
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://github.com/Dids/clover-builder>
|
||||
\c
|
||||
.UR https://github.com/Dids/clover-builder
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
OpenCore Configurator (https://mackie100projects.altervista.org)
|
||||
\c
|
||||
.UR https://mackie100projects.altervista.org
|
||||
OpenCore Configurator
|
||||
.UE \c
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
Windows
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
<https://www.heiko-sieger.info/running-windows-10-on-linux-using-kvm-with-vga-passthrough/>
|
||||
\c
|
||||
.UR
|
||||
https://www.heiko-sieger.info/running-windows-10-on-linux-using-kvm-with-vga-passthrough/
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://leduccc.medium.com/improving-the-performance-of-a-windows-10-guest-on-qemu-a5b3f54d9cf5>
|
||||
\c
|
||||
.UR
|
||||
https://leduccc.medium.com/improving-the-performance-of-a-windows-10-guest-on-qemu-a5b3f54d9cf5
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://frontpagelinux.com/tutorials/how-to-use-linux-kvm-to-optimize-your-windows-10-virtual-machine/>
|
||||
\c
|
||||
.UR
|
||||
https://frontpagelinux.com/tutorials/how-to-use-linux-kvm-to-optimize-your-windows-10-virtual-machine/
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://turlucode.com/qemu-command-line-args/>
|
||||
\c
|
||||
.UR https://turlucode.com/qemu-command-line-args/
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://github.com/pbatard/Fido>
|
||||
\c
|
||||
.UR https://github.com/pbatard/Fido
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://www.catapultsystems.com/blogs/create-zero-touch-windows-10-iso/>
|
||||
\c
|
||||
.UR
|
||||
https://www.catapultsystems.com/blogs/create-zero-touch-windows-10-iso/
|
||||
.UE \c
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
TPM
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
<https://qemu-project.gitlab.io/qemu/specs/tpm.html>
|
||||
\c
|
||||
.UR https://qemu-project.gitlab.io/qemu/specs/tpm.html
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://www.tecklyfe.com/how-to-create-a-windows-11-virtual-machine-in-qemu/>
|
||||
\c
|
||||
.UR
|
||||
https://www.tecklyfe.com/how-to-create-a-windows-11-virtual-machine-in-qemu/
|
||||
.UE \c
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
9p & virtiofs
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
<https://wiki.qemu.org/Documentation/9p>
|
||||
\c
|
||||
.UR https://wiki.qemu.org/Documentation/9p
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://wiki.qemu.org/Documentation/9psetup>
|
||||
\c
|
||||
.UR https://wiki.qemu.org/Documentation/9psetup
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://www.kraxel.org/blog/2019/06/macos-qemu-guest/>
|
||||
\c
|
||||
.UR https://www.kraxel.org/blog/2019/06/macos-qemu-guest/
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://superuser.com/questions/628169/how-to-share-a-directory-with-the-host-without-networking-in-qemu>
|
||||
\c
|
||||
.UR
|
||||
https://superuser.com/questions/628169/how-to-share-a-directory-with-the-host-without-networking-in-qemu
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
<https://virtio-fs.gitlab.io/>
|
||||
\c
|
||||
.UR https://virtio-fs.gitlab.io/
|
||||
.UE \c
|
||||
.RE
|
||||
.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_conf(1), quickget(1), quickgui(1)
|
||||
.SH AUTHORS
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
author: Martin Wimpress
|
||||
date: October 24, 2023
|
||||
date: November 10, 2023
|
||||
footer: quickemu
|
||||
header: Quickemu User Manual
|
||||
section: 1
|
||||
|
|
@ -27,9 +27,6 @@ machines for Linux, macOS and Windows
|
|||
|
||||
You can also pass optional parameters
|
||||
|
||||
**--access**
|
||||
: Enable remote spice access support. 'local' (default), 'remote', 'clientipaddress'
|
||||
|
||||
**--braille**
|
||||
: Enable braille support. Requires SDL.
|
||||
|
||||
|
|
@ -295,7 +292,7 @@ with your preferred flavour.
|
|||
- `gentoo` (Gentoo)
|
||||
- `ghostbsd` (GhostBSD)
|
||||
- `haiku` (Haiku)
|
||||
- `holoiso` (HoloISO)
|
||||
- `holoiso` (SteamOS HoloISO)
|
||||
- `kali` (Kali)
|
||||
- `kdeneon` (KDE Neon)
|
||||
- `kolibrios` (KolibriOS)
|
||||
|
|
@ -510,7 +507,7 @@ sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
|
|||
|
||||
Now reboot, and the App Store should work.
|
||||
|
||||
## Windows 10 & 11 Guests
|
||||
## Windows 8, 10 & 11 Guests
|
||||
|
||||
`quickget` can download
|
||||
[Windows10](https://www.microsoft.com/software-download/windows10) and
|
||||
|
|
@ -519,9 +516,12 @@ 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/).
|
||||
|
||||
Windows 8.1 is also supported but doesn't feature any automated
|
||||
installation or driver optimisation.
|
||||
|
||||
``` bash
|
||||
quickget windows 11
|
||||
quickemu --vm windows-11-22H2.conf
|
||||
quickemu --vm windows-11.conf
|
||||
```
|
||||
|
||||
- Complete the installation as you normally would.
|
||||
|
|
@ -539,7 +539,7 @@ disk_img="windows-11/disk.qcow2"
|
|||
iso="windows-11/windows-11.iso"
|
||||
fixed_iso="windows-11/virtio-win.iso"
|
||||
tpm="on"
|
||||
secureboot="on"
|
||||
secureboot="off"
|
||||
```
|
||||
|
||||
- `guest_os="windows"` instructs `quickemu` to optimise for Windows.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Automatically generated by Pandoc 3.1.8
|
||||
.\" Automatically generated by Pandoc 3.1.9
|
||||
.\"
|
||||
.TH "QUICKEMU_CONF" "1" "October 24, 2023" "quickemu_conf" "Quickemu Configuration Manual"
|
||||
.TH "QUICKEMU_CONF" "1" "November 10, 2023" "quickemu_conf" "Quickemu Configuration Manual"
|
||||
.SH NAME
|
||||
quickemu_conf - Options and parameters in the quickemu <vm>.conf
|
||||
.SH DESCRIPTION
|
||||
|
|
@ -143,8 +143,11 @@ following line to the VM configuration:
|
|||
.IP \[bu] 2
|
||||
\f[CR]fixed_iso=\[dq]/path/to/image.iso\[dq]\f[R]
|
||||
.SS Floppy disks
|
||||
If you\[cq]re like Alan Pope (https://popey.com) you\[cq]ll probably
|
||||
want to mount a floppy disk image in the guest.
|
||||
If you\[cq]re like \c
|
||||
.UR https://popey.com
|
||||
Alan Pope
|
||||
.UE \c
|
||||
\ you\[cq]ll probably want to mount a floppy disk image in the guest.
|
||||
To do so add the following line to the VM configuration:
|
||||
.IP \[bu] 2
|
||||
\f[CR]floppy=\[dq]/path/to/floppy.img\[dq]\f[R]
|
||||
|
|
@ -267,10 +270,13 @@ virtual machines.
|
|||
.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
|
||||
quickget(1), quickemu(1), quickgui(1)
|
||||
.SH AUTHORS
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
author: Martin Wimpress
|
||||
date: October 24, 2023
|
||||
date: November 10, 2023
|
||||
footer: quickemu_conf
|
||||
header: Quickemu Configuration Manual
|
||||
section: 1
|
||||
|
|
|
|||
105
docs/quickget.1
105
docs/quickget.1
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
author: Martin Wimpress
|
||||
date: October 24, 2023
|
||||
date: November 10, 2023
|
||||
footer: quickget
|
||||
header: Quickget User Manual
|
||||
section: 1
|
||||
|
|
@ -119,7 +119,7 @@ with your preferred flavour.
|
|||
- `gentoo` (Gentoo)
|
||||
- `ghostbsd` (GhostBSD)
|
||||
- `haiku` (Haiku)
|
||||
- `holoiso` (HoloISO)
|
||||
- `holoiso` (SteamOS HoloISO)
|
||||
- `kali` (Kali)
|
||||
- `kdeneon` (KDE Neon)
|
||||
- `kolibrios` (KolibriOS)
|
||||
|
|
@ -334,7 +334,7 @@ sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
|
|||
|
||||
Now reboot, and the App Store should work.
|
||||
|
||||
## Windows 10 & 11 Guests
|
||||
## Windows 8, 10 & 11 Guests
|
||||
|
||||
`quickget` can download
|
||||
[Windows10](https://www.microsoft.com/software-download/windows10) and
|
||||
|
|
@ -343,9 +343,12 @@ 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/).
|
||||
|
||||
Windows 8.1 is also supported but doesn't feature any automated
|
||||
installation or driver optimisation.
|
||||
|
||||
``` bash
|
||||
quickget windows 11
|
||||
quickemu --vm windows-11-22H2.conf
|
||||
quickemu --vm windows-11.conf
|
||||
```
|
||||
|
||||
- Complete the installation as you normally would.
|
||||
|
|
@ -363,7 +366,7 @@ disk_img="windows-11/disk.qcow2"
|
|||
iso="windows-11/windows-11.iso"
|
||||
fixed_iso="windows-11/virtio-win.iso"
|
||||
tpm="on"
|
||||
secureboot="on"
|
||||
secureboot="off"
|
||||
```
|
||||
|
||||
- `guest_os="windows"` instructs `quickemu` to optimise for Windows.
|
||||
|
|
|
|||
Loading…
Reference in a new issue