docs: windows automation return changes reflected and documentation regenerated

Co-authored-by: dabrown645 dabrown645@users.noreply.github.com

.editorconfig

@@ -0,0 +1,20 @@
+root = true
+
+[quickemu]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+
+[quickget]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.github/issue_template.md

@@ -0,0 +1,24 @@
+#### Expected behaviour
+
+Describe the your expected behaviour.
+
+#### Actual behaviour
+
+Describe the actual behaviour.
+
+#### Steps to reproduce the behaviour
+
+Outline the step to reproduce the issue you've encountered.
+
+#### Quickemu output
+
+Run `quickemu` or `quickget` and paste the output here.
+
+#### Linux Distribution & Kernel
+
+Run the following and paste the output.
+
+```bash
+lsb_release --all
+uname -a
+```

.github/workflows/greetings.yml

@@ -0,0 +1,25 @@
+name: 👋 Greetings
+
+on: [pull_request, issues]
+
+jobs:
+  greeting:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/first-interaction@v1
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        issue-message: |
+          Hello there 👋
+          Thanks for submitting your first issue to the Quickemu project 🐛 We'll try and take a look at your issue soon ⏲
+
+          In the meantime you might want to join the [Wimpys World Discord](https://wimpysworld.io/discord) 🗣 where we have a large community of Linux 🐧 enthusiasts and passionate open source developers 🧑‍💻
+
+          You might also be interested in following [Wimpys World Twitch 📡 channel](https://twitch.tv/WimpysWorld) where Wimpy streams let's code video, including this project, several times a week. A back catalog of past live stream and other Linux related content is available on [Wimpys World YouTube 📺 channel](https://youtube.com/WimpysWorld).
+        pr-message: |
+          Hello there 👋
+          Thanks for submitting your first pull request to the Quickemu project 💪 We'll try to review your pull request soon ⏲
+
+          In the meantime you might want to join the [Wimpys World Discord](https://wimpysworld.io/discord) 🗣 where we have a large community of Linux 🐧 enthusiasts and passionate open source developers 🧑‍💻
+
+          You might also be interested in following [Wimpys World Twitch 📡 channel](https://twitch.tv/WimpysWorld) where Wimpy streams let's code video, including this project, several times a week. A back catalog of past live stream and other Linux related content is available on [Wimpys World YouTube 📺 channel](https://youtube.com/WimpysWorld).

.gitignore

@@ -1,11 +1,18 @@
-*.qcow2
+*.chunklist
-*.iso
 *.conf
-*.sh
+*.dmg
-*.log
 *.fd
-*.xml
+*.img
+*.iso
+*.lock
+*.log
+*.msi
+*.part
 *.permall
-.lock
+*.pid
-SHA*
+*.ports
-sha*
+*.qcow2
+*.sh
+*.sock
+*.xml
+*.zs-old

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "build-docs"]
+	path = build-docs
+	url = git@github.com:philclifford/quickemu-docs.git

build-docs

@@ -0,0 +1 @@
+Subproject commit 5bd40cb6bfbf21493c2cde258d09d0cab9ad3ff8

docs/Makefile

@@ -0,0 +1,42 @@
+include pandoc-man.mk
+
+ifeq ($(PREFIX),)
+    PREFIX := /usr/local
+endif
+
+datarootdir := $(PREFIX)/share
+datadir := $(datarootdir)
+mandir := $(datarootdir)/man
+bindir :=  $(PREFIX)/bin
+
+all: quickget.1 quickemu.1 quickemu_conf.1
+
+clean:
+	rm *.1
+
+install_docs: all
+	install -d $(DESTDIR)$(mandir)/man1
+	install -m 644 quickget.1 $(DESTDIR)$(mandir)/man1
+	install -m 644 quickemu.1 $(DESTDIR)$(mandir)/man1
+	install -m 644 quickemu_conf.1 $(DESTDIR)$(mandir)/man1
+
+#   install -m 644 quickgui.1 $(DESTDIR)$(mandir)/man1
+
+install_bins:
+	install -d $(DESTDIR)$(bindir)
+	install -m 755 ../quickget $(DESTDIR)$(bindir)
+	install -m 755 ../quickemu $(DESTDIR)$(bindir)
+	install -m 755 ../macrecovery $(DESTDIR)$(bindir)
+
+install: install_bins  install_docs
+
+uninstall::
+	rm -f $(DESTDIR)$(mandir)/man1/quickget.1
+	rm -f $(DESTDIR)$(mandir)/man1/quickemu.1
+	rm -f $(DESTDIR)$(mandir)/man1/quickemu_conf.1
+	rm -f $(DESTDIR)$(bindir)/quickget
+	rm -f $(DESTDIR)$(bindir)/quickemu
+	rm -f $(DESTDIR)$(bindir)/macrecovery
+
+
+.PHONY: all

docs/pandoc-man.mk

@@ -0,0 +1,8 @@
+PANDOC ?= pandoc
+
+MANSECTION ?= 1
+
+MANPAGE.md = $(PANDOC) --standalone $(PANDOCFLAGS) --to man
+
+%.$(MANSECTION): %.$(MANSECTION).md
+	$(MANPAGE.md) $< -o $@

docs/quickemu.1

@@ -0,0 +1,950 @@
+.\" Automatically generated by Pandoc 3.1.1
+.\"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
+.TH "QUICKEMU" "1" "June 14, 2023" "quickemu" "Quickemu User Manual"
+.hy
+.SH NAME
+.PP
+quickemu - A quick VM builder and manager
+.SH SYNOPSIS
+.PP
+\f[B]quickemu\f[R] [\f[I]OPTION\f[R]]\&...
+.SH DESCRIPTION
+.PP
+\f[B]quickemu\f[R] will create and run highly optimised desktop virtual
+machines for Linux, macOS and Windows
+.SH OPTIONS
+.TP
+\f[B]\[en]vm\f[R]
+vm configuration file
+.PP
+You can also pass optional parameters
+.TP
+\f[B]\[en]braille\f[R]
+Enable braille support.
+Requires SDL.
+.TP
+\f[B]\[en]delete\f[R]
+Delete the disk image.
+.TP
+\f[B]\[en]display\f[R]
+Select display backend.
+`sdl' (default), `gtk', `none' or `spice'
+.TP
+\f[B]\[en]fullscreen\f[R]
+Starts VM in full screen mode (Ctl+Alt+f to exit)
+.TP
+\f[B]\[en]ignore-msrs-always\f[R]
+Configure KVM to always ignore unhandled machine-specific registers
+.TP
+\f[B]\[en]screen <screen>\f[R]
+Use specified screen to determine the window size.
+.TP
+\f[B]\[en]shortcut\f[R]
+Create a desktop shortcut
+.TP
+\f[B]\[en]snapshot apply <tag>\f[R]
+Apply/restore a snapshot.
+.TP
+\f[B]\[en]snapshot create <tag>\f[R]
+Create a snapshot.
+.TP
+\f[B]\[en]snapshot delete <tag>\f[R]
+Delete a snapshot.
+.TP
+\f[B]\[en]snapshot info\f[R]
+Show disk/snapshot info.
+.TP
+\f[B]\[en]status-quo\f[R]
+Do not commit any changes to disk/snapshot.
+.TP
+\f[B]\[en]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]
+.SS Introduction
+.PP
+Quickly create and run highly optimised desktop virtual machines for
+Linux, macOS and Windows; with just two commands.
+You decide what operating system you want to run and Quickemu will
+figure out the best way to do it for you.
+For example:
+.IP
+.nf
+\f[C]
+quickget ubuntu-mate 22.04
+quickemu --vm ubuntu-mate-22.04.conf
+\f[R]
+.fi
+.PP
+The original objective of the project was to enable quick testing of
+Linux distributions where the virtual machine configurations can be
+stored anywhere, such as external USB storage or your home directory,
+and no elevated permissions are required to run the virtual machines.
+\f[B]Quickemu now also includes comprehensive support for macOS and
+Windows\f[R].
+.SS Features
+.IP \[bu] 2
+\f[B]macOS\f[R] Monterey, Big Sur, Catalina, Mojave & High Sierra
+.IP \[bu] 2
+\f[B]Windows\f[R] 10 and 11 including TPM 2.0
+.IP \[bu] 2
+Ubuntu (https://ubuntu.com/desktop) and all the \f[B]official Ubuntu
+flavours (https://ubuntu.com/download/flavours)\f[R]
+.IP \[bu] 2
+\f[B]Over 360 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
+QEMU Guest Agent support (https://wiki.qemu.org/Features/GuestAgent);
+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[VI]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
+.IP \[bu] 2
+Graphical user interfaces available
+.PP
+Quickemu is a wrapper for the excellent QEMU (https://www.qemu.org/)
+that attempts to automatically \f[I]\[lq]do the right thing\[rq]\f[R],
+rather than expose exhaustive configuration options.
+.PP
+We have a Discord for this project:
+[IMAGE: Discord (https://img.shields.io/discord/712850672223125565?color=0C306A&label=WimpysWorld%20Discord&logo=Discord&logoColor=ffffff&style=flat-square)] (https://discord.gg/sNmz3uw)
+.PP
+See this (old) video where I explain some of my motivations for creating
+Quickemu.
+.PP
+[IMAGE: Replace VirtualBox with Bash &
+QEMU (https://img.youtube.com/vi/AOTYWEgw0hI/0.jpg)] (https://www.youtube.com/watch?v=AOTYWEgw0hI)
+.SS Requirements
+.IP \[bu] 2
+QEMU (https://www.qemu.org/) (\f[I]6.0.0 or newer\f[R]) \f[B]with GTK,
+SDL, SPICE & VirtFS support\f[R]
+.IP \[bu] 2
+bash (https://www.gnu.org/software/bash/) (\f[I]4.0 or newer\f[R])
+.IP \[bu] 2
+Coreutils (https://www.gnu.org/software/coreutils/)
+.IP \[bu] 2
+EDK II (https://github.com/tianocore/edk2)
+.IP \[bu] 2
+grep (https://www.gnu.org/software/grep/)
+.IP \[bu] 2
+jq (https://stedolan.github.io/jq/)
+.IP \[bu] 2
+LSB (https://wiki.linuxfoundation.org/lsb/start)
+.IP \[bu] 2
+procps (https://gitlab.com/procps-ng/procps)
+.IP \[bu] 2
+python3 (https://www.python.org/)
+.IP \[bu] 2
+macrecovery (https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macrecovery)
+.IP \[bu] 2
+mkisofs (http://cdrtools.sourceforge.net/private/cdrecord.html)
+.IP \[bu] 2
+usbutils (https://github.com/gregkh/usbutils)
+.IP \[bu] 2
+util-linux (https://github.com/karelzak/util-linux)
+.IP \[bu] 2
+sed (https://www.gnu.org/software/sed/)
+.IP \[bu] 2
+socat (http://www.dest-unreach.org/socat/)
+.IP \[bu] 2
+spicy (https://gitlab.freedesktop.org/spice/spice-gtk)
+.IP \[bu] 2
+swtpm (https://github.com/stefanberger/swtpm)
+.IP \[bu] 2
+Wget (https://www.gnu.org/software/wget/)
+.IP \[bu] 2
+xdg-user-dirs (https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)
+.IP \[bu] 2
+xrandr (https://gitlab.freedesktop.org/xorg/app/xrandr)
+.IP \[bu] 2
+zsync (http://zsync.moria.org.uk/)
+.IP \[bu] 2
+unzip (http://www.info-zip.org/UnZip.html)
+.SS Installing Requirements
+.PP
+For Ubuntu, Arch and nixos systems the
+ppa (https://launchpad.net/~flexiondotorg/+archive/ubuntu/quickemu),
+AUR (https://aur.archlinux.org/packages/quickemu) or
+nix (https://github.com/NixOS/nixpkgs/tree/master/pkgs/development/quickemu)
+packaging will take care of the dependencies.
+For 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
+.PP
+Debian (and direct derivatives such as MX Linux):
+.IP
+.nf
+\f[C]
+sudo apt install qemu bash coreutils ovmf grep jq lsb-base procps python3 genisoimage usbutils util-linux sed spice-client-gtk libtss2-tcti-swtpm0 wget xdg-user-dirs zsync unzip
+\f[R]
+.fi
+.PP
+Fedora:
+.IP
+.nf
+\f[C]
+sudo dnf install qemu bash coreutils edk2-tools grep jq lsb procps python3 genisoimage usbutils util-linux sed spice-gtk-tools swtpm wget xdg-user-dirs xrandr unzip
+\f[R]
+.fi
+.PP
+MacOS:
+.PP
+This is a work in progress (see issue
+248 (https://github.com/quickemu-project/quickemu/issues/248) for other
+steps and changes that may enable running on MacOS)
+.IP
+.nf
+\f[C]
+brew install qemu bash coreutils grep jq python\[at]3.10 cdrtools gnu-sed spice-gtk wget zsync
+\f[R]
+.fi
+.SH Usage
+.SS Graphical User Interfaces
+.PP
+While \f[V]quickemu\f[R] and \f[V]quickget\f[R] are designed for the
+terminal, a graphical user interface is also available:
+.IP \[bu] 2
+\f[B]Quickgui (https://github.com/quickgui/quickgui)\f[R] by Mark
+Johnson (https://github.com/marxjohnson) and Yannick
+Mauray (https://github.com/ymauray).
+.PP
+Many thanks to Luke Wesley-Holley (https://github.com/Lukewh) and
+Philipp Kiemle (https://github.com/daPhipz) for creating the
+\f[B]Quickemu icons (https://github.com/Lukewh/quickemu-icons)\f[R] 🎨
+.SS Quickgui for Ubuntu
+.IP
+.nf
+\f[C]
+sudo add-apt-repository ppa:yannick-mauray/quickgui
+sudo apt update
+sudo apt install quickgui
+\f[R]
+.fi
+.SS Ubuntu Guest
+.PP
+\f[V]quickget\f[R] will automatically download an Ubuntu release and
+create the virtual machine configuration.
+.IP
+.nf
+\f[C]
+quickget ubuntu 22.04
+quickemu --vm ubuntu-22.04.conf
+\f[R]
+.fi
+.IP \[bu] 2
+Complete the installation as normal.
+.IP \[bu] 2
+Post-install:
+.RS 2
+.IP \[bu] 2
+Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable
+copy/paste and USB redirection
+.RS 2
+.IP \[bu] 2
+\f[V]sudo apt install spice-vdagent\f[R]
+.RE
+.IP \[bu] 2
+Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to
+enable file sharing.
+.RS 2
+.IP \[bu] 2
+\f[V]sudo apt install spice-webdavd\f[R]
+.RE
+.RE
+.SS Ubuntu devel (daily-live) images
+.PP
+\f[V]quickget\f[R] can also download/refresh devel images via
+\f[V]zsync\f[R] for Ubuntu developers and testers.
+.IP
+.nf
+\f[C]
+quickget ubuntu devel
+quickemu --vm ubuntu-devel.conf
+\f[R]
+.fi
+.PP
+You can run \f[V]quickget ubuntu devel\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
+.PP
+All the official Ubuntu flavours are supported, just replace
+\f[V]ubuntu\f[R] with your preferred flavour.
+.IP \[bu] 2
+\f[V]kubuntu\f[R] (Kubuntu)
+.IP \[bu] 2
+\f[V]lubuntu\f[R] (Lubuntu)
+.IP \[bu] 2
+\f[V]ubuntu-budgie\f[R] (Ubuntu Budgie)
+.IP \[bu] 2
+\f[V]ubuntucinnamon\f[R] (Ubuntu Cinnamon)
+.IP \[bu] 2
+\f[V]ubuntukylin\f[R] (Ubuntu Kylin)
+.IP \[bu] 2
+\f[V]ubuntu-mate\f[R] (Ubuntu MATE)
+.IP \[bu] 2
+\f[V]ubuntu-server\f[R] (Ubuntu Server)
+.IP \[bu] 2
+\f[V]ubuntustudio\f[R] (Ubuntu Studio)
+.IP \[bu] 2
+\f[V]ubuntu\f[R] (Ubuntu)
+.IP \[bu] 2
+\f[V]ubuntu-unity\f[R] (Ubuntu Unity)
+.IP \[bu] 2
+\f[V]xubuntu\f[R] (Xubuntu)
+.SS Other Operating Systems
+.PP
+\f[V]quickget\f[R] also supports:
+.IP \[bu] 2
+\f[V]alma\f[R] (Alma Linux)
+.IP \[bu] 2
+\f[V]alpine\f[R] (Alpine Linux)
+.IP \[bu] 2
+\f[V]android\f[R] (Android x86)
+.IP \[bu] 2
+\f[V]archcraft\f[R] (Archcraft)
+.IP \[bu] 2
+\f[V]archlinux\f[R] (Arch Linux)
+.IP \[bu] 2
+\f[V]arcolinux\f[R] (Arco Linux)
+.IP \[bu] 2
+\f[V]batocera\f[R] (Batocera)
+.IP \[bu] 2
+\f[V]blendos\f[R] (BlendOS)
+.IP \[bu] 2
+\f[V]cachyos\f[R] (CachyOS)
+.IP \[bu] 2
+\f[V]centos-stream\f[R] (CentOS Stream)
+.IP \[bu] 2
+\f[V]debian\f[R] (Debian)
+.IP \[bu] 2
+\f[V]deepin\f[R] (Deepin)
+.IP \[bu] 2
+\f[V]devuan\f[R] (Devuan)
+.IP \[bu] 2
+\f[V]dragonflybsd\f[R] (DragonFlyBSD)
+.IP \[bu] 2
+\f[V]elementary\f[R] (elementary OS)
+.IP \[bu] 2
+\f[V]endeavouros\f[R] (EndeavourOS)
+.IP \[bu] 2
+\f[V]endless\f[R] (Endless OS)
+.IP \[bu] 2
+\f[V]fedora\f[R] (Fedora)
+.IP \[bu] 2
+\f[V]freebsd\f[R] (FreeBSD)
+.IP \[bu] 2
+\f[V]freedos\f[R] (FreeDOS)
+.IP \[bu] 2
+\f[V]gentoo\f[R] (Gentoo)
+.IP \[bu] 2
+\f[V]ghostbsd\f[R] (GhostBSD)
+.IP \[bu] 2
+\f[V]haiku\f[R] (Haiku)
+.IP \[bu] 2
+\f[V]holoiso\f[R] (HoloISO)
+.IP \[bu] 2
+\f[V]kali\f[R] (Kali)
+.IP \[bu] 2
+\f[V]kdeneon\f[R] (KDE Neon)
+.IP \[bu] 2
+\f[V]kolibrios\f[R] (KolibriOS)
+.IP \[bu] 2
+\f[V]linuxmint\f[R] (Linux Mint)
+.IP \[bu] 2
+\f[V]lmde\f[R] (Linux Mint Debian Edition)
+.IP \[bu] 2
+\f[V]mageia\f[R] (Mageia)
+.IP \[bu] 2
+\f[V]manjaro\f[R] (Manjaro)
+.IP \[bu] 2
+\f[V]mxlinux\f[R] (MX Linux)
+.IP \[bu] 2
+\f[V]netboot\f[R] (netboot.xyz)
+.IP \[bu] 2
+\f[V]netbsd\f[R] (NetBSD)
+.IP \[bu] 2
+\f[V]nixos\f[R] (NixOS)
+.IP \[bu] 2
+\f[V]openbsd\f[R] (OpenBSD)
+.IP \[bu] 2
+\f[V]openindiana\f[R] (OpenIndiana)
+.IP \[bu] 2
+\f[V]opensuse\f[R] (openSUSE)
+.IP \[bu] 2
+\f[V]oraclelinux\f[R] (Oracle Linux)
+.IP \[bu] 2
+\f[V]popos\f[R] (Pop!_OS)
+.IP \[bu] 2
+\f[V]reactos\f[R] (ReactOS)
+.IP \[bu] 2
+\f[V]rebornos\f[R] (RebornOS)
+.IP \[bu] 2
+\f[V]rockylinux\f[R] (Rocky Linux)
+.IP \[bu] 2
+\f[V]siduction\f[R] (Siduction)
+.IP \[bu] 2
+\f[V]slackware\f[R] (Slackware)
+.IP \[bu] 2
+\f[V]solus\f[R] (Solus)
+.IP \[bu] 2
+\f[V]tails\f[R] (Tails)
+.IP \[bu] 2
+\f[V]truenas-core\f[R] (TrueNAS Core)
+.IP \[bu] 2
+\f[V]truenas-scale\f[R] (TrueNAS Scale)
+.IP \[bu] 2
+\f[V]vanillaos\f[R] (Vanilla OS)
+.IP \[bu] 2
+\f[V]void\f[R] (Void Linux)
+.IP \[bu] 2
+\f[V]vxlinux\f[R] (VX Linux)
+.IP \[bu] 2
+\f[V]xerolinux\f[R] (XeroLinux)
+.IP \[bu] 2
+\f[V]zorin\f[R] (Zorin OS)
+.PP
+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[V]debian-bullseye.conf\f[R]
+.IP
+.nf
+\f[C]
+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]
+\f[R]
+.fi
+.IP \[bu] 2
+Use \f[V]quickemu\f[R] to start the virtual machine:
+.IP
+.nf
+\f[C]
+quickemu --vm debian-bullseye.conf
+\f[R]
+.fi
+.IP \[bu] 2
+Complete the installation as normal.
+.IP \[bu] 2
+Post-install:
+.RS 2
+.IP \[bu] 2
+Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable
+copy/paste and USB redirection.
+.IP \[bu] 2
+Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to
+enable file sharing.
+.RE
+.SS macOS Guest
+.PP
+\f[V]quickget\f[R] automatically downloads a macOS recovery image and
+creates a virtual machine configuration.
+.IP
+.nf
+\f[C]
+quickget macos catalina
+quickemu --vm macos-catalina.conf
+\f[R]
+.fi
+.PP
+macOS \f[V]high-sierra\f[R], \f[V]mojave\f[R], \f[V]catalina\f[R],
+\f[V]big-sur\f[R] and \f[V]monterey\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[V]QEMU HARDDISK Media\f[R] (\[ti]103.08GB) from the list (on
+Big Sur and above use \f[V]Apple Inc. VirtIO Block Device\f[R]) and
+click \f[B]Erase\f[R].
+.IP \[bu] 2
+Enter a \f[V]Name:\f[R] for the disk
+.IP \[bu] 2
+If you are installing macOS Mojave or later (Catalina, Big Sur, and
+Monterey), 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
+.nf
+\f[C]
+sudo trimforce enable
+\f[R]
+.fi
+.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.
+If you press enter without first typing y the system will consider that
+a negative response as though you said \[lq]no\[rq]:
+.IP
+.nf
+\f[C]
+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)?
+\f[R]
+.fi
+.PP
+And a second confirmation once you\[cq]ve confirmed the previous one:
+.IP
+.nf
+\f[C]
+Your system will immediately reboot when this is complete.
+Is this OK (y/N)?
+\f[R]
+.fi
+.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
+.nf
+\f[C]
+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]
+\f[R]
+.fi
+.IP \[bu] 2
+\f[V]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
+macOS.
+.IP \[bu] 2
+\f[V]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
+.SS macOS compatibility
+.PP
+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
+.RE
+.IP \[bu] 2
+\f[V]quickemu\f[R] will automatically download the required
+OpenCore (https://github.com/acidanthera/OpenCorePkg) bootloader and
+OVMF firmware from OSX-KVM (https://github.com/kholia/OSX-KVM).
+.IP \[bu] 2
+Optimised by default, but no GPU acceleration is available.
+.RS 2
+.IP \[bu] 2
+Host CPU vendor is detected and guest CPU is optimised accordingly.
+.IP \[bu] 2
+VirtIO Block
+Media (https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is used
+for the system disk where supported.
+.IP \[bu] 2
+VirtIO \f[V]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used for
+the mouse.
+.IP \[bu] 2
+VirtIO Network (\f[V]virtio-net\f[R]) is supported and enabled on macOS
+Big Sur and newer but previous releases use \f[V]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 VoodooHDA
+OC (https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB
+audio-device to the macOS guest VM\f[R].
+.IP \[bu] 2
+NOTE!
+Gatekeeper (https://disable-gatekeeper.github.io/) and System Integrity
+Protection
+(SIP) (https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection)
+need to be disabled to install VoodooHDA OC
+.IP \[bu] 2
+File sharing between guest and host is available via
+virtio-9p (https://wiki.qemu.org/Documentation/9psetup) and SPICE
+webdavd (https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24).
+.IP \[bu] 2
+Copy/paste via SPICE agent is \f[B]not available on macOS\f[R].
+.SS macOS App Store
+.PP
+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[V]en0\f[R].
+Use \f[V]ifconfig\f[R] in a terminal to verify this.
+.PP
+If the wired ethernet device is not \f[V]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
+.nf
+\f[C]
+sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
+\f[R]
+.fi
+.PP
+Now reboot, and the App Store should work.
+.SS Windows 10 & 11 Guests
+.PP
+\f[V]quickget\f[R] can download
+Windows10 (https://www.microsoft.com/software-download/windows10) and
+Windows 11 (https://www.microsoft.com/software-download/windows11)
+automatically and create an optimised virtual machine configuration.
+This configuration also includes the VirtIO drivers for
+Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/).
+.IP
+.nf
+\f[C]
+quickget windows 11
+quickemu --vm windows-11-22H2.conf
+\f[R]
+.fi
+.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 adminstrator user account is automatically created, with these
+credentials:
+.RS 2
+.IP \[bu] 2
+Username: \f[V]Quickemu\f[R]
+.IP \[bu] 2
+Password: \f[V]quickemu\f[R]
+.RE
+.PP
+The default Windows 11 configuration looks like this:
+.IP
+.nf
+\f[C]
+guest_os=\[dq]windows\[dq]
+disk_img=\[dq]windows-11/disk.qcow2\[dq]
+iso=\[dq]windows-11/windows-11.iso\[dq]
+fixed_iso=\[dq]windows-11/virtio-win.iso\[dq]
+tpm=\[dq]on\[dq]
+secureboot=\[dq]on\[dq]
+\f[R]
+.fi
+.IP \[bu] 2
+\f[V]guest_os=\[dq]windows\[dq]\f[R] instructs \f[V]quickemu\f[R] to
+optimise for Windows.
+.IP \[bu] 2
+\f[V]fixed_iso=\f[R] specifies the ISO image that provides VirtIO
+drivers.
+.IP \[bu] 2
+\f[V]tpm=\[dq]on\[dq]\f[R] instructs \f[V]quickemu\f[R] to create a
+software emulated TPM device using \f[V]swtpm\f[R].
+.SH All the options
+.PP
+Here are the usage instructions:
+.IP
+.nf
+\f[C]
+Usage
+  quickemu --vm ubuntu.conf
+
+You can also pass optional parameters
+  --braille                         : Enable braille support. Requires SDL.
+  --delete-disk                     : Delete the disk image and EFI variables
+  --delete-vm                       : Delete the entire VM and it\[aq]s configuration
+  --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
+  --screen <screen>                 : Use specified screen to determine the window size.
+  --screenpct <percent>             : Percent of fullscreen for VM if --fullscreen is not specified.
+  --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]
+  --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]
+  --extra_args <arguments>          : Pass additional arguments to qemu
+  --version                         : Print version
+\f[R]
+.fi
+.SS Desktop shortcuts
+.PP
+Desktop shortcuts can be created for a VM, the shortcuts are saved in
+\f[V]\[ti]/.local/share/applications\f[R].
+Here is an example of how to create a shortcut.
+.IP
+.nf
+\f[C]
+quickemu --vm ubuntu-22.04-desktop.conf --shortcut
+\f[R]
+.fi
+.SS Screen and window size (Linux guests only)
+.PP
+\f[V]qemu\f[R] will always default to the primary monitor to display the
+VM\[cq]s window.
+.PP
+Without the \f[V]--screen\f[R] option, \f[V]quickemu\f[R] will look for
+the size of the smallest monitor, and use a size that fits on said
+monitor.
+.PP
+The \f[V]--screen\f[R] option forces \f[V]quickemu\f[R] to use the size
+of the given monitor to compute the size of the window.
+\f[B]It won\[cq]t use that monitor to display the VM\[cq]s window if
+it\[cq]s not the primary monitor\f[R].
+This is useful if the primary monitor if not the smallest one, and if
+the VM\[cq]s window doesn\[cq]t need to be moved around.
+.PP
+The \f[V]--screen\f[R] option is also useful with the
+\f[V]--fullscreen\f[R] option, again because \f[V]qemu\f[R] will always
+use the primary monitor.
+In order for the fullscreen mode to work properly, the resolution of the
+VM\[cq]s window must match the resolution of the screen.
+.PP
+To know which screen to use, type:
+.IP
+.nf
+\f[C]
+xrandr --listmonitors | grep -v Monitors
+\f[R]
+.fi
+.PP
+The command will output something like this:
+.IP
+.nf
+\f[C]
+ 0: +*HDMI-0 2560/597x1440/336+1920+0  HDMI-0
+ 1: +DVI-D-0 1920/527x1080/296+0+0  DVI-D-0
+\f[R]
+.fi
+.PP
+The first number is what needs to be passed to the \f[V]--screen\f[R]
+option.
+.PP
+For example:
+.IP
+.nf
+\f[C]
+quickemu --vm vm.conf --screen 0
+\f[R]
+.fi
+.PP
+The above uses the 2560x1440 screen to compute the size of the window,
+which Quickemu sizes to 2048x1152.
+Without the \f[V]--screen\f[R] option, Quickemu would have used the
+1920x1080 monitor which results in a window size of 1664x936.
+.PP
+The `\[en]screenpct' is an optional interger value between 25 <= pct <
+100 which will override system default screen sizes.
+The VM size will be `pct' of the chosen screen.
+\f[B]If \[en]fullscreen is chosen screen will be fullsize instead of
+being scaled down by \[en]screenpct value.\f[R]
+.SH References
+.PP
+Useful reference that assisted the development of Quickemu.
+.IP \[bu] 2
+General
+.RS 2
+.IP \[bu] 2
+QEMU\[cq]s documentation! (https://qemu.readthedocs.io/en/latest/)
+.IP \[bu] 2
+<https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines>
+.IP \[bu] 2
+<https://www.kraxel.org/blog/2020/01/qemu-sound-audiodev/>
+.RE
+.IP \[bu] 2
+macOS
+.RS 2
+.IP \[bu] 2
+<https://www.nicksherlock.com/2020/06/installing-macos-big-sur-on-proxmox/>
+.IP \[bu] 2
+<https://passthroughpo.st/mac-os-adds-early-support-for-virtio-qemu/>
+.IP \[bu] 2
+<https://github.com/kholia/OSX-KVM>
+.IP \[bu] 2
+<https://github.com/thenickdude/KVM-Opencore>
+.IP \[bu] 2
+<https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macrecovery>
+.IP \[bu] 2
+<https://www.kraxel.org/blog/2017/09/running-macos-as-guest-in-kvm/>
+.IP \[bu] 2
+<https://www.nicksherlock.com/2017/10/passthrough-of-advanced-cpu-features-for-macos-high-sierra-guests/>
+.IP \[bu] 2
+<http://philjordan.eu/osx-virt/>
+.IP \[bu] 2
+<https://github.com/Dids/clover-builder>
+.IP \[bu] 2
+OpenCore Configurator (https://mackie100projects.altervista.org)
+.RE
+.IP \[bu] 2
+Windows
+.RS 2
+.IP \[bu] 2
+<https://www.heiko-sieger.info/running-windows-10-on-linux-using-kvm-with-vga-passthrough/>
+.IP \[bu] 2
+<https://leduccc.medium.com/improving-the-performance-of-a-windows-10-guest-on-qemu-a5b3f54d9cf5>
+.IP \[bu] 2
+<https://frontpagelinux.com/tutorials/how-to-use-linux-kvm-to-optimize-your-windows-10-virtual-machine/>
+.IP \[bu] 2
+<https://turlucode.com/qemu-command-line-args/>
+.IP \[bu] 2
+<https://github.com/pbatard/Fido>
+.IP \[bu] 2
+<https://www.catapultsystems.com/blogs/create-zero-touch-windows-10-iso/>
+.RE
+.IP \[bu] 2
+TPM
+.RS 2
+.IP \[bu] 2
+<https://qemu-project.gitlab.io/qemu/specs/tpm.html>
+.IP \[bu] 2
+<https://www.tecklyfe.com/how-to-create-a-windows-11-virtual-machine-in-qemu/>
+.RE
+.IP \[bu] 2
+9p & virtiofs
+.RS 2
+.IP \[bu] 2
+<https://wiki.qemu.org/Documentation/9p>
+.IP \[bu] 2
+<https://wiki.qemu.org/Documentation/9psetup>
+.IP \[bu] 2
+<https://www.kraxel.org/blog/2019/06/macos-qemu-guest/>
+.IP \[bu] 2
+<https://superuser.com/questions/628169/how-to-share-a-directory-with-the-host-without-networking-in-qemu>
+.IP \[bu] 2
+<https://virtio-fs.gitlab.io/>
+.RE
+.SH AUTHORS
+.PP
+Written by Martin Wimpress.
+.SH BUGS
+.PP
+Submit bug reports online at:
+<https://github.com/quickemu-project/quickemu/issues>
+.SH SEE ALSO
+.PP
+Full sources at: <https://github.com/quickemu-project/quickemu>
+.PP
+quickemu_conf(1), quickget(1), quickgui(1)
+.SH AUTHORS
+Martin Wimpress.

docs/quickemu.1.md

@@ -0,0 +1,681 @@
+---
+author: Martin Wimpress
+date: June 14, 2023
+footer: quickemu
+header: Quickemu User Manual
+section: 1
+title: QUICKEMU
+---
+
+# NAME
+
+quickemu - A quick VM builder and manager
+
+# SYNOPSIS
+
+**quickemu** \[*OPTION*\]...
+
+# DESCRIPTION
+
+**quickemu** will create and run highly optimised desktop virtual
+machines for Linux, macOS and Windows
+
+# OPTIONS
+
+**--vm**
+:   vm configuration file
+
+You can also pass optional parameters
+
+**--braille**
+:   Enable braille support. Requires SDL.
+
+**--delete**
+:   Delete the disk image.
+
+**--display**
+:   Select display backend. 'sdl' (default), 'gtk', 'none' or 'spice'
+
+**--fullscreen**
+:   Starts VM in full screen mode (Ctl+Alt+f to exit)
+
+**--ignore-msrs-always**
+:   Configure KVM to always ignore unhandled machine-specific registers
+
+**--screen \<screen\>**
+:   Use specified screen to determine the window size.
+
+**--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.
+
+**--version**
+:   Print version
+
+# EXAMPLES
+
+**quickemu --vm ubuntu-mate-22.04.conf**
+:   Launches the VM specified in the file *ubuntu-mate-22.04.conf*
+
+## Introduction
+
+Quickly create and run highly optimised desktop virtual machines for
+Linux, macOS and Windows; with just two commands. You decide what
+operating system you want to run and Quickemu will figure out the best
+way to do it for you. For example:
+
+``` bash
+quickget ubuntu-mate 22.04
+quickemu --vm ubuntu-mate-22.04.conf
+```
+
+The original objective of the project was to enable quick testing of
+Linux distributions where the virtual machine configurations can be
+stored anywhere, such as external USB storage or your home directory,
+and no elevated permissions are required to run the virtual machines.
+**Quickemu now also includes comprehensive support for macOS and
+Windows**.
+
+## Features
+
+-   **macOS** Monterey, Big Sur, Catalina, Mojave & High Sierra
+-   **Windows** 10 and 11 including TPM 2.0
+-   [Ubuntu](https://ubuntu.com/desktop) and all the **[official Ubuntu
+    flavours](https://ubuntu.com/download/flavours)**
+-   **Over 360 operating system editions are supported!**
+-   Full SPICE support including host/guest clipboard sharing
+-   VirtIO-webdavd file sharing for Linux and Windows guests
+-   VirtIO-9p file sharing for Linux and macOS guests
+-   [QEMU Guest Agent
+    support](https://wiki.qemu.org/Features/GuestAgent); provides access
+    to a system-level agent via standard QMP commands
+-   Samba file sharing for Linux, macOS and Windows guests (*if `smbd`
+    is installed on the host*)
+-   VirGL acceleration
+-   USB device pass-through
+-   Smartcard pass-through
+-   Automatic SSH port forwarding to guests
+-   Network port forwarding
+-   Full duplex audio
+-   Braille support
+-   EFI (with or without SecureBoot) and Legacy BIOS boot
+-   Graphical user interfaces available
+
+Quickemu is a wrapper for the excellent [QEMU](https://www.qemu.org/)
+that attempts to automatically *"do the right thing"*, rather than
+expose exhaustive configuration options.
+
+We have a Discord for this project:
+[![Discord](https://img.shields.io/discord/712850672223125565?color=0C306A&label=WimpysWorld%20Discord&logo=Discord&logoColor=ffffff&style=flat-square)](https://discord.gg/sNmz3uw)
+
+See this (old) video where I explain some of my motivations for creating
+Quickemu.
+
+[![Replace VirtualBox with Bash &
+QEMU](https://img.youtube.com/vi/AOTYWEgw0hI/0.jpg)](https://www.youtube.com/watch?v=AOTYWEgw0hI)
+
+## Requirements
+
+-   [QEMU](https://www.qemu.org/) (*6.0.0 or newer*) **with GTK, SDL,
+    SPICE & VirtFS support**
+-   [bash](https://www.gnu.org/software/bash/) (*4.0 or newer*)
+-   [Coreutils](https://www.gnu.org/software/coreutils/)
+-   [EDK II](https://github.com/tianocore/edk2)
+-   [grep](https://www.gnu.org/software/grep/)
+-   [jq](https://stedolan.github.io/jq/)
+-   [LSB](https://wiki.linuxfoundation.org/lsb/start)
+-   [procps](https://gitlab.com/procps-ng/procps)
+-   [python3](https://www.python.org/)
+-   [macrecovery](https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macrecovery)
+-   [mkisofs](http://cdrtools.sourceforge.net/private/cdrecord.html)
+-   [usbutils](https://github.com/gregkh/usbutils)
+-   [util-linux](https://github.com/karelzak/util-linux)
+-   [sed](https://www.gnu.org/software/sed/)
+-   [socat](http://www.dest-unreach.org/socat/)
+-   [spicy](https://gitlab.freedesktop.org/spice/spice-gtk)
+-   [swtpm](https://github.com/stefanberger/swtpm)
+-   [Wget](https://www.gnu.org/software/wget/)
+-   [xdg-user-dirs](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)
+-   [xrandr](https://gitlab.freedesktop.org/xorg/app/xrandr)
+-   [zsync](http://zsync.moria.org.uk/)
+-   [unzip](http://www.info-zip.org/UnZip.html)
+
+### Installing Requirements
+
+For Ubuntu, Arch and nixos systems the
+[ppa](https://launchpad.net/~flexiondotorg/+archive/ubuntu/quickemu),
+[AUR](https://aur.archlinux.org/packages/quickemu) or
+[nix](https://github.com/NixOS/nixpkgs/tree/master/pkgs/development/quickemu)
+packaging will take care of the dependencies. For other host
+distributions or operating systems it will be necessary to install the
+above requirements or their equivalents.
+
+These examples may save a little typing
+
+Debian (and direct derivatives such as MX Linux):
+
+    sudo apt install qemu bash coreutils ovmf grep jq lsb-base procps python3 genisoimage usbutils util-linux sed spice-client-gtk libtss2-tcti-swtpm0 wget xdg-user-dirs zsync unzip
+
+Fedora:
+
+    sudo dnf install qemu bash coreutils edk2-tools grep jq lsb procps python3 genisoimage usbutils util-linux sed spice-gtk-tools swtpm wget xdg-user-dirs xrandr unzip
+
+MacOS:
+
+This is a work in progress (see [issue
+248](https://github.com/quickemu-project/quickemu/issues/248) for other
+steps and changes that may enable running on MacOS)
+
+    brew install qemu bash coreutils grep jq python@3.10 cdrtools gnu-sed spice-gtk wget zsync
+
+# Usage
+
+## Graphical User Interfaces
+
+While `quickemu` and `quickget` are designed for the terminal, a
+graphical user interface is also available:
+
+-   **[Quickgui](https://github.com/quickgui/quickgui)** by [Mark
+    Johnson](https://github.com/marxjohnson) and [Yannick
+    Mauray](https://github.com/ymauray).
+
+Many thanks to [Luke Wesley-Holley](https://github.com/Lukewh) and
+[Philipp Kiemle](https://github.com/daPhipz) for creating the
+**[Quickemu icons](https://github.com/Lukewh/quickemu-icons)** 🎨
+
+### Quickgui for Ubuntu
+
+``` bash
+sudo add-apt-repository ppa:yannick-mauray/quickgui
+sudo apt update
+sudo apt install quickgui
+```
+
+## Ubuntu Guest
+
+`quickget` will automatically download an Ubuntu release and create the
+virtual machine configuration.
+
+``` bash
+quickget ubuntu 22.04
+quickemu --vm ubuntu-22.04.conf
+```
+
+-   Complete the installation as normal.
+-   Post-install:
+    -   Install the SPICE agent (`spice-vdagent`) in the guest to enable
+        copy/paste and USB redirection
+        -   `sudo apt install spice-vdagent`
+    -   Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to
+        enable file sharing.
+        -   `sudo apt install spice-webdavd`
+
+### Ubuntu devel (daily-live) images
+
+`quickget` can also download/refresh devel images via `zsync` for Ubuntu
+developers and testers.
+
+``` bash
+quickget ubuntu devel
+quickemu --vm ubuntu-devel.conf
+```
+
+You can run `quickget ubuntu devel` to refresh your daily development
+image as often as you like, it will even automatically switch to a new
+series.
+
+### Ubuntu Flavours
+
+All the official Ubuntu flavours are supported, just replace `ubuntu`
+with your preferred flavour.
+
+-   `kubuntu` (Kubuntu)
+-   `lubuntu` (Lubuntu)
+-   `ubuntu-budgie` (Ubuntu Budgie)
+-   `ubuntucinnamon` (Ubuntu Cinnamon)
+-   `ubuntukylin` (Ubuntu Kylin)
+-   `ubuntu-mate` (Ubuntu MATE)
+-   `ubuntu-server` (Ubuntu Server)
+-   `ubuntustudio` (Ubuntu Studio)
+-   `ubuntu` (Ubuntu)
+-   `ubuntu-unity` (Ubuntu Unity)
+-   `xubuntu` (Xubuntu)
+
+## Other Operating Systems
+
+`quickget` also supports:
+
+-   `alma` (Alma Linux)
+-   `alpine` (Alpine Linux)
+-   `android` (Android x86)
+-   `archcraft` (Archcraft)
+-   `archlinux` (Arch Linux)
+-   `arcolinux` (Arco Linux)
+-   `batocera` (Batocera)
+-   `blendos` (BlendOS)
+-   `cachyos` (CachyOS)
+-   `centos-stream` (CentOS Stream)
+-   `debian` (Debian)
+-   `deepin` (Deepin)
+-   `devuan` (Devuan)
+-   `dragonflybsd` (DragonFlyBSD)
+-   `elementary` (elementary OS)
+-   `endeavouros` (EndeavourOS)
+-   `endless` (Endless OS)
+-   `fedora` (Fedora)
+-   `freebsd` (FreeBSD)
+-   `freedos` (FreeDOS)
+-   `gentoo` (Gentoo)
+-   `ghostbsd` (GhostBSD)
+-   `haiku` (Haiku)
+-   `holoiso` (HoloISO)
+-   `kali` (Kali)
+-   `kdeneon` (KDE Neon)
+-   `kolibrios` (KolibriOS)
+-   `linuxmint` (Linux Mint)
+-   `lmde` (Linux Mint Debian Edition)
+-   `mageia` (Mageia)
+-   `manjaro` (Manjaro)
+-   `mxlinux` (MX Linux)
+-   `netboot` (netboot.xyz)
+-   `netbsd` (NetBSD)
+-   `nixos` (NixOS)
+-   `openbsd` (OpenBSD)
+-   `openindiana` (OpenIndiana)
+-   `opensuse` (openSUSE)
+-   `oraclelinux` (Oracle Linux)
+-   `popos` (Pop!\_OS)
+-   `reactos` (ReactOS)
+-   `rebornos` (RebornOS)
+-   `rockylinux` (Rocky Linux)
+-   `siduction` (Siduction)
+-   `slackware` (Slackware)
+-   `solus` (Solus)
+-   `tails` (Tails)
+-   `truenas-core` (TrueNAS Core)
+-   `truenas-scale` (TrueNAS Scale)
+-   `vanillaos` (Vanilla OS)
+-   `void` (Void Linux)
+-   `vxlinux` (VX Linux)
+-   `xerolinux` (XeroLinux)
+-   `zorin` (Zorin OS)
+
+Or you can download a Linux image and manually create a VM
+configuration.
+
+-   Download a .iso image of a Linux distribution
+-   Create a VM configuration file; for example `debian-bullseye.conf`
+
+``` bash
+guest_os="linux"
+disk_img="debian-bullseye/disk.qcow2"
+iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso"
+```
+
+-   Use `quickemu` to start the virtual machine:
+
+``` bash
+quickemu --vm debian-bullseye.conf
+```
+
+-   Complete the installation as normal.
+-   Post-install:
+    -   Install the SPICE agent (`spice-vdagent`) in the guest to enable
+        copy/paste and USB redirection.
+    -   Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to
+        enable file sharing.
+
+## macOS Guest
+
+`quickget` automatically downloads a macOS recovery image and creates a
+virtual machine configuration.
+
+``` bash
+quickget macos catalina
+quickemu --vm macos-catalina.conf
+```
+
+macOS `high-sierra`, `mojave`, `catalina`, `big-sur` and `monterey` are
+supported.
+
+-   Use cursor keys and enter key to select the **macOS Base System**
+-   From **macOS Utilities**
+    -   Click **Disk Utility** and **Continue**
+        -   Select `QEMU HARDDISK Media` (\~103.08GB) from the list (on
+            Big Sur and above use `Apple Inc. VirtIO Block Device`) and
+            click **Erase**.
+        -   Enter a `Name:` for the disk
+        -   If you are installing macOS Mojave or later (Catalina, Big
+            Sur, and Monterey), choose any of the APFS options as the
+            filesystem. MacOS Extended may not work.
+    -   Click **Erase**.
+    -   Click **Done**.
+    -   Close Disk Utility
+-   From **macOS Utilities**
+    -   Click **Reinstall macOS** and **Continue**
+-   Complete the installation as you normally would.
+    -   On the first reboot use cursor keys and enter key to select
+        **macOS Installer**
+    -   On the subsequent reboots use cursor keys and enter key to
+        select the disk you named
+-   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
+-   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.
+    -   To enable TRIM, open the Terminal application and type the
+        following command followed by pressing
+        `<kbd>`{=html}enter`</kbd>`{=html} to tell macos to use the TRIM
+        command on the hard disk when files are deleted:
+
+``` bash
+sudo trimforce enable
+```
+
+You will be prompted to enter your account's password to gain the
+privilege needed. Once you've entered your password and pressed
+`<kbd>`{=html}enter`</kbd>`{=html} the command will request confirmation
+in the form of two questions that require you to type
+`<kbd>`{=html}y`</kbd>`{=html} (for a "yes" response) followed by
+`<kbd>`{=html}enter`</kbd>`{=html} to confirm. If you press
+`<kbd>`{=html}enter`</kbd>`{=html} without first typing
+`<kbd>`{=html}y`</kbd>`{=html} the system will consider that a negative
+response as though you said "no":
+
+``` plain
+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 "as is" 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)?
+```
+
+And a second confirmation once you've confirmed the previous one:
+
+``` plain
+Your system will immediately reboot when this is complete.
+Is this OK (y/N)?
+```
+
+As the last message states, your system will automatically reboot as
+soon as the command completes.
+
+The default macOS configuration looks like this:
+
+``` bash
+guest_os="macos"
+img="macos-catalina/RecoveryImage.img"
+disk_img="macos-catalina/disk.qcow2"
+macos_release="catalina"
+```
+
+-   `guest_os="macos"` instructs Quickemu to optimise for macOS.
+-   `macos_release="catalina"` instructs Quickemu to optimise for a
+    particular macOS release.
+    -   For example VirtIO Network and Memory Ballooning are available
+        in Big Sur and newer, but not previous releases.
+    -   And VirtIO Block Media (disks) are supported/stable in Catalina
+        and newer.
+
+### macOS compatibility
+
+There are some considerations when running macOS via Quickemu.
+
+-   Supported macOS releases:
+    -   High Sierra
+    -   Mojave
+    -   Catalina **(Recommended)**
+    -   Big Sur
+    -   Monterey
+-   `quickemu` will automatically download the required
+    [OpenCore](https://github.com/acidanthera/OpenCorePkg) bootloader
+    and OVMF firmware from [OSX-KVM](https://github.com/kholia/OSX-KVM).
+-   Optimised by default, but no GPU acceleration is available.
+    -   Host CPU vendor is detected and guest CPU is optimised
+        accordingly.
+    -   [VirtIO Block
+        Media](https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is
+        used for the system disk where supported.
+    -   [VirtIO `usb-tablet`](http://philjordan.eu/osx-virt/) is used
+        for the mouse.
+    -   VirtIO Network (`virtio-net`) is supported and enabled on macOS
+        Big Sur and newer but previous releases use `vmxnet3`.
+    -   VirtIO Memory Ballooning is supported and enabled on macOS Big
+        Sur and newer but disabled for other support macOS releases.
+-   USB host and SPICE pass-through is:
+    -   UHCI (USB 2.0) on macOS Catalina and earlier.
+    -   XHCI (USB 3.0) on macOS Big Sur and newer.
+-   Display resolution can only be changed via macOS System Preferences.
+-   **Full Duplex audio requires [VoodooHDA
+    OC](https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB
+    audio-device to the macOS guest VM**.
+-   NOTE! [Gatekeeper](https://disable-gatekeeper.github.io/) and
+    [System Integrity Protection
+    (SIP)](https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection)
+    need to be disabled to install VoodooHDA OC
+-   File sharing between guest and host is available via
+    [virtio-9p](https://wiki.qemu.org/Documentation/9psetup) and [SPICE
+    webdavd](https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24).
+-   Copy/paste via SPICE agent is **not available on macOS**.
+
+### macOS App Store
+
+If you see *"Your device or computer could not be verified"* when you
+try to login to the App Store, make sure that your wired ethernet device
+is `en0`. Use `ifconfig` in a terminal to verify this.
+
+If the wired ethernet device is not `en0`, then then go to *System
+Preferences* -\> *Network*, delete all the network devices and apply the
+changes. Next, open a terminal and run the following:
+
+``` bash
+sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
+```
+
+Now reboot, and the App Store should work.
+
+## Windows 10 & 11 Guests
+
+`quickget` can download
+[Windows10](https://www.microsoft.com/software-download/windows10) and
+[Windows 11](https://www.microsoft.com/software-download/windows11)
+automatically and create an optimised virtual machine configuration.
+This configuration also includes the [VirtIO drivers for
+Windows](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/).
+
+``` bash
+quickget windows 11
+quickemu --vm windows-11-22H2.conf
+```
+
+-   Complete the installation as you normally would.
+-   All relevant drivers and services should be installed automatically.
+-   A local adminstrator user account is automatically created, with
+    these credentials:
+    -   Username: `Quickemu`
+    -   Password: `quickemu`
+
+The default Windows 11 configuration looks like this:
+
+``` bash
+guest_os="windows"
+disk_img="windows-11/disk.qcow2"
+iso="windows-11/windows-11.iso"
+fixed_iso="windows-11/virtio-win.iso"
+tpm="on"
+secureboot="on"
+```
+
+-   `guest_os="windows"` instructs `quickemu` to optimise for Windows.
+-   `fixed_iso=` specifies the ISO image that provides VirtIO drivers.
+-   `tpm="on"` instructs `quickemu` to create a software emulated TPM
+    device using `swtpm`.
+
+# All the options
+
+Here are the usage instructions:
+
+
+    Usage
+      quickemu --vm ubuntu.conf
+
+    You can also pass optional parameters
+      --braille                         : Enable braille support. Requires SDL.
+      --delete-disk                     : Delete the disk image and EFI variables
+      --delete-vm                       : Delete the entire VM and it's configuration
+      --display                         : Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or 'spice-app'
+      --fullscreen                      : Starts VM in full screen mode (Ctl+Alt+f to exit)
+      --ignore-msrs-always              : Configure KVM to always ignore unhandled machine-specific registers
+      --screen <screen>                 : Use specified screen to determine the window size.
+      --screenpct <percent>             : Percent of fullscreen for VM if --fullscreen is not specified.
+      --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. @Options: 'spicy' (default), 'remote-viewer', 'none'
+      --ssh-port <port>                 : Set ssh-port manually
+      --spice-port <port>               : Set spice-port manually
+      --public-dir <path>               : expose share directory. @Options: '' (default: xdg-user-dir PUBLICSHARE), '<directory>', 'none'
+      --monitor <type>                  : Set monitor connection type. @Options: 'socket' (default), 'telnet', 'none'
+      --monitor-telnet-host <ip/host>   : Set telnet host for monitor. (default: 'localhost')
+      --monitor-telnet-port <port>      : Set telnet port for monitor. (default: '4440')
+      --monitor-cmd <cmd>               : Send command to monitor if available. (Example: system_powerdown)
+      --serial <type>                   : Set serial connection type. @Options: 'socket' (default), 'telnet', 'none'
+      --serial-telnet-host <ip/host>    : Set telnet host for serial. (default: 'localhost')
+      --serial-telnet-port <port>       : Set telnet port for serial. (default: '6660')
+      --keyboard <type>                 : Set keyboard. @Options: 'usb' (default), 'ps2', 'virtio'
+      --keyboard_layout <layout>        : Set keyboard layout.
+      --mouse <type>                    : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio'
+      --usb-controller <type>           : Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none'
+      --extra_args <arguments>          : Pass additional arguments to qemu
+      --version                         : Print version
+
+## Desktop shortcuts
+
+Desktop shortcuts can be created for a VM, the shortcuts are saved in
+`~/.local/share/applications`. Here is an example of how to create a
+shortcut.
+
+``` bash
+quickemu --vm ubuntu-22.04-desktop.conf --shortcut
+```
+
+## Screen and window size (Linux guests only)
+
+`qemu` will always default to the primary monitor to display the VM's
+window.
+
+Without the `--screen` option, `quickemu` will look for the size of the
+smallest monitor, and use a size that fits on said monitor.
+
+The `--screen` option forces `quickemu` to use the size of the given
+monitor to compute the size of the window. **It won't use that monitor
+to display the VM's window if it's not the primary monitor**. 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 `--screen` option is also useful with the `--fullscreen` option,
+again because `qemu` will always use the primary monitor. In order for
+the fullscreen mode to work properly, the resolution of the VM's window
+must match the resolution of the screen.
+
+To know which screen to use, type:
+
+``` bash
+xrandr --listmonitors | grep -v Monitors
+```
+
+The command will output something like this:
+
+``` bash
+ 0: +*HDMI-0 2560/597x1440/336+1920+0  HDMI-0
+ 1: +DVI-D-0 1920/527x1080/296+0+0  DVI-D-0
+```
+
+The first number is what needs to be passed to the `--screen` option.
+
+For example:
+
+``` bash
+quickemu --vm vm.conf --screen 0
+```
+
+The above uses the 2560x1440 screen to compute the size of the window,
+which Quickemu sizes to 2048x1152. Without the `--screen` option,
+Quickemu would have used the 1920x1080 monitor which results in a window
+size of 1664x936.
+
+The '--screenpct' is an optional interger value between 25 \<= pct \<
+100 which will override system default screen sizes. The VM size will be
+'pct' of the chosen screen. **If --fullscreen is chosen screen will be
+fullsize instead of being scaled down by --screenpct value.**
+
+# References
+
+Useful reference that assisted the development of Quickemu.
+
+-   General
+    -   [QEMU's documentation!](https://qemu.readthedocs.io/en/latest/)
+    -   <https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines>
+    -   <https://www.kraxel.org/blog/2020/01/qemu-sound-audiodev/>
+-   macOS
+    -   <https://www.nicksherlock.com/2020/06/installing-macos-big-sur-on-proxmox/>
+    -   <https://passthroughpo.st/mac-os-adds-early-support-for-virtio-qemu/>
+    -   <https://github.com/kholia/OSX-KVM>
+    -   <https://github.com/thenickdude/KVM-Opencore>
+    -   <https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macrecovery>
+    -   <https://www.kraxel.org/blog/2017/09/running-macos-as-guest-in-kvm/>
+    -   <https://www.nicksherlock.com/2017/10/passthrough-of-advanced-cpu-features-for-macos-high-sierra-guests/>
+    -   <http://philjordan.eu/osx-virt/>
+    -   <https://github.com/Dids/clover-builder>
+    -   [OpenCore
+        Configurator](https://mackie100projects.altervista.org)
+-   Windows
+    -   <https://www.heiko-sieger.info/running-windows-10-on-linux-using-kvm-with-vga-passthrough/>
+    -   <https://leduccc.medium.com/improving-the-performance-of-a-windows-10-guest-on-qemu-a5b3f54d9cf5>
+    -   <https://frontpagelinux.com/tutorials/how-to-use-linux-kvm-to-optimize-your-windows-10-virtual-machine/>
+    -   <https://turlucode.com/qemu-command-line-args/>
+    -   <https://github.com/pbatard/Fido>
+    -   <https://www.catapultsystems.com/blogs/create-zero-touch-windows-10-iso/>
+-   TPM
+    -   <https://qemu-project.gitlab.io/qemu/specs/tpm.html>
+    -   <https://www.tecklyfe.com/how-to-create-a-windows-11-virtual-machine-in-qemu/>
+-   9p & virtiofs
+    -   <https://wiki.qemu.org/Documentation/9p>
+    -   <https://wiki.qemu.org/Documentation/9psetup>
+    -   <https://www.kraxel.org/blog/2019/06/macos-qemu-guest/>
+    -   <https://superuser.com/questions/628169/how-to-share-a-directory-with-the-host-without-networking-in-qemu>
+    -   <https://virtio-fs.gitlab.io/>
+
+# AUTHORS
+
+Written by Martin Wimpress.
+
+# BUGS
+
+Submit bug reports online at:
+<https://github.com/quickemu-project/quickemu/issues>
+
+# SEE ALSO
+
+Full sources at: <https://github.com/quickemu-project/quickemu>
+
+quickemu_conf(1), quickget(1), quickgui(1)

docs/quickemu_conf.1

@@ -0,0 +1,327 @@
+.\" Automatically generated by Pandoc 3.1.1
+.\"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
+.TH "QUICKEMU_CONF" "1" "June 14, 2023" "quickemu_conf" "Quickemu Configuration Manual"
+.hy
+.SH NAME
+.PP
+quickemu_conf - Options and parameters in the quickemu <vm>.conf
+.SH DESCRIPTION
+.PP
+\f[B]quickemu\f[R] will create and run highly optimised desktop virtual
+machines for Linux, macOS and Windows.
+It uses sensible defaults, but many configuration options can be
+overridden in the required configuration file, which will as a minimum
+specify the path to the installation ISO and QEMU disk for the installed
+VM
+.SH OPTIONS
+.PP
+These are the options and defaults for the <vm>.conf file
+.IP
+.nf
+\f[C]
+# Lowercase variables are used in the VM config file only
+boot=\[dq]efi\[dq]
+cpu_cores=\[dq]\[dq]
+disk_img=\[dq]\[dq]
+disk_size=\[dq]\[dq]
+display=\[dq]\[dq]
+extra_args=\[dq]\[dq]
+fixed_iso=\[dq]\[dq]
+floppy=\[dq]\[dq]
+guest_os=\[dq]linux\[dq]
+img=\[dq]\[dq]
+iso=\[dq]\[dq]
+macaddr=\[dq]\[dq]
+macos_release=\[dq]\[dq]
+network=\[dq]\[dq]
+port_forwards=()
+preallocation=\[dq]off\[dq]
+ram=\[dq]\[dq]
+secureboot=\[dq]off\[dq]
+tpm=\[dq]off\[dq]
+usb_devices=()
+viewer=\[dq]spicy\[dq]
+ssh_port=\[dq]\[dq]
+spice_port=\[dq]\[dq]
+public_dir=\[dq]\[dq]
+monitor=\[dq]socket\[dq]
+monitor_telnet_port=\[dq]4440\[dq]
+monitor_telnet_host=\[dq]localhost\[dq]
+monitor_cmd=\[dq]\[dq]
+serial=\[dq]socket\[dq]
+serial_telnet_port=\[dq]6660\[dq]
+serial_telnet_host=\[dq]localhost\[dq]
+# options: ehci(USB2.0), xhci(USB3.0)
+usb_controller=\[dq]ehci\[dq]
+# options: ps2, usb, virtio
+keyboard=\[dq]usb\[dq]
+keyboard_layout=\[dq]en-us\[dq]
+# options: ps2, usb, tablet, virtio
+mouse=\[dq]tablet\[dq]
+\f[R]
+.fi
+.SH EXAMPLES
+.IP
+.nf
+\f[C]
+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]
+\f[R]
+.fi
+.PP
+The default macOS configuration looks like this:
+.IP
+.nf
+\f[C]
+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]
+\f[R]
+.fi
+.IP \[bu] 2
+\f[V]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
+macOS.
+.IP \[bu] 2
+\f[V]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
+.PP
+The default Windows 11 configuration looks like this:
+.IP
+.nf
+\f[C]
+guest_os=\[dq]windows\[dq]
+disk_img=\[dq]windows-11/disk.qcow2\[dq]
+iso=\[dq]windows-11/Win11_EnglishInternational_x64.iso\[dq]
+fixed_iso=\[dq]windows-11/virtio-win.iso\[dq]
+tpm=\[dq]on\[dq]
+secureboot=\[dq]on\[dq]
+\f[R]
+.fi
+.IP \[bu] 2
+\f[V]guest_os=\[dq]windows\[dq]\f[R] instructs \f[V]quickemu\f[R] to
+optimise for Windows.
+.IP \[bu] 2
+\f[V]fixed_iso=\f[R] specifies the ISO image that provides VirtIO
+drivers.
+.IP \[bu] 2
+\f[V]tpm=\[dq]on\[dq]\f[R] instructs \f[V]quickemu\f[R] to create a
+software emulated TPM device using \f[V]swtpm\f[R].
+.SH BIOS and EFI
+.PP
+Since Quickemu 2.1.0 \f[V]efi\f[R] is the default boot option.
+If you want to override this behaviour then add the following line to
+you VM configuration to enable legacy BIOS.
+.IP \[bu] 2
+\f[V]boot=\[dq]legacy\[dq]\f[R] - Enable Legacy BIOS boot
+.SH Tuning CPU cores, RAM & disks
+.PP
+By default, Quickemu will calculate the number of CPUs cores and RAM to
+allocate to a VM based on the specifications of your host computer.
+You can override this default behaviour and tune the VM configuration to
+your liking.
+.PP
+Add additional lines to your virtual machine configuration:
+.IP \[bu] 2
+\f[V]cpu_cores=\[dq]4\[dq]\f[R] - Specify the number of CPU cores
+allocated to the VM
+.IP \[bu] 2
+\f[V]ram=\[dq]4G\[dq]\f[R] - Specify the amount of RAM to allocate to
+the VM
+.IP \[bu] 2
+\f[V]disk_size=\[dq]16G\[dq]\f[R] - Specify the size of the virtual disk
+allocated to the VM
+.SS Disk preallocation
+.PP
+Preallocation mode (allowed values: \f[V]off\f[R] (default),
+\f[V]metadata\f[R], \f[V]falloc\f[R], \f[V]full\f[R]).
+An image with preallocated metadata is initially larger but can improve
+performance when the image needs to grow.
+.PP
+Specify what disk preallocation should be used, if any, when creating
+the system disk image by adding a line like this to your VM
+configuration.
+.IP \[bu] 2
+\f[V]preallocation=\[dq]metadata\[dq]\f[R]
+.SS CD-ROM disks
+.PP
+If you want to expose an ISO image from the host to guest add the
+following line to the VM configuration:
+.IP \[bu] 2
+\f[V]fixed_iso=\[dq]/path/to/image.iso\[dq]\f[R]
+.SS Floppy disks
+.PP
+If you\[cq]re like Alan Pope (https://popey.com) you\[cq]ll probably
+want to mount a floppy disk image in the guest.
+To do so add the following line to the VM configuration:
+.IP \[bu] 2
+\f[V]floppy=\[dq]/path/to/floppy.img\[dq]\f[R]
+.SH File Sharing
+.PP
+All File Sharing options will only expose \f[V]\[ti]/Public\f[R] (or
+localised variations) for the current user to the guest VMs.
+.SS Samba 🐧 🍏 🪟
+.PP
+If \f[V]smbd\f[R] is available on the host, Quickemu will automatically
+enable the built-in QEMU support for exposing a Samba share from the
+host to the guest.
+.PP
+You can install the minimal Samba components on Ubuntu using:
+.IP
+.nf
+\f[C]
+sudo apt install --no-install-recommends samba
+\f[R]
+.fi
+.PP
+If everything is set up correctly, the \f[V]smbd\f[R] address will be
+printed when the virtual machine is started.
+For example:
+.IP
+.nf
+\f[C]
+ - smbd:     On guest: smb://10.0.2.4/qemu
+\f[R]
+.fi
+.PP
+If using a Windows guest, right-click on \[lq]This PC\[rq], click
+\[lq]Add a network location\[rq], and paste this address, removing
+\f[V]smb:\f[R] and replacing forward slashes with backslashes (in this
+example \f[V]\[rs]\[rs]10.0.2.4\[rs]qemu\f[R]).
+.SS SPICE WebDAV 🐧 🪟
+.IP \[bu] 2
+TBD
+.SS VirtIO-9P 🐧 🍏
+.IP \[bu] 2
+TBD
+.SH Network port forwarding
+.PP
+Add an additional line to your virtual machine configuration.
+For example:
+.IP \[bu] 2
+\f[V]port_forwards=(\[dq]8123:8123\[dq] \[dq]8888:80\[dq])\f[R]
+.PP
+In the example above:
+.IP \[bu] 2
+Port 8123 on the host is forwarded to port 8123 on the guest.
+.IP \[bu] 2
+Port 8888 on the host is forwarded to port 80 on the guest.
+.SH Disable networking
+.PP
+To completely disable all network interfaces in a guest VM add this
+additional line to your virtual machine configuration:
+.IP \[bu] 2
+\f[V]network=\[dq]none\[dq]\f[R]
+.SH Restricted networking
+.PP
+You can isolate the guest from the host (and broader network) using the
+restrict option, which will restrict networking to just the guest and
+any virtual devices.
+.PP
+This can be used to prevent software running inside the guest from
+phoning home while still providing a network inside the guest.
+Add this additional line to your virtual machine configuration:
+.IP \[bu] 2
+\f[V]network=\[dq]restrict\[dq]\f[R]
+.SH Bridged networking
+.PP
+Connect your virtual machine to a preconfigured network bridge.
+Add an additional line to your virtual machine configuration:
+.IP \[bu] 2
+\f[V]network=\[dq]br0\[dq]\f[R]
+.PP
+If you want to have a persistent MAC address for your bridged network
+interface in the guest VM you can add \f[V]macaddr\f[R] to the virtual
+machine configuration.
+QEMU requires that the MAC address is in the range:
+\f[B]52:54:00:AB:00:00 - 52:54:00:AB:FF:FF\f[R]
+.PP
+So you can generate your own MAC addresses with:
+.IP \[bu] 2
+\f[V]macaddr=\[dq]52:54:00:AB:51:AE\[dq]\f[R]
+.SH USB redirection
+.PP
+Quickemu supports USB redirection via SPICE pass-through and host
+pass-through.
+.SS SPICE redirection (recommended)
+.PP
+Using SPICE for USB pass-through is easiest as it doesn\[cq]t require
+any elevated permission, start Quickemu with \f[V]--display spice\f[R]
+and then select \f[V]Input\f[R] ->
+\f[V]Select USB Device for redirection\f[R] from the menu to choose
+which device(s) you want to attach to the guest.
+.SS Host redirection \f[B]NOT Recommended\f[R]
+.PP
+\f[B]USB host redirection is not recommended\f[R], it is provided purely
+for backwards compatibility to older versions of Quickemu.
+Using SPICE is preferred, see above.
+.PP
+Add an additional line to your virtual machine configuration.
+For example:
+.IP \[bu] 2
+\f[V]usb_devices=(\[dq]046d:082d\[dq] \[dq]046d:085e\[dq])\f[R]
+.PP
+In the example above:
+.IP \[bu] 2
+The USB device with vendor_id 046d and product_id 082d will be exposed
+to the guest.
+.IP \[bu] 2
+The USB device with vendor_id 046d and product_id 085e will be exposed
+to the guest.
+.PP
+If the USB devices are not writable, \f[V]quickemu\f[R] will display the
+appropriate commands to modify the USB device(s) access permissions,
+like this:
+.IP
+.nf
+\f[C]
+ - USB:      Host pass-through requested:
+              - Sennheiser Communications EPOS GTW 270 on bus 001 device 005 needs permission changes:
+                sudo chown -v root:user /dev/bus/usb/001/005
+                ERROR! USB permission changes are required 👆
+\f[R]
+.fi
+.SH TPM
+.PP
+Since Quickemu 2.2.0 a software emulated TPM device can be added to
+guest virtual machines.
+Just add \f[V]tpm=\[dq]on\[dq]\f[R] to your VM configuration.
+\f[V]quickget\f[R] will automatically add this line to Windows 11
+virtual machines.
+.SH AUTHORS
+.PP
+Written by Martin Wimpress.
+.SH BUGS
+.PP
+Submit bug reports online at:
+<https://github.com/quickemu-project/quickemu/issues>
+.SH SEE ALSO
+.PP
+Full sources at: <https://github.com/quickemu-project/quickemu>
+.PP
+quickget(1), quickemu(1), quickgui(1)
+.SH AUTHORS
+Martin Wimpress.

docs/quickemu_conf.1.md

@@ -0,0 +1,299 @@
+---
+author: Martin Wimpress
+date: June 14, 2023
+footer: quickemu_conf
+header: Quickemu Configuration Manual
+section: 1
+title: QUICKEMU_CONF
+---
+
+# NAME
+
+quickemu_conf - Options and parameters in the quickemu \<vm\>.conf
+
+# DESCRIPTION
+
+**quickemu** will create and run highly optimised desktop virtual
+machines for Linux, macOS and Windows. It uses sensible defaults, but
+many configuration options can be overridden in the required
+configuration file, which will as a minimum specify the path to the
+installation ISO and QEMU disk for the installed VM
+
+# OPTIONS
+
+These are the options and defaults for the \<vm\>.conf file
+
+``` bash
+# Lowercase variables are used in the VM config file only
+boot="efi"
+cpu_cores=""
+disk_img=""
+disk_size=""
+display=""
+extra_args=""
+fixed_iso=""
+floppy=""
+guest_os="linux"
+img=""
+iso=""
+macaddr=""
+macos_release=""
+network=""
+port_forwards=()
+preallocation="off"
+ram=""
+secureboot="off"
+tpm="off"
+usb_devices=()
+viewer="spicy"
+ssh_port=""
+spice_port=""
+public_dir=""
+monitor="socket"
+monitor_telnet_port="4440"
+monitor_telnet_host="localhost"
+monitor_cmd=""
+serial="socket"
+serial_telnet_port="6660"
+serial_telnet_host="localhost"
+# options: ehci(USB2.0), xhci(USB3.0)
+usb_controller="ehci"
+# options: ps2, usb, virtio
+keyboard="usb"
+keyboard_layout="en-us"
+# options: ps2, usb, tablet, virtio
+mouse="tablet"
+```
+
+# EXAMPLES
+
+``` bash
+guest_os="linux"
+disk_img="debian-bullseye/disk.qcow2"
+iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso"
+```
+
+The default macOS configuration looks like this:
+
+``` bash
+guest_os="macos"
+img="macos-catalina/RecoveryImage.img"
+disk_img="macos-catalina/disk.qcow2"
+macos_release="catalina"
+```
+
+-   `guest_os="macos"` instructs Quickemu to optimise for macOS.
+-   `macos_release="catalina"` instructs Quickemu to optimise for a
+    particular macOS release.
+    -   For example VirtIO Network and Memory Ballooning are available
+        in Big Sur and newer, but not previous releases.
+    -   And VirtIO Block Media (disks) are supported/stable in Catalina
+        and newer.
+
+The default Windows 11 configuration looks like this:
+
+``` bash
+guest_os="windows"
+disk_img="windows-11/disk.qcow2"
+iso="windows-11/Win11_EnglishInternational_x64.iso"
+fixed_iso="windows-11/virtio-win.iso"
+tpm="on"
+secureboot="on"
+```
+
+-   `guest_os="windows"` instructs `quickemu` to optimise for Windows.
+-   `fixed_iso=` specifies the ISO image that provides VirtIO drivers.
+-   `tpm="on"` instructs `quickemu` to create a software emulated TPM
+    device using `swtpm`.
+
+# BIOS and EFI
+
+Since Quickemu 2.1.0 `efi` is the default boot option. If you want to
+override this behaviour then add the following line to you VM
+configuration to enable legacy BIOS.
+
+-   `boot="legacy"` - Enable Legacy BIOS boot
+
+# Tuning CPU cores, RAM & disks
+
+By default, Quickemu will calculate the number of CPUs cores and RAM to
+allocate to a VM based on the specifications of your host computer. You
+can override this default behaviour and tune the VM configuration to
+your liking.
+
+Add additional lines to your virtual machine configuration:
+
+-   `cpu_cores="4"` - Specify the number of CPU cores allocated to the
+    VM
+-   `ram="4G"` - Specify the amount of RAM to allocate to the VM
+-   `disk_size="16G"` - Specify the size of the virtual disk allocated
+    to the VM
+
+## Disk preallocation
+
+Preallocation mode (allowed values: `off` (default), `metadata`,
+`falloc`, `full`). An image with preallocated metadata is initially
+larger but can improve performance when the image needs to grow.
+
+Specify what disk preallocation should be used, if any, when creating
+the system disk image by adding a line like this to your VM
+configuration.
+
+-   `preallocation="metadata"`
+
+## CD-ROM disks
+
+If you want to expose an ISO image from the host to guest add the
+following line to the VM configuration:
+
+-   `fixed_iso="/path/to/image.iso"`
+
+## Floppy disks
+
+If you're like [Alan Pope](https://popey.com) you'll probably want to
+mount a floppy disk image in the guest. To do so add the following line
+to the VM configuration:
+
+-   `floppy="/path/to/floppy.img"`
+
+# File Sharing
+
+All File Sharing options will only expose `~/Public` (or localised
+variations) for the current user to the guest VMs.
+
+## Samba 🐧 🍏 🪟
+
+If `smbd` is available on the host, Quickemu will automatically enable
+the built-in QEMU support for exposing a Samba share from the host to
+the guest.
+
+You can install the minimal Samba components on Ubuntu using:
+
+``` bash
+sudo apt install --no-install-recommends samba
+```
+
+If everything is set up correctly, the `smbd` address will be printed
+when the virtual machine is started. For example:
+
+     - smbd:     On guest: smb://10.0.2.4/qemu
+
+If using a Windows guest, right-click on "This PC", click "Add a network
+location", and paste this address, removing `smb:` and replacing forward
+slashes with backslashes (in this example `\\10.0.2.4\qemu`).
+
+## SPICE WebDAV 🐧 🪟
+
+-   TBD
+
+## VirtIO-9P 🐧 🍏
+
+-   TBD
+
+# Network port forwarding
+
+Add an additional line to your virtual machine configuration. For
+example:
+
+-   `port_forwards=("8123:8123" "8888:80")`
+
+In the example above:
+
+-   Port 8123 on the host is forwarded to port 8123 on the guest.
+-   Port 8888 on the host is forwarded to port 80 on the guest.
+
+# Disable networking
+
+To completely disable all network interfaces in a guest VM add this
+additional line to your virtual machine configuration:
+
+-   `network="none"`
+
+# Restricted networking
+
+You can isolate the guest from the host (and broader network) using the
+restrict option, which will restrict networking to just the guest and
+any virtual devices.
+
+This can be used to prevent software running inside the guest from
+phoning home while still providing a network inside the guest. Add this
+additional line to your virtual machine configuration:
+
+-   `network="restrict"`
+
+# Bridged networking
+
+Connect your virtual machine to a preconfigured network bridge. Add an
+additional line to your virtual machine configuration:
+
+-   `network="br0"`
+
+If you want to have a persistent MAC address for your bridged network
+interface in the guest VM you can add `macaddr` to the virtual machine
+configuration. QEMU requires that the MAC address is in the range:
+**52:54:00:AB:00:00 - 52:54:00:AB:FF:FF**
+
+So you can generate your own MAC addresses with:
+
+-   `macaddr="52:54:00:AB:51:AE"`
+
+# USB redirection
+
+Quickemu supports USB redirection via SPICE pass-through and host
+pass-through.
+
+## SPICE redirection (recommended)
+
+Using SPICE for USB pass-through is easiest as it doesn't require any
+elevated permission, start Quickemu with `--display spice` and then
+select `Input` -\> `Select USB Device for redirection` from the menu to
+choose which device(s) you want to attach to the guest.
+
+## Host redirection **NOT Recommended**
+
+**USB host redirection is not recommended**, it is provided purely for
+backwards compatibility to older versions of Quickemu. Using SPICE is
+preferred, see above.
+
+Add an additional line to your virtual machine configuration. For
+example:
+
+-   `usb_devices=("046d:082d" "046d:085e")`
+
+In the example above:
+
+-   The USB device with vendor_id 046d and product_id 082d will be
+    exposed to the guest.
+-   The USB device with vendor_id 046d and product_id 085e will be
+    exposed to the guest.
+
+If the USB devices are not writable, `quickemu` will display the
+appropriate commands to modify the USB device(s) access permissions,
+like this:
+
+     - USB:      Host pass-through requested:
+                  - Sennheiser Communications EPOS GTW 270 on bus 001 device 005 needs permission changes:
+                    sudo chown -v root:user /dev/bus/usb/001/005
+                    ERROR! USB permission changes are required 👆
+
+# TPM
+
+Since Quickemu 2.2.0 a software emulated TPM device can be added to
+guest virtual machines. Just add `tpm="on"` to your VM configuration.
+`quickget` will automatically add this line to Windows 11 virtual
+machines.
+
+# AUTHORS
+
+Written by Martin Wimpress.
+
+# BUGS
+
+Submit bug reports online at:
+<https://github.com/quickemu-project/quickemu/issues>
+
+# SEE ALSO
+
+Full sources at: <https://github.com/quickemu-project/quickemu>
+
+quickget(1), quickemu(1), quickgui(1)

docs/quickget.1

@@ -0,0 +1,544 @@
+.\" Automatically generated by Pandoc 3.1.1
+.\"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
+.TH "QUICKGET" "1" "June 14, 2023" "quickget" "Quickget User Manual"
+.hy
+.SH NAME
+.PP
+quickget - download and prepare materials for building a quickemu VM
+.SH SYNOPSIS
+.PP
+\f[B]quickget\f[R] [\f[I]os\f[R]] [\f[I]release\f[R]]
+[\f[I]edition\f[R]] | [\f[I]OPTION\f[R]]*
+.SH DESCRIPTION
+.PP
+\f[B]quickget\f[R] will download the requisite materials and prepare a
+configuration for \f[V]quickemu\f[R] to use to build and run
+.SH OPTIONS
+.TP
+\f[B]version | -version | \[en]version\f[R]
+show version (from Quickemu)
+.TP
+\f[B]list | list_csv | list_json\f[R]
+provide a csv list of all supported guest OSes, versions and variants.
+.TP
+\f[B][OS] [Release] [Edition]\f[R]
+specify the OS and release (and optional edition) if insufficient input
+is provided a list of missing options will be reported and the script
+will exit.
+Editions may not apply and will be defaulted if not provided.
+.SH NOTES
+.SS Ubuntu Guest
+.PP
+\f[V]quickget\f[R] will automatically download an Ubuntu release and
+create the virtual machine configuration.
+.IP
+.nf
+\f[C]
+quickget ubuntu 22.04
+quickemu --vm ubuntu-22.04.conf
+\f[R]
+.fi
+.IP \[bu] 2
+Complete the installation as normal.
+.IP \[bu] 2
+Post-install:
+.RS 2
+.IP \[bu] 2
+Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable
+copy/paste and USB redirection
+.RS 2
+.IP \[bu] 2
+\f[V]sudo apt install spice-vdagent\f[R]
+.RE
+.IP \[bu] 2
+Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to
+enable file sharing.
+.RS 2
+.IP \[bu] 2
+\f[V]sudo apt install spice-webdavd\f[R]
+.RE
+.RE
+.SS Ubuntu devel (daily-live) images
+.PP
+\f[V]quickget\f[R] can also download/refresh devel images via
+\f[V]zsync\f[R] for Ubuntu developers and testers.
+.IP
+.nf
+\f[C]
+quickget ubuntu devel
+quickemu --vm ubuntu-devel.conf
+\f[R]
+.fi
+.PP
+You can run \f[V]quickget ubuntu devel\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
+.PP
+All the official Ubuntu flavours are supported, just replace
+\f[V]ubuntu\f[R] with your preferred flavour.
+.IP \[bu] 2
+\f[V]kubuntu\f[R] (Kubuntu)
+.IP \[bu] 2
+\f[V]lubuntu\f[R] (Lubuntu)
+.IP \[bu] 2
+\f[V]ubuntu-budgie\f[R] (Ubuntu Budgie)
+.IP \[bu] 2
+\f[V]ubuntucinnamon\f[R] (Ubuntu Cinnamon)
+.IP \[bu] 2
+\f[V]ubuntukylin\f[R] (Ubuntu Kylin)
+.IP \[bu] 2
+\f[V]ubuntu-mate\f[R] (Ubuntu MATE)
+.IP \[bu] 2
+\f[V]ubuntu-server\f[R] (Ubuntu Server)
+.IP \[bu] 2
+\f[V]ubuntustudio\f[R] (Ubuntu Studio)
+.IP \[bu] 2
+\f[V]ubuntu\f[R] (Ubuntu)
+.IP \[bu] 2
+\f[V]ubuntu-unity\f[R] (Ubuntu Unity)
+.IP \[bu] 2
+\f[V]xubuntu\f[R] (Xubuntu)
+.SS Other Operating Systems
+.PP
+\f[V]quickget\f[R] also supports:
+.IP \[bu] 2
+\f[V]alma\f[R] (Alma Linux)
+.IP \[bu] 2
+\f[V]alpine\f[R] (Alpine Linux)
+.IP \[bu] 2
+\f[V]android\f[R] (Android x86)
+.IP \[bu] 2
+\f[V]archcraft\f[R] (Archcraft)
+.IP \[bu] 2
+\f[V]archlinux\f[R] (Arch Linux)
+.IP \[bu] 2
+\f[V]arcolinux\f[R] (Arco Linux)
+.IP \[bu] 2
+\f[V]batocera\f[R] (Batocera)
+.IP \[bu] 2
+\f[V]blendos\f[R] (BlendOS)
+.IP \[bu] 2
+\f[V]cachyos\f[R] (CachyOS)
+.IP \[bu] 2
+\f[V]centos-stream\f[R] (CentOS Stream)
+.IP \[bu] 2
+\f[V]debian\f[R] (Debian)
+.IP \[bu] 2
+\f[V]deepin\f[R] (Deepin)
+.IP \[bu] 2
+\f[V]devuan\f[R] (Devuan)
+.IP \[bu] 2
+\f[V]dragonflybsd\f[R] (DragonFlyBSD)
+.IP \[bu] 2
+\f[V]elementary\f[R] (elementary OS)
+.IP \[bu] 2
+\f[V]endeavouros\f[R] (EndeavourOS)
+.IP \[bu] 2
+\f[V]endless\f[R] (Endless OS)
+.IP \[bu] 2
+\f[V]fedora\f[R] (Fedora)
+.IP \[bu] 2
+\f[V]freebsd\f[R] (FreeBSD)
+.IP \[bu] 2
+\f[V]freedos\f[R] (FreeDOS)
+.IP \[bu] 2
+\f[V]gentoo\f[R] (Gentoo)
+.IP \[bu] 2
+\f[V]ghostbsd\f[R] (GhostBSD)
+.IP \[bu] 2
+\f[V]haiku\f[R] (Haiku)
+.IP \[bu] 2
+\f[V]holoiso\f[R] (HoloISO)
+.IP \[bu] 2
+\f[V]kali\f[R] (Kali)
+.IP \[bu] 2
+\f[V]kdeneon\f[R] (KDE Neon)
+.IP \[bu] 2
+\f[V]kolibrios\f[R] (KolibriOS)
+.IP \[bu] 2
+\f[V]linuxmint\f[R] (Linux Mint)
+.IP \[bu] 2
+\f[V]lmde\f[R] (Linux Mint Debian Edition)
+.IP \[bu] 2
+\f[V]mageia\f[R] (Mageia)
+.IP \[bu] 2
+\f[V]manjaro\f[R] (Manjaro)
+.IP \[bu] 2
+\f[V]mxlinux\f[R] (MX Linux)
+.IP \[bu] 2
+\f[V]netboot\f[R] (netboot.xyz)
+.IP \[bu] 2
+\f[V]netbsd\f[R] (NetBSD)
+.IP \[bu] 2
+\f[V]nixos\f[R] (NixOS)
+.IP \[bu] 2
+\f[V]openbsd\f[R] (OpenBSD)
+.IP \[bu] 2
+\f[V]openindiana\f[R] (OpenIndiana)
+.IP \[bu] 2
+\f[V]opensuse\f[R] (openSUSE)
+.IP \[bu] 2
+\f[V]oraclelinux\f[R] (Oracle Linux)
+.IP \[bu] 2
+\f[V]popos\f[R] (Pop!_OS)
+.IP \[bu] 2
+\f[V]reactos\f[R] (ReactOS)
+.IP \[bu] 2
+\f[V]rebornos\f[R] (RebornOS)
+.IP \[bu] 2
+\f[V]rockylinux\f[R] (Rocky Linux)
+.IP \[bu] 2
+\f[V]siduction\f[R] (Siduction)
+.IP \[bu] 2
+\f[V]slackware\f[R] (Slackware)
+.IP \[bu] 2
+\f[V]solus\f[R] (Solus)
+.IP \[bu] 2
+\f[V]tails\f[R] (Tails)
+.IP \[bu] 2
+\f[V]truenas-core\f[R] (TrueNAS Core)
+.IP \[bu] 2
+\f[V]truenas-scale\f[R] (TrueNAS Scale)
+.IP \[bu] 2
+\f[V]vanillaos\f[R] (Vanilla OS)
+.IP \[bu] 2
+\f[V]void\f[R] (Void Linux)
+.IP \[bu] 2
+\f[V]vxlinux\f[R] (VX Linux)
+.IP \[bu] 2
+\f[V]xerolinux\f[R] (XeroLinux)
+.IP \[bu] 2
+\f[V]zorin\f[R] (Zorin OS)
+.PP
+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[V]debian-bullseye.conf\f[R]
+.IP
+.nf
+\f[C]
+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]
+\f[R]
+.fi
+.IP \[bu] 2
+Use \f[V]quickemu\f[R] to start the virtual machine:
+.IP
+.nf
+\f[C]
+quickemu --vm debian-bullseye.conf
+\f[R]
+.fi
+.IP \[bu] 2
+Complete the installation as normal.
+.IP \[bu] 2
+Post-install:
+.RS 2
+.IP \[bu] 2
+Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable
+copy/paste and USB redirection.
+.IP \[bu] 2
+Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to
+enable file sharing.
+.RE
+.SS macOS Guest
+.PP
+\f[V]quickget\f[R] automatically downloads a macOS recovery image and
+creates a virtual machine configuration.
+.IP
+.nf
+\f[C]
+quickget macos catalina
+quickemu --vm macos-catalina.conf
+\f[R]
+.fi
+.PP
+macOS \f[V]high-sierra\f[R], \f[V]mojave\f[R], \f[V]catalina\f[R],
+\f[V]big-sur\f[R] and \f[V]monterey\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[V]QEMU HARDDISK Media\f[R] (\[ti]103.08GB) from the list (on
+Big Sur and above use \f[V]Apple Inc. VirtIO Block Device\f[R]) and
+click \f[B]Erase\f[R].
+.IP \[bu] 2
+Enter a \f[V]Name:\f[R] for the disk
+.IP \[bu] 2
+If you are installing macOS Mojave or later (Catalina, Big Sur, and
+Monterey), 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
+.nf
+\f[C]
+sudo trimforce enable
+\f[R]
+.fi
+.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.
+If you press enter without first typing y the system will consider that
+a negative response as though you said \[lq]no\[rq]:
+.IP
+.nf
+\f[C]
+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)?
+\f[R]
+.fi
+.PP
+And a second confirmation once you\[cq]ve confirmed the previous one:
+.IP
+.nf
+\f[C]
+Your system will immediately reboot when this is complete.
+Is this OK (y/N)?
+\f[R]
+.fi
+.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
+.nf
+\f[C]
+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]
+\f[R]
+.fi
+.IP \[bu] 2
+\f[V]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
+macOS.
+.IP \[bu] 2
+\f[V]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
+.SS macOS compatibility
+.PP
+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
+.RE
+.IP \[bu] 2
+\f[V]quickemu\f[R] will automatically download the required
+OpenCore (https://github.com/acidanthera/OpenCorePkg) bootloader and
+OVMF firmware from OSX-KVM (https://github.com/kholia/OSX-KVM).
+.IP \[bu] 2
+Optimised by default, but no GPU acceleration is available.
+.RS 2
+.IP \[bu] 2
+Host CPU vendor is detected and guest CPU is optimised accordingly.
+.IP \[bu] 2
+VirtIO Block
+Media (https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is used
+for the system disk where supported.
+.IP \[bu] 2
+VirtIO \f[V]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used for
+the mouse.
+.IP \[bu] 2
+VirtIO Network (\f[V]virtio-net\f[R]) is supported and enabled on macOS
+Big Sur and newer but previous releases use \f[V]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 VoodooHDA
+OC (https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB
+audio-device to the macOS guest VM\f[R].
+.IP \[bu] 2
+NOTE!
+Gatekeeper (https://disable-gatekeeper.github.io/) and System Integrity
+Protection
+(SIP) (https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection)
+need to be disabled to install VoodooHDA OC
+.IP \[bu] 2
+File sharing between guest and host is available via
+virtio-9p (https://wiki.qemu.org/Documentation/9psetup) and SPICE
+webdavd (https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24).
+.IP \[bu] 2
+Copy/paste via SPICE agent is \f[B]not available on macOS\f[R].
+.SS macOS App Store
+.PP
+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[V]en0\f[R].
+Use \f[V]ifconfig\f[R] in a terminal to verify this.
+.PP
+If the wired ethernet device is not \f[V]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
+.nf
+\f[C]
+sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
+\f[R]
+.fi
+.PP
+Now reboot, and the App Store should work.
+.SS Windows 10 & 11 Guests
+.PP
+\f[V]quickget\f[R] can download
+Windows10 (https://www.microsoft.com/software-download/windows10) and
+Windows 11 (https://www.microsoft.com/software-download/windows11)
+automatically and create an optimised virtual machine configuration.
+This configuration also includes the VirtIO drivers for
+Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/).
+.IP
+.nf
+\f[C]
+quickget windows 11
+quickemu --vm windows-11-22H2.conf
+\f[R]
+.fi
+.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 adminstrator user account is automatically created, with these
+credentials:
+.RS 2
+.IP \[bu] 2
+Username: \f[V]Quickemu\f[R]
+.IP \[bu] 2
+Password: \f[V]quickemu\f[R]
+.RE
+.PP
+The default Windows 11 configuration looks like this:
+.IP
+.nf
+\f[C]
+guest_os=\[dq]windows\[dq]
+disk_img=\[dq]windows-11/disk.qcow2\[dq]
+iso=\[dq]windows-11/windows-11.iso\[dq]
+fixed_iso=\[dq]windows-11/virtio-win.iso\[dq]
+tpm=\[dq]on\[dq]
+secureboot=\[dq]on\[dq]
+\f[R]
+.fi
+.IP \[bu] 2
+\f[V]guest_os=\[dq]windows\[dq]\f[R] instructs \f[V]quickemu\f[R] to
+optimise for Windows.
+.IP \[bu] 2
+\f[V]fixed_iso=\f[R] specifies the ISO image that provides VirtIO
+drivers.
+.IP \[bu] 2
+\f[V]tpm=\[dq]on\[dq]\f[R] instructs \f[V]quickemu\f[R] to create a
+software emulated TPM device using \f[V]swtpm\f[R].
+.SH AUTHORS
+.PP
+Written by Martin Wimpress.
+.SH BUGS
+.PP
+Submit bug reports online at:
+<https://github.com/quickemu-project/quickemu/issues>
+.SH SEE ALSO
+.PP
+Full sources at: <https://github.com/quickemu-project/quickemu>
+.PP
+quickemu(1), quickemu_conf(1), quickgui(1)
+.SH AUTHORS
+Martin Wimpress.

docs/quickget.1.md

@@ -0,0 +1,375 @@
+---
+author: Martin Wimpress
+date: June 14, 2023
+footer: quickget
+header: Quickget User Manual
+section: 1
+title: QUICKGET
+---
+
+# NAME
+
+quickget - download and prepare materials for building a quickemu VM
+
+# SYNOPSIS
+
+**quickget** \[*os*\] \[*release*\] \[*edition*\] \| \[*OPTION*\]\*
+
+# DESCRIPTION
+
+**quickget** will download the requisite materials and prepare a
+configuration for `quickemu` to use to build and run
+
+# OPTIONS
+
+**version \| -version \| --version**
+:   show version (from Quickemu)
+
+**list \| list_csv \| list_json**
+:   provide a csv list of all supported guest OSes, versions and
+    variants.
+
+**\[OS\] \[Release\] \[Edition\]**
+:   specify the OS and release (and optional edition) if insufficient
+    input is provided a list of missing options will be reported and the
+    script will exit. Editions may not apply and will be defaulted if
+    not provided.
+
+# NOTES
+
+## Ubuntu Guest
+
+`quickget` will automatically download an Ubuntu release and create the
+virtual machine configuration.
+
+``` bash
+quickget ubuntu 22.04
+quickemu --vm ubuntu-22.04.conf
+```
+
+-   Complete the installation as normal.
+-   Post-install:
+    -   Install the SPICE agent (`spice-vdagent`) in the guest to enable
+        copy/paste and USB redirection
+        -   `sudo apt install spice-vdagent`
+    -   Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to
+        enable file sharing.
+        -   `sudo apt install spice-webdavd`
+
+### Ubuntu devel (daily-live) images
+
+`quickget` can also download/refresh devel images via `zsync` for Ubuntu
+developers and testers.
+
+``` bash
+quickget ubuntu devel
+quickemu --vm ubuntu-devel.conf
+```
+
+You can run `quickget ubuntu devel` to refresh your daily development
+image as often as you like, it will even automatically switch to a new
+series.
+
+### Ubuntu Flavours
+
+All the official Ubuntu flavours are supported, just replace `ubuntu`
+with your preferred flavour.
+
+-   `kubuntu` (Kubuntu)
+-   `lubuntu` (Lubuntu)
+-   `ubuntu-budgie` (Ubuntu Budgie)
+-   `ubuntucinnamon` (Ubuntu Cinnamon)
+-   `ubuntukylin` (Ubuntu Kylin)
+-   `ubuntu-mate` (Ubuntu MATE)
+-   `ubuntu-server` (Ubuntu Server)
+-   `ubuntustudio` (Ubuntu Studio)
+-   `ubuntu` (Ubuntu)
+-   `ubuntu-unity` (Ubuntu Unity)
+-   `xubuntu` (Xubuntu)
+
+## Other Operating Systems
+
+`quickget` also supports:
+
+-   `alma` (Alma Linux)
+-   `alpine` (Alpine Linux)
+-   `android` (Android x86)
+-   `archcraft` (Archcraft)
+-   `archlinux` (Arch Linux)
+-   `arcolinux` (Arco Linux)
+-   `batocera` (Batocera)
+-   `blendos` (BlendOS)
+-   `cachyos` (CachyOS)
+-   `centos-stream` (CentOS Stream)
+-   `debian` (Debian)
+-   `deepin` (Deepin)
+-   `devuan` (Devuan)
+-   `dragonflybsd` (DragonFlyBSD)
+-   `elementary` (elementary OS)
+-   `endeavouros` (EndeavourOS)
+-   `endless` (Endless OS)
+-   `fedora` (Fedora)
+-   `freebsd` (FreeBSD)
+-   `freedos` (FreeDOS)
+-   `gentoo` (Gentoo)
+-   `ghostbsd` (GhostBSD)
+-   `haiku` (Haiku)
+-   `holoiso` (HoloISO)
+-   `kali` (Kali)
+-   `kdeneon` (KDE Neon)
+-   `kolibrios` (KolibriOS)
+-   `linuxmint` (Linux Mint)
+-   `lmde` (Linux Mint Debian Edition)
+-   `mageia` (Mageia)
+-   `manjaro` (Manjaro)
+-   `mxlinux` (MX Linux)
+-   `netboot` (netboot.xyz)
+-   `netbsd` (NetBSD)
+-   `nixos` (NixOS)
+-   `openbsd` (OpenBSD)
+-   `openindiana` (OpenIndiana)
+-   `opensuse` (openSUSE)
+-   `oraclelinux` (Oracle Linux)
+-   `popos` (Pop!\_OS)
+-   `reactos` (ReactOS)
+-   `rebornos` (RebornOS)
+-   `rockylinux` (Rocky Linux)
+-   `siduction` (Siduction)
+-   `slackware` (Slackware)
+-   `solus` (Solus)
+-   `tails` (Tails)
+-   `truenas-core` (TrueNAS Core)
+-   `truenas-scale` (TrueNAS Scale)
+-   `vanillaos` (Vanilla OS)
+-   `void` (Void Linux)
+-   `vxlinux` (VX Linux)
+-   `xerolinux` (XeroLinux)
+-   `zorin` (Zorin OS)
+
+Or you can download a Linux image and manually create a VM
+configuration.
+
+-   Download a .iso image of a Linux distribution
+-   Create a VM configuration file; for example `debian-bullseye.conf`
+
+``` bash
+guest_os="linux"
+disk_img="debian-bullseye/disk.qcow2"
+iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso"
+```
+
+-   Use `quickemu` to start the virtual machine:
+
+``` bash
+quickemu --vm debian-bullseye.conf
+```
+
+-   Complete the installation as normal.
+-   Post-install:
+    -   Install the SPICE agent (`spice-vdagent`) in the guest to enable
+        copy/paste and USB redirection.
+    -   Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to
+        enable file sharing.
+
+## macOS Guest
+
+`quickget` automatically downloads a macOS recovery image and creates a
+virtual machine configuration.
+
+``` bash
+quickget macos catalina
+quickemu --vm macos-catalina.conf
+```
+
+macOS `high-sierra`, `mojave`, `catalina`, `big-sur` and `monterey` are
+supported.
+
+-   Use cursor keys and enter key to select the **macOS Base System**
+-   From **macOS Utilities**
+    -   Click **Disk Utility** and **Continue**
+        -   Select `QEMU HARDDISK Media` (\~103.08GB) from the list (on
+            Big Sur and above use `Apple Inc. VirtIO Block Device`) and
+            click **Erase**.
+        -   Enter a `Name:` for the disk
+        -   If you are installing macOS Mojave or later (Catalina, Big
+            Sur, and Monterey), choose any of the APFS options as the
+            filesystem. MacOS Extended may not work.
+    -   Click **Erase**.
+    -   Click **Done**.
+    -   Close Disk Utility
+-   From **macOS Utilities**
+    -   Click **Reinstall macOS** and **Continue**
+-   Complete the installation as you normally would.
+    -   On the first reboot use cursor keys and enter key to select
+        **macOS Installer**
+    -   On the subsequent reboots use cursor keys and enter key to
+        select the disk you named
+-   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
+-   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.
+    -   To enable TRIM, open the Terminal application and type the
+        following command followed by pressing
+        `<kbd>`{=html}enter`</kbd>`{=html} to tell macos to use the TRIM
+        command on the hard disk when files are deleted:
+
+``` bash
+sudo trimforce enable
+```
+
+You will be prompted to enter your account's password to gain the
+privilege needed. Once you've entered your password and pressed
+`<kbd>`{=html}enter`</kbd>`{=html} the command will request confirmation
+in the form of two questions that require you to type
+`<kbd>`{=html}y`</kbd>`{=html} (for a "yes" response) followed by
+`<kbd>`{=html}enter`</kbd>`{=html} to confirm. If you press
+`<kbd>`{=html}enter`</kbd>`{=html} without first typing
+`<kbd>`{=html}y`</kbd>`{=html} the system will consider that a negative
+response as though you said "no":
+
+``` plain
+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 "as is" 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)?
+```
+
+And a second confirmation once you've confirmed the previous one:
+
+``` plain
+Your system will immediately reboot when this is complete.
+Is this OK (y/N)?
+```
+
+As the last message states, your system will automatically reboot as
+soon as the command completes.
+
+The default macOS configuration looks like this:
+
+``` bash
+guest_os="macos"
+img="macos-catalina/RecoveryImage.img"
+disk_img="macos-catalina/disk.qcow2"
+macos_release="catalina"
+```
+
+-   `guest_os="macos"` instructs Quickemu to optimise for macOS.
+-   `macos_release="catalina"` instructs Quickemu to optimise for a
+    particular macOS release.
+    -   For example VirtIO Network and Memory Ballooning are available
+        in Big Sur and newer, but not previous releases.
+    -   And VirtIO Block Media (disks) are supported/stable in Catalina
+        and newer.
+
+### macOS compatibility
+
+There are some considerations when running macOS via Quickemu.
+
+-   Supported macOS releases:
+    -   High Sierra
+    -   Mojave
+    -   Catalina **(Recommended)**
+    -   Big Sur
+    -   Monterey
+-   `quickemu` will automatically download the required
+    [OpenCore](https://github.com/acidanthera/OpenCorePkg) bootloader
+    and OVMF firmware from [OSX-KVM](https://github.com/kholia/OSX-KVM).
+-   Optimised by default, but no GPU acceleration is available.
+    -   Host CPU vendor is detected and guest CPU is optimised
+        accordingly.
+    -   [VirtIO Block
+        Media](https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is
+        used for the system disk where supported.
+    -   [VirtIO `usb-tablet`](http://philjordan.eu/osx-virt/) is used
+        for the mouse.
+    -   VirtIO Network (`virtio-net`) is supported and enabled on macOS
+        Big Sur and newer but previous releases use `vmxnet3`.
+    -   VirtIO Memory Ballooning is supported and enabled on macOS Big
+        Sur and newer but disabled for other support macOS releases.
+-   USB host and SPICE pass-through is:
+    -   UHCI (USB 2.0) on macOS Catalina and earlier.
+    -   XHCI (USB 3.0) on macOS Big Sur and newer.
+-   Display resolution can only be changed via macOS System Preferences.
+-   **Full Duplex audio requires [VoodooHDA
+    OC](https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB
+    audio-device to the macOS guest VM**.
+-   NOTE! [Gatekeeper](https://disable-gatekeeper.github.io/) and
+    [System Integrity Protection
+    (SIP)](https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection)
+    need to be disabled to install VoodooHDA OC
+-   File sharing between guest and host is available via
+    [virtio-9p](https://wiki.qemu.org/Documentation/9psetup) and [SPICE
+    webdavd](https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24).
+-   Copy/paste via SPICE agent is **not available on macOS**.
+
+### macOS App Store
+
+If you see *"Your device or computer could not be verified"* when you
+try to login to the App Store, make sure that your wired ethernet device
+is `en0`. Use `ifconfig` in a terminal to verify this.
+
+If the wired ethernet device is not `en0`, then then go to *System
+Preferences* -\> *Network*, delete all the network devices and apply the
+changes. Next, open a terminal and run the following:
+
+``` bash
+sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
+```
+
+Now reboot, and the App Store should work.
+
+## Windows 10 & 11 Guests
+
+`quickget` can download
+[Windows10](https://www.microsoft.com/software-download/windows10) and
+[Windows 11](https://www.microsoft.com/software-download/windows11)
+automatically and create an optimised virtual machine configuration.
+This configuration also includes the [VirtIO drivers for
+Windows](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/).
+
+``` bash
+quickget windows 11
+quickemu --vm windows-11-22H2.conf
+```
+
+-   Complete the installation as you normally would.
+-   All relevant drivers and services should be installed automatically.
+-   A local adminstrator user account is automatically created, with
+    these credentials:
+    -   Username: `Quickemu`
+    -   Password: `quickemu`
+
+The default Windows 11 configuration looks like this:
+
+``` bash
+guest_os="windows"
+disk_img="windows-11/disk.qcow2"
+iso="windows-11/windows-11.iso"
+fixed_iso="windows-11/virtio-win.iso"
+tpm="on"
+secureboot="on"
+```
+
+-   `guest_os="windows"` instructs `quickemu` to optimise for Windows.
+-   `fixed_iso=` specifies the ISO image that provides VirtIO drivers.
+-   `tpm="on"` instructs `quickemu` to create a software emulated TPM
+    device using `swtpm`.
+
+# AUTHORS
+
+Written by Martin Wimpress.
+
+# BUGS
+
+Submit bug reports online at:
+<https://github.com/quickemu-project/quickemu/issues>
+
+# SEE ALSO
+
+Full sources at: <https://github.com/quickemu-project/quickemu>
+
+quickemu(1), quickemu_conf(1), quickgui(1)

macrecovery

@@ -9,10 +9,14 @@ Copyright (c) 2019, vit9696
 from __future__ import print_function
 
 import argparse
+import binascii
 import datetime
+import hashlib
 import json
+import linecache
 import os
 import random
+import struct
 import sys
 import textwrap
 import time
@@ -79,6 +83,54 @@ def mlb_from_eeee(eeee):
 
   return '00000000000' + eeee + '00'
 
+def int_from_unsigned_bytes(bytes, byteorder):
+  if byteorder == 'little': bytes = bytes[::-1]
+  encoded = binascii.hexlify(bytes)
+  return int(encoded, 16)
+
+# zhangyoufu https://gist.github.com/MCJack123/943eaca762730ca4b7ae460b731b68e7#gistcomment-3061078 2021-10-08
+Apple_EFI_ROM_public_key_1 = 0xC3E748CAD9CD384329E10E25A91E43E1A762FF529ADE578C935BDDF9B13F2179D4855E6FC89E9E29CA12517D17DFA1EDCE0BEBF0EA7B461FFE61D94E2BDF72C196F89ACD3536B644064014DAE25A15DB6BB0852ECBD120916318D1CCDEA3C84C92ED743FC176D0BACA920D3FCF3158AFF731F88CE0623182A8ED67E650515F75745909F07D415F55FC15A35654D118C55A462D37A3ACDA08612F3F3F6571761EFCCBCC299AEE99B3A4FD6212CCFFF5EF37A2C334E871191F7E1C31960E010A54E86FA3F62E6D6905E1CD57732410A3EB0C6B4DEFDABE9F59BF1618758C751CD56CEF851D1C0EAA1C558E37AC108DA9089863D20E2E7E4BF475EC66FE6B3EFDCF
+
+ChunkListHeader = struct.Struct('<4sIBBBxQQQ')
+assert ChunkListHeader.size == 0x24
+
+Chunk = struct.Struct('<I32s')
+assert Chunk.size == 0x24
+
+def verify_chunklist(cnkpath):
+    with open(cnkpath, 'rb') as f:
+        hash_ctx = hashlib.sha256()
+        data = f.read(ChunkListHeader.size)
+        hash_ctx.update(data)
+        magic, header_size, file_version, chunk_method, signature_method, chunk_count, chunk_offset, signature_offset = ChunkListHeader.unpack(data)
+        assert magic == b'CNKL'
+        assert header_size == ChunkListHeader.size
+        assert file_version == 1
+        assert chunk_method == 1
+        assert signature_method in [1, 2]
+        assert chunk_count > 0
+        assert chunk_offset == 0x24
+        assert signature_offset == chunk_offset + Chunk.size * chunk_count
+        for i in range(chunk_count):
+            data = f.read(Chunk.size)
+            hash_ctx.update(data)
+            chunk_size, chunk_sha256 = Chunk.unpack(data)
+            yield chunk_size, chunk_sha256
+        digest = hash_ctx.digest()
+        if signature_method == 1:
+            data = f.read(256)
+            assert len(data) == 256
+            signature = int_from_unsigned_bytes(data, 'little')
+            plaintext = 0x1ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff003031300d0609608648016503040201050004200000000000000000000000000000000000000000000000000000000000000000 | int_from_unsigned_bytes(digest, 'big')
+            assert pow(signature, 0x10001, Apple_EFI_ROM_public_key_1) == plaintext
+        elif signature_method == 2:
+            data = f.read(32)
+            assert data == digest
+            raise RuntimeError('Chunklist missing digital signature')
+        else:
+            raise NotImplementedError
+        assert f.read(1) == b''
+
 def get_session(args):
   headers = {
     'Host'      : 'osrecovery.apple.com',
@@ -173,6 +225,26 @@ def save_image(url, sess, filename='', dir=''):
       sys.stdout.flush()
     print('\rDownload complete!')
 
+  return os.path.join(dir, os.path.basename(filename))
+
+def verify_image(dmgpath, cnkpath):
+  print('Verifying image with chunklist...')
+
+  with open (dmgpath, 'rb') as dmgf:
+    cnkcount = 0
+    for cnksize, cnkhash in verify_chunklist(cnkpath):
+      cnkcount += 1
+      print('\rChunk {} ({} bytes)'.format(cnkcount, cnksize), end='')
+      sys.stdout.flush()
+      cnk = dmgf.read(cnksize)
+      if len(cnk) != cnksize:
+        raise RuntimeError('Invalid chunk {} size: expected {}, read {}'.format(cnkcount, cnksize, len(cnk)))
+      if hashlib.sha256(cnk).digest() != cnkhash:
+        raise RuntimeError('Invalid chunk {}: hash mismatch'.format(cnkcount)) 
+    if dmgf.read(1) != b'':
+      raise RuntimeError('Invalid image: larger than chunklist')
+    print('\rImage verification complete!')
+
 def action_download(args):
   """
   Reference information for queries:
@@ -208,10 +280,23 @@ def action_download(args):
     print(info)
   print('Downloading ' + info[INFO_PRODUCT] + '...')
   dmgname = '' if args.basename == '' else args.basename + '.dmg'
-  save_image(info[INFO_IMAGE_LINK], info[INFO_IMAGE_SESS], dmgname, args.outdir)
+  dmgpath = save_image(info[INFO_IMAGE_LINK], info[INFO_IMAGE_SESS], dmgname, args.outdir)
   cnkname = '' if args.basename == '' else args.basename + '.chunklist'
-  save_image(info[INFO_SIGN_LINK], info[INFO_SIGN_SESS], cnkname, args.outdir)
+  cnkpath = save_image(info[INFO_SIGN_LINK], info[INFO_SIGN_SESS], cnkname, args.outdir)
-  return 0
+  try:
+    verify_image(dmgpath, cnkpath)
+    return 0
+  except Exception as err:
+    if isinstance(err, AssertionError) and str(err)=='':
+      try:
+        tb = sys.exc_info()[2]
+        while tb.tb_next:
+          tb = tb.tb_next
+        err = linecache.getline(tb.tb_frame.f_code.co_filename, tb.tb_lineno, tb.tb_frame.f_globals).strip()
+      except:
+        err = "Invalid chunklist"
+    print('\rImage verification failed. ({})'.format(err))
+    return 1
 
 def action_selfcheck(args):
   """

windowskey

@@ -0,0 +1,85 @@
+#!/usr/bin/env python3
+
+
+import html.parser
+import os
+import sys
+import urllib.request
+
+
+"""
+Download Windows product keys from MicroSoft
+"""
+
+key_page_url = "https://docs.microsoft.com/en-us/windows-server/get-started/kms-client-activation-keys"
+
+
+def usage():
+    script = os.path.basename(sys.argv[0])
+    message = f"""Usage: {script} [windows-version]
+
+To specify the version of Windows you'd like, pass a string that matches the
+name of the operating system you'd like to download. Case doesn't matter, so
+you can use "windows 10" or "Windows 10".
+
+e.g.
+
+    {script} "Windows 10"
+    {script} "enterprise"
+
+"""
+    print(message, file=sys.stderr)
+    sys.exit(0)
+
+
+def download_page(url):
+    response = urllib.request.urlopen(url)
+    return response.read().decode("utf-8")
+
+
+class WindowsKeyPageParser(html.parser.HTMLParser):
+    def __init__(self, *, convert_charrefs=True):
+        super().__init__(convert_charrefs=True)
+        self.product_keys = {}
+        self.parsing_os = False
+
+    def handle_starttag(self, tag, attrs):
+        self.parsing_os = tag == "td"
+
+    def handle_endtag(self, tag):
+        self.parsing_os = False
+
+    def handle_data(self, data):
+        if self.parsing_os:
+            self.stash_table_cell(data)
+
+    def stash_table_cell(self, data):
+        if "Windows" in data:
+            self.current_os = data
+        else:
+            product_key = data
+            self.product_keys[self.current_os] = product_key
+
+
+def find_keys_for_all_versions(markup):
+    parser = WindowsKeyPageParser()
+    parser.feed(markup)
+    return parser.product_keys
+
+
+if __name__ == "__main__":
+    try:
+        arg = sys.argv[1]
+    except IndexError:
+        windows_version = ""
+    else:
+        if arg in ["-h", "--help"]:
+            usage()
+        windows_version = arg
+
+    markup = download_page(key_page_url)
+    product_keys = find_keys_for_all_versions(markup)
+
+    for os_name, product_key in product_keys.items():
+        if windows_version.lower() in os_name.lower():
+            print(f"{os_name}: {product_key}")