Skip to content

docs: align manual pages with release 4.9.8 #1858

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
flexiondotorg merged 1 commit into from
Feb 10, 2026
Merged

docs: align manual pages with release 4.9.8 #1858

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion build-docs
Open in desktop
Submodule build-docs updated 8 files
+2 −1 get_quickget_help
+1 −1 quickemu.1-01-head.md
+1 −1 quickemu.1-02-options.md
+1 −0 quickemu.1-05-features01.md
+17 −12 quickemu.1-08-OtherOperatingSystems01.md
+6 −4 quickemu.1-10-macOSguests.md
+1 −1 quickemu_conf.1-00-hdr.md
+1 −1 quickget.1-00-header.md
81 changes: 48 additions & 33 deletions docs/quickemu.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
quickemu \- A quick VM builder and manager
.SH SYNOPSIS
Expand Down Expand Up @@ -31,8 +31,8 @@ Delete the entire VM and its configuration
.TP
\f[B]\-\-display\f[R]
Select display backend.
\(aqsdl\(aq (default), \(aqgtk\(aq, \(aqnone\(aq, \(aqspice\(aq or
\(aqspice\-app\(aq
\(aqgtk\(aq (default), \(aqsdl\(aq, \(aqcocoa\(aq, \(aqnone\(aq,
\(aqspice\(aq or \(aqspice\-app\(aq
.TP
\f[B]\-\-fullscreen\f[R]
Starts VM in full screen mode (Ctl+Alt+f to exit)
Expand Down Expand Up @@ -191,6 +191,9 @@ Mojave
.IP \(bu 2
\f[B]Windows Server\f[R] 2022 2019 2016
.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
.UR https://ubuntu.com/desktop
Ubuntu
Expand Down Expand Up @@ -570,18 +573,23 @@ wiki
You can also use \f[CR]quickget\f[R] with advanced options :
.IP
.EX
\-\-download <os> <release> [edition] : Download image; no VM configuration
\-\-create\-config <os> [path/url] [flags] : Create VM config for an OS image
\-\-open\-homepage <os> : Open homepage for the OS
\-\-show [os] : Show OS information
\-\-version : Show version
\-\-help : Show this help message
\-\-disable\-unattended : Force quickget not to set up an unattended installation
\-\-url [os] [release] [edition] : Show image URL(s)
\-\-check [os] [release] [edition] : Check image URL(s)
\-\-list : List all supported systems
\-\-list\-csv : List everything in csv format
\-\-list\-json : List everything in json format
\-\-arch <arch> : Set architecture (arm64, aarch64, amd64, x86_64)
\-\-download <os> <release> [edition] : Download image; no VM configuration
\-\-create\-config <os> [path/url] [flags] : Create VM config for an OS image
\-\-open\-homepage <os> : Open homepage for the OS
\-\-show [os] : Show OS information
\-\-version : Show version
\-\-help : Show this help message
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- Flags \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\-\-create\-config:
\-\-disable\-unattended : Force quickget not to set up an unattended installation
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- For testing & development \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\-\-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
.PP
Here are some typical uses
Expand Down Expand Up @@ -622,7 +630,7 @@ wiki
.IP \(bu 2
\f[CR]artixlinux\f[R] (Artix Linux)
.IP \(bu 2
\f[CR]athenaos\f[R] (Athena OS)
\f[CR]azurelinux\f[R] (Azure Linux)
.IP \(bu 2
\f[CR]batocera\f[R] (Batocera)
.IP \(bu 2
Expand Down Expand Up @@ -678,8 +686,6 @@ wiki
.IP \(bu 2
\f[CR]haiku\f[R] (Haiku)
.IP \(bu 2
\f[CR]holoiso\f[R] (HoloISO)
.IP \(bu 2
\f[CR]kali\f[R] (Kali)
.IP \(bu 2
\f[CR]kdeneon\f[R] (KDE Neon)
Expand Down Expand Up @@ -752,26 +758,22 @@ wiki
.IP \(bu 2
\f[CR]solus\f[R] (Solus)
.IP \(bu 2
\f[CR]sparkylinux\f[R] (SparkyLinux)
.IP \(bu 2
\f[CR]spirallinux\f[R] (SpiralLinux)
.IP \(bu 2
\f[CR]tails\f[R] (Tails)
.IP \(bu 2
\f[CR]tinycore\f[R] (Tiny Core Linux)
.IP \(bu 2
\f[CR]trisquel\f[R] (Trisquel\-)
.IP \(bu 2
\f[CR]truenas\-core\f[R] (TrueNAS Core)
.IP \(bu 2
\f[CR]truenas\-scale\f[R] (TrueNAS Scale)
\f[CR]trisquel\f[R] (Trisquel)
.IP \(bu 2
\f[CR]tuxedo\-os\f[R] (Tuxedo OS)
.IP \(bu 2
\f[CR]vanillaos\f[R] (Vanilla OS)
.IP \(bu 2
\f[CR]void\f[R] (Void Linux)
.IP \(bu 2
\f[CR]vxlinux\f[R] (VX Linux)
.IP \(bu 2
\f[CR]zorin\f[R] (Zorin OS)
.SS \c
.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests
Expand Down Expand Up @@ -827,6 +829,17 @@ check the Discussions
.PP
\f[CR]quickget\f[R] automatically downloads a macOS recovery image and
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
.EX
quickget macos big\-sur
Expand Down Expand Up @@ -931,16 +944,16 @@ The default macOS configuration looks like this:
.IP
.EX
guest_os=\(dqmacos\(dq
img=\(dqmacos\- big\-sur/RecoveryImage.img\(dq
disk_img=\(dqmacos\- big\-sur/disk.qcow2\(dq
macos_release=\(dq big\-sur\(dq
img=\(dqmacos\-big\-sur/RecoveryImage.img\(dq
disk_img=\(dqmacos\-big\-sur/disk.qcow2\(dq
macos_release=\(dqbig\-sur\(dq
.EE
.IP \(bu 2
\f[CR]guest_os=\(dqmacos\(dq\f[R] instructs Quickemu to optimise for
macOS.
.IP \(bu 2
\f[CR]macos_release=\(dq big\-sur\(dq\f[R] instructs Quickemu to
optimise for a particular macOS release.
\f[CR]macos_release=\(dqbig\-sur\(dq\f[R] instructs Quickemu to optimise
for a particular macOS release.
.RS 2
.IP \(bu 2
For example VirtIO Network and Memory Ballooning are available in Big
Expand Down Expand Up @@ -1144,11 +1157,13 @@ Usage
Arguments
\-\-access : Enable remote spice access support. \(aqlocal\(aq (default), \(aqremote\(aq, \(aqclientipaddress\(aq
\-\-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\-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)
\-\-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
\-\-offline : Override all network settings and start the VM offline
\-\-shortcut : Create a desktop shortcut
Expand All @@ -1174,7 +1189,7 @@ Arguments
\-\-keyboard_layout <layout> : Set keyboard layout: \(aqen\-us\(aq (default)
\-\-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
\-\-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)
\-\-extra_args <arguments> : Pass additional arguments to qemu
\-\-version : Print version
Expand Down
67 changes: 40 additions & 27 deletions docs/quickemu.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
author: Martin Wimpress
date: July 31, 2025
date: February 2, 2026
footer: quickemu
header: Quickemu User Manual
section: 1
Expand Down Expand Up @@ -41,8 +41,8 @@ You can also pass optional parameters
: Delete the entire VM and its configuration

**--display**
: Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or
'spice-app'
: Select display backend. 'gtk' (default), 'sdl', 'cocoa', 'none',
'spice' or 'spice-app'

**--fullscreen**
: Starts VM in full screen mode (Ctl+Alt+f to exit)
Expand Down Expand Up @@ -177,6 +177,8 @@ Haiku, KolibriOS, OpenIndiana, ReactOS, and more.
Mojave
- **Windows** 10 and 11 including TPM 2.0
- **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
flavours](https://ubuntu.com/download/flavours)**
- **Nearly 1000 operating system editions are supported!**
Expand Down Expand Up @@ -397,18 +399,23 @@ may have further information.
You can also use `quickget` with advanced options :

``` text
--download <os> <release> [edition] : Download image; no VM configuration
--create-config <os> [path/url] [flags] : Create VM config for an OS image
--open-homepage <os> : Open homepage for the OS
--show [os] : Show OS information
--version : Show version
--help : Show this help message
--disable-unattended : Force quickget not to set up an unattended installation
--url [os] [release] [edition] : Show image URL(s)
--check [os] [release] [edition] : Check image URL(s)
--list : List all supported systems
--list-csv : List everything in csv format
--list-json : List everything in json format
--arch <arch> : Set architecture (arm64, aarch64, amd64, x86_64)
--download <os> <release> [edition] : Download image; no VM configuration
--create-config <os> [path/url] [flags] : Create VM config for an OS image
--open-homepage <os> : Open homepage for the OS
--show [os] : Show OS information
--version : Show version
--help : Show this help message
------------------------------------ Flags -------------------------------------
--create-config:
--disable-unattended : Force quickget not to set up an unattended installation
-------------------------- For testing & development ---------------------------
--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
Expand Down Expand Up @@ -441,7 +448,7 @@ Further information is available from the project
- `archcraft` (Archcraft)
- `archlinux` (Arch Linux)
- `artixlinux` (Artix Linux)
- `athenaos` (Athena OS)
- `azurelinux` (Azure Linux)
- `batocera` (Batocera)
- `bazzite` (Bazzite)
- `biglinux` (BigLinux)
Expand Down Expand Up @@ -469,7 +476,6 @@ Further information is available from the project
- `gnomeos` (GNOME OS)
- `guix` (Guix)
- `haiku` (Haiku)
- `holoiso` (HoloISO)
- `kali` (Kali)
- `kdeneon` (KDE Neon)
- `kolibrios` (KolibriOS)
Expand Down Expand Up @@ -506,16 +512,14 @@ Further information is available from the project
- `slint` (Slint)
- `slitaz` (SliTaz)
- `solus` (Solus)
- `sparkylinux` (SparkyLinux)
- `spirallinux` (SpiralLinux)
- `tails` (Tails)
- `tinycore` (Tiny Core Linux)
- `trisquel` (Trisquel-)
- `truenas-core` (TrueNAS Core)
- `truenas-scale` (TrueNAS Scale)
- `trisquel` (Trisquel)
- `tuxedo-os` (Tuxedo OS)
- `vanillaos` (Vanilla OS)
- `void` (Void Linux)
- `vxlinux` (VX Linux)
- `zorin` (Zorin OS)

### [Custom Linux guests](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests)
Expand Down Expand Up @@ -561,6 +565,13 @@ for solutions or ask for help there** 🛟
`quickget` automatically downloads a macOS recovery image and creates a
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
quickget macos big-sur
quickemu --vm macos-big-sur.conf
Expand Down Expand Up @@ -635,13 +646,13 @@ The default macOS configuration looks like this:

``` shell
guest_os="macos"
img="macos- big-sur/RecoveryImage.img"
disk_img="macos- big-sur/disk.qcow2"
macos_release=" big-sur"
img="macos-big-sur/RecoveryImage.img"
disk_img="macos-big-sur/disk.qcow2"
macos_release="big-sur"
```

- `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.
- For example VirtIO Network and Memory Ballooning are available in
Big Sur and newer, but not previous releases.
Expand Down Expand Up @@ -758,11 +769,13 @@ Usage
Arguments
--access : Enable remote spice access support. 'local' (default), 'remote', 'clientipaddress'
--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-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)
--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
--offline : Override all network settings and start the VM offline
--shortcut : Create a desktop shortcut
Expand All @@ -788,7 +801,7 @@ Arguments
--keyboard_layout <layout> : Set keyboard layout: 'en-us' (default)
--mouse <type> : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio'
--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)
--extra_args <arguments> : Pass additional arguments to qemu
--version : Print version
Expand Down
4 changes: 2 additions & 2 deletions docs/quickemu_conf.5
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
quickemu_conf \- Options and parameters in the quickemu <vm>.conf
.SH DESCRIPTION
Expand Down
2 changes: 1 addition & 1 deletion docs/quickemu_conf.5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
author: Martin Wimpress
date: July 31, 2025
date: February 2, 2026
footer: quickemu_conf
header: Quickemu Configuration Manual
section: 5
Expand Down
Loading
Loading