Readme and man pages regenerated reflecting updates

This commit is contained in:
Phil Clifford 2024-04-12 02:05:02 +01:00 committed by Martin Wimpress
parent eac8cc2031
commit 33b8133a33
7 changed files with 941 additions and 562 deletions

132
README.md
View File

@ -49,17 +49,18 @@ We have a Discord for this project:
## Introduction ## Introduction
**Quickemu** is a wrapper for the excellent [QEMU](https://www.qemu.org/) that attempts to **Quickemu** is a wrapper for the excellent
automatically *"do the right thing"*, rather than expose exhaustive configuration options. [QEMU](https://www.qemu.org/) that attempts to automatically *"do the
You decide what operating system you want to run, and Quickemu will figure out the best right thing"*, rather than expose exhaustive configuration options. You
way to do it for you. decide what operating system you want to run, and Quickemu will figure
out the best way to do it for you.
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](#linux-guests) where the virtual machine configurations can be Linux distributions](#linux-guests) where the virtual machine
stored anywhere (such as external USB storage or your home directory) configurations can be stored anywhere (such as external USB storage or
and no elevated permissions are required to run the virtual machines. your home directory) and no elevated permissions are required to run the
**Quickemu now also includes comprehensive support for [macOS](#macos-guests) virtual machines. **Quickemu now also includes comprehensive support for
and [Windows](#windows-guests)**. [macOS](#macos-guests) and [Windows](#windows-guests)**.
## Features ## Features
@ -123,19 +124,19 @@ sudo apt install quickemu
To quickly try quickemu: To quickly try quickemu:
```sh ``` sh
nix-shell -p quickemu nix-shell -p quickemu
``` ```
To install via Nix profile: To install via Nix profile:
```sh ``` sh
nix-env -iA pkgs.quickemu nix-env -iA pkgs.quickemu
``` ```
To install via NixOS config: To install via NixOS config:
```nix ``` nix
# /etc/nixos/configuration.nix # /etc/nixos/configuration.nix
{pkgs, ...}: { {pkgs, ...}: {
environment.systemPackages = with pkgs; environment.systemPackages = with pkgs;
@ -146,7 +147,7 @@ To install via NixOS config:
To install via Flakes: To install via Flakes:
```sh ``` sh
# TODO (flake users, please add an example!) # TODO (flake users, please add an example!)
``` ```
@ -157,7 +158,8 @@ git clone --filter=blob:none https://github.com/wimpysworld/quickemu
cd quickemu cd quickemu
``` ```
When installing from source, you will need to install the following requirements manually: When installing from source, you will need to install the following
requirements manually:
- [QEMU](https://www.qemu.org/) (*6.0.0 or newer*) **with GTK, SDL, - [QEMU](https://www.qemu.org/) (*6.0.0 or newer*) **with GTK, SDL,
SPICE & VirtFS support** SPICE & VirtFS support**
@ -197,13 +199,13 @@ These examples may save a little typing:
This also applies to derivatives: This also applies to derivatives:
```sh ``` sh
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
``` ```
#### Install requirements on Fedora hosts #### Install requirements on Fedora hosts
```sh ``` sh
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
``` ```
@ -212,7 +214,7 @@ sudo dnf install qemu bash coreutils edk2-tools grep jq lsb procps python3 genis
This is a **work in progress** (see [issue 248](https://github.com/quickemu-project/quickemu/issues/248) This is a **work in progress** (see [issue 248](https://github.com/quickemu-project/quickemu/issues/248)
for other steps and changes that may enable running on MacOS) for other steps and changes that may enable running on MacOS)
```sh ``` sh
brew install qemu bash coreutils grep jq python@3.10 cdrtools gnu-sed spice-gtk wget zsync brew install qemu bash coreutils grep jq python@3.10 cdrtools gnu-sed spice-gtk wget zsync
``` ```
@ -221,11 +223,13 @@ brew install qemu bash coreutils grep jq python@3.10 cdrtools gnu-sed spice-gtk
While `quickemu` and `quickget` are designed for the terminal, a While `quickemu` and `quickget` are designed for the terminal, a
graphical user interface is also available: graphical user interface is also available:
- **[Quickgui](https://github.com/quickgui/quickgui)** by [Mark Johnson](https://github.com/marxjohnson) and [Yannick Mauray](https://github.com/ymauray). - **[Quickgui](https://github.com/quickgui/quickgui)** by [Mark
Johnson](https://github.com/marxjohnson) and [Yannick
Mauray](https://github.com/ymauray).
To install Quickgui on Ubuntu: To install Quickgui on Ubuntu:
```sh ``` sh
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
@ -239,11 +243,12 @@ Many thanks to [Luke Wesley-Holley](https://github.com/Lukewh) and
From Nov 2023, there is also a multi option desktop integrated text From Nov 2023, there is also a multi option desktop integrated text
interface, the **quickemu quickget X terminal project**, a.k.a. **qqX**, interface, the **quickemu quickget X terminal project**, a.k.a. **qqX**,
with lots of unique tools and utilities to help you make with lots of unique tools and utilities to help you make light work of
light work of installations, snapshots and disk management installations, snapshots and disk management
- **[qqX](https://github.com/TuxVinyards/qqX)** is independently curated - **[qqX](https://github.com/TuxVinyards/qqX)** is independently
by [Alex Genovese](https://github.com/TuxVinyards) (see the github pages) curated by [Alex Genovese](https://github.com/TuxVinyards) (see the
github pages)
![qqX-vmm](https://github.com/TuxVinyards/qqX/assets/3956806/18e5c495-8072-49a5-8b9c-e1302549efcf) ![qqX-vmm](https://github.com/TuxVinyards/qqX/assets/3956806/18e5c495-8072-49a5-8b9c-e1302549efcf)
@ -312,8 +317,8 @@ You can also use `quickget` with options to:
quickget --download-iso elementary 7.1 quickget --download-iso elementary 7.1
``` ```
The `--show-iso-url`, `--test-iso-url`, and `--download-iso` options are fully The `--show-iso-url`, `--test-iso-url`, and `--download-iso` options are
functional for all operating systems, including Windows and macOS. fully functional for all operating systems, including Windows and macOS.
### Other Operating Systems ### Other Operating Systems
@ -326,16 +331,23 @@ functional for all operating systems, including Windows and macOS.
- `archcraft` (Archcraft) - `archcraft` (Archcraft)
- `archlinux` (Arch Linux) - `archlinux` (Arch Linux)
- `arcolinux` (Arco Linux) - `arcolinux` (Arco Linux)
- `artixlinux` (Artix Linux)
- `athenaos` (Athenaos)
- `batocera` (Batocera) - `batocera` (Batocera)
- `bazzite` (Bazzite)
- `biglinux` (BigLinux)
- `blendos` (BlendOS) - `blendos` (BlendOS)
- `bodhi` (Bodhi) - `bodhi` (Bodhi)
- `bunsenlabs` (Bunsenlabs) - `bunsenlabs` (Bunsenlabs)
- `cachyos` (CachyOS) - `cachyos` (CachyOS)
- `centos-stream` (CentOS Stream) - `centos-stream` (CentOS Stream)
- `chimeralinux` (Chimera Linux)
- `crunchbang++` (Crunchbang++)
- `debian` (Debian) - `debian` (Debian)
- `deepin` (Deepin) - `deepin` (Deepin)
- `devuan` (Devuan) - `devuan` (Devuan)
- `dragonflybsd` (DragonFlyBSD) - `dragonflybsd` (DragonFlyBSD)
- `easyos` (EasyOS)
- `elementary` (elementary OS) - `elementary` (elementary OS)
- `endeavouros` (EndeavourOS) - `endeavouros` (EndeavourOS)
- `endless` (Endless OS) - `endless` (Endless OS)
@ -345,8 +357,9 @@ functional for all operating systems, including Windows and macOS.
- `garuda` (Garuda Linux) - `garuda` (Garuda Linux)
- `gentoo` (Gentoo) - `gentoo` (Gentoo)
- `ghostbsd` (GhostBSD) - `ghostbsd` (GhostBSD)
- `gnomeos` (GNOME OS)
- `guix` (Guix)
- `haiku` (Haiku) - `haiku` (Haiku)
- `holoiso` (SteamOS HoloISO)
- `kali` (Kali) - `kali` (Kali)
- `kdeneon` (KDE Neon) - `kdeneon` (KDE Neon)
- `kolibrios` (KolibriOS) - `kolibrios` (KolibriOS)
@ -358,21 +371,27 @@ functional for all operating systems, including Windows and macOS.
- `mxlinux` (MX Linux) - `mxlinux` (MX Linux)
- `netboot` (netboot.xyz) - `netboot` (netboot.xyz)
- `netbsd` (NetBSD) - `netbsd` (NetBSD)
- `nitrux` (Nitrux)
- `nixos` (NixOS) - `nixos` (NixOS)
- `openbsd` (OpenBSD) - `openbsd` (OpenBSD)
- `openindiana` (OpenIndiana) - `openindiana` (OpenIndiana)
- `opensuse` (openSUSE) - `opensuse` (openSUSE)
- `oraclelinux` (Oracle Linux) - `oraclelinux` (Oracle Linux)
- `parrotsec` (Parrot Security)
- `peppermint` (PeppermintOS) - `peppermint` (PeppermintOS)
- `popos` (Pop!\_OS) - `popos` (Pop!\_OS)
- `porteus` (Porteus) - `porteus` (Porteus)
- `primtux` (Primtux)
- `reactos` (ReactOS) - `reactos` (ReactOS)
- `rebornos` (RebornOS) - `rebornos` (RebornOS)
- `rockylinux` (Rocky Linux) - `rockylinux` (Rocky Linux)
- `siduction` (Siduction) - `siduction` (Siduction)
- `slackware` (Slackware) - `slackware` (Slackware)
- `slax` (Slax)
- `slint` (Slint)
- `slitaz` (SliTaz GNU/Linux)
- `solus` (Solus) - `solus` (Solus)
- `spiral` (Spiral) - `spirallinux` (Spirallinux)
- `tails` (Tails) - `tails` (Tails)
- `tinycore` (Tiny Core Linux) - `tinycore` (Tiny Core Linux)
- `trisquel` (Trisquel) - `trisquel` (Trisquel)
@ -421,8 +440,8 @@ quickget macos catalina
quickemu --vm macos-catalina.conf quickemu --vm macos-catalina.conf
``` ```
macOS `high-sierra`, `mojave`, `catalina`, `big-sur`, `monterey`, `ventura` and macOS `high-sierra`, `mojave`, `catalina`, `big-sur`, `monterey`,
`sonoma` are supported. `ventura` and `sonoma` are supported.
- Use cursor keys and enter key to select the **macOS Base System** - Use cursor keys and enter key to select the **macOS Base System**
- From **macOS Utilities** - From **macOS Utilities**
@ -432,8 +451,8 @@ macOS `high-sierra`, `mojave`, `catalina`, `big-sur`, `monterey`, `ventura` and
click **Erase**. click **Erase**.
- Enter a `Name:` for the disk - Enter a `Name:` for the disk
- If you are installing macOS Mojave or later (Catalina, Big - If you are installing macOS Mojave or later (Catalina, Big
Sur, Monterey, Ventura and Sonoma), choose any of the APFS options Sur, Monterey, Ventura and Sonoma), choose any of the APFS
as the filesystem. MacOS Extended may not work. options as the filesystem. MacOS Extended may not work.
- Click **Erase**. - Click **Erase**.
- Click **Done**. - Click **Done**.
- Close Disk Utility - Close Disk Utility
@ -455,17 +474,17 @@ macOS `high-sierra`, `mojave`, `catalina`, `big-sur`, `monterey`, `ventura` and
macOS disk image will only ever get larger and will not shrink even macOS disk image will only ever get larger and will not shrink even
when you delete lots of data inside macOS. when you delete lots of data inside macOS.
- To enable TRIM, open the Terminal application and type the - To enable TRIM, open the Terminal application and type the
following command followed by pressing following command followed by pressing command on the hard disk
command on the hard disk when files are deleted: when files are deleted:
``` bash ``` bash
sudo trimforce enable sudo trimforce enable
``` ```
You will be prompted to enter your account's password to gain the You will be prompted to enter your account's password to gain the
privilege needed. Once you've entered your password and pressed privilege needed. Once you've entered your password and pressed in the
in the form of two questions that require you to type form of two questions that require you to type response as though you
response as though you said "no": said "no":
``` plain ``` plain
IMPORTANT NOTICE: This tool force-enables TRIM for all relevant attached devices, even though such devices may not have been validated for data integrity while using TRIM. Use of this tool to enable TRIM may result in unintended data loss or data corruption. It should not be used in a commercial operating environment or with important data. Before using this tool, you should back up all of your data and regularly back up data while TRIM is enabled. This tool is provided on an "as is" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS TOOL OR ITS USE ALONE OR IN COMBINATION WITH YOUR DEVICES, SYSTEMS, OR SERVICES. BY USING THIS TOOL TO ENABLE TRIM, YOU AGREE THAT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, USE OF THE TOOL IS AT YOUR SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH YOU. IMPORTANT NOTICE: This tool force-enables TRIM for all relevant attached devices, even though such devices may not have been validated for data integrity while using TRIM. Use of this tool to enable TRIM may result in unintended data loss or data corruption. It should not be used in a commercial operating environment or with important data. Before using this tool, you should back up all of your data and regularly back up data while TRIM is enabled. This tool is provided on an "as is" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS TOOL OR ITS USE ALONE OR IN COMBINATION WITH YOUR DEVICES, SYSTEMS, OR SERVICES. BY USING THIS TOOL TO ENABLE TRIM, YOU AGREE THAT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, USE OF THE TOOL IS AT YOUR SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH YOU.
@ -560,8 +579,8 @@ Now reboot, and the App Store should work.
## Creating Windows guests 🪟 ## Creating Windows guests 🪟
`quickget` can download `quickget` can download [**Windows
[**Windows 10**](https://www.microsoft.com/software-download/windows10) and 10**](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
@ -570,8 +589,15 @@ Windows](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/).
**Windows 8.1** is also supported but doesn't feature any automated **Windows 8.1** is also supported but doesn't feature any automated
installation or driver optimisation. installation or driver optimisation.
`quickget` can also download [Windows 10 LTSC](https://www.microsoft.com/en-us/evalcenter/download-windows-10-enterprise) and Windows Server [2012-r2](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2012-r2), [2016](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2016), [2019](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2019), and [2022](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2022). No automated installation is supported for these releases. `quickget` can also download [Windows 10
LTSC](https://www.microsoft.com/en-us/evalcenter/download-windows-10-enterprise)
and Windows Server
[2012-r2](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2012-r2),
[2016](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2016),
[2019](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2019),
and
[2022](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2022).
No automated installation is supported for these releases.
``` bash ``` bash
quickget windows 11 quickget windows 11
@ -587,8 +613,9 @@ quickemu --vm windows-11.conf
### Regional versions ### Regional versions
By default `quickget` will download the *"English International"* release (*"English (United States)"* for server releases), By default `quickget` will download the *"English International"*
but you can optionally specify one of the supported languages: For example: release (*"English (United States)"* for server releases), but you can
optionally specify one of the supported languages: For example:
``` bash ``` bash
quickget windows 11 "Chinese (Traditional)" quickget windows 11 "Chinese (Traditional)"
@ -809,21 +836,20 @@ pass-through.
Using SPICE for USB pass-through is easiest as it doesn't require any Using SPICE for USB pass-through is easiest as it doesn't require any
elevated permission: elevated permission:
* Start Quickemu with `--display spice` and then - Start Quickemu with `--display spice` and then
* select `Input` -\> `Select USB Device for redirection` from the menu to - select `Input` -\> `Select USB Device for redirection` from the menu
choose which device(s) you want to attach to the guest. to choose which device(s) you want to attach to the guest.
##### Enabling SPICE redirection on NixOS ##### Enabling SPICE redirection on NixOS
On NixOS, if you encounter this error: On NixOS, if you encounter this error:
``` Error setting facl: Operation not permitted
Error setting facl: Operation not permitted
```
Try setting [the following option](https://search.nixos.org/options?channel=23.11&show=virtualisation.spiceUSBRedirection.enable&from=0&size=50&sort=relevance&type=packages&query=spiceusbredirec): Try setting [the following
option](https://search.nixos.org/options?channel=23.11&show=virtualisation.spiceUSBRedirection.enable&from=0&size=50&sort=relevance&type=packages&query=spiceusbredirec):
```nix ``` nix
virtualisation.spiceUSBRedirection.enable = true; virtualisation.spiceUSBRedirection.enable = true;
``` ```
@ -878,9 +904,9 @@ cog.out(f"\n```\n{help}\n```\n")
``` ```
Usage Usage
quickemu --vm ubuntu.conf quickemu --vm ubuntu.conf [optional params]
You can also pass optional parameters List of optional parameters:
--access : Enable remote spice access support. 'local' (default), 'remote', 'clientipaddress' --access : Enable remote spice access support. 'local' (default), 'remote', 'clientipaddress'
--braille : Enable braille support. Requires SDL. --braille : Enable braille support. Requires SDL.
--delete-disk : Delete the disk image and EFI variables --delete-disk : Delete the disk image and EFI variables
@ -897,6 +923,8 @@ You can also pass optional parameters
--snapshot info : Show disk/snapshot info. --snapshot info : Show disk/snapshot info.
--status-quo : Do not commit any changes to disk/snapshot. --status-quo : Do not commit any changes to disk/snapshot.
--viewer <viewer> : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none' --viewer <viewer> : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none'
--width <width> : Set VM screen width. Does nothing without --height
--height <height> : Set VM screen height. Does nothing without --width
--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'

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: November 26, 2023 date: April 12, 2024
footer: quickemu footer: quickemu
header: Quickemu User Manual header: Quickemu User Manual
section: 1 section: 1
@ -27,39 +27,45 @@ machines for Linux, macOS and Windows
You can also pass optional parameters You can also pass optional parameters
**--access**
: Enable remote spice access support. 'local' (default), 'remote',
'clientipaddress'
**--braille** **--braille**
: Enable braille support. Requires SDL. : Enable braille support. Requires SDL.
**--delete-disk** **--delete-disk**
: Delete the disk image. : Delete the disk image and EFI variables
**--delete-vm**
: Delete the entire VM and it's configuration
**--display** **--display**
: Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or : Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or
'spice-app' '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)
**--ignore-msrs-always** **--ignore-msrs-always**
: Configure KVM to always ignore unhandled machine-specific registers : Configure KVM to always ignore unhandled machine-specific registers
**--screen \<screen\>** **--screen**
: Use specified screen to determine the window size. : Use specified screen to determine the window size.
**--screenpct `<percent>`{=html}**
: Percent of fullscreen for VM if --fullscreen is not specified.
**--shortcut** **--shortcut**
: Create a desktop shortcut : Create a desktop shortcut
**--snapshot apply \<tag\>** **--snapshot apply `<tag>`{=html}**
: Apply/restore a snapshot. : Apply/restore a snapshot.
**--snapshot create \<tag\>** **--snapshot create `<tag>`{=html}**
: Create a snapshot. : Create a snapshot.
**--snapshot delete \<tag\>** **--snapshot delete `<tag>`{=html}**
: Delete a snapshot. : Delete a snapshot.
**--snapshot info** **--snapshot info**
@ -68,6 +74,68 @@ You can also pass optional parameters
**--status-quo** **--status-quo**
: Do not commit any changes to disk/snapshot. : Do not commit any changes to disk/snapshot.
**--viewer `<viewer>`{=html}**
: Choose an alternative viewer. @Options: 'spicy' (default),
'remote-viewer', 'none'
**--width `<width>`{=html}**
: Set VM screen width. Does nothing without --height
**--height `<height>`{=html}**
: Set VM screen height. Does nothing without --width
**--ssh-port `<port>`{=html}**
: Set ssh-port manually
**--spice-port `<port>`{=html}**
: Set spice-port manually
**--public-dir `<path>`{=html}**
: Expose share directory. @Options: '' (default: xdg-user-dir
PUBLICSHARE), '`<directory>`{=html}', 'none'
**--monitor `<type>`{=html}**
: Set monitor connection type. @Options: 'socket' (default), 'telnet',
'none'
**--monitor-telnet-host `<ip/host>`{=html}**
: Set telnet host for monitor. (default: 'localhost')
**--monitor-telnet-port `<port>`{=html}**
: Set telnet port for monitor. (default: '4440')
**--monitor-cmd `<cmd>`{=html}**
: Send command to monitor if available. (Example: system_powerdown)
**--serial `<type>`{=html}**
: Set serial connection type. @Options: 'socket' (default), 'telnet',
'none'
**--serial-telnet-host `<ip/host>`{=html}**
: Set telnet host for serial. (default: 'localhost')
**--serial-telnet-port `<port>`{=html}**
: Set telnet port for serial. (default: '6660')
**--keyboard `<type>`{=html}**
: Set keyboard. @Options: 'usb' (default), 'ps2', 'virtio'
**--keyboard_layout `<layout>`{=html}**
: Set keyboard layout.
**--mouse `<type>`{=html}**
: Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio'
**--usb-controller `<type>`{=html}**
: Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none'
**--sound-card `<type>`{=html}**
: Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370',
'sb16', 'none'
**--extra_args `<arguments>`{=html}**
: Pass additional arguments to qemu
**--version** **--version**
: Print version : Print version
@ -78,22 +146,26 @@ You can also pass optional parameters
## Introduction ## Introduction
Quickly create and run highly optimised desktop virtual machines for **Quickemu** is a wrapper for the excellent
Linux, macOS and Windows; with just two commands. You decide what [QEMU](https://www.qemu.org/) that attempts to automatically *"do the
operating system you want to run and Quickemu will figure out the best right thing"*, rather than expose exhaustive configuration options. You
way to do it for you. For example: decide what operating system you want to run, and Quickemu will figure
out the best way to do it for you.
``` bash The original objective of the project was to enable [quick testing of
quickget ubuntu-mate 22.04 Linux distributions](#linux-guests) where the virtual machine
quickemu --vm ubuntu-mate-22.04.conf configurations can be stored anywhere (such as external USB storage or
``` your home directory) and no elevated permissions are required to run the
virtual machines. **Quickemu now also includes comprehensive support for
[macOS](#macos-guests) and [Windows](#windows-guests)**.
The original objective of the project was to enable quick testing of See this (old) video where I explain some of my motivations for creating
Linux distributions where the virtual machine configurations can be Quickemu:
stored anywhere, such as external USB storage or your home directory,
and no elevated permissions are required to run the virtual machines. ::: {align="center"}
**Quickemu now also includes comprehensive support for macOS and [![Replace VirtualBox with Bash &
Windows**. QEMU](https://img.youtube.com/vi/AOTYWEgw0hI/0.jpg)](https://www.youtube.com/watch?v=AOTYWEgw0hI)
:::
## Features ## Features
@ -120,20 +192,8 @@ Windows**.
- EFI (with or without SecureBoot) and Legacy BIOS boot - EFI (with or without SecureBoot) and Legacy BIOS boot
- Graphical user interfaces available - Graphical user interfaces available
Quickemu is a wrapper for the excellent [QEMU](https://www.qemu.org/) When installing from source, you will need to install the following
that attempts to automatically *"do the right thing"*, rather than requirements manually:
expose exhaustive configuration options.
We have a Discord for this project:
[![Discord](https://img.shields.io/discord/712850672223125565?color=0C306A&label=WimpysWorld%20Discord&logo=Discord&logoColor=ffffff&style=flat-square)](https://discord.gg/sNmz3uw)
See this (old) video where I explain some of my motivations for creating
Quickemu.
[![Replace VirtualBox with Bash &
QEMU](https://img.youtube.com/vi/AOTYWEgw0hI/0.jpg)](https://www.youtube.com/watch?v=AOTYWEgw0hI)
## Requirements
- [QEMU](https://www.qemu.org/) (*6.0.0 or newer*) **with GTK, SDL, - [QEMU](https://www.qemu.org/) (*6.0.0 or newer*) **with GTK, SDL,
SPICE & VirtFS support** SPICE & VirtFS support**
@ -145,7 +205,7 @@ QEMU](https://img.youtube.com/vi/AOTYWEgw0hI/0.jpg)](https://www.youtube.com/wat
- [LSB](https://wiki.linuxfoundation.org/lsb/start) - [LSB](https://wiki.linuxfoundation.org/lsb/start)
- [procps](https://gitlab.com/procps-ng/procps) - [procps](https://gitlab.com/procps-ng/procps)
- [python3](https://www.python.org/) - [python3](https://www.python.org/)
- [macrecovery](https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macrecovery) - [chunkcheck](https://gist.github.com/MCJack123/943eaca762730ca4b7ae460b731b68e7)
- [mkisofs](http://cdrtools.sourceforge.net/private/cdrecord.html) - [mkisofs](http://cdrtools.sourceforge.net/private/cdrecord.html)
- [usbutils](https://github.com/gregkh/usbutils) - [usbutils](https://github.com/gregkh/usbutils)
- [util-linux](https://github.com/karelzak/util-linux) - [util-linux](https://github.com/karelzak/util-linux)
@ -159,9 +219,7 @@ QEMU](https://img.youtube.com/vi/AOTYWEgw0hI/0.jpg)](https://www.youtube.com/wat
- [zsync](http://zsync.moria.org.uk/) - [zsync](http://zsync.moria.org.uk/)
- [unzip](http://www.info-zip.org/UnZip.html) - [unzip](http://www.info-zip.org/UnZip.html)
### Installing Requirements For Ubuntu, Arch and NixOS hosts, 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
[nix](https://github.com/NixOS/nixpkgs/tree/master/pkgs/development/quickemu) [nix](https://github.com/NixOS/nixpkgs/tree/master/pkgs/development/quickemu)
@ -169,27 +227,33 @@ packaging will take care of the dependencies. For other host
distributions or operating systems it will be necessary to install the distributions or operating systems it will be necessary to install the
above requirements or their equivalents. above requirements or their equivalents.
These examples may save a little typing These examples may save a little typing:
Debian (and direct derivatives such as MX Linux): #### Install requirements on Debian hosts
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 This also applies to direct derivatives, such as MX Linux:
Fedora: ``` sh
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 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 #### Install requirements on Fedora hosts
MacOS: ``` sh
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
```
#### Install requirements on macOS hosts
This is a work in progress (see [issue 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)
brew install qemu bash coreutils grep jq python@3.10 cdrtools gnu-sed spice-gtk wget zsync ``` sh
brew install qemu bash coreutils grep jq python@3.10 cdrtools gnu-sed spice-gtk wget zsync
```
# Usage ## GUI (quickgui)
## Graphical User Interfaces
While `quickemu` and `quickget` are designed for the terminal, a While `quickemu` and `quickget` are designed for the terminal, a
graphical user interface is also available: graphical user interface is also available:
@ -198,23 +262,24 @@ graphical user interface is also available:
Johnson](https://github.com/marxjohnson) and [Yannick Johnson](https://github.com/marxjohnson) and [Yannick
Mauray](https://github.com/ymauray). Mauray](https://github.com/ymauray).
Many thanks to [Luke Wesley-Holley](https://github.com/Lukewh) and To install Quickgui on Ubuntu:
[Philipp Kiemle](https://github.com/daPhipz) for creating the
**[Quickemu icons](https://github.com/Lukewh/quickemu-icons)** 🎨
### Quickgui for Ubuntu ``` sh
``` bash
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
``` ```
### quickemu quickget X terminal project Many thanks to [Luke Wesley-Holley](https://github.com/Lukewh) and
[Philipp Kiemle](https://github.com/daPhipz) for creating the
**[Quickemu icons](https://github.com/Lukewh/quickemu-icons)** 🎨
## TUI (qqx)
From Nov 2023, there is also a multi option desktop integrated text From Nov 2023, there is also a multi option desktop integrated text
interface, with lots of unique tools and utilities to help you make interface, the **quickemu quickget X terminal project**, a.k.a. **qqX**,
light work of installations, snapshots and disk management with lots of unique tools and utilities to help you make light work of
installations, snapshots and disk management
- **[qqX](https://github.com/TuxVinyards/qqX)** is independently - **[qqX](https://github.com/TuxVinyards/qqX)** is independently
curated by [Alex Genovese](https://github.com/TuxVinyards) (see the curated by [Alex Genovese](https://github.com/TuxVinyards) (see the
@ -222,7 +287,9 @@ light work of installations, snapshots and disk management
![qqX-vmm](https://github.com/TuxVinyards/qqX/assets/3956806/18e5c495-8072-49a5-8b9c-e1302549efcf) ![qqX-vmm](https://github.com/TuxVinyards/qqX/assets/3956806/18e5c495-8072-49a5-8b9c-e1302549efcf)
## Ubuntu Guest ## Creating Linux guests 🐧
### Ubuntu
`quickget` will automatically download an Ubuntu release and create the `quickget` will automatically download an Ubuntu release and create the
virtual machine configuration. virtual machine configuration.
@ -278,17 +345,18 @@ You can also use `quickget` with options to:
``` shell ``` shell
# show an OS ISO download URL for {os} {release} [edition] # show an OS ISO download URL for {os} {release} [edition]
quickget --show-iso-url fedora 38 Silverblue quickget --show-iso-url fedora 38 Silverblue
# test if and OS ISO is available for {os} {release} [edition] # test if an OS ISO is available for {os} {release} [edition]
quickget --test-iso-url nixos 23.05 plasma5 quickget --test-iso-url nixos 23.05 plasma5
# open an OS distribution homepage in a browser # open an OS distribution homepage in a browser
quickget --open-distro-homepage ubuntu-mate quickget --open-distro-homepage ubuntu-mate
# Only download image file into current directory, without creating VM
quickget --download-iso elementary 7.1
``` ```
The `--show-iso-url` and `--test-iso-url` options **do not** work for The `--show-iso-url`, `--test-iso-url`, and `--download-iso` options are
`Windows` (`quickget` will begin downloading the requested release and fully functional for all operating systems, including Windows and macOS.
edition of windows)
## Other Operating Systems ### Other Operating Systems
`quickget` also supports: `quickget` also supports:
@ -299,16 +367,23 @@ edition of windows)
- `archcraft` (Archcraft) - `archcraft` (Archcraft)
- `archlinux` (Arch Linux) - `archlinux` (Arch Linux)
- `arcolinux` (Arco Linux) - `arcolinux` (Arco Linux)
- `artixlinux` (Artix Linux)
- `athenaos` (Athenaos)
- `batocera` (Batocera) - `batocera` (Batocera)
- `bazzite` (Bazzite)
- `biglinux` (BigLinux)
- `blendos` (BlendOS) - `blendos` (BlendOS)
- `bodhi` (Bodhi) - `bodhi` (Bodhi)
- `bunsenlabs` (Bunsenlabs) - `bunsenlabs` (Bunsenlabs)
- `cachyos` (CachyOS) - `cachyos` (CachyOS)
- `centos-stream` (CentOS Stream) - `centos-stream` (CentOS Stream)
- `chimeralinux` (Chimera Linux)
- `crunchbang++` (Crunchbang++)
- `debian` (Debian) - `debian` (Debian)
- `deepin` (Deepin) - `deepin` (Deepin)
- `devuan` (Devuan) - `devuan` (Devuan)
- `dragonflybsd` (DragonFlyBSD) - `dragonflybsd` (DragonFlyBSD)
- `easyos` (EasyOS)
- `elementary` (elementary OS) - `elementary` (elementary OS)
- `endeavouros` (EndeavourOS) - `endeavouros` (EndeavourOS)
- `endless` (Endless OS) - `endless` (Endless OS)
@ -318,8 +393,9 @@ edition of windows)
- `garuda` (Garuda Linux) - `garuda` (Garuda Linux)
- `gentoo` (Gentoo) - `gentoo` (Gentoo)
- `ghostbsd` (GhostBSD) - `ghostbsd` (GhostBSD)
- `gnomeos` (GNOME OS)
- `guix` (Guix)
- `haiku` (Haiku) - `haiku` (Haiku)
- `holoiso` (SteamOS HoloISO)
- `kali` (Kali) - `kali` (Kali)
- `kdeneon` (KDE Neon) - `kdeneon` (KDE Neon)
- `kolibrios` (KolibriOS) - `kolibrios` (KolibriOS)
@ -331,21 +407,27 @@ edition of windows)
- `mxlinux` (MX Linux) - `mxlinux` (MX Linux)
- `netboot` (netboot.xyz) - `netboot` (netboot.xyz)
- `netbsd` (NetBSD) - `netbsd` (NetBSD)
- `nitrux` (Nitrux)
- `nixos` (NixOS) - `nixos` (NixOS)
- `openbsd` (OpenBSD) - `openbsd` (OpenBSD)
- `openindiana` (OpenIndiana) - `openindiana` (OpenIndiana)
- `opensuse` (openSUSE) - `opensuse` (openSUSE)
- `oraclelinux` (Oracle Linux) - `oraclelinux` (Oracle Linux)
- `parrotsec` (Parrot Security)
- `peppermint` (PeppermintOS) - `peppermint` (PeppermintOS)
- `popos` (Pop!\_OS) - `popos` (Pop!\_OS)
- `porteus` (Porteus) - `porteus` (Porteus)
- `primtux` (Primtux)
- `reactos` (ReactOS) - `reactos` (ReactOS)
- `rebornos` (RebornOS) - `rebornos` (RebornOS)
- `rockylinux` (Rocky Linux) - `rockylinux` (Rocky Linux)
- `siduction` (Siduction) - `siduction` (Siduction)
- `slackware` (Slackware) - `slackware` (Slackware)
- `slax` (Slax)
- `slint` (Slint)
- `slitaz` (SliTaz GNU/Linux)
- `solus` (Solus) - `solus` (Solus)
- `spiral` (Spiral) - `spirallinux` (Spirallinux)
- `tails` (Tails) - `tails` (Tails)
- `tinycore` (Tiny Core Linux) - `tinycore` (Tiny Core Linux)
- `trisquel` (Trisquel) - `trisquel` (Trisquel)
@ -357,6 +439,8 @@ edition of windows)
- `xerolinux` (XeroLinux) - `xerolinux` (XeroLinux)
- `zorin` (Zorin OS) - `zorin` (Zorin OS)
### Custom Linux guests
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.
@ -382,7 +466,7 @@ quickemu --vm debian-bullseye.conf
- Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to - Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to
enable file sharing. enable file sharing.
## macOS Guest ## Creating macOS Guests 🍏
`quickget` automatically downloads a macOS recovery image and creates a `quickget` automatically downloads a macOS recovery image and creates a
virtual machine configuration. virtual machine configuration.
@ -392,8 +476,8 @@ quickget macos catalina
quickemu --vm macos-catalina.conf quickemu --vm macos-catalina.conf
``` ```
macOS `high-sierra`, `mojave`, `catalina`, `big-sur`, `monterey` and macOS `high-sierra`, `mojave`, `catalina`, `big-sur`, `monterey`,
`ventura` are supported. `ventura` and `sonoma` are supported.
- Use cursor keys and enter key to select the **macOS Base System** - Use cursor keys and enter key to select the **macOS Base System**
- From **macOS Utilities** - From **macOS Utilities**
@ -403,8 +487,8 @@ macOS `high-sierra`, `mojave`, `catalina`, `big-sur`, `monterey` and
click **Erase**. click **Erase**.
- Enter a `Name:` for the disk - Enter a `Name:` for the disk
- If you are installing macOS Mojave or later (Catalina, Big - If you are installing macOS Mojave or later (Catalina, Big
Sur, Monterey and Ventura), choose any of the APFS options Sur, Monterey, Ventura and Sonoma), choose any of the APFS
as the filesystem. MacOS Extended may not work. options as the filesystem. MacOS Extended may not work.
- Click **Erase**. - Click **Erase**.
- Click **Done**. - Click **Done**.
- Close Disk Utility - Close Disk Utility
@ -426,23 +510,17 @@ macOS `high-sierra`, `mojave`, `catalina`, `big-sur`, `monterey` and
macOS disk image will only ever get larger and will not shrink even macOS disk image will only ever get larger and will not shrink even
when you delete lots of data inside macOS. when you delete lots of data inside macOS.
- To enable TRIM, open the Terminal application and type the - To enable TRIM, open the Terminal application and type the
following command followed by pressing following command followed by pressing command on the hard disk
`<kbd>`{=html}enter`</kbd>`{=html} to tell macos to use the TRIM when files are deleted:
command on the hard disk when files are deleted:
``` bash ``` bash
sudo trimforce enable sudo trimforce enable
``` ```
You will be prompted to enter your account's password to gain the You will be prompted to enter your account's password to gain the
privilege needed. Once you've entered your password and pressed privilege needed. Once you've entered your password and pressed in the
`<kbd>`{=html}enter`</kbd>`{=html} the command will request confirmation form of two questions that require you to type response as though you
in the form of two questions that require you to type said "no":
`<kbd>`{=html}y`</kbd>`{=html} (for a "yes" response) followed by
`<kbd>`{=html}enter`</kbd>`{=html} to confirm. If you press
`<kbd>`{=html}enter`</kbd>`{=html} without first typing
`<kbd>`{=html}y`</kbd>`{=html} the system will consider that a negative
response as though you said "no":
``` plain ``` plain
IMPORTANT NOTICE: This tool force-enables TRIM for all relevant attached devices, even though such devices may not have been validated for data integrity while using TRIM. Use of this tool to enable TRIM may result in unintended data loss or data corruption. It should not be used in a commercial operating environment or with important data. Before using this tool, you should back up all of your data and regularly back up data while TRIM is enabled. This tool is provided on an "as is" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS TOOL OR ITS USE ALONE OR IN COMBINATION WITH YOUR DEVICES, SYSTEMS, OR SERVICES. BY USING THIS TOOL TO ENABLE TRIM, YOU AGREE THAT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, USE OF THE TOOL IS AT YOUR SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH YOU. IMPORTANT NOTICE: This tool force-enables TRIM for all relevant attached devices, even though such devices may not have been validated for data integrity while using TRIM. Use of this tool to enable TRIM may result in unintended data loss or data corruption. It should not be used in a commercial operating environment or with important data. Before using this tool, you should back up all of your data and regularly back up data while TRIM is enabled. This tool is provided on an "as is" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS TOOL OR ITS USE ALONE OR IN COMBINATION WITH YOUR DEVICES, SYSTEMS, OR SERVICES. BY USING THIS TOOL TO ENABLE TRIM, YOU AGREE THAT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, USE OF THE TOOL IS AT YOUR SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH YOU.
@ -487,6 +565,7 @@ There are some considerations when running macOS via Quickemu.
- Big Sur - Big Sur
- Monterey - Monterey
- Ventura - Ventura
- Sonoma
- `quickemu` will automatically download the required - `quickemu` will automatically download the required
[OpenCore](https://github.com/acidanthera/OpenCorePkg) bootloader [OpenCore](https://github.com/acidanthera/OpenCorePkg) bootloader
and OVMF firmware from [OSX-KVM](https://github.com/kholia/OSX-KVM). and OVMF firmware from [OSX-KVM](https://github.com/kholia/OSX-KVM).
@ -534,18 +613,28 @@ sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
Now reboot, and the App Store should work. Now reboot, and the App Store should work.
## Windows 8, 10 & 11 Guests ## Creating Windows guests 🪟
`quickget` can download `quickget` can download [**Windows
[Windows10](https://www.microsoft.com/software-download/windows10) and 10**](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/).
Windows 8.1 is also supported but doesn't feature any automated **Windows 8.1** is also supported but doesn't feature any automated
installation or driver optimisation. installation or driver optimisation.
`quickget` can also download [Windows 10
LTSC](https://www.microsoft.com/en-us/evalcenter/download-windows-10-enterprise)
and Windows Server
[2012-r2](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2012-r2),
[2016](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2016),
[2019](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2019),
and
[2022](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2022).
No automated installation is supported for these releases.
``` bash ``` bash
quickget windows 11 quickget windows 11
quickemu --vm windows-11.conf quickemu --vm windows-11.conf
@ -558,6 +647,16 @@ quickemu --vm windows-11.conf
- Username: `Quickemu` - Username: `Quickemu`
- Password: `quickemu` - Password: `quickemu`
### Regional versions
By default `quickget` will download the *"English International"*
release (*"English (United States)"* for server releases), but you can
optionally specify one of the supported languages: For example:
``` bash
quickget windows 11 "Chinese (Traditional)"
```
The default Windows 11 configuration looks like this: The default Windows 11 configuration looks like this:
``` bash ``` bash
@ -574,15 +673,15 @@ secureboot="off"
- `tpm="on"` instructs `quickemu` to create a software emulated TPM - `tpm="on"` instructs `quickemu` to create a software emulated TPM
device using `swtpm`. device using `swtpm`.
# All the options ## Configuration
Here are the usage instructions: Here are the usage instructions:
Usage Usage
quickemu --vm ubuntu.conf quickemu --vm ubuntu.conf [optional params]
You can also pass optional parameters List of optional parameters:
--access : Enable remote spice access support. 'local' (default), 'remote', 'clientipaddress' --access : Enable remote spice access support. 'local' (default), 'remote', 'clientipaddress'
--braille : Enable braille support. Requires SDL. --braille : Enable braille support. Requires SDL.
--delete-disk : Delete the disk image and EFI variables --delete-disk : Delete the disk image and EFI variables
@ -599,6 +698,8 @@ Here are the usage instructions:
--snapshot info : Show disk/snapshot info. --snapshot info : Show disk/snapshot info.
--status-quo : Do not commit any changes to disk/snapshot. --status-quo : Do not commit any changes to disk/snapshot.
--viewer <viewer> : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none' --viewer <viewer> : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none'
--width <width> : Set VM screen width. Does nothing without --height
--height <height> : Set VM screen height. Does nothing without --width
--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'
@ -677,7 +778,7 @@ 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.**
# References ## References
Useful reference that assisted the development of Quickemu. Useful reference that assisted the development of Quickemu.
@ -690,6 +791,7 @@ Useful reference that assisted the development of Quickemu.
- <https://passthroughpo.st/mac-os-adds-early-support-for-virtio-qemu/> - <https://passthroughpo.st/mac-os-adds-early-support-for-virtio-qemu/>
- <https://github.com/kholia/OSX-KVM> - <https://github.com/kholia/OSX-KVM>
- <https://github.com/thenickdude/KVM-Opencore> - <https://github.com/thenickdude/KVM-Opencore>
- <https://gist.github.com/MCJack123/943eaca762730ca4b7ae460b731b68e7>
- <https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macrecovery> - <https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macrecovery>
- <https://www.kraxel.org/blog/2017/09/running-macos-as-guest-in-kvm/> - <https://www.kraxel.org/blog/2017/09/running-macos-as-guest-in-kvm/>
- <https://www.nicksherlock.com/2017/10/passthrough-of-advanced-cpu-features-for-macos-high-sierra-guests/> - <https://www.nicksherlock.com/2017/10/passthrough-of-advanced-cpu-features-for-macos-high-sierra-guests/>

View File

@ -1,8 +1,8 @@
.\" Automatically generated by Pandoc 3.1.9 .\" Automatically generated by Pandoc 3.1.12.3
.\" .\"
.TH "QUICKEMU_CONF" "1" "November 26, 2023" "quickemu_conf" "Quickemu Configuration Manual" .TH "QUICKEMU_CONF" "1" "April 12, 2024" "quickemu_conf" "Quickemu Configuration Manual"
.SH NAME .SH NAME
quickemu_conf - Options and parameters in the quickemu <vm>.conf quickemu_conf \- Options and parameters in the quickemu <vm>.conf
.SH DESCRIPTION .SH DESCRIPTION
\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.
@ -14,7 +14,7 @@ VM
These are the options and defaults for the <vm>.conf file These are the options and defaults for the <vm>.conf file
.IP .IP
.EX .EX
# Lowercase variables are used in the VM config file only \f[I]# Lowercase variables are used in the VM config file only\f[R]
boot=\[dq]efi\[dq] boot=\[dq]efi\[dq]
cpu_cores=\[dq]\[dq] cpu_cores=\[dq]\[dq]
disk_img=\[dq]\[dq] disk_img=\[dq]\[dq]
@ -46,28 +46,28 @@ monitor_cmd=\[dq]\[dq]
serial=\[dq]socket\[dq] serial=\[dq]socket\[dq]
serial_telnet_port=\[dq]6660\[dq] serial_telnet_port=\[dq]6660\[dq]
serial_telnet_host=\[dq]localhost\[dq] serial_telnet_host=\[dq]localhost\[dq]
# options: ehci(USB2.0), xhci(USB3.0) \f[I]# options: ehci(USB2.0), xhci(USB3.0)\f[R]
usb_controller=\[dq]ehci\[dq] usb_controller=\[dq]ehci\[dq]
# options: ps2, usb, virtio \f[I]# options: ps2, usb, virtio\f[R]
keyboard=\[dq]usb\[dq] keyboard=\[dq]usb\[dq]
keyboard_layout=\[dq]en-us\[dq] keyboard_layout=\[dq]en\-us\[dq]
# options: ps2, usb, tablet, virtio \f[I]# options: ps2, usb, tablet, virtio\f[R]
mouse=\[dq]tablet\[dq] mouse=\[dq]tablet\[dq]
.EE .EE
.SH EXAMPLES .SH EXAMPLES
.IP .IP
.EX .EX
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]
.EE .EE
.PP .PP
The default macOS configuration looks like this: The default macOS configuration looks like this:
.IP .IP
.EX .EX
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]
.EE .EE
.IP \[bu] 2 .IP \[bu] 2
@ -89,9 +89,9 @@ The default Windows 11 configuration looks like this:
.IP .IP
.EX .EX
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]
.EE .EE
@ -104,13 +104,13 @@ drivers.
.IP \[bu] 2 .IP \[bu] 2
\f[CR]tpm=\[dq]on\[dq]\f[R] instructs \f[CR]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[CR]swtpm\f[R]. software emulated TPM device using \f[CR]swtpm\f[R].
.SH BIOS and EFI .SS BIOS and EFI
Since Quickemu 2.1.0 \f[CR]efi\f[R] is the default boot option. Since Quickemu 2.1.0 \f[CR]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[CR]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 .SS Tuning CPU cores, RAM & disks
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
@ -118,13 +118,13 @@ 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[CR]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[CR]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[CR]disk_size=\[dq]16G\[dq]\f[R] - Specify the size of the virtual \f[CR]disk_size=\[dq]16G\[dq]\f[R] \- Specify the size of the virtual
disk allocated to the VM disk allocated to the VM
.SS Disk preallocation .SS Disk preallocation
Preallocation mode (allowed values: \f[CR]off\f[R] (default), Preallocation mode (allowed values: \f[CR]off\f[R] (default),
@ -137,7 +137,7 @@ the system disk image by adding a line like this to your VM
configuration. configuration.
.IP \[bu] 2 .IP \[bu] 2
\f[CR]preallocation=\[dq]metadata\[dq]\f[R] \f[CR]preallocation=\[dq]metadata\[dq]\f[R]
.SS CD-ROM disks .SS CD\-ROM disks
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
@ -151,18 +151,18 @@ Alan Pope
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[CR]floppy=\[dq]/path/to/floppy.img\[dq]\f[R] \f[CR]floppy=\[dq]/path/to/floppy.img\[dq]\f[R]
.SH File Sharing .SS File Sharing
All File Sharing options will only expose \f[CR]\[ti]/Public\f[R] (or All File Sharing options will only expose \f[CR]\[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 🐧 🍏 🪟
If \f[CR]smbd\f[R] is available on the host, Quickemu will automatically If \f[CR]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
.EX .EX
sudo apt install --no-install-recommends samba sudo apt install \-\-no\-install\-recommends samba
.EE .EE
.PP .PP
If everything is set up correctly, the \f[CR]smbd\f[R] address will be If everything is set up correctly, the \f[CR]smbd\f[R] address will be
@ -170,20 +170,21 @@ printed when the virtual machine is started.
For example: For example:
.IP .IP
.EX .EX
- smbd: On guest: smb://10.0.2.4/qemu \- smbd: On guest: smb://10.0.2.4/qemu
.EE .EE
.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[CR]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[CR]\[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
.SS VirtIO-9P 🐧 🍏 .SS VirtIO\-9P 🐧 🍏
.IP \[bu] 2 .IP \[bu] 2
TBD TBD
.SH Network port forwarding .SS Networking
.SS Port forwarding
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
@ -194,12 +195,12 @@ In the example above:
Port 8123 on the host is forwarded to port 8123 on the guest. 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 .SS Disable networking
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[CR]network=\[dq]none\[dq]\f[R] \f[CR]network=\[dq]none\[dq]\f[R]
.SH Restricted networking .SS Restricted networking
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.
@ -209,7 +210,7 @@ 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[CR]network=\[dq]restrict\[dq]\f[R] \f[CR]network=\[dq]restrict\[dq]\f[R]
.SH Bridged networking .SS Bridged networking
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
@ -219,21 +220,39 @@ If you want to have a persistent MAC address for your bridged network
interface in the guest VM you can add \f[CR]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[CR]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 .SS USB redirection
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)
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[CR]--display spice\f[R] any elevated permission:
and then select \f[CR]Input\f[R] -> .IP \[bu] 2
\f[CR]Select USB Device for redirection\f[R] from the menu to choose Start Quickemu with \f[CR]\-\-display spice\f[R] and then
which device(s) you want to attach to the guest. .IP \[bu] 2
.SS Host redirection \f[B]NOT Recommended\f[R] select \f[CR]Input\f[R] \-> \f[CR]Select USB Device for redirection\f[R]
from the menu to choose which device(s) you want to attach to the guest.
.SS Enabling SPICE redirection on NixOS
On NixOS, if you encounter this error:
.IP
.EX
Error setting facl: Operation not permitted
.EE
.PP
Try setting \c
.UR https://search.nixos.org/options?channel=23.11&show=virtualisation.spiceUSBRedirection.enable&from=0&size=50&sort=relevance&type=packages&query=spiceusbredirec
the following option
.UE \c
:
.IP
.EX
virtualisation.spiceUSBRedirection.enable = true;
.EE
.SS Host redirection (\f[B]NOT Recommended\f[R])
\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.
@ -256,12 +275,12 @@ the appropriate commands to modify the USB device(s) access permissions,
like this: like this:
.IP .IP
.EX .EX
- 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 👆
.EE .EE
.SH TPM .SS TPM
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[CR]tpm=\[dq]on\[dq]\f[R] to your VM configuration. Just add \f[CR]tpm=\[dq]on\[dq]\f[R] to your VM configuration.

View File

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: November 26, 2023 date: April 12, 2024
footer: quickemu_conf footer: quickemu_conf
header: Quickemu Configuration Manual header: Quickemu Configuration Manual
section: 1 section: 1
@ -106,7 +106,7 @@ secureboot="on"
- `tpm="on"` instructs `quickemu` to create a software emulated TPM - `tpm="on"` instructs `quickemu` to create a software emulated TPM
device using `swtpm`. device using `swtpm`.
# BIOS and EFI ### BIOS and EFI
Since Quickemu 2.1.0 `efi` is the default boot option. If you want to Since Quickemu 2.1.0 `efi` is the default boot option. If you want to
override this behaviour then add the following line to you VM override this behaviour then add the following line to you VM
@ -114,7 +114,7 @@ configuration to enable legacy BIOS.
- `boot="legacy"` - Enable Legacy BIOS boot - `boot="legacy"` - Enable Legacy BIOS boot
# Tuning CPU cores, RAM & disks ### Tuning CPU cores, RAM & disks
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. You allocate to a VM based on the specifications of your host computer. You
@ -129,7 +129,7 @@ Add additional lines to your virtual machine configuration:
- `disk_size="16G"` - Specify the size of the virtual disk allocated - `disk_size="16G"` - Specify the size of the virtual disk allocated
to the VM to the VM
## Disk preallocation ### Disk preallocation
Preallocation mode (allowed values: `off` (default), `metadata`, Preallocation mode (allowed values: `off` (default), `metadata`,
`falloc`, `full`). An image with preallocated metadata is initially `falloc`, `full`). An image with preallocated metadata is initially
@ -141,14 +141,14 @@ configuration.
- `preallocation="metadata"` - `preallocation="metadata"`
## CD-ROM disks ### CD-ROM disks
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:
- `fixed_iso="/path/to/image.iso"` - `fixed_iso="/path/to/image.iso"`
## Floppy disks ### Floppy disks
If you're like [Alan Pope](https://popey.com) you'll probably want to If you're like [Alan Pope](https://popey.com) you'll probably want to
mount a floppy disk image in the guest. To do so add the following line mount a floppy disk image in the guest. To do so add the following line
@ -156,12 +156,12 @@ to the VM configuration:
- `floppy="/path/to/floppy.img"` - `floppy="/path/to/floppy.img"`
# File Sharing ### File Sharing
All File Sharing options will only expose `~/Public` (or localised All File Sharing options will only expose `~/Public` (or localised
variations) for the current user to the guest VMs. variations) for the current user to the guest VMs.
## Samba 🐧 🍏 🪟 #### Samba 🐧 🍏 🪟
If `smbd` is available on the host, Quickemu will automatically enable If `smbd` is available on the host, Quickemu will automatically enable
the built-in QEMU support for exposing a Samba share from the host to the built-in QEMU support for exposing a Samba share from the host to
@ -182,15 +182,17 @@ If using a Windows guest, right-click on "This PC", click "Add a network
location", and paste this address, removing `smb:` and replacing forward location", and paste this address, removing `smb:` and replacing forward
slashes with backslashes (in this example `\\10.0.2.4\qemu`). slashes with backslashes (in this example `\\10.0.2.4\qemu`).
## SPICE WebDAV 🐧 🪟 #### SPICE WebDAV 🐧 🪟
- TBD - TBD
## VirtIO-9P 🐧 🍏 #### VirtIO-9P 🐧 🍏
- TBD - TBD
# Network port forwarding ### Networking
#### Port forwarding
Add an additional line to your virtual machine configuration. For Add an additional line to your virtual machine configuration. For
example: example:
@ -202,14 +204,14 @@ In the example above:
- Port 8123 on the host is forwarded to port 8123 on the guest. - Port 8123 on the host is forwarded to port 8123 on the guest.
- Port 8888 on the host is forwarded to port 80 on the guest. - Port 8888 on the host is forwarded to port 80 on the guest.
# Disable networking #### Disable networking
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:
- `network="none"` - `network="none"`
# Restricted networking #### Restricted networking
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
@ -221,7 +223,7 @@ additional line to your virtual machine configuration:
- `network="restrict"` - `network="restrict"`
# Bridged networking #### Bridged networking
Connect your virtual machine to a preconfigured network bridge. Add an Connect your virtual machine to a preconfigured network bridge. Add an
additional line to your virtual machine configuration: additional line to your virtual machine configuration:
@ -237,19 +239,34 @@ So you can generate your own MAC addresses with:
- `macaddr="52:54:00:AB:51:AE"` - `macaddr="52:54:00:AB:51:AE"`
# USB redirection ### USB redirection
Quickemu supports USB redirection via SPICE pass-through and host Quickemu supports USB redirection via SPICE pass-through and host
pass-through. pass-through.
## SPICE redirection (recommended) #### SPICE redirection (recommended)
Using SPICE for USB pass-through is easiest as it doesn't require any Using SPICE for USB pass-through is easiest as it doesn't require any
elevated permission, start Quickemu with `--display spice` and then elevated permission:
select `Input` -\> `Select USB Device for redirection` from the menu to
choose which device(s) you want to attach to the guest.
## Host redirection **NOT Recommended** - Start Quickemu with `--display spice` and then
- select `Input` -\> `Select USB Device for redirection` from the menu
to choose which device(s) you want to attach to the guest.
##### Enabling SPICE redirection on NixOS
On NixOS, if you encounter this error:
Error setting facl: Operation not permitted
Try setting [the following
option](https://search.nixos.org/options?channel=23.11&show=virtualisation.spiceUSBRedirection.enable&from=0&size=50&sort=relevance&type=packages&query=spiceusbredirec):
``` nix
virtualisation.spiceUSBRedirection.enable = true;
```
#### Host redirection (**NOT Recommended**)
**USB host redirection is not recommended**, it is provided purely for **USB host redirection is not recommended**, it is provided purely for
backwards compatibility to older versions of Quickemu. Using SPICE is backwards compatibility to older versions of Quickemu. Using SPICE is
@ -276,7 +293,7 @@ like this:
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 👆
# TPM ### TPM
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. Just add `tpm="on"` to your VM configuration. guest virtual machines. Just add `tpm="on"` to your VM configuration.

View File

@ -1,8 +1,8 @@
.\" Automatically generated by Pandoc 3.1.9 .\" Automatically generated by Pandoc 3.1.12.3
.\" .\"
.TH "QUICKGET" "1" "November 26, 2023" "quickget" "Quickget User Manual" .TH "QUICKGET" "1" "April 12, 2024" "quickget" "Quickget User Manual"
.SH NAME .SH NAME
quickget - download and prepare materials for building a quickemu VM quickget \- download and prepare materials for building a quickemu VM
.SH SYNOPSIS .SH SYNOPSIS
\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]]*
@ -11,19 +11,19 @@ quickget - download and prepare materials for building a quickemu VM
configuration for \f[CR]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]
show version (from Quickemu) show version (from Quickemu)
.TP .TP
\f[B]list | list_csv | list_json\f[R] \f[B]list | list_csv | list_json\f[R]
provide a csv list of all supported guest OSes, versions and variants. provide a csv list of all supported guest OSes, versions and variants.
.TP .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]] \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 show ISO download URL
.TP .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]] \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 test if ISO is available
.TP .TP
\f[B]\f[CB]--open-distro-homepage\f[B] | -o\f[R] {\f[B]os\f[R]} \f[B]\f[CB]\-\-open\-distro\-homepage\f[B] | \-o\f[R] {\f[B]os\f[R]}
open OS homepage in browser open OS homepage in browser
.TP .TP
\f[B][OS] [Release] [Edition]\f[R] \f[B][OS] [Release] [Edition]\f[R]
@ -32,41 +32,42 @@ is provided a list of missing options will be reported and the script
will exit. will exit.
Editions may not apply and will be defaulted if not provided. Editions may not apply and will be defaulted if not provided.
.SH NOTES .SH NOTES
.SS Ubuntu Guest .SS Creating Linux guests 🐧
.SS Ubuntu
\f[CR]quickget\f[R] will automatically download an Ubuntu release and \f[CR]quickget\f[R] will automatically download an Ubuntu release and
create the virtual machine configuration. create the virtual machine configuration.
.IP .IP
.EX .EX
quickget ubuntu 22.04 quickget ubuntu 22.04
quickemu --vm ubuntu-22.04.conf quickemu \-\-vm ubuntu\-22.04.conf
.EE .EE
.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[CR]spice-vdagent\f[R]) in the guest to Install the SPICE agent (\f[CR]spice\-vdagent\f[R]) in the guest to
enable copy/paste and USB redirection enable copy/paste and USB redirection
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
\f[CR]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[CR]spice-webdavd\f[R]) in the guest Install the SPICE WebDAV agent (\f[CR]spice\-webdavd\f[R]) in the guest
to enable file sharing. to enable file sharing.
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
\f[CR]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
\f[CR]quickget\f[R] can also download/refresh devel images via \f[CR]quickget\f[R] can also download/refresh devel images via
\f[CR]zsync\f[R] for Ubuntu developers and testers. \f[CR]zsync\f[R] for Ubuntu developers and testers.
.IP .IP
.EX .EX
quickget ubuntu devel quickget ubuntu devel
quickemu --vm ubuntu-devel.conf quickemu \-\-vm ubuntu\-devel.conf
.EE .EE
.PP .PP
You can run \f[CR]quickget ubuntu devel\f[R] to refresh your daily You can run \f[CR]quickget ubuntu devel\f[R] to refresh your daily
@ -82,21 +83,21 @@ All the official Ubuntu flavours are supported, just replace
.IP \[bu] 2 .IP \[bu] 2
\f[CR]lubuntu\f[R] (Lubuntu) \f[CR]lubuntu\f[R] (Lubuntu)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]ubuntu-budgie\f[R] (Ubuntu Budgie) \f[CR]ubuntu\-budgie\f[R] (Ubuntu Budgie)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]ubuntucinnamon\f[R] (Ubuntu Cinnamon) \f[CR]ubuntucinnamon\f[R] (Ubuntu Cinnamon)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]ubuntukylin\f[R] (Ubuntu Kylin) \f[CR]ubuntukylin\f[R] (Ubuntu Kylin)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]ubuntu-mate\f[R] (Ubuntu MATE) \f[CR]ubuntu\-mate\f[R] (Ubuntu MATE)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]ubuntu-server\f[R] (Ubuntu Server) \f[CR]ubuntu\-server\f[R] (Ubuntu Server)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]ubuntustudio\f[R] (Ubuntu Studio) \f[CR]ubuntustudio\f[R] (Ubuntu Studio)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]ubuntu\f[R] (Ubuntu) \f[CR]ubuntu\f[R] (Ubuntu)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]ubuntu-unity\f[R] (Ubuntu Unity) \f[CR]ubuntu\-unity\f[R] (Ubuntu Unity)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]xubuntu\f[R] (Xubuntu) \f[CR]xubuntu\f[R] (Xubuntu)
.PP .PP
@ -104,16 +105,18 @@ You can also use \f[CR]quickget\f[R] with options to:
.IP .IP
.EX .EX
# show an OS ISO download URL for {os} {release} [edition] # show an OS ISO download URL for {os} {release} [edition]
quickget --show-iso-url fedora 38 Silverblue quickget \-\-show\-iso\-url fedora 38 Silverblue
# test if and OS ISO is available for {os} {release} [edition] # test if an OS ISO is available for {os} {release} [edition]
quickget --test-iso-url nixos 23.05 plasma5 quickget \-\-test\-iso\-url nixos 23.05 plasma5
# open an OS distribution homepage in a browser # open an OS distribution homepage in a browser
quickget --open-distro-homepage ubuntu-mate quickget \-\-open\-distro\-homepage ubuntu\-mate
# Only download image file into current directory, without creating VM
quickget \-\-download\-iso elementary 7.1
.EE .EE
.PP .PP
The \f[CR]--show-iso-url\f[R] and \f[CR]--test-iso-url\f[R] options The \f[CR]\-\-show\-iso\-url\f[R], \f[CR]\-\-test\-iso\-url\f[R], and
\f[B]do not\f[R] work for \f[CR]Windows\f[R] (\f[CR]quickget\f[R] will \f[CR]\-\-download\-iso\f[R] options are fully functional for all
begin downloading the requested release and edition of windows) operating systems, including Windows and macOS.
.SS Other Operating Systems .SS Other Operating Systems
\f[CR]quickget\f[R] also supports: \f[CR]quickget\f[R] also supports:
.IP \[bu] 2 .IP \[bu] 2
@ -131,8 +134,16 @@ begin downloading the requested release and edition of windows)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]arcolinux\f[R] (Arco Linux) \f[CR]arcolinux\f[R] (Arco Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]artixlinux\f[R] (Artix Linux)
.IP \[bu] 2
\f[CR]athenaos\f[R] (Athenaos)
.IP \[bu] 2
\f[CR]batocera\f[R] (Batocera) \f[CR]batocera\f[R] (Batocera)
.IP \[bu] 2 .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) \f[CR]blendos\f[R] (BlendOS)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]bodhi\f[R] (Bodhi) \f[CR]bodhi\f[R] (Bodhi)
@ -141,7 +152,11 @@ begin downloading the requested release and edition of windows)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]cachyos\f[R] (CachyOS) \f[CR]cachyos\f[R] (CachyOS)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]centos-stream\f[R] (CentOS Stream) \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] (Crunchbang++)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]debian\f[R] (Debian) \f[CR]debian\f[R] (Debian)
.IP \[bu] 2 .IP \[bu] 2
@ -151,6 +166,8 @@ begin downloading the requested release and edition of windows)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]dragonflybsd\f[R] (DragonFlyBSD) \f[CR]dragonflybsd\f[R] (DragonFlyBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]easyos\f[R] (EasyOS)
.IP \[bu] 2
\f[CR]elementary\f[R] (elementary OS) \f[CR]elementary\f[R] (elementary OS)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]endeavouros\f[R] (EndeavourOS) \f[CR]endeavouros\f[R] (EndeavourOS)
@ -169,9 +186,11 @@ begin downloading the requested release and edition of windows)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]ghostbsd\f[R] (GhostBSD) \f[CR]ghostbsd\f[R] (GhostBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]haiku\f[R] (Haiku) \f[CR]gnomeos\f[R] (GNOME OS)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]holoiso\f[R] (SteamOS HoloISO) \f[CR]guix\f[R] (Guix)
.IP \[bu] 2
\f[CR]haiku\f[R] (Haiku)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]kali\f[R] (Kali) \f[CR]kali\f[R] (Kali)
.IP \[bu] 2 .IP \[bu] 2
@ -195,6 +214,8 @@ begin downloading the requested release and edition of windows)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]netbsd\f[R] (NetBSD) \f[CR]netbsd\f[R] (NetBSD)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]nitrux\f[R] (Nitrux)
.IP \[bu] 2
\f[CR]nixos\f[R] (NixOS) \f[CR]nixos\f[R] (NixOS)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]openbsd\f[R] (OpenBSD) \f[CR]openbsd\f[R] (OpenBSD)
@ -205,12 +226,16 @@ begin downloading the requested release and edition of windows)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]oraclelinux\f[R] (Oracle Linux) \f[CR]oraclelinux\f[R] (Oracle Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]parrotsec\f[R] (Parrot Security)
.IP \[bu] 2
\f[CR]peppermint\f[R] (PeppermintOS) \f[CR]peppermint\f[R] (PeppermintOS)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]popos\f[R] (Pop!_OS) \f[CR]popos\f[R] (Pop!_OS)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]porteus\f[R] (Porteus) \f[CR]porteus\f[R] (Porteus)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]primtux\f[R] (Primtux)
.IP \[bu] 2
\f[CR]reactos\f[R] (ReactOS) \f[CR]reactos\f[R] (ReactOS)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]rebornos\f[R] (RebornOS) \f[CR]rebornos\f[R] (RebornOS)
@ -221,9 +246,15 @@ begin downloading the requested release and edition of windows)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]slackware\f[R] (Slackware) \f[CR]slackware\f[R] (Slackware)
.IP \[bu] 2 .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 GNU/Linux)
.IP \[bu] 2
\f[CR]solus\f[R] (Solus) \f[CR]solus\f[R] (Solus)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]spiral\f[R] (Spiral) \f[CR]spirallinux\f[R] (Spirallinux)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]tails\f[R] (Tails) \f[CR]tails\f[R] (Tails)
.IP \[bu] 2 .IP \[bu] 2
@ -231,9 +262,9 @@ begin downloading the requested release and edition of windows)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]trisquel\f[R] (Trisquel) \f[CR]trisquel\f[R] (Trisquel)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]truenas-core\f[R] (TrueNAS Core) \f[CR]truenas\-core\f[R] (TrueNAS Core)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]truenas-scale\f[R] (TrueNAS Scale) \f[CR]truenas\-scale\f[R] (TrueNAS Scale)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]vanillaos\f[R] (Vanilla OS) \f[CR]vanillaos\f[R] (Vanilla OS)
.IP \[bu] 2 .IP \[bu] 2
@ -244,50 +275,50 @@ begin downloading the requested release and edition of windows)
\f[CR]xerolinux\f[R] (XeroLinux) \f[CR]xerolinux\f[R] (XeroLinux)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]zorin\f[R] (Zorin OS) \f[CR]zorin\f[R] (Zorin OS)
.PP .SS Custom Linux guests
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.
.IP \[bu] 2 .IP \[bu] 2
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[CR]debian-bullseye.conf\f[R] \f[CR]debian\-bullseye.conf\f[R]
.IP .IP
.EX .EX
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]
.EE .EE
.IP \[bu] 2 .IP \[bu] 2
Use \f[CR]quickemu\f[R] to start the virtual machine: Use \f[CR]quickemu\f[R] to start the virtual machine:
.IP .IP
.EX .EX
quickemu --vm debian-bullseye.conf quickemu \-\-vm debian\-bullseye.conf
.EE .EE
.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[CR]spice-vdagent\f[R]) in the guest to Install the SPICE agent (\f[CR]spice\-vdagent\f[R]) in the guest to
enable copy/paste and USB redirection. enable copy/paste and USB redirection.
.IP \[bu] 2 .IP \[bu] 2
Install the SPICE WebDAV agent (\f[CR]spice-webdavd\f[R]) in the guest Install the SPICE WebDAV agent (\f[CR]spice\-webdavd\f[R]) in the guest
to enable file sharing. to enable file sharing.
.RE .RE
.SS macOS Guest .SS Creating macOS Guests 🍏
\f[CR]quickget\f[R] automatically downloads a macOS recovery image and \f[CR]quickget\f[R] automatically downloads a macOS recovery image and
creates a virtual machine configuration. creates a virtual machine configuration.
.IP .IP
.EX .EX
quickget macos catalina quickget macos catalina
quickemu --vm macos-catalina.conf quickemu \-\-vm macos\-catalina.conf
.EE .EE
.PP .PP
macOS \f[CR]high-sierra\f[R], \f[CR]mojave\f[R], \f[CR]catalina\f[R], 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] and \f[CR]ventura\f[R] are \f[CR]big\-sur\f[R], \f[CR]monterey\f[R], \f[CR]ventura\f[R] and
supported. \f[CR]sonoma\f[R] are supported.
.IP \[bu] 2 .IP \[bu] 2
Use cursor keys and enter key to select the \f[B]macOS Base System\f[R] Use cursor keys and enter key to select the \f[B]macOS Base System\f[R]
.IP \[bu] 2 .IP \[bu] 2
@ -303,8 +334,9 @@ click \f[B]Erase\f[R].
.IP \[bu] 2 .IP \[bu] 2
Enter a \f[CR]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,
and Ventura), choose any of the APFS options as the filesystem. Monterey, Ventura and Sonoma), choose any of the APFS options as the
filesystem.
MacOS Extended may not work. MacOS Extended may not work.
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
@ -332,10 +364,10 @@ disk you named
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
Once you have finished installing macOS you will be presented with an 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 the out\-of\-the\-box first\-start wizard to configure various options
set up your username and password and set up your username and password
.IP \[bu] 2 .IP \[bu] 2
OPTIONAL: After you have concluded the out-of-the-box wizard, you may 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 want to enable the TRIM feature that the computer industry created for
SSD disks. SSD disks.
This feature in our macOS installation will allow QuickEmu to compact This feature in our macOS installation will allow QuickEmu to compact
@ -346,8 +378,8 @@ will not shrink even when you delete lots of data inside macOS.
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
To enable TRIM, open the Terminal application and type the following To enable TRIM, open the Terminal application and type the following
command followed by pressing enter to tell macos to use the TRIM command command followed by pressing command on the hard disk when files are
on the hard disk when files are deleted: deleted:
.RE .RE
.IP .IP
.EX .EX
@ -356,14 +388,12 @@ sudo trimforce enable
.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.
Once you\[cq]ve entered your password and pressed enter the command will Once you\[cq]ve entered your password and pressed in the form of two
request confirmation in the form of two questions that require you to questions that require you to type response as though you said
type y (for a \[lq]yes\[rq] response) followed by enter to confirm. \[lq]no\[rq]:
If you press enter without first typing y the system will consider that
a negative response as though you said \[lq]no\[rq]:
.IP .IP
.EX .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. 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)?
.EE .EE
.PP .PP
@ -381,8 +411,8 @@ The default macOS configuration looks like this:
.IP .IP
.EX .EX
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]
.EE .EE
.IP \[bu] 2 .IP \[bu] 2
@ -416,6 +446,8 @@ Big Sur
Monterey Monterey
.IP \[bu] 2 .IP \[bu] 2
Ventura Ventura
.IP \[bu] 2
Sonoma
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
\f[CR]quickemu\f[R] will automatically download the required \c \f[CR]quickemu\f[R] will automatically download the required \c
@ -424,7 +456,7 @@ OpenCore
.UE \c .UE \c
\ bootloader and OVMF firmware from \c \ bootloader and OVMF firmware from \c
.UR https://github.com/kholia/OSX-KVM .UR https://github.com/kholia/OSX-KVM
OSX-KVM OSX\-KVM
.UE \c .UE \c
\&. \&.
.IP \[bu] 2 .IP \[bu] 2
@ -441,18 +473,18 @@ VirtIO Block Media
.IP \[bu] 2 .IP \[bu] 2
\c \c
.UR http://philjordan.eu/osx-virt/ .UR http://philjordan.eu/osx-virt/
VirtIO \f[CR]usb-tablet\f[R] VirtIO \f[CR]usb\-tablet\f[R]
.UE \c .UE \c
\ is used for the mouse. \ is used for the mouse.
.IP \[bu] 2 .IP \[bu] 2
VirtIO Network (\f[CR]virtio-net\f[R]) is supported and enabled on macOS VirtIO Network (\f[CR]virtio\-net\f[R]) is supported and enabled on
Big Sur and newer but previous releases use \f[CR]vmxnet3\f[R]. macOS 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.
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
USB host and SPICE pass-through is: USB host and SPICE pass\-through is:
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
UHCI (USB 2.0) on macOS Catalina and earlier. UHCI (USB 2.0) on macOS Catalina and earlier.
@ -466,7 +498,7 @@ Display resolution can only be changed via macOS System Preferences.
.UR https://github.com/chris1111/VoodooHDA-OC .UR https://github.com/chris1111/VoodooHDA-OC
VoodooHDA OC VoodooHDA OC
.UE \c .UE \c
\ or pass-through a USB audio-device to the macOS guest VM\f[R]. \ or pass\-through a USB audio\-device to the macOS guest VM\f[R].
.IP \[bu] 2 .IP \[bu] 2
NOTE! NOTE!
\c \c
@ -474,15 +506,14 @@ NOTE!
Gatekeeper Gatekeeper
.UE \c .UE \c
\ and \c \ and \c
.UR .UR https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection
https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection
System Integrity Protection (SIP) System Integrity Protection (SIP)
.UE \c .UE \c
\ need to be disabled to install VoodooHDA OC \ need to be disabled to install VoodooHDA OC
.IP \[bu] 2 .IP \[bu] 2
File sharing between guest and host is available via \c File sharing between guest and host is available via \c
.UR https://wiki.qemu.org/Documentation/9psetup .UR https://wiki.qemu.org/Documentation/9psetup
virtio-9p virtio\-9p
.UE \c .UE \c
\ and \c \ and \c
.UR https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24 .UR https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24
@ -498,7 +529,7 @@ that your wired ethernet device is \f[CR]en0\f[R].
Use \f[CR]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[CR]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
@ -507,14 +538,14 @@ sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
.EE .EE
.PP .PP
Now reboot, and the App Store should work. Now reboot, and the App Store should work.
.SS Windows 8, 10 & 11 Guests .SS Creating Windows guests 🪟
\f[CR]quickget\f[R] can download \c \f[CR]quickget\f[R] can download \c
.UR https://www.microsoft.com/software-download/windows10 .UR https://www.microsoft.com/software-download/windows10
Windows10 \f[B]Windows 10\f[R]
.UE \c .UE \c
\ and \c \ and \c
.UR https://www.microsoft.com/software-download/windows11 .UR https://www.microsoft.com/software-download/windows11
Windows 11 \f[B]Windows 11\f[R]
.UE \c .UE \c
\ automatically and create an optimised virtual machine configuration. \ automatically and create an optimised virtual machine configuration.
This configuration also includes the \c This configuration also includes the \c
@ -523,12 +554,35 @@ VirtIO drivers for Windows
.UE \c .UE \c
\&. \&.
.PP .PP
Windows 8.1 is also supported but doesn\[cq]t feature any automated \f[B]Windows 8.1\f[R] is also supported but doesn\[cq]t feature any
installation or driver optimisation. 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 .IP
.EX .EX
quickget windows 11 quickget windows 11
quickemu --vm windows-11.conf quickemu \-\-vm windows\-11.conf
.EE .EE
.IP \[bu] 2 .IP \[bu] 2
Complete the installation as you normally would. Complete the installation as you normally would.
@ -543,14 +597,23 @@ Username: \f[CR]Quickemu\f[R]
.IP \[bu] 2 .IP \[bu] 2
Password: \f[CR]quickemu\f[R] Password: \f[CR]quickemu\f[R]
.RE .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 .PP
The default Windows 11 configuration looks like this: The default Windows 11 configuration looks like this:
.IP .IP
.EX .EX
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]off\[dq] secureboot=\[dq]off\[dq]
.EE .EE

View File

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: November 26, 2023 date: April 12, 2024
footer: quickget footer: quickget
header: Quickget User Manual header: Quickget User Manual
section: 1 section: 1
@ -46,7 +46,9 @@ configuration for `quickemu` to use to build and run
# NOTES # NOTES
## Ubuntu Guest ## Creating Linux guests 🐧
### Ubuntu
`quickget` will automatically download an Ubuntu release and create the `quickget` will automatically download an Ubuntu release and create the
virtual machine configuration. virtual machine configuration.
@ -102,17 +104,18 @@ You can also use `quickget` with options to:
``` shell ``` shell
# show an OS ISO download URL for {os} {release} [edition] # show an OS ISO download URL for {os} {release} [edition]
quickget --show-iso-url fedora 38 Silverblue quickget --show-iso-url fedora 38 Silverblue
# test if and OS ISO is available for {os} {release} [edition] # test if an OS ISO is available for {os} {release} [edition]
quickget --test-iso-url nixos 23.05 plasma5 quickget --test-iso-url nixos 23.05 plasma5
# open an OS distribution homepage in a browser # open an OS distribution homepage in a browser
quickget --open-distro-homepage ubuntu-mate quickget --open-distro-homepage ubuntu-mate
# Only download image file into current directory, without creating VM
quickget --download-iso elementary 7.1
``` ```
The `--show-iso-url` and `--test-iso-url` options **do not** work for The `--show-iso-url`, `--test-iso-url`, and `--download-iso` options are
`Windows` (`quickget` will begin downloading the requested release and fully functional for all operating systems, including Windows and macOS.
edition of windows)
## Other Operating Systems ### Other Operating Systems
`quickget` also supports: `quickget` also supports:
@ -123,16 +126,23 @@ edition of windows)
- `archcraft` (Archcraft) - `archcraft` (Archcraft)
- `archlinux` (Arch Linux) - `archlinux` (Arch Linux)
- `arcolinux` (Arco Linux) - `arcolinux` (Arco Linux)
- `artixlinux` (Artix Linux)
- `athenaos` (Athenaos)
- `batocera` (Batocera) - `batocera` (Batocera)
- `bazzite` (Bazzite)
- `biglinux` (BigLinux)
- `blendos` (BlendOS) - `blendos` (BlendOS)
- `bodhi` (Bodhi) - `bodhi` (Bodhi)
- `bunsenlabs` (Bunsenlabs) - `bunsenlabs` (Bunsenlabs)
- `cachyos` (CachyOS) - `cachyos` (CachyOS)
- `centos-stream` (CentOS Stream) - `centos-stream` (CentOS Stream)
- `chimeralinux` (Chimera Linux)
- `crunchbang++` (Crunchbang++)
- `debian` (Debian) - `debian` (Debian)
- `deepin` (Deepin) - `deepin` (Deepin)
- `devuan` (Devuan) - `devuan` (Devuan)
- `dragonflybsd` (DragonFlyBSD) - `dragonflybsd` (DragonFlyBSD)
- `easyos` (EasyOS)
- `elementary` (elementary OS) - `elementary` (elementary OS)
- `endeavouros` (EndeavourOS) - `endeavouros` (EndeavourOS)
- `endless` (Endless OS) - `endless` (Endless OS)
@ -142,8 +152,9 @@ edition of windows)
- `garuda` (Garuda Linux) - `garuda` (Garuda Linux)
- `gentoo` (Gentoo) - `gentoo` (Gentoo)
- `ghostbsd` (GhostBSD) - `ghostbsd` (GhostBSD)
- `gnomeos` (GNOME OS)
- `guix` (Guix)
- `haiku` (Haiku) - `haiku` (Haiku)
- `holoiso` (SteamOS HoloISO)
- `kali` (Kali) - `kali` (Kali)
- `kdeneon` (KDE Neon) - `kdeneon` (KDE Neon)
- `kolibrios` (KolibriOS) - `kolibrios` (KolibriOS)
@ -155,21 +166,27 @@ edition of windows)
- `mxlinux` (MX Linux) - `mxlinux` (MX Linux)
- `netboot` (netboot.xyz) - `netboot` (netboot.xyz)
- `netbsd` (NetBSD) - `netbsd` (NetBSD)
- `nitrux` (Nitrux)
- `nixos` (NixOS) - `nixos` (NixOS)
- `openbsd` (OpenBSD) - `openbsd` (OpenBSD)
- `openindiana` (OpenIndiana) - `openindiana` (OpenIndiana)
- `opensuse` (openSUSE) - `opensuse` (openSUSE)
- `oraclelinux` (Oracle Linux) - `oraclelinux` (Oracle Linux)
- `parrotsec` (Parrot Security)
- `peppermint` (PeppermintOS) - `peppermint` (PeppermintOS)
- `popos` (Pop!\_OS) - `popos` (Pop!\_OS)
- `porteus` (Porteus) - `porteus` (Porteus)
- `primtux` (Primtux)
- `reactos` (ReactOS) - `reactos` (ReactOS)
- `rebornos` (RebornOS) - `rebornos` (RebornOS)
- `rockylinux` (Rocky Linux) - `rockylinux` (Rocky Linux)
- `siduction` (Siduction) - `siduction` (Siduction)
- `slackware` (Slackware) - `slackware` (Slackware)
- `slax` (Slax)
- `slint` (Slint)
- `slitaz` (SliTaz GNU/Linux)
- `solus` (Solus) - `solus` (Solus)
- `spiral` (Spiral) - `spirallinux` (Spirallinux)
- `tails` (Tails) - `tails` (Tails)
- `tinycore` (Tiny Core Linux) - `tinycore` (Tiny Core Linux)
- `trisquel` (Trisquel) - `trisquel` (Trisquel)
@ -181,6 +198,8 @@ edition of windows)
- `xerolinux` (XeroLinux) - `xerolinux` (XeroLinux)
- `zorin` (Zorin OS) - `zorin` (Zorin OS)
### Custom Linux guests
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.
@ -206,7 +225,7 @@ quickemu --vm debian-bullseye.conf
- Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to - Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to
enable file sharing. enable file sharing.
## macOS Guest ## Creating macOS Guests 🍏
`quickget` automatically downloads a macOS recovery image and creates a `quickget` automatically downloads a macOS recovery image and creates a
virtual machine configuration. virtual machine configuration.
@ -216,8 +235,8 @@ quickget macos catalina
quickemu --vm macos-catalina.conf quickemu --vm macos-catalina.conf
``` ```
macOS `high-sierra`, `mojave`, `catalina`, `big-sur`, `monterey` and macOS `high-sierra`, `mojave`, `catalina`, `big-sur`, `monterey`,
`ventura` are supported. `ventura` and `sonoma` are supported.
- Use cursor keys and enter key to select the **macOS Base System** - Use cursor keys and enter key to select the **macOS Base System**
- From **macOS Utilities** - From **macOS Utilities**
@ -227,8 +246,8 @@ macOS `high-sierra`, `mojave`, `catalina`, `big-sur`, `monterey` and
click **Erase**. click **Erase**.
- Enter a `Name:` for the disk - Enter a `Name:` for the disk
- If you are installing macOS Mojave or later (Catalina, Big - If you are installing macOS Mojave or later (Catalina, Big
Sur, Monterey and Ventura), choose any of the APFS options Sur, Monterey, Ventura and Sonoma), choose any of the APFS
as the filesystem. MacOS Extended may not work. options as the filesystem. MacOS Extended may not work.
- Click **Erase**. - Click **Erase**.
- Click **Done**. - Click **Done**.
- Close Disk Utility - Close Disk Utility
@ -250,23 +269,17 @@ macOS `high-sierra`, `mojave`, `catalina`, `big-sur`, `monterey` and
macOS disk image will only ever get larger and will not shrink even macOS disk image will only ever get larger and will not shrink even
when you delete lots of data inside macOS. when you delete lots of data inside macOS.
- To enable TRIM, open the Terminal application and type the - To enable TRIM, open the Terminal application and type the
following command followed by pressing following command followed by pressing command on the hard disk
`<kbd>`{=html}enter`</kbd>`{=html} to tell macos to use the TRIM when files are deleted:
command on the hard disk when files are deleted:
``` bash ``` bash
sudo trimforce enable sudo trimforce enable
``` ```
You will be prompted to enter your account's password to gain the You will be prompted to enter your account's password to gain the
privilege needed. Once you've entered your password and pressed privilege needed. Once you've entered your password and pressed in the
`<kbd>`{=html}enter`</kbd>`{=html} the command will request confirmation form of two questions that require you to type response as though you
in the form of two questions that require you to type said "no":
`<kbd>`{=html}y`</kbd>`{=html} (for a "yes" response) followed by
`<kbd>`{=html}enter`</kbd>`{=html} to confirm. If you press
`<kbd>`{=html}enter`</kbd>`{=html} without first typing
`<kbd>`{=html}y`</kbd>`{=html} the system will consider that a negative
response as though you said "no":
``` plain ``` plain
IMPORTANT NOTICE: This tool force-enables TRIM for all relevant attached devices, even though such devices may not have been validated for data integrity while using TRIM. Use of this tool to enable TRIM may result in unintended data loss or data corruption. It should not be used in a commercial operating environment or with important data. Before using this tool, you should back up all of your data and regularly back up data while TRIM is enabled. This tool is provided on an "as is" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS TOOL OR ITS USE ALONE OR IN COMBINATION WITH YOUR DEVICES, SYSTEMS, OR SERVICES. BY USING THIS TOOL TO ENABLE TRIM, YOU AGREE THAT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, USE OF THE TOOL IS AT YOUR SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH YOU. IMPORTANT NOTICE: This tool force-enables TRIM for all relevant attached devices, even though such devices may not have been validated for data integrity while using TRIM. Use of this tool to enable TRIM may result in unintended data loss or data corruption. It should not be used in a commercial operating environment or with important data. Before using this tool, you should back up all of your data and regularly back up data while TRIM is enabled. This tool is provided on an "as is" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS TOOL OR ITS USE ALONE OR IN COMBINATION WITH YOUR DEVICES, SYSTEMS, OR SERVICES. BY USING THIS TOOL TO ENABLE TRIM, YOU AGREE THAT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, USE OF THE TOOL IS AT YOUR SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH YOU.
@ -311,6 +324,7 @@ There are some considerations when running macOS via Quickemu.
- Big Sur - Big Sur
- Monterey - Monterey
- Ventura - Ventura
- Sonoma
- `quickemu` will automatically download the required - `quickemu` will automatically download the required
[OpenCore](https://github.com/acidanthera/OpenCorePkg) bootloader [OpenCore](https://github.com/acidanthera/OpenCorePkg) bootloader
and OVMF firmware from [OSX-KVM](https://github.com/kholia/OSX-KVM). and OVMF firmware from [OSX-KVM](https://github.com/kholia/OSX-KVM).
@ -358,18 +372,28 @@ sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
Now reboot, and the App Store should work. Now reboot, and the App Store should work.
## Windows 8, 10 & 11 Guests ## Creating Windows guests 🪟
`quickget` can download `quickget` can download [**Windows
[Windows10](https://www.microsoft.com/software-download/windows10) and 10**](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/).
Windows 8.1 is also supported but doesn't feature any automated **Windows 8.1** is also supported but doesn't feature any automated
installation or driver optimisation. installation or driver optimisation.
`quickget` can also download [Windows 10
LTSC](https://www.microsoft.com/en-us/evalcenter/download-windows-10-enterprise)
and Windows Server
[2012-r2](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2012-r2),
[2016](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2016),
[2019](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2019),
and
[2022](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2022).
No automated installation is supported for these releases.
``` bash ``` bash
quickget windows 11 quickget windows 11
quickemu --vm windows-11.conf quickemu --vm windows-11.conf
@ -382,6 +406,16 @@ quickemu --vm windows-11.conf
- Username: `Quickemu` - Username: `Quickemu`
- Password: `quickemu` - Password: `quickemu`
### Regional versions
By default `quickget` will download the *"English International"*
release (*"English (United States)"* for server releases), but you can
optionally specify one of the supported languages: For example:
``` bash
quickget windows 11 "Chinese (Traditional)"
```
The default Windows 11 configuration looks like this: The default Windows 11 configuration looks like this:
``` bash ``` bash