quickemu/docs/quickget.1

.\" Automatically generated by Pandoc 2.2.3.2
.\"
.TH "QUICKGET" "1" "February 20, 2022" "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[] [\f[I]os\f[]] [\f[I]release\f[]] [\f[I]variant\f[]] |
[\f[I]OPTION\f[]]*
.SH DESCRIPTION
.PP
\f[B]quickget\f[] will download the requisite materials and prepare a
configuration for \f[C]quickemu\f[] to use to build and run
.SH OPTIONS
.TP
.B \f[B]version | \-version | \[en]version\f[]
show version (from Quickemu)
.RS
.RE
.TP
.B \f[B]list | list_csv | list_json\f[]
provide a csv list of all supported guest OSes, versions and variants.
.RS
.RE
.TP
.B \f[B][OS] [Release] [Variant]\f[]
specify the OS and release (and optional variant) if insufficient input
is provided a list of missing options will be reported and the script
will exit.
Variants may not apply and will be defaulted if not provided.
.RS
.RE
.SH NOTES
.SS Ubuntu Guest
.PP
\f[C]quickget\f[] will automatically download an Ubuntu release and
create the virtual machine configuration.
.IP
.nf
\f[C]
quickget\ ubuntu\ focal
quickemu\ \-\-vm\ ubuntu\-focal.conf
\f[]
.fi
.IP \[bu] 2
Complete the installation as normal.
.IP \[bu] 2
Post\-install:
.RS 2
.IP \[bu] 2
Install the SPICE agent (\f[C]spice\-vdagent\f[]) to enable copy/paste
and USB redirection
.RS 2
.IP \[bu] 2
\f[C]sudo\ apt\ install\ spice\-vdagent\f[]
.RE
.IP \[bu] 2
Install the SPICE WebDAV agent (\f[C]spice\-webdavd\f[]) to enable file
sharing.
.RS 2
.IP \[bu] 2
\f[C]sudo\ apt\ install\ spice\-webdavd\f[]
.RE
.RE
.SS Ubuntu devel (daily\-live) images
.PP
\f[C]quickget\f[] can also download/refresh devel images via
\f[C]zsync\f[] for Ubuntu developers and testers.
.IP
.nf
\f[C]
quickget\ ubuntu\ devel
quickemu\ \-\-vm\ ubuntu\-devel.conf
\f[]
.fi
.PP
You can run \f[C]quickget\ ubuntu\ devel\f[] 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[C]ubuntu\f[] with your preferred flavour.
.IP \[bu] 2
\f[C]kubuntu\f[] (Kubuntu)
.IP \[bu] 2
\f[C]lubuntu\f[] (Lubuntu)
.IP \[bu] 2
\f[C]ubuntu\-budgie\f[] (Ubuntu Budgie)
.IP \[bu] 2
\f[C]ubuntu\-kylin\f[] (Ubuntu Kylin)
.IP \[bu] 2
\f[C]ubuntu\-mate\f[] (Ubuntu MATE)
.IP \[bu] 2
\f[C]ubuntu\-studio\f[] (Ubuntu Studio)
.IP \[bu] 2
\f[C]ubuntu\f[] (Ubuntu)
.IP \[bu] 2
\f[C]xubuntu\f[] (Xubuntu)
.SS Other Linux Guests
.PP
\f[C]quickget\f[] also supports:
.IP \[bu] 2
\f[C]alma\f[] (Alma Linux)
.IP \[bu] 2
\f[C]alpine\f[] (Alpine Linux)
.IP \[bu] 2
\f[C]archlinux\f[] (Arch Linux)
.IP \[bu] 2
\f[C]arcolinux\f[] (Arco Linux)
.IP \[bu] 2
\f[C]cachyos\f[] (CachyOS)
.IP \[bu] 2
\f[C]debian\f[] (Debian)
.IP \[bu] 2
\f[C]elementary\f[] (elementary OS)
.IP \[bu] 2
\f[C]fedora\f[] (Fedora)
.IP \[bu] 2
\f[C]garuda\f[] (Garuda Linux)
.IP \[bu] 2
\f[C]gentoo\f[] (Gentoo)
.IP \[bu] 2
\f[C]haiku\f[] (Haiku)
.IP \[bu] 2
\f[C]kali\f[] (Kali)
.IP \[bu] 2
\f[C]kdeneon\f[] (KDE Neon)
.IP \[bu] 2
\f[C]kolibrios\f[] (KolibriOS)
.IP \[bu] 2
\f[C]linuxmint\-cinnamon\f[] (Linux Mint Cinnamon)
.IP \[bu] 2
\f[C]linuxmint\-mate\f[] (Linux Mint MATE)
.IP \[bu] 2
\f[C]linuxmint\-xfce\f[] (Linux Mint XFCE)
.IP \[bu] 2
\f[C]manjaro\-budgie\f[] (Manjaro Budgie)
.IP \[bu] 2
\f[C]manjaro\-cinnamon\f[] (Manjaro Cinnamon)
.IP \[bu] 2
\f[C]manjaro\-deepin\f[] (Manjaro Deepin)
.IP \[bu] 2
\f[C]manjaro\-gnome\f[] (Manjaro Gnome)
.IP \[bu] 2
\f[C]manjaro\-i3\f[] (Manjaro i3)
.IP \[bu] 2
\f[C]manjaro\-kde\f[] (Manjaro KDE)
.IP \[bu] 2
\f[C]manjaro\-mate\f[] (Manjaro MATE)
.IP \[bu] 2
\f[C]manjaro\-xfce\f[] (Manjaro XFCE)
.IP \[bu] 2
\f[C]mxlinux\-fluxbox\f[] (MX Linux Fluxbox)
.IP \[bu] 2
\f[C]mxlinux\-kde\f[] (MX Linux KDE)
.IP \[bu] 2
\f[C]mxlinux\-xfce\f[] (MX Linux XFCE)
.IP \[bu] 2
\f[C]nixos\-gnome\f[] (NixOS Gnome)
.IP \[bu] 2
\f[C]nixos\-minimal\f[] (NixOS Minimal)
.IP \[bu] 2
\f[C]nixos\-plasma5\f[] (NixOS KDE)
.IP \[bu] 2
\f[C]opensuse\f[] (openSUSE)
.IP \[bu] 2
\f[C]oraclelinux\f[] (Oracle Linux)
.IP \[bu] 2
\f[C]popos\f[] (Pop!_OS)
.IP \[bu] 2
\f[C]regolith\f[] (Regolith Linux)
.IP \[bu] 2
\f[C]rockylinux\f[] (Rocky Linux)
.IP \[bu] 2
\f[C]solus\f[] (Solus)
.IP \[bu] 2
\f[C]tails\f[] (Tails)
.IP \[bu] 2
\f[C]void\f[] (Void Linux)
.IP \[bu] 2
\f[C]zorin\f[] (Zorin OS)
.SS BSD Guest Support
.PP
\f[C]quickget\f[] also supports:
.IP \[bu] 2
\f[C]freebsd\f[] (FreeBSD)
.IP \[bu] 2
\f[C]openbsd\f[] (OpenBSD)
.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[C]debian\-bullseye.conf\f[]
.IP
.nf
\f[C]
guest_os="linux"
disk_img="debian\-bullseye/disk.qcow2"
iso="debian\-bullseye/firmware\-11.0.0\-amd64\-DVD\-1.iso"
\f[]
.fi
.PP
If you already have a collection of ISOs downloaded you can have
\f[C]quickget\f[] find and copy your existing file into the VM
directory.
.IP
.nf
\f[C]
\-\-isodir\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ :\ base\ path\ beneath\ which\ to\ find\ local\ ISO\ copy
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ if\ a\ matching\ file\ is\ found\ it\ will\ be\ copied\ to\ the\ VM\ directory
\-\-localiso\ \ \ \ \ \ \ \ \ \ \ \ \ \ :\ optional\ local\ ISO\ filename\ \-\ defaults\ to\ target\ filename
\f[]
.fi
.PP
\f[C]quickget\f[] will then continue to \f[C]wget\f[] or \f[C]zsync\f[]
using that file as a prior copy.
If the target file exists in the VM directory \f[C]quickget\f[] will
raise an error if you run it with \f[C]\-\-isodir\f[]
.IP \[bu] 2
Use \f[C]quickemu\f[] to start the virtual machine:
.IP
.nf
\f[C]
quickemu\ \-\-vm\ debian\-bullseye.conf
\f[]
.fi
.IP \[bu] 2
Complete the installation as normal.
.IP \[bu] 2
Post\-install:
.RS 2
.IP \[bu] 2
Install the SPICE agent (\f[C]spice\-vdagent\f[]) to enable copy/paste
and USB redirection.
.IP \[bu] 2
Install the SPICE WebDAV agent (\f[C]spice\-webdavd\f[]) to enable file
sharing.
.RE
.SS macOS Guest
.PP
\f[C]quickget\f[] 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[]
.fi
.PP
macOS \f[C]high\-sierra\f[], \f[C]mojave\f[], \f[C]catalina\f[],
\f[C]big\-sur\f[] and \f[C]monterey\f[] are supported.
.IP \[bu] 2
Use cursor keys and enter key to select the \f[B]macOS Base System\f[]
.IP \[bu] 2
From \f[B]macOS Utilities\f[]
.RS 2
.IP \[bu] 2
Click \f[B]Disk Utility\f[] and \f[B]Continue\f[]
.RS 2
.IP \[bu] 2
On macOS Catalina, Big Sur & Monterey
.RS 2
.IP \[bu] 2
Select \f[C]Apple\ Inc.\ VirtIO\ Block\ Media\f[] from the list and
click \f[B]Erase\f[].
.RE
.IP \[bu] 2
On macOS Mojave and High Sierra
.RS 2
.IP \[bu] 2
Select \f[C]QEMU\ HARDDISK\ Media\f[] (~103.08GB) from the list and
click \f[B]Erase\f[].
.RE
.RE
.IP \[bu] 2
Enter a \f[C]Name:\f[] for the disk and click \f[B]Erase\f[].
.IP \[bu] 2
Click \f[B]Done\f[].
.IP \[bu] 2
Close Disk Utility
.RE
.IP \[bu] 2
From \f[B]macOS Utilities\f[]
.RS 2
.IP \[bu] 2
Click \f[B]Reinstall macOS\f[] and \f[B]Continue\f[]
.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[]
.IP \[bu] 2
On the subsequent reboots use cursor keys and enter key to select the
disk you named
.RE
.PP
The default macOS configuration looks like this:
.IP
.nf
\f[C]
guest_os="macos"
img="macos\-catalina/RecoveryImage.img"
disk_img="macos\-catalina/disk.qcow2"
macos_release="catalina"
\f[]
.fi
.IP \[bu] 2
\f[C]guest_os="macos"\f[] instructs Quickemu to optimise for macOS.
.IP \[bu] 2
\f[C]macos_release="catalina"\f[] 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[]
.IP \[bu] 2
Big Sur
.IP \[bu] 2
Monterey
.RE
.IP \[bu] 2
\f[C]quickemu\f[] 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[C]usb\-tablet\f[] (http://philjordan.eu/osx-virt/) is used for
the mouse.
.IP \[bu] 2
VirtIO Network (\f[C]virtio\-net\f[]) is supported and enabled on macOS
Big Sur and newer but previous releases use \f[C]vmxnet3\f[].
.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
Full Duplex audio works on macOS High Sierra, Mojave and Catalina.
.RS 2
.IP \[bu] 2
\f[B]macOS Big Sur and Monterey have no audio at all\f[].
.RE
.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[].
.SS Windows 8.1, 10 & 11 Guests
.PP
\f[C]quickget\f[] can automatically download Windows 8.1, Windows
10 (https://www.microsoft.com/en-gb/software-download/windows10ISO) and
Windows 11 (https://www.microsoft.com/en-gb/software-download/windows11)
along with the VirtIO drivers for
Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/)
and creates a virtual machine configuration.
.IP
.nf
\f[C]
quickget\ windows\ 11
quickemu\ \-\-vm\ windows\-11.conf
\f[]
.fi
.IP \[bu] 2
Complete the installation as you normally would.
.IP \[bu] 2
All relevant drivers and services should be installed automatically.
.SS Regional versions
.PP
By default \f[C]quickget\f[] will download the \f[I]\[lq]English
International\[rq]\f[] release, but you can optionally specify one of
the supported languages: For example:
.IP
.nf
\f[C]
quickget\ windows\ 11\ "Chinese\ (Traditional)"
\f[]
.fi
.PP
The default Windows 11 configuration looks like this:
.IP
.nf
\f[C]
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"
\f[]
.fi
.IP \[bu] 2
\f[C]guest_os="windows"\f[] instructs \f[C]quickemu\f[] to optimise for
Windows.
.IP \[bu] 2
\f[C]fixed_iso=\f[] specifies the ISO image that provides VirtIO
drivers.
.IP \[bu] 2
\f[C]tpm="on"\f[] instructs \f[C]quickemu\f[] to create a software
emulated TPM device using \f[C]swtpm\f[].
.SS BSD Guests
.PP
\f[C]quickemu\f[] supports FreeBSD and OpenBSD.
.IP
.nf
\f[C]
quickget\ freebsd\ 13_0
quickemu\ \-\-vm\ freebsd\-13_0.conf
\f[]
.fi
.SS Other Guests
.IP \[bu] 2
\f[C]android\f[] (Android x86)
.SS Haiku Guests
.PP
\f[C]quickemu\f[] supports Haiku (https://www.haiku-os.org/).
.IP
.nf
\f[C]
quickget\ quickget\ haiku\ r1beta3\-x86_64
quickemu\ \-\-vm\ haiku\-r1beta3\-x86_64.conf
\f[]
.fi
.PP
At the moment the only way to share files between host and a Haiku guest
is by using SSH (having a SSH server running on the host):
.PP
On guest:
.IP
.nf
\f[C]
scp\ example.txt\ user\@host\-local\-ip:/home/user\ #\ sending\ a\ file\ from\ guest\ to\ host
scp\ user\@host\-local\-ip:/home/user/example.txt\ .\ #\ receiving\ a\ file\ from\ host\ to\ guest
\f[]
.fi
.PP
\f[C]quickget\f[] cannot automatically download and create virtual
machines for Haiku nightly versions, but they work if the ISO and
configuration are set up manually.
.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.