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

docs: regenerated to align with changed, added and removed options

This commit is contained in:
Phil Clifford 2024-05-13 18:07:28 +01:00 committed by Martin Wimpress
parent 41f4c6ae01
commit 26a904f861
7 changed files with 717 additions and 795 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,5 +1,4 @@
<div align="center"> <div align="center">
<img src=".github/logo.png" alt="Quickemu" width="256" /> <img src=".github/logo.png" alt="Quickemu" width="256" />
# Quickemu # Quickemu
@ -7,17 +6,16 @@
**Quickly create and run optimised Windows, macOS and Linux virtual machines:** **Quickly create and run optimised Windows, macOS and Linux virtual machines:**
**Made with 💝 for <img src=".github/tux.png" align="top" width="24" alt="Tux (Linux)"/>** **Made with 💝 for <img src=".github/tux.png" align="top" width="24" alt="Tux (Linux)"/>**
</div> </div>
<p align="center"> <p align="center">
 <a href="https://wimpysworld.io/discord" target="_blank"><img alt="Discord" src="https://img.shields.io/discord/712850672223125565?style=for-the-badge&logo=discord&logoColor=%23ffffff&label=Discord&labelColor=%234253e8 &nbsp;<a href="https://wimpysworld.io/discord" target="_blank"><img alt="Discord" src="https://img.shields.io/discord/712850672223125565?style=for-the-badge&logo=discord&logoColor=%23ffffff&label=Discord&labelColor=%234253e8&color=%23e4e2e2"></a>&nbsp;
&color=%23e4e2e2"></a>  &nbsp;<a href="https://fosstodon.org/@wimpy" target="_blank"><img alt="Mastodon" src="https://img.shields.io/badge/Mastodon-6468fa?style=for-the-badge&logo=mastodon&logoColor=%23ffffff"></a>&nbsp;
 <a href="https://fosstodon.org/@wimpy" target="_blank"><img alt="Mastodon" src="https://img.shields.io/badge/Mastodon-6468fa?style=for-the-badge&logo=mastodon&logoColor=%23ffffff"></a>  &nbsp;<a href="https://twitter.com/m_wimpress" target="_blank"><img alt="Twitter" src="https://img.shields.io/badge/Twitter-303030?style=for-the-badge&logo=x&logoColor=%23ffffff"></a>&nbsp;
 <a href="https://twitter.com/m_wimpress" target="_blank"><img alt="Twitter" src="https://img.shields.io/badge/Twitter-303030?style=for-the-badge&logo=x&logoColor=%23ffffff"></a>  &nbsp;<a href="https://linkedin.com/in/martinwimpress" target="_blank"><img alt="LinkedIn" src="https://img.shields.io/badge/LinkedIn-1667be?style=for-the-badge&logo=linkedin&logoColor=%23ffffff"></a>&nbsp;
 <a href="https://linkedin.com/in/martinwimpress" target="_blank"><img alt="LinkedIn" src="https://img.shields.io/badge/LinkedIn-1667be?style=for-the-badge&logo=linkedin&logoColor=%23ffffff"></a> 
</p> </p>
# Introduction # Introduction
**Quickemu** is a wrapper for the excellent [QEMU](https://www.qemu.org/) that **Quickemu** is a wrapper for the excellent [QEMU](https://www.qemu.org/) that

2
build-docs

@ -1 +1 @@
Subproject commit bcde95902676cb7c1918eb71753724ffcf641e6e Subproject commit 91309a4efd67c29fe44f103fa78d82cd71beaf78

189
docs/quickemu.1
View File

@ -10,133 +10,137 @@ quickemu \- A quick VM builder and manager
machines for Linux, macOS and Windows machines for Linux, macOS and Windows
.SH OPTIONS .SH OPTIONS
.TP .TP
\f[B]\[en]vm\f[R] \f[B]\-\-vm\f[R]
vm configuration file vm configuration file
.PP .PP
You can also pass optional parameters You can also pass optional parameters
.TP .TP
\f[B]\[en]access\f[R] \f[B]\-\-access\f[R]
Enable remote spice access support. Enable remote spice access support.
`local' (default), `remote', `clientipaddress' \[oq]local\[cq] (default), \[oq]remote\[cq], \[oq]clientipaddress\[cq]
.TP .TP
\f[B]\[en]braille\f[R] \f[B]\-\-braille\f[R]
Enable braille support. Enable braille support.
Requires SDL. Requires SDL.
.TP .TP
\f[B]\[en]delete\-disk\f[R] \f[B]\-\-delete\-disk\f[R]
Delete the disk image and EFI variables Delete the disk image and EFI variables
.TP .TP
\f[B]\[en]delete\-vm\f[R] \f[B]\-\-delete\-vm\f[R]
Delete the entire VM and it\[cq]s configuration Delete the entire VM and its configuration
.TP .TP
\f[B]\[en]display\f[R] \f[B]\-\-display\f[R]
Select display backend. Select display backend.
`sdl' (default), `gtk', `none', `spice' or `spice\-app' \[oq]sdl\[cq] (default), \[oq]gtk\[cq], \[oq]none\[cq], \[oq]spice\[cq]
or \[oq]spice\-app\[cq]
.TP .TP
\f[B]\[en]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)
.TP .TP
\f[B]\[en]ignore\-msrs\-always\f[R] \f[B]\-\-ignore\-msrs\-always\f[R]
Configure KVM to always ignore unhandled machine\-specific registers Configure KVM to always ignore unhandled machine\-specific registers
.TP .TP
\f[B]\[en]screen <screen>\f[R] \f[B]\-\-kill\f[R]
Use specified screen to determine the window size. Kill the VM process if it is running
.TP .TP
\f[B]\[en]screenpct <percent>\f[R] \f[B]\-\-offline\f[R]
Percent of fullscreen for VM if \[en]fullscreen is not specified. Override all network settings and start the VM offline
.TP .TP
\f[B]\[en]shortcut\f[R] \f[B]\-\-shortcut\f[R]
Create a desktop shortcut Create a desktop shortcut
.TP .TP
\f[B]\[en]snapshot apply <tag>\f[R] \f[B]\-\-snapshot apply <tag>\f[R]
Apply/restore a snapshot. Apply/restore a snapshot.
.TP .TP
\f[B]\[en]snapshot create <tag>\f[R] \f[B]\-\-snapshot create <tag>\f[R]
Create a snapshot. Create a snapshot.
.TP .TP
\f[B]\[en]snapshot delete <tag>\f[R] \f[B]\-\-snapshot delete <tag>\f[R]
Delete a snapshot. Delete a snapshot.
.TP .TP
\f[B]\[en]snapshot info\f[R] \f[B]\-\-snapshot info\f[R]
Show disk/snapshot info. Show disk/snapshot info.
.TP .TP
\f[B]\[en]status\-quo\f[R] \f[B]\-\-status\-quo\f[R]
Do not commit any changes to disk/snapshot. Do not commit any changes to disk/snapshot.
.TP .TP
\f[B]\[en]viewer <viewer>\f[R] \f[B]\-\-viewer <viewer>\f[R]
Choose an alternative viewer. Choose an alternative viewer.
\[at]Options: `spicy' (default), `remote\-viewer', `none' \[at]Options: \[oq]spicy\[cq] (default), \[oq]remote\-viewer\[cq],
\[oq]none\[cq]
.TP .TP
\f[B]\[en]width <width>\f[R] \f[B]\-\-width <width>\f[R]
Set VM screen width. Set VM screen width; requires \[oq]\-\-height\[cq]
Does nothing without \[en]height
.TP .TP
\f[B]\[en]height <height>\f[R] \f[B]\-\-height <height>\f[R]
Set VM screen height. Set VM screen height; requires \[oq]\-\-width\[cq]
Does nothing without \[en]width
.TP .TP
\f[B]\[en]ssh\-port <port>\f[R] \f[B]\-\-ssh\-port <port>\f[R]
Set ssh\-port manually Set SSH port manually
.TP .TP
\f[B]\[en]spice\-port <port>\f[R] \f[B]\-\-spice\-port <port>\f[R]
Set spice\-port manually Set SPICE port manually
.TP .TP
\f[B]\[en]public\-dir <path>\f[R] \f[B]\-\-public\-dir <path>\f[R]
Expose share directory. Expose share directory.
\[at]Options: \[cq]\[cq] (default: xdg\-user\-dir PUBLICSHARE), `', \[at]Options: \[cq]\[cq] (default: xdg\-user\-dir PUBLICSHARE),
`none' \[oq]\[cq], \[oq]none\[cq]
.TP .TP
\f[B]\[en]monitor <type>\f[R] \f[B]\-\-monitor <type>\f[R]
Set monitor connection type. Set monitor connection type.
\[at]Options: `socket' (default), `telnet', `none' \[at]Options: \[oq]socket\[cq] (default), \[oq]telnet\[cq],
\[oq]none\[cq]
.TP .TP
\f[B]\[en]monitor\-telnet\-host <ip/host>\f[R] \f[B]\-\-monitor\-telnet\-host <ip/host>\f[R]
Set telnet host for monitor. Set telnet host for monitor.
(default: `localhost') (default: \[oq]localhost\[cq])
.TP .TP
\f[B]\[en]monitor\-telnet\-port <port>\f[R] \f[B]\-\-monitor\-telnet\-port <port>\f[R]
Set telnet port for monitor. Set telnet port for monitor.
(default: `4440') (default: \[oq]4440\[cq])
.TP .TP
\f[B]\[en]monitor\-cmd <cmd>\f[R] \f[B]\-\-monitor\-cmd <cmd>\f[R]
Send command to monitor if available. Send command to monitor if available.
(Example: system_powerdown) (Example: system_powerdown)
.TP .TP
\f[B]\[en]serial <type>\f[R] \f[B]\-\-serial <type>\f[R]
Set serial connection type. Set serial connection type.
\[at]Options: `socket' (default), `telnet', `none' \[at]Options: \[oq]socket\[cq] (default), \[oq]telnet\[cq],
\[oq]none\[cq]
.TP .TP
\f[B]\[en]serial\-telnet\-host <ip/host>\f[R] \f[B]\-\-serial\-telnet\-host <ip/host>\f[R]
Set telnet host for serial. Set telnet host for serial.
(default: `localhost') (default: \[oq]localhost\[cq])
.TP .TP
\f[B]\[en]serial\-telnet\-port <port>\f[R] \f[B]\-\-serial\-telnet\-port <port>\f[R]
Set telnet port for serial. Set telnet port for serial.
(default: `6660') (default: \[oq]6660\[cq])
.TP .TP
\f[B]\[en]keyboard <type>\f[R] \f[B]\-\-keyboard <type>\f[R]
Set keyboard. Set keyboard.
\[at]Options: `usb' (default), `ps2', `virtio' \[at]Options: \[oq]usb\[cq] (default), \[oq]ps2\[cq], \[oq]virtio\[cq]
.TP .TP
\f[B]\[en]keyboard_layout <layout>\f[R] \f[B]\-\-keyboard_layout <layout>\f[R]
Set keyboard layout. Set keyboard layout: \[oq]en\-us\[cq] (default)
.TP .TP
\f[B]\[en]mouse <type>\f[R] \f[B]\-\-mouse <type>\f[R]
Set mouse. Set mouse.
\[at]Options: `tablet' (default), `ps2', `usb', `virtio' \[at]Options: \[oq]tablet\[cq] (default), \[oq]ps2\[cq], \[oq]usb\[cq],
\[oq]virtio\[cq]
.TP .TP
\f[B]\[en]usb\-controller <type>\f[R] \f[B]\-\-usb\-controller <type>\f[R]
Set usb\-controller. Set usb\-controller.
\[at]Options: `ehci' (default), `xhci', `none' \[at]Options: \[oq]ehci\[cq] (default), \[oq]xhci\[cq], \[oq]none\[cq]
.TP .TP
\f[B]\[en]sound\-card <type>\f[R] \f[B]\-\-sound\-card <type>\f[R]
Set sound card. Set sound card.
\[at]Options: `intel\-hda' (default), `ac97', `es1370', `sb16', `none' \[at]Options: \[oq]intel\-hda\[cq] (default), \[oq]ac97\[cq],
\[oq]es1370\[cq], \[oq]sb16\[cq], \[oq]none\[cq]
.TP .TP
\f[B]\[en]extra_args <arguments>\f[R] \f[B]\-\-extra_args <arguments>\f[R]
Pass additional arguments to qemu Pass additional arguments to qemu
.TP .TP
\f[B]\[en]version\f[R] \f[B]\-\-version\f[R]
Print version Print version
.SH EXAMPLES .SH EXAMPLES
.TP .TP
@ -431,7 +435,7 @@ While \f[CR]quickemu\f[R] and \f[CR]quickget\f[R] are designed for the
terminal, a graphical user interface is also available: terminal, a graphical user interface is also available:
.IP \[bu] 2 .IP \[bu] 2
\f[B]\c \f[B]\c
.UR https://github.com/quickgui/quickgui .UR https://github.com/quickemu-project/quickgui
Quickgui Quickgui
.UE \c .UE \c
\f[R] by \c \f[R] by \c
@ -480,12 +484,6 @@ qqX
Alex Genovese Alex Genovese
.UE \c .UE \c
\ (see the github pages) \ (see the github pages)
[IMAGE: \c
.UR https://github.com/TuxVinyards/qqX/assets/3956806/18e5c495-8072-49a5-8b9c-e1302549efcf
qqX\-vmm
.UE \c
]
qqX\-vmm
.SS Creating Linux guests 🐧 .SS Creating Linux guests 🐧
.SS Ubuntu .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
@ -1137,7 +1135,7 @@ Arguments
\-\-access : Enable remote spice access support. \[aq]local\[aq] (default), \[aq]remote\[aq], \[aq]clientipaddress\[aq] \-\-access : Enable remote spice access support. \[aq]local\[aq] (default), \[aq]remote\[aq], \[aq]clientipaddress\[aq]
\-\-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
\-\-delete\-vm : Delete the entire VM and it\[aq]s configuration \-\-delete\-vm : Delete the entire VM and its configuration
\-\-display : Select display backend. \[aq]sdl\[aq] (default), \[aq]gtk\[aq], \[aq]none\[aq], \[aq]spice\[aq] or \[aq]spice\-app\[aq] \-\-display : Select display backend. \[aq]sdl\[aq] (default), \[aq]gtk\[aq], \[aq]none\[aq], \[aq]spice\[aq] or \[aq]spice\-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
@ -1178,59 +1176,6 @@ Here is an example of how to create a shortcut.
.EX .EX
quickemu \-\-vm ubuntu\-22.04\-desktop.conf \-\-shortcut quickemu \-\-vm ubuntu\-22.04\-desktop.conf \-\-shortcut
.EE .EE
.SS Screen and window size (Linux guests only)
\f[CR]qemu\f[R] will always default to the primary monitor to display
the VM\[cq]s window.
.PP
Without the \f[CR]\-\-screen\f[R] option, \f[CR]quickemu\f[R] will look
for the size of the smallest monitor, and use a size that fits on said
monitor.
.PP
The \f[CR]\-\-screen\f[R] option forces \f[CR]quickemu\f[R] to use the
size of the given monitor to compute the size of the window.
\f[B]It won\[cq]t use that monitor to display the VM\[cq]s window if
it\[cq]s not the primary monitor\f[R].
This is useful if the primary monitor if not the smallest one, and if
the VM\[cq]s window doesn\[cq]t need to be moved around.
.PP
The \f[CR]\-\-screen\f[R] option is also useful with the
\f[CR]\-\-fullscreen\f[R] option, again because \f[CR]qemu\f[R] will
always use the primary monitor.
In order for the fullscreen mode to work properly, the resolution of the
VM\[cq]s window must match the resolution of the screen.
.PP
To know which screen to use, type:
.IP
.EX
xrandr \-\-listmonitors | grep \-v Monitors
.EE
.PP
The command will output something like this:
.IP
.EX
0: +*HDMI\-0 2560/597x1440/336+1920+0 HDMI\-0
1: +DVI\-D\-0 1920/527x1080/296+0+0 DVI\-D\-0
.EE
.PP
The first number is what needs to be passed to the \f[CR]\-\-screen\f[R]
option.
.PP
For example:
.IP
.EX
quickemu \-\-vm vm.conf \-\-screen 0
.EE
.PP
The above uses the 2560x1440 screen to compute the size of the window,
which Quickemu sizes to 2048x1152.
Without the \f[CR]\-\-screen\f[R] option, Quickemu would have used the
1920x1080 monitor which results in a window size of 1664x936.
.PP
The `\[en]screenpct' is an optional integer value between 25 <= pct <
100 which will override system default screen sizes.
The VM size will be `pct' of the chosen screen.
\f[B]If \[en]fullscreen is chosen screen will be fullsize instead of
being scaled down by \[en]screenpct value.\f[R]
.SS References .SS References
Useful reference that assisted the development of Quickemu. Useful reference that assisted the development of Quickemu.
.IP \[bu] 2 .IP \[bu] 2

251
docs/quickemu.1.md
View File

@ -13,7 +13,7 @@ quickemu - A quick VM builder and manager
# SYNOPSIS # SYNOPSIS
**quickemu** \[*OPTION*\]... **quickemu** \[*OPTION*\]…
# DESCRIPTION # DESCRIPTION
@ -28,8 +28,8 @@ machines for Linux, macOS and Windows
You can also pass optional parameters You can also pass optional parameters
**--access** **--access**
: Enable remote spice access support. 'local' (default), 'remote', : Enable remote spice access support. ‘local’ (default), ‘remote’,
'clientipaddress' ‘clientipaddress’
**--braille** **--braille**
: Enable braille support. Requires SDL. : Enable braille support. Requires SDL.
@ -38,11 +38,11 @@ You can also pass optional parameters
: Delete the disk image and EFI variables : Delete the disk image and EFI variables
**--delete-vm** **--delete-vm**
: Delete the entire VM and it's configuration : Delete the entire VM and its 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’
**--fullscreen** **--fullscreen**
: Starts VM in full screen mode (Ctl+Alt+f to exit) : Starts VM in full screen mode (Ctl+Alt+f to exit)
@ -50,11 +50,11 @@ You can also pass optional parameters
**--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\>** **--kill**
: Use specified screen to determine the window size. : Kill the VM process if it is running
**--screenpct \<percent\>** **--offline**
: Percent of fullscreen for VM if --fullscreen is not specified. : Override all network settings and start the VM offline
**--shortcut** **--shortcut**
: Create a desktop shortcut : Create a desktop shortcut
@ -75,63 +75,63 @@ You can also pass optional parameters
: Do not commit any changes to disk/snapshot. : Do not commit any changes to disk/snapshot.
**--viewer \<viewer\>** **--viewer \<viewer\>**
: Choose an alternative viewer. @Options: 'spicy' (default), : Choose an alternative viewer. @Options: ‘spicy’ (default),
'remote-viewer', 'none' ‘remote-viewer’, ‘none’
**--width \<width\>** **--width \<width\>**
: Set VM screen width. Does nothing without --height : Set VM screen width; requires ‘--height’
**--height \<height\>** **--height \<height\>**
: Set VM screen height. Does nothing without --width : Set VM screen height; requires ‘--width’
**--ssh-port \<port\>** **--ssh-port \<port\>**
: Set ssh-port manually : Set SSH port manually
**--spice-port \<port\>** **--spice-port \<port\>**
: Set spice-port manually : Set SPICE port manually
**--public-dir \<path\>** **--public-dir \<path\>**
: Expose share directory. @Options: '' (default: xdg-user-dir : Expose share directory. @Options: ’’ (default: xdg-user-dir
PUBLICSHARE), '`<directory>`{=html}', 'none' PUBLICSHARE), ‘<directory>’, ‘none’
**--monitor \<type\>** **--monitor \<type\>**
: Set monitor connection type. @Options: 'socket' (default), 'telnet', : Set monitor connection type. @Options: ‘socket’ (default), ‘telnet’,
'none' ‘none’
**--monitor-telnet-host \<ip/host\>** **--monitor-telnet-host \<ip/host\>**
: Set telnet host for monitor. (default: 'localhost') : Set telnet host for monitor. (default: ‘localhost’)
**--monitor-telnet-port \<port\>** **--monitor-telnet-port \<port\>**
: Set telnet port for monitor. (default: '4440') : Set telnet port for monitor. (default: ‘4440’)
**--monitor-cmd \<cmd\>** **--monitor-cmd \<cmd\>**
: Send command to monitor if available. (Example: system_powerdown) : Send command to monitor if available. (Example: system_powerdown)
**--serial \<type\>** **--serial \<type\>**
: Set serial connection type. @Options: 'socket' (default), 'telnet', : Set serial connection type. @Options: ‘socket’ (default), ‘telnet’,
'none' ‘none’
**--serial-telnet-host \<ip/host\>** **--serial-telnet-host \<ip/host\>**
: Set telnet host for serial. (default: 'localhost') : Set telnet host for serial. (default: ‘localhost’)
**--serial-telnet-port \<port\>** **--serial-telnet-port \<port\>**
: Set telnet port for serial. (default: '6660') : Set telnet port for serial. (default: ‘6660’)
**--keyboard \<type\>** **--keyboard \<type\>**
: Set keyboard. @Options: 'usb' (default), 'ps2', 'virtio' : Set keyboard. @Options: ‘usb’ (default), ‘ps2’, ‘virtio’
**--keyboard_layout \<layout\>** **--keyboard_layout \<layout\>**
: Set keyboard layout. : Set keyboard layout: ‘en-us’ (default)
**--mouse \<type\>** **--mouse \<type\>**
: Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio' : Set mouse. @Options: ‘tablet’ (default), ‘ps2’, ‘usb’, ‘virtio’
**--usb-controller \<type\>** **--usb-controller \<type\>**
: Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none' : Set usb-controller. @Options: ‘ehci’ (default), ‘xhci’, ‘none’
**--sound-card \<type\>** **--sound-card \<type\>**
: Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370', : Set sound card. @Options: ‘intel-hda’ (default), ‘ac97’, ‘es1370’,
'sb16', 'none' ‘sb16’, ‘none’
**--extra_args \<arguments\>** **--extra_args \<arguments\>**
: Pass additional arguments to qemu : Pass additional arguments to qemu
@ -141,19 +141,19 @@ You can also pass optional parameters
# EXAMPLES # EXAMPLES
**quickemu --vm ubuntu-mate-22.04.conf** **quickemu –vm ubuntu-mate-22.04.conf**
: Launches the VM specified in the file *ubuntu-mate-22.04.conf* : Launches the VM specified in the file *ubuntu-mate-22.04.conf*
# Introduction # Introduction
**Quickemu** is a wrapper for the excellent **Quickemu** is a wrapper for the excellent
[QEMU](https://www.qemu.org/) that automatically *"does the right [QEMU](https://www.qemu.org/) that automatically *“does the right
thing"* when creating virtual machines. No requirement for exhaustive thing”* when creating virtual machines. No requirement for exhaustive
configuration options. You decide what operating system you want to run configuration options. You decide what operating system you want to run
and Quickemu takes care of the rest 🤖 and Quickemu takes care of the rest 🤖
- `quickget` **automatically downloads the upstream OS** and creates - `quickget` **automatically downloads the upstream OS** and creates the
the configuration 📀 configuration 📀
- `quickemu` enumerates your hardware and launches the virtual machine - `quickemu` enumerates your hardware and launches the virtual machine
with the **optimum configuration best suited to your computer** ⚡️ with the **optimum configuration best suited to your computer** ⚡️
@ -181,11 +181,10 @@ Haiku, KolibriOS, OpenIndiana, ReactOS, and more.
- Full SPICE support including host/guest clipboard sharing - Full SPICE support including host/guest clipboard sharing
- VirtIO-webdavd file sharing for Linux and Windows guests - VirtIO-webdavd file sharing for Linux and Windows guests
- VirtIO-9p file sharing for Linux and macOS guests - VirtIO-9p file sharing for Linux and macOS guests
- [QEMU Guest Agent - [QEMU Guest Agent support](https://wiki.qemu.org/Features/GuestAgent);
support](https://wiki.qemu.org/Features/GuestAgent); provides access provides access to a system-level agent via standard QMP commands
to a system-level agent via standard QMP commands - Samba file sharing for Linux, macOS and Windows guests (*if `smbd` is
- Samba file sharing for Linux, macOS and Windows guests (*if `smbd` installed on the host*)
is installed on the host*)
- VirGL acceleration - VirGL acceleration
- USB device pass-through - USB device pass-through
- Smartcard pass-through - Smartcard pass-through
@ -296,7 +295,7 @@ brew install qemu bash coreutils curl grep jq pciutils python@3.10 cdrtools gnu-
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 - **[Quickgui](https://github.com/quickemu-project/quickgui)** by [Mark
Johnson](https://github.com/marxjohnson) and [Yannick Johnson](https://github.com/marxjohnson) and [Yannick
Mauray](https://github.com/ymauray). Mauray](https://github.com/ymauray).
@ -319,11 +318,16 @@ There is also a multi option desktop integrated text interface, the
unique tools and utilities to help you make light work of installations, unique tools and utilities to help you make light work of installations,
snapshots and disk management snapshots and disk management
- **[qqX](https://github.com/TuxVinyards/qqX)** is independently - **[qqX](https://github.com/TuxVinyards/qqX)** is independently curated
curated by [Alex Genovese](https://github.com/TuxVinyards) (see the by [Alex Genovese](https://github.com/TuxVinyards) (see the github
github pages) pages)
![qqX-vmm](https://github.com/TuxVinyards/qqX/assets/3956806/18e5c495-8072-49a5-8b9c-e1302549efcf) <figure>
<img
src="https://github.com/TuxVinyards/qqX/assets/3956806/18e5c495-8072-49a5-8b9c-e1302549efcf"
alt="qqX-vmm" />
<figcaption aria-hidden="true">qqX-vmm</figcaption>
</figure>
## Creating Linux guests 🐧 ## Creating Linux guests 🐧
@ -558,59 +562,56 @@ macOS `mojave`, `catalina`, `big-sur`, `monterey`, `ventura` and
- 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**
- Click **Disk Utility** and **Continue** - Click **Disk Utility** and **Continue**
- Select `QEMU HARDDISK Media` (\~103.08GB) from the list (on - Select `QEMU HARDDISK Media` (~103.08GB) from the list (on Big Sur
Big Sur and above use `Apple Inc. VirtIO Block Device`) and and above use `Apple Inc. VirtIO Block Device`) and click
click **Erase**. **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,
Sur, Monterey, Ventura and Sonoma), choose any of the APFS Monterey, Ventura and Sonoma), choose any of the APFS options as
options as the filesystem. MacOS Extended may not work. the filesystem. MacOS Extended may not work.
- Click **Erase**. - Click **Erase**.
- Click **Done**. - Click **Done**.
- Close Disk Utility - Close Disk Utility
- From **macOS Utilities** - From **macOS Utilities**
- Click **Reinstall macOS** and **Continue** - Click **Reinstall macOS** and **Continue**
- Complete the installation as you normally would. - Complete the installation as you normally would.
- On the first reboot use cursor keys and enter key to select - On the first reboot use cursor keys and enter key to select **macOS
**macOS Installer** Installer**
- On the subsequent reboots use cursor keys and enter key to - On the subsequent reboots use cursor keys and enter key to select
select the disk you named the disk you named
- Once you have finished installing macOS you will be presented with - Once you have finished installing macOS you will be presented with an
an the out-of-the-box first-start wizard to configure various the out-of-the-box first-start wizard to configure various options and
options and set up your username and password set up your username and password
- OPTIONAL: After you have concluded the out-of-the-box wizard, you - OPTIONAL: After you have concluded the out-of-the-box wizard, you may
may want to enable the TRIM feature that the computer industry want to enable the TRIM feature that the computer industry created for
created for SSD disks. This feature in our macOS installation will SSD disks. This feature in our macOS installation will allow QuickEmu
allow QuickEmu to compact (shrink) your macOS disk image whenever to compact (shrink) your macOS disk image whenever you delete files
you delete files inside the Virtual Machine. Without this step your inside the Virtual Machine. Without this step your macOS disk image
macOS disk image will only ever get larger and will not shrink even will only ever get larger and will not shrink even when you delete
when you delete lots of data inside macOS. 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
following command followed by pressing command followed by pressing <kbd>enter</kbd> to tell macos to use
<kbd>enter</kbd> to tell macos to use the TRIM the TRIM command on the hard disk when files are deleted:
command on the hard disk when files are deleted:
``` shell ``` shell
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
<kbd>enter</kbd> the command will request confirmation <kbd>enter</kbd> the command will request confirmation in the form of
in the form of two questions that require you to type two questions that require you to type <kbd>y</kbd> (for a “yes”
<kbd>y</kbd> (for a "yes" response) followed by response) followed by <kbd>enter</kbd> to confirm.
<kbd>enter</kbd> to confirm.
If you press <kbd>enter</kbd> without first typing If you press <kbd>enter</kbd> without first typing <kbd>y</kbd> the
<kbd>y</kbd> the system will consider that a negative system will consider that a negative response as though you said “no”:
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.
Are you sure you with to proceed (y/N)? Are you sure you with to proceed (y/N)?
``` ```
And a second confirmation once you've confirmed the previous one: And a second confirmation once you’ve confirmed the previous one:
``` plain ``` plain
Your system will immediately reboot when this is complete. Your system will immediately reboot when this is complete.
@ -632,10 +633,10 @@ macos_release="catalina"
- `guest_os="macos"` instructs Quickemu to optimise for macOS. - `guest_os="macos"` instructs Quickemu to optimise for macOS.
- `macos_release="catalina"` instructs Quickemu to optimise for a - `macos_release="catalina"` instructs Quickemu to optimise for a
particular macOS release. particular macOS release.
- For example VirtIO Network and Memory Ballooning are available - For example VirtIO Network and Memory Ballooning are available in
in Big Sur and newer, but not previous releases. Big Sur and newer, but not previous releases.
- And VirtIO Block Media (disks) are supported/stable in Catalina - And VirtIO Block Media (disks) are supported/stable in Catalina and
and newer. newer.
# macOS compatibility # macOS compatibility
@ -650,20 +651,19 @@ There are some considerations when running macOS via Quickemu.
- Ventura - Ventura
- Sonoma - 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
and OVMF firmware from [OSX-KVM](https://github.com/kholia/OSX-KVM). OVMF firmware from [OSX-KVM](https://github.com/kholia/OSX-KVM).
- Optimised by default, but no GPU acceleration is available. - Optimised by default, but no GPU acceleration is available.
- Host CPU vendor is detected and guest CPU is optimised - Host CPU vendor is detected and guest CPU is optimised accordingly.
accordingly.
- [VirtIO Block - [VirtIO Block
Media](https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is Media](https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is
used for the system disk where supported. used for the system disk where supported.
- [VirtIO `usb-tablet`](http://philjordan.eu/osx-virt/) is used - [VirtIO `usb-tablet`](http://philjordan.eu/osx-virt/) is used for
for the mouse. the mouse.
- VirtIO Network (`virtio-net`) is supported and enabled on macOS - VirtIO Network (`virtio-net`) is supported and enabled on macOS Big
Big Sur and newer, but earlier releases use `vmxnet3`. Sur and newer, but earlier releases use `vmxnet3`.
- VirtIO Memory Ballooning is supported and enabled on macOS Big - VirtIO Memory Ballooning is supported and enabled on macOS Big Sur
Sur and newer but disabled for other support macOS releases. and newer but disabled for other support macOS releases.
- USB host and SPICE pass-through is: - USB host and SPICE pass-through is:
- UHCI (USB 2.0) on macOS Catalina and earlier. - UHCI (USB 2.0) on macOS Catalina and earlier.
- XHCI (USB 3.0) on macOS Big Sur and newer. - XHCI (USB 3.0) on macOS Big Sur and newer.
@ -682,7 +682,7 @@ There are some considerations when running macOS via Quickemu.
# macOS App Store # macOS App Store
If you see *"Your device or computer could not be verified"* when you If you see *“Your device or computer could not be verified”* when you
try to login to the App Store, make sure that your wired ethernet device try to login to the App Store, make sure that your wired ethernet device
is `en0`. Use `ifconfig` in a terminal to verify this. is `en0`. Use `ifconfig` in a terminal to verify this.
@ -709,7 +709,7 @@ 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 `quickget` can also download [Windows 10
@ -749,7 +749,7 @@ 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.
--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 it's configuration --delete-vm : Delete the entire VM and its configuration
--display : Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or 'spice-app' --display : Select display backend. 'sdl' (default), 'gtk', '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
@ -793,62 +793,12 @@ shortcut.
quickemu --vm ubuntu-22.04-desktop.conf --shortcut quickemu --vm ubuntu-22.04-desktop.conf --shortcut
``` ```
## Screen and window size (Linux guests only)
`qemu` will always default to the primary monitor to display the VM's
window.
Without the `--screen` option, `quickemu` will look for the size of the
smallest monitor, and use a size that fits on said monitor.
The `--screen` option forces `quickemu` to use the size of the given
monitor to compute the size of the window. **It won't use that monitor
to display the VM's window if it's not the primary monitor**. This is
useful if the primary monitor if not the smallest one, and if the VM's
window doesn't need to be moved around.
The `--screen` option is also useful with the `--fullscreen` option,
again because `qemu` will always use the primary monitor. In order for
the fullscreen mode to work properly, the resolution of the VM's window
must match the resolution of the screen.
To know which screen to use, type:
``` shell
xrandr --listmonitors | grep -v Monitors
```
The command will output something like this:
``` shell
0: +*HDMI-0 2560/597x1440/336+1920+0 HDMI-0
1: +DVI-D-0 1920/527x1080/296+0+0 DVI-D-0
```
The first number is what needs to be passed to the `--screen` option.
For example:
``` shell
quickemu --vm vm.conf --screen 0
```
The above uses the 2560x1440 screen to compute the size of the window,
which Quickemu sizes to 2048x1152. Without the `--screen` option,
Quickemu would have used the 1920x1080 monitor which results in a window
size of 1664x936.
The '--screenpct' is an optional integer value between 25 \<= pct \< 100
which will override system default screen sizes. The VM size will be
'pct' of the chosen screen. **If --fullscreen is chosen screen will be
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.
- General - General
- [QEMU's documentation!](https://qemu.readthedocs.io/en/latest/) - [QEMU’s documentation!](https://qemu.readthedocs.io/en/latest/)
- <https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines> - <https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines>
- <https://www.kraxel.org/blog/2020/01/qemu-sound-audiodev/> - <https://www.kraxel.org/blog/2020/01/qemu-sound-audiodev/>
- macOS - macOS
@ -862,8 +812,7 @@ Useful reference that assisted the development of Quickemu.
- <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/>
- <http://philjordan.eu/osx-virt/> - <http://philjordan.eu/osx-virt/>
- <https://github.com/Dids/clover-builder> - <https://github.com/Dids/clover-builder>
- [OpenCore - [OpenCore Configurator](https://mackie100projects.altervista.org)
Configurator](https://mackie100projects.altervista.org)
- Windows - Windows
- <https://www.heiko-sieger.info/running-windows-10-on-linux-using-kvm-with-vga-passthrough/> - <https://www.heiko-sieger.info/running-windows-10-on-linux-using-kvm-with-vga-passthrough/>
- <https://leduccc.medium.com/improving-the-performance-of-a-windows-10-guest-on-qemu-a5b3f54d9cf5> - <https://leduccc.medium.com/improving-the-performance-of-a-windows-10-guest-on-qemu-a5b3f54d9cf5>

31
docs/quickemu_conf.1.md
View File

@ -85,10 +85,10 @@ macos_release="catalina"
- `guest_os="macos"` instructs Quickemu to optimise for macOS. - `guest_os="macos"` instructs Quickemu to optimise for macOS.
- `macos_release="catalina"` instructs Quickemu to optimise for a - `macos_release="catalina"` instructs Quickemu to optimise for a
particular macOS release. particular macOS release.
- For example VirtIO Network and Memory Ballooning are available - For example VirtIO Network and Memory Ballooning are available in
in Big Sur and newer, but not previous releases. Big Sur and newer, but not previous releases.
- And VirtIO Block Media (disks) are supported/stable in Catalina - And VirtIO Block Media (disks) are supported/stable in Catalina and
and newer. newer.
The default Windows 11 configuration looks like this: The default Windows 11 configuration looks like this:
@ -123,11 +123,10 @@ your liking.
Add additional lines to your virtual machine configuration: Add additional lines to your virtual machine configuration:
- `cpu_cores="4"` - Specify the number of CPU cores allocated to the - `cpu_cores="4"` - Specify the number of CPU cores allocated to the VM
VM
- `ram="4G"` - Specify the amount of RAM to allocate to the VM - `ram="4G"` - Specify the amount of RAM to allocate to the VM
- `disk_size="16G"` - Specify the size of the virtual disk allocated - `disk_size="16G"` - Specify the size of the virtual disk allocated to
to the VM the VM
### Disk preallocation ### Disk preallocation
@ -150,7 +149,7 @@ following line to the VM configuration:
### 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
to the VM configuration: to the VM configuration:
@ -178,8 +177,8 @@ when the virtual machine is started. For example:
- smbd: On guest: smb://10.0.2.4/qemu - smbd: On guest: smb://10.0.2.4/qemu
If using a Windows guest, right-click on "This PC", click "Add a network 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 🐧 🪟
@ -246,7 +245,7 @@ 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: elevated permission:
- Start Quickemu with `--display spice` and then - Start Quickemu with `--display spice` and then
@ -279,10 +278,10 @@ example:
In the example above: In the example above:
- The USB device with vendor_id 046d and product_id 082d will be - The USB device with vendor_id 046d and product_id 082d will be exposed
exposed to the guest. to the guest.
- The USB device with vendor_id 046d and product_id 085e will be - The USB device with vendor_id 046d and product_id 085e will be exposed
exposed to the guest. to the guest.
If the USB devices are not writable, `quickemu` will display the If the USB devices are not writable, `quickemu` will display the
appropriate commands to modify the USB device(s) access permissions, appropriate commands to modify the USB device(s) access permissions,

48
docs/quickget.1
View File

@ -11,26 +11,44 @@ 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]
show version (from Quickemu)
.TP
\f[B]list | list_csv | list_json\f[R]
provide a csv list of all supported guest OSes, versions and variants.
.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]]
show ISO download URL
.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]]
test if ISO is available
.TP
\f[B]\f[CB]\-\-open\-distro\-homepage\f[B] | \-o\f[R] {\f[B]os\f[R]}
open OS homepage in browser
.TP
\f[B][OS] [Release] [Edition]\f[R] \f[B][OS] [Release] [Edition]\f[R]
specify the OS and release (and optional edition) if insufficient input specify the OS and release (and optional edition) if insufficient input
is provided a list of missing options will be reported and the script 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.
.TP
\f[B]\-\-download\f[R] [edition]
Download image; no VM configuration
.TP
\f[B]\-\-create\-config\f[R] [path/url]
Create VM config for a OS image
.TP
\f[B]\-\-open\-homepage\f[R]
Open homepage for the OS
.TP
\f[B]\-\-show\f[R] [os]
Show OS information
.TP
\f[B]\-\-url\f[R] [os] [release] [edition]
Show image URL(s)
.TP
\f[B]\-\-check\f[R] [os] [release] [edition]
Check image URL(s)
.TP
\f[B]\-\-list\f[R]
List all supported systems
.TP
\f[B]\-\-list\-csv\f[R]
List everything in csv format
.TP
\f[B]\-\-list\-json\f[R]
List everything in json format
.TP
\f[B]\-\-version\f[R]
Show version
.TP
\f[B]\-\-help\f[R]
Show this help message
.SH NOTES .SH NOTES
.SS Creating Linux guests 🐧 .SS Creating Linux guests 🐧
.SS Ubuntu .SS Ubuntu

145
docs/quickget.1.md
View File

@ -22,28 +22,45 @@ configuration for `quickemu` to use to build and run
# OPTIONS # OPTIONS
**version \| -version \| --version**
: show version (from Quickemu)
**list \| list_csv \| list_json**
: provide a csv list of all supported guest OSes, versions and
variants.
**`--show-iso-url` \| -s** {**os**} {**release**} \[**edition**\]
: show ISO download URL
**`--test-iso-url` \| -t** {**os**} {**release**} \[**edition**\]
: test if ISO is available
**`--open-distro-homepage` \| -o** {**os**}
: open OS homepage in browser
**\[OS\] \[Release\] \[Edition\]** **\[OS\] \[Release\] \[Edition\]**
: specify the OS and release (and optional edition) if insufficient : specify the OS and release (and optional edition) if insufficient
input is provided a list of missing options will be reported and the input is provided a list of missing options will be reported and the
script will exit. Editions may not apply and will be defaulted if script will exit. Editions may not apply and will be defaulted if
not provided. not provided.
**--download** <os> <release> \[edition\]
: Download image; no VM configuration
**--create-config** <os> \[path/url\]
: Create VM config for a OS image
**--open-homepage** <os>
: Open homepage for the OS
**--show** \[os\]
: Show OS information
**--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
**--version**
: Show version
**--help**
: Show this help message
# NOTES # NOTES
## Creating Linux guests 🐧 ## Creating Linux guests 🐧
@ -279,59 +296,56 @@ macOS `mojave`, `catalina`, `big-sur`, `monterey`, `ventura` and
- 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**
- Click **Disk Utility** and **Continue** - Click **Disk Utility** and **Continue**
- Select `QEMU HARDDISK Media` (\~103.08GB) from the list (on - Select `QEMU HARDDISK Media` (~103.08GB) from the list (on Big Sur
Big Sur and above use `Apple Inc. VirtIO Block Device`) and and above use `Apple Inc. VirtIO Block Device`) and click
click **Erase**. **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,
Sur, Monterey, Ventura and Sonoma), choose any of the APFS Monterey, Ventura and Sonoma), choose any of the APFS options as
options as the filesystem. MacOS Extended may not work. the filesystem. MacOS Extended may not work.
- Click **Erase**. - Click **Erase**.
- Click **Done**. - Click **Done**.
- Close Disk Utility - Close Disk Utility
- From **macOS Utilities** - From **macOS Utilities**
- Click **Reinstall macOS** and **Continue** - Click **Reinstall macOS** and **Continue**
- Complete the installation as you normally would. - Complete the installation as you normally would.
- On the first reboot use cursor keys and enter key to select - On the first reboot use cursor keys and enter key to select **macOS
**macOS Installer** Installer**
- On the subsequent reboots use cursor keys and enter key to - On the subsequent reboots use cursor keys and enter key to select
select the disk you named the disk you named
- Once you have finished installing macOS you will be presented with - Once you have finished installing macOS you will be presented with an
an the out-of-the-box first-start wizard to configure various the out-of-the-box first-start wizard to configure various options and
options and set up your username and password set up your username and password
- OPTIONAL: After you have concluded the out-of-the-box wizard, you - OPTIONAL: After you have concluded the out-of-the-box wizard, you may
may want to enable the TRIM feature that the computer industry want to enable the TRIM feature that the computer industry created for
created for SSD disks. This feature in our macOS installation will SSD disks. This feature in our macOS installation will allow QuickEmu
allow QuickEmu to compact (shrink) your macOS disk image whenever to compact (shrink) your macOS disk image whenever you delete files
you delete files inside the Virtual Machine. Without this step your inside the Virtual Machine. Without this step your macOS disk image
macOS disk image will only ever get larger and will not shrink even will only ever get larger and will not shrink even when you delete
when you delete lots of data inside macOS. 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
following command followed by pressing command followed by pressing <kbd>enter</kbd> to tell macos to use
<kbd>enter</kbd> to tell macos to use the TRIM the TRIM command on the hard disk when files are deleted:
command on the hard disk when files are deleted:
``` shell ``` shell
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
<kbd>enter</kbd> the command will request confirmation <kbd>enter</kbd> the command will request confirmation in the form of
in the form of two questions that require you to type two questions that require you to type <kbd>y</kbd> (for a “yes”
<kbd>y</kbd> (for a "yes" response) followed by response) followed by <kbd>enter</kbd> to confirm.
<kbd>enter</kbd> to confirm.
If you press <kbd>enter</kbd> without first typing If you press <kbd>enter</kbd> without first typing <kbd>y</kbd> the
<kbd>y</kbd> the system will consider that a negative system will consider that a negative response as though you said “no”:
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.
Are you sure you with to proceed (y/N)? Are you sure you with to proceed (y/N)?
``` ```
And a second confirmation once you've confirmed the previous one: And a second confirmation once you’ve confirmed the previous one:
``` plain ``` plain
Your system will immediately reboot when this is complete. Your system will immediately reboot when this is complete.
@ -353,10 +367,10 @@ macos_release="catalina"
- `guest_os="macos"` instructs Quickemu to optimise for macOS. - `guest_os="macos"` instructs Quickemu to optimise for macOS.
- `macos_release="catalina"` instructs Quickemu to optimise for a - `macos_release="catalina"` instructs Quickemu to optimise for a
particular macOS release. particular macOS release.
- For example VirtIO Network and Memory Ballooning are available - For example VirtIO Network and Memory Ballooning are available in
in Big Sur and newer, but not previous releases. Big Sur and newer, but not previous releases.
- And VirtIO Block Media (disks) are supported/stable in Catalina - And VirtIO Block Media (disks) are supported/stable in Catalina and
and newer. newer.
# macOS compatibility # macOS compatibility
@ -371,20 +385,19 @@ There are some considerations when running macOS via Quickemu.
- Ventura - Ventura
- Sonoma - 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
and OVMF firmware from [OSX-KVM](https://github.com/kholia/OSX-KVM). OVMF firmware from [OSX-KVM](https://github.com/kholia/OSX-KVM).
- Optimised by default, but no GPU acceleration is available. - Optimised by default, but no GPU acceleration is available.
- Host CPU vendor is detected and guest CPU is optimised - Host CPU vendor is detected and guest CPU is optimised accordingly.
accordingly.
- [VirtIO Block - [VirtIO Block
Media](https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is Media](https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is
used for the system disk where supported. used for the system disk where supported.
- [VirtIO `usb-tablet`](http://philjordan.eu/osx-virt/) is used - [VirtIO `usb-tablet`](http://philjordan.eu/osx-virt/) is used for
for the mouse. the mouse.
- VirtIO Network (`virtio-net`) is supported and enabled on macOS - VirtIO Network (`virtio-net`) is supported and enabled on macOS Big
Big Sur and newer, but earlier releases use `vmxnet3`. Sur and newer, but earlier releases use `vmxnet3`.
- VirtIO Memory Ballooning is supported and enabled on macOS Big - VirtIO Memory Ballooning is supported and enabled on macOS Big Sur
Sur and newer but disabled for other support macOS releases. and newer but disabled for other support macOS releases.
- USB host and SPICE pass-through is: - USB host and SPICE pass-through is:
- UHCI (USB 2.0) on macOS Catalina and earlier. - UHCI (USB 2.0) on macOS Catalina and earlier.
- XHCI (USB 3.0) on macOS Big Sur and newer. - XHCI (USB 3.0) on macOS Big Sur and newer.
@ -403,7 +416,7 @@ There are some considerations when running macOS via Quickemu.
# macOS App Store # macOS App Store
If you see *"Your device or computer could not be verified"* when you If you see *“Your device or computer could not be verified”* when you
try to login to the App Store, make sure that your wired ethernet device try to login to the App Store, make sure that your wired ethernet device
is `en0`. Use `ifconfig` in a terminal to verify this. is `en0`. Use `ifconfig` in a terminal to verify this.
@ -430,7 +443,7 @@ 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 `quickget` can also download [Windows 10