1325 lines
36 KiB
Groff
1325 lines
36 KiB
Groff
.\" Automatically generated by Pandoc 3.2
|
|
.\"
|
|
.TH "QUICKEMU" "1" "May 13, 2024" "quickemu" "Quickemu User Manual"
|
|
.SH NAME
|
|
quickemu \- A quick VM builder and manager
|
|
.SH SYNOPSIS
|
|
\f[B]quickemu\f[R] [\f[I]OPTION\f[R]]\&...
|
|
.SH DESCRIPTION
|
|
\f[B]quickemu\f[R] will create and run highly optimised desktop virtual
|
|
machines for Linux, macOS and Windows
|
|
.SH OPTIONS
|
|
.TP
|
|
\f[B]\-\-vm\f[R]
|
|
vm configuration file
|
|
.PP
|
|
You can also pass optional parameters
|
|
.TP
|
|
\f[B]\-\-access\f[R]
|
|
Enable remote spice access support.
|
|
\[oq]local\[cq] (default), \[oq]remote\[cq], \[oq]clientipaddress\[cq]
|
|
.TP
|
|
\f[B]\-\-braille\f[R]
|
|
Enable braille support.
|
|
Requires SDL.
|
|
.TP
|
|
\f[B]\-\-delete\-disk\f[R]
|
|
Delete the disk image and EFI variables
|
|
.TP
|
|
\f[B]\-\-delete\-vm\f[R]
|
|
Delete the entire VM and its configuration
|
|
.TP
|
|
\f[B]\-\-display\f[R]
|
|
Select display backend.
|
|
\[oq]sdl\[cq] (default), \[oq]gtk\[cq], \[oq]none\[cq], \[oq]spice\[cq]
|
|
or \[oq]spice\-app\[cq]
|
|
.TP
|
|
\f[B]\-\-fullscreen\f[R]
|
|
Starts VM in full screen mode (Ctl+Alt+f to exit)
|
|
.TP
|
|
\f[B]\-\-ignore\-msrs\-always\f[R]
|
|
Configure KVM to always ignore unhandled machine\-specific registers
|
|
.TP
|
|
\f[B]\-\-kill\f[R]
|
|
Kill the VM process if it is running
|
|
.TP
|
|
\f[B]\-\-offline\f[R]
|
|
Override all network settings and start the VM offline
|
|
.TP
|
|
\f[B]\-\-shortcut\f[R]
|
|
Create a desktop shortcut
|
|
.TP
|
|
\f[B]\-\-snapshot apply <tag>\f[R]
|
|
Apply/restore a snapshot.
|
|
.TP
|
|
\f[B]\-\-snapshot create <tag>\f[R]
|
|
Create a snapshot.
|
|
.TP
|
|
\f[B]\-\-snapshot delete <tag>\f[R]
|
|
Delete a snapshot.
|
|
.TP
|
|
\f[B]\-\-snapshot info\f[R]
|
|
Show disk/snapshot info.
|
|
.TP
|
|
\f[B]\-\-status\-quo\f[R]
|
|
Do not commit any changes to disk/snapshot.
|
|
.TP
|
|
\f[B]\-\-viewer <viewer>\f[R]
|
|
Choose an alternative viewer.
|
|
\[at]Options: \[oq]spicy\[cq] (default), \[oq]remote\-viewer\[cq],
|
|
\[oq]none\[cq]
|
|
.TP
|
|
\f[B]\-\-width <width>\f[R]
|
|
Set VM screen width; requires \[oq]\-\-height\[cq]
|
|
.TP
|
|
\f[B]\-\-height <height>\f[R]
|
|
Set VM screen height; requires \[oq]\-\-width\[cq]
|
|
.TP
|
|
\f[B]\-\-ssh\-port <port>\f[R]
|
|
Set SSH port manually
|
|
.TP
|
|
\f[B]\-\-spice\-port <port>\f[R]
|
|
Set SPICE port manually
|
|
.TP
|
|
\f[B]\-\-public\-dir <path>\f[R]
|
|
Expose share directory.
|
|
\[at]Options: \[cq]\[cq] (default: xdg\-user\-dir PUBLICSHARE),
|
|
\[oq]\[cq], \[oq]none\[cq]
|
|
.TP
|
|
\f[B]\-\-monitor <type>\f[R]
|
|
Set monitor connection type.
|
|
\[at]Options: \[oq]socket\[cq] (default), \[oq]telnet\[cq],
|
|
\[oq]none\[cq]
|
|
.TP
|
|
\f[B]\-\-monitor\-telnet\-host <ip/host>\f[R]
|
|
Set telnet host for monitor.
|
|
(default: \[oq]localhost\[cq])
|
|
.TP
|
|
\f[B]\-\-monitor\-telnet\-port <port>\f[R]
|
|
Set telnet port for monitor.
|
|
(default: \[oq]4440\[cq])
|
|
.TP
|
|
\f[B]\-\-monitor\-cmd <cmd>\f[R]
|
|
Send command to monitor if available.
|
|
(Example: system_powerdown)
|
|
.TP
|
|
\f[B]\-\-serial <type>\f[R]
|
|
Set serial connection type.
|
|
\[at]Options: \[oq]socket\[cq] (default), \[oq]telnet\[cq],
|
|
\[oq]none\[cq]
|
|
.TP
|
|
\f[B]\-\-serial\-telnet\-host <ip/host>\f[R]
|
|
Set telnet host for serial.
|
|
(default: \[oq]localhost\[cq])
|
|
.TP
|
|
\f[B]\-\-serial\-telnet\-port <port>\f[R]
|
|
Set telnet port for serial.
|
|
(default: \[oq]6660\[cq])
|
|
.TP
|
|
\f[B]\-\-keyboard <type>\f[R]
|
|
Set keyboard.
|
|
\[at]Options: \[oq]usb\[cq] (default), \[oq]ps2\[cq], \[oq]virtio\[cq]
|
|
.TP
|
|
\f[B]\-\-keyboard_layout <layout>\f[R]
|
|
Set keyboard layout: \[oq]en\-us\[cq] (default)
|
|
.TP
|
|
\f[B]\-\-mouse <type>\f[R]
|
|
Set mouse.
|
|
\[at]Options: \[oq]tablet\[cq] (default), \[oq]ps2\[cq], \[oq]usb\[cq],
|
|
\[oq]virtio\[cq]
|
|
.TP
|
|
\f[B]\-\-usb\-controller <type>\f[R]
|
|
Set usb\-controller.
|
|
\[at]Options: \[oq]ehci\[cq] (default), \[oq]xhci\[cq], \[oq]none\[cq]
|
|
.TP
|
|
\f[B]\-\-sound\-card <type>\f[R]
|
|
Set sound card.
|
|
\[at]Options: \[oq]intel\-hda\[cq] (default), \[oq]ac97\[cq],
|
|
\[oq]es1370\[cq], \[oq]sb16\[cq], \[oq]none\[cq]
|
|
.TP
|
|
\f[B]\-\-extra_args <arguments>\f[R]
|
|
Pass additional arguments to qemu
|
|
.TP
|
|
\f[B]\-\-version\f[R]
|
|
Print version
|
|
.SH EXAMPLES
|
|
.TP
|
|
\f[B]quickemu \[en]vm ubuntu\-mate\-22.04.conf\f[R]
|
|
Launches the VM specified in the file \f[I]ubuntu\-mate\-22.04.conf\f[R]
|
|
.SH Introduction
|
|
\f[B]Quickemu\f[R] is a wrapper for the excellent \c
|
|
.UR https://www.qemu.org/
|
|
QEMU
|
|
.UE \c
|
|
\ that automatically \f[I]\[lq]does the right thing\[rq]\f[R] when
|
|
creating virtual machines.
|
|
No requirement for exhaustive configuration options.
|
|
You decide what operating system you want to run and Quickemu takes care
|
|
of the rest 🤖
|
|
.IP \[bu] 2
|
|
\f[CR]quickget\f[R] \f[B]automatically downloads the upstream OS\f[R]
|
|
and creates the configuration 📀
|
|
.IP \[bu] 2
|
|
\f[CR]quickemu\f[R] enumerates your hardware and launches the virtual
|
|
machine with the \f[B]optimum configuration best suited to your
|
|
computer\f[R] ⚡️
|
|
.PP
|
|
The original objective of the project was to \c
|
|
.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines
|
|
enable quick testing of Linux distributions
|
|
.UE \c
|
|
\ where the virtual machines and their configuration can be stored
|
|
anywhere (such as external USB storage or your home directory) and no
|
|
elevated permissions are required to run the virtual machines.
|
|
.PP
|
|
\f[B]Today, Quickemu includes comprehensive support for \c
|
|
.UR https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines
|
|
macOS
|
|
.UE \c
|
|
, \c
|
|
.UR https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines
|
|
Windows
|
|
.UE \c
|
|
\f[R], most of the BSDs, novel non\-Linux operating systems such as
|
|
FreeDOS, Haiku, KolibriOS, OpenIndiana, ReactOS, and more.
|
|
.SH Features
|
|
.IP \[bu] 2
|
|
\f[B]macOS\f[R] Sonoma, Ventura, Monterey, Big Sur, Catalina & Mojave
|
|
.IP \[bu] 2
|
|
\f[B]Windows\f[R] 10 and 11 including TPM 2.0
|
|
.IP \[bu] 2
|
|
\f[B]Windows Server\f[R] 2022 2019 2016 2012\-r2
|
|
.IP \[bu] 2
|
|
\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]Nearly 1000 operating system editions are supported!\f[R]
|
|
.IP \[bu] 2
|
|
Full SPICE support including host/guest clipboard sharing
|
|
.IP \[bu] 2
|
|
VirtIO\-webdavd file sharing for Linux and Windows guests
|
|
.IP \[bu] 2
|
|
VirtIO\-9p file sharing for Linux and macOS guests
|
|
.IP \[bu] 2
|
|
\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])
|
|
.IP \[bu] 2
|
|
VirGL acceleration
|
|
.IP \[bu] 2
|
|
USB device pass\-through
|
|
.IP \[bu] 2
|
|
Smartcard pass\-through
|
|
.IP \[bu] 2
|
|
Automatic SSH port forwarding to guests
|
|
.IP \[bu] 2
|
|
Network port forwarding
|
|
.IP \[bu] 2
|
|
Full duplex audio
|
|
.IP \[bu] 2
|
|
Braille support
|
|
.IP \[bu] 2
|
|
EFI (with or without SecureBoot) and Legacy BIOS boot
|
|
.PP
|
|
When installing from source, you will need to install the following
|
|
requirements manually:
|
|
.IP \[bu] 2
|
|
\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
|
|
\c
|
|
.UR https://www.gnu.org/software/bash/
|
|
bash
|
|
.UE \c
|
|
\ (\f[I]4.0 or newer\f[R])
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://www.gnu.org/software/coreutils/
|
|
Coreutils
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://curl.se/
|
|
curl
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://github.com/tianocore/edk2
|
|
EDK II
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://www.gnu.org/software/gawk/
|
|
gawk
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://www.gnu.org/software/grep/
|
|
grep
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://gitlab.freedesktop.org/mesa/demos
|
|
glxinfo
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://stedolan.github.io/jq/
|
|
jq
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://wiki.linuxfoundation.org/lsb/start
|
|
LSB
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://github.com/pciutils/pciutils
|
|
pciutils
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://gitlab.com/procps-ng/procps
|
|
procps
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://www.python.org/
|
|
python3
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR http://cdrtools.sourceforge.net/private/cdrecord.html
|
|
mkisofs
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://github.com/gregkh/usbutils
|
|
usbutils
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://github.com/karelzak/util-linux
|
|
util\-linux
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://www.gnu.org/software/sed/
|
|
sed
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR http://www.dest-unreach.org/socat/
|
|
socat
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://gitlab.freedesktop.org/spice/spice-gtk
|
|
spicy
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://github.com/stefanberger/swtpm
|
|
swtpm
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://www.freedesktop.org/wiki/Software/xdg-user-dirs/
|
|
xdg\-user\-dirs
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://gitlab.freedesktop.org/xorg/app/xrandr
|
|
xrandr
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR http://zsync.moria.org.uk/
|
|
zsync
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR http://www.info-zip.org/UnZip.html
|
|
unzip
|
|
.UE \c
|
|
.PP
|
|
For Ubuntu, Arch and NixOS hosts, 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
|
|
These examples may save a little typing:
|
|
.SS Install requirements on Debian hosts
|
|
This also applies to derivatives:
|
|
.IP
|
|
.EX
|
|
sudo apt install qemu bash coreutils ovmf grep jq mesa\-utils pciutils procps python3 genisoimage usbutils util\-linux sed socat spice\-client\-gtk libtss2\-tcti\-swtpm0 xdg\-user\-dirs zsync unzip
|
|
.EE
|
|
.SS Install requirements on Fedora hosts
|
|
.IP
|
|
.EX
|
|
sudo dnf install qemu bash coreutils edk2\-tools grep jq mesa\-demos pciutils procps python3 genisoimage usbutils util\-linux sed socat spice\-gtk\-tools swtpm xdg\-user\-dirs xrandr unzip
|
|
.EE
|
|
.SS Install requirements on Gentoo
|
|
Please note that you may have to use \f[CR]sys\-firmware/edk2\-ovmf\f[R]
|
|
instead of \f[CR]sys\-firmware/edk2\-ovmf\-bin\f[R] \- depending on how
|
|
your system is configured.
|
|
.IP
|
|
.EX
|
|
sudo emerge \-\-ask \-\-noreplace app\-emulation/qemu \[rs]
|
|
app\-shells/bash \[rs]
|
|
sys\-apps/coreutils \[rs]
|
|
net\-misc/curl \[rs]
|
|
sys\-firmware/edk2\-ovmf\-bin \[rs]
|
|
sys\-apps/gawk \[rs]
|
|
sys\-apps/grep \[rs]
|
|
x11\-apps/mesa\-progs \[rs]
|
|
app\-misc/jq \[rs]
|
|
sys\-apps/pciutils \[rs]
|
|
sys\-process/procps \[rs]
|
|
app\-cdr/cdrtools \[rs]
|
|
sys\-apps/usbutils \[rs]
|
|
sys\-apps/util\-linux \[rs]
|
|
sys\-apps/sed \[rs]
|
|
net\-misc/socat \[rs]
|
|
app\-emulation/spice \[rs]
|
|
app\-crypt/swtpm \[rs]
|
|
x11\-misc/xdg\-user\-dirs \[rs]
|
|
x11\-apps/xrandr \[rs]
|
|
net\-misc/zsync \[rs]
|
|
app\-arch/unzip
|
|
.EE
|
|
.SS Install requirements on macOS hosts
|
|
This is a \f[B]work in progress\f[R] (see \c
|
|
.UR https://github.com/quickemu-project/quickemu/issues/447
|
|
issue 447
|
|
.UE \c
|
|
\ for other steps and changes that may enable running on MacOS)
|
|
.IP
|
|
.EX
|
|
brew install qemu bash coreutils curl grep jq pciutils python\[at]3.10 cdrtools gnu\-sed spice\-gtk zsync
|
|
.EE
|
|
.SS \c
|
|
.UR https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends
|
|
Alternative Frontends
|
|
.UE \c
|
|
.SS Quickgui
|
|
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]\c
|
|
.UR https://github.com/quickemu-project/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
|
|
To install Quickgui on Ubuntu:
|
|
.IP
|
|
.EX
|
|
sudo add\-apt\-repository ppa:yannick\-mauray/quickgui
|
|
sudo apt update
|
|
sudo apt install quickgui
|
|
.EE
|
|
.PP
|
|
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 qqX
|
|
There is also a multi option desktop integrated text interface, the
|
|
\f[B]quickemu quickget X terminal project\f[R], or \f[B]qqX\f[R], with
|
|
lots of unique tools and utilities to help you make light work of
|
|
installations, snapshots and disk management
|
|
.IP \[bu] 2
|
|
\f[B]\c
|
|
.UR https://github.com/TuxVinyards/qqX
|
|
qqX
|
|
.UE \c
|
|
\f[R] is independently curated by \c
|
|
.UR https://github.com/TuxVinyards
|
|
Alex Genovese
|
|
.UE \c
|
|
\ (see the github pages)
|
|
.SS Creating Linux guests 🐧
|
|
.SS Ubuntu
|
|
\f[CR]quickget\f[R] will automatically download an Ubuntu release and
|
|
create the virtual machine configuration.
|
|
.IP
|
|
.EX
|
|
quickget ubuntu 22.04
|
|
quickemu \-\-vm ubuntu\-22.04.conf
|
|
.EE
|
|
.IP \[bu] 2
|
|
Complete the installation as normal.
|
|
.IP \[bu] 2
|
|
Post\-install:
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
Install the SPICE agent (\f[CR]spice\-vdagent\f[R]) in the guest to
|
|
enable copy/paste and USB redirection
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
\f[CR]sudo apt install spice\-vdagent\f[R]
|
|
.RE
|
|
.IP \[bu] 2
|
|
Install the SPICE WebDAV agent (\f[CR]spice\-webdavd\f[R]) in the guest
|
|
to enable file sharing.
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
\f[CR]sudo apt install spice\-webdavd\f[R]
|
|
.RE
|
|
.RE
|
|
.SS Ubuntu daily\-live images
|
|
\f[CR]quickget\f[R] can also download/refresh daily\-live images via
|
|
\f[CR]zsync\f[R] for Ubuntu developers and testers.
|
|
.IP
|
|
.EX
|
|
quickget ubuntu daily\-live
|
|
quickemu \-\-vm ubuntu\-daily\-live.conf
|
|
.EE
|
|
.PP
|
|
You can run \f[CR]quickget ubuntu daily\-live\f[R] to refresh your daily
|
|
development image as often as you like, it will even automatically
|
|
switch to a new series.
|
|
.SS Ubuntu Flavours
|
|
All the official Ubuntu flavours are supported, just replace
|
|
\f[CR]ubuntu\f[R] with your preferred flavour.
|
|
.PP
|
|
The project \c
|
|
.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines
|
|
wiki
|
|
.UE \c
|
|
\ may have further information.
|
|
.IP \[bu] 2
|
|
\f[CR]edubuntu\f[R] (Edubuntu)
|
|
.IP \[bu] 2
|
|
\f[CR]kubuntu\f[R] (Kubuntu)
|
|
.IP \[bu] 2
|
|
\f[CR]lubuntu\f[R] (Lubuntu)
|
|
.IP \[bu] 2
|
|
\f[CR]ubuntu\-budgie\f[R] (Ubuntu Budgie)
|
|
.IP \[bu] 2
|
|
\f[CR]ubuntucinnamon\f[R] (Ubuntu Cinnamon)
|
|
.IP \[bu] 2
|
|
\f[CR]ubuntukylin\f[R] (Ubuntu Kylin)
|
|
.IP \[bu] 2
|
|
\f[CR]ubuntu\-mate\f[R] (Ubuntu MATE)
|
|
.IP \[bu] 2
|
|
\f[CR]ubuntu\-server\f[R] (Ubuntu Server)
|
|
.IP \[bu] 2
|
|
\f[CR]ubuntustudio\f[R] (Ubuntu Studio)
|
|
.IP \[bu] 2
|
|
\f[CR]ubuntu\f[R] (Ubuntu)
|
|
.IP \[bu] 2
|
|
\f[CR]ubuntu\-unity\f[R] (Ubuntu Unity)
|
|
.IP \[bu] 2
|
|
\f[CR]xubuntu\f[R] (Xubuntu)
|
|
.PP
|
|
You can also use \f[CR]quickget\f[R] with advanced options :
|
|
.IP
|
|
.EX
|
|
\-\-download <os> <release> [edition] : Download image; no VM configuration
|
|
\-\-create\-config <os> [path/url] : Create VM config for a OS image
|
|
\-\-open\-homepage <os> : Open homepage for the OS
|
|
\-\-show [os] : Show OS information
|
|
\-\-version : Show version
|
|
\-\-help : Show this help message
|
|
\-\-url [os] [release] [edition] : Show image URL(s)
|
|
\-\-check [os] [release] [edition] : Check image URL(s)
|
|
\-\-list : List all supported systems
|
|
\-\-list\-csv : List everything in csv format
|
|
\-\-list\-json : List everything in json format
|
|
.EE
|
|
.PP
|
|
Here are some typical uses
|
|
.IP
|
|
.EX
|
|
# show an OS ISO download URL for {os} {release} [edition]
|
|
quickget \-\-url fedora 38 Silverblue
|
|
# test if an OS ISO is available for {os} {release} [edition]
|
|
quickget \-\-check nixos unstable plasma5
|
|
# open an OS distribution homepage in a browser
|
|
quickget \-\-open\-homepage ubuntu\-mate
|
|
# Only download image file into current directory, without creating VM
|
|
quickget \-\-download elementary 7.1
|
|
.EE
|
|
.PP
|
|
The \f[CR]\-\-url\f[R], \f[CR]\-\-check\f[R], and
|
|
\f[CR]\-\-download\f[R] options are fully functional for all operating
|
|
systems, including Windows and macOS.
|
|
.PP
|
|
Further information is available from the project \c
|
|
.UR https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features
|
|
wiki
|
|
.UE \c
|
|
.SS Other Operating Systems
|
|
\f[CR]quickget\f[R] also supports:
|
|
.IP \[bu] 2
|
|
\f[CR]alma\f[R] (AlmaLinux)
|
|
.IP \[bu] 2
|
|
\f[CR]alpine\f[R] (Alpine Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]android\f[R] (Android x86)
|
|
.IP \[bu] 2
|
|
\f[CR]antix\f[R] (Antix)
|
|
.IP \[bu] 2
|
|
\f[CR]archcraft\f[R] (Archcraft)
|
|
.IP \[bu] 2
|
|
\f[CR]archlinux\f[R] (Arch Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]arcolinux\f[R] (Arco Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]artixlinux\f[R] (Artix Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]athenaos\f[R] (Athena OS)
|
|
.IP \[bu] 2
|
|
\f[CR]batocera\f[R] (Batocera)
|
|
.IP \[bu] 2
|
|
\f[CR]bazzite\f[R] (Bazzite)
|
|
.IP \[bu] 2
|
|
\f[CR]biglinux\f[R] (BigLinux)
|
|
.IP \[bu] 2
|
|
\f[CR]blendos\f[R] (BlendOS)
|
|
.IP \[bu] 2
|
|
\f[CR]bodhi\f[R] (Bodhi)
|
|
.IP \[bu] 2
|
|
\f[CR]bunsenlabs\f[R] (BunsenLabs)
|
|
.IP \[bu] 2
|
|
\f[CR]cachyos\f[R] (CachyOS)
|
|
.IP \[bu] 2
|
|
\f[CR]centos\-stream\f[R] (CentOS Stream)
|
|
.IP \[bu] 2
|
|
\f[CR]chimeralinux\f[R] (Chimera Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]crunchbang++\f[R] (Crunchbangplusplus)
|
|
.IP \[bu] 2
|
|
\f[CR]debian\f[R] (Debian)
|
|
.IP \[bu] 2
|
|
\f[CR]deepin\f[R] (Deepin)
|
|
.IP \[bu] 2
|
|
\f[CR]devuan\f[R] (Devuan)
|
|
.IP \[bu] 2
|
|
\f[CR]dragonflybsd\f[R] (DragonFlyBSD)
|
|
.IP \[bu] 2
|
|
\f[CR]easyos\f[R] (EasyOS)
|
|
.IP \[bu] 2
|
|
\f[CR]elementary\f[R] (elementary OS)
|
|
.IP \[bu] 2
|
|
\f[CR]endeavouros\f[R] (EndeavourOS)
|
|
.IP \[bu] 2
|
|
\f[CR]endless\f[R] (Endless OS)
|
|
.IP \[bu] 2
|
|
\f[CR]fedora\f[R] (Fedora)
|
|
.IP \[bu] 2
|
|
\f[CR]freebsd\f[R] (FreeBSD)
|
|
.IP \[bu] 2
|
|
\f[CR]freedos\f[R] (FreeDOS)
|
|
.IP \[bu] 2
|
|
\f[CR]garuda\f[R] (Garuda Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]gentoo\f[R] (Gentoo)
|
|
.IP \[bu] 2
|
|
\f[CR]ghostbsd\f[R] (GhostBSD)
|
|
.IP \[bu] 2
|
|
\f[CR]gnomeos\f[R] (GNOME OS)
|
|
.IP \[bu] 2
|
|
\f[CR]guix\f[R] (Guix)
|
|
.IP \[bu] 2
|
|
\f[CR]haiku\f[R] (Haiku)
|
|
.IP \[bu] 2
|
|
\f[CR]holoiso\f[R] (HoloISO)
|
|
.IP \[bu] 2
|
|
\f[CR]kali\f[R] (Kali)
|
|
.IP \[bu] 2
|
|
\f[CR]kdeneon\f[R] (KDE Neon)
|
|
.IP \[bu] 2
|
|
\f[CR]kolibrios\f[R] (KolibriOS)
|
|
.IP \[bu] 2
|
|
\f[CR]linuxlite\f[R] (Linux Lite)
|
|
.IP \[bu] 2
|
|
\f[CR]linuxmint\f[R] (Linux Mint)
|
|
.IP \[bu] 2
|
|
\f[CR]lmde\f[R] (Linux Mint Debian Edition)
|
|
.IP \[bu] 2
|
|
\f[CR]mageia\f[R] (Mageia)
|
|
.IP \[bu] 2
|
|
\f[CR]manjaro\f[R] (Manjaro)
|
|
.IP \[bu] 2
|
|
\f[CR]mxlinux\f[R] (MX Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]netboot\f[R] (netboot.xyz)
|
|
.IP \[bu] 2
|
|
\f[CR]netbsd\f[R] (NetBSD)
|
|
.IP \[bu] 2
|
|
\f[CR]nitrux\f[R] (Nitrux)
|
|
.IP \[bu] 2
|
|
\f[CR]nixos\f[R] (NixOS)
|
|
.IP \[bu] 2
|
|
\f[CR]nwg\-shell\f[R] (nwg\-shell)
|
|
.IP \[bu] 2
|
|
\f[CR]openbsd\f[R] (OpenBSD)
|
|
.IP \[bu] 2
|
|
\f[CR]openindiana\f[R] (OpenIndiana)
|
|
.IP \[bu] 2
|
|
\f[CR]opensuse\f[R] (openSUSE)
|
|
.IP \[bu] 2
|
|
\f[CR]oraclelinux\f[R] (Oracle Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]parrotsec\f[R] (Parrot Security)
|
|
.IP \[bu] 2
|
|
\f[CR]peppermint\f[R] (PeppermintOS)
|
|
.IP \[bu] 2
|
|
\f[CR]popos\f[R] (Pop!_OS)
|
|
.IP \[bu] 2
|
|
\f[CR]porteus\f[R] (Porteus)
|
|
.IP \[bu] 2
|
|
\f[CR]primtux\f[R] (PrimTux)
|
|
.IP \[bu] 2
|
|
\f[CR]pureos\f[R] (PureOS)
|
|
.IP \[bu] 2
|
|
\f[CR]reactos\f[R] (ReactOS)
|
|
.IP \[bu] 2
|
|
\f[CR]rebornos\f[R] (RebornOS)
|
|
.IP \[bu] 2
|
|
\f[CR]rockylinux\f[R] (Rocky Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]siduction\f[R] (Siduction)
|
|
.IP \[bu] 2
|
|
\f[CR]slackware\f[R] (Slackware)
|
|
.IP \[bu] 2
|
|
\f[CR]slax\f[R] (Slax)
|
|
.IP \[bu] 2
|
|
\f[CR]slint\f[R] (Slint)
|
|
.IP \[bu] 2
|
|
\f[CR]slitaz\f[R] (SliTaz)
|
|
.IP \[bu] 2
|
|
\f[CR]solus\f[R] (Solus)
|
|
.IP \[bu] 2
|
|
\f[CR]sparkylinux\f[R] (SparkyLinux)
|
|
.IP \[bu] 2
|
|
\f[CR]spirallinux\f[R] (SpiralLinux)
|
|
.IP \[bu] 2
|
|
\f[CR]tails\f[R] (Tails)
|
|
.IP \[bu] 2
|
|
\f[CR]tinycore\f[R] (Tiny Core Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]trisquel\f[R] (Trisquel\-)
|
|
.IP \[bu] 2
|
|
\f[CR]truenas\-core\f[R] (TrueNAS Core)
|
|
.IP \[bu] 2
|
|
\f[CR]truenas\-scale\f[R] (TrueNAS Scale)
|
|
.IP \[bu] 2
|
|
\f[CR]tuxedo\-os\f[R] (Tuxedo OS)
|
|
.IP \[bu] 2
|
|
\f[CR]vanillaos\f[R] (Vanilla OS)
|
|
.IP \[bu] 2
|
|
\f[CR]void\f[R] (Void Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]vxlinux\f[R] (VX Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]zorin\f[R] (Zorin OS)
|
|
.SS \c
|
|
.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests
|
|
Custom Linux guests
|
|
.UE \c
|
|
Or you can download a Linux image and manually create a VM
|
|
configuration.
|
|
.IP \[bu] 2
|
|
Download a .iso image of a Linux distribution
|
|
.IP \[bu] 2
|
|
Create a VM configuration file; for example
|
|
\f[CR]debian\-bullseye.conf\f[R]
|
|
.IP
|
|
.EX
|
|
guest_os=\[dq]linux\[dq]
|
|
disk_img=\[dq]debian\-bullseye/disk.qcow2\[dq]
|
|
iso=\[dq]debian\-bullseye/firmware\-11.0.0\-amd64\-DVD\-1.iso\[dq]
|
|
.EE
|
|
.IP \[bu] 2
|
|
Use \f[CR]quickemu\f[R] to start the virtual machine:
|
|
.IP
|
|
.EX
|
|
quickemu \-\-vm debian\-bullseye.conf
|
|
.EE
|
|
.IP \[bu] 2
|
|
Complete the installation as normal.
|
|
.IP \[bu] 2
|
|
Post\-install:
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
Install the SPICE agent (\f[CR]spice\-vdagent\f[R]) in the guest to
|
|
enable copy/paste and USB redirection.
|
|
.IP \[bu] 2
|
|
Install the SPICE WebDAV agent (\f[CR]spice\-webdavd\f[R]) in the guest
|
|
to enable file sharing.
|
|
.RE
|
|
.SS Supporting old Linux distros
|
|
If you want to run an old Linux , from 2016 or earlier, change the
|
|
\f[CR]guest_os\f[R] to \f[CR]linux_old\f[R].
|
|
This will enable the \f[CR]vmware\-svga\f[R] graphics driver which is
|
|
better supported on older distros.
|
|
.SS \c
|
|
.UR https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests
|
|
Creating macOS Guests
|
|
.UE \c
|
|
\ 🍏
|
|
\f[B]Installing macOS in a VM can be a bit finicky, if you encounter
|
|
problems, \c
|
|
.UR https://github.com/quickemu-project/quickemu/discussions
|
|
check the Discussions
|
|
.UE \c
|
|
\ for solutions or ask for help there\f[R] 🛟
|
|
.PP
|
|
\f[CR]quickget\f[R] automatically downloads a macOS recovery image and
|
|
creates a virtual machine configuration.
|
|
.IP
|
|
.EX
|
|
quickget macos catalina
|
|
quickemu \-\-vm macos\-catalina.conf
|
|
.EE
|
|
.PP
|
|
macOS \f[CR]mojave\f[R], \f[CR]catalina\f[R], \f[CR]big\-sur\f[R],
|
|
\f[CR]monterey\f[R], \f[CR]ventura\f[R] and \f[CR]sonoma\f[R] are
|
|
supported.
|
|
.IP \[bu] 2
|
|
Use cursor keys and enter key to select the \f[B]macOS Base System\f[R]
|
|
.IP \[bu] 2
|
|
From \f[B]macOS Utilities\f[R]
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R]
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
Select \f[CR]QEMU HARDDISK Media\f[R] (\[ti]103.08GB) from the list (on
|
|
Big Sur and above use \f[CR]Apple Inc. VirtIO Block Device\f[R]) and
|
|
click \f[B]Erase\f[R].
|
|
.IP \[bu] 2
|
|
Enter a \f[CR]Name:\f[R] for the disk
|
|
.IP \[bu] 2
|
|
If you are installing macOS Mojave or later (Catalina, Big Sur,
|
|
Monterey, Ventura and Sonoma), choose any of the APFS options as the
|
|
filesystem.
|
|
MacOS Extended may not work.
|
|
.RE
|
|
.IP \[bu] 2
|
|
Click \f[B]Erase\f[R].
|
|
.IP \[bu] 2
|
|
Click \f[B]Done\f[R].
|
|
.IP \[bu] 2
|
|
Close Disk Utility
|
|
.RE
|
|
.IP \[bu] 2
|
|
From \f[B]macOS Utilities\f[R]
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
Click \f[B]Reinstall macOS\f[R] and \f[B]Continue\f[R]
|
|
.RE
|
|
.IP \[bu] 2
|
|
Complete the installation as you normally would.
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
On the first reboot use cursor keys and enter key to select \f[B]macOS
|
|
Installer\f[R]
|
|
.IP \[bu] 2
|
|
On the subsequent reboots use cursor keys and enter key to select the
|
|
disk you named
|
|
.RE
|
|
.IP \[bu] 2
|
|
Once you have finished installing macOS you will be presented with an
|
|
the out\-of\-the\-box first\-start wizard to configure various options
|
|
and set up your username and password
|
|
.IP \[bu] 2
|
|
OPTIONAL: After you have concluded the out\-of\-the\-box wizard, you may
|
|
want to enable the TRIM feature that the computer industry created for
|
|
SSD disks.
|
|
This feature in our macOS installation will allow QuickEmu to compact
|
|
(shrink) your macOS disk image whenever you delete files inside the
|
|
Virtual Machine.
|
|
Without this step your macOS disk image will only ever get larger and
|
|
will not shrink even when you delete lots of data inside macOS.
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
To enable TRIM, open the Terminal application and type the following
|
|
command followed by pressing enter to tell macos to use the TRIM command
|
|
on the hard disk when files are deleted:
|
|
.RE
|
|
.IP
|
|
.EX
|
|
sudo trimforce enable
|
|
.EE
|
|
.PP
|
|
You will be prompted to enter your account\[cq]s password to gain the
|
|
privilege needed.
|
|
Once you\[cq]ve entered your password and pressed enter the command will
|
|
request confirmation in the form of two questions that require you to
|
|
type y (for a \[lq]yes\[rq] response) followed by enter to confirm.
|
|
.PP
|
|
If you press enter without first typing y the system will consider that
|
|
a negative response as though you said \[lq]no\[rq]:
|
|
.IP
|
|
.EX
|
|
IMPORTANT NOTICE: This tool force\-enables TRIM for all relevant attached devices, even though such devices may not have been validated for data integrity while using TRIM. Use of this tool to enable TRIM may result in unintended data loss or data corruption. It should not be used in a commercial operating environment or with important data. Before using this tool, you should back up all of your data and regularly back up data while TRIM is enabled. This tool is provided on an \[dq]as is\[dq] basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON\-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS TOOL OR ITS USE ALONE OR IN COMBINATION WITH YOUR DEVICES, SYSTEMS, OR SERVICES. BY USING THIS TOOL TO ENABLE TRIM, YOU AGREE THAT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, USE OF THE TOOL IS AT YOUR SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH YOU.
|
|
Are you sure you with to proceed (y/N)?
|
|
.EE
|
|
.PP
|
|
And a second confirmation once you\[cq]ve confirmed the previous one:
|
|
.IP
|
|
.EX
|
|
Your system will immediately reboot when this is complete.
|
|
Is this OK (y/N)?
|
|
.EE
|
|
.PP
|
|
As the last message states, your system will automatically reboot as
|
|
soon as the command completes.
|
|
.PP
|
|
The default macOS configuration looks like this:
|
|
.IP
|
|
.EX
|
|
guest_os=\[dq]macos\[dq]
|
|
img=\[dq]macos\-catalina/RecoveryImage.img\[dq]
|
|
disk_img=\[dq]macos\-catalina/disk.qcow2\[dq]
|
|
macos_release=\[dq]catalina\[dq]
|
|
.EE
|
|
.IP \[bu] 2
|
|
\f[CR]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
|
|
macOS.
|
|
.IP \[bu] 2
|
|
\f[CR]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to
|
|
optimise for a particular macOS release.
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
For example VirtIO Network and Memory Ballooning are available in Big
|
|
Sur and newer, but not previous releases.
|
|
.IP \[bu] 2
|
|
And VirtIO Block Media (disks) are supported/stable in Catalina and
|
|
newer.
|
|
.RE
|
|
.SH macOS compatibility
|
|
There are some considerations when running macOS via Quickemu.
|
|
.IP \[bu] 2
|
|
Supported macOS releases:
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
High Sierra
|
|
.IP \[bu] 2
|
|
Mojave
|
|
.IP \[bu] 2
|
|
Catalina \f[B](Recommended)\f[R]
|
|
.IP \[bu] 2
|
|
Big Sur
|
|
.IP \[bu] 2
|
|
Monterey
|
|
.IP \[bu] 2
|
|
Ventura
|
|
.IP \[bu] 2
|
|
Sonoma
|
|
.RE
|
|
.IP \[bu] 2
|
|
\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
|
|
\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
|
|
\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 earlier releases use \f[CR]vmxnet3\f[R].
|
|
.IP \[bu] 2
|
|
VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and
|
|
newer but disabled for other support macOS releases.
|
|
.RE
|
|
.IP \[bu] 2
|
|
USB host and SPICE pass\-through is:
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
UHCI (USB 2.0) on macOS Catalina and earlier.
|
|
.IP \[bu] 2
|
|
XHCI (USB 3.0) on macOS Big Sur and newer.
|
|
.RE
|
|
.IP \[bu] 2
|
|
Display resolution can only be changed via macOS System Preferences.
|
|
.IP \[bu] 2
|
|
\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].
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
NOTE!
|
|
\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
|
|
.RE
|
|
.IP \[bu] 2
|
|
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].
|
|
.SH macOS App Store
|
|
If you see \f[I]\[lq]Your device or computer could not be
|
|
verified\[rq]\f[R] when you try to login to the App Store, make sure
|
|
that your wired ethernet device is \f[CR]en0\f[R].
|
|
Use \f[CR]ifconfig\f[R] in a terminal to verify this.
|
|
.PP
|
|
If the wired ethernet device is not \f[CR]en0\f[R], then then go to
|
|
\f[I]System Preferences\f[R] \-> \f[I]Network\f[R], delete all the
|
|
network devices and apply the changes.
|
|
Next, open a terminal and run the following:
|
|
.IP
|
|
.EX
|
|
sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
|
|
.EE
|
|
.PP
|
|
Now reboot, and the App Store should work.
|
|
.PP
|
|
There may be further advice and information about macOS guests in the
|
|
project \c
|
|
.UR https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests
|
|
wiki
|
|
.UE \c
|
|
\&.
|
|
.SS \c
|
|
.UR https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines
|
|
Creating Windows guests
|
|
.UE \c
|
|
\ 🪟
|
|
\f[CR]quickget\f[R] can download \c
|
|
.UR https://www.microsoft.com/software-download/windows10
|
|
\f[B]Windows 10\f[R]
|
|
.UE \c
|
|
\ and \c
|
|
.UR https://www.microsoft.com/software-download/windows11
|
|
\f[B]Windows 11\f[R]
|
|
.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
|
|
\f[B]Windows 8.1\f[R] is also supported but doesn\[cq]t feature any
|
|
automated installation or driver optimisation.
|
|
.PP
|
|
\f[CR]quickget\f[R] can also download \c
|
|
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-10-enterprise
|
|
Windows 10 LTSC
|
|
.UE \c
|
|
\ and Windows Server \c
|
|
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-server-2012-r2
|
|
2012\-r2
|
|
.UE \c
|
|
, \c
|
|
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-server-2016
|
|
2016
|
|
.UE \c
|
|
, \c
|
|
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-server-2019
|
|
2019
|
|
.UE \c
|
|
, and \c
|
|
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-server-2022
|
|
2022
|
|
.UE \c
|
|
\&.
|
|
No automated installation is supported for these releases.
|
|
.IP
|
|
.EX
|
|
quickget windows 11
|
|
quickemu \-\-vm windows\-11.conf
|
|
.EE
|
|
.IP \[bu] 2
|
|
Complete the installation as you normally would.
|
|
.IP \[bu] 2
|
|
All relevant drivers and services should be installed automatically.
|
|
.IP \[bu] 2
|
|
A local administrator user account is automatically created, with these
|
|
credentials:
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
Username: \f[CR]Quickemu\f[R]
|
|
.IP \[bu] 2
|
|
Password: \f[CR]quickemu\f[R]
|
|
.RE
|
|
.PP
|
|
Further information is available from the project \c
|
|
.UR https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines
|
|
wiki
|
|
.UE \c
|
|
.SS Configuration
|
|
Here are the usage instructions:
|
|
.IP
|
|
.EX
|
|
Usage
|
|
quickemu \-\-vm ubuntu.conf <arguments>
|
|
|
|
Arguments
|
|
\-\-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 its configuration
|
|
\-\-display : Select display backend. \[aq]sdl\[aq] (default), \[aq]gtk\[aq], \[aq]none\[aq], \[aq]spice\[aq] or \[aq]spice\-app\[aq]
|
|
\-\-fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)
|
|
\-\-ignore\-msrs\-always : Configure KVM to always ignore unhandled machine\-specific registers
|
|
\-\-kill : Kill the VM process if it is running
|
|
\-\-offline : Override all network settings and start the VM offline
|
|
\-\-shortcut : Create a desktop shortcut
|
|
\-\-snapshot apply <tag> : Apply/restore a snapshot.
|
|
\-\-snapshot create <tag> : Create a snapshot.
|
|
\-\-snapshot delete <tag> : Delete a snapshot.
|
|
\-\-snapshot info : Show disk/snapshot info.
|
|
\-\-status\-quo : Do not commit any changes to disk/snapshot.
|
|
\-\-viewer <viewer> : Choose an alternative viewer. \[at]Options: \[aq]spicy\[aq] (default), \[aq]remote\-viewer\[aq], \[aq]none\[aq]
|
|
\-\-width <width> : Set VM screen width; requires \[aq]\-\-height\[aq]
|
|
\-\-height <height> : Set VM screen height; requires \[aq]\-\-width\[aq]
|
|
\-\-ssh\-port <port> : Set ssh\-port manually
|
|
\-\-spice\-port <port> : Set spice\-port manually
|
|
\-\-public\-dir <path> : Expose share directory. \[at]Options: \[aq]\[aq] (default: xdg\-user\-dir PUBLICSHARE), \[aq]<directory>\[aq], \[aq]none\[aq]
|
|
\-\-monitor <type> : Set monitor connection type. \[at]Options: \[aq]socket\[aq] (default), \[aq]telnet\[aq], \[aq]none\[aq]
|
|
\-\-monitor\-telnet\-host <ip/host> : Set telnet host for monitor. (default: \[aq]localhost\[aq])
|
|
\-\-monitor\-telnet\-port <port> : Set telnet port for monitor. (default: \[aq]4440\[aq])
|
|
\-\-monitor\-cmd <cmd> : Send command to monitor if available. (Example: system_powerdown)
|
|
\-\-serial <type> : Set serial connection type. \[at]Options: \[aq]socket\[aq] (default), \[aq]telnet\[aq], \[aq]none\[aq]
|
|
\-\-serial\-telnet\-host <ip/host> : Set telnet host for serial. (default: \[aq]localhost\[aq])
|
|
\-\-serial\-telnet\-port <port> : Set telnet port for serial. (default: \[aq]6660\[aq])
|
|
\-\-keyboard <type> : Set keyboard. \[at]Options: \[aq]usb\[aq] (default), \[aq]ps2\[aq], \[aq]virtio\[aq]
|
|
\-\-keyboard_layout <layout> : Set keyboard layout.
|
|
\-\-mouse <type> : Set mouse. \[at]Options: \[aq]tablet\[aq] (default), \[aq]ps2\[aq], \[aq]usb\[aq], \[aq]virtio\[aq]
|
|
\-\-usb\-controller <type> : Set usb\-controller. \[at]Options: \[aq]ehci\[aq] (default), \[aq]xhci\[aq], \[aq]none\[aq]
|
|
\-\-sound\-card <type> : Set sound card. \[at]Options: \[aq]intel\-hda\[aq] (default), \[aq]ac97\[aq], \[aq]es1370\[aq], \[aq]sb16\[aq], \[aq]none\[aq]
|
|
\-\-extra_args <arguments> : Pass additional arguments to qemu
|
|
\-\-version : Print version
|
|
.EE
|
|
.SS Desktop shortcuts
|
|
Desktop shortcuts can be created for a VM, the shortcuts are saved in
|
|
\f[CR]\[ti]/.local/share/applications\f[R].
|
|
Here is an example of how to create a shortcut.
|
|
.IP
|
|
.EX
|
|
quickemu \-\-vm ubuntu\-22.04\-desktop.conf \-\-shortcut
|
|
.EE
|
|
.SS References
|
|
Useful reference that assisted the development of Quickemu.
|
|
.IP \[bu] 2
|
|
General
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://qemu.readthedocs.io/en/latest/
|
|
QEMU\[cq]s documentation!
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://www.kraxel.org/blog/2020/01/qemu-sound-audiodev/
|
|
.UE \c
|
|
.RE
|
|
.IP \[bu] 2
|
|
macOS
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://www.nicksherlock.com/2020/06/installing-macos-big-sur-on-proxmox/
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://passthroughpo.st/mac-os-adds-early-support-for-virtio-qemu/
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://github.com/kholia/OSX-KVM
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://github.com/thenickdude/KVM-Opencore
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://gist.github.com/MCJack123/943eaca762730ca4b7ae460b731b68e7
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macrecovery
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://www.kraxel.org/blog/2017/09/running-macos-as-guest-in-kvm/
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://www.nicksherlock.com/2017/10/passthrough-of-advanced-cpu-features-for-macos-high-sierra-guests/
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR http://philjordan.eu/osx-virt/
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://github.com/Dids/clover-builder
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://mackie100projects.altervista.org
|
|
OpenCore Configurator
|
|
.UE \c
|
|
.RE
|
|
.IP \[bu] 2
|
|
Windows
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://www.heiko-sieger.info/running-windows-10-on-linux-using-kvm-with-vga-passthrough/
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://leduccc.medium.com/improving-the-performance-of-a-windows-10-guest-on-qemu-a5b3f54d9cf5
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://frontpagelinux.com/tutorials/how-to-use-linux-kvm-to-optimize-your-windows-10-virtual-machine/
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://turlucode.com/qemu-command-line-args/
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://github.com/pbatard/Fido
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\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
|
|
\c
|
|
.UR https://qemu-project.gitlab.io/qemu/specs/tpm.html
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\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
|
|
\c
|
|
.UR https://wiki.qemu.org/Documentation/9p
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://wiki.qemu.org/Documentation/9psetup
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://www.kraxel.org/blog/2019/06/macos-qemu-guest/
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://superuser.com/questions/628169/how-to-share-a-directory-with-the-host-without-networking-in-qemu
|
|
.UE \c
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://virtio-fs.gitlab.io/
|
|
.UE \c
|
|
.RE
|
|
.SH AUTHORS
|
|
Written by Martin Wimpress.
|
|
.SH BUGS
|
|
Submit bug reports online at: \c
|
|
.UR https://github.com/quickemu-project/quickemu/issues
|
|
.UE \c
|
|
.SH SEE ALSO
|
|
Full sources at: \c
|
|
.UR https://github.com/quickemu-project/quickemu
|
|
.UE \c
|
|
.PP
|
|
quickemu_conf(1), quickget(1), quickgui(1)
|
|
.SH AUTHORS
|
|
Martin Wimpress.
|