AIR/quickemu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

regenerated with pandoc 2.9.2.1

Browse Source 
flipping pip virtual environments and apt repo sources
This commit is contained in:
Phil 2022-02-26 04:10:28 +00:00
parent b8bf37682e
commit 4991a48f0b
6 changed files with 449 additions and 483 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -623,7 +623,6 @@ Here are the usage instructions:
``` {.bash} ``` {.bash}
Usage Usage
quickemu --vm ubuntu.conf quickemu --vm ubuntu.conf

471
docs/quickemu.1
View File

@ -1,99 +1,68 @@
.\" Automatically generated by Pandoc 2.2.3.2 .\" Automatically generated by Pandoc 2.9.2.1
.\" .\"
.TH "QUICKEMU" "1" "February 20, 2022" "quickemu" "Quickemu User Manual" .TH "QUICKEMU" "1" "February 20, 2022" "quickemu" "Quickemu User Manual"
.hy .hy
.SH NAME .SH NAME
.PP .PP
quickemu \- A quick VM builder and manager quickemu - A quick VM builder and manager
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\f[B]quickemu\f[] [\f[I]OPTION\f[]]\&... \f[B]quickemu\f[R] [\f[I]OPTION\f[R]]\&...
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
\f[B]quickemu\f[] will create and run highly optimised desktop virtual \f[B]quickemu\f[R] will create and run highly optimised desktop virtual
machines for Linux, macOS and Windows machines for Linux, macOS and Windows
.SH OPTIONS .SH OPTIONS
.TP .TP
.B \f[B]\[en]vm\f[] \f[B]\[en]vm\f[R]
vm configuration file vm configuration file
.RS
.RE
.PP .PP
You can also pass optional parameters You can also pass optional parameters
.TP .TP
.B \f[B]\[en]braille\f[] \f[B]\[en]braille\f[R]
Enable braille support. Enable braille support.
Requires SDL. Requires SDL.
.RS
.RE
.TP .TP
.B \f[B]\[en]delete\f[] \f[B]\[en]delete\f[R]
Delete the disk image. Delete the disk image.
.RS
.RE
.TP .TP
.B \f[B]\[en]display\f[] \f[B]\[en]display\f[R]
Select display backend. Select display backend.
`sdl' (default), `gtk', `none' or `spice' `sdl' (default), `gtk', `none' or `spice'
.RS
.RE
.TP .TP
.B \f[B]\[en]fullscreen\f[] \f[B]\[en]fullscreen\f[R]
Starts VM in full screen mode (Ctl+Alt+f to exit) Starts VM in full screen mode (Ctl+Alt+f to exit)
.RS
.RE
.TP .TP
.B \f[B]\[en]ignore\-msrs\-always\f[] \f[B]\[en]ignore-msrs-always\f[R]
Configure KVM to always ignore unhandled machine\-specific registers Configure KVM to always ignore unhandled machine-specific registers
.RS
.RE
.TP .TP
.B \f[B]\[en]screen <screen>\f[] \f[B]\[en]screen <screen>\f[R]
Use specified screen to determine the window size. Use specified screen to determine the window size.
.RS
.RE
.TP .TP
.B \f[B]\[en]shortcut\f[] \f[B]\[en]shortcut\f[R]
Create a desktop shortcut Create a desktop shortcut
.RS
.RE
.TP .TP
.B \f[B]\[en]snapshot apply <tag>\f[] \f[B]\[en]snapshot apply <tag>\f[R]
Apply/restore a snapshot. Apply/restore a snapshot.
.RS
.RE
.TP .TP
.B \f[B]\[en]snapshot create <tag>\f[] \f[B]\[en]snapshot create <tag>\f[R]
Create a snapshot. Create a snapshot.
.RS
.RE
.TP .TP
.B \f[B]\[en]snapshot delete <tag>\f[] \f[B]\[en]snapshot delete <tag>\f[R]
Delete a snapshot. Delete a snapshot.
.RS
.RE
.TP .TP
.B \f[B]\[en]snapshot info\f[] \f[B]\[en]snapshot info\f[R]
Show disk/snapshot info. Show disk/snapshot info.
.RS
.RE
.TP .TP
.B \f[B]\[en]status\-quo\f[] \f[B]\[en]status-quo\f[R]
Do not commit any changes to disk/snapshot. Do not commit any changes to disk/snapshot.
.RS
.RE
.TP .TP
.B \f[B]\[en]version\f[] \f[B]\[en]version\f[R]
Print version Print version
.RS
.RE
.SH EXAMPLES .SH EXAMPLES
.TP .TP
.B \f[B]quickemu \[en]vm ubuntu\-mate\-21.10\-.conf\f[] \f[B]quickemu \[en]vm ubuntu-mate-21.10-.conf\f[R]
Launches the VM specified in the file Launches the VM specified in the file \f[I]ubuntu-mate-21.10-.conf\f[R]
\f[I]ubuntu\-mate\-21.10\-.conf\f[]
.RS
.RE
.SS Introduction .SS Introduction
.PP .PP
Quickly create and run highly optimised desktop virtual machines for Quickly create and run highly optimised desktop virtual machines for
@ -104,9 +73,9 @@ For example:
.IP .IP
.nf .nf
\f[C] \f[C]
quickget\ ubuntu\-mate\ 21.10 quickget ubuntu-mate 21.10
quickemu\ \-\-vm\ ubuntu\-mate\-21.10\-.conf quickemu --vm ubuntu-mate-21.10-.conf
\f[] \f[R]
.fi .fi
.PP .PP
The original objective of the project was to enable quick testing of The original objective of the project was to enable quick testing of
@ -114,35 +83,35 @@ Linux distributions where the virtual machine configurations can be
stored anywhere, such as external USB storage or your home directory, stored anywhere, such as external USB storage or your home directory,
and no elevated permissions are required to run the virtual machines. and no elevated permissions are required to run the virtual machines.
\f[B]Quickemu now also includes comprehensive support for macOS and \f[B]Quickemu now also includes comprehensive support for macOS and
Windows\f[]. Windows\f[R].
.SS Features .SS Features
.IP \[bu] 2 .IP \[bu] 2
\f[B]macOS\f[] Monterey, Big Sur, Catalina, Mojave & High Sierra \f[B]macOS\f[R] Monterey, Big Sur, Catalina, Mojave & High Sierra
.IP \[bu] 2 .IP \[bu] 2
\f[B]Windows\f[] 8.1, 10 and 11 including TPM 2.0 \f[B]Windows\f[R] 8.1, 10 and 11 including TPM 2.0
.IP \[bu] 2 .IP \[bu] 2
Ubuntu (https://ubuntu.com/desktop) and all the \f[B]official Ubuntu Ubuntu (https://ubuntu.com/desktop) and all the \f[B]official Ubuntu
flavours (https://ubuntu.com/download/flavours)\f[] flavours (https://ubuntu.com/download/flavours)\f[R]
.IP \[bu] 2 .IP \[bu] 2
\f[B]Over 360 operating system editions are supported!\f[] \f[B]Over 360 operating system editions are supported!\f[R]
.IP \[bu] 2 .IP \[bu] 2
Full SPICE support including host/guest clipboard sharing Full SPICE support including host/guest clipboard sharing
.IP \[bu] 2 .IP \[bu] 2
VirtIO\-webdavd file sharing for Linux and Windows guests VirtIO-webdavd file sharing for Linux and Windows guests
.IP \[bu] 2 .IP \[bu] 2
VirtIO\-9p file sharing for Linux and macOS guests VirtIO-9p file sharing for Linux and macOS guests
.IP \[bu] 2 .IP \[bu] 2
QEMU Guest Agent support (https://wiki.qemu.org/Features/GuestAgent); QEMU Guest Agent support (https://wiki.qemu.org/Features/GuestAgent);
provides access to a system\-level agent via standard QMP commands provides access to a system-level agent via standard QMP commands
.IP \[bu] 2 .IP \[bu] 2
Samba file sharing for Linux, macOS and Windows guests (\f[I]if Samba file sharing for Linux, macOS and Windows guests (\f[I]if
\f[CI]smbd\f[I] is installed on the host\f[]) \f[CI]smbd\f[I] is installed on the host\f[R])
.IP \[bu] 2 .IP \[bu] 2
VirGL acceleration VirGL acceleration
.IP \[bu] 2 .IP \[bu] 2
USB device pass\-through USB device pass-through
.IP \[bu] 2 .IP \[bu] 2
Smartcard pass\-through Smartcard pass-through
.IP \[bu] 2 .IP \[bu] 2
Automatic SSH port forwarding to guests Automatic SSH port forwarding to guests
.IP \[bu] 2 .IP \[bu] 2
@ -157,7 +126,7 @@ EFI (with or without SecureBoot) and Legacy BIOS boot
Graphical user interfaces available Graphical user interfaces available
.PP .PP
Quickemu is a wrapper for the excellent QEMU (https://www.qemu.org/) 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[], that attempts to automatically \f[I]\[lq]do the right thing\[rq]\f[R],
rather than expose exhaustive configuration options. rather than expose exhaustive configuration options.
.PP .PP
We have a Discord for this project: We have a Discord for this project:
@ -170,10 +139,10 @@ Quickemu.
QEMU (https://img.youtube.com/vi/AOTYWEgw0hI/0.jpg)] (https://www.youtube.com/watch?v=AOTYWEgw0hI) QEMU (https://img.youtube.com/vi/AOTYWEgw0hI/0.jpg)] (https://www.youtube.com/watch?v=AOTYWEgw0hI)
.SS Requirements .SS Requirements
.IP \[bu] 2 .IP \[bu] 2
QEMU (https://www.qemu.org/) (\f[I]6.0.0 or newer\f[]) \f[B]with GTK, QEMU (https://www.qemu.org/) (\f[I]6.0.0 or newer\f[R]) \f[B]with GTK,
SDL, SPICE & VirtFS support\f[] SDL, SPICE & VirtFS support\f[R]
.IP \[bu] 2 .IP \[bu] 2
bash (https://www.gnu.org/software/bash/) (\f[I]4.0 or newer\f[]) bash (https://www.gnu.org/software/bash/) (\f[I]4.0 or newer\f[R])
.IP \[bu] 2 .IP \[bu] 2
Coreutils (https://www.gnu.org/software/coreutils/) Coreutils (https://www.gnu.org/software/coreutils/)
.IP \[bu] 2 .IP \[bu] 2
@ -195,7 +164,7 @@ mkisofs (http://cdrtools.sourceforge.net/private/cdrecord.html)
.IP \[bu] 2 .IP \[bu] 2
usbutils (https://github.com/gregkh/usbutils) usbutils (https://github.com/gregkh/usbutils)
.IP \[bu] 2 .IP \[bu] 2
util\-linux (https://github.com/karelzak/util-linux) util-linux (https://github.com/karelzak/util-linux)
.IP \[bu] 2 .IP \[bu] 2
sed (https://www.gnu.org/software/sed/) sed (https://www.gnu.org/software/sed/)
.IP \[bu] 2 .IP \[bu] 2
@ -205,7 +174,7 @@ swtpm (https://github.com/stefanberger/swtpm)
.IP \[bu] 2 .IP \[bu] 2
Wget (https://www.gnu.org/software/wget/) Wget (https://www.gnu.org/software/wget/)
.IP \[bu] 2 .IP \[bu] 2
xdg\-user\-dirs (https://www.freedesktop.org/wiki/Software/xdg-user-dirs/) xdg-user-dirs (https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)
.IP \[bu] 2 .IP \[bu] 2
xrandr (https://gitlab.freedesktop.org/xorg/app/xrandr) xrandr (https://gitlab.freedesktop.org/xorg/app/xrandr)
.IP \[bu] 2 .IP \[bu] 2
@ -215,168 +184,169 @@ unzip (http://www.info-zip.org/UnZip.html)
.SH Usage .SH Usage
.SS Graphical User Interfaces .SS Graphical User Interfaces
.PP .PP
While \f[C]quickemu\f[] and \f[C]quickget\f[] are designed for the While \f[C]quickemu\f[R] and \f[C]quickget\f[R] are designed for the
terminal, a graphical user interface is also available: terminal, a graphical user interface is also available:
.IP \[bu] 2 .IP \[bu] 2
\f[B]Quickgui (https://github.com/quickgui/quickgui)\f[] by Mark \f[B]Quickgui (https://github.com/quickgui/quickgui)\f[R] by Mark
Johnson (https://github.com/marxjohnson) and Yannick Johnson (https://github.com/marxjohnson) and Yannick
Mauray (https://github.com/ymauray). Mauray (https://github.com/ymauray).
.PP .PP
Many thanks to Luke Wesley\-Holley (https://github.com/Lukewh) and Many thanks to Luke Wesley-Holley (https://github.com/Lukewh) and
Philipp Kiemle (https://github.com/daPhipz) for creating the Philipp Kiemle (https://github.com/daPhipz) for creating the
\f[B]Quickemu icons (https://github.com/Lukewh/quickemu-icons)\f[] 🎨 \f[B]Quickemu icons (https://github.com/Lukewh/quickemu-icons)\f[R]
\[u1F3A8]
.SS Quickgui for Ubuntu .SS Quickgui for Ubuntu
.IP .IP
.nf .nf
\f[C] \f[C]
sudo\ add\-apt\-repository\ ppa:yannick\-mauray/quickgui sudo add-apt-repository ppa:yannick-mauray/quickgui
sudo\ apt\ update sudo apt update
sudo\ apt\ install\ quickgui sudo apt install quickgui
\f[] \f[R]
.fi .fi
.SS Ubuntu Guest .SS Ubuntu Guest
.PP .PP
\f[C]quickget\f[] will automatically download an Ubuntu release and \f[C]quickget\f[R] will automatically download an Ubuntu release and
create the virtual machine configuration. create the virtual machine configuration.
.IP .IP
.nf .nf
\f[C] \f[C]
quickget\ ubuntu\ 20.04 quickget ubuntu 20.04
quickemu\ \-\-vm\ ubuntu\-20.04.conf quickemu --vm ubuntu-20.04.conf
\f[] \f[R]
.fi .fi
.IP \[bu] 2 .IP \[bu] 2
Complete the installation as normal. Complete the installation as normal.
.IP \[bu] 2 .IP \[bu] 2
Post\-install: Post-install:
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE agent (\f[C]spice\-vdagent\f[]) to enable copy/paste Install the SPICE agent (\f[C]spice-vdagent\f[R]) to enable copy/paste
and USB redirection and USB redirection
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
\f[C]sudo\ apt\ install\ spice\-vdagent\f[] \f[C]sudo apt install spice-vdagent\f[R]
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE WebDAV agent (\f[C]spice\-webdavd\f[]) to enable file Install the SPICE WebDAV agent (\f[C]spice-webdavd\f[R]) to enable file
sharing. sharing.
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
\f[C]sudo\ apt\ install\ spice\-webdavd\f[] \f[C]sudo apt install spice-webdavd\f[R]
.RE .RE
.RE .RE
.SS Ubuntu devel (daily\-live) images .SS Ubuntu devel (daily-live) images
.PP .PP
\f[C]quickget\f[] can also download/refresh devel images via \f[C]quickget\f[R] can also download/refresh devel images via
\f[C]zsync\f[] for Ubuntu developers and testers. \f[C]zsync\f[R] for Ubuntu developers and testers.
.IP .IP
.nf .nf
\f[C] \f[C]
quickget\ ubuntu\ devel quickget ubuntu devel
quickemu\ \-\-vm\ ubuntu\-devel.conf quickemu --vm ubuntu-devel.conf
\f[] \f[R]
.fi .fi
.PP .PP
You can run \f[C]quickget\ ubuntu\ devel\f[] to refresh your daily You can run \f[C]quickget ubuntu devel\f[R] to refresh your daily
development image as often as you like, it will even automatically development image as often as you like, it will even automatically
switch to a new series. switch to a new series.
.SS Ubuntu Flavours .SS Ubuntu Flavours
.PP .PP
All the official Ubuntu flavours are supported, just replace All the official Ubuntu flavours are supported, just replace
\f[C]ubuntu\f[] with your preferred flavour. \f[C]ubuntu\f[R] with your preferred flavour.
.IP \[bu] 2 .IP \[bu] 2
\f[C]kubuntu\f[] (Kubuntu) \f[C]kubuntu\f[R] (Kubuntu)
.IP \[bu] 2 .IP \[bu] 2
\f[C]lubuntu\f[] (Lubuntu) \f[C]lubuntu\f[R] (Lubuntu)
.IP \[bu] 2 .IP \[bu] 2
\f[C]ubuntu\-budgie\f[] (Ubuntu Budgie) \f[C]ubuntu-budgie\f[R] (Ubuntu Budgie)
.IP \[bu] 2 .IP \[bu] 2
\f[C]ubuntukylin\f[] (Ubuntu Kylin) \f[C]ubuntukylin\f[R] (Ubuntu Kylin)
.IP \[bu] 2 .IP \[bu] 2
\f[C]ubuntu\-mate\f[] (Ubuntu MATE) \f[C]ubuntu-mate\f[R] (Ubuntu MATE)
.IP \[bu] 2 .IP \[bu] 2
\f[C]ubuntustudio\f[] (Ubuntu Studio) \f[C]ubuntustudio\f[R] (Ubuntu Studio)
.IP \[bu] 2 .IP \[bu] 2
\f[C]ubuntu\f[] (Ubuntu) \f[C]ubuntu\f[R] (Ubuntu)
.IP \[bu] 2 .IP \[bu] 2
\f[C]xubuntu\f[] (Xubuntu) \f[C]xubuntu\f[R] (Xubuntu)
.SS Other Operating Systems .SS Other Operating Systems
.PP .PP
\f[C]quickget\f[] also supports: \f[C]quickget\f[R] also supports:
.IP \[bu] 2 .IP \[bu] 2
\f[C]alma\f[] (Alma Linux) \f[C]alma\f[R] (Alma Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]alpine\f[] (Alpine Linux) \f[C]alpine\f[R] (Alpine Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]android\f[] (Android x86) \f[C]android\f[R] (Android x86)
.IP \[bu] 2 .IP \[bu] 2
\f[C]archlinux\f[] (Arch Linux) \f[C]archlinux\f[R] (Arch Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]arcolinux\f[] (Arco Linux) \f[C]arcolinux\f[R] (Arco Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]cachyos\f[] (CachyOS) \f[C]cachyos\f[R] (CachyOS)
.IP \[bu] 2 .IP \[bu] 2
\f[C]debian\f[] (Debian) \f[C]debian\f[R] (Debian)
.IP \[bu] 2 .IP \[bu] 2
\f[C]devuan\f[] (Devuan) \f[C]devuan\f[R] (Devuan)
.IP \[bu] 2 .IP \[bu] 2
\f[C]dragonflybsd\f[] (DragonFlyBSD) \f[C]dragonflybsd\f[R] (DragonFlyBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[C]elementary\f[] (elementary OS) \f[C]elementary\f[R] (elementary OS)
.IP \[bu] 2 .IP \[bu] 2
\f[C]fedora\f[] (Fedora) \f[C]fedora\f[R] (Fedora)
.IP \[bu] 2 .IP \[bu] 2
\f[C]freebsd\f[] (FreeBSD) \f[C]freebsd\f[R] (FreeBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[C]freedos\f[] (FreeDOS) \f[C]freedos\f[R] (FreeDOS)
.IP \[bu] 2 .IP \[bu] 2
\f[C]garuda\f[] (Garuda Linux) \f[C]garuda\f[R] (Garuda Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]gentoo\f[] (Gentoo) \f[C]gentoo\f[R] (Gentoo)
.IP \[bu] 2 .IP \[bu] 2
\f[C]ghostbsd\f[] (GhostBSD) \f[C]ghostbsd\f[R] (GhostBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[C]haiku\f[] (Haiku) \f[C]haiku\f[R] (Haiku)
.IP \[bu] 2 .IP \[bu] 2
\f[C]kali\f[] (Kali) \f[C]kali\f[R] (Kali)
.IP \[bu] 2 .IP \[bu] 2
\f[C]kdeneon\f[] (KDE Neon) \f[C]kdeneon\f[R] (KDE Neon)
.IP \[bu] 2 .IP \[bu] 2
\f[C]kolibrios\f[] (KolibriOS) \f[C]kolibrios\f[R] (KolibriOS)
.IP \[bu] 2 .IP \[bu] 2
\f[C]linuxmint\f[] (Linux Mint) \f[C]linuxmint\f[R] (Linux Mint)
.IP \[bu] 2 .IP \[bu] 2
\f[C]manjaro\f[] (Manjaro) \f[C]manjaro\f[R] (Manjaro)
.IP \[bu] 2 .IP \[bu] 2
\f[C]mxlinux\f[] (MX Linux) \f[C]mxlinux\f[R] (MX Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]netboot\f[] (netboot.xyz) \f[C]netboot\f[R] (netboot.xyz)
.IP \[bu] 2 .IP \[bu] 2
\f[C]netbsd\f[] (NetBSD) \f[C]netbsd\f[R] (NetBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[C]nixos\f[] (NixOS) \f[C]nixos\f[R] (NixOS)
.IP \[bu] 2 .IP \[bu] 2
\f[C]openbsd\f[] (OpenBSD) \f[C]openbsd\f[R] (OpenBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[C]opensuse\f[] (openSUSE) \f[C]opensuse\f[R] (openSUSE)
.IP \[bu] 2 .IP \[bu] 2
\f[C]oraclelinux\f[] (Oracle Linux) \f[C]oraclelinux\f[R] (Oracle Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]popos\f[] (Pop!_OS) \f[C]popos\f[R] (Pop!_OS)
.IP \[bu] 2 .IP \[bu] 2
\f[C]regolith\f[] (Regolith Linux) \f[C]regolith\f[R] (Regolith Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]rockylinux\f[] (Rocky Linux) \f[C]rockylinux\f[R] (Rocky Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]slackware\f[] (Slackware) \f[C]slackware\f[R] (Slackware)
.IP \[bu] 2 .IP \[bu] 2
\f[C]solus\f[] (Solus) \f[C]solus\f[R] (Solus)
.IP \[bu] 2 .IP \[bu] 2
\f[C]tails\f[] (Tails) \f[C]tails\f[R] (Tails)
.IP \[bu] 2 .IP \[bu] 2
\f[C]void\f[] (Void Linux) \f[C]void\f[R] (Void Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]zorin\f[] (Zorin OS) \f[C]zorin\f[R] (Zorin OS)
.PP .PP
Or you can download a Linux image and manually create a VM Or you can download a Linux image and manually create a VM
configuration. configuration.
@ -384,91 +354,91 @@ configuration.
Download a .iso image of a Linux distribution Download a .iso image of a Linux distribution
.IP \[bu] 2 .IP \[bu] 2
Create a VM configuration file; for example Create a VM configuration file; for example
\f[C]debian\-bullseye.conf\f[] \f[C]debian-bullseye.conf\f[R]
.IP .IP
.nf .nf
\f[C] \f[C]
guest_os="linux" guest_os=\[dq]linux\[dq]
disk_img="debian\-bullseye/disk.qcow2" disk_img=\[dq]debian-bullseye/disk.qcow2\[dq]
iso="debian\-bullseye/firmware\-11.0.0\-amd64\-DVD\-1.iso" iso=\[dq]debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso\[dq]
\f[] \f[R]
.fi .fi
.IP \[bu] 2 .IP \[bu] 2
Use \f[C]quickemu\f[] to start the virtual machine: Use \f[C]quickemu\f[R] to start the virtual machine:
.IP .IP
.nf .nf
\f[C] \f[C]
quickemu\ \-\-vm\ debian\-bullseye.conf quickemu --vm debian-bullseye.conf
\f[] \f[R]
.fi .fi
.IP \[bu] 2 .IP \[bu] 2
Complete the installation as normal. Complete the installation as normal.
.IP \[bu] 2 .IP \[bu] 2
Post\-install: Post-install:
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE agent (\f[C]spice\-vdagent\f[]) to enable copy/paste Install the SPICE agent (\f[C]spice-vdagent\f[R]) to enable copy/paste
and USB redirection. and USB redirection.
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE WebDAV agent (\f[C]spice\-webdavd\f[]) to enable file Install the SPICE WebDAV agent (\f[C]spice-webdavd\f[R]) to enable file
sharing. sharing.
.RE .RE
.SS macOS Guest .SS macOS Guest
.PP .PP
\f[C]quickget\f[] automatically downloads a macOS recovery image and \f[C]quickget\f[R] automatically downloads a macOS recovery image and
creates a virtual machine configuration. creates a virtual machine configuration.
.IP .IP
.nf .nf
\f[C] \f[C]
quickget\ macos\ catalina quickget macos catalina
quickemu\ \-\-vm\ macos\-catalina.conf quickemu --vm macos-catalina.conf
\f[] \f[R]
.fi .fi
.PP .PP
macOS \f[C]high\-sierra\f[], \f[C]mojave\f[], \f[C]catalina\f[], macOS \f[C]high-sierra\f[R], \f[C]mojave\f[R], \f[C]catalina\f[R],
\f[C]big\-sur\f[] and \f[C]monterey\f[] are supported. \f[C]big-sur\f[R] and \f[C]monterey\f[R] are supported.
.IP \[bu] 2 .IP \[bu] 2
Use cursor keys and enter key to select the \f[B]macOS Base System\f[] Use cursor keys and enter key to select the \f[B]macOS Base System\f[R]
.IP \[bu] 2 .IP \[bu] 2
From \f[B]macOS Utilities\f[] From \f[B]macOS Utilities\f[R]
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Click \f[B]Disk Utility\f[] and \f[B]Continue\f[] Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R]
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
On macOS Catalina, Big Sur & Monterey On macOS Catalina, Big Sur & Monterey
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Select \f[C]Apple\ Inc.\ VirtIO\ Block\ Media\f[] from the list and Select \f[C]Apple Inc. VirtIO Block Media\f[R] from the list and click
click \f[B]Erase\f[]. \f[B]Erase\f[R].
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
On macOS Mojave and High Sierra On macOS Mojave and High Sierra
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Select \f[C]QEMU\ HARDDISK\ Media\f[] (~103.08GB) from the list and Select \f[C]QEMU HARDDISK Media\f[R] (\[ti]103.08GB) from the list and
click \f[B]Erase\f[]. click \f[B]Erase\f[R].
.RE .RE
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
Enter a \f[C]Name:\f[] for the disk and click \f[B]Erase\f[]. Enter a \f[C]Name:\f[R] for the disk and click \f[B]Erase\f[R].
.IP \[bu] 2 .IP \[bu] 2
Click \f[B]Done\f[]. Click \f[B]Done\f[R].
.IP \[bu] 2 .IP \[bu] 2
Close Disk Utility Close Disk Utility
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
From \f[B]macOS Utilities\f[] From \f[B]macOS Utilities\f[R]
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Click \f[B]Reinstall macOS\f[] and \f[B]Continue\f[] Click \f[B]Reinstall macOS\f[R] and \f[B]Continue\f[R]
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
Complete the installation as you normally would. Complete the installation as you normally would.
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
On the first reboot use cursor keys and enter key to select \f[B]macOS On the first reboot use cursor keys and enter key to select \f[B]macOS
Installer\f[] Installer\f[R]
.IP \[bu] 2 .IP \[bu] 2
On the subsequent reboots use cursor keys and enter key to select the On the subsequent reboots use cursor keys and enter key to select the
disk you named disk you named
@ -478,17 +448,18 @@ The default macOS configuration looks like this:
.IP .IP
.nf .nf
\f[C] \f[C]
guest_os="macos" guest_os=\[dq]macos\[dq]
img="macos\-catalina/RecoveryImage.img" img=\[dq]macos-catalina/RecoveryImage.img\[dq]
disk_img="macos\-catalina/disk.qcow2" disk_img=\[dq]macos-catalina/disk.qcow2\[dq]
macos_release="catalina" macos_release=\[dq]catalina\[dq]
\f[] \f[R]
.fi .fi
.IP \[bu] 2 .IP \[bu] 2
\f[C]guest_os="macos"\f[] instructs Quickemu to optimise for macOS. \f[C]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
macOS.
.IP \[bu] 2 .IP \[bu] 2
\f[C]macos_release="catalina"\f[] instructs Quickemu to optimise for a \f[C]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to
particular macOS release. optimise for a particular macOS release.
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
For example VirtIO Network and Memory Ballooning are available in Big For example VirtIO Network and Memory Ballooning are available in Big
@ -508,16 +479,16 @@ High Sierra
.IP \[bu] 2 .IP \[bu] 2
Mojave Mojave
.IP \[bu] 2 .IP \[bu] 2
Catalina \f[B](Recommended)\f[] Catalina \f[B](Recommended)\f[R]
.IP \[bu] 2 .IP \[bu] 2
Big Sur Big Sur
.IP \[bu] 2 .IP \[bu] 2
Monterey Monterey
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
\f[C]quickemu\f[] will automatically download the required \f[C]quickemu\f[R] will automatically download the required
OpenCore (https://github.com/acidanthera/OpenCorePkg) bootloader and OpenCore (https://github.com/acidanthera/OpenCorePkg) bootloader and
OVMF firmware from OSX\-KVM (https://github.com/kholia/OSX-KVM). OVMF firmware from OSX-KVM (https://github.com/kholia/OSX-KVM).
.IP \[bu] 2 .IP \[bu] 2
Optimised by default, but no GPU acceleration is available. Optimised by default, but no GPU acceleration is available.
.RS 2 .RS 2
@ -528,17 +499,17 @@ VirtIO Block
Media (https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is used Media (https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is used
for the system disk where supported. for the system disk where supported.
.IP \[bu] 2 .IP \[bu] 2
VirtIO \f[C]usb\-tablet\f[] (http://philjordan.eu/osx-virt/) is used for VirtIO \f[C]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used for
the mouse. the mouse.
.IP \[bu] 2 .IP \[bu] 2
VirtIO Network (\f[C]virtio\-net\f[]) is supported and enabled on macOS VirtIO Network (\f[C]virtio-net\f[R]) is supported and enabled on macOS
Big Sur and newer but previous releases use \f[C]vmxnet3\f[]. Big Sur and newer but previous releases use \f[C]vmxnet3\f[R].
.IP \[bu] 2 .IP \[bu] 2
VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and
newer but disabled for other support macOS releases. newer but disabled for other support macOS releases.
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
USB host and SPICE pass\-through is: USB host and SPICE pass-through is:
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
UHCI (USB 2.0) on macOS Catalina and earlier. UHCI (USB 2.0) on macOS Catalina and earlier.
@ -551,17 +522,17 @@ Display resolution can only be changed via macOS System Preferences.
Full Duplex audio works on macOS High Sierra, Mojave and Catalina. Full Duplex audio works on macOS High Sierra, Mojave and Catalina.
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
\f[B]macOS Big Sur and Monterey have no audio at all\f[]. \f[B]macOS Big Sur and Monterey have no audio at all\f[R].
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
File sharing between guest and host is available via File sharing between guest and host is available via
virtio\-9p (https://wiki.qemu.org/Documentation/9psetup) and SPICE virtio-9p (https://wiki.qemu.org/Documentation/9psetup) and SPICE
webdavd (https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24). webdavd (https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24).
.IP \[bu] 2 .IP \[bu] 2
Copy/paste via SPICE agent is \f[B]not available on macOS\f[]. Copy/paste via SPICE agent is \f[B]not available on macOS\f[R].
.SS Windows 8.1, 10 & 11 Guests .SS Windows 8.1, 10 & 11 Guests
.PP .PP
\f[C]quickget\f[] can automatically download Windows 8.1, Windows \f[C]quickget\f[R] can automatically download Windows 8.1, Windows
10 (https://www.microsoft.com/en-gb/software-download/windows10ISO) and 10 (https://www.microsoft.com/en-gb/software-download/windows10ISO) and
Windows 11 (https://www.microsoft.com/en-gb/software-download/windows11) Windows 11 (https://www.microsoft.com/en-gb/software-download/windows11)
along with the VirtIO drivers for along with the VirtIO drivers for
@ -570,9 +541,9 @@ and creates a virtual machine configuration.
.IP .IP
.nf .nf
\f[C] \f[C]
quickget\ windows\ 11 quickget windows 11
quickemu\ \-\-vm\ windows\-11.conf quickemu --vm windows-11.conf
\f[] \f[R]
.fi .fi
.IP \[bu] 2 .IP \[bu] 2
Complete the installation as you normally would. Complete the installation as you normally would.
@ -580,36 +551,36 @@ Complete the installation as you normally would.
All relevant drivers and services should be installed automatically. All relevant drivers and services should be installed automatically.
.SS Regional versions .SS Regional versions
.PP .PP
By default \f[C]quickget\f[] will download the \f[I]\[lq]English By default \f[C]quickget\f[R] will download the \f[I]\[lq]English
International\[rq]\f[] release, but you can optionally specify one of International\[rq]\f[R] release, but you can optionally specify one of
the supported languages: For example: the supported languages: For example:
.IP .IP
.nf .nf
\f[C] \f[C]
quickget\ windows\ 11\ "Chinese\ (Traditional)" quickget windows 11 \[dq]Chinese (Traditional)\[dq]
\f[] \f[R]
.fi .fi
.PP .PP
The default Windows 11 configuration looks like this: The default Windows 11 configuration looks like this:
.IP .IP
.nf .nf
\f[C] \f[C]
guest_os="windows" guest_os=\[dq]windows\[dq]
disk_img="windows\-11/disk.qcow2" disk_img=\[dq]windows-11/disk.qcow2\[dq]
iso="windows\-11/Win11_EnglishInternational_x64.iso" iso=\[dq]windows-11/Win11_EnglishInternational_x64.iso\[dq]
fixed_iso="windows\-11/virtio\-win.iso" fixed_iso=\[dq]windows-11/virtio-win.iso\[dq]
tpm="on" tpm=\[dq]on\[dq]
\f[] \f[R]
.fi .fi
.IP \[bu] 2 .IP \[bu] 2
\f[C]guest_os="windows"\f[] instructs \f[C]quickemu\f[] to optimise for \f[C]guest_os=\[dq]windows\[dq]\f[R] instructs \f[C]quickemu\f[R] to
Windows. optimise for Windows.
.IP \[bu] 2 .IP \[bu] 2
\f[C]fixed_iso=\f[] specifies the ISO image that provides VirtIO \f[C]fixed_iso=\f[R] specifies the ISO image that provides VirtIO
drivers. drivers.
.IP \[bu] 2 .IP \[bu] 2
\f[C]tpm="on"\f[] instructs \f[C]quickemu\f[] to create a software \f[C]tpm=\[dq]on\[dq]\f[R] instructs \f[C]quickemu\f[R] to create a
emulated TPM device using \f[C]swtpm\f[]. software emulated TPM device using \f[C]swtpm\f[R].
.SH All the options .SH All the options
.PP .PP
Here are the usage instructions: Here are the usage instructions:
@ -617,91 +588,91 @@ Here are the usage instructions:
.nf .nf
\f[C] \f[C]
Usage Usage
\ \ quickemu\ \-\-vm\ ubuntu.conf quickemu --vm ubuntu.conf
You\ can\ also\ pass\ optional\ parameters You can also pass optional parameters
\ \ \-\-braille\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ :\ Enable\ braille\ support.\ Requires\ SDL. --braille : Enable braille support. Requires SDL.
\ \ \-\-delete\-disk\ \ \ \ \ \ \ \ \ \ \ :\ Delete\ the\ disk\ image\ and\ EFI\ variables --delete-disk : Delete the disk image and EFI variables
\ \ \-\-delete\-vm\ \ \ \ \ \ \ \ \ \ \ \ \ :\ Delete\ the\ entire\ VM\ and\ it\[aq]s\ configuration --delete-vm : Delete the entire VM and it\[aq]s configuration
\ \ \-\-display\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ :\ Select\ display\ backend.\ \[aq]sdl\[aq]\ (default),\ \[aq]gtk\[aq],\ \[aq]none\[aq],\ or\ \[aq]spice\[aq] --display : Select display backend. \[aq]sdl\[aq] (default), \[aq]gtk\[aq], \[aq]none\[aq], or \[aq]spice\[aq]
\ \ \-\-fullscreen\ \ \ \ \ \ \ \ \ \ \ \ :\ Starts\ VM\ in\ full\ screen\ mode\ (Ctl+Alt+f\ to\ exit) --fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)
\ \ \-\-ignore\-msrs\-always\ \ \ \ :\ Configure\ KVM\ to\ always\ ignore\ unhandled\ machine\-specific\ registers --ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers
\ \ \-\-screen\ <screen>\ \ \ \ \ \ \ :\ Use\ specified\ screen\ to\ determine\ the\ window\ size. --screen <screen> : Use specified screen to determine the window size.
\ \ \-\-shortcut\ \ \ \ \ \ \ \ \ \ \ \ \ \ :\ Create\ a\ desktop\ shortcut --shortcut : Create a desktop shortcut
\ \ \-\-snapshot\ apply\ <tag>\ \ :\ Apply/restore\ a\ snapshot. --snapshot apply <tag> : Apply/restore a snapshot.
\ \ \-\-snapshot\ create\ <tag>\ :\ Create\ a\ snapshot. --snapshot create <tag> : Create a snapshot.
\ \ \-\-snapshot\ delete\ <tag>\ :\ Delete\ a\ snapshot. --snapshot delete <tag> : Delete a snapshot.
\ \ \-\-snapshot\ info\ \ \ \ \ \ \ \ \ :\ Show\ disk/snapshot\ info. --snapshot info : Show disk/snapshot info.
\ \ \-\-status\-quo\ \ \ \ \ \ \ \ \ \ \ \ :\ Do\ not\ commit\ any\ changes\ to\ disk/snapshot. --status-quo : Do not commit any changes to disk/snapshot.
\ \ \-\-version\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ :\ Print\ version --version : Print version
\f[]
\f[R]
.fi .fi
.SS Desktop shortcuts .SS Desktop shortcuts
.PP .PP
Desktop shortcuts can be created for a VM, the shortcuts are saved in Desktop shortcuts can be created for a VM, the shortcuts are saved in
\f[C]~/.local/share/applications\f[]. \f[C]\[ti]/.local/share/applications\f[R].
Here is an example of how to create a shortcut. Here is an example of how to create a shortcut.
.IP .IP
.nf .nf
\f[C] \f[C]
quickemu\ \-\-vm\ ubuntu\-20.04\-desktop.conf\ \-\-shortcut quickemu --vm ubuntu-20.04-desktop.conf --shortcut
\f[] \f[R]
.fi .fi
.SS Screen and window size (Linux guests only) .SS Screen and window size (Linux guests only)
.PP .PP
\f[C]qemu\f[] will always default to the primary monitor to display the \f[C]qemu\f[R] will always default to the primary monitor to display the
VM's window. VM\[cq]s window.
.PP .PP
Without the \f[C]\-\-screen\f[] option, \f[C]quickemu\f[] will look for Without the \f[C]--screen\f[R] option, \f[C]quickemu\f[R] will look for
the size of the smallest monitor, and use a size that fits on said the size of the smallest monitor, and use a size that fits on said
monitor. monitor.
.PP .PP
The \f[C]\-\-screen\f[] option forces \f[C]quickemu\f[] to use the size The \f[C]--screen\f[R] option forces \f[C]quickemu\f[R] to use the size
of the given monitor to compute the size of the window. of the given monitor to compute the size of the window.
\f[B]It won't use that monitor to display the VM's window if it's not \f[B]It won\[cq]t use that monitor to display the VM\[cq]s window if
the primary monitor\f[]. it\[cq]s not the primary monitor\f[R].
This is useful if the primary monitor if not the smallest one, and if This is useful if the primary monitor if not the smallest one, and if
the VM's window doesn't need to be moved around. the VM\[cq]s window doesn\[cq]t need to be moved around.
.PP .PP
The \f[C]\-\-screen\f[] option is also useful with the The \f[C]--screen\f[R] option is also useful with the
\f[C]\-\-fullscreen\f[] option, again because \f[C]qemu\f[] will always \f[C]--fullscreen\f[R] option, again because \f[C]qemu\f[R] will always
use the primary monitor. use the primary monitor.
In order for the fullscreen mode to work properly, the resolution of the In order for the fullscreen mode to work properly, the resolution of the
VM's window must match the resolution of the screen. VM\[cq]s window must match the resolution of the screen.
.PP .PP
To know which screen to use, type: To know which screen to use, type:
.IP .IP
.nf .nf
\f[C] \f[C]
xrandr\ \-\-listmonitors\ |\ grep\ \-v\ Monitors xrandr --listmonitors | grep -v Monitors
\f[] \f[R]
.fi .fi
.PP .PP
The command will output something like this: The command will output something like this:
.IP .IP
.nf .nf
\f[C] \f[C]
\ 0:\ +*HDMI\-0\ 2560/597x1440/336+1920+0\ \ HDMI\-0 0: +*HDMI-0 2560/597x1440/336+1920+0 HDMI-0
\ 1:\ +DVI\-D\-0\ 1920/527x1080/296+0+0\ \ DVI\-D\-0 1: +DVI-D-0 1920/527x1080/296+0+0 DVI-D-0
\f[] \f[R]
.fi .fi
.PP .PP
The first number is what needs to be passed to the \f[C]\-\-screen\f[] The first number is what needs to be passed to the \f[C]--screen\f[R]
option. option.
.PP .PP
For example: For example:
.IP .IP
.nf .nf
\f[C] \f[C]
quickemu\ \-\-vm\ vm.conf\ \-\-screen\ 0 quickemu --vm vm.conf --screen 0
\f[] \f[R]
.fi .fi
.PP .PP
The above uses the 2560x1440 screen to compute the size of the window, The above uses the 2560x1440 screen to compute the size of the window,
which Quickemu sizes to 2048x1152. which Quickemu sizes to 2048x1152.
Without the \f[C]\-\-screen\f[] option, Quickemu would have used the Without the \f[C]--screen\f[R] option, Quickemu would have used the
1920x1080 monitor which results in a window size of 1664x936. 1920x1080 monitor which results in a window size of 1664x936.
.SH References .SH References
.PP .PP
@ -710,7 +681,7 @@ Useful reference that assisted the development of Quickemu.
General General
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
QEMU's documentation! (https://qemu.readthedocs.io/en/latest/) QEMU\[cq]s documentation! (https://qemu.readthedocs.io/en/latest/)
.IP \[bu] 2 .IP \[bu] 2
<https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines> <https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines>
.IP \[bu] 2 .IP \[bu] 2

1
docs/quickemu.1.md
View File

@ -440,7 +440,6 @@ Here are the usage instructions:
``` {.bash} ``` {.bash}
Usage Usage
quickemu --vm ubuntu.conf quickemu --vm ubuntu.conf

172
docs/quickemu_conf.1
View File

@ -1,13 +1,13 @@
.\" Automatically generated by Pandoc 2.2.3.2 .\" Automatically generated by Pandoc 2.9.2.1
.\" .\"
.TH "QUICKEMU_CONF" "1" "February 20, 2022" "quickemu_conf" "Quickemu Configuration Manual" .TH "QUICKEMU_CONF" "1" "February 20, 2022" "quickemu_conf" "Quickemu Configuration Manual"
.hy .hy
.SH NAME .SH NAME
.PP .PP
quickemu_conf \- Options and parameters in the quickemu <vm>.conf quickemu_conf - Options and parameters in the quickemu <vm>.conf
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
\f[B]quickemu\f[] will create and run highly optimised desktop virtual \f[B]quickemu\f[R] will create and run highly optimised desktop virtual
machines for Linux, macOS and Windows. machines for Linux, macOS and Windows.
It uses sensible defaults, but many configuration options can be It uses sensible defaults, but many configuration options can be
overridden in the required configuration file, which will as a minimum overridden in the required configuration file, which will as a minimum
@ -19,51 +19,52 @@ These are the options and defaults for the <vm>.conf file
.IP .IP
.nf .nf
\f[C] \f[C]
#\ Lowercase\ variables\ are\ used\ in\ the\ VM\ config\ file\ only # Lowercase variables are used in the VM config file only
boot="efi" boot=\[dq]efi\[dq]
bridge="" bridge=\[dq]\[dq]
cpu_cores="" cpu_cores=\[dq]\[dq]
disk_img="" disk_img=\[dq]\[dq]
disk_size="" disk_size=\[dq]\[dq]
fixed_iso="" fixed_iso=\[dq]\[dq]
floppy="" floppy=\[dq]\[dq]
guest_os="linux" guest_os=\[dq]linux\[dq]
img="" img=\[dq]\[dq]
iso="" iso=\[dq]\[dq]
macos_release="" macos_release=\[dq]\[dq]
port_forwards=() port_forwards=()
preallocation="off" preallocation=\[dq]off\[dq]
ram="" ram=\[dq]\[dq]
secureboot="off" secureboot=\[dq]off\[dq]
tpm="off" tpm=\[dq]off\[dq]
usb_devices=() usb_devices=()
\f[] \f[R]
.fi .fi
.SH EXAMPLES .SH EXAMPLES
.IP .IP
.nf .nf
\f[C] \f[C]
guest_os="linux" guest_os=\[dq]linux\[dq]
disk_img="debian\-bullseye/disk.qcow2" disk_img=\[dq]debian-bullseye/disk.qcow2\[dq]
iso="debian\-bullseye/firmware\-11.0.0\-amd64\-DVD\-1.iso" iso=\[dq]debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso\[dq]
\f[] \f[R]
.fi .fi
.PP .PP
The default macOS configuration looks like this: The default macOS configuration looks like this:
.IP .IP
.nf .nf
\f[C] \f[C]
guest_os="macos" guest_os=\[dq]macos\[dq]
img="macos\-catalina/RecoveryImage.img" img=\[dq]macos-catalina/RecoveryImage.img\[dq]
disk_img="macos\-catalina/disk.qcow2" disk_img=\[dq]macos-catalina/disk.qcow2\[dq]
macos_release="catalina" macos_release=\[dq]catalina\[dq]
\f[] \f[R]
.fi .fi
.IP \[bu] 2 .IP \[bu] 2
\f[C]guest_os="macos"\f[] instructs Quickemu to optimise for macOS. \f[C]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
macOS.
.IP \[bu] 2 .IP \[bu] 2
\f[C]macos_release="catalina"\f[] instructs Quickemu to optimise for a \f[C]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to
particular macOS release. optimise for a particular macOS release.
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
For example VirtIO Network and Memory Ballooning are available in Big For example VirtIO Network and Memory Ballooning are available in Big
@ -77,29 +78,29 @@ The default Windows 11 configuration looks like this:
.IP .IP
.nf .nf
\f[C] \f[C]
guest_os="windows" guest_os=\[dq]windows\[dq]
disk_img="windows\-11/disk.qcow2" disk_img=\[dq]windows-11/disk.qcow2\[dq]
iso="windows\-11/Win11_EnglishInternational_x64.iso" iso=\[dq]windows-11/Win11_EnglishInternational_x64.iso\[dq]
fixed_iso="windows\-11/virtio\-win.iso" fixed_iso=\[dq]windows-11/virtio-win.iso\[dq]
tpm="on" tpm=\[dq]on\[dq]
\f[] \f[R]
.fi .fi
.IP \[bu] 2 .IP \[bu] 2
\f[C]guest_os="windows"\f[] instructs \f[C]quickemu\f[] to optimise for \f[C]guest_os=\[dq]windows\[dq]\f[R] instructs \f[C]quickemu\f[R] to
Windows. optimise for Windows.
.IP \[bu] 2 .IP \[bu] 2
\f[C]fixed_iso=\f[] specifies the ISO image that provides VirtIO \f[C]fixed_iso=\f[R] specifies the ISO image that provides VirtIO
drivers. drivers.
.IP \[bu] 2 .IP \[bu] 2
\f[C]tpm="on"\f[] instructs \f[C]quickemu\f[] to create a software \f[C]tpm=\[dq]on\[dq]\f[R] instructs \f[C]quickemu\f[R] to create a
emulated TPM device using \f[C]swtpm\f[]. software emulated TPM device using \f[C]swtpm\f[R].
.SH BIOS and EFI .SH BIOS and EFI
.PP .PP
Since Quickemu 2.1.0 \f[C]efi\f[] is the default boot option. Since Quickemu 2.1.0 \f[C]efi\f[R] is the default boot option.
If you want to override this behaviour then add the following line to If you want to override this behaviour then add the following line to
you VM configuration to enable legacy BIOS. you VM configuration to enable legacy BIOS.
.IP \[bu] 2 .IP \[bu] 2
\f[C]boot="legacy"\f[] \- Enable Legacy BIOS boot \f[C]boot=\[dq]legacy\[dq]\f[R] - Enable Legacy BIOS boot
.SH Tuning CPU cores, RAM & disks .SH Tuning CPU cores, RAM & disks
.PP .PP
By default, Quickemu will calculate the number of CPUs cores and RAM to By default, Quickemu will calculate the number of CPUs cores and RAM to
@ -109,17 +110,18 @@ your liking.
.PP .PP
Add additional lines to your virtual machine configuration: Add additional lines to your virtual machine configuration:
.IP \[bu] 2 .IP \[bu] 2
\f[C]cpu_cores="4"\f[] \- Specify the number of CPU cores allocated to \f[C]cpu_cores=\[dq]4\[dq]\f[R] - Specify the number of CPU cores
allocated to the VM
.IP \[bu] 2
\f[C]ram=\[dq]4G\[dq]\f[R] - Specify the amount of RAM to allocate to
the VM the VM
.IP \[bu] 2 .IP \[bu] 2
\f[C]ram="4G"\f[] \- Specify the amount of RAM to allocate to the VM \f[C]disk_size=\[dq]16G\[dq]\f[R] - Specify the size of the virtual disk
.IP \[bu] 2
\f[C]disk_size="16G"\f[] \- Specify the size of the virtual disk
allocated to the VM allocated to the VM
.SS Disk preallocation .SS Disk preallocation
.PP .PP
Preallocation mode (allowed values: \f[C]off\f[] (default), Preallocation mode (allowed values: \f[C]off\f[R] (default),
\f[C]metadata\f[], \f[C]falloc\f[], \f[C]full\f[]). \f[C]metadata\f[R], \f[C]falloc\f[R], \f[C]full\f[R]).
An image with preallocated metadata is initially larger but can improve An image with preallocated metadata is initially larger but can improve
performance when the image needs to grow. performance when the image needs to grow.
.PP .PP
@ -127,41 +129,41 @@ Specify what disk preallocation should be used, if any, when creating
the system disk image by adding a line like this to your VM the system disk image by adding a line like this to your VM
configuration. configuration.
.IP \[bu] 2 .IP \[bu] 2
\f[C]preallocation="metadata"\f[] \f[C]preallocation=\[dq]metadata\[dq]\f[R]
.SS CD\-ROM disks .SS CD-ROM disks
.PP .PP
If you want to expose an ISO image from the host to guest add the If you want to expose an ISO image from the host to guest add the
following line to the VM configuration: following line to the VM configuration:
.IP \[bu] 2 .IP \[bu] 2
\f[C]fixed_iso="/path/to/image.iso"\f[] \f[C]fixed_iso=\[dq]/path/to/image.iso\[dq]\f[R]
.SS Floppy disks .SS Floppy disks
.PP .PP
If you're like Alan Pope (https://popey.com) you'll probably want to If you\[cq]re like Alan Pope (https://popey.com) you\[cq]ll probably
mount a floppy disk image in the guest. want to mount a floppy disk image in the guest.
To do so add the following line to the VM configuration: To do so add the following line to the VM configuration:
.IP \[bu] 2 .IP \[bu] 2
\f[C]floppy="/path/to/floppy.img"\f[] \f[C]floppy=\[dq]/path/to/floppy.img\[dq]\f[R]
.SH File Sharing .SH File Sharing
.PP .PP
All File Sharing options will only expose \f[C]~/Public\f[] (or All File Sharing options will only expose \f[C]\[ti]/Public\f[R] (or
localised variations) for the current user to the guest VMs. localised variations) for the current user to the guest VMs.
.SS Samba 🐧 🍏 🪟 .SS Samba \[u1F427] \[u1F34F] \[u1FA9F]
.PP .PP
If \f[C]smbd\f[] is available on the host, Quickemu will automatically If \f[C]smbd\f[R] is available on the host, Quickemu will automatically
enable the built\-in QEMU support for exposing a Samba share from the enable the built-in QEMU support for exposing a Samba share from the
host to the guest. host to the guest.
.PP .PP
You can install the minimal Samba components on Ubuntu using: You can install the minimal Samba components on Ubuntu using:
.IP .IP
.nf .nf
\f[C] \f[C]
sudo\ apt\ install\ \-\-no\-install\-recommends\ samba sudo apt install --no-install-recommends samba
\f[] \f[R]
.fi .fi
.SS SPICE WebDAV 🐧 🪟 .SS SPICE WebDAV \[u1F427] \[u1FA9F]
.IP \[bu] 2 .IP \[bu] 2
TBD TBD
.SS VirtIO\-9P 🐧 🍏 .SS VirtIO-9P \[u1F427] \[u1F34F]
.IP \[bu] 2 .IP \[bu] 2
TBD TBD
.SH Network port forwarding .SH Network port forwarding
@ -169,7 +171,7 @@ TBD
Add an additional line to your virtual machine configuration. Add an additional line to your virtual machine configuration.
For example: For example:
.IP \[bu] 2 .IP \[bu] 2
\f[C]port_forwards=("8123:8123"\ "8888:80")\f[] \f[C]port_forwards=(\[dq]8123:8123\[dq] \[dq]8888:80\[dq])\f[R]
.PP .PP
In the example above: In the example above:
.IP \[bu] 2 .IP \[bu] 2
@ -181,28 +183,28 @@ Port 8888 on the host is forwarded to port 80 on the guest.
Connect your virtual machine to a preconfigured network bridge. Connect your virtual machine to a preconfigured network bridge.
Add an additional line to your virtual machine configuration Add an additional line to your virtual machine configuration
.IP \[bu] 2 .IP \[bu] 2
\f[C]bridge="br0"\f[] \f[C]bridge=\[dq]br0\[dq]\f[R]
.SH USB redirection .SH USB redirection
.PP .PP
Quickemu supports USB redirection via SPICE pass\-through and host Quickemu supports USB redirection via SPICE pass-through and host
pass\-through. pass-through.
.SS SPICE redirection (recommended) .SS SPICE redirection (recommended)
.PP .PP
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\[cq]t require
elevated permission, start Quickemu with \f[C]\-\-display\ spice\f[] and any elevated permission, start Quickemu with \f[C]--display spice\f[R]
then select \f[C]Input\f[] \-> and then select \f[C]Input\f[R] ->
\f[C]Select\ USB\ Device\ for\ redirection\f[] from the menu to choose \f[C]Select USB Device for redirection\f[R] from the menu to choose
which device(s) you want to attach to the guest. which device(s) you want to attach to the guest.
.SS Host redirection \f[B]NOT Recommended\f[] .SS Host redirection \f[B]NOT Recommended\f[R]
.PP .PP
\f[B]USB host redirection is not recommended\f[], it is provided purely \f[B]USB host redirection is not recommended\f[R], it is provided purely
for backwards compatibility to older versions of Quickemu. for backwards compatibility to older versions of Quickemu.
Using SPICE is preferred, see above. Using SPICE is preferred, see above.
.PP .PP
Add an additional line to your virtual machine configuration. Add an additional line to your virtual machine configuration.
For example: For example:
.IP \[bu] 2 .IP \[bu] 2
\f[C]usb_devices=("046d:082d"\ "046d:085e")\f[] \f[C]usb_devices=(\[dq]046d:082d\[dq] \[dq]046d:085e\[dq])\f[R]
.PP .PP
In the example above: In the example above:
.IP \[bu] 2 .IP \[bu] 2
@ -212,25 +214,25 @@ to the guest.
The USB device with vendor_id 046d and product_id 085e will be exposed The USB device with vendor_id 046d and product_id 085e will be exposed
to the guest. to the guest.
.PP .PP
If the USB devices are not writable, \f[C]quickemu\f[] will display the If the USB devices are not writable, \f[C]quickemu\f[R] will display the
appropriate commands to modify the USB device(s) access permissions, appropriate commands to modify the USB device(s) access permissions,
like this: like this:
.IP .IP
.nf .nf
\f[C] \f[C]
\ \-\ USB:\ \ \ \ \ \ Host\ pass\-through\ requested: - USB: Host pass-through requested:
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \-\ Sennheiser\ Communications\ EPOS\ GTW\ 270\ on\ bus\ 001\ device\ 005\ needs\ permission\ changes: - Sennheiser Communications EPOS GTW 270 on bus 001 device 005 needs permission changes:
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ sudo\ chown\ \-v\ root:user\ /dev/bus/usb/001/005 sudo chown -v root:user /dev/bus/usb/001/005
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ ERROR!\ USB\ permission\ changes\ are\ required\ 👆 ERROR! USB permission changes are required \[u1F446]
\f[] \f[R]
.fi .fi
.SH TPM .SH TPM
.PP .PP
Since Quickemu 2.2.0 a software emulated TPM device can be added to Since Quickemu 2.2.0 a software emulated TPM device can be added to
guest virtual machines. guest virtual machines.
Just add \f[C]tpm="on"\f[] to your VM configuration. Just add \f[C]tpm=\[dq]on\[dq]\f[R] to your VM configuration.
\f[C]quickget\f[] will automatically add this line to Windows 11 virtual \f[C]quickget\f[R] will automatically add this line to Windows 11
machines. virtual machines.
.SH AUTHORS .SH AUTHORS
.PP .PP
Written by Martin Wimpress. Written by Martin Wimpress.

4
docs/quickemu_conf.1.md
View File

@ -1,10 +1,10 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: 'February 20, 2022' date: 'February 20, 2022'
footer: 'quickemu\_conf' footer: quickemu\_conf
header: Quickemu Configuration Manual header: Quickemu Configuration Manual
section: 1 section: 1
title: 'QUICKEMU\_CONF' title: QUICKEMU\_CONF
--- ---
NAME NAME

283
docs/quickget.1
View File

@ -1,181 +1,175 @@
.\" Automatically generated by Pandoc 2.2.3.2 .\" Automatically generated by Pandoc 2.9.2.1
.\" .\"
.TH "QUICKGET" "1" "February 20, 2022" "quickget" "Quickget User Manual" .TH "QUICKGET" "1" "February 20, 2022" "quickget" "Quickget User Manual"
.hy .hy
.SH NAME .SH NAME
.PP .PP
quickget \- download and prepare materials for building a quickemu VM quickget - download and prepare materials for building a quickemu VM
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\f[B]quickget\f[] [\f[I]os\f[]] [\f[I]release\f[]] [\f[I]edition\f[]] | \f[B]quickget\f[R] [\f[I]os\f[R]] [\f[I]release\f[R]]
[\f[I]OPTION\f[]]* [\f[I]edition\f[R]] | [\f[I]OPTION\f[R]]*
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
\f[B]quickget\f[] will download the requisite materials and prepare a \f[B]quickget\f[R] will download the requisite materials and prepare a
configuration for \f[C]quickemu\f[] to use to build and run configuration for \f[C]quickemu\f[R] to use to build and run
.SH OPTIONS .SH OPTIONS
.TP .TP
.B \f[B]version | \-version | \[en]version\f[] \f[B]version | -version | \[en]version\f[R]
show version (from Quickemu) show version (from Quickemu)
.RS
.RE
.TP .TP
.B \f[B]list | list_csv | list_json\f[] \f[B]list | list_csv | list_json\f[R]
provide a csv list of all supported guest OSes, versions and variants. provide a csv list of all supported guest OSes, versions and variants.
.RS
.RE
.TP .TP
.B \f[B][OS] [Release] [Edition]\f[] \f[B][OS] [Release] [Edition]\f[R]
specify the OS and release (and optional edition) if insufficient input specify the OS and release (and optional edition) if insufficient input
is provided a list of missing options will be reported and the script is provided a list of missing options will be reported and the script
will exit. will exit.
Editions may not apply and will be defaulted if not provided. Editions may not apply and will be defaulted if not provided.
.RS
.RE
.SH NOTES .SH NOTES
.SS Ubuntu Guest .SS Ubuntu Guest
.PP .PP
\f[C]quickget\f[] will automatically download an Ubuntu release and \f[C]quickget\f[R] will automatically download an Ubuntu release and
create the virtual machine configuration. create the virtual machine configuration.
.IP .IP
.nf .nf
\f[C] \f[C]
quickget\ ubuntu\ 20.04 quickget ubuntu 20.04
quickemu\ \-\-vm\ ubuntu\-20.04.conf quickemu --vm ubuntu-20.04.conf
\f[] \f[R]
.fi .fi
.IP \[bu] 2 .IP \[bu] 2
Complete the installation as normal. Complete the installation as normal.
.IP \[bu] 2 .IP \[bu] 2
Post\-install: Post-install:
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE agent (\f[C]spice\-vdagent\f[]) to enable copy/paste Install the SPICE agent (\f[C]spice-vdagent\f[R]) to enable copy/paste
and USB redirection and USB redirection
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
\f[C]sudo\ apt\ install\ spice\-vdagent\f[] \f[C]sudo apt install spice-vdagent\f[R]
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE WebDAV agent (\f[C]spice\-webdavd\f[]) to enable file Install the SPICE WebDAV agent (\f[C]spice-webdavd\f[R]) to enable file
sharing. sharing.
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
\f[C]sudo\ apt\ install\ spice\-webdavd\f[] \f[C]sudo apt install spice-webdavd\f[R]
.RE .RE
.RE .RE
.SS Ubuntu devel (daily\-live) images .SS Ubuntu devel (daily-live) images
.PP .PP
\f[C]quickget\f[] can also download/refresh devel images via \f[C]quickget\f[R] can also download/refresh devel images via
\f[C]zsync\f[] for Ubuntu developers and testers. \f[C]zsync\f[R] for Ubuntu developers and testers.
.IP .IP
.nf .nf
\f[C] \f[C]
quickget\ ubuntu\ devel quickget ubuntu devel
quickemu\ \-\-vm\ ubuntu\-devel.conf quickemu --vm ubuntu-devel.conf
\f[] \f[R]
.fi .fi
.PP .PP
You can run \f[C]quickget\ ubuntu\ devel\f[] to refresh your daily You can run \f[C]quickget ubuntu devel\f[R] to refresh your daily
development image as often as you like, it will even automatically development image as often as you like, it will even automatically
switch to a new series. switch to a new series.
.SS Ubuntu Flavours .SS Ubuntu Flavours
.PP .PP
All the official Ubuntu flavours are supported, just replace All the official Ubuntu flavours are supported, just replace
\f[C]ubuntu\f[] with your preferred flavour. \f[C]ubuntu\f[R] with your preferred flavour.
.IP \[bu] 2 .IP \[bu] 2
\f[C]kubuntu\f[] (Kubuntu) \f[C]kubuntu\f[R] (Kubuntu)
.IP \[bu] 2 .IP \[bu] 2
\f[C]lubuntu\f[] (Lubuntu) \f[C]lubuntu\f[R] (Lubuntu)
.IP \[bu] 2 .IP \[bu] 2
\f[C]ubuntu\-budgie\f[] (Ubuntu Budgie) \f[C]ubuntu-budgie\f[R] (Ubuntu Budgie)
.IP \[bu] 2 .IP \[bu] 2
\f[C]ubuntukylin\f[] (Ubuntu Kylin) \f[C]ubuntukylin\f[R] (Ubuntu Kylin)
.IP \[bu] 2 .IP \[bu] 2
\f[C]ubuntu\-mate\f[] (Ubuntu MATE) \f[C]ubuntu-mate\f[R] (Ubuntu MATE)
.IP \[bu] 2 .IP \[bu] 2
\f[C]ubuntustudio\f[] (Ubuntu Studio) \f[C]ubuntustudio\f[R] (Ubuntu Studio)
.IP \[bu] 2 .IP \[bu] 2
\f[C]ubuntu\f[] (Ubuntu) \f[C]ubuntu\f[R] (Ubuntu)
.IP \[bu] 2 .IP \[bu] 2
\f[C]xubuntu\f[] (Xubuntu) \f[C]xubuntu\f[R] (Xubuntu)
.SS Other Operating Systems .SS Other Operating Systems
.PP .PP
\f[C]quickget\f[] also supports: \f[C]quickget\f[R] also supports:
.IP \[bu] 2 .IP \[bu] 2
\f[C]alma\f[] (Alma Linux) \f[C]alma\f[R] (Alma Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]alpine\f[] (Alpine Linux) \f[C]alpine\f[R] (Alpine Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]android\f[] (Android x86) \f[C]android\f[R] (Android x86)
.IP \[bu] 2 .IP \[bu] 2
\f[C]archlinux\f[] (Arch Linux) \f[C]archlinux\f[R] (Arch Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]arcolinux\f[] (Arco Linux) \f[C]arcolinux\f[R] (Arco Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]cachyos\f[] (CachyOS) \f[C]cachyos\f[R] (CachyOS)
.IP \[bu] 2 .IP \[bu] 2
\f[C]debian\f[] (Debian) \f[C]debian\f[R] (Debian)
.IP \[bu] 2 .IP \[bu] 2
\f[C]devuan\f[] (Devuan) \f[C]devuan\f[R] (Devuan)
.IP \[bu] 2 .IP \[bu] 2
\f[C]dragonflybsd\f[] (DragonFlyBSD) \f[C]dragonflybsd\f[R] (DragonFlyBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[C]elementary\f[] (elementary OS) \f[C]elementary\f[R] (elementary OS)
.IP \[bu] 2 .IP \[bu] 2
\f[C]fedora\f[] (Fedora) \f[C]fedora\f[R] (Fedora)
.IP \[bu] 2 .IP \[bu] 2
\f[C]freebsd\f[] (FreeBSD) \f[C]freebsd\f[R] (FreeBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[C]freedos\f[] (FreeDOS) \f[C]freedos\f[R] (FreeDOS)
.IP \[bu] 2 .IP \[bu] 2
\f[C]garuda\f[] (Garuda Linux) \f[C]garuda\f[R] (Garuda Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]gentoo\f[] (Gentoo) \f[C]gentoo\f[R] (Gentoo)
.IP \[bu] 2 .IP \[bu] 2
\f[C]ghostbsd\f[] (GhostBSD) \f[C]ghostbsd\f[R] (GhostBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[C]haiku\f[] (Haiku) \f[C]haiku\f[R] (Haiku)
.IP \[bu] 2 .IP \[bu] 2
\f[C]kali\f[] (Kali) \f[C]kali\f[R] (Kali)
.IP \[bu] 2 .IP \[bu] 2
\f[C]kdeneon\f[] (KDE Neon) \f[C]kdeneon\f[R] (KDE Neon)
.IP \[bu] 2 .IP \[bu] 2
\f[C]kolibrios\f[] (KolibriOS) \f[C]kolibrios\f[R] (KolibriOS)
.IP \[bu] 2 .IP \[bu] 2
\f[C]linuxmint\f[] (Linux Mint) \f[C]linuxmint\f[R] (Linux Mint)
.IP \[bu] 2 .IP \[bu] 2
\f[C]manjaro\f[] (Manjaro) \f[C]manjaro\f[R] (Manjaro)
.IP \[bu] 2 .IP \[bu] 2
\f[C]mxlinux\f[] (MX Linux) \f[C]mxlinux\f[R] (MX Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]netboot\f[] (netboot.xyz) \f[C]netboot\f[R] (netboot.xyz)
.IP \[bu] 2 .IP \[bu] 2
\f[C]netbsd\f[] (NetBSD) \f[C]netbsd\f[R] (NetBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[C]nixos\f[] (NixOS) \f[C]nixos\f[R] (NixOS)
.IP \[bu] 2 .IP \[bu] 2
\f[C]openbsd\f[] (OpenBSD) \f[C]openbsd\f[R] (OpenBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[C]opensuse\f[] (openSUSE) \f[C]opensuse\f[R] (openSUSE)
.IP \[bu] 2 .IP \[bu] 2
\f[C]oraclelinux\f[] (Oracle Linux) \f[C]oraclelinux\f[R] (Oracle Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]popos\f[] (Pop!_OS) \f[C]popos\f[R] (Pop!_OS)
.IP \[bu] 2 .IP \[bu] 2
\f[C]regolith\f[] (Regolith Linux) \f[C]regolith\f[R] (Regolith Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]rockylinux\f[] (Rocky Linux) \f[C]rockylinux\f[R] (Rocky Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]slackware\f[] (Slackware) \f[C]slackware\f[R] (Slackware)
.IP \[bu] 2 .IP \[bu] 2
\f[C]solus\f[] (Solus) \f[C]solus\f[R] (Solus)
.IP \[bu] 2 .IP \[bu] 2
\f[C]tails\f[] (Tails) \f[C]tails\f[R] (Tails)
.IP \[bu] 2 .IP \[bu] 2
\f[C]void\f[] (Void Linux) \f[C]void\f[R] (Void Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[C]zorin\f[] (Zorin OS) \f[C]zorin\f[R] (Zorin OS)
.PP .PP
Or you can download a Linux image and manually create a VM Or you can download a Linux image and manually create a VM
configuration. configuration.
@ -183,91 +177,91 @@ configuration.
Download a .iso image of a Linux distribution Download a .iso image of a Linux distribution
.IP \[bu] 2 .IP \[bu] 2
Create a VM configuration file; for example Create a VM configuration file; for example
\f[C]debian\-bullseye.conf\f[] \f[C]debian-bullseye.conf\f[R]
.IP .IP
.nf .nf
\f[C] \f[C]
guest_os="linux" guest_os=\[dq]linux\[dq]
disk_img="debian\-bullseye/disk.qcow2" disk_img=\[dq]debian-bullseye/disk.qcow2\[dq]
iso="debian\-bullseye/firmware\-11.0.0\-amd64\-DVD\-1.iso" iso=\[dq]debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso\[dq]
\f[] \f[R]
.fi .fi
.IP \[bu] 2 .IP \[bu] 2
Use \f[C]quickemu\f[] to start the virtual machine: Use \f[C]quickemu\f[R] to start the virtual machine:
.IP .IP
.nf .nf
\f[C] \f[C]
quickemu\ \-\-vm\ debian\-bullseye.conf quickemu --vm debian-bullseye.conf
\f[] \f[R]
.fi .fi
.IP \[bu] 2 .IP \[bu] 2
Complete the installation as normal. Complete the installation as normal.
.IP \[bu] 2 .IP \[bu] 2
Post\-install: Post-install:
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE agent (\f[C]spice\-vdagent\f[]) to enable copy/paste Install the SPICE agent (\f[C]spice-vdagent\f[R]) to enable copy/paste
and USB redirection. and USB redirection.
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE WebDAV agent (\f[C]spice\-webdavd\f[]) to enable file Install the SPICE WebDAV agent (\f[C]spice-webdavd\f[R]) to enable file
sharing. sharing.
.RE .RE
.SS macOS Guest .SS macOS Guest
.PP .PP
\f[C]quickget\f[] automatically downloads a macOS recovery image and \f[C]quickget\f[R] automatically downloads a macOS recovery image and
creates a virtual machine configuration. creates a virtual machine configuration.
.IP .IP
.nf .nf
\f[C] \f[C]
quickget\ macos\ catalina quickget macos catalina
quickemu\ \-\-vm\ macos\-catalina.conf quickemu --vm macos-catalina.conf
\f[] \f[R]
.fi .fi
.PP .PP
macOS \f[C]high\-sierra\f[], \f[C]mojave\f[], \f[C]catalina\f[], macOS \f[C]high-sierra\f[R], \f[C]mojave\f[R], \f[C]catalina\f[R],
\f[C]big\-sur\f[] and \f[C]monterey\f[] are supported. \f[C]big-sur\f[R] and \f[C]monterey\f[R] are supported.
.IP \[bu] 2 .IP \[bu] 2
Use cursor keys and enter key to select the \f[B]macOS Base System\f[] Use cursor keys and enter key to select the \f[B]macOS Base System\f[R]
.IP \[bu] 2 .IP \[bu] 2
From \f[B]macOS Utilities\f[] From \f[B]macOS Utilities\f[R]
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Click \f[B]Disk Utility\f[] and \f[B]Continue\f[] Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R]
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
On macOS Catalina, Big Sur & Monterey On macOS Catalina, Big Sur & Monterey
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Select \f[C]Apple\ Inc.\ VirtIO\ Block\ Media\f[] from the list and Select \f[C]Apple Inc. VirtIO Block Media\f[R] from the list and click
click \f[B]Erase\f[]. \f[B]Erase\f[R].
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
On macOS Mojave and High Sierra On macOS Mojave and High Sierra
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Select \f[C]QEMU\ HARDDISK\ Media\f[] (~103.08GB) from the list and Select \f[C]QEMU HARDDISK Media\f[R] (\[ti]103.08GB) from the list and
click \f[B]Erase\f[]. click \f[B]Erase\f[R].
.RE .RE
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
Enter a \f[C]Name:\f[] for the disk and click \f[B]Erase\f[]. Enter a \f[C]Name:\f[R] for the disk and click \f[B]Erase\f[R].
.IP \[bu] 2 .IP \[bu] 2
Click \f[B]Done\f[]. Click \f[B]Done\f[R].
.IP \[bu] 2 .IP \[bu] 2
Close Disk Utility Close Disk Utility
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
From \f[B]macOS Utilities\f[] From \f[B]macOS Utilities\f[R]
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Click \f[B]Reinstall macOS\f[] and \f[B]Continue\f[] Click \f[B]Reinstall macOS\f[R] and \f[B]Continue\f[R]
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
Complete the installation as you normally would. Complete the installation as you normally would.
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
On the first reboot use cursor keys and enter key to select \f[B]macOS On the first reboot use cursor keys and enter key to select \f[B]macOS
Installer\f[] Installer\f[R]
.IP \[bu] 2 .IP \[bu] 2
On the subsequent reboots use cursor keys and enter key to select the On the subsequent reboots use cursor keys and enter key to select the
disk you named disk you named
@ -277,17 +271,18 @@ The default macOS configuration looks like this:
.IP .IP
.nf .nf
\f[C] \f[C]
guest_os="macos" guest_os=\[dq]macos\[dq]
img="macos\-catalina/RecoveryImage.img" img=\[dq]macos-catalina/RecoveryImage.img\[dq]
disk_img="macos\-catalina/disk.qcow2" disk_img=\[dq]macos-catalina/disk.qcow2\[dq]
macos_release="catalina" macos_release=\[dq]catalina\[dq]
\f[] \f[R]
.fi .fi
.IP \[bu] 2 .IP \[bu] 2
\f[C]guest_os="macos"\f[] instructs Quickemu to optimise for macOS. \f[C]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
macOS.
.IP \[bu] 2 .IP \[bu] 2
\f[C]macos_release="catalina"\f[] instructs Quickemu to optimise for a \f[C]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to
particular macOS release. optimise for a particular macOS release.
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
For example VirtIO Network and Memory Ballooning are available in Big For example VirtIO Network and Memory Ballooning are available in Big
@ -307,16 +302,16 @@ High Sierra
.IP \[bu] 2 .IP \[bu] 2
Mojave Mojave
.IP \[bu] 2 .IP \[bu] 2
Catalina \f[B](Recommended)\f[] Catalina \f[B](Recommended)\f[R]
.IP \[bu] 2 .IP \[bu] 2
Big Sur Big Sur
.IP \[bu] 2 .IP \[bu] 2
Monterey Monterey
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
\f[C]quickemu\f[] will automatically download the required \f[C]quickemu\f[R] will automatically download the required
OpenCore (https://github.com/acidanthera/OpenCorePkg) bootloader and OpenCore (https://github.com/acidanthera/OpenCorePkg) bootloader and
OVMF firmware from OSX\-KVM (https://github.com/kholia/OSX-KVM). OVMF firmware from OSX-KVM (https://github.com/kholia/OSX-KVM).
.IP \[bu] 2 .IP \[bu] 2
Optimised by default, but no GPU acceleration is available. Optimised by default, but no GPU acceleration is available.
.RS 2 .RS 2
@ -327,17 +322,17 @@ VirtIO Block
Media (https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is used Media (https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is used
for the system disk where supported. for the system disk where supported.
.IP \[bu] 2 .IP \[bu] 2
VirtIO \f[C]usb\-tablet\f[] (http://philjordan.eu/osx-virt/) is used for VirtIO \f[C]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used for
the mouse. the mouse.
.IP \[bu] 2 .IP \[bu] 2
VirtIO Network (\f[C]virtio\-net\f[]) is supported and enabled on macOS VirtIO Network (\f[C]virtio-net\f[R]) is supported and enabled on macOS
Big Sur and newer but previous releases use \f[C]vmxnet3\f[]. Big Sur and newer but previous releases use \f[C]vmxnet3\f[R].
.IP \[bu] 2 .IP \[bu] 2
VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and
newer but disabled for other support macOS releases. newer but disabled for other support macOS releases.
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
USB host and SPICE pass\-through is: USB host and SPICE pass-through is:
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
UHCI (USB 2.0) on macOS Catalina and earlier. UHCI (USB 2.0) on macOS Catalina and earlier.
@ -350,17 +345,17 @@ Display resolution can only be changed via macOS System Preferences.
Full Duplex audio works on macOS High Sierra, Mojave and Catalina. Full Duplex audio works on macOS High Sierra, Mojave and Catalina.
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
\f[B]macOS Big Sur and Monterey have no audio at all\f[]. \f[B]macOS Big Sur and Monterey have no audio at all\f[R].
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
File sharing between guest and host is available via File sharing between guest and host is available via
virtio\-9p (https://wiki.qemu.org/Documentation/9psetup) and SPICE virtio-9p (https://wiki.qemu.org/Documentation/9psetup) and SPICE
webdavd (https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24). webdavd (https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24).
.IP \[bu] 2 .IP \[bu] 2
Copy/paste via SPICE agent is \f[B]not available on macOS\f[]. Copy/paste via SPICE agent is \f[B]not available on macOS\f[R].
.SS Windows 8.1, 10 & 11 Guests .SS Windows 8.1, 10 & 11 Guests
.PP .PP
\f[C]quickget\f[] can automatically download Windows 8.1, Windows \f[C]quickget\f[R] can automatically download Windows 8.1, Windows
10 (https://www.microsoft.com/en-gb/software-download/windows10ISO) and 10 (https://www.microsoft.com/en-gb/software-download/windows10ISO) and
Windows 11 (https://www.microsoft.com/en-gb/software-download/windows11) Windows 11 (https://www.microsoft.com/en-gb/software-download/windows11)
along with the VirtIO drivers for along with the VirtIO drivers for
@ -369,9 +364,9 @@ and creates a virtual machine configuration.
.IP .IP
.nf .nf
\f[C] \f[C]
quickget\ windows\ 11 quickget windows 11
quickemu\ \-\-vm\ windows\-11.conf quickemu --vm windows-11.conf
\f[] \f[R]
.fi .fi
.IP \[bu] 2 .IP \[bu] 2
Complete the installation as you normally would. Complete the installation as you normally would.
@ -379,36 +374,36 @@ Complete the installation as you normally would.
All relevant drivers and services should be installed automatically. All relevant drivers and services should be installed automatically.
.SS Regional versions .SS Regional versions
.PP .PP
By default \f[C]quickget\f[] will download the \f[I]\[lq]English By default \f[C]quickget\f[R] will download the \f[I]\[lq]English
International\[rq]\f[] release, but you can optionally specify one of International\[rq]\f[R] release, but you can optionally specify one of
the supported languages: For example: the supported languages: For example:
.IP .IP
.nf .nf
\f[C] \f[C]
quickget\ windows\ 11\ "Chinese\ (Traditional)" quickget windows 11 \[dq]Chinese (Traditional)\[dq]
\f[] \f[R]
.fi .fi
.PP .PP
The default Windows 11 configuration looks like this: The default Windows 11 configuration looks like this:
.IP .IP
.nf .nf
\f[C] \f[C]
guest_os="windows" guest_os=\[dq]windows\[dq]
disk_img="windows\-11/disk.qcow2" disk_img=\[dq]windows-11/disk.qcow2\[dq]
iso="windows\-11/Win11_EnglishInternational_x64.iso" iso=\[dq]windows-11/Win11_EnglishInternational_x64.iso\[dq]
fixed_iso="windows\-11/virtio\-win.iso" fixed_iso=\[dq]windows-11/virtio-win.iso\[dq]
tpm="on" tpm=\[dq]on\[dq]
\f[] \f[R]
.fi .fi
.IP \[bu] 2 .IP \[bu] 2
\f[C]guest_os="windows"\f[] instructs \f[C]quickemu\f[] to optimise for \f[C]guest_os=\[dq]windows\[dq]\f[R] instructs \f[C]quickemu\f[R] to
Windows. optimise for Windows.
.IP \[bu] 2 .IP \[bu] 2
\f[C]fixed_iso=\f[] specifies the ISO image that provides VirtIO \f[C]fixed_iso=\f[R] specifies the ISO image that provides VirtIO
drivers. drivers.
.IP \[bu] 2 .IP \[bu] 2
\f[C]tpm="on"\f[] instructs \f[C]quickemu\f[] to create a software \f[C]tpm=\[dq]on\[dq]\f[R] instructs \f[C]quickemu\f[R] to create a
emulated TPM device using \f[C]swtpm\f[]. software emulated TPM device using \f[C]swtpm\f[R].
.SH AUTHORS .SH AUTHORS
.PP .PP
Written by Martin Wimpress. Written by Martin Wimpress.