Skip to content

Commit

Permalink
Merge branch 'master' into dietpi
Browse files Browse the repository at this point in the history
  • Loading branch information
zen0bit authored Sep 15, 2023
2 parents 26035b2 + c7e91a0 commit 1842d0b
Show file tree
Hide file tree
Showing 10 changed files with 526 additions and 272 deletions.
42 changes: 25 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Windows**.
## Features

- **macOS** Monterey, Big Sur, Catalina, Mojave & High Sierra
- **Windows** 8.1, 10 and 11 including TPM 2.0
- **Windows** 10 and 11 including TPM 2.0
- [Ubuntu](https://ubuntu.com/desktop) and all the **[official Ubuntu
flavours](https://ubuntu.com/download/flavours)**
- **Over 360 operating system editions are supported!**
Expand Down Expand Up @@ -103,9 +103,9 @@ above requirements or their equivalents.

These examples may save a little typing

Debian:
Debian (and direct derivatives such as MX Linux):

sudo apt install qemu bash coreutils ovmf grep jq lsb procps python3 genisoimage usbutils util-linux sed spice-client-gtk swtpm wget xdg-user-dirs zsync unzip
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

Fedora:

Expand Down Expand Up @@ -222,8 +222,10 @@ with your preferred flavour.
- `kubuntu` (Kubuntu)
- `lubuntu` (Lubuntu)
- `ubuntu-budgie` (Ubuntu Budgie)
- `ubuntucinnamon` (Ubuntu Cinnamon)
- `ubuntukylin` (Ubuntu Kylin)
- `ubuntu-mate` (Ubuntu MATE)
- `ubuntu-server` (Ubuntu Server)
- `ubuntustudio` (Ubuntu Studio)
- `ubuntu` (Ubuntu)
- `ubuntu-unity` (Ubuntu Unity)
Expand All @@ -240,6 +242,7 @@ with your preferred flavour.
- `archlinux` (Arch Linux)
- `arcolinux` (Arco Linux)
- `batocera` (Batocera)
- `blendos` (BlendOS)
- `cachyos` (CachyOS)
- `centos-stream` (CentOS Stream)
- `debian` (Debian)
Expand All @@ -248,13 +251,14 @@ with your preferred flavour.
- `dragonflybsd` (DragonFlyBSD)
- `elementary` (elementary OS)
- `endeavouros` (EndeavourOS)
- `endless` (Endless OS)
- `fedora` (Fedora)
- `freebsd` (FreeBSD)
- `freedos` (FreeDOS)
- `garuda` (Garuda Linux)
- `gentoo` (Gentoo)
- `ghostbsd` (GhostBSD)
- `haiku` (Haiku)
- `holoiso` (HoloISO)
- `kali` (Kali)
- `kdeneon` (KDE Neon)
- `kolibrios` (KolibriOS)
Expand All @@ -267,18 +271,23 @@ with your preferred flavour.
- `netbsd` (NetBSD)
- `nixos` (NixOS)
- `openbsd` (OpenBSD)
- `openindiana` (OpenIndiana)
- `opensuse` (openSUSE)
- `oraclelinux` (Oracle Linux)
- `popos` (Pop!\_OS)
- `reactos` (ReactOS)
- `rebornos` (RebornOS)
- `rockylinux` (Rocky Linux)
- `siduction` (Siduction)
- `slackware` (Slackware)
- `solus` (Solus)
- `tails` (Tails)
- `truenas-core` (TrueNAS Core)
- `truenas-scale` (TrueNAS Scale)
- `vanillaos` (Vanilla OS)
- `void` (Void Linux)
- `vxlinux` (VX Linux)
- `xerolinux` (XeroLinux)
- `zorin` (Zorin OS)

Or you can download a Linux image and manually create a VM
Expand Down Expand Up @@ -322,7 +331,8 @@ supported.
- Use cursor keys and enter key to select the **macOS Base System**
- From **macOS Utilities**
- Click **Disk Utility** and **Continue**
- Select `QEMU HARDDISK Media` (\~103.08GB) from the list and
- Select `QEMU HARDDISK Media` (\~103.08GB) from the list (on
Big Sur and above use `Apple Inc. VirtIO Block Device`) and
click **Erase**.
- Enter a `Name:` for the disk
- If you are installing macOS Mojave or later (Catalina, Big
Expand Down Expand Up @@ -452,24 +462,16 @@ Now reboot, and the App Store should work.

## Windows 10 & 11 Guests

`quickget` can not download
`quickget` can download
[Windows10](https://www.microsoft.com/software-download/windows10) and
[Windows 11](https://www.microsoft.com/software-download/windows11)
automatically, but does automatically create an optimised virtual
machine configuration that you can just add an Windows .iso image to.
automatically and create an optimised virtual machine configuration.
This configuration also includes the [VirtIO drivers for
Windows](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/).
`quickget` can automatically download Windows 8.1, [Windows
10](https://www.microsoft.com/en-gb/software-download/windows10ISO) and
[Windows
11](https://www.microsoft.com/en-gb/software-download/windows11) along
with the [VirtIO drivers for
Windows](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/)
and creates a virtual machine configuration.

``` bash
quickget windows 11
quickemu --vm windows-11.conf
quickemu --vm windows-11-22H2.conf
```

- Complete the installation as you normally would.
Expand Down Expand Up @@ -753,6 +755,7 @@ You can also pass optional parameters
--fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)
--ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers
--screen <screen> : Use specified screen to determine the window size.
--screenpct <percent> : Percent of fullscreen for VM if --fullscreen is not specified.
--shortcut : Create a desktop shortcut
--snapshot apply <tag> : Apply/restore a snapshot.
--snapshot create <tag> : Create a snapshot.
Expand All @@ -779,7 +782,7 @@ You can also pass optional parameters
```
<!-- [[[end]]] -->
```

## Desktop shortcuts

Desktop shortcuts can be created for a VM, the shortcuts are saved in
Expand Down Expand Up @@ -835,6 +838,11 @@ 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 interger 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

Useful reference that assisted the development of Quickemu.
Expand Down
58 changes: 38 additions & 20 deletions docs/quickemu.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 2.19.2
.\" Automatically generated by Pandoc 3.1.1
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
Expand All @@ -14,7 +14,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "QUICKEMU" "1" "February 4, 2023" "quickemu" "Quickemu User Manual"
.TH "QUICKEMU" "1" "June 14, 2023" "quickemu" "Quickemu User Manual"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -102,7 +102,7 @@ Windows\f[R].
.IP \[bu] 2
\f[B]macOS\f[R] Monterey, Big Sur, Catalina, Mojave & High Sierra
.IP \[bu] 2
\f[B]Windows\f[R] 8.1, 10 and 11 including TPM 2.0
\f[B]Windows\f[R] 10 and 11 including TPM 2.0
.IP \[bu] 2
Ubuntu (https://ubuntu.com/desktop) and all the \f[B]official Ubuntu
flavours (https://ubuntu.com/download/flavours)\f[R]
Expand Down Expand Up @@ -209,11 +209,11 @@ to install the above requirements or their equivalents.
.PP
These examples may save a little typing
.PP
Debian:
Debian (and direct derivatives such as MX Linux):
.IP
.nf
\f[C]
sudo apt install qemu bash coreutils ovmf grep jq lsb procps python3 genisoimage usbutils util-linux sed spice-client-gtk swtpm wget xdg-user-dirs zsync unzip
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
\f[R]
.fi
.PP
Expand Down Expand Up @@ -248,8 +248,7 @@ Mauray (https://github.com/ymauray).
.PP
Many thanks to Luke Wesley-Holley (https://github.com/Lukewh) and
Philipp Kiemle (https://github.com/daPhipz) for creating the
\f[B]Quickemu icons (https://github.com/Lukewh/quickemu-icons)\f[R]
\[u1F3A8]
\f[B]Quickemu icons (https://github.com/Lukewh/quickemu-icons)\f[R] 🎨
.SS Quickgui for Ubuntu
.IP
.nf
Expand Down Expand Up @@ -316,10 +315,14 @@ All the official Ubuntu flavours are supported, just replace
.IP \[bu] 2
\f[V]ubuntu-budgie\f[R] (Ubuntu Budgie)
.IP \[bu] 2
\f[V]ubuntucinnamon\f[R] (Ubuntu Cinnamon)
.IP \[bu] 2
\f[V]ubuntukylin\f[R] (Ubuntu Kylin)
.IP \[bu] 2
\f[V]ubuntu-mate\f[R] (Ubuntu MATE)
.IP \[bu] 2
\f[V]ubuntu-server\f[R] (Ubuntu Server)
.IP \[bu] 2
\f[V]ubuntustudio\f[R] (Ubuntu Studio)
.IP \[bu] 2
\f[V]ubuntu\f[R] (Ubuntu)
Expand All @@ -345,6 +348,8 @@ All the official Ubuntu flavours are supported, just replace
.IP \[bu] 2
\f[V]batocera\f[R] (Batocera)
.IP \[bu] 2
\f[V]blendos\f[R] (BlendOS)
.IP \[bu] 2
\f[V]cachyos\f[R] (CachyOS)
.IP \[bu] 2
\f[V]centos-stream\f[R] (CentOS Stream)
Expand All @@ -361,20 +366,22 @@ All the official Ubuntu flavours are supported, just replace
.IP \[bu] 2
\f[V]endeavouros\f[R] (EndeavourOS)
.IP \[bu] 2
\f[V]endless\f[R] (Endless OS)
.IP \[bu] 2
\f[V]fedora\f[R] (Fedora)
.IP \[bu] 2
\f[V]freebsd\f[R] (FreeBSD)
.IP \[bu] 2
\f[V]freedos\f[R] (FreeDOS)
.IP \[bu] 2
\f[V]garuda\f[R] (Garuda Linux)
.IP \[bu] 2
\f[V]gentoo\f[R] (Gentoo)
.IP \[bu] 2
\f[V]ghostbsd\f[R] (GhostBSD)
.IP \[bu] 2
\f[V]haiku\f[R] (Haiku)
.IP \[bu] 2
\f[V]holoiso\f[R] (HoloISO)
.IP \[bu] 2
\f[V]kali\f[R] (Kali)
.IP \[bu] 2
\f[V]kdeneon\f[R] (KDE Neon)
Expand All @@ -399,6 +406,8 @@ All the official Ubuntu flavours are supported, just replace
.IP \[bu] 2
\f[V]openbsd\f[R] (OpenBSD)
.IP \[bu] 2
\f[V]openindiana\f[R] (OpenIndiana)
.IP \[bu] 2
\f[V]opensuse\f[R] (openSUSE)
.IP \[bu] 2
\f[V]oraclelinux\f[R] (Oracle Linux)
Expand All @@ -411,6 +420,8 @@ All the official Ubuntu flavours are supported, just replace
.IP \[bu] 2
\f[V]rockylinux\f[R] (Rocky Linux)
.IP \[bu] 2
\f[V]siduction\f[R] (Siduction)
.IP \[bu] 2
\f[V]slackware\f[R] (Slackware)
.IP \[bu] 2
\f[V]solus\f[R] (Solus)
Expand All @@ -421,8 +432,14 @@ All the official Ubuntu flavours are supported, just replace
.IP \[bu] 2
\f[V]truenas-scale\f[R] (TrueNAS Scale)
.IP \[bu] 2
\f[V]vanillaos\f[R] (Vanilla OS)
.IP \[bu] 2
\f[V]void\f[R] (Void Linux)
.IP \[bu] 2
\f[V]vxlinux\f[R] (VX Linux)
.IP \[bu] 2
\f[V]xerolinux\f[R] (XeroLinux)
.IP \[bu] 2
\f[V]zorin\f[R] (Zorin OS)
.PP
Or you can download a Linux image and manually create a VM
Expand Down Expand Up @@ -483,7 +500,8 @@ From \f[B]macOS Utilities\f[R]
Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R]
.RS 2
.IP \[bu] 2
Select \f[V]QEMU HARDDISK Media\f[R] (\[ti]103.08GB) from the list and
Select \f[V]QEMU HARDDISK Media\f[R] (\[ti]103.08GB) from the list (on
Big Sur and above use \f[V]Apple Inc. VirtIO Block Device\f[R]) and
click \f[B]Erase\f[R].
.IP \[bu] 2
Enter a \f[V]Name:\f[R] for the disk
Expand Down Expand Up @@ -679,24 +697,17 @@ sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
Now reboot, and the App Store should work.
.SS Windows 10 & 11 Guests
.PP
\f[V]quickget\f[R] can not download
\f[V]quickget\f[R] can download
Windows10 (https://www.microsoft.com/software-download/windows10) and
Windows 11 (https://www.microsoft.com/software-download/windows11)
automatically, but does automatically create an optimised virtual
machine configuration that you can just add an Windows .iso image to.
automatically and create an optimised virtual machine configuration.
This configuration also includes the VirtIO drivers for
Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/).
\f[V]quickget\f[R] can automatically download Windows 8.1, Windows
10 (https://www.microsoft.com/en-gb/software-download/windows10ISO) and
Windows 11 (https://www.microsoft.com/en-gb/software-download/windows11)
along with the VirtIO drivers for
Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/)
and creates a virtual machine configuration.
.IP
.nf
\f[C]
quickget windows 11
quickemu --vm windows-11.conf
quickemu --vm windows-11-22H2.conf
\f[R]
.fi
.IP \[bu] 2
Expand Down Expand Up @@ -751,6 +762,7 @@ You can also pass optional parameters
--fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)
--ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers
--screen <screen> : Use specified screen to determine the window size.
--screenpct <percent> : Percent of fullscreen for VM if --fullscreen is not specified.
--shortcut : Create a desktop shortcut
--snapshot apply <tag> : Apply/restore a snapshot.
--snapshot create <tag> : Create a snapshot.
Expand Down Expand Up @@ -841,6 +853,12 @@ The above uses the 2560x1440 screen to compute the size of the window,
which Quickemu sizes to 2048x1152.
Without the \f[V]--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 interger 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]
.SH References
.PP
Useful reference that assisted the development of Quickemu.
Expand Down
Loading

0 comments on commit 1842d0b

Please sign in to comment.