oSoWoSo/DistroHopper
1
0
Fork 0
mirror of https://github.com/oSoWoSo/DistroHopper.git synced 2024-08-14 22:46:53 +00:00
Code Issues Projects Releases Packages Wiki Activity

Docs: regenerated for recent PR merges

Browse source
This commit is contained in:
Phil Clifford 2023-10-16 19:02:02 +01:00 • committed by Martin Wimpress
parent 4906752519
commit 218e87990f
8 changed files with 407 additions and 549 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -243,6 +243,7 @@ with your preferred flavour.
- `arcolinux` (Arco Linux) - `arcolinux` (Arco Linux)
- `batocera` (Batocera) - `batocera` (Batocera)
- `blendos` (BlendOS) - `blendos` (BlendOS)
- `bunsenlabs` (Bunsenlabs)
- `cachyos` (CachyOS) - `cachyos` (CachyOS)
- `centos-stream` (CentOS Stream) - `centos-stream` (CentOS Stream)
- `debian` (Debian) - `debian` (Debian)
@ -255,6 +256,7 @@ with your preferred flavour.
- `fedora` (Fedora) - `fedora` (Fedora)
- `freebsd` (FreeBSD) - `freebsd` (FreeBSD)
- `freedos` (FreeDOS) - `freedos` (FreeDOS)
- `garuda` (Garuda Linux)
- `gentoo` (Gentoo) - `gentoo` (Gentoo)
- `ghostbsd` (GhostBSD) - `ghostbsd` (GhostBSD)
- `haiku` (Haiku) - `haiku` (Haiku)
@ -274,6 +276,7 @@ with your preferred flavour.
- `openindiana` (OpenIndiana) - `openindiana` (OpenIndiana)
- `opensuse` (openSUSE) - `opensuse` (openSUSE)
- `oraclelinux` (Oracle Linux) - `oraclelinux` (Oracle Linux)
- `peppermint` (PeppermintOS)
- `popos` (Pop!\_OS) - `popos` (Pop!\_OS)
- `reactos` (ReactOS) - `reactos` (ReactOS)
- `rebornos` (RebornOS) - `rebornos` (RebornOS)
@ -282,6 +285,7 @@ with your preferred flavour.
- `slackware` (Slackware) - `slackware` (Slackware)
- `solus` (Solus) - `solus` (Solus)
- `tails` (Tails) - `tails` (Tails)
- `trisquel` (Trisquel)
- `truenas-core` (TrueNAS Core) - `truenas-core` (TrueNAS Core)
- `truenas-scale` (TrueNAS Scale) - `truenas-scale` (TrueNAS Scale)
- `vanillaos` (Vanilla OS) - `vanillaos` (Vanilla OS)
@ -766,7 +770,7 @@ You can also pass optional parameters
--viewer <viewer> : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none' --viewer <viewer> : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none'
--ssh-port <port> : Set ssh-port manually --ssh-port <port> : Set ssh-port manually
--spice-port <port> : Set spice-port manually --spice-port <port> : Set spice-port manually
--public-dir <path> : expose share directory. @Options: '' (default: xdg-user-dir PUBLICSHARE), '<directory>', 'none' --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 <type> : Set monitor connection type. @Options: 'socket' (default), 'telnet', 'none'
--monitor-telnet-host <ip/host> : Set telnet host for monitor. (default: 'localhost') --monitor-telnet-host <ip/host> : Set telnet host for monitor. (default: 'localhost')
--monitor-telnet-port <port> : Set telnet port for monitor. (default: '4440') --monitor-telnet-port <port> : Set telnet port for monitor. (default: '4440')
@ -778,6 +782,7 @@ You can also pass optional parameters
--keyboard_layout <layout> : Set keyboard layout. --keyboard_layout <layout> : Set keyboard layout.
--mouse <type> : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio' --mouse <type> : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio'
--usb-controller <type> : Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none' --usb-controller <type> : Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none'
--sound-card <type> : Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370', 'sb16', 'none'
--extra_args <arguments> : Pass additional arguments to qemu --extra_args <arguments> : Pass additional arguments to qemu
--version : Print version --version : Print version
@ -839,8 +844,8 @@ which Quickemu sizes to 2048x1152. Without the `--screen` option,
Quickemu would have used the 1920x1080 monitor which results in a window Quickemu would have used the 1920x1080 monitor which results in a window
size of 1664x936. size of 1664x936.
The '--screenpct' is an optional integer value between 25 \<= pct \< The '--screenpct' is an optional integer value between 25 \<= pct \< 100
100 which will override system default screen sizes. The VM size will be which will override system default screen sizes. The VM size will be
'pct' of the chosen screen. **If --fullscreen is chosen screen will be 'pct' of the chosen screen. **If --fullscreen is chosen screen will be
fullsize instead of being scaled down by --screenpct value.** fullsize instead of being scaled down by --screenpct value.**

2
build-docs

@ -1 +1 @@
Subproject commit e33d8263e0d19d8ad9ef16d1dc00274b9a0ab4bf Subproject commit 984085207432ed50dfae2d6aeb3bab04a9185c49

432
docs/quickemu.1
View file

@ -1,29 +1,11 @@
.\" Automatically generated by Pandoc 3.1.1 .\" Automatically generated by Pandoc 3.1.8
.\" .\"
.\" Define V font for inline verbatim, using C font in formats .TH "QUICKEMU" "1" "October 17, 2023" "quickemu" "Quickemu User Manual"
.\" 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 27, 2023" "quickemu" "Quickemu User Manual"
.hy
.SH NAME .SH NAME
.PP
quickemu - A quick VM builder and manager quickemu - A quick VM builder and manager
.SH SYNOPSIS .SH SYNOPSIS
.PP
\f[B]quickemu\f[R] [\f[I]OPTION\f[R]]\&... \f[B]quickemu\f[R] [\f[I]OPTION\f[R]]\&...
.SH DESCRIPTION .SH DESCRIPTION
.PP
\f[B]quickemu\f[R] will create and run highly optimised desktop virtual \f[B]quickemu\f[R] will create and run highly optimised desktop virtual
machines for Linux, macOS and Windows machines for Linux, macOS and Windows
.SH OPTIONS .SH OPTIONS
@ -37,12 +19,17 @@ You can also pass optional parameters
Enable braille support. Enable braille support.
Requires SDL. Requires SDL.
.TP .TP
\f[B]\[en]delete\f[R] \f[B]\[en]delete-disk\f[R]
Delete the disk image. Delete the disk image.
.TP .TP
\f[B]\[en]display\f[R] \f[B]\[en]display\f[R]
Select display backend. Select display backend.
`sdl' (default), `gtk', `none' or `spice' `sdl' (default), `gtk', `none', `spice' or `spice-app'
.TP
\f[B]\[en]sound-card\f[R]
Select virtual audio emulation.
`intel-hda' (default), `ac97' (solaris default), `es1370', `sb16'
(freedos default) or `none'
.TP .TP
\f[B]\[en]fullscreen\f[R] \f[B]\[en]fullscreen\f[R]
Starts VM in full screen mode (Ctl+Alt+f to exit) Starts VM in full screen mode (Ctl+Alt+f to exit)
@ -78,19 +65,16 @@ Print version
\f[B]quickemu \[en]vm ubuntu-mate-22.04.conf\f[R] \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] Launches the VM specified in the file \f[I]ubuntu-mate-22.04.conf\f[R]
.SS Introduction .SS Introduction
.PP
Quickly create and run highly optimised desktop virtual machines for Quickly create and run highly optimised desktop virtual machines for
Linux, macOS and Windows; with just two commands. Linux, macOS and Windows; with just two commands.
You decide what operating system you want to run and Quickemu will You decide what operating system you want to run and Quickemu will
figure out the best way to do it for you. figure out the best way to do it for you.
For example: For example:
.IP .IP
.nf .EX
\f[C]
quickget ubuntu-mate 22.04 quickget ubuntu-mate 22.04
quickemu --vm ubuntu-mate-22.04.conf quickemu --vm ubuntu-mate-22.04.conf
\f[R] .EE
.fi
.PP .PP
The original objective of the project was to enable quick testing of The original objective of the project was to enable quick testing of
Linux distributions where the virtual machine configurations can be Linux distributions where the virtual machine configurations can be
@ -119,7 +103,7 @@ QEMU Guest Agent support (https://wiki.qemu.org/Features/GuestAgent);
provides access to a system-level agent via standard QMP commands provides access to a system-level agent via standard QMP commands
.IP \[bu] 2 .IP \[bu] 2
Samba file sharing for Linux, macOS and Windows guests (\f[I]if Samba file sharing for Linux, macOS and Windows guests (\f[I]if
\f[VI]smbd\f[I] is installed on the host\f[R]) \f[CI]smbd\f[I] is installed on the host\f[R])
.IP \[bu] 2 .IP \[bu] 2
VirGL acceleration VirGL acceleration
.IP \[bu] 2 .IP \[bu] 2
@ -198,7 +182,6 @@ zsync (http://zsync.moria.org.uk/)
.IP \[bu] 2 .IP \[bu] 2
unzip (http://www.info-zip.org/UnZip.html) unzip (http://www.info-zip.org/UnZip.html)
.SS Installing Requirements .SS Installing Requirements
.PP
For Ubuntu, Arch and nixos systems the For Ubuntu, Arch and nixos systems the
ppa (https://launchpad.net/~flexiondotorg/+archive/ubuntu/quickemu), ppa (https://launchpad.net/~flexiondotorg/+archive/ubuntu/quickemu),
AUR (https://aur.archlinux.org/packages/quickemu) or AUR (https://aur.archlinux.org/packages/quickemu) or
@ -211,19 +194,15 @@ These examples may save a little typing
.PP .PP
Debian (and direct derivatives such as MX Linux): Debian (and direct derivatives such as MX Linux):
.IP .IP
.nf .EX
\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 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] .EE
.fi
.PP .PP
Fedora: Fedora:
.IP .IP
.nf .EX
\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 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] .EE
.fi
.PP .PP
MacOS: MacOS:
.PP .PP
@ -231,15 +210,12 @@ This is a work in progress (see issue
248 (https://github.com/quickemu-project/quickemu/issues/248) for other 248 (https://github.com/quickemu-project/quickemu/issues/248) for other
steps and changes that may enable running on MacOS) steps and changes that may enable running on MacOS)
.IP .IP
.nf .EX
\f[C]
brew install qemu bash coreutils grep jq python\[at]3.10 cdrtools gnu-sed spice-gtk wget zsync brew install qemu bash coreutils grep jq python\[at]3.10 cdrtools gnu-sed spice-gtk wget zsync
\f[R] .EE
.fi
.SH Usage .SH Usage
.SS Graphical User Interfaces .SS Graphical User Interfaces
.PP While \f[CR]quickemu\f[R] and \f[CR]quickget\f[R] are designed for the
While \f[V]quickemu\f[R] and \f[V]quickget\f[R] are designed for the
terminal, a graphical user interface is also available: terminal, a graphical user interface is also available:
.IP \[bu] 2 .IP \[bu] 2
\f[B]Quickgui (https://github.com/quickgui/quickgui)\f[R] by Mark \f[B]Quickgui (https://github.com/quickgui/quickgui)\f[R] by Mark
@ -251,196 +227,194 @@ Philipp Kiemle (https://github.com/daPhipz) for creating the
\f[B]Quickemu icons (https://github.com/Lukewh/quickemu-icons)\f[R] 🎨 \f[B]Quickemu icons (https://github.com/Lukewh/quickemu-icons)\f[R] 🎨
.SS Quickgui for Ubuntu .SS Quickgui for Ubuntu
.IP .IP
.nf .EX
\f[C]
sudo add-apt-repository ppa:yannick-mauray/quickgui sudo add-apt-repository ppa:yannick-mauray/quickgui
sudo apt update sudo apt update
sudo apt install quickgui sudo apt install quickgui
\f[R] .EE
.fi
.SS Ubuntu Guest .SS Ubuntu Guest
.PP \f[CR]quickget\f[R] will automatically download an Ubuntu release and
\f[V]quickget\f[R] will automatically download an Ubuntu release and
create the virtual machine configuration. create the virtual machine configuration.
.IP .IP
.nf .EX
\f[C]
quickget ubuntu 22.04 quickget ubuntu 22.04
quickemu --vm ubuntu-22.04.conf quickemu --vm ubuntu-22.04.conf
\f[R] .EE
.fi
.IP \[bu] 2 .IP \[bu] 2
Complete the installation as normal. Complete the installation as normal.
.IP \[bu] 2 .IP \[bu] 2
Post-install: Post-install:
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable Install the SPICE agent (\f[CR]spice-vdagent\f[R]) in the guest to
copy/paste and USB redirection enable copy/paste and USB redirection
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
\f[V]sudo apt install spice-vdagent\f[R] \f[CR]sudo apt install spice-vdagent\f[R]
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to Install the SPICE WebDAV agent (\f[CR]spice-webdavd\f[R]) in the guest
enable file sharing. to enable file sharing.
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
\f[V]sudo apt install spice-webdavd\f[R] \f[CR]sudo apt install spice-webdavd\f[R]
.RE .RE
.RE .RE
.SS Ubuntu devel (daily-live) images .SS Ubuntu devel (daily-live) images
.PP \f[CR]quickget\f[R] can also download/refresh devel images via
\f[V]quickget\f[R] can also download/refresh devel images via \f[CR]zsync\f[R] for Ubuntu developers and testers.
\f[V]zsync\f[R] for Ubuntu developers and testers.
.IP .IP
.nf .EX
\f[C]
quickget ubuntu devel quickget ubuntu devel
quickemu --vm ubuntu-devel.conf quickemu --vm ubuntu-devel.conf
\f[R] .EE
.fi
.PP .PP
You can run \f[V]quickget ubuntu devel\f[R] to refresh your daily You can run \f[CR]quickget ubuntu devel\f[R] to refresh your daily
development image as often as you like, it will even automatically development image as often as you like, it will even automatically
switch to a new series. switch to a new series.
.SS Ubuntu Flavours .SS Ubuntu Flavours
.PP
All the official Ubuntu flavours are supported, just replace All the official Ubuntu flavours are supported, just replace
\f[V]ubuntu\f[R] with your preferred flavour. \f[CR]ubuntu\f[R] with your preferred flavour.
.IP \[bu] 2 .IP \[bu] 2
\f[V]kubuntu\f[R] (Kubuntu) \f[CR]kubuntu\f[R] (Kubuntu)
.IP \[bu] 2 .IP \[bu] 2
\f[V]lubuntu\f[R] (Lubuntu) \f[CR]lubuntu\f[R] (Lubuntu)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ubuntu-budgie\f[R] (Ubuntu Budgie) \f[CR]ubuntu-budgie\f[R] (Ubuntu Budgie)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ubuntucinnamon\f[R] (Ubuntu Cinnamon) \f[CR]ubuntucinnamon\f[R] (Ubuntu Cinnamon)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ubuntukylin\f[R] (Ubuntu Kylin) \f[CR]ubuntukylin\f[R] (Ubuntu Kylin)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ubuntu-mate\f[R] (Ubuntu MATE) \f[CR]ubuntu-mate\f[R] (Ubuntu MATE)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ubuntu-server\f[R] (Ubuntu Server) \f[CR]ubuntu-server\f[R] (Ubuntu Server)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ubuntustudio\f[R] (Ubuntu Studio) \f[CR]ubuntustudio\f[R] (Ubuntu Studio)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ubuntu\f[R] (Ubuntu) \f[CR]ubuntu\f[R] (Ubuntu)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ubuntu-unity\f[R] (Ubuntu Unity) \f[CR]ubuntu-unity\f[R] (Ubuntu Unity)
.IP \[bu] 2 .IP \[bu] 2
\f[V]xubuntu\f[R] (Xubuntu) \f[CR]xubuntu\f[R] (Xubuntu)
.SS Other Operating Systems .SS Other Operating Systems
.PP \f[CR]quickget\f[R] also supports:
\f[V]quickget\f[R] also supports:
.IP \[bu] 2 .IP \[bu] 2
\f[V]alma\f[R] (Alma Linux) \f[CR]alma\f[R] (Alma Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]alpine\f[R] (Alpine Linux) \f[CR]alpine\f[R] (Alpine Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]android\f[R] (Android x86) \f[CR]android\f[R] (Android x86)
.IP \[bu] 2 .IP \[bu] 2
\f[V]archcraft\f[R] (Archcraft) \f[CR]archcraft\f[R] (Archcraft)
.IP \[bu] 2 .IP \[bu] 2
\f[V]archlinux\f[R] (Arch Linux) \f[CR]archlinux\f[R] (Arch Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]arcolinux\f[R] (Arco Linux) \f[CR]arcolinux\f[R] (Arco Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]batocera\f[R] (Batocera) \f[CR]batocera\f[R] (Batocera)
.IP \[bu] 2 .IP \[bu] 2
\f[V]blendos\f[R] (BlendOS) \f[CR]blendos\f[R] (BlendOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]cachyos\f[R] (CachyOS) \f[CR]bunsenlabs\f[R] (Bunsenlabs)
.IP \[bu] 2 .IP \[bu] 2
\f[V]centos-stream\f[R] (CentOS Stream) \f[CR]cachyos\f[R] (CachyOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]debian\f[R] (Debian) \f[CR]centos-stream\f[R] (CentOS Stream)
.IP \[bu] 2 .IP \[bu] 2
\f[V]deepin\f[R] (Deepin) \f[CR]debian\f[R] (Debian)
.IP \[bu] 2 .IP \[bu] 2
\f[V]devuan\f[R] (Devuan) \f[CR]deepin\f[R] (Deepin)
.IP \[bu] 2 .IP \[bu] 2
\f[V]dragonflybsd\f[R] (DragonFlyBSD) \f[CR]devuan\f[R] (Devuan)
.IP \[bu] 2 .IP \[bu] 2
\f[V]elementary\f[R] (elementary OS) \f[CR]dragonflybsd\f[R] (DragonFlyBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[V]endeavouros\f[R] (EndeavourOS) \f[CR]elementary\f[R] (elementary OS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]endless\f[R] (Endless OS) \f[CR]endeavouros\f[R] (EndeavourOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]fedora\f[R] (Fedora) \f[CR]endless\f[R] (Endless OS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]freebsd\f[R] (FreeBSD) \f[CR]fedora\f[R] (Fedora)
.IP \[bu] 2 .IP \[bu] 2
\f[V]freedos\f[R] (FreeDOS) \f[CR]freebsd\f[R] (FreeBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[V]gentoo\f[R] (Gentoo) \f[CR]freedos\f[R] (FreeDOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ghostbsd\f[R] (GhostBSD) \f[CR]garuda\f[R] (Garuda Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]haiku\f[R] (Haiku) \f[CR]gentoo\f[R] (Gentoo)
.IP \[bu] 2 .IP \[bu] 2
\f[V]holoiso\f[R] (HoloISO) \f[CR]ghostbsd\f[R] (GhostBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[V]kali\f[R] (Kali) \f[CR]haiku\f[R] (Haiku)
.IP \[bu] 2 .IP \[bu] 2
\f[V]kdeneon\f[R] (KDE Neon) \f[CR]holoiso\f[R] (HoloISO)
.IP \[bu] 2 .IP \[bu] 2
\f[V]kolibrios\f[R] (KolibriOS) \f[CR]kali\f[R] (Kali)
.IP \[bu] 2 .IP \[bu] 2
\f[V]linuxmint\f[R] (Linux Mint) \f[CR]kdeneon\f[R] (KDE Neon)
.IP \[bu] 2 .IP \[bu] 2
\f[V]lmde\f[R] (Linux Mint Debian Edition) \f[CR]kolibrios\f[R] (KolibriOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]mageia\f[R] (Mageia) \f[CR]linuxmint\f[R] (Linux Mint)
.IP \[bu] 2 .IP \[bu] 2
\f[V]manjaro\f[R] (Manjaro) \f[CR]lmde\f[R] (Linux Mint Debian Edition)
.IP \[bu] 2 .IP \[bu] 2
\f[V]mxlinux\f[R] (MX Linux) \f[CR]mageia\f[R] (Mageia)
.IP \[bu] 2 .IP \[bu] 2
\f[V]netboot\f[R] (netboot.xyz) \f[CR]manjaro\f[R] (Manjaro)
.IP \[bu] 2 .IP \[bu] 2
\f[V]netbsd\f[R] (NetBSD) \f[CR]mxlinux\f[R] (MX Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]nixos\f[R] (NixOS) \f[CR]netboot\f[R] (netboot.xyz)
.IP \[bu] 2 .IP \[bu] 2
\f[V]openbsd\f[R] (OpenBSD) \f[CR]netbsd\f[R] (NetBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[V]openindiana\f[R] (OpenIndiana) \f[CR]nixos\f[R] (NixOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]opensuse\f[R] (openSUSE) \f[CR]openbsd\f[R] (OpenBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[V]oraclelinux\f[R] (Oracle Linux) \f[CR]openindiana\f[R] (OpenIndiana)
.IP \[bu] 2 .IP \[bu] 2
\f[V]popos\f[R] (Pop!_OS) \f[CR]opensuse\f[R] (openSUSE)
.IP \[bu] 2 .IP \[bu] 2
\f[V]reactos\f[R] (ReactOS) \f[CR]oraclelinux\f[R] (Oracle Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]rebornos\f[R] (RebornOS) \f[CR]peppermint\f[R] (PeppermintOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]rockylinux\f[R] (Rocky Linux) \f[CR]popos\f[R] (Pop!_OS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]siduction\f[R] (Siduction) \f[CR]reactos\f[R] (ReactOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]slackware\f[R] (Slackware) \f[CR]rebornos\f[R] (RebornOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]solus\f[R] (Solus) \f[CR]rockylinux\f[R] (Rocky Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]tails\f[R] (Tails) \f[CR]siduction\f[R] (Siduction)
.IP \[bu] 2 .IP \[bu] 2
\f[V]truenas-core\f[R] (TrueNAS Core) \f[CR]slackware\f[R] (Slackware)
.IP \[bu] 2 .IP \[bu] 2
\f[V]truenas-scale\f[R] (TrueNAS Scale) \f[CR]solus\f[R] (Solus)
.IP \[bu] 2 .IP \[bu] 2
\f[V]vanillaos\f[R] (Vanilla OS) \f[CR]tails\f[R] (Tails)
.IP \[bu] 2 .IP \[bu] 2
\f[V]void\f[R] (Void Linux) \f[CR]trisquel\f[R] (Trisquel)
.IP \[bu] 2 .IP \[bu] 2
\f[V]vxlinux\f[R] (VX Linux) \f[CR]truenas-core\f[R] (TrueNAS Core)
.IP \[bu] 2 .IP \[bu] 2
\f[V]xerolinux\f[R] (XeroLinux) \f[CR]truenas-scale\f[R] (TrueNAS Scale)
.IP \[bu] 2 .IP \[bu] 2
\f[V]zorin\f[R] (Zorin OS) \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]xerolinux\f[R] (XeroLinux)
.IP \[bu] 2
\f[CR]zorin\f[R] (Zorin OS)
.PP .PP
Or you can download a Linux image and manually create a VM Or you can download a Linux image and manually create a VM
configuration. configuration.
@ -448,49 +422,42 @@ configuration.
Download a .iso image of a Linux distribution Download a .iso image of a Linux distribution
.IP \[bu] 2 .IP \[bu] 2
Create a VM configuration file; for example Create a VM configuration file; for example
\f[V]debian-bullseye.conf\f[R] \f[CR]debian-bullseye.conf\f[R]
.IP .IP
.nf .EX
\f[C]
guest_os=\[dq]linux\[dq] guest_os=\[dq]linux\[dq]
disk_img=\[dq]debian-bullseye/disk.qcow2\[dq] disk_img=\[dq]debian-bullseye/disk.qcow2\[dq]
iso=\[dq]debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso\[dq] iso=\[dq]debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso\[dq]
\f[R] .EE
.fi
.IP \[bu] 2 .IP \[bu] 2
Use \f[V]quickemu\f[R] to start the virtual machine: Use \f[CR]quickemu\f[R] to start the virtual machine:
.IP .IP
.nf .EX
\f[C]
quickemu --vm debian-bullseye.conf quickemu --vm debian-bullseye.conf
\f[R] .EE
.fi
.IP \[bu] 2 .IP \[bu] 2
Complete the installation as normal. Complete the installation as normal.
.IP \[bu] 2 .IP \[bu] 2
Post-install: Post-install:
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable Install the SPICE agent (\f[CR]spice-vdagent\f[R]) in the guest to
copy/paste and USB redirection. enable copy/paste and USB redirection.
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to Install the SPICE WebDAV agent (\f[CR]spice-webdavd\f[R]) in the guest
enable file sharing. to enable file sharing.
.RE .RE
.SS macOS Guest .SS macOS Guest
.PP \f[CR]quickget\f[R] automatically downloads a macOS recovery image and
\f[V]quickget\f[R] automatically downloads a macOS recovery image and
creates a virtual machine configuration. creates a virtual machine configuration.
.IP .IP
.nf .EX
\f[C]
quickget macos catalina quickget macos catalina
quickemu --vm macos-catalina.conf quickemu --vm macos-catalina.conf
\f[R] .EE
.fi
.PP .PP
macOS \f[V]high-sierra\f[R], \f[V]mojave\f[R], \f[V]catalina\f[R], macOS \f[CR]high-sierra\f[R], \f[CR]mojave\f[R], \f[CR]catalina\f[R],
\f[V]big-sur\f[R], \f[V]monterey\f[R] and \f[V]ventura\f[R] are \f[CR]big-sur\f[R], \f[CR]monterey\f[R] and \f[CR]ventura\f[R] are
supported. supported.
.IP \[bu] 2 .IP \[bu] 2
Use cursor keys and enter key to select the \f[B]macOS Base System\f[R] Use cursor keys and enter key to select the \f[B]macOS Base System\f[R]
@ -501,11 +468,11 @@ From \f[B]macOS Utilities\f[R]
Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R] Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R]
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Select \f[V]QEMU HARDDISK Media\f[R] (\[ti]103.08GB) from the list (on Select \f[CR]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 Big Sur and above use \f[CR]Apple Inc. VirtIO Block Device\f[R]) and
click \f[B]Erase\f[R]. click \f[B]Erase\f[R].
.IP \[bu] 2 .IP \[bu] 2
Enter a \f[V]Name:\f[R] for the disk Enter a \f[CR]Name:\f[R] for the disk
.IP \[bu] 2 .IP \[bu] 2
If you are installing macOS Mojave or later (Catalina, Big Sur, Monterey If you are installing macOS Mojave or later (Catalina, Big Sur, Monterey
and Ventura), choose any of the APFS options as the filesystem. and Ventura), choose any of the APFS options as the filesystem.
@ -554,11 +521,9 @@ command followed by pressing enter to tell macos to use the TRIM command
on the hard disk when files are deleted: on the hard disk when files are deleted:
.RE .RE
.IP .IP
.nf .EX
\f[C]
sudo trimforce enable sudo trimforce enable
\f[R] .EE
.fi
.PP .PP
You will be prompted to enter your account\[cq]s password to gain the You will be prompted to enter your account\[cq]s password to gain the
privilege needed. privilege needed.
@ -568,40 +533,34 @@ 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 If you press enter without first typing y the system will consider that
a negative response as though you said \[lq]no\[rq]: a negative response as though you said \[lq]no\[rq]:
.IP .IP
.nf .EX
\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. 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)? Are you sure you with to proceed (y/N)?
\f[R] .EE
.fi
.PP .PP
And a second confirmation once you\[cq]ve confirmed the previous one: And a second confirmation once you\[cq]ve confirmed the previous one:
.IP .IP
.nf .EX
\f[C]
Your system will immediately reboot when this is complete. Your system will immediately reboot when this is complete.
Is this OK (y/N)? Is this OK (y/N)?
\f[R] .EE
.fi
.PP .PP
As the last message states, your system will automatically reboot as As the last message states, your system will automatically reboot as
soon as the command completes. soon as the command completes.
.PP .PP
The default macOS configuration looks like this: The default macOS configuration looks like this:
.IP .IP
.nf .EX
\f[C]
guest_os=\[dq]macos\[dq] guest_os=\[dq]macos\[dq]
img=\[dq]macos-catalina/RecoveryImage.img\[dq] img=\[dq]macos-catalina/RecoveryImage.img\[dq]
disk_img=\[dq]macos-catalina/disk.qcow2\[dq] disk_img=\[dq]macos-catalina/disk.qcow2\[dq]
macos_release=\[dq]catalina\[dq] macos_release=\[dq]catalina\[dq]
\f[R] .EE
.fi
.IP \[bu] 2 .IP \[bu] 2
\f[V]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for \f[CR]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
macOS. macOS.
.IP \[bu] 2 .IP \[bu] 2
\f[V]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to \f[CR]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to
optimise for a particular macOS release. optimise for a particular macOS release.
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
@ -612,7 +571,6 @@ And VirtIO Block Media (disks) are supported/stable in Catalina and
newer. newer.
.RE .RE
.SS macOS compatibility .SS macOS compatibility
.PP
There are some considerations when running macOS via Quickemu. There are some considerations when running macOS via Quickemu.
.IP \[bu] 2 .IP \[bu] 2
Supported macOS releases: Supported macOS releases:
@ -631,7 +589,7 @@ Monterey
Ventura Ventura
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
\f[V]quickemu\f[R] will automatically download the required \f[CR]quickemu\f[R] will automatically download the required
OpenCore (https://github.com/acidanthera/OpenCorePkg) bootloader and OpenCore (https://github.com/acidanthera/OpenCorePkg) bootloader and
OVMF firmware from OSX-KVM (https://github.com/kholia/OSX-KVM). OVMF firmware from OSX-KVM (https://github.com/kholia/OSX-KVM).
.IP \[bu] 2 .IP \[bu] 2
@ -644,11 +602,11 @@ VirtIO Block
Media (https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is used Media (https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is used
for the system disk where supported. for the system disk where supported.
.IP \[bu] 2 .IP \[bu] 2
VirtIO \f[V]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used for VirtIO \f[CR]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used
the mouse. for the mouse.
.IP \[bu] 2 .IP \[bu] 2
VirtIO Network (\f[V]virtio-net\f[R]) is supported and enabled on macOS VirtIO Network (\f[CR]virtio-net\f[R]) is supported and enabled on macOS
Big Sur and newer but previous releases use \f[V]vmxnet3\f[R]. Big Sur and newer but previous releases use \f[CR]vmxnet3\f[R].
.IP \[bu] 2 .IP \[bu] 2
VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and
newer but disabled for other support macOS releases. newer but disabled for other support macOS releases.
@ -680,39 +638,33 @@ webdavd (https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24).
.IP \[bu] 2 .IP \[bu] 2
Copy/paste via SPICE agent is \f[B]not available on macOS\f[R]. Copy/paste via SPICE agent is \f[B]not available on macOS\f[R].
.SS macOS App Store .SS macOS App Store
.PP
If you see \f[I]\[lq]Your device or computer could not be 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 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]. that your wired ethernet device is \f[CR]en0\f[R].
Use \f[V]ifconfig\f[R] in a terminal to verify this. Use \f[CR]ifconfig\f[R] in a terminal to verify this.
.PP .PP
If the wired ethernet device is not \f[V]en0\f[R], then then go to 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 \f[I]System Preferences\f[R] -> \f[I]Network\f[R], delete all the
network devices and apply the changes. network devices and apply the changes.
Next, open a terminal and run the following: Next, open a terminal and run the following:
.IP .IP
.nf .EX
\f[C]
sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
\f[R] .EE
.fi
.PP .PP
Now reboot, and the App Store should work. Now reboot, and the App Store should work.
.SS Windows 10 & 11 Guests .SS Windows 10 & 11 Guests
.PP \f[CR]quickget\f[R] can download
\f[V]quickget\f[R] can download
Windows10 (https://www.microsoft.com/software-download/windows10) and Windows10 (https://www.microsoft.com/software-download/windows10) and
Windows 11 (https://www.microsoft.com/software-download/windows11) Windows 11 (https://www.microsoft.com/software-download/windows11)
automatically and create an optimised virtual machine configuration. automatically and create an optimised virtual machine configuration.
This configuration also includes the VirtIO drivers for This configuration also includes the VirtIO drivers for
Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/). Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/).
.IP .IP
.nf .EX
\f[C]
quickget windows 11 quickget windows 11
quickemu --vm windows-11-22H2.conf quickemu --vm windows-11-22H2.conf
\f[R] .EE
.fi
.IP \[bu] 2 .IP \[bu] 2
Complete the installation as you normally would. Complete the installation as you normally would.
.IP \[bu] 2 .IP \[bu] 2
@ -722,38 +674,34 @@ A local administrator user account is automatically created, with these
credentials: credentials:
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Username: \f[V]Quickemu\f[R] Username: \f[CR]Quickemu\f[R]
.IP \[bu] 2 .IP \[bu] 2
Password: \f[V]quickemu\f[R] Password: \f[CR]quickemu\f[R]
.RE .RE
.PP .PP
The default Windows 11 configuration looks like this: The default Windows 11 configuration looks like this:
.IP .IP
.nf .EX
\f[C]
guest_os=\[dq]windows\[dq] guest_os=\[dq]windows\[dq]
disk_img=\[dq]windows-11/disk.qcow2\[dq] disk_img=\[dq]windows-11/disk.qcow2\[dq]
iso=\[dq]windows-11/windows-11.iso\[dq] iso=\[dq]windows-11/windows-11.iso\[dq]
fixed_iso=\[dq]windows-11/virtio-win.iso\[dq] fixed_iso=\[dq]windows-11/virtio-win.iso\[dq]
tpm=\[dq]on\[dq] tpm=\[dq]on\[dq]
secureboot=\[dq]on\[dq] secureboot=\[dq]on\[dq]
\f[R] .EE
.fi
.IP \[bu] 2 .IP \[bu] 2
\f[V]guest_os=\[dq]windows\[dq]\f[R] instructs \f[V]quickemu\f[R] to \f[CR]guest_os=\[dq]windows\[dq]\f[R] instructs \f[CR]quickemu\f[R] to
optimise for Windows. optimise for Windows.
.IP \[bu] 2 .IP \[bu] 2
\f[V]fixed_iso=\f[R] specifies the ISO image that provides VirtIO \f[CR]fixed_iso=\f[R] specifies the ISO image that provides VirtIO
drivers. drivers.
.IP \[bu] 2 .IP \[bu] 2
\f[V]tpm=\[dq]on\[dq]\f[R] instructs \f[V]quickemu\f[R] to create a \f[CR]tpm=\[dq]on\[dq]\f[R] instructs \f[CR]quickemu\f[R] to create a
software emulated TPM device using \f[V]swtpm\f[R]. software emulated TPM device using \f[CR]swtpm\f[R].
.SH All the options .SH All the options
.PP
Here are the usage instructions: Here are the usage instructions:
.IP .IP
.nf .EX
\f[C]
Usage Usage
quickemu --vm ubuntu.conf quickemu --vm ubuntu.conf
@ -775,7 +723,7 @@ You can also pass optional parameters
--viewer <viewer> : Choose an alternative viewer. \[at]Options: \[aq]spicy\[aq] (default), \[aq]remote-viewer\[aq], \[aq]none\[aq] --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 --ssh-port <port> : Set ssh-port manually
--spice-port <port> : Set spice-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] --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 <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-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-telnet-port <port> : Set telnet port for monitor. (default: \[aq]4440\[aq])
@ -787,74 +735,64 @@ You can also pass optional parameters
--keyboard_layout <layout> : Set keyboard layout. --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] --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] --usb-controller <type> : Set usb-controller. \[at]Options: \[aq]ehci\[aq] (default), \[aq]xhci\[aq], \[aq]none\[aq]
--sound-card <type> : Set sound card. \[at]Options: \[aq]intel-hda\[aq] (default), \[aq]ac97\[aq], \[aq]es1370\[aq], \[aq]sb16\[aq], \[aq]none\[aq]
--extra_args <arguments> : Pass additional arguments to qemu --extra_args <arguments> : Pass additional arguments to qemu
--version : Print version --version : Print version
\f[R] .EE
.fi
.SS Desktop shortcuts .SS Desktop shortcuts
.PP
Desktop shortcuts can be created for a VM, the shortcuts are saved in Desktop shortcuts can be created for a VM, the shortcuts are saved in
\f[V]\[ti]/.local/share/applications\f[R]. \f[CR]\[ti]/.local/share/applications\f[R].
Here is an example of how to create a shortcut. Here is an example of how to create a shortcut.
.IP .IP
.nf .EX
\f[C]
quickemu --vm ubuntu-22.04-desktop.conf --shortcut quickemu --vm ubuntu-22.04-desktop.conf --shortcut
\f[R] .EE
.fi
.SS Screen and window size (Linux guests only) .SS Screen and window size (Linux guests only)
\f[CR]qemu\f[R] will always default to the primary monitor to display
the VM\[cq]s window.
.PP .PP
\f[V]qemu\f[R] will always default to the primary monitor to display the Without the \f[CR]--screen\f[R] option, \f[CR]quickemu\f[R] will look
VM\[cq]s window. for the size of the smallest monitor, and use a size that fits on said
.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. monitor.
.PP .PP
The \f[V]--screen\f[R] option forces \f[V]quickemu\f[R] to use the size The \f[CR]--screen\f[R] option forces \f[CR]quickemu\f[R] to use the
of the given monitor to compute the size of the window. 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 \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]. it\[cq]s not the primary monitor\f[R].
This is useful if the primary monitor if not the smallest one, and if This is useful if the primary monitor if not the smallest one, and if
the VM\[cq]s window doesn\[cq]t need to be moved around. the VM\[cq]s window doesn\[cq]t need to be moved around.
.PP .PP
The \f[V]--screen\f[R] option is also useful with the The \f[CR]--screen\f[R] option is also useful with the
\f[V]--fullscreen\f[R] option, again because \f[V]qemu\f[R] will always \f[CR]--fullscreen\f[R] option, again because \f[CR]qemu\f[R] will
use the primary monitor. always use the primary monitor.
In order for the fullscreen mode to work properly, the resolution of the In order for the fullscreen mode to work properly, the resolution of the
VM\[cq]s window must match the resolution of the screen. VM\[cq]s window must match the resolution of the screen.
.PP .PP
To know which screen to use, type: To know which screen to use, type:
.IP .IP
.nf .EX
\f[C]
xrandr --listmonitors | grep -v Monitors xrandr --listmonitors | grep -v Monitors
\f[R] .EE
.fi
.PP .PP
The command will output something like this: The command will output something like this:
.IP .IP
.nf .EX
\f[C]
0: +*HDMI-0 2560/597x1440/336+1920+0 HDMI-0 0: +*HDMI-0 2560/597x1440/336+1920+0 HDMI-0
1: +DVI-D-0 1920/527x1080/296+0+0 DVI-D-0 1: +DVI-D-0 1920/527x1080/296+0+0 DVI-D-0
\f[R] .EE
.fi
.PP .PP
The first number is what needs to be passed to the \f[V]--screen\f[R] The first number is what needs to be passed to the \f[CR]--screen\f[R]
option. option.
.PP .PP
For example: For example:
.IP .IP
.nf .EX
\f[C]
quickemu --vm vm.conf --screen 0 quickemu --vm vm.conf --screen 0
\f[R] .EE
.fi
.PP .PP
The above uses the 2560x1440 screen to compute the size of the window, The above uses the 2560x1440 screen to compute the size of the window,
which Quickemu sizes to 2048x1152. which Quickemu sizes to 2048x1152.
Without the \f[V]--screen\f[R] option, Quickemu would have used the Without the \f[CR]--screen\f[R] option, Quickemu would have used the
1920x1080 monitor which results in a window size of 1664x936. 1920x1080 monitor which results in a window size of 1664x936.
.PP .PP
The `\[en]screenpct' is an optional integer value between 25 <= pct < The `\[en]screenpct' is an optional integer value between 25 <= pct <
@ -863,7 +801,6 @@ The VM size will be `pct' of the chosen screen.
\f[B]If \[en]fullscreen is chosen screen will be fullsize instead of \f[B]If \[en]fullscreen is chosen screen will be fullsize instead of
being scaled down by \[en]screenpct value.\f[R] being scaled down by \[en]screenpct value.\f[R]
.SH References .SH References
.PP
Useful reference that assisted the development of Quickemu. Useful reference that assisted the development of Quickemu.
.IP \[bu] 2 .IP \[bu] 2
General General
@ -938,14 +875,11 @@ TPM
<https://virtio-fs.gitlab.io/> <https://virtio-fs.gitlab.io/>
.RE .RE
.SH AUTHORS .SH AUTHORS
.PP
Written by Martin Wimpress. Written by Martin Wimpress.
.SH BUGS .SH BUGS
.PP
Submit bug reports online at: Submit bug reports online at:
<https://github.com/quickemu-project/quickemu/issues> <https://github.com/quickemu-project/quickemu/issues>
.SH SEE ALSO .SH SEE ALSO
.PP
Full sources at: <https://github.com/quickemu-project/quickemu> Full sources at: <https://github.com/quickemu-project/quickemu>
.PP .PP
quickemu_conf(1), quickget(1), quickgui(1) quickemu_conf(1), quickget(1), quickgui(1)

22
docs/quickemu.1.md
View file

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: June 27, 2023 date: October 17, 2023
footer: quickemu footer: quickemu
header: Quickemu User Manual header: Quickemu User Manual
section: 1 section: 1
@ -30,11 +30,16 @@ You can also pass optional parameters
**--braille** **--braille**
: Enable braille support. Requires SDL. : Enable braille support. Requires SDL.
**--delete** **--delete-disk**
: Delete the disk image. : Delete the disk image.
**--display** **--display**
: Select display backend. 'sdl' (default), 'gtk', 'none' or 'spice' : Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or
'spice-app'
**--sound-card**
: Select virtual audio emulation. 'intel-hda' (default), 'ac97'
(solaris default), 'es1370', 'sb16' (freedos default) or 'none'
**--fullscreen** **--fullscreen**
: Starts VM in full screen mode (Ctl+Alt+f to exit) : Starts VM in full screen mode (Ctl+Alt+f to exit)
@ -267,6 +272,7 @@ with your preferred flavour.
- `arcolinux` (Arco Linux) - `arcolinux` (Arco Linux)
- `batocera` (Batocera) - `batocera` (Batocera)
- `blendos` (BlendOS) - `blendos` (BlendOS)
- `bunsenlabs` (Bunsenlabs)
- `cachyos` (CachyOS) - `cachyos` (CachyOS)
- `centos-stream` (CentOS Stream) - `centos-stream` (CentOS Stream)
- `debian` (Debian) - `debian` (Debian)
@ -279,6 +285,7 @@ with your preferred flavour.
- `fedora` (Fedora) - `fedora` (Fedora)
- `freebsd` (FreeBSD) - `freebsd` (FreeBSD)
- `freedos` (FreeDOS) - `freedos` (FreeDOS)
- `garuda` (Garuda Linux)
- `gentoo` (Gentoo) - `gentoo` (Gentoo)
- `ghostbsd` (GhostBSD) - `ghostbsd` (GhostBSD)
- `haiku` (Haiku) - `haiku` (Haiku)
@ -298,6 +305,7 @@ with your preferred flavour.
- `openindiana` (OpenIndiana) - `openindiana` (OpenIndiana)
- `opensuse` (openSUSE) - `opensuse` (openSUSE)
- `oraclelinux` (Oracle Linux) - `oraclelinux` (Oracle Linux)
- `peppermint` (PeppermintOS)
- `popos` (Pop!\_OS) - `popos` (Pop!\_OS)
- `reactos` (ReactOS) - `reactos` (ReactOS)
- `rebornos` (RebornOS) - `rebornos` (RebornOS)
@ -306,6 +314,7 @@ with your preferred flavour.
- `slackware` (Slackware) - `slackware` (Slackware)
- `solus` (Solus) - `solus` (Solus)
- `tails` (Tails) - `tails` (Tails)
- `trisquel` (Trisquel)
- `truenas-core` (TrueNAS Core) - `truenas-core` (TrueNAS Core)
- `truenas-scale` (TrueNAS Scale) - `truenas-scale` (TrueNAS Scale)
- `vanillaos` (Vanilla OS) - `vanillaos` (Vanilla OS)
@ -554,7 +563,7 @@ Here are the usage instructions:
--viewer <viewer> : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none' --viewer <viewer> : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none'
--ssh-port <port> : Set ssh-port manually --ssh-port <port> : Set ssh-port manually
--spice-port <port> : Set spice-port manually --spice-port <port> : Set spice-port manually
--public-dir <path> : expose share directory. @Options: '' (default: xdg-user-dir PUBLICSHARE), '<directory>', 'none' --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 <type> : Set monitor connection type. @Options: 'socket' (default), 'telnet', 'none'
--monitor-telnet-host <ip/host> : Set telnet host for monitor. (default: 'localhost') --monitor-telnet-host <ip/host> : Set telnet host for monitor. (default: 'localhost')
--monitor-telnet-port <port> : Set telnet port for monitor. (default: '4440') --monitor-telnet-port <port> : Set telnet port for monitor. (default: '4440')
@ -566,6 +575,7 @@ Here are the usage instructions:
--keyboard_layout <layout> : Set keyboard layout. --keyboard_layout <layout> : Set keyboard layout.
--mouse <type> : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio' --mouse <type> : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio'
--usb-controller <type> : Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none' --usb-controller <type> : Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none'
--sound-card <type> : Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370', 'sb16', 'none'
--extra_args <arguments> : Pass additional arguments to qemu --extra_args <arguments> : Pass additional arguments to qemu
--version : Print version --version : Print version
@ -624,8 +634,8 @@ which Quickemu sizes to 2048x1152. Without the `--screen` option,
Quickemu would have used the 1920x1080 monitor which results in a window Quickemu would have used the 1920x1080 monitor which results in a window
size of 1664x936. size of 1664x936.
The '--screenpct' is an optional integer value between 25 \<= pct \< The '--screenpct' is an optional integer value between 25 \<= pct \< 100
100 which will override system default screen sizes. The VM size will be which will override system default screen sizes. The VM size will be
'pct' of the chosen screen. **If --fullscreen is chosen screen will be 'pct' of the chosen screen. **If --fullscreen is chosen screen will be
fullsize instead of being scaled down by --screenpct value.** fullsize instead of being scaled down by --screenpct value.**

154
docs/quickemu_conf.1
View file

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

2
docs/quickemu_conf.1.md
View file

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: June 27, 2023 date: October 17, 2023
footer: quickemu_conf footer: quickemu_conf
header: Quickemu Configuration Manual header: Quickemu Configuration Manual
section: 1 section: 1

327
docs/quickget.1
View file

@ -1,32 +1,14 @@
.\" Automatically generated by Pandoc 3.1.1 .\" Automatically generated by Pandoc 3.1.8
.\" .\"
.\" Define V font for inline verbatim, using C font in formats .TH "QUICKGET" "1" "October 17, 2023" "quickget" "Quickget User Manual"
.\" 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 27, 2023" "quickget" "Quickget User Manual"
.hy
.SH NAME .SH NAME
.PP
quickget - download and prepare materials for building a quickemu VM quickget - download and prepare materials for building a quickemu VM
.SH SYNOPSIS .SH SYNOPSIS
.PP
\f[B]quickget\f[R] [\f[I]os\f[R]] [\f[I]release\f[R]] \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]]* [\f[I]edition\f[R]] | [\f[I]OPTION\f[R]]*
.SH DESCRIPTION .SH DESCRIPTION
.PP
\f[B]quickget\f[R] will download the requisite materials and prepare a \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 configuration for \f[CR]quickemu\f[R] to use to build and run
.SH OPTIONS .SH OPTIONS
.TP .TP
\f[B]version | -version | \[en]version\f[R] \f[B]version | -version | \[en]version\f[R]
@ -42,188 +24,188 @@ will exit.
Editions may not apply and will be defaulted if not provided. Editions may not apply and will be defaulted if not provided.
.SH NOTES .SH NOTES
.SS Ubuntu Guest .SS Ubuntu Guest
.PP \f[CR]quickget\f[R] will automatically download an Ubuntu release and
\f[V]quickget\f[R] will automatically download an Ubuntu release and
create the virtual machine configuration. create the virtual machine configuration.
.IP .IP
.nf .EX
\f[C]
quickget ubuntu 22.04 quickget ubuntu 22.04
quickemu --vm ubuntu-22.04.conf quickemu --vm ubuntu-22.04.conf
\f[R] .EE
.fi
.IP \[bu] 2 .IP \[bu] 2
Complete the installation as normal. Complete the installation as normal.
.IP \[bu] 2 .IP \[bu] 2
Post-install: Post-install:
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable Install the SPICE agent (\f[CR]spice-vdagent\f[R]) in the guest to
copy/paste and USB redirection enable copy/paste and USB redirection
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
\f[V]sudo apt install spice-vdagent\f[R] \f[CR]sudo apt install spice-vdagent\f[R]
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to Install the SPICE WebDAV agent (\f[CR]spice-webdavd\f[R]) in the guest
enable file sharing. to enable file sharing.
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
\f[V]sudo apt install spice-webdavd\f[R] \f[CR]sudo apt install spice-webdavd\f[R]
.RE .RE
.RE .RE
.SS Ubuntu devel (daily-live) images .SS Ubuntu devel (daily-live) images
.PP \f[CR]quickget\f[R] can also download/refresh devel images via
\f[V]quickget\f[R] can also download/refresh devel images via \f[CR]zsync\f[R] for Ubuntu developers and testers.
\f[V]zsync\f[R] for Ubuntu developers and testers.
.IP .IP
.nf .EX
\f[C]
quickget ubuntu devel quickget ubuntu devel
quickemu --vm ubuntu-devel.conf quickemu --vm ubuntu-devel.conf
\f[R] .EE
.fi
.PP .PP
You can run \f[V]quickget ubuntu devel\f[R] to refresh your daily You can run \f[CR]quickget ubuntu devel\f[R] to refresh your daily
development image as often as you like, it will even automatically development image as often as you like, it will even automatically
switch to a new series. switch to a new series.
.SS Ubuntu Flavours .SS Ubuntu Flavours
.PP
All the official Ubuntu flavours are supported, just replace All the official Ubuntu flavours are supported, just replace
\f[V]ubuntu\f[R] with your preferred flavour. \f[CR]ubuntu\f[R] with your preferred flavour.
.IP \[bu] 2 .IP \[bu] 2
\f[V]kubuntu\f[R] (Kubuntu) \f[CR]kubuntu\f[R] (Kubuntu)
.IP \[bu] 2 .IP \[bu] 2
\f[V]lubuntu\f[R] (Lubuntu) \f[CR]lubuntu\f[R] (Lubuntu)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ubuntu-budgie\f[R] (Ubuntu Budgie) \f[CR]ubuntu-budgie\f[R] (Ubuntu Budgie)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ubuntucinnamon\f[R] (Ubuntu Cinnamon) \f[CR]ubuntucinnamon\f[R] (Ubuntu Cinnamon)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ubuntukylin\f[R] (Ubuntu Kylin) \f[CR]ubuntukylin\f[R] (Ubuntu Kylin)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ubuntu-mate\f[R] (Ubuntu MATE) \f[CR]ubuntu-mate\f[R] (Ubuntu MATE)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ubuntu-server\f[R] (Ubuntu Server) \f[CR]ubuntu-server\f[R] (Ubuntu Server)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ubuntustudio\f[R] (Ubuntu Studio) \f[CR]ubuntustudio\f[R] (Ubuntu Studio)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ubuntu\f[R] (Ubuntu) \f[CR]ubuntu\f[R] (Ubuntu)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ubuntu-unity\f[R] (Ubuntu Unity) \f[CR]ubuntu-unity\f[R] (Ubuntu Unity)
.IP \[bu] 2 .IP \[bu] 2
\f[V]xubuntu\f[R] (Xubuntu) \f[CR]xubuntu\f[R] (Xubuntu)
.SS Other Operating Systems .SS Other Operating Systems
.PP \f[CR]quickget\f[R] also supports:
\f[V]quickget\f[R] also supports:
.IP \[bu] 2 .IP \[bu] 2
\f[V]alma\f[R] (Alma Linux) \f[CR]alma\f[R] (Alma Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]alpine\f[R] (Alpine Linux) \f[CR]alpine\f[R] (Alpine Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]android\f[R] (Android x86) \f[CR]android\f[R] (Android x86)
.IP \[bu] 2 .IP \[bu] 2
\f[V]archcraft\f[R] (Archcraft) \f[CR]archcraft\f[R] (Archcraft)
.IP \[bu] 2 .IP \[bu] 2
\f[V]archlinux\f[R] (Arch Linux) \f[CR]archlinux\f[R] (Arch Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]arcolinux\f[R] (Arco Linux) \f[CR]arcolinux\f[R] (Arco Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]batocera\f[R] (Batocera) \f[CR]batocera\f[R] (Batocera)
.IP \[bu] 2 .IP \[bu] 2
\f[V]blendos\f[R] (BlendOS) \f[CR]blendos\f[R] (BlendOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]cachyos\f[R] (CachyOS) \f[CR]bunsenlabs\f[R] (Bunsenlabs)
.IP \[bu] 2 .IP \[bu] 2
\f[V]centos-stream\f[R] (CentOS Stream) \f[CR]cachyos\f[R] (CachyOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]debian\f[R] (Debian) \f[CR]centos-stream\f[R] (CentOS Stream)
.IP \[bu] 2 .IP \[bu] 2
\f[V]deepin\f[R] (Deepin) \f[CR]debian\f[R] (Debian)
.IP \[bu] 2 .IP \[bu] 2
\f[V]devuan\f[R] (Devuan) \f[CR]deepin\f[R] (Deepin)
.IP \[bu] 2 .IP \[bu] 2
\f[V]dragonflybsd\f[R] (DragonFlyBSD) \f[CR]devuan\f[R] (Devuan)
.IP \[bu] 2 .IP \[bu] 2
\f[V]elementary\f[R] (elementary OS) \f[CR]dragonflybsd\f[R] (DragonFlyBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[V]endeavouros\f[R] (EndeavourOS) \f[CR]elementary\f[R] (elementary OS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]endless\f[R] (Endless OS) \f[CR]endeavouros\f[R] (EndeavourOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]fedora\f[R] (Fedora) \f[CR]endless\f[R] (Endless OS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]freebsd\f[R] (FreeBSD) \f[CR]fedora\f[R] (Fedora)
.IP \[bu] 2 .IP \[bu] 2
\f[V]freedos\f[R] (FreeDOS) \f[CR]freebsd\f[R] (FreeBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[V]gentoo\f[R] (Gentoo) \f[CR]freedos\f[R] (FreeDOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]ghostbsd\f[R] (GhostBSD) \f[CR]garuda\f[R] (Garuda Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]haiku\f[R] (Haiku) \f[CR]gentoo\f[R] (Gentoo)
.IP \[bu] 2 .IP \[bu] 2
\f[V]holoiso\f[R] (HoloISO) \f[CR]ghostbsd\f[R] (GhostBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[V]kali\f[R] (Kali) \f[CR]haiku\f[R] (Haiku)
.IP \[bu] 2 .IP \[bu] 2
\f[V]kdeneon\f[R] (KDE Neon) \f[CR]holoiso\f[R] (HoloISO)
.IP \[bu] 2 .IP \[bu] 2
\f[V]kolibrios\f[R] (KolibriOS) \f[CR]kali\f[R] (Kali)
.IP \[bu] 2 .IP \[bu] 2
\f[V]linuxmint\f[R] (Linux Mint) \f[CR]kdeneon\f[R] (KDE Neon)
.IP \[bu] 2 .IP \[bu] 2
\f[V]lmde\f[R] (Linux Mint Debian Edition) \f[CR]kolibrios\f[R] (KolibriOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]mageia\f[R] (Mageia) \f[CR]linuxmint\f[R] (Linux Mint)
.IP \[bu] 2 .IP \[bu] 2
\f[V]manjaro\f[R] (Manjaro) \f[CR]lmde\f[R] (Linux Mint Debian Edition)
.IP \[bu] 2 .IP \[bu] 2
\f[V]mxlinux\f[R] (MX Linux) \f[CR]mageia\f[R] (Mageia)
.IP \[bu] 2 .IP \[bu] 2
\f[V]netboot\f[R] (netboot.xyz) \f[CR]manjaro\f[R] (Manjaro)
.IP \[bu] 2 .IP \[bu] 2
\f[V]netbsd\f[R] (NetBSD) \f[CR]mxlinux\f[R] (MX Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]nixos\f[R] (NixOS) \f[CR]netboot\f[R] (netboot.xyz)
.IP \[bu] 2 .IP \[bu] 2
\f[V]openbsd\f[R] (OpenBSD) \f[CR]netbsd\f[R] (NetBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[V]openindiana\f[R] (OpenIndiana) \f[CR]nixos\f[R] (NixOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]opensuse\f[R] (openSUSE) \f[CR]openbsd\f[R] (OpenBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[V]oraclelinux\f[R] (Oracle Linux) \f[CR]openindiana\f[R] (OpenIndiana)
.IP \[bu] 2 .IP \[bu] 2
\f[V]popos\f[R] (Pop!_OS) \f[CR]opensuse\f[R] (openSUSE)
.IP \[bu] 2 .IP \[bu] 2
\f[V]reactos\f[R] (ReactOS) \f[CR]oraclelinux\f[R] (Oracle Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]rebornos\f[R] (RebornOS) \f[CR]peppermint\f[R] (PeppermintOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]rockylinux\f[R] (Rocky Linux) \f[CR]popos\f[R] (Pop!_OS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]siduction\f[R] (Siduction) \f[CR]reactos\f[R] (ReactOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]slackware\f[R] (Slackware) \f[CR]rebornos\f[R] (RebornOS)
.IP \[bu] 2 .IP \[bu] 2
\f[V]solus\f[R] (Solus) \f[CR]rockylinux\f[R] (Rocky Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]tails\f[R] (Tails) \f[CR]siduction\f[R] (Siduction)
.IP \[bu] 2 .IP \[bu] 2
\f[V]truenas-core\f[R] (TrueNAS Core) \f[CR]slackware\f[R] (Slackware)
.IP \[bu] 2 .IP \[bu] 2
\f[V]truenas-scale\f[R] (TrueNAS Scale) \f[CR]solus\f[R] (Solus)
.IP \[bu] 2 .IP \[bu] 2
\f[V]vanillaos\f[R] (Vanilla OS) \f[CR]tails\f[R] (Tails)
.IP \[bu] 2 .IP \[bu] 2
\f[V]void\f[R] (Void Linux) \f[CR]trisquel\f[R] (Trisquel)
.IP \[bu] 2 .IP \[bu] 2
\f[V]vxlinux\f[R] (VX Linux) \f[CR]truenas-core\f[R] (TrueNAS Core)
.IP \[bu] 2 .IP \[bu] 2
\f[V]xerolinux\f[R] (XeroLinux) \f[CR]truenas-scale\f[R] (TrueNAS Scale)
.IP \[bu] 2 .IP \[bu] 2
\f[V]zorin\f[R] (Zorin OS) \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]xerolinux\f[R] (XeroLinux)
.IP \[bu] 2
\f[CR]zorin\f[R] (Zorin OS)
.PP .PP
Or you can download a Linux image and manually create a VM Or you can download a Linux image and manually create a VM
configuration. configuration.
@ -231,49 +213,42 @@ configuration.
Download a .iso image of a Linux distribution Download a .iso image of a Linux distribution
.IP \[bu] 2 .IP \[bu] 2
Create a VM configuration file; for example Create a VM configuration file; for example
\f[V]debian-bullseye.conf\f[R] \f[CR]debian-bullseye.conf\f[R]
.IP .IP
.nf .EX
\f[C]
guest_os=\[dq]linux\[dq] guest_os=\[dq]linux\[dq]
disk_img=\[dq]debian-bullseye/disk.qcow2\[dq] disk_img=\[dq]debian-bullseye/disk.qcow2\[dq]
iso=\[dq]debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso\[dq] iso=\[dq]debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso\[dq]
\f[R] .EE
.fi
.IP \[bu] 2 .IP \[bu] 2
Use \f[V]quickemu\f[R] to start the virtual machine: Use \f[CR]quickemu\f[R] to start the virtual machine:
.IP .IP
.nf .EX
\f[C]
quickemu --vm debian-bullseye.conf quickemu --vm debian-bullseye.conf
\f[R] .EE
.fi
.IP \[bu] 2 .IP \[bu] 2
Complete the installation as normal. Complete the installation as normal.
.IP \[bu] 2 .IP \[bu] 2
Post-install: Post-install:
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable Install the SPICE agent (\f[CR]spice-vdagent\f[R]) in the guest to
copy/paste and USB redirection. enable copy/paste and USB redirection.
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to Install the SPICE WebDAV agent (\f[CR]spice-webdavd\f[R]) in the guest
enable file sharing. to enable file sharing.
.RE .RE
.SS macOS Guest .SS macOS Guest
.PP \f[CR]quickget\f[R] automatically downloads a macOS recovery image and
\f[V]quickget\f[R] automatically downloads a macOS recovery image and
creates a virtual machine configuration. creates a virtual machine configuration.
.IP .IP
.nf .EX
\f[C]
quickget macos catalina quickget macos catalina
quickemu --vm macos-catalina.conf quickemu --vm macos-catalina.conf
\f[R] .EE
.fi
.PP .PP
macOS \f[V]high-sierra\f[R], \f[V]mojave\f[R], \f[V]catalina\f[R], macOS \f[CR]high-sierra\f[R], \f[CR]mojave\f[R], \f[CR]catalina\f[R],
\f[V]big-sur\f[R], \f[V]monterey\f[R] and \f[V]ventura\f[R] are \f[CR]big-sur\f[R], \f[CR]monterey\f[R] and \f[CR]ventura\f[R] are
supported. supported.
.IP \[bu] 2 .IP \[bu] 2
Use cursor keys and enter key to select the \f[B]macOS Base System\f[R] Use cursor keys and enter key to select the \f[B]macOS Base System\f[R]
@ -284,11 +259,11 @@ From \f[B]macOS Utilities\f[R]
Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R] Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R]
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Select \f[V]QEMU HARDDISK Media\f[R] (\[ti]103.08GB) from the list (on Select \f[CR]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 Big Sur and above use \f[CR]Apple Inc. VirtIO Block Device\f[R]) and
click \f[B]Erase\f[R]. click \f[B]Erase\f[R].
.IP \[bu] 2 .IP \[bu] 2
Enter a \f[V]Name:\f[R] for the disk Enter a \f[CR]Name:\f[R] for the disk
.IP \[bu] 2 .IP \[bu] 2
If you are installing macOS Mojave or later (Catalina, Big Sur, Monterey If you are installing macOS Mojave or later (Catalina, Big Sur, Monterey
and Ventura), choose any of the APFS options as the filesystem. and Ventura), choose any of the APFS options as the filesystem.
@ -337,11 +312,9 @@ command followed by pressing enter to tell macos to use the TRIM command
on the hard disk when files are deleted: on the hard disk when files are deleted:
.RE .RE
.IP .IP
.nf .EX
\f[C]
sudo trimforce enable sudo trimforce enable
\f[R] .EE
.fi
.PP .PP
You will be prompted to enter your account\[cq]s password to gain the You will be prompted to enter your account\[cq]s password to gain the
privilege needed. privilege needed.
@ -351,40 +324,34 @@ 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 If you press enter without first typing y the system will consider that
a negative response as though you said \[lq]no\[rq]: a negative response as though you said \[lq]no\[rq]:
.IP .IP
.nf .EX
\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. 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)? Are you sure you with to proceed (y/N)?
\f[R] .EE
.fi
.PP .PP
And a second confirmation once you\[cq]ve confirmed the previous one: And a second confirmation once you\[cq]ve confirmed the previous one:
.IP .IP
.nf .EX
\f[C]
Your system will immediately reboot when this is complete. Your system will immediately reboot when this is complete.
Is this OK (y/N)? Is this OK (y/N)?
\f[R] .EE
.fi
.PP .PP
As the last message states, your system will automatically reboot as As the last message states, your system will automatically reboot as
soon as the command completes. soon as the command completes.
.PP .PP
The default macOS configuration looks like this: The default macOS configuration looks like this:
.IP .IP
.nf .EX
\f[C]
guest_os=\[dq]macos\[dq] guest_os=\[dq]macos\[dq]
img=\[dq]macos-catalina/RecoveryImage.img\[dq] img=\[dq]macos-catalina/RecoveryImage.img\[dq]
disk_img=\[dq]macos-catalina/disk.qcow2\[dq] disk_img=\[dq]macos-catalina/disk.qcow2\[dq]
macos_release=\[dq]catalina\[dq] macos_release=\[dq]catalina\[dq]
\f[R] .EE
.fi
.IP \[bu] 2 .IP \[bu] 2
\f[V]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for \f[CR]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
macOS. macOS.
.IP \[bu] 2 .IP \[bu] 2
\f[V]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to \f[CR]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to
optimise for a particular macOS release. optimise for a particular macOS release.
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
@ -395,7 +362,6 @@ And VirtIO Block Media (disks) are supported/stable in Catalina and
newer. newer.
.RE .RE
.SS macOS compatibility .SS macOS compatibility
.PP
There are some considerations when running macOS via Quickemu. There are some considerations when running macOS via Quickemu.
.IP \[bu] 2 .IP \[bu] 2
Supported macOS releases: Supported macOS releases:
@ -414,7 +380,7 @@ Monterey
Ventura Ventura
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
\f[V]quickemu\f[R] will automatically download the required \f[CR]quickemu\f[R] will automatically download the required
OpenCore (https://github.com/acidanthera/OpenCorePkg) bootloader and OpenCore (https://github.com/acidanthera/OpenCorePkg) bootloader and
OVMF firmware from OSX-KVM (https://github.com/kholia/OSX-KVM). OVMF firmware from OSX-KVM (https://github.com/kholia/OSX-KVM).
.IP \[bu] 2 .IP \[bu] 2
@ -427,11 +393,11 @@ VirtIO Block
Media (https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is used Media (https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is used
for the system disk where supported. for the system disk where supported.
.IP \[bu] 2 .IP \[bu] 2
VirtIO \f[V]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used for VirtIO \f[CR]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used
the mouse. for the mouse.
.IP \[bu] 2 .IP \[bu] 2
VirtIO Network (\f[V]virtio-net\f[R]) is supported and enabled on macOS VirtIO Network (\f[CR]virtio-net\f[R]) is supported and enabled on macOS
Big Sur and newer but previous releases use \f[V]vmxnet3\f[R]. Big Sur and newer but previous releases use \f[CR]vmxnet3\f[R].
.IP \[bu] 2 .IP \[bu] 2
VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and
newer but disabled for other support macOS releases. newer but disabled for other support macOS releases.
@ -463,39 +429,33 @@ webdavd (https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24).
.IP \[bu] 2 .IP \[bu] 2
Copy/paste via SPICE agent is \f[B]not available on macOS\f[R]. Copy/paste via SPICE agent is \f[B]not available on macOS\f[R].
.SS macOS App Store .SS macOS App Store
.PP
If you see \f[I]\[lq]Your device or computer could not be 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 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]. that your wired ethernet device is \f[CR]en0\f[R].
Use \f[V]ifconfig\f[R] in a terminal to verify this. Use \f[CR]ifconfig\f[R] in a terminal to verify this.
.PP .PP
If the wired ethernet device is not \f[V]en0\f[R], then then go to 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 \f[I]System Preferences\f[R] -> \f[I]Network\f[R], delete all the
network devices and apply the changes. network devices and apply the changes.
Next, open a terminal and run the following: Next, open a terminal and run the following:
.IP .IP
.nf .EX
\f[C]
sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
\f[R] .EE
.fi
.PP .PP
Now reboot, and the App Store should work. Now reboot, and the App Store should work.
.SS Windows 10 & 11 Guests .SS Windows 10 & 11 Guests
.PP \f[CR]quickget\f[R] can download
\f[V]quickget\f[R] can download
Windows10 (https://www.microsoft.com/software-download/windows10) and Windows10 (https://www.microsoft.com/software-download/windows10) and
Windows 11 (https://www.microsoft.com/software-download/windows11) Windows 11 (https://www.microsoft.com/software-download/windows11)
automatically and create an optimised virtual machine configuration. automatically and create an optimised virtual machine configuration.
This configuration also includes the VirtIO drivers for This configuration also includes the VirtIO drivers for
Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/). Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/).
.IP .IP
.nf .EX
\f[C]
quickget windows 11 quickget windows 11
quickemu --vm windows-11-22H2.conf quickemu --vm windows-11-22H2.conf
\f[R] .EE
.fi
.IP \[bu] 2 .IP \[bu] 2
Complete the installation as you normally would. Complete the installation as you normally would.
.IP \[bu] 2 .IP \[bu] 2
@ -505,41 +465,36 @@ A local administrator user account is automatically created, with these
credentials: credentials:
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Username: \f[V]Quickemu\f[R] Username: \f[CR]Quickemu\f[R]
.IP \[bu] 2 .IP \[bu] 2
Password: \f[V]quickemu\f[R] Password: \f[CR]quickemu\f[R]
.RE .RE
.PP .PP
The default Windows 11 configuration looks like this: The default Windows 11 configuration looks like this:
.IP .IP
.nf .EX
\f[C]
guest_os=\[dq]windows\[dq] guest_os=\[dq]windows\[dq]
disk_img=\[dq]windows-11/disk.qcow2\[dq] disk_img=\[dq]windows-11/disk.qcow2\[dq]
iso=\[dq]windows-11/windows-11.iso\[dq] iso=\[dq]windows-11/windows-11.iso\[dq]
fixed_iso=\[dq]windows-11/virtio-win.iso\[dq] fixed_iso=\[dq]windows-11/virtio-win.iso\[dq]
tpm=\[dq]on\[dq] tpm=\[dq]on\[dq]
secureboot=\[dq]on\[dq] secureboot=\[dq]on\[dq]
\f[R] .EE
.fi
.IP \[bu] 2 .IP \[bu] 2
\f[V]guest_os=\[dq]windows\[dq]\f[R] instructs \f[V]quickemu\f[R] to \f[CR]guest_os=\[dq]windows\[dq]\f[R] instructs \f[CR]quickemu\f[R] to
optimise for Windows. optimise for Windows.
.IP \[bu] 2 .IP \[bu] 2
\f[V]fixed_iso=\f[R] specifies the ISO image that provides VirtIO \f[CR]fixed_iso=\f[R] specifies the ISO image that provides VirtIO
drivers. drivers.
.IP \[bu] 2 .IP \[bu] 2
\f[V]tpm=\[dq]on\[dq]\f[R] instructs \f[V]quickemu\f[R] to create a \f[CR]tpm=\[dq]on\[dq]\f[R] instructs \f[CR]quickemu\f[R] to create a
software emulated TPM device using \f[V]swtpm\f[R]. software emulated TPM device using \f[CR]swtpm\f[R].
.SH AUTHORS .SH AUTHORS
.PP
Written by Martin Wimpress. Written by Martin Wimpress.
.SH BUGS .SH BUGS
.PP
Submit bug reports online at: Submit bug reports online at:
<https://github.com/quickemu-project/quickemu/issues> <https://github.com/quickemu-project/quickemu/issues>
.SH SEE ALSO .SH SEE ALSO
.PP
Full sources at: <https://github.com/quickemu-project/quickemu> Full sources at: <https://github.com/quickemu-project/quickemu>
.PP .PP
quickemu(1), quickemu_conf(1), quickgui(1) quickemu(1), quickemu_conf(1), quickgui(1)

6
docs/quickget.1.md
View file

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: June 27, 2023 date: October 17, 2023
footer: quickget footer: quickget
header: Quickget User Manual header: Quickget User Manual
section: 1 section: 1
@ -99,6 +99,7 @@ with your preferred flavour.
- `arcolinux` (Arco Linux) - `arcolinux` (Arco Linux)
- `batocera` (Batocera) - `batocera` (Batocera)
- `blendos` (BlendOS) - `blendos` (BlendOS)
- `bunsenlabs` (Bunsenlabs)
- `cachyos` (CachyOS) - `cachyos` (CachyOS)
- `centos-stream` (CentOS Stream) - `centos-stream` (CentOS Stream)
- `debian` (Debian) - `debian` (Debian)
@ -111,6 +112,7 @@ with your preferred flavour.
- `fedora` (Fedora) - `fedora` (Fedora)
- `freebsd` (FreeBSD) - `freebsd` (FreeBSD)
- `freedos` (FreeDOS) - `freedos` (FreeDOS)
- `garuda` (Garuda Linux)
- `gentoo` (Gentoo) - `gentoo` (Gentoo)
- `ghostbsd` (GhostBSD) - `ghostbsd` (GhostBSD)
- `haiku` (Haiku) - `haiku` (Haiku)
@ -130,6 +132,7 @@ with your preferred flavour.
- `openindiana` (OpenIndiana) - `openindiana` (OpenIndiana)
- `opensuse` (openSUSE) - `opensuse` (openSUSE)
- `oraclelinux` (Oracle Linux) - `oraclelinux` (Oracle Linux)
- `peppermint` (PeppermintOS)
- `popos` (Pop!\_OS) - `popos` (Pop!\_OS)
- `reactos` (ReactOS) - `reactos` (ReactOS)
- `rebornos` (RebornOS) - `rebornos` (RebornOS)
@ -138,6 +141,7 @@ with your preferred flavour.
- `slackware` (Slackware) - `slackware` (Slackware)
- `solus` (Solus) - `solus` (Solus)
- `tails` (Tails) - `tails` (Tails)
- `trisquel` (Trisquel)
- `truenas-core` (TrueNAS Core) - `truenas-core` (TrueNAS Core)
- `truenas-scale` (TrueNAS Scale) - `truenas-scale` (TrueNAS Scale)
- `vanillaos` (Vanilla OS) - `vanillaos` (Vanilla OS)