Skip to content

Commit 50f24a3

Browse files
philcliffordphilclifford
committed
docs: align manual pages with release 4.9.8 [skip ci]
chore: align doc submodule commit [skip ci] 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>
1 parent c2d8c96 commit 50f24a3

File tree

8 files changed

+174
-127
lines changed

8 files changed

+174
-127
lines changed

‎build-docs‎

‎docs/quickemu.1‎

Lines changed: 48 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.\" Automatically generated by Pandoc 3.7.0.2
1+
.\" Automatically generated by Pandoc 3.8.3
22
.\"
3-
.TH "QUICKEMU" "1" "July 31, 2025" "quickemu" "Quickemu User Manual"
3+
.TH "QUICKEMU" "1" "February 2, 2026" "quickemu" "Quickemu User Manual"
44
.SH NAME
55
quickemu \- A quick VM builder and manager
66
.SH SYNOPSIS
@@ -31,8 +31,8 @@ Delete the entire VM and its configuration
3131
.TP
3232
\f[B]\-\-display\f[R]
3333
Select display backend.
34-
\(aqsdl\(aq (default), \(aqgtk\(aq, \(aqnone\(aq, \(aqspice\(aq or
35-
\(aqspice\-app\(aq
34+
\(aqgtk\(aq (default), \(aqsdl\(aq, \(aqcocoa\(aq, \(aqnone\(aq,
35+
\(aqspice\(aq or \(aqspice\-app\(aq
3636
.TP
3737
\f[B]\-\-fullscreen\f[R]
3838
Starts VM in full screen mode (Ctl+Alt+f to exit)
@@ -191,6 +191,9 @@ Mojave
191191
.IP \(bu 2
192192
\f[B]Windows Server\f[R] 2022 2019 2016
193193
.IP \(bu 2
194+
\f[B]ARM64 guest support\f[R] for running aarch64 VMs (native on ARM
195+
hosts, emulated on x86_64)
196+
.IP \(bu 2
194197
\c
195198
.UR https://ubuntu.com/desktop
196199
Ubuntu
@@ -570,18 +573,23 @@ wiki
570573
You can also use \f[CR]quickget\f[R] with advanced options :
571574
.IP
572575
.EX
573-
\-\-download <os> <release> [edition] : Download image; no VM configuration
574-
\-\-create\-config <os> [path/url] [flags] : Create VM config for an OS image
575-
\-\-open\-homepage <os> : Open homepage for the OS
576-
\-\-show [os] : Show OS information
577-
\-\-version : Show version
578-
\-\-help : Show this help message
579-
\-\-disable\-unattended : Force quickget not to set up an unattended installation
580-
\-\-url [os] [release] [edition] : Show image URL(s)
581-
\-\-check [os] [release] [edition] : Check image URL(s)
582-
\-\-list : List all supported systems
583-
\-\-list\-csv : List everything in csv format
584-
\-\-list\-json : List everything in json format
576+
\-\-arch <arch> : Set architecture (arm64, aarch64, amd64, x86_64)
577+
\-\-download <os> <release> [edition] : Download image; no VM configuration
578+
\-\-create\-config <os> [path/url] [flags] : Create VM config for an OS image
579+
\-\-open\-homepage <os> : Open homepage for the OS
580+
\-\-show [os] : Show OS information
581+
\-\-version : Show version
582+
\-\-help : Show this help message
583+
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- Flags \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
584+
\-\-create\-config:
585+
\-\-disable\-unattended : Force quickget not to set up an unattended installation
586+
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- For testing & development \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
587+
\-\-url [os] [release] [edition] : Show image URL(s)
588+
\-\-check [os] [release] [edition] : Check image URL(s)
589+
\-\-check\-all\-arch [os] [release] [edition] : Check downloads for all architectures (amd64 and arm64)
590+
\-\-list : List all supported systems
591+
\-\-list\-csv : List everything in csv format
592+
\-\-list\-json : List everything in json format
585593
.EE
586594
.PP
587595
Here are some typical uses
@@ -622,7 +630,7 @@ wiki
622630
.IP \(bu 2
623631
\f[CR]artixlinux\f[R] (Artix Linux)
624632
.IP \(bu 2
625-
\f[CR]athenaos\f[R] (Athena OS)
633+
\f[CR]azurelinux\f[R] (Azure Linux)
626634
.IP \(bu 2
627635
\f[CR]batocera\f[R] (Batocera)
628636
.IP \(bu 2
@@ -678,8 +686,6 @@ wiki
678686
.IP \(bu 2
679687
\f[CR]haiku\f[R] (Haiku)
680688
.IP \(bu 2
681-
\f[CR]holoiso\f[R] (HoloISO)
682-
.IP \(bu 2
683689
\f[CR]kali\f[R] (Kali)
684690
.IP \(bu 2
685691
\f[CR]kdeneon\f[R] (KDE Neon)
@@ -752,26 +758,22 @@ wiki
752758
.IP \(bu 2
753759
\f[CR]solus\f[R] (Solus)
754760
.IP \(bu 2
761+
\f[CR]sparkylinux\f[R] (SparkyLinux)
762+
.IP \(bu 2
755763
\f[CR]spirallinux\f[R] (SpiralLinux)
756764
.IP \(bu 2
757765
\f[CR]tails\f[R] (Tails)
758766
.IP \(bu 2
759767
\f[CR]tinycore\f[R] (Tiny Core Linux)
760768
.IP \(bu 2
761-
\f[CR]trisquel\f[R] (Trisquel\-)
762-
.IP \(bu 2
763-
\f[CR]truenas\-core\f[R] (TrueNAS Core)
764-
.IP \(bu 2
765-
\f[CR]truenas\-scale\f[R] (TrueNAS Scale)
769+
\f[CR]trisquel\f[R] (Trisquel)
766770
.IP \(bu 2
767771
\f[CR]tuxedo\-os\f[R] (Tuxedo OS)
768772
.IP \(bu 2
769773
\f[CR]vanillaos\f[R] (Vanilla OS)
770774
.IP \(bu 2
771775
\f[CR]void\f[R] (Void Linux)
772776
.IP \(bu 2
773-
\f[CR]vxlinux\f[R] (VX Linux)
774-
.IP \(bu 2
775777
\f[CR]zorin\f[R] (Zorin OS)
776778
.SS \c
777779
.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests
@@ -827,6 +829,17 @@ check the Discussions
827829
.PP
828830
\f[CR]quickget\f[R] automatically downloads a macOS recovery image and
829831
creates a virtual machine configuration.
832+
.PP
833+
Note: Some VPN users may need to \c
834+
.UR https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-3506845235
835+
turn off their VPN
836+
.UE \c
837+
\ in order to download a recovery image.
838+
Some other users may find \c
839+
.UR https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-2429146013
840+
using a VPN
841+
.UE \c
842+
\ necessary in order to download a recovery image.
830843
.IP
831844
.EX
832845
quickget macos big\-sur
@@ -931,16 +944,16 @@ The default macOS configuration looks like this:
931944
.IP
932945
.EX
933946
guest_os=\(dqmacos\(dq
934-
img=\(dqmacos\- big\-sur/RecoveryImage.img\(dq
935-
disk_img=\(dqmacos\- big\-sur/disk.qcow2\(dq
936-
macos_release=\(dq big\-sur\(dq
947+
img=\(dqmacos\-big\-sur/RecoveryImage.img\(dq
948+
disk_img=\(dqmacos\-big\-sur/disk.qcow2\(dq
949+
macos_release=\(dqbig\-sur\(dq
937950
.EE
938951
.IP \(bu 2
939952
\f[CR]guest_os=\(dqmacos\(dq\f[R] instructs Quickemu to optimise for
940953
macOS.
941954
.IP \(bu 2
942-
\f[CR]macos_release=\(dq big\-sur\(dq\f[R] instructs Quickemu to
943-
optimise for a particular macOS release.
955+
\f[CR]macos_release=\(dqbig\-sur\(dq\f[R] instructs Quickemu to optimise
956+
for a particular macOS release.
944957
.RS 2
945958
.IP \(bu 2
946959
For example VirtIO Network and Memory Ballooning are available in Big
@@ -1144,11 +1157,13 @@ Usage
11441157
Arguments
11451158
\-\-access : Enable remote spice access support. \(aqlocal\(aq (default), \(aqremote\(aq, \(aqclientipaddress\(aq
11461159
\-\-braille : Enable braille support. Requires SDL.
1160+
\-\-cpu\-pinning : Choose which host cores correspond to which guest cores.
11471161
\-\-delete\-disk : Delete the disk image and EFI variables
11481162
\-\-delete\-vm : Delete the entire VM and its configuration
1149-
\-\-display : Select display backend. \(aqsdl\(aq (default), \(aqcocoa\(aq, \(aqgtk\(aq, \(aqnone\(aq, \(aqspice\(aq or \(aqspice\-app\(aq
1163+
\-\-display : Select display backend. \(aqgtk\(aq (default), \(aqsdl\(aq, \(aqcocoa\(aq, \(aqnone\(aq, \(aqspice\(aq or \(aqspice\-app\(aq
11501164
\-\-fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)
11511165
\-\-ignore\-msrs\-always : Configure KVM to always ignore unhandled machine\-specific registers
1166+
\-\-ignore\-tsc\-warning : Skip TSC stability warning for macOS VMs on AMD
11521167
\-\-kill : Kill the VM process if it is running
11531168
\-\-offline : Override all network settings and start the VM offline
11541169
\-\-shortcut : Create a desktop shortcut
@@ -1174,7 +1189,7 @@ Arguments
11741189
\-\-keyboard_layout <layout> : Set keyboard layout: \(aqen\-us\(aq (default)
11751190
\-\-mouse <type> : Set mouse. \(atOptions: \(aqtablet\(aq (default), \(aqps2\(aq, \(aqusb\(aq, \(aqvirtio\(aq
11761191
\-\-usb\-controller <type> : Set usb\-controller. \(atOptions: \(aqehci\(aq (default), \(aqxhci\(aq, \(aqnone\(aq
1177-
\-\-sound\-card <type> : Set sound card. \(atOptions: \(aqintel\-hda\(aq (default), \(aqac97\(aq, \(aqes1370\(aq, \(aqsb16\(aq, \(aqusb\-audio\(aq, \(aqnone\(aq
1192+
\-\-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
11781193
\-\-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)
11791194
\-\-extra_args <arguments> : Pass additional arguments to qemu
11801195
\-\-version : Print version

‎docs/quickemu.1.md‎

Lines changed: 40 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
author: Martin Wimpress
3-
date: July 31, 2025
3+
date: February 2, 2026
44
footer: quickemu
55
header: Quickemu User Manual
66
section: 1
@@ -41,8 +41,8 @@ You can also pass optional parameters
4141
: Delete the entire VM and its configuration
4242

4343
**--display**
44-
: Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or
45-
'spice-app'
44+
: Select display backend. 'gtk' (default), 'sdl', 'cocoa', 'none',
45+
'spice' or 'spice-app'
4646

4747
**--fullscreen**
4848
: Starts VM in full screen mode (Ctl+Alt+f to exit)
@@ -177,6 +177,8 @@ Haiku, KolibriOS, OpenIndiana, ReactOS, and more.
177177
Mojave
178178
- **Windows** 10 and 11 including TPM 2.0
179179
- **Windows Server** 2022 2019 2016
180+
- **ARM64 guest support** for running aarch64 VMs (native on ARM hosts,
181+
emulated on x86_64)
180182
- [Ubuntu](https://ubuntu.com/desktop) and all the **[official Ubuntu
181183
flavours](https://ubuntu.com/download/flavours)**
182184
- **Nearly 1000 operating system editions are supported!**
@@ -397,18 +399,23 @@ may have further information.
397399
You can also use `quickget` with advanced options :
398400

399401
``` text
400-
--download <os> <release> [edition] : Download image; no VM configuration
401-
--create-config <os> [path/url] [flags] : Create VM config for an OS image
402-
--open-homepage <os> : Open homepage for the OS
403-
--show [os] : Show OS information
404-
--version : Show version
405-
--help : Show this help message
406-
--disable-unattended : Force quickget not to set up an unattended installation
407-
--url [os] [release] [edition] : Show image URL(s)
408-
--check [os] [release] [edition] : Check image URL(s)
409-
--list : List all supported systems
410-
--list-csv : List everything in csv format
411-
--list-json : List everything in json format
402+
--arch <arch> : Set architecture (arm64, aarch64, amd64, x86_64)
403+
--download <os> <release> [edition] : Download image; no VM configuration
404+
--create-config <os> [path/url] [flags] : Create VM config for an OS image
405+
--open-homepage <os> : Open homepage for the OS
406+
--show [os] : Show OS information
407+
--version : Show version
408+
--help : Show this help message
409+
------------------------------------ Flags -------------------------------------
410+
--create-config:
411+
--disable-unattended : Force quickget not to set up an unattended installation
412+
-------------------------- For testing & development ---------------------------
413+
--url [os] [release] [edition] : Show image URL(s)
414+
--check [os] [release] [edition] : Check image URL(s)
415+
--check-all-arch [os] [release] [edition] : Check downloads for all architectures (amd64 and arm64)
416+
--list : List all supported systems
417+
--list-csv : List everything in csv format
418+
--list-json : List everything in json format
412419
```
413420

414421
Here are some typical uses
@@ -441,7 +448,7 @@ Further information is available from the project
441448
- `archcraft` (Archcraft)
442449
- `archlinux` (Arch Linux)
443450
- `artixlinux` (Artix Linux)
444-
- `athenaos` (Athena OS)
451+
- `azurelinux` (Azure Linux)
445452
- `batocera` (Batocera)
446453
- `bazzite` (Bazzite)
447454
- `biglinux` (BigLinux)
@@ -469,7 +476,6 @@ Further information is available from the project
469476
- `gnomeos` (GNOME OS)
470477
- `guix` (Guix)
471478
- `haiku` (Haiku)
472-
- `holoiso` (HoloISO)
473479
- `kali` (Kali)
474480
- `kdeneon` (KDE Neon)
475481
- `kolibrios` (KolibriOS)
@@ -506,16 +512,14 @@ Further information is available from the project
506512
- `slint` (Slint)
507513
- `slitaz` (SliTaz)
508514
- `solus` (Solus)
515+
- `sparkylinux` (SparkyLinux)
509516
- `spirallinux` (SpiralLinux)
510517
- `tails` (Tails)
511518
- `tinycore` (Tiny Core Linux)
512-
- `trisquel` (Trisquel-)
513-
- `truenas-core` (TrueNAS Core)
514-
- `truenas-scale` (TrueNAS Scale)
519+
- `trisquel` (Trisquel)
515520
- `tuxedo-os` (Tuxedo OS)
516521
- `vanillaos` (Vanilla OS)
517522
- `void` (Void Linux)
518-
- `vxlinux` (VX Linux)
519523
- `zorin` (Zorin OS)
520524

521525
### [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** 🛟
561565
`quickget` automatically downloads a macOS recovery image and creates a
562566
virtual machine configuration.
563567

568+
Note: Some VPN users may need to [turn off their
569+
VPN](https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-3506845235)
570+
in order to download a recovery image. Some other users may find [using
571+
a
572+
VPN](https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-2429146013)
573+
necessary in order to download a recovery image.
574+
564575
``` shell
565576
quickget macos big-sur
566577
quickemu --vm macos-big-sur.conf
@@ -635,13 +646,13 @@ The default macOS configuration looks like this:
635646

636647
``` shell
637648
guest_os="macos"
638-
img="macos- big-sur/RecoveryImage.img"
639-
disk_img="macos- big-sur/disk.qcow2"
640-
macos_release=" big-sur"
649+
img="macos-big-sur/RecoveryImage.img"
650+
disk_img="macos-big-sur/disk.qcow2"
651+
macos_release="big-sur"
641652
```
642653

643654
- `guest_os="macos"` instructs Quickemu to optimise for macOS.
644-
- `macos_release=" big-sur"` instructs Quickemu to optimise for a
655+
- `macos_release="big-sur"` instructs Quickemu to optimise for a
645656
particular macOS release.
646657
- For example VirtIO Network and Memory Ballooning are available in
647658
Big Sur and newer, but not previous releases.
@@ -758,11 +769,13 @@ Usage
758769
Arguments
759770
--access : Enable remote spice access support. 'local' (default), 'remote', 'clientipaddress'
760771
--braille : Enable braille support. Requires SDL.
772+
--cpu-pinning : Choose which host cores correspond to which guest cores.
761773
--delete-disk : Delete the disk image and EFI variables
762774
--delete-vm : Delete the entire VM and its configuration
763-
--display : Select display backend. 'sdl' (default), 'cocoa', 'gtk', 'none', 'spice' or 'spice-app'
775+
--display : Select display backend. 'gtk' (default), 'sdl', 'cocoa', 'none', 'spice' or 'spice-app'
764776
--fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)
765777
--ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers
778+
--ignore-tsc-warning : Skip TSC stability warning for macOS VMs on AMD
766779
--kill : Kill the VM process if it is running
767780
--offline : Override all network settings and start the VM offline
768781
--shortcut : Create a desktop shortcut
@@ -788,7 +801,7 @@ Arguments
788801
--keyboard_layout <layout> : Set keyboard layout: 'en-us' (default)
789802
--mouse <type> : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio'
790803
--usb-controller <type> : Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none'
791-
--sound-card <type> : Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370', 'sb16', 'usb-audio', 'none'
804+
--sound-card <type> : Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370', 'sb16', 'usb-audio', 'virtio-sound-pci', 'none'
792805
--sound-duplex <type> : Set sound card duplex. @Options: 'hda-micro' (default: speaker/mic), 'hda-duplex' (line-in/line-out), 'hda-output' (output-only)
793806
--extra_args <arguments> : Pass additional arguments to qemu
794807
--version : Print version

‎docs/quickemu_conf.5‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.\" Automatically generated by Pandoc 3.7.0.2
1+
.\" Automatically generated by Pandoc 3.8.3
22
.\"
3-
.TH "QUICKEMU_CONF" "5" "July 31, 2025" "quickemu_conf" "Quickemu Configuration Manual"
3+
.TH "QUICKEMU_CONF" "5" "February 2, 2026" "quickemu_conf" "Quickemu Configuration Manual"
44
.SH NAME
55
quickemu_conf \- Options and parameters in the quickemu <vm>.conf
66
.SH DESCRIPTION

‎docs/quickemu_conf.5.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
author: Martin Wimpress
3-
date: July 31, 2025
3+
date: February 2, 2026
44
footer: quickemu_conf
55
header: Quickemu Configuration Manual
66
section: 5

0 commit comments

Comments
 (0)