694 lines
20 KiB
Groff
694 lines
20 KiB
Groff
.\" Automatically generated by Pandoc 3.1.13
|
|
.\"
|
|
.TH "QUICKGET" "1" "April 22, 2024" "quickget" "Quickget User Manual"
|
|
.SH NAME
|
|
quickget \- download and prepare materials for building a quickemu VM
|
|
.SH SYNOPSIS
|
|
\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
|
|
\f[B]quickget\f[R] will download the requisite materials and prepare a
|
|
configuration for \f[CR]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]\f[CB]\-\-show\-iso\-url\f[B] | \-s\f[R] {\f[B]os\f[R]} {\f[B]release\f[R]} [\f[B]edition\f[R]]
|
|
show ISO download URL
|
|
.TP
|
|
\f[B]\f[CB]\-\-test\-iso\-url\f[B] | \-t\f[R] {\f[B]os\f[R]} {\f[B]release\f[R]} [\f[B]edition\f[R]]
|
|
test if ISO is available
|
|
.TP
|
|
\f[B]\f[CB]\-\-open\-distro\-homepage\f[B] | \-o\f[R] {\f[B]os\f[R]}
|
|
open OS homepage in browser
|
|
.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 Creating Linux guests 🐧
|
|
.SS Ubuntu
|
|
\f[CR]quickget\f[R] will automatically download an Ubuntu release and
|
|
create the virtual machine configuration.
|
|
.IP
|
|
.EX
|
|
quickget ubuntu 22.04
|
|
quickemu \-\-vm ubuntu\-22.04.conf
|
|
.EE
|
|
.IP \[bu] 2
|
|
Complete the installation as normal.
|
|
.IP \[bu] 2
|
|
Post\-install:
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
Install the SPICE agent (\f[CR]spice\-vdagent\f[R]) in the guest to
|
|
enable copy/paste and USB redirection
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
\f[CR]sudo apt install spice\-vdagent\f[R]
|
|
.RE
|
|
.IP \[bu] 2
|
|
Install the SPICE WebDAV agent (\f[CR]spice\-webdavd\f[R]) in the guest
|
|
to enable file sharing.
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
\f[CR]sudo apt install spice\-webdavd\f[R]
|
|
.RE
|
|
.RE
|
|
.SS Ubuntu daily\-live images
|
|
\f[CR]quickget\f[R] can also download/refresh daily\-live images via
|
|
\f[CR]zsync\f[R] for Ubuntu developers and testers.
|
|
.IP
|
|
.EX
|
|
quickget ubuntu daily\-live
|
|
quickemu \-\-vm ubuntu\-daily\-live.conf
|
|
.EE
|
|
.PP
|
|
You can run \f[CR]quickget ubuntu daily\-live\f[R] to refresh your daily
|
|
development image as often as you like, it will even automatically
|
|
switch to a new series.
|
|
.SS Ubuntu Flavours
|
|
All the official Ubuntu flavours are supported, just replace
|
|
\f[CR]ubuntu\f[R] with your preferred flavour.
|
|
.PP
|
|
The project \c
|
|
.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines
|
|
wiki
|
|
.UE \c
|
|
\ may have further information.
|
|
.IP \[bu] 2
|
|
\f[CR]edubuntu\f[R] (Edubuntu)
|
|
.IP \[bu] 2
|
|
\f[CR]kubuntu\f[R] (Kubuntu)
|
|
.IP \[bu] 2
|
|
\f[CR]lubuntu\f[R] (Lubuntu)
|
|
.IP \[bu] 2
|
|
\f[CR]ubuntu\-budgie\f[R] (Ubuntu Budgie)
|
|
.IP \[bu] 2
|
|
\f[CR]ubuntucinnamon\f[R] (Ubuntu Cinnamon)
|
|
.IP \[bu] 2
|
|
\f[CR]ubuntukylin\f[R] (Ubuntu Kylin)
|
|
.IP \[bu] 2
|
|
\f[CR]ubuntu\-mate\f[R] (Ubuntu MATE)
|
|
.IP \[bu] 2
|
|
\f[CR]ubuntu\-server\f[R] (Ubuntu Server)
|
|
.IP \[bu] 2
|
|
\f[CR]ubuntustudio\f[R] (Ubuntu Studio)
|
|
.IP \[bu] 2
|
|
\f[CR]ubuntu\f[R] (Ubuntu)
|
|
.IP \[bu] 2
|
|
\f[CR]ubuntu\-unity\f[R] (Ubuntu Unity)
|
|
.IP \[bu] 2
|
|
\f[CR]xubuntu\f[R] (Xubuntu)
|
|
.PP
|
|
You can also use \f[CR]quickget\f[R] with advanced options :
|
|
.IP
|
|
.EX
|
|
\-[12345] <os> : Show info* about OS
|
|
\-\-download (\-d) <os> <re> [ed] : Download the ISO only; no VM configuration
|
|
\-\-create\-config (\-cc) <os> [path/url]: Create default VM config for image
|
|
\-\-open\-homepage (\-o) <os> : Open homepage for the OS
|
|
\-\-version (\-v) : Show version
|
|
\-\-help (\-h) : Show this help message
|
|
\-\-url (\-u) <os> <re> [ed] : Show download URL for an OS release/edition
|
|
\-\-check (\-c) <os> [re] [ed] : Check download an OS release/edition is available
|
|
\-\-url\-all (\-ua) <os> : Show all download URLs for an OS
|
|
\-\-check\-all (\-ca) <os> : Check all downloads for an OS are available
|
|
\-\-list (\-l) : List all supported systems in plain text
|
|
\-\-list\-csv (\-lc) : List all supported systems in csv format
|
|
\-\-list\-json (\-lj) : List all supported systems in json format
|
|
\-\-list\-urls (\-lu) : List all supported systems download URLs
|
|
\-\-test\-urls (\-tu) : Check all downloads for all OSs are available
|
|
.EE
|
|
.PP
|
|
Here are some typical uses
|
|
.IP
|
|
.EX
|
|
# show an OS ISO download URL for {os} {release} [edition]
|
|
quickget \-\-url fedora 38 Silverblue
|
|
# test if an OS ISO is available for {os} {release} [edition]
|
|
quickget \-\-check nixos unstable plasma5
|
|
# open an OS distribution homepage in a browser
|
|
quickget \-\-open\-homepage ubuntu\-mate
|
|
# Only download image file into current directory, without creating VM
|
|
quickget \-\-download elementary 7.1
|
|
.EE
|
|
.PP
|
|
The \f[CR]\-\-url\f[R], \f[CR]\-\-check\f[R], and
|
|
\f[CR]\-\-download\f[R] options are fully functional for all operating
|
|
systems, including Windows and macOS.
|
|
.PP
|
|
Further information is available from the project \c
|
|
.UR https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features
|
|
wiki
|
|
.UE \c
|
|
.SS Other Operating Systems
|
|
\f[CR]quickget\f[R] also supports:
|
|
.IP \[bu] 2
|
|
\f[CR]alma\f[R] (Alma Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]alpine\f[R] (Alpine Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]android\f[R] (Android x86)
|
|
.IP \[bu] 2
|
|
\f[CR]antix\f[R] (Antix)
|
|
.IP \[bu] 2
|
|
\f[CR]archcraft\f[R] (Archcraft)
|
|
.IP \[bu] 2
|
|
\f[CR]archlinux\f[R] (Arch Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]arcolinux\f[R] (Arco Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]artixlinux\f[R] (Artix Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]athenaos\f[R] (Athena OS)
|
|
.IP \[bu] 2
|
|
\f[CR]batocera\f[R] (Batocera)
|
|
.IP \[bu] 2
|
|
\f[CR]bazzite\f[R] (Bazzite)
|
|
.IP \[bu] 2
|
|
\f[CR]biglinux\f[R] (BigLinux)
|
|
.IP \[bu] 2
|
|
\f[CR]blendos\f[R] (BlendOS)
|
|
.IP \[bu] 2
|
|
\f[CR]bodhi\f[R] (Bodhi)
|
|
.IP \[bu] 2
|
|
\f[CR]bunsenlabs\f[R] (BunsenLabs)
|
|
.IP \[bu] 2
|
|
\f[CR]cachyos\f[R] (CachyOS)
|
|
.IP \[bu] 2
|
|
\f[CR]centos\-stream\f[R] (CentOS Stream)
|
|
.IP \[bu] 2
|
|
\f[CR]chimeralinux\f[R] (Chimera Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]crunchbang++\f[R] (#!++)
|
|
.IP \[bu] 2
|
|
\f[CR]debian\f[R] (Debian)
|
|
.IP \[bu] 2
|
|
\f[CR]deepin\f[R] (Deepin)
|
|
.IP \[bu] 2
|
|
\f[CR]devuan\f[R] (Devuan)
|
|
.IP \[bu] 2
|
|
\f[CR]dragonflybsd\f[R] (DragonFlyBSD)
|
|
.IP \[bu] 2
|
|
\f[CR]easyos\f[R] (EasyOS)
|
|
.IP \[bu] 2
|
|
\f[CR]elementary\f[R] (elementary OS)
|
|
.IP \[bu] 2
|
|
\f[CR]endeavouros\f[R] (EndeavourOS)
|
|
.IP \[bu] 2
|
|
\f[CR]endless\f[R] (Endless OS)
|
|
.IP \[bu] 2
|
|
\f[CR]fedora\f[R] (Fedora)
|
|
.IP \[bu] 2
|
|
\f[CR]freebsd\f[R] (FreeBSD)
|
|
.IP \[bu] 2
|
|
\f[CR]freedos\f[R] (FreeDOS)
|
|
.IP \[bu] 2
|
|
\f[CR]garuda\f[R] (Garuda Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]gentoo\f[R] (Gentoo)
|
|
.IP \[bu] 2
|
|
\f[CR]ghostbsd\f[R] (GhostBSD)
|
|
.IP \[bu] 2
|
|
\f[CR]gnomeos\f[R] (GNOME OS)
|
|
.IP \[bu] 2
|
|
\f[CR]guix\f[R] (Guix)
|
|
.IP \[bu] 2
|
|
\f[CR]haiku\f[R] (Haiku)
|
|
.IP \[bu] 2
|
|
\f[CR]holoiso\f[R] (SteamOS HoloISO)
|
|
.IP \[bu] 2
|
|
\f[CR]kali\f[R] (Kali)
|
|
.IP \[bu] 2
|
|
\f[CR]kdeneon\f[R] (KDE Neon)
|
|
.IP \[bu] 2
|
|
\f[CR]kolibrios\f[R] (KolibriOS)
|
|
.IP \[bu] 2
|
|
\f[CR]linuxlite\f[R] (Linux Lite)
|
|
.IP \[bu] 2
|
|
\f[CR]linuxmint\f[R] (Linux Mint)
|
|
.IP \[bu] 2
|
|
\f[CR]lmde\f[R] (Linux Mint Debian Edition)
|
|
.IP \[bu] 2
|
|
\f[CR]mageia\f[R] (Mageia)
|
|
.IP \[bu] 2
|
|
\f[CR]manjaro\f[R] (Manjaro)
|
|
.IP \[bu] 2
|
|
\f[CR]mxlinux\f[R] (MX Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]netboot\f[R] (netboot.xyz)
|
|
.IP \[bu] 2
|
|
\f[CR]netbsd\f[R] (NetBSD)
|
|
.IP \[bu] 2
|
|
\f[CR]nitrux\f[R] (Nitrux)
|
|
.IP \[bu] 2
|
|
\f[CR]nixos\f[R] (NixOS)
|
|
.IP \[bu] 2
|
|
\f[CR]openbsd\f[R] (OpenBSD)
|
|
.IP \[bu] 2
|
|
\f[CR]openindiana\f[R] (OpenIndiana)
|
|
.IP \[bu] 2
|
|
\f[CR]opensuse\f[R] (openSUSE)
|
|
.IP \[bu] 2
|
|
\f[CR]oraclelinux\f[R] (Oracle Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]parrotsec\f[R] (Parrot Security)
|
|
.IP \[bu] 2
|
|
\f[CR]peppermint\f[R] (PeppermintOS)
|
|
.IP \[bu] 2
|
|
\f[CR]popos\f[R] (Pop!_OS)
|
|
.IP \[bu] 2
|
|
\f[CR]porteus\f[R] (Porteus)
|
|
.IP \[bu] 2
|
|
\f[CR]primtux\f[R] (PrimTux)
|
|
.IP \[bu] 2
|
|
\f[CR]pureos\f[R] (PureOS)
|
|
.IP \[bu] 2
|
|
\f[CR]reactos\f[R] (ReactOS)
|
|
.IP \[bu] 2
|
|
\f[CR]rebornos\f[R] (RebornOS)
|
|
.IP \[bu] 2
|
|
\f[CR]rockylinux\f[R] (Rocky Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]siduction\f[R] (Siduction)
|
|
.IP \[bu] 2
|
|
\f[CR]slackware\f[R] (Slackware)
|
|
.IP \[bu] 2
|
|
\f[CR]slax\f[R] (Slax)
|
|
.IP \[bu] 2
|
|
\f[CR]slint\f[R] (Slint)
|
|
.IP \[bu] 2
|
|
\f[CR]slitaz\f[R] (SliTaz)
|
|
.IP \[bu] 2
|
|
\f[CR]solus\f[R] (Solus)
|
|
.IP \[bu] 2
|
|
\f[CR]sparkylinux\f[R] (SparkyLinux)
|
|
.IP \[bu] 2
|
|
\f[CR]spirallinux\f[R] (SpiralLinux)
|
|
.IP \[bu] 2
|
|
\f[CR]tails\f[R] (Tails)
|
|
.IP \[bu] 2
|
|
\f[CR]tinycore\f[R] (Tiny Core Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]trisquel\f[R] (Trisquel)
|
|
.IP \[bu] 2
|
|
\f[CR]truenas\-core\f[R] (TrueNAS Core)
|
|
.IP \[bu] 2
|
|
\f[CR]truenas\-scale\f[R] (TrueNAS Scale)
|
|
.IP \[bu] 2
|
|
\f[CR]tuxedo\-os\f[R] (Tuxedo OS)
|
|
.IP \[bu] 2
|
|
\f[CR]vanillaos\f[R] (Vanilla OS)
|
|
.IP \[bu] 2
|
|
\f[CR]void\f[R] (Void Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]vxlinux\f[R] (VX Linux)
|
|
.IP \[bu] 2
|
|
\f[CR]zorin\f[R] (Zorin OS)
|
|
.SS \c
|
|
.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests
|
|
Custom Linux guests
|
|
.UE \c
|
|
Or you can download a Linux image and manually create a VM
|
|
configuration.
|
|
.IP \[bu] 2
|
|
Download a .iso image of a Linux distribution
|
|
.IP \[bu] 2
|
|
Create a VM configuration file; for example
|
|
\f[CR]debian\-bullseye.conf\f[R]
|
|
.IP
|
|
.EX
|
|
guest_os=\[dq]linux\[dq]
|
|
disk_img=\[dq]debian\-bullseye/disk.qcow2\[dq]
|
|
iso=\[dq]debian\-bullseye/firmware\-11.0.0\-amd64\-DVD\-1.iso\[dq]
|
|
.EE
|
|
.IP \[bu] 2
|
|
Use \f[CR]quickemu\f[R] to start the virtual machine:
|
|
.IP
|
|
.EX
|
|
quickemu \-\-vm debian\-bullseye.conf
|
|
.EE
|
|
.IP \[bu] 2
|
|
Complete the installation as normal.
|
|
.IP \[bu] 2
|
|
Post\-install:
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
Install the SPICE agent (\f[CR]spice\-vdagent\f[R]) in the guest to
|
|
enable copy/paste and USB redirection.
|
|
.IP \[bu] 2
|
|
Install the SPICE WebDAV agent (\f[CR]spice\-webdavd\f[R]) in the guest
|
|
to enable file sharing.
|
|
.RE
|
|
.SS \c
|
|
.UR https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests
|
|
Creating macOS Guests
|
|
.UE \c
|
|
\ 🍏
|
|
\f[CR]quickget\f[R] automatically downloads a macOS recovery image and
|
|
creates a virtual machine configuration.
|
|
.IP
|
|
.EX
|
|
quickget macos catalina
|
|
quickemu \-\-vm macos\-catalina.conf
|
|
.EE
|
|
.PP
|
|
macOS \f[CR]high\-sierra\f[R], \f[CR]mojave\f[R], \f[CR]catalina\f[R],
|
|
\f[CR]big\-sur\f[R], \f[CR]monterey\f[R], \f[CR]ventura\f[R] and
|
|
\f[CR]sonoma\f[R] are supported.
|
|
.IP \[bu] 2
|
|
Use cursor keys and enter key to select the \f[B]macOS Base System\f[R]
|
|
.IP \[bu] 2
|
|
From \f[B]macOS Utilities\f[R]
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R]
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
Select \f[CR]QEMU HARDDISK Media\f[R] (\[ti]103.08GB) from the list (on
|
|
Big Sur and above use \f[CR]Apple Inc. VirtIO Block Device\f[R]) and
|
|
click \f[B]Erase\f[R].
|
|
.IP \[bu] 2
|
|
Enter a \f[CR]Name:\f[R] for the disk
|
|
.IP \[bu] 2
|
|
If you are installing macOS Mojave or later (Catalina, Big Sur,
|
|
Monterey, Ventura and Sonoma), choose any of the APFS options as the
|
|
filesystem.
|
|
MacOS Extended may not work.
|
|
.RE
|
|
.IP \[bu] 2
|
|
Click \f[B]Erase\f[R].
|
|
.IP \[bu] 2
|
|
Click \f[B]Done\f[R].
|
|
.IP \[bu] 2
|
|
Close Disk Utility
|
|
.RE
|
|
.IP \[bu] 2
|
|
From \f[B]macOS Utilities\f[R]
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
Click \f[B]Reinstall macOS\f[R] and \f[B]Continue\f[R]
|
|
.RE
|
|
.IP \[bu] 2
|
|
Complete the installation as you normally would.
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
On the first reboot use cursor keys and enter key to select \f[B]macOS
|
|
Installer\f[R]
|
|
.IP \[bu] 2
|
|
On the subsequent reboots use cursor keys and enter key to select the
|
|
disk you named
|
|
.RE
|
|
.IP \[bu] 2
|
|
Once you have finished installing macOS you will be presented with an
|
|
the out\-of\-the\-box first\-start wizard to configure various options
|
|
and set up your username and password
|
|
.IP \[bu] 2
|
|
OPTIONAL: After you have concluded the out\-of\-the\-box wizard, you may
|
|
want to enable the TRIM feature that the computer industry created for
|
|
SSD disks.
|
|
This feature in our macOS installation will allow QuickEmu to compact
|
|
(shrink) your macOS disk image whenever you delete files inside the
|
|
Virtual Machine.
|
|
Without this step your macOS disk image will only ever get larger and
|
|
will not shrink even when you delete lots of data inside macOS.
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
To enable TRIM, open the Terminal application and type the following
|
|
command followed by pressing enter to tell macos to use the TRIM command
|
|
on the hard disk when files are deleted:
|
|
.RE
|
|
.IP
|
|
.EX
|
|
sudo trimforce enable
|
|
.EE
|
|
.PP
|
|
You will be prompted to enter your account\[cq]s password to gain the
|
|
privilege needed.
|
|
Once you\[cq]ve entered your password and pressed enter the command will
|
|
request confirmation in the form of two questions that require you to
|
|
type y (for a \[lq]yes\[rq] response) followed by enter to confirm.
|
|
.PP
|
|
If you press enter without first typing y the system will consider that
|
|
a negative response as though you said \[lq]no\[rq]:
|
|
.IP
|
|
.EX
|
|
IMPORTANT NOTICE: This tool force\-enables TRIM for all relevant attached devices, even though such devices may not have been validated for data integrity while using TRIM. Use of this tool to enable TRIM may result in unintended data loss or data corruption. It should not be used in a commercial operating environment or with important data. Before using this tool, you should back up all of your data and regularly back up data while TRIM is enabled. This tool is provided on an \[dq]as is\[dq] basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON\-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS TOOL OR ITS USE ALONE OR IN COMBINATION WITH YOUR DEVICES, SYSTEMS, OR SERVICES. BY USING THIS TOOL TO ENABLE TRIM, YOU AGREE THAT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, USE OF THE TOOL IS AT YOUR SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH YOU.
|
|
Are you sure you with to proceed (y/N)?
|
|
.EE
|
|
.PP
|
|
And a second confirmation once you\[cq]ve confirmed the previous one:
|
|
.IP
|
|
.EX
|
|
Your system will immediately reboot when this is complete.
|
|
Is this OK (y/N)?
|
|
.EE
|
|
.PP
|
|
As the last message states, your system will automatically reboot as
|
|
soon as the command completes.
|
|
.PP
|
|
The default macOS configuration looks like this:
|
|
.IP
|
|
.EX
|
|
guest_os=\[dq]macos\[dq]
|
|
img=\[dq]macos\-catalina/RecoveryImage.img\[dq]
|
|
disk_img=\[dq]macos\-catalina/disk.qcow2\[dq]
|
|
macos_release=\[dq]catalina\[dq]
|
|
.EE
|
|
.IP \[bu] 2
|
|
\f[CR]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
|
|
macOS.
|
|
.IP \[bu] 2
|
|
\f[CR]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to
|
|
optimise for a particular macOS release.
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
For example VirtIO Network and Memory Ballooning are available in Big
|
|
Sur and newer, but not previous releases.
|
|
.IP \[bu] 2
|
|
And VirtIO Block Media (disks) are supported/stable in Catalina and
|
|
newer.
|
|
.RE
|
|
.SS macOS compatibility
|
|
There are some considerations when running macOS via Quickemu.
|
|
.IP \[bu] 2
|
|
Supported macOS releases:
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
High Sierra
|
|
.IP \[bu] 2
|
|
Mojave
|
|
.IP \[bu] 2
|
|
Catalina \f[B](Recommended)\f[R]
|
|
.IP \[bu] 2
|
|
Big Sur
|
|
.IP \[bu] 2
|
|
Monterey
|
|
.IP \[bu] 2
|
|
Ventura
|
|
.IP \[bu] 2
|
|
Sonoma
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[CR]quickemu\f[R] will automatically download the required \c
|
|
.UR https://github.com/acidanthera/OpenCorePkg
|
|
OpenCore
|
|
.UE \c
|
|
\ bootloader and OVMF firmware from \c
|
|
.UR https://github.com/kholia/OSX-KVM
|
|
OSX\-KVM
|
|
.UE \c
|
|
\&.
|
|
.IP \[bu] 2
|
|
Optimised by default, but no GPU acceleration is available.
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
Host CPU vendor is detected and guest CPU is optimised accordingly.
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR https://www.kraxel.org/blog/2019/06/macos-qemu-guest/
|
|
VirtIO Block Media
|
|
.UE \c
|
|
\ is used for the system disk where supported.
|
|
.IP \[bu] 2
|
|
\c
|
|
.UR http://philjordan.eu/osx-virt/
|
|
VirtIO \f[CR]usb\-tablet\f[R]
|
|
.UE \c
|
|
\ is used for the mouse.
|
|
.IP \[bu] 2
|
|
VirtIO Network (\f[CR]virtio\-net\f[R]) is supported and enabled on
|
|
macOS Big Sur and newer but previous releases use \f[CR]vmxnet3\f[R].
|
|
.IP \[bu] 2
|
|
VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and
|
|
newer but disabled for other support macOS releases.
|
|
.RE
|
|
.IP \[bu] 2
|
|
USB host and SPICE pass\-through is:
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
UHCI (USB 2.0) on macOS Catalina and earlier.
|
|
.IP \[bu] 2
|
|
XHCI (USB 3.0) on macOS Big Sur and newer.
|
|
.RE
|
|
.IP \[bu] 2
|
|
Display resolution can only be changed via macOS System Preferences.
|
|
.IP \[bu] 2
|
|
\f[B]Full Duplex audio requires \c
|
|
.UR https://github.com/chris1111/VoodooHDA-OC
|
|
VoodooHDA OC
|
|
.UE \c
|
|
\ or pass\-through a USB audio\-device to the macOS guest VM\f[R].
|
|
.IP \[bu] 2
|
|
NOTE!
|
|
\c
|
|
.UR https://disable-gatekeeper.github.io/
|
|
Gatekeeper
|
|
.UE \c
|
|
\ and \c
|
|
.UR https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection
|
|
System Integrity Protection (SIP)
|
|
.UE \c
|
|
\ need to be disabled to install VoodooHDA OC
|
|
.IP \[bu] 2
|
|
File sharing between guest and host is available via \c
|
|
.UR https://wiki.qemu.org/Documentation/9psetup
|
|
virtio\-9p
|
|
.UE \c
|
|
\ and \c
|
|
.UR https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24
|
|
SPICE webdavd
|
|
.UE \c
|
|
\&.
|
|
.IP \[bu] 2
|
|
Copy/paste via SPICE agent is \f[B]not available on macOS\f[R].
|
|
.SS macOS App Store
|
|
If you see \f[I]\[lq]Your device or computer could not be
|
|
verified\[rq]\f[R] when you try to login to the App Store, make sure
|
|
that your wired ethernet device is \f[CR]en0\f[R].
|
|
Use \f[CR]ifconfig\f[R] in a terminal to verify this.
|
|
.PP
|
|
If the wired ethernet device is not \f[CR]en0\f[R], then then go to
|
|
\f[I]System Preferences\f[R] \-> \f[I]Network\f[R], delete all the
|
|
network devices and apply the changes.
|
|
Next, open a terminal and run the following:
|
|
.IP
|
|
.EX
|
|
sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
|
|
.EE
|
|
.PP
|
|
Now reboot, and the App Store should work.
|
|
.SS \c
|
|
.UR https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines
|
|
Creating Windows guests
|
|
.UE \c
|
|
\ 🪟
|
|
\f[CR]quickget\f[R] can download \c
|
|
.UR https://www.microsoft.com/software-download/windows10
|
|
\f[B]Windows 10\f[R]
|
|
.UE \c
|
|
\ and \c
|
|
.UR https://www.microsoft.com/software-download/windows11
|
|
\f[B]Windows 11\f[R]
|
|
.UE \c
|
|
\ automatically and create an optimised virtual machine configuration.
|
|
This configuration also includes the \c
|
|
.UR https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/
|
|
VirtIO drivers for Windows
|
|
.UE \c
|
|
\&.
|
|
.PP
|
|
\f[B]Windows 8.1\f[R] is also supported but doesn\[cq]t feature any
|
|
automated installation or driver optimisation.
|
|
.PP
|
|
\f[CR]quickget\f[R] can also download \c
|
|
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-10-enterprise
|
|
Windows 10 LTSC
|
|
.UE \c
|
|
\ and Windows Server \c
|
|
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-server-2012-r2
|
|
2012\-r2
|
|
.UE \c
|
|
, \c
|
|
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-server-2016
|
|
2016
|
|
.UE \c
|
|
, \c
|
|
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-server-2019
|
|
2019
|
|
.UE \c
|
|
, and \c
|
|
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-server-2022
|
|
2022
|
|
.UE \c
|
|
\&.
|
|
No automated installation is supported for these releases.
|
|
.IP
|
|
.EX
|
|
quickget windows 11
|
|
quickemu \-\-vm windows\-11.conf
|
|
.EE
|
|
.IP \[bu] 2
|
|
Complete the installation as you normally would.
|
|
.IP \[bu] 2
|
|
All relevant drivers and services should be installed automatically.
|
|
.IP \[bu] 2
|
|
A local administrator user account is automatically created, with these
|
|
credentials:
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
Username: \f[CR]Quickemu\f[R]
|
|
.IP \[bu] 2
|
|
Password: \f[CR]quickemu\f[R]
|
|
.RE
|
|
.SS Regional versions
|
|
By default \f[CR]quickget\f[R] will download the \f[I]\[lq]English
|
|
International\[rq]\f[R] release (\f[I]\[lq]English (United
|
|
States)\[rq]\f[R] for server releases), but you can optionally specify
|
|
one of the supported languages: For example:
|
|
.IP
|
|
.EX
|
|
quickget windows 11 \[dq]Chinese (Traditional)\[dq]
|
|
.EE
|
|
.PP
|
|
The default Windows 11 configuration looks like this:
|
|
.IP
|
|
.EX
|
|
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]off\[dq]
|
|
.EE
|
|
.IP \[bu] 2
|
|
\f[CR]guest_os=\[dq]windows\[dq]\f[R] instructs \f[CR]quickemu\f[R] to
|
|
optimise for Windows.
|
|
.IP \[bu] 2
|
|
\f[CR]fixed_iso=\f[R] specifies the ISO image that provides VirtIO
|
|
drivers.
|
|
.IP \[bu] 2
|
|
\f[CR]tpm=\[dq]on\[dq]\f[R] instructs \f[CR]quickemu\f[R] to create a
|
|
software emulated TPM device using \f[CR]swtpm\f[R].
|
|
.SH AUTHORS
|
|
Written by Martin Wimpress.
|
|
.SH BUGS
|
|
Submit bug reports online at: \c
|
|
.UR https://github.com/quickemu-project/quickemu/issues
|
|
.UE \c
|
|
.SH SEE ALSO
|
|
Full sources at: \c
|
|
.UR https://github.com/quickemu-project/quickemu
|
|
.UE \c
|
|
.PP
|
|
quickemu(1), quickemu_conf(1), quickgui(1)
|
|
.SH AUTHORS
|
|
Martin Wimpress.
|