RomanNum3ral
/
quickemu
mirror of https://github.com/quickemu-project/quickemu.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: align manual pages with release 4.9.8 

chore: align doc submodule commit

docs(quickget): adapt whitespace in help_message()

needed in manual page regeneration to retain filtering of needed lines
currently omits the new flag for --disable-unattended

Signed-off-by: Phil Clifford <philip.clifford@gmail.com>
This commit is contained in:
Phil Clifford 2026-01-27 22:06:25 +00:00 committed by Martin Wimpress
parent 879d0ba885
commit 81d038cbae
8 changed files with 174 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
build-docs

@ -1 +1 @@
Subproject commit c5907eae9c0bd9364b4a91a3f449f1d1dbbc58c9 Subproject commit f9582c397c8ac9f1fc6ab2d6882d5ef51dc5efda

81
docs/quickemu.1
View File

@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 3.7.0.2 .\" Automatically generated by Pandoc 3.8.3
.\" .\"
.TH "QUICKEMU" "1" "July 31, 2025" "quickemu" "Quickemu User Manual" .TH "QUICKEMU" "1" "February 2, 2026" "quickemu" "Quickemu User Manual"
.SH NAME .SH NAME
quickemu \- A quick VM builder and manager quickemu \- A quick VM builder and manager
.SH SYNOPSIS .SH SYNOPSIS
@ -31,8 +31,8 @@ Delete the entire VM and its configuration
.TP .TP
\f[B]\-\-display\f[R] \f[B]\-\-display\f[R]
Select display backend. Select display backend.
\(aqsdl\(aq (default), \(aqgtk\(aq, \(aqnone\(aq, \(aqspice\(aq or \(aqgtk\(aq (default), \(aqsdl\(aq, \(aqcocoa\(aq, \(aqnone\(aq,
\(aqspice\-app\(aq \(aqspice\(aq or \(aqspice\-app\(aq
.TP .TP
\f[B]\-\-fullscreen\f[R] \f[B]\-\-fullscreen\f[R]
Starts VM in full screen mode (Ctl+Alt+f to exit) Starts VM in full screen mode (Ctl+Alt+f to exit)
@ -191,6 +191,9 @@ Mojave
.IP \(bu 2 .IP \(bu 2
\f[B]Windows Server\f[R] 2022 2019 2016 \f[B]Windows Server\f[R] 2022 2019 2016
.IP \(bu 2 .IP \(bu 2
\f[B]ARM64 guest support\f[R] for running aarch64 VMs (native on ARM
hosts, emulated on x86_64)
.IP \(bu 2
\c \c
.UR https://ubuntu.com/desktop .UR https://ubuntu.com/desktop
Ubuntu Ubuntu
@ -570,18 +573,23 @@ wiki
You can also use \f[CR]quickget\f[R] with advanced options : You can also use \f[CR]quickget\f[R] with advanced options :
.IP .IP
.EX .EX
\-\-download <os> <release> [edition] : Download image; no VM configuration \-\-arch <arch> : Set architecture (arm64, aarch64, amd64, x86_64)
\-\-create\-config <os> [path/url] [flags] : Create VM config for an OS image \-\-download <os> <release> [edition] : Download image; no VM configuration
\-\-open\-homepage <os> : Open homepage for the OS \-\-create\-config <os> [path/url] [flags] : Create VM config for an OS image
\-\-show [os] : Show OS information \-\-open\-homepage <os> : Open homepage for the OS
\-\-version : Show version \-\-show [os] : Show OS information
\-\-help : Show this help message \-\-version : Show version
\-\-disable\-unattended : Force quickget not to set up an unattended installation \-\-help : Show this help message
\-\-url [os] [release] [edition] : Show image URL(s) \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- Flags \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\-\-check [os] [release] [edition] : Check image URL(s) \-\-create\-config:
\-\-list : List all supported systems \-\-disable\-unattended : Force quickget not to set up an unattended installation
\-\-list\-csv : List everything in csv format \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- For testing & development \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\-\-list\-json : List everything in json format \-\-url [os] [release] [edition] : Show image URL(s)
\-\-check [os] [release] [edition] : Check image URL(s)
\-\-check\-all\-arch [os] [release] [edition] : Check downloads for all architectures (amd64 and arm64)
\-\-list : List all supported systems
\-\-list\-csv : List everything in csv format
\-\-list\-json : List everything in json format
.EE .EE
.PP .PP
Here are some typical uses Here are some typical uses
@ -622,7 +630,7 @@ wiki
.IP \(bu 2 .IP \(bu 2
\f[CR]artixlinux\f[R] (Artix Linux) \f[CR]artixlinux\f[R] (Artix Linux)
.IP \(bu 2 .IP \(bu 2
\f[CR]athenaos\f[R] (Athena OS) \f[CR]azurelinux\f[R] (Azure Linux)
.IP \(bu 2 .IP \(bu 2
\f[CR]batocera\f[R] (Batocera) \f[CR]batocera\f[R] (Batocera)
.IP \(bu 2 .IP \(bu 2
@ -678,8 +686,6 @@ wiki
.IP \(bu 2 .IP \(bu 2
\f[CR]haiku\f[R] (Haiku) \f[CR]haiku\f[R] (Haiku)
.IP \(bu 2 .IP \(bu 2
\f[CR]holoiso\f[R] (HoloISO)
.IP \(bu 2
\f[CR]kali\f[R] (Kali) \f[CR]kali\f[R] (Kali)
.IP \(bu 2 .IP \(bu 2
\f[CR]kdeneon\f[R] (KDE Neon) \f[CR]kdeneon\f[R] (KDE Neon)
@ -752,17 +758,15 @@ wiki
.IP \(bu 2 .IP \(bu 2
\f[CR]solus\f[R] (Solus) \f[CR]solus\f[R] (Solus)
.IP \(bu 2 .IP \(bu 2
\f[CR]sparkylinux\f[R] (SparkyLinux)
.IP \(bu 2
\f[CR]spirallinux\f[R] (SpiralLinux) \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
\f[CR]tinycore\f[R] (Tiny Core Linux) \f[CR]tinycore\f[R] (Tiny Core Linux)
.IP \(bu 2 .IP \(bu 2
\f[CR]trisquel\f[R] (Trisquel\-) \f[CR]trisquel\f[R] (Trisquel)
.IP \(bu 2
\f[CR]truenas\-core\f[R] (TrueNAS Core)
.IP \(bu 2
\f[CR]truenas\-scale\f[R] (TrueNAS Scale)
.IP \(bu 2 .IP \(bu 2
\f[CR]tuxedo\-os\f[R] (Tuxedo OS) \f[CR]tuxedo\-os\f[R] (Tuxedo OS)
.IP \(bu 2 .IP \(bu 2
@ -770,8 +774,6 @@ wiki
.IP \(bu 2 .IP \(bu 2
\f[CR]void\f[R] (Void Linux) \f[CR]void\f[R] (Void Linux)
.IP \(bu 2 .IP \(bu 2
\f[CR]vxlinux\f[R] (VX Linux)
.IP \(bu 2
\f[CR]zorin\f[R] (Zorin OS) \f[CR]zorin\f[R] (Zorin OS)
.SS \c .SS \c
.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests .UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests
@ -827,6 +829,17 @@ check the Discussions
.PP .PP
\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.
.PP
Note: Some VPN users may need to \c
.UR https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-3506845235
turn off their VPN
.UE \c
\ in order to download a recovery image.
Some other users may find \c
.UR https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-2429146013
using a VPN
.UE \c
\ necessary in order to download a recovery image.
.IP .IP
.EX .EX
quickget macos big\-sur quickget macos big\-sur
@ -931,16 +944,16 @@ The default macOS configuration looks like this:
.IP .IP
.EX .EX
guest_os=\(dqmacos\(dq guest_os=\(dqmacos\(dq
img=\(dqmacos\- big\-sur/RecoveryImage.img\(dq img=\(dqmacos\-big\-sur/RecoveryImage.img\(dq
disk_img=\(dqmacos\- big\-sur/disk.qcow2\(dq disk_img=\(dqmacos\-big\-sur/disk.qcow2\(dq
macos_release=\(dq big\-sur\(dq macos_release=\(dqbig\-sur\(dq
.EE .EE
.IP \(bu 2 .IP \(bu 2
\f[CR]guest_os=\(dqmacos\(dq\f[R] instructs Quickemu to optimise for \f[CR]guest_os=\(dqmacos\(dq\f[R] instructs Quickemu to optimise for
macOS. macOS.
.IP \(bu 2 .IP \(bu 2
\f[CR]macos_release=\(dq big\-sur\(dq\f[R] instructs Quickemu to \f[CR]macos_release=\(dqbig\-sur\(dq\f[R] instructs Quickemu to optimise
optimise for a particular macOS release. for a particular macOS release.
.RS 2 .RS 2
.IP \(bu 2 .IP \(bu 2
For example VirtIO Network and Memory Ballooning are available in Big For example VirtIO Network and Memory Ballooning are available in Big
@ -1144,11 +1157,13 @@ Usage
Arguments Arguments
\-\-access : Enable remote spice access support. \(aqlocal\(aq (default), \(aqremote\(aq, \(aqclientipaddress\(aq \-\-access : Enable remote spice access support. \(aqlocal\(aq (default), \(aqremote\(aq, \(aqclientipaddress\(aq
\-\-braille : Enable braille support. Requires SDL. \-\-braille : Enable braille support. Requires SDL.
\-\-cpu\-pinning : Choose which host cores correspond to which guest cores.
\-\-delete\-disk : Delete the disk image and EFI variables \-\-delete\-disk : Delete the disk image and EFI variables
\-\-delete\-vm : Delete the entire VM and its configuration \-\-delete\-vm : Delete the entire VM and its configuration
\-\-display : Select display backend. \(aqsdl\(aq (default), \(aqcocoa\(aq, \(aqgtk\(aq, \(aqnone\(aq, \(aqspice\(aq or \(aqspice\-app\(aq \-\-display : Select display backend. \(aqgtk\(aq (default), \(aqsdl\(aq, \(aqcocoa\(aq, \(aqnone\(aq, \(aqspice\(aq or \(aqspice\-app\(aq
\-\-fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit) \-\-fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)
\-\-ignore\-msrs\-always : Configure KVM to always ignore unhandled machine\-specific registers \-\-ignore\-msrs\-always : Configure KVM to always ignore unhandled machine\-specific registers
\-\-ignore\-tsc\-warning : Skip TSC stability warning for macOS VMs on AMD
\-\-kill : Kill the VM process if it is running \-\-kill : Kill the VM process if it is running
\-\-offline : Override all network settings and start the VM offline \-\-offline : Override all network settings and start the VM offline
\-\-shortcut : Create a desktop shortcut \-\-shortcut : Create a desktop shortcut
@ -1174,7 +1189,7 @@ Arguments
\-\-keyboard_layout <layout> : Set keyboard layout: \(aqen\-us\(aq (default) \-\-keyboard_layout <layout> : Set keyboard layout: \(aqen\-us\(aq (default)
\-\-mouse <type> : Set mouse. \(atOptions: \(aqtablet\(aq (default), \(aqps2\(aq, \(aqusb\(aq, \(aqvirtio\(aq \-\-mouse <type> : Set mouse. \(atOptions: \(aqtablet\(aq (default), \(aqps2\(aq, \(aqusb\(aq, \(aqvirtio\(aq
\-\-usb\-controller <type> : Set usb\-controller. \(atOptions: \(aqehci\(aq (default), \(aqxhci\(aq, \(aqnone\(aq \-\-usb\-controller <type> : Set usb\-controller. \(atOptions: \(aqehci\(aq (default), \(aqxhci\(aq, \(aqnone\(aq
\-\-sound\-card <type> : Set sound card. \(atOptions: \(aqintel\-hda\(aq (default), \(aqac97\(aq, \(aqes1370\(aq, \(aqsb16\(aq, \(aqusb\-audio\(aq, \(aqnone\(aq \-\-sound\-card <type> : Set sound card. \(atOptions: \(aqintel\-hda\(aq (default), \(aqac97\(aq, \(aqes1370\(aq, \(aqsb16\(aq, \(aqusb\-audio\(aq, \(aqvirtio\-sound\-pci\(aq, \(aqnone\(aq
\-\-sound\-duplex <type> : Set sound card duplex. \(atOptions: \(aqhda\-micro\(aq (default: speaker/mic), \(aqhda\-duplex\(aq (line\-in/line\-out), \(aqhda\-output\(aq (output\-only) \-\-sound\-duplex <type> : Set sound card duplex. \(atOptions: \(aqhda\-micro\(aq (default: speaker/mic), \(aqhda\-duplex\(aq (line\-in/line\-out), \(aqhda\-output\(aq (output\-only)
\-\-extra_args <arguments> : Pass additional arguments to qemu \-\-extra_args <arguments> : Pass additional arguments to qemu
\-\-version : Print version \-\-version : Print version

67
docs/quickemu.1.md
View File

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: July 31, 2025 date: February 2, 2026
footer: quickemu footer: quickemu
header: Quickemu User Manual header: Quickemu User Manual
section: 1 section: 1
@ -41,8 +41,8 @@ You can also pass optional parameters
: Delete the entire VM and its configuration : Delete the entire VM and its configuration
**--display** **--display**
: Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or : Select display backend. 'gtk' (default), 'sdl', 'cocoa', 'none',
'spice-app' 'spice' or 'spice-app'
**--fullscreen** **--fullscreen**
: Starts VM in full screen mode (Ctl+Alt+f to exit) : Starts VM in full screen mode (Ctl+Alt+f to exit)
@ -177,6 +177,8 @@ Haiku, KolibriOS, OpenIndiana, ReactOS, and more.
Mojave Mojave
- **Windows** 10 and 11 including TPM 2.0 - **Windows** 10 and 11 including TPM 2.0
- **Windows Server** 2022 2019 2016 - **Windows Server** 2022 2019 2016
- **ARM64 guest support** for running aarch64 VMs (native on ARM hosts,
emulated on x86_64)
- [Ubuntu](https://ubuntu.com/desktop) and all the **[official Ubuntu - [Ubuntu](https://ubuntu.com/desktop) and all the **[official Ubuntu
flavours](https://ubuntu.com/download/flavours)** flavours](https://ubuntu.com/download/flavours)**
- **Nearly 1000 operating system editions are supported!** - **Nearly 1000 operating system editions are supported!**
@ -397,18 +399,23 @@ may have further information.
You can also use `quickget` with advanced options : You can also use `quickget` with advanced options :
``` text ``` text
--download <os> <release> [edition] : Download image; no VM configuration --arch <arch> : Set architecture (arm64, aarch64, amd64, x86_64)
--create-config <os> [path/url] [flags] : Create VM config for an OS image --download <os> <release> [edition] : Download image; no VM configuration
--open-homepage <os> : Open homepage for the OS --create-config <os> [path/url] [flags] : Create VM config for an OS image
--show [os] : Show OS information --open-homepage <os> : Open homepage for the OS
--version : Show version --show [os] : Show OS information
--help : Show this help message --version : Show version
--disable-unattended : Force quickget not to set up an unattended installation --help : Show this help message
--url [os] [release] [edition] : Show image URL(s) ------------------------------------ Flags -------------------------------------
--check [os] [release] [edition] : Check image URL(s) --create-config:
--list : List all supported systems --disable-unattended : Force quickget not to set up an unattended installation
--list-csv : List everything in csv format -------------------------- For testing & development ---------------------------
--list-json : List everything in json format --url [os] [release] [edition] : Show image URL(s)
--check [os] [release] [edition] : Check image URL(s)
--check-all-arch [os] [release] [edition] : Check downloads for all architectures (amd64 and arm64)
--list : List all supported systems
--list-csv : List everything in csv format
--list-json : List everything in json format
``` ```
Here are some typical uses Here are some typical uses
@ -441,7 +448,7 @@ Further information is available from the project
- `archcraft` (Archcraft) - `archcraft` (Archcraft)
- `archlinux` (Arch Linux) - `archlinux` (Arch Linux)
- `artixlinux` (Artix Linux) - `artixlinux` (Artix Linux)
- `athenaos` (Athena OS) - `azurelinux` (Azure Linux)
- `batocera` (Batocera) - `batocera` (Batocera)
- `bazzite` (Bazzite) - `bazzite` (Bazzite)
- `biglinux` (BigLinux) - `biglinux` (BigLinux)
@ -469,7 +476,6 @@ Further information is available from the project
- `gnomeos` (GNOME OS) - `gnomeos` (GNOME OS)
- `guix` (Guix) - `guix` (Guix)
- `haiku` (Haiku) - `haiku` (Haiku)
- `holoiso` (HoloISO)
- `kali` (Kali) - `kali` (Kali)
- `kdeneon` (KDE Neon) - `kdeneon` (KDE Neon)
- `kolibrios` (KolibriOS) - `kolibrios` (KolibriOS)
@ -506,16 +512,14 @@ Further information is available from the project
- `slint` (Slint) - `slint` (Slint)
- `slitaz` (SliTaz) - `slitaz` (SliTaz)
- `solus` (Solus) - `solus` (Solus)
- `sparkylinux` (SparkyLinux)
- `spirallinux` (SpiralLinux) - `spirallinux` (SpiralLinux)
- `tails` (Tails) - `tails` (Tails)
- `tinycore` (Tiny Core Linux) - `tinycore` (Tiny Core Linux)
- `trisquel` (Trisquel-) - `trisquel` (Trisquel)
- `truenas-core` (TrueNAS Core)
- `truenas-scale` (TrueNAS Scale)
- `tuxedo-os` (Tuxedo OS) - `tuxedo-os` (Tuxedo OS)
- `vanillaos` (Vanilla OS) - `vanillaos` (Vanilla OS)
- `void` (Void Linux) - `void` (Void Linux)
- `vxlinux` (VX Linux)
- `zorin` (Zorin OS) - `zorin` (Zorin OS)
### [Custom Linux guests](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests) ### [Custom Linux guests](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests)
@ -561,6 +565,13 @@ for solutions or ask for help there** 🛟
`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.
Note: Some VPN users may need to [turn off their
VPN](https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-3506845235)
in order to download a recovery image. Some other users may find [using
a
VPN](https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-2429146013)
necessary in order to download a recovery image.
``` shell ``` shell
quickget macos big-sur quickget macos big-sur
quickemu --vm macos-big-sur.conf quickemu --vm macos-big-sur.conf
@ -635,13 +646,13 @@ The default macOS configuration looks like this:
``` shell ``` shell
guest_os="macos" guest_os="macos"
img="macos- big-sur/RecoveryImage.img" img="macos-big-sur/RecoveryImage.img"
disk_img="macos- big-sur/disk.qcow2" disk_img="macos-big-sur/disk.qcow2"
macos_release=" big-sur" macos_release="big-sur"
``` ```
- `guest_os="macos"` instructs Quickemu to optimise for macOS. - `guest_os="macos"` instructs Quickemu to optimise for macOS.
- `macos_release=" big-sur"` instructs Quickemu to optimise for a - `macos_release="big-sur"` instructs Quickemu to optimise for a
particular macOS release. particular macOS release.
- For example VirtIO Network and Memory Ballooning are available in - For example VirtIO Network and Memory Ballooning are available in
Big Sur and newer, but not previous releases. Big Sur and newer, but not previous releases.
@ -758,11 +769,13 @@ Usage
Arguments Arguments
--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.
--cpu-pinning : Choose which host cores correspond to which guest cores.
--delete-disk : Delete the disk image and EFI variables --delete-disk : Delete the disk image and EFI variables
--delete-vm : Delete the entire VM and its configuration --delete-vm : Delete the entire VM and its configuration
--display : Select display backend. 'sdl' (default), 'cocoa', 'gtk', 'none', 'spice' or 'spice-app' --display : Select display backend. 'gtk' (default), 'sdl', 'cocoa', 'none', 'spice' or 'spice-app'
--fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit) --fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)
--ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers --ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers
--ignore-tsc-warning : Skip TSC stability warning for macOS VMs on AMD
--kill : Kill the VM process if it is running --kill : Kill the VM process if it is running
--offline : Override all network settings and start the VM offline --offline : Override all network settings and start the VM offline
--shortcut : Create a desktop shortcut --shortcut : Create a desktop shortcut
@ -788,7 +801,7 @@ Arguments
--keyboard_layout <layout> : Set keyboard layout: 'en-us' (default) --keyboard_layout <layout> : Set keyboard layout: 'en-us' (default)
--mouse <type> : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio' --mouse <type> : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio'
--usb-controller <type> : Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none' --usb-controller <type> : Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none'
--sound-card <type> : Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370', 'sb16', 'usb-audio', 'none' --sound-card <type> : Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370', 'sb16', 'usb-audio', 'virtio-sound-pci', 'none'
--sound-duplex <type> : Set sound card duplex. @Options: 'hda-micro' (default: speaker/mic), 'hda-duplex' (line-in/line-out), 'hda-output' (output-only) --sound-duplex <type> : Set sound card duplex. @Options: 'hda-micro' (default: speaker/mic), 'hda-duplex' (line-in/line-out), 'hda-output' (output-only)
--extra_args <arguments> : Pass additional arguments to qemu --extra_args <arguments> : Pass additional arguments to qemu
--version : Print version --version : Print version

4
docs/quickemu_conf.5
View File

@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 3.7.0.2 .\" Automatically generated by Pandoc 3.8.3
.\" .\"
.TH "QUICKEMU_CONF" "5" "July 31, 2025" "quickemu_conf" "Quickemu Configuration Manual" .TH "QUICKEMU_CONF" "5" "February 2, 2026" "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

2
docs/quickemu_conf.5.md
View File

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: July 31, 2025 date: February 2, 2026
footer: quickemu_conf footer: quickemu_conf
header: Quickemu Configuration Manual header: Quickemu Configuration Manual
section: 5 section: 5

62
docs/quickget.1
View File

@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 3.7.0.2 .\" Automatically generated by Pandoc 3.8.3
.\" .\"
.TH "QUICKGET" "1" "July 31, 2025" "quickget" "Quickget User Manual" .TH "QUICKGET" "1" "February 2, 2026" "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
@ -128,18 +128,23 @@ wiki
You can also use \f[CR]quickget\f[R] with advanced options : You can also use \f[CR]quickget\f[R] with advanced options :
.IP .IP
.EX .EX
\-\-download <os> <release> [edition] : Download image; no VM configuration \-\-arch <arch> : Set architecture (arm64, aarch64, amd64, x86_64)
\-\-create\-config <os> [path/url] [flags] : Create VM config for an OS image \-\-download <os> <release> [edition] : Download image; no VM configuration
\-\-open\-homepage <os> : Open homepage for the OS \-\-create\-config <os> [path/url] [flags] : Create VM config for an OS image
\-\-show [os] : Show OS information \-\-open\-homepage <os> : Open homepage for the OS
\-\-version : Show version \-\-show [os] : Show OS information
\-\-help : Show this help message \-\-version : Show version
\-\-disable\-unattended : Force quickget not to set up an unattended installation \-\-help : Show this help message
\-\-url [os] [release] [edition] : Show image URL(s) \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- Flags \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\-\-check [os] [release] [edition] : Check image URL(s) \-\-create\-config:
\-\-list : List all supported systems \-\-disable\-unattended : Force quickget not to set up an unattended installation
\-\-list\-csv : List everything in csv format \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- For testing & development \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\-\-list\-json : List everything in json format \-\-url [os] [release] [edition] : Show image URL(s)
\-\-check [os] [release] [edition] : Check image URL(s)
\-\-check\-all\-arch [os] [release] [edition] : Check downloads for all architectures (amd64 and arm64)
\-\-list : List all supported systems
\-\-list\-csv : List everything in csv format
\-\-list\-json : List everything in json format
.EE .EE
.PP .PP
Here are some typical uses Here are some typical uses
@ -180,7 +185,7 @@ wiki
.IP \(bu 2 .IP \(bu 2
\f[CR]artixlinux\f[R] (Artix Linux) \f[CR]artixlinux\f[R] (Artix Linux)
.IP \(bu 2 .IP \(bu 2
\f[CR]athenaos\f[R] (Athena OS) \f[CR]azurelinux\f[R] (Azure Linux)
.IP \(bu 2 .IP \(bu 2
\f[CR]batocera\f[R] (Batocera) \f[CR]batocera\f[R] (Batocera)
.IP \(bu 2 .IP \(bu 2
@ -236,8 +241,6 @@ wiki
.IP \(bu 2 .IP \(bu 2
\f[CR]haiku\f[R] (Haiku) \f[CR]haiku\f[R] (Haiku)
.IP \(bu 2 .IP \(bu 2
\f[CR]holoiso\f[R] (HoloISO)
.IP \(bu 2
\f[CR]kali\f[R] (Kali) \f[CR]kali\f[R] (Kali)
.IP \(bu 2 .IP \(bu 2
\f[CR]kdeneon\f[R] (KDE Neon) \f[CR]kdeneon\f[R] (KDE Neon)
@ -310,17 +313,15 @@ wiki
.IP \(bu 2 .IP \(bu 2
\f[CR]solus\f[R] (Solus) \f[CR]solus\f[R] (Solus)
.IP \(bu 2 .IP \(bu 2
\f[CR]sparkylinux\f[R] (SparkyLinux)
.IP \(bu 2
\f[CR]spirallinux\f[R] (SpiralLinux) \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
\f[CR]tinycore\f[R] (Tiny Core Linux) \f[CR]tinycore\f[R] (Tiny Core Linux)
.IP \(bu 2 .IP \(bu 2
\f[CR]trisquel\f[R] (Trisquel\-) \f[CR]trisquel\f[R] (Trisquel)
.IP \(bu 2
\f[CR]truenas\-core\f[R] (TrueNAS Core)
.IP \(bu 2
\f[CR]truenas\-scale\f[R] (TrueNAS Scale)
.IP \(bu 2 .IP \(bu 2
\f[CR]tuxedo\-os\f[R] (Tuxedo OS) \f[CR]tuxedo\-os\f[R] (Tuxedo OS)
.IP \(bu 2 .IP \(bu 2
@ -328,8 +329,6 @@ wiki
.IP \(bu 2 .IP \(bu 2
\f[CR]void\f[R] (Void Linux) \f[CR]void\f[R] (Void Linux)
.IP \(bu 2 .IP \(bu 2
\f[CR]vxlinux\f[R] (VX Linux)
.IP \(bu 2
\f[CR]zorin\f[R] (Zorin OS) \f[CR]zorin\f[R] (Zorin OS)
.SS \c .SS \c
.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests .UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests
@ -385,6 +384,17 @@ check the Discussions
.PP .PP
\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.
.PP
Note: Some VPN users may need to \c
.UR https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-3506845235
turn off their VPN
.UE \c
\ in order to download a recovery image.
Some other users may find \c
.UR https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-2429146013
using a VPN
.UE \c
\ necessary in order to download a recovery image.
.IP .IP
.EX .EX
quickget macos big\-sur quickget macos big\-sur
@ -497,8 +507,8 @@ macos_release=\(dqbig\-sur\(dq
\f[CR]guest_os=\(dqmacos\(dq\f[R] instructs Quickemu to optimise for \f[CR]guest_os=\(dqmacos\(dq\f[R] instructs Quickemu to optimise for
macOS. macOS.
.IP \(bu 2 .IP \(bu 2
\f[CR]macos_release=\(dq big\-sur\(dq\f[R] instructs Quickemu to \f[CR]macos_release=\(dqbig\-sur\(dq\f[R] instructs Quickemu to optimise
optimise for a particular macOS release. for a particular macOS release.
.RS 2 .RS 2
.IP \(bu 2 .IP \(bu 2
For example VirtIO Network and Memory Ballooning are available in Big For example VirtIO Network and Memory Ballooning are available in Big

55
docs/quickget.1.md
View File

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: July 31, 2025 date: February 2, 2026
footer: quickget footer: quickget
header: Quickget User Manual header: Quickget User Manual
section: 1 section: 1
@ -123,18 +123,23 @@ may have further information.
You can also use `quickget` with advanced options : You can also use `quickget` with advanced options :
``` text ``` text
--download <os> <release> [edition] : Download image; no VM configuration --arch <arch> : Set architecture (arm64, aarch64, amd64, x86_64)
--create-config <os> [path/url] [flags] : Create VM config for an OS image --download <os> <release> [edition] : Download image; no VM configuration
--open-homepage <os> : Open homepage for the OS --create-config <os> [path/url] [flags] : Create VM config for an OS image
--show [os] : Show OS information --open-homepage <os> : Open homepage for the OS
--version : Show version --show [os] : Show OS information
--help : Show this help message --version : Show version
--disable-unattended : Force quickget not to set up an unattended installation --help : Show this help message
--url [os] [release] [edition] : Show image URL(s) ------------------------------------ Flags -------------------------------------
--check [os] [release] [edition] : Check image URL(s) --create-config:
--list : List all supported systems --disable-unattended : Force quickget not to set up an unattended installation
--list-csv : List everything in csv format -------------------------- For testing & development ---------------------------
--list-json : List everything in json format --url [os] [release] [edition] : Show image URL(s)
--check [os] [release] [edition] : Check image URL(s)
--check-all-arch [os] [release] [edition] : Check downloads for all architectures (amd64 and arm64)
--list : List all supported systems
--list-csv : List everything in csv format
--list-json : List everything in json format
``` ```
Here are some typical uses Here are some typical uses
@ -167,7 +172,7 @@ Further information is available from the project
- `archcraft` (Archcraft) - `archcraft` (Archcraft)
- `archlinux` (Arch Linux) - `archlinux` (Arch Linux)
- `artixlinux` (Artix Linux) - `artixlinux` (Artix Linux)
- `athenaos` (Athena OS) - `azurelinux` (Azure Linux)
- `batocera` (Batocera) - `batocera` (Batocera)
- `bazzite` (Bazzite) - `bazzite` (Bazzite)
- `biglinux` (BigLinux) - `biglinux` (BigLinux)
@ -195,7 +200,6 @@ Further information is available from the project
- `gnomeos` (GNOME OS) - `gnomeos` (GNOME OS)
- `guix` (Guix) - `guix` (Guix)
- `haiku` (Haiku) - `haiku` (Haiku)
- `holoiso` (HoloISO)
- `kali` (Kali) - `kali` (Kali)
- `kdeneon` (KDE Neon) - `kdeneon` (KDE Neon)
- `kolibrios` (KolibriOS) - `kolibrios` (KolibriOS)
@ -232,16 +236,14 @@ Further information is available from the project
- `slint` (Slint) - `slint` (Slint)
- `slitaz` (SliTaz) - `slitaz` (SliTaz)
- `solus` (Solus) - `solus` (Solus)
- `sparkylinux` (SparkyLinux)
- `spirallinux` (SpiralLinux) - `spirallinux` (SpiralLinux)
- `tails` (Tails) - `tails` (Tails)
- `tinycore` (Tiny Core Linux) - `tinycore` (Tiny Core Linux)
- `trisquel` (Trisquel-) - `trisquel` (Trisquel)
- `truenas-core` (TrueNAS Core)
- `truenas-scale` (TrueNAS Scale)
- `tuxedo-os` (Tuxedo OS) - `tuxedo-os` (Tuxedo OS)
- `vanillaos` (Vanilla OS) - `vanillaos` (Vanilla OS)
- `void` (Void Linux) - `void` (Void Linux)
- `vxlinux` (VX Linux)
- `zorin` (Zorin OS) - `zorin` (Zorin OS)
### [Custom Linux guests](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests) ### [Custom Linux guests](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests)
@ -287,6 +289,13 @@ for solutions or ask for help there** 🛟
`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.
Note: Some VPN users may need to [turn off their
VPN](https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-3506845235)
in order to download a recovery image. Some other users may find [using
a
VPN](https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-2429146013)
necessary in order to download a recovery image.
``` shell ``` shell
quickget macos big-sur quickget macos big-sur
quickemu --vm macos-big-sur.conf quickemu --vm macos-big-sur.conf
@ -361,13 +370,13 @@ The default macOS configuration looks like this:
``` shell ``` shell
guest_os="macos" guest_os="macos"
img="macos- big-sur/RecoveryImage.img" img="macos-big-sur/RecoveryImage.img"
disk_img="macos- big-sur/disk.qcow2" disk_img="macos-big-sur/disk.qcow2"
macos_release=" big-sur" macos_release="big-sur"
``` ```
- `guest_os="macos"` instructs Quickemu to optimise for macOS. - `guest_os="macos"` instructs Quickemu to optimise for macOS.
- `macos_release=" big-sur"` instructs Quickemu to optimise for a - `macos_release="big-sur"` instructs Quickemu to optimise for a
particular macOS release. particular macOS release.
- For example VirtIO Network and Memory Ballooning are available in - For example VirtIO Network and Memory Ballooning are available in
Big Sur and newer, but not previous releases. Big Sur and newer, but not previous releases.

28
quickget
View File

@ -3763,23 +3763,23 @@ Advanced usage:
quickget --download ubuntu 22.04 quickget --download ubuntu 22.04
Arguments: Arguments:
--arch <arch> : Set architecture (arm64, aarch64, amd64, x86_64) --arch <arch> : Set architecture (arm64, aarch64, amd64, x86_64)
--download <os> <release> [edition] : Download image; no VM configuration --download <os> <release> [edition] : Download image; no VM configuration
--create-config <os> [path/url] [flags] : Create VM config for an OS image --create-config <os> [path/url] [flags] : Create VM config for an OS image
--open-homepage <os> : Open homepage for the OS --open-homepage <os> : Open homepage for the OS
--show [os] : Show OS information --show [os] : Show OS information
--version : Show version --version : Show version
--help : Show this help message --help : Show this help message
------------------------------------ Flags ------------------------------------- ------------------------------------ Flags -------------------------------------
--create-config: --create-config:
--disable-unattended : Force quickget not to set up an unattended installation --disable-unattended : Force quickget not to set up an unattended installation
-------------------------- For testing & development --------------------------- -------------------------- For testing & development ---------------------------
--url [os] [release] [edition] : Show image URL(s) --url [os] [release] [edition] : Show image URL(s)
--check [os] [release] [edition] : Check image URL(s) --check [os] [release] [edition] : Check image URL(s)
--check-all-arch [os] [release] [edition]: Check downloads for all architectures (amd64 and arm64) --check-all-arch [os] [release] [edition] : Check downloads for all architectures (amd64 and arm64)
--list : List all supported systems --list : List all supported systems
--list-csv : List everything in csv format --list-csv : List everything in csv format
--list-json : List everything in json format --list-json : List everything in json format
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
Supported Operating Systems:\n\n' "$(${QUICKEMU} --version)" "${CURL_VERSION}" Supported Operating Systems:\n\n' "$(${QUICKEMU} --version)" "${CURL_VERSION}"