Readme and man pages regenerated reflecting updates

Co-authored-by: frafra frafra@users.noreply.github.com
This commit is contained in:
Phil Clifford 2024-04-12 02:05:02 +01:00 committed by Martin Wimpress
parent 8aa7ccc796
commit d1c4fa9de5
8 changed files with 121 additions and 115 deletions

View File

@ -26,7 +26,7 @@ Quickemu is available in the repositories of the following distros
<tbody>
<tr valign="top">
<td>
[![Packaging
status of quickemu](https://repology.org/badge/vertical-allrepos/quickemu.svg?header=quickemu)](https://repology.org/project/quickemu/versions)
@ -35,7 +35,7 @@ status of quickemu](https://repology.org/badge/vertical-allrepos/quickemu.svg?he
[![Packaging
status](https://repology.org/badge/vertical-allrepos/quickgui.svg?header=quickgui)](https://repology.org/project/quickgui/versions)
</td>
</tr>
</tbody>
@ -56,15 +56,17 @@ decide what operating system you want to run, and Quickemu will figure
out the best way to do it for you.
The original objective of the project was to enable [quick testing of
Linux distributions](#linux-guests) where the virtual machine
Linux distributions](#creating-linux-guests-) where the virtual machine
configurations can be stored anywhere (such as external USB storage or
your home directory) and no elevated permissions are required to run the
virtual machines. **Quickemu now also includes comprehensive support for
[macOS](#macos-guests) and [Windows](#windows-guests)**.
[macOS](#creating-macos-guests-) and
[Windows](#creating-windows-guests-)**.
## Features
- **macOS** Sonoma, Ventura, Monterey, Big Sur, Catalina, Mojave & High Sierra
- **macOS** Sonoma, Ventura, Monterey, Big Sur, Catalina, Mojave &
High Sierra
- **Windows** 10 and 11 including TPM 2.0
- [Ubuntu](https://ubuntu.com/desktop) and all the **[official Ubuntu
flavours](https://ubuntu.com/download/flavours)**
@ -98,14 +100,6 @@ following command:
``` bash
yay -Sy quickemu
```
### Debian and derivatives
A [.deb package is available for Debian and derivatives in this project's GitHub releases page](https://github.com/quickemu-project/quickemu/releases).
Download the .deb and install it with `apt-get`.
```bash
sudo apt-get install ./quickemu_x.y.z-1_all.deb
```
### Debian and derivatives
@ -211,19 +205,20 @@ These examples may save a little typing:
This also applies to derivatives:
``` sh
sudo apt install qemu bash coreutils ovmf grep jq lsb-base procps python3 genisoimage usbutils util-linux sed spice-client-gtk libtss2-tcti-swtpm0 wget xdg-user-dirs zsync unzip
sudo apt install qemu bash coreutils ovmf grep jq lsb-base procps python3 genisoimage usbutils util-linux sed socat spice-client-gtk libtss2-tcti-swtpm0 wget xdg-user-dirs zsync unzip
```
#### Install requirements on Fedora hosts
``` sh
sudo dnf install qemu bash coreutils edk2-tools grep jq lsb procps python3 genisoimage usbutils util-linux sed spice-gtk-tools swtpm wget xdg-user-dirs xrandr unzip
sudo dnf install qemu bash coreutils edk2-tools grep jq lsb procps python3 genisoimage usbutils util-linux sed socat spice-gtk-tools swtpm wget xdg-user-dirs xrandr unzip
```
#### Install requirements on macOS hosts
This is a **work in progress** (see [issue 248](https://github.com/quickemu-project/quickemu/issues/248)
for other steps and changes that may enable running on MacOS)
This is a **work in progress** (see [issue
248](https://github.com/quickemu-project/quickemu/issues/248) for other
steps and changes that may enable running on MacOS)
``` sh
brew install qemu bash coreutils grep jq python@3.10 cdrtools gnu-sed spice-gtk wget zsync
@ -286,16 +281,17 @@ quickemu --vm ubuntu-22.04.conf
### Ubuntu daily-live images
`quickget` can also download/refresh daily-live images via `zsync` for Ubuntu developers and testers.
`quickget` can also download/refresh daily-live images via `zsync` for
Ubuntu developers and testers.
``` bash
quickget ubuntu daily-live
quickemu --vm ubuntu-daily-live.conf
```
You can run `quickget ubuntu daily-live` to refresh your daily development
image as often as you like, it will even automatically switch to a new
series.
You can run `quickget ubuntu daily-live` to refresh your daily
development image as often as you like, it will even automatically
switch to a new series.
### Ubuntu Flavours
@ -318,8 +314,8 @@ with your preferred flavour.
You can also use `quickget` with options to:
``` shell
# show an OS ISO download URL for {os} {release} [edition]
quickget --show-iso-url fedora 38 Silverblue
# show an OS ISO download URL for {os} {release} [edition]
quickget --show-iso-url fedora 38 Silverblue
# test if an OS ISO is available for {os} {release} [edition]
quickget --test-iso-url nixos 23.05 plasma5
# open an OS distribution homepage in a browser
@ -358,6 +354,7 @@ fully functional for all operating systems, including Windows and macOS.
- `deepin` (Deepin)
- `devuan` (Devuan)
- `dragonflybsd` (DragonFlyBSD)
- `easyos` (EasyOS)
- `elementary` (elementary OS)
- `endeavouros` (EndeavourOS)
- `endless` (Endless OS)

@ -1 +1 @@
Subproject commit d6acc32a36447b5c0ef62c5adc125f21bfc269e7
Subproject commit d851e47195635c83c9b5981959cf64830a228320

View File

@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 3.1.12.3
.\" Automatically generated by Pandoc 3.1.13
.\"
.TH "QUICKEMU" "1" "April 12, 2024" "quickemu" "Quickemu User Manual"
.TH "QUICKEMU" "1" "April 13, 2024" "quickemu" "Quickemu User Manual"
.SH NAME
quickemu \- A quick VM builder and manager
.SH SYNOPSIS
@ -39,22 +39,22 @@ Starts VM in full screen mode (Ctl+Alt+f to exit)
\f[B]\[en]ignore\-msrs\-always\f[R]
Configure KVM to always ignore unhandled machine\-specific registers
.TP
\f[B]\[en]screen\f[R]
\f[B]\[en]screen <screen>\f[R]
Use specified screen to determine the window size.
.TP
\f[B]\[en]screenpct \f[R]
\f[B]\[en]screenpct <percent>\f[R]
Percent of fullscreen for VM if \[en]fullscreen is not specified.
.TP
\f[B]\[en]shortcut\f[R]
Create a desktop shortcut
.TP
\f[B]\[en]snapshot apply \f[R]
\f[B]\[en]snapshot apply <tag>\f[R]
Apply/restore a snapshot.
.TP
\f[B]\[en]snapshot create \f[R]
\f[B]\[en]snapshot create <tag>\f[R]
Create a snapshot.
.TP
\f[B]\[en]snapshot delete \f[R]
\f[B]\[en]snapshot delete <tag>\f[R]
Delete a snapshot.
.TP
\f[B]\[en]snapshot info\f[R]
@ -63,77 +63,77 @@ Show disk/snapshot info.
\f[B]\[en]status\-quo\f[R]
Do not commit any changes to disk/snapshot.
.TP
\f[B]\[en]viewer \f[R]
\f[B]\[en]viewer <viewer>\f[R]
Choose an alternative viewer.
\[at]Options: `spicy' (default), `remote\-viewer', `none'
.TP
\f[B]\[en]width \f[R]
\f[B]\[en]width <width>\f[R]
Set VM screen width.
Does nothing without \[en]height
.TP
\f[B]\[en]height \f[R]
\f[B]\[en]height <height>\f[R]
Set VM screen height.
Does nothing without \[en]width
.TP
\f[B]\[en]ssh\-port \f[R]
\f[B]\[en]ssh\-port <port>\f[R]
Set ssh\-port manually
.TP
\f[B]\[en]spice\-port \f[R]
\f[B]\[en]spice\-port <port>\f[R]
Set spice\-port manually
.TP
\f[B]\[en]public\-dir \f[R]
\f[B]\[en]public\-dir <path>\f[R]
Expose share directory.
\[at]Options: \[cq]\[cq] (default: xdg\-user\-dir PUBLICSHARE), `',
`none'
.TP
\f[B]\[en]monitor \f[R]
\f[B]\[en]monitor <type>\f[R]
Set monitor connection type.
\[at]Options: `socket' (default), `telnet', `none'
.TP
\f[B]\[en]monitor\-telnet\-host \f[R]
\f[B]\[en]monitor\-telnet\-host <ip/host>\f[R]
Set telnet host for monitor.
(default: `localhost')
.TP
\f[B]\[en]monitor\-telnet\-port \f[R]
\f[B]\[en]monitor\-telnet\-port <port>\f[R]
Set telnet port for monitor.
(default: `4440')
.TP
\f[B]\[en]monitor\-cmd \f[R]
\f[B]\[en]monitor\-cmd <cmd>\f[R]
Send command to monitor if available.
(Example: system_powerdown)
.TP
\f[B]\[en]serial \f[R]
\f[B]\[en]serial <type>\f[R]
Set serial connection type.
\[at]Options: `socket' (default), `telnet', `none'
.TP
\f[B]\[en]serial\-telnet\-host \f[R]
\f[B]\[en]serial\-telnet\-host <ip/host>\f[R]
Set telnet host for serial.
(default: `localhost')
.TP
\f[B]\[en]serial\-telnet\-port \f[R]
\f[B]\[en]serial\-telnet\-port <port>\f[R]
Set telnet port for serial.
(default: `6660')
.TP
\f[B]\[en]keyboard \f[R]
\f[B]\[en]keyboard <type>\f[R]
Set keyboard.
\[at]Options: `usb' (default), `ps2', `virtio'
.TP
\f[B]\[en]keyboard_layout \f[R]
\f[B]\[en]keyboard_layout <layout>\f[R]
Set keyboard layout.
.TP
\f[B]\[en]mouse \f[R]
\f[B]\[en]mouse <type>\f[R]
Set mouse.
\[at]Options: `tablet' (default), `ps2', `usb', `virtio'
.TP
\f[B]\[en]usb\-controller \f[R]
\f[B]\[en]usb\-controller <type>\f[R]
Set usb\-controller.
\[at]Options: `ehci' (default), `xhci', `none'
.TP
\f[B]\[en]sound\-card \f[R]
\f[B]\[en]sound\-card <type>\f[R]
Set sound card.
\[at]Options: `intel\-hda' (default), `ac97', `es1370', `sb16', `none'
.TP
\f[B]\[en]extra_args \f[R]
\f[B]\[en]extra_args <arguments>\f[R]
Pass additional arguments to qemu
.TP
\f[B]\[en]version\f[R]
@ -160,7 +160,8 @@ and no elevated permissions are required to run the virtual machines.
Windows\f[R].
.SS Features
.IP \[bu] 2
\f[B]macOS\f[R] Monterey, Big Sur, Catalina, Mojave & High Sierra
\f[B]macOS\f[R] Sonoma, Ventura, Monterey, Big Sur, Catalina, Mojave &
High Sierra
.IP \[bu] 2
\f[B]Windows\f[R] 10 and 11 including TPM 2.0
.IP \[bu] 2
@ -346,12 +347,12 @@ These examples may save a little typing:
This also applies to derivatives:
.IP
.EX
sudo apt install qemu bash coreutils ovmf grep jq lsb\-base procps python3 genisoimage usbutils util\-linux sed spice\-client\-gtk libtss2\-tcti\-swtpm0 wget xdg\-user\-dirs zsync unzip
sudo apt install qemu bash coreutils ovmf grep jq lsb\-base procps python3 genisoimage usbutils util\-linux sed socat spice\-client\-gtk libtss2\-tcti\-swtpm0 wget xdg\-user\-dirs zsync unzip
.EE
.SS Install requirements on Fedora hosts
.IP
.EX
sudo dnf install qemu bash coreutils edk2\-tools grep jq lsb procps python3 genisoimage usbutils util\-linux sed spice\-gtk\-tools swtpm wget xdg\-user\-dirs xrandr unzip
sudo dnf install qemu bash coreutils edk2\-tools grep jq lsb procps python3 genisoimage usbutils util\-linux sed socat spice\-gtk\-tools swtpm wget xdg\-user\-dirs xrandr unzip
.EE
.SS Install requirements on macOS hosts
This is a \f[B]work in progress\f[R] (see \c
@ -452,16 +453,16 @@ to enable file sharing.
\f[CR]sudo apt install spice\-webdavd\f[R]
.RE
.RE
.SS Ubuntu devel (daily\-live) images
\f[CR]quickget\f[R] can also download/refresh devel images via
.SS Ubuntu daily\-live images
\f[CR]quickget\f[R] can also download/refresh daily\-live images via
\f[CR]zsync\f[R] for Ubuntu developers and testers.
.IP
.EX
quickget ubuntu devel
quickemu \-\-vm ubuntu\-devel.conf
quickget ubuntu daily\-live
quickemu \-\-vm ubuntu\-daily\-live.conf
.EE
.PP
You can run \f[CR]quickget ubuntu devel\f[R] to refresh your daily
You can run \f[CR]quickget ubuntu daily\-live\f[R] to refresh your daily
development image as often as you like, it will even automatically
switch to a new series.
.SS Ubuntu Flavours
@ -557,6 +558,8 @@ operating systems, including Windows and macOS.
.IP \[bu] 2
\f[CR]dragonflybsd\f[R] (DragonFlyBSD)
.IP \[bu] 2
\f[CR]easyos\f[R] (EasyOS)
.IP \[bu] 2
\f[CR]elementary\f[R] (elementary OS)
.IP \[bu] 2
\f[CR]endeavouros\f[R] (EndeavourOS)

View File

@ -1,6 +1,6 @@
---
author: Martin Wimpress
date: April 12, 2024
date: April 13, 2024
footer: quickemu
header: Quickemu User Manual
section: 1
@ -50,22 +50,22 @@ You can also pass optional parameters
**--ignore-msrs-always**
: Configure KVM to always ignore unhandled machine-specific registers
**--screen**
**--screen \<screen\>**
: Use specified screen to determine the window size.
**--screenpct `<percent>`{=html}**
**--screenpct \<percent\>**
: Percent of fullscreen for VM if --fullscreen is not specified.
**--shortcut**
: Create a desktop shortcut
**--snapshot apply `<tag>`{=html}**
**--snapshot apply \<tag\>**
: Apply/restore a snapshot.
**--snapshot create `<tag>`{=html}**
**--snapshot create \<tag\>**
: Create a snapshot.
**--snapshot delete `<tag>`{=html}**
**--snapshot delete \<tag\>**
: Delete a snapshot.
**--snapshot info**
@ -74,66 +74,66 @@ You can also pass optional parameters
**--status-quo**
: Do not commit any changes to disk/snapshot.
**--viewer `<viewer>`{=html}**
**--viewer \<viewer\>**
: Choose an alternative viewer. @Options: 'spicy' (default),
'remote-viewer', 'none'
**--width `<width>`{=html}**
**--width \<width\>**
: Set VM screen width. Does nothing without --height
**--height `<height>`{=html}**
**--height \<height\>**
: Set VM screen height. Does nothing without --width
**--ssh-port `<port>`{=html}**
**--ssh-port \<port\>**
: Set ssh-port manually
**--spice-port `<port>`{=html}**
**--spice-port \<port\>**
: Set spice-port manually
**--public-dir `<path>`{=html}**
**--public-dir \<path\>**
: Expose share directory. @Options: '' (default: xdg-user-dir
PUBLICSHARE), '`<directory>`{=html}', 'none'
**--monitor `<type>`{=html}**
**--monitor \<type\>**
: Set monitor connection type. @Options: 'socket' (default), 'telnet',
'none'
**--monitor-telnet-host `<ip/host>`{=html}**
**--monitor-telnet-host \<ip/host\>**
: Set telnet host for monitor. (default: 'localhost')
**--monitor-telnet-port `<port>`{=html}**
**--monitor-telnet-port \<port\>**
: Set telnet port for monitor. (default: '4440')
**--monitor-cmd `<cmd>`{=html}**
**--monitor-cmd \<cmd\>**
: Send command to monitor if available. (Example: system_powerdown)
**--serial `<type>`{=html}**
**--serial \<type\>**
: Set serial connection type. @Options: 'socket' (default), 'telnet',
'none'
**--serial-telnet-host `<ip/host>`{=html}**
**--serial-telnet-host \<ip/host\>**
: Set telnet host for serial. (default: 'localhost')
**--serial-telnet-port `<port>`{=html}**
**--serial-telnet-port \<port\>**
: Set telnet port for serial. (default: '6660')
**--keyboard `<type>`{=html}**
**--keyboard \<type\>**
: Set keyboard. @Options: 'usb' (default), 'ps2', 'virtio'
**--keyboard_layout `<layout>`{=html}**
**--keyboard_layout \<layout\>**
: Set keyboard layout.
**--mouse `<type>`{=html}**
**--mouse \<type\>**
: Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio'
**--usb-controller `<type>`{=html}**
**--usb-controller \<type\>**
: Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none'
**--sound-card `<type>`{=html}**
**--sound-card \<type\>**
: Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370',
'sb16', 'none'
**--extra_args `<arguments>`{=html}**
**--extra_args \<arguments\>**
: Pass additional arguments to qemu
**--version**
@ -153,15 +153,17 @@ decide what operating system you want to run, and Quickemu will figure
out the best way to do it for you.
The original objective of the project was to enable [quick testing of
Linux distributions](#linux-guests) where the virtual machine
Linux distributions](#creating-linux-guests-) where the virtual machine
configurations can be stored anywhere (such as external USB storage or
your home directory) and no elevated permissions are required to run the
virtual machines. **Quickemu now also includes comprehensive support for
[macOS](#macos-guests) and [Windows](#windows-guests)**.
[macOS](#creating-macos-guests-) and
[Windows](#creating-windows-guests-)**.
## Features
- **macOS** Monterey, Big Sur, Catalina, Mojave & High Sierra
- **macOS** Sonoma, Ventura, Monterey, Big Sur, Catalina, Mojave &
High Sierra
- **Windows** 10 and 11 including TPM 2.0
- [Ubuntu](https://ubuntu.com/desktop) and all the **[official Ubuntu
flavours](https://ubuntu.com/download/flavours)**
@ -226,13 +228,13 @@ These examples may save a little typing:
This also applies to derivatives:
``` sh
sudo apt install qemu bash coreutils ovmf grep jq lsb-base procps python3 genisoimage usbutils util-linux sed spice-client-gtk libtss2-tcti-swtpm0 wget xdg-user-dirs zsync unzip
sudo apt install qemu bash coreutils ovmf grep jq lsb-base procps python3 genisoimage usbutils util-linux sed socat spice-client-gtk libtss2-tcti-swtpm0 wget xdg-user-dirs zsync unzip
```
#### Install requirements on Fedora hosts
``` sh
sudo dnf install qemu bash coreutils edk2-tools grep jq lsb procps python3 genisoimage usbutils util-linux sed spice-gtk-tools swtpm wget xdg-user-dirs xrandr unzip
sudo dnf install qemu bash coreutils edk2-tools grep jq lsb procps python3 genisoimage usbutils util-linux sed socat spice-gtk-tools swtpm wget xdg-user-dirs xrandr unzip
```
#### Install requirements on macOS hosts
@ -300,19 +302,19 @@ quickemu --vm ubuntu-22.04.conf
enable file sharing.
- `sudo apt install spice-webdavd`
### Ubuntu devel (daily-live) images
### Ubuntu daily-live images
`quickget` can also download/refresh devel images via `zsync` for Ubuntu
developers and testers.
`quickget` can also download/refresh daily-live images via `zsync` for
Ubuntu developers and testers.
``` bash
quickget ubuntu devel
quickemu --vm ubuntu-devel.conf
quickget ubuntu daily-live
quickemu --vm ubuntu-daily-live.conf
```
You can run `quickget ubuntu devel` to refresh your daily development
image as often as you like, it will even automatically switch to a new
series.
You can run `quickget ubuntu daily-live` to refresh your daily
development image as often as you like, it will even automatically
switch to a new series.
### Ubuntu Flavours
@ -375,6 +377,7 @@ fully functional for all operating systems, including Windows and macOS.
- `deepin` (Deepin)
- `devuan` (Devuan)
- `dragonflybsd` (DragonFlyBSD)
- `easyos` (EasyOS)
- `elementary` (elementary OS)
- `endeavouros` (EndeavourOS)
- `endless` (Endless OS)

View File

@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 3.1.12.3
.\" Automatically generated by Pandoc 3.1.13
.\"
.TH "QUICKEMU_CONF" "1" "April 12, 2024" "quickemu_conf" "Quickemu Configuration Manual"
.TH "QUICKEMU_CONF" "1" "April 13, 2024" "quickemu_conf" "Quickemu Configuration Manual"
.SH NAME
quickemu_conf \- Options and parameters in the quickemu <vm>.conf
.SH DESCRIPTION

View File

@ -1,6 +1,6 @@
---
author: Martin Wimpress
date: April 12, 2024
date: April 13, 2024
footer: quickemu_conf
header: Quickemu Configuration Manual
section: 1

View File

@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 3.1.12.3
.\" Automatically generated by Pandoc 3.1.13
.\"
.TH "QUICKGET" "1" "April 12, 2024" "quickget" "Quickget User Manual"
.TH "QUICKGET" "1" "April 13, 2024" "quickget" "Quickget User Manual"
.SH NAME
quickget \- download and prepare materials for building a quickemu VM
.SH SYNOPSIS
@ -61,16 +61,16 @@ to enable file sharing.
\f[CR]sudo apt install spice\-webdavd\f[R]
.RE
.RE
.SS Ubuntu devel (daily\-live) images
\f[CR]quickget\f[R] can also download/refresh devel images via
.SS Ubuntu daily\-live images
\f[CR]quickget\f[R] can also download/refresh daily\-live images via
\f[CR]zsync\f[R] for Ubuntu developers and testers.
.IP
.EX
quickget ubuntu devel
quickemu \-\-vm ubuntu\-devel.conf
quickget ubuntu daily\-live
quickemu \-\-vm ubuntu\-daily\-live.conf
.EE
.PP
You can run \f[CR]quickget ubuntu devel\f[R] to refresh your daily
You can run \f[CR]quickget ubuntu daily\-live\f[R] to refresh your daily
development image as often as you like, it will even automatically
switch to a new series.
.SS Ubuntu Flavours
@ -166,6 +166,8 @@ operating systems, including Windows and macOS.
.IP \[bu] 2
\f[CR]dragonflybsd\f[R] (DragonFlyBSD)
.IP \[bu] 2
\f[CR]easyos\f[R] (EasyOS)
.IP \[bu] 2
\f[CR]elementary\f[R] (elementary OS)
.IP \[bu] 2
\f[CR]endeavouros\f[R] (EndeavourOS)

View File

@ -1,6 +1,6 @@
---
author: Martin Wimpress
date: April 12, 2024
date: April 13, 2024
footer: quickget
header: Quickget User Manual
section: 1
@ -67,19 +67,19 @@ quickemu --vm ubuntu-22.04.conf
enable file sharing.
- `sudo apt install spice-webdavd`
### Ubuntu devel (daily-live) images
### Ubuntu daily-live images
`quickget` can also download/refresh devel images via `zsync` for Ubuntu
developers and testers.
`quickget` can also download/refresh daily-live images via `zsync` for
Ubuntu developers and testers.
``` bash
quickget ubuntu devel
quickemu --vm ubuntu-devel.conf
quickget ubuntu daily-live
quickemu --vm ubuntu-daily-live.conf
```
You can run `quickget ubuntu devel` to refresh your daily development
image as often as you like, it will even automatically switch to a new
series.
You can run `quickget ubuntu daily-live` to refresh your daily
development image as often as you like, it will even automatically
switch to a new series.
### Ubuntu Flavours
@ -142,6 +142,7 @@ fully functional for all operating systems, including Windows and macOS.
- `deepin` (Deepin)
- `devuan` (Devuan)
- `dragonflybsd` (DragonFlyBSD)
- `easyos` (EasyOS)
- `elementary` (elementary OS)
- `endeavouros` (EndeavourOS)
- `endless` (Endless OS)