Merge 6cdd372a8d into 9eb54db525

chore: align sub-project
README.md regenerated, with only pandoc markdown pedantry differences
2024-05-05 10:06:06 +01:00 · 2024-05-05 09:36:41 +01:00 · 2024-05-05 09:36:41 +01:00 · 2024-05-05 09:36:41 +01:00 · 2024-05-05 09:32:10 +01:00 · 2024-05-05 09:31:23 +01:00
10 changed files with 214 additions and 577 deletions
--- a/README.md
+++ b/README.md
@ -4,6 +4,7 @@
 # Quickemu

 **Quickly create and run optimised Windows, macOS and Linux virtual machines:**
+
 <img src=".github/screenshot.png" alt="Quickemu Screenshot" />

 **Made with 💝 for <img src=".github/tux.png" align="top" width="24" alt="Tux (Linux)"/>**
@ -22,15 +23,19 @@ 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](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines) 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.
+Linux
+distributions](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines)
+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.

-**Today, Quickemu includes comprehensive support for [macOS](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines),
-[Windows](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines)**, most of the BSDs, novel non-Linux operating systems such as FreeDOS, Haiku, KolibriOS, OpenIndiana, ReactOS, and more.
+**Today, Quickemu includes comprehensive support for
+[macOS](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines),
+[Windows](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines)**,
+most of the BSDs, novel non-Linux operating systems such as FreeDOS,
+Haiku, KolibriOS, OpenIndiana, ReactOS, and more.

-## Features
+# Features

 -   **macOS** Sonoma, Ventura, Monterey, Big Sur, Catalina, Mojave &
    High Sierra
@ -58,40 +63,70 @@ virtual machines.

 # Quick start

-[Once Quickemu is installed](https://github.com/quickemu-project/quickemu/wiki/01-Installation), there are two simple steps to create and run a virtual machine:
+[Once Quickemu is
+installed](https://github.com/quickemu-project/quickemu/wiki/01-Installation),
+there are two simple steps to create and run a virtual machine:

- `quickget` automatically downloads the ISO image for the operating system you want to run and creates a configuration file for the virtual machine.
+-   `quickget` automatically downloads the ISO image for the operating
+    system you want to run and creates a configuration file for the
+    virtual machine.

-```shell
+``` shell
 quickget nixos unstable
 ```

- `quickemu` starts the virtual machine using the configuration file created by `quickget`.
+-   `quickemu` starts the virtual machine using the configuration file
+    created by `quickget`.

-```shell
+``` shell
 quickemu --vm nixos-unstable.conf
 ```
- Execute `quickget` (with no arguments) to see a list of all the supported operating systems.
+
+-   Execute `quickget` (with no arguments) to see a list of all the
+    supported operating systems.

 # Documentation

-The wiki describes how to get up and running with Quickemu and also covers more advanced configuration and usage.
+The wiki describes how to get up and running with Quickemu and also
+covers more advanced configuration and usage.

- [**Installation**](https://github.com/quickemu-project/quickemu/wiki/01-Installation) 💾
- [**Create Linux virtual machines**](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines) 🐧
- [**Create macOS virtual machines**](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines) 🍏
- [**Create Windows virtual machines**](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines) 🪟
- [**Advanced quickemu configuration**](https://github.com/quickemu-project/quickemu/wiki/05-Advanced-quickemu-configuration) 🔧
- [**Advanced quickget features**](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features) 🤓
- [**Alternative frontends**](https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends) 🧑‍💻
- [**References**](https://github.com/quickemu-project/quickemu/wiki/08-References) 📚️
+-   [**Installation**](https://github.com/quickemu-project/quickemu/wiki/01-Installation)
+    💾
+-   [**Create Linux virtual
+    machines**](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines)
+    🐧
+-   [**Create macOS virtual
+    machines**](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines)
+    🍏
+-   [**Create Windows virtual
+    machines**](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines)
+    🪟
+-   [**Advanced quickemu
+    configuration**](https://github.com/quickemu-project/quickemu/wiki/05-Advanced-quickemu-configuration)
+    🔧
+-   [**Advanced quickget
+    features**](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features)
+    🤓
+-   [**Alternative
+    frontends**](https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends)
+    🧑‍💻
+-   [**References**](https://github.com/quickemu-project/quickemu/wiki/08-References)
+    📚️

 # Contributing

 We welcome contributions to Quickemu.

- Help other Quickemu users by answering questions in the [Quickemu Discussions](https://github.com/quickemu-project/quickemu/discussions) 🛟
- Improve the documentation in [this README](https://github.com/quickemu-project/quickemu/edit/master/README.md) and the [Quickemu Wiki](https://github.com/quickemu-project/quickemu/wiki) 📖
- File bug reports and feature requests in the [Quickemu Issues](https://github.com/quickemu-project/quickemu/issues) 📁
- Submit [Quickemu Pull requests](https://github.com/quickemu-project/quickemu/pulls) to fix bugs 🐞 or add new features ✨
- [Sponsor the project](https://github.com/sponsors/flexiondotorg) 💖
+-   Help other Quickemu users by answering questions in the [Quickemu
+    Discussions](https://github.com/quickemu-project/quickemu/discussions)
+    🛟
+-   Improve the documentation in [this
+    README](https://github.com/quickemu-project/quickemu/edit/master/README.md)
+    and the [Quickemu
+    Wiki](https://github.com/quickemu-project/quickemu/wiki) 📖
+-   File bug reports and feature requests in the [Quickemu
+    Issues](https://github.com/quickemu-project/quickemu/issues) 📁
+-   Submit [Quickemu Pull
+    requests](https://github.com/quickemu-project/quickemu/pulls) to fix
+    bugs 🐞 or add new features ✨
+-   [Sponsor the project](https://github.com/sponsors/flexiondotorg) 💖
--- a/2
+++ b/2
@ -1 +1 @@
-Subproject commit ddfea9dc4c9b40e3136c7462eba9bbf45e84e88b
+Subproject commit bfd2e4ba571279453b0a725c379fc1e2c4e24906
--- a/docs/quickemu.1
+++ b/docs/quickemu.1
@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 3.1.13
 .\"
-.TH "QUICKEMU" "1" "April 30, 2024" "quickemu" "Quickemu User Manual"
+.TH "QUICKEMU" "1" "May 4, 2024" "quickemu" "Quickemu User Manual"
 .SH NAME
 quickemu \- A quick VM builder and manager
 .SH SYNOPSIS
@ -142,7 +142,7 @@ Print version
 .TP
 \f[B]quickemu \[en]vm ubuntu\-mate\-22.04.conf\f[R]
 Launches the VM specified in the file \f[I]ubuntu\-mate\-22.04.conf\f[R]
-.SS Introduction
+.SH Introduction
 \f[B]Quickemu\f[R] is a wrapper for the excellent \c
 .UR https://www.qemu.org/
 QEMU
@ -152,14 +152,25 @@ rather than expose exhaustive configuration options.
 You decide what operating system you want to run, and Quickemu will
 figure out the best way to do it for you.
 .PP
-The original objective of the project was to enable quick testing of
-Linux distributions 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.
+The original objective of the project was to \c
+.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines
+enable quick testing of Linux distributions
+.UE \c
+\ 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.
 .PP
-\f[B]Quickemu now also includes comprehensive support for macOS and
-Windows\f[R].
-.SS Features
+\f[B]Today, Quickemu includes comprehensive support for \c
+.UR https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines
+macOS
+.UE \c
+, \c
+.UR https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines
+Windows
+.UE \c
+\f[R], most of the BSDs, novel non\-Linux operating systems such as
+FreeDOS, Haiku, KolibriOS, OpenIndiana, ReactOS, and more.
+.SH Features
 .IP \[bu] 2
 \f[B]macOS\f[R] Sonoma, Ventura, Monterey, Big Sur, Catalina, Mojave &
 High Sierra
@ -176,7 +187,7 @@ official Ubuntu flavours
 .UE \c
 \f[R]
 .IP \[bu] 2
-\f[B]Over 360 operating system editions are supported!\f[R]
+\f[B]Nearly 1000 operating system editions are supported!\f[R]
 .IP \[bu] 2
 Full SPICE support including host/guest clipboard sharing
 .IP \[bu] 2
@ -308,11 +319,6 @@ swtpm
 .UE \c
 .IP \[bu] 2
 \c
-.UR https://www.gnu.org/software/wget/
-Wget
-.UE \c
-.IP \[bu] 2
-\c
 .UR https://www.freedesktop.org/wiki/Software/xdg-user-dirs/
 xdg\-user\-dirs
 .UE \c
@ -353,12 +359,12 @@ These examples may save a little typing:
 This also applies to derivatives:
 .IP
 .EX
-sudo apt install qemu bash coreutils curl 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
+sudo apt install qemu bash coreutils curl ovmf grep jq lsb\-base procps python3 genisoimage usbutils util\-linux sed socat spice\-client\-gtk libtss2\-tcti\-swtpm0 xdg\-user\-dirs zsync unzip
 .EE
 .SS Install requirements on Fedora hosts
 .IP
 .EX
-sudo dnf install qemu bash coreutils curl edk2\-tools grep jq lsb procps python3 genisoimage usbutils util\-linux sed socat spice\-gtk\-tools swtpm wget xdg\-user\-dirs xrandr unzip
+sudo dnf install qemu bash coreutils curl edk2\-tools grep jq lsb procps python3 genisoimage usbutils util\-linux sed socat spice\-gtk\-tools swtpm xdg\-user\-dirs xrandr unzip
 .EE
 .SS Install requirements on macOS hosts
 This is a \f[B]work in progress\f[R] (see \c
@ -368,7 +374,7 @@ issue 248
 \ for other steps and changes that may enable running on MacOS)
 .IP
 .EX
-brew install qemu bash coreutils curl grep jq python\[at]3.10 cdrtools gnu\-sed spice\-gtk wget zsync
+brew install qemu bash coreutils curl grep jq python\[at]3.10 cdrtools gnu\-sed spice\-gtk zsync
 .EE
 .SS \c
 .UR https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends
@ -512,19 +518,17 @@ wiki
 You can also use \f[CR]quickget\f[R] with advanced options :
 .IP
 .EX
- \-[12345]              <os>           : Show info* about OS
- \-\-download       (\-d) <os> <re> [ed] : Download the ISO only; no VM configuration
- \-\-create\-config (\-cc) <os> [path/url]: Create default VM config for image
- \-\-open\-homepage  (\-o) <os>           : Open homepage for the OS
- \-\-version        (\-v)                : Show version
- \-\-help           (\-h)                : Show this help message
- \-\-url            (\-u) <os> <re> [ed] : Show download URL for an OS release/edition
- \-\-url\-all       (\-ua) <os>           : Show all download URLs for an OS
- \-\-check          (\-c) <os> [re] [ed] : Check download an OS release/edition is available
- \-\-check\-all     (\-ca) <os>           : Check all downloads for an OS are available
- \-\-list           (\-l)                : List all supported systems in plain text
- \-\-list\-csv      (\-lc)                : List all supported systems in csv format
- \-\-list\-json     (\-lj)                : List all supported systems in json format
+  \-[12345]              <os>           : Show info* about OS
+  \-\-download       (\-d) <os> <re> [ed] : Download image; no VM configuration
+  \-\-create\-config (\-cc) <os> [path/url]: Create default VM config for image
+  \-\-open\-homepage  (\-o) <os>           : Open homepage for the OS
+  \-\-version        (\-v)                : Show version
+  \-\-help           (\-h)                : Show this help message
+  \-\-url            (\-u) [os] [re] [ed] : Show image URL(s)
+  \-\-check          (\-c) [os] [re] [ed] : Check image URL(s)
+  \-\-list           (\-l)                : List all supported systems
+  \-\-list\-csv      (\-lc)                : List everything in csv format
+  \-\-list\-json     (\-lj)                : List everything in json format
 .EE
 .PP
 Here are some typical uses
@ -651,6 +655,8 @@ wiki
 .IP \[bu] 2
 \f[CR]nixos\f[R] (NixOS)
 .IP \[bu] 2
+\f[CR]nwg\-shell\f[R] (nwg\-shell)
+.IP \[bu] 2
 \f[CR]openbsd\f[R] (OpenBSD)
 .IP \[bu] 2
 \f[CR]openindiana\f[R] (OpenIndiana)
@ -876,115 +882,13 @@ Sur and newer, but not previous releases.
 And VirtIO Block Media (disks) are supported/stable in Catalina and
 newer.
 .RE
-.SS macOS compatibility
-There are some considerations when running macOS via Quickemu.
-.IP \[bu] 2
-Supported macOS releases:
-.RS 2
-.IP \[bu] 2
-High Sierra
-.IP \[bu] 2
-Mojave
-.IP \[bu] 2
-Catalina \f[B](Recommended)\f[R]
-.IP \[bu] 2
-Big Sur
-.IP \[bu] 2
-Monterey
-.IP \[bu] 2
-Ventura
-.IP \[bu] 2
-Sonoma
-.RE
-.IP \[bu] 2
-\f[CR]quickemu\f[R] will automatically download the required \c
-.UR https://github.com/acidanthera/OpenCorePkg
-OpenCore
-.UE \c
-\ bootloader and OVMF firmware from \c
-.UR https://github.com/kholia/OSX-KVM
-OSX\-KVM
+.PP
+There is further advice and information about macOS guests in the
+project \c
+.UR https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests
+wiki
 .UE \c
 \&.
-.IP \[bu] 2
-Optimised by default, but no GPU acceleration is available.
-.RS 2
-.IP \[bu] 2
-Host CPU vendor is detected and guest CPU is optimised accordingly.
-.IP \[bu] 2
-\c
-.UR https://www.kraxel.org/blog/2019/06/macos-qemu-guest/
-VirtIO Block Media
-.UE \c
-\ is used for the system disk where supported.
-.IP \[bu] 2
-\c
-.UR http://philjordan.eu/osx-virt/
-VirtIO \f[CR]usb\-tablet\f[R]
-.UE \c
-\ is used for the mouse.
-.IP \[bu] 2
-VirtIO Network (\f[CR]virtio\-net\f[R]) is supported and enabled on
-macOS Big Sur and newer but previous releases use \f[CR]vmxnet3\f[R].
-.IP \[bu] 2
-VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and
-newer but disabled for other support macOS releases.
-.RE
-.IP \[bu] 2
-USB host and SPICE pass\-through is:
-.RS 2
-.IP \[bu] 2
-UHCI (USB 2.0) on macOS Catalina and earlier.
-.IP \[bu] 2
-XHCI (USB 3.0) on macOS Big Sur and newer.
-.RE
-.IP \[bu] 2
-Display resolution can only be changed via macOS System Preferences.
-.IP \[bu] 2
-\f[B]Full Duplex audio requires \c
-.UR https://github.com/chris1111/VoodooHDA-OC
-VoodooHDA OC
-.UE \c
-\ or pass\-through a USB audio\-device to the macOS guest VM\f[R].
-.IP \[bu] 2
-NOTE!
-\c
-.UR https://disable-gatekeeper.github.io/
-Gatekeeper
-.UE \c
-\ and \c
-.UR https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection
-System Integrity Protection (SIP)
-.UE \c
-\ need to be disabled to install VoodooHDA OC
-.IP \[bu] 2
-File sharing between guest and host is available via \c
-.UR https://wiki.qemu.org/Documentation/9psetup
-virtio\-9p
-.UE \c
-\ and \c
-.UR https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24
-SPICE webdavd
-.UE \c
-\&.
-.IP \[bu] 2
-Copy/paste via SPICE agent is \f[B]not available on macOS\f[R].
-.SS macOS App Store
-If you see \f[I]\[lq]Your device or computer could not be
-verified\[rq]\f[R] when you try to login to the App Store, make sure
-that your wired ethernet device is \f[CR]en0\f[R].
-Use \f[CR]ifconfig\f[R] in a terminal to verify this.
-.PP
-If the wired ethernet device is not \f[CR]en0\f[R], then then go to
-\f[I]System Preferences\f[R] \-> \f[I]Network\f[R], delete all the
-network devices and apply the changes.
-Next, open a terminal and run the following:
-.IP
-.EX
-sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
-.EE
-.PP
-Now reboot, and the App Store should work.
 .SS \c
 .UR https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines
 Creating Windows guests
@ -1048,44 +952,19 @@ Username: \f[CR]Quickemu\f[R]
 .IP \[bu] 2
 Password: \f[CR]quickemu\f[R]
 .RE
-.SS Regional versions
-By default \f[CR]quickget\f[R] will download the \f[I]\[lq]English
-International\[rq]\f[R] release (\f[I]\[lq]English (United
-States)\[rq]\f[R] for server releases), but you can optionally specify
-one of the supported languages: For example:
-.IP
-.EX
-quickget windows 11 \[dq]Chinese (Traditional)\[dq]
-.EE
 .PP
-The default Windows 11 configuration looks like this:
-.IP
-.EX
-guest_os=\[dq]windows\[dq]
-disk_img=\[dq]windows\-11/disk.qcow2\[dq]
-iso=\[dq]windows\-11/windows\-11.iso\[dq]
-fixed_iso=\[dq]windows\-11/virtio\-win.iso\[dq]
-tpm=\[dq]on\[dq]
-secureboot=\[dq]off\[dq]
-.EE
-.IP \[bu] 2
-\f[CR]guest_os=\[dq]windows\[dq]\f[R] instructs \f[CR]quickemu\f[R] to
-optimise for Windows.
-.IP \[bu] 2
-\f[CR]fixed_iso=\f[R] specifies the ISO image that provides VirtIO
-drivers.
-.IP \[bu] 2
-\f[CR]tpm=\[dq]on\[dq]\f[R] instructs \f[CR]quickemu\f[R] to create a
-software emulated TPM device using \f[CR]swtpm\f[R].
+Further information is available from the project \c
+.UR https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines
+wiki
+.UE \c
 .SS Configuration
 Here are the usage instructions:
 .IP
 .EX
-
 Usage
-  quickemu \-\-vm ubuntu.conf [optional params]
+  quickemu \-\-vm ubuntu.conf <arguments>

-List of optional parameters:
+Arguments
  \-\-access                          : Enable remote spice access support. \[aq]local\[aq] (default), \[aq]remote\[aq], \[aq]clientipaddress\[aq]
  \-\-braille                         : Enable braille support. Requires SDL.
  \-\-delete\-disk                     : Delete the disk image and EFI variables
--- a/docs/quickemu.1.md
+++ b/docs/quickemu.1.md
@ -1,6 +1,6 @@
 ---
 author: Martin Wimpress
-date: April 30, 2024
+date: May 4, 2024
 footer: quickemu
 header: Quickemu User Manual
 section: 1
@ -144,7 +144,7 @@ You can also pass optional parameters
 **quickemu --vm 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
 [QEMU](https://www.qemu.org/) that attempts to automatically *"do the
@ -152,24 +152,27 @@ right thing"*, rather than expose exhaustive configuration options. You
 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](#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.
+The original objective of the project was to [enable quick testing of
+Linux
+distributions](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines)
+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](#creating-macos-guests-) and
-[Windows](#creating-windows-guests-)**.
+**Today, Quickemu includes comprehensive support for
+[macOS](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines),
+[Windows](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines)**,
+most of the BSDs, novel non-Linux operating systems such as FreeDOS,
+Haiku, KolibriOS, OpenIndiana, ReactOS, and more.

-## Features
+# Features

 -   **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)**
-   **Over 360 operating system editions are supported!**
+-   **Nearly 1000 operating system editions are supported!**
 -   Full SPICE support including host/guest clipboard sharing
 -   VirtIO-webdavd file sharing for Linux and Windows guests
 -   VirtIO-9p file sharing for Linux and macOS guests
@ -345,19 +348,17 @@ may have further information.
 You can also use `quickget` with advanced options :

 ``` text
- -[12345]              <os>           : Show info* about OS
- --download       (-d) <os> <re> [ed] : Download the ISO only; no VM configuration
- --create-config (-cc) <os> [path/url]: Create default VM config for image
- --open-homepage  (-o) <os>           : Open homepage for the OS
- --version        (-v)                : Show version
- --help           (-h)                : Show this help message
- --url            (-u) <os> <re> [ed] : Show download URL for an OS release/edition
- --url-all       (-ua) <os>           : Show all download URLs for an OS
- --check          (-c) <os> [re] [ed] : Check download an OS release/edition is available
- --check-all     (-ca) <os>           : Check all downloads for an OS are available
- --list           (-l)                : List all supported systems in plain text
- --list-csv      (-lc)                : List all supported systems in csv format
- --list-json     (-lj)                : List all supported systems in json format
+  -[12345]              <os>           : Show info* about OS
+  --download       (-d) <os> <re> [ed] : Download image; no VM configuration
+  --create-config (-cc) <os> [path/url]: Create default VM config for image
+  --open-homepage  (-o) <os>           : Open homepage for the OS
+  --version        (-v)                : Show version
+  --help           (-h)                : Show this help message
+  --url            (-u) [os] [re] [ed] : Show image URL(s)
+  --check          (-c) [os] [re] [ed] : Check image URL(s)
+  --list           (-l)                : List all supported systems
+  --list-csv      (-lc)                : List everything in csv format
+  --list-json     (-lj)                : List everything in json format
 ```

 Here are some typical uses
@ -433,6 +434,7 @@ Further information is available from the project
 -   `netbsd` (NetBSD)
 -   `nitrux` (Nitrux)
 -   `nixos` (NixOS)
+-   `nwg-shell` (nwg-shell)
 -   `openbsd` (OpenBSD)
 -   `openindiana` (OpenIndiana)
 -   `opensuse` (openSUSE)
@ -587,64 +589,9 @@ macos_release="catalina"
    -   And VirtIO Block Media (disks) are supported/stable in Catalina
        and newer.

-### macOS compatibility
-
-There are some considerations when running macOS via Quickemu.
-
-   Supported macOS releases:
-    -   High Sierra
-    -   Mojave
-    -   Catalina **(Recommended)**
-    -   Big Sur
-    -   Monterey
-    -   Ventura
-    -   Sonoma
-   `quickemu` will automatically download the required
-    [OpenCore](https://github.com/acidanthera/OpenCorePkg) bootloader
-    and OVMF firmware from [OSX-KVM](https://github.com/kholia/OSX-KVM).
-   Optimised by default, but no GPU acceleration is available.
-    -   Host CPU vendor is detected and guest CPU is optimised
-        accordingly.
-    -   [VirtIO Block
-        Media](https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is
-        used for the system disk where supported.
-    -   [VirtIO `usb-tablet`](http://philjordan.eu/osx-virt/) is used
-        for the mouse.
-    -   VirtIO Network (`virtio-net`) is supported and enabled on macOS
-        Big Sur and newer but previous releases use `vmxnet3`.
-    -   VirtIO Memory Ballooning is supported and enabled on macOS Big
-        Sur and newer but disabled for other support macOS releases.
-   USB host and SPICE pass-through is:
-    -   UHCI (USB 2.0) on macOS Catalina and earlier.
-    -   XHCI (USB 3.0) on macOS Big Sur and newer.
-   Display resolution can only be changed via macOS System Preferences.
-   **Full Duplex audio requires [VoodooHDA
-    OC](https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB
-    audio-device to the macOS guest VM**.
-   NOTE! [Gatekeeper](https://disable-gatekeeper.github.io/) and
-    [System Integrity Protection
-    (SIP)](https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection)
-    need to be disabled to install VoodooHDA OC
-   File sharing between guest and host is available via
-    [virtio-9p](https://wiki.qemu.org/Documentation/9psetup) and [SPICE
-    webdavd](https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24).
-   Copy/paste via SPICE agent is **not available on macOS**.
-
-### macOS App Store
-
-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
-is `en0`. Use `ifconfig` in a terminal to verify this.
-
-If the wired ethernet device is not `en0`, then then go to *System
-Preferences* -\> *Network*, delete all the network devices and apply the
-changes. Next, open a terminal and run the following:
-
-``` shell
-sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
-```
-
-Now reboot, and the App Store should work.
+There is further advice and information about macOS guests in the
+project
+[wiki](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests).

 ## [Creating Windows guests](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines) 🪟

@ -680,42 +627,18 @@ quickemu --vm windows-11.conf
    -   Username: `Quickemu`
    -   Password: `quickemu`

-### Regional versions
-
-By default `quickget` will download the *"English International"*
-release (*"English (United States)"* for server releases), but you can
-optionally specify one of the supported languages: For example:
-
-``` shell
-quickget windows 11 "Chinese (Traditional)"
-```
-
-The default Windows 11 configuration looks like this:
-
-``` shell
-guest_os="windows"
-disk_img="windows-11/disk.qcow2"
-iso="windows-11/windows-11.iso"
-fixed_iso="windows-11/virtio-win.iso"
-tpm="on"
-secureboot="off"
-```
-
-   `guest_os="windows"` instructs `quickemu` to optimise for Windows.
-   `fixed_iso=` specifies the ISO image that provides VirtIO drivers.
-   `tpm="on"` instructs `quickemu` to create a software emulated TPM
-    device using `swtpm`.
+Further information is available from the project
+[wiki](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines)

 ## Configuration

 Here are the usage instructions:

 ``` text
-
 Usage
-  quickemu --vm ubuntu.conf [optional params]
+  quickemu --vm ubuntu.conf <arguments>

-List of optional parameters:
+Arguments
  --access                          : Enable remote spice access support. 'local' (default), 'remote', 'clientipaddress'
  --braille                         : Enable braille support. Requires SDL.
  --delete-disk                     : Delete the disk image and EFI variables
--- a/docs/quickemu_conf.1
+++ b/docs/quickemu_conf.1
@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 3.1.13
 .\"
-.TH "QUICKEMU_CONF" "1" "April 30, 2024" "quickemu_conf" "Quickemu Configuration Manual"
+.TH "QUICKEMU_CONF" "1" "May 4, 2024" "quickemu_conf" "Quickemu Configuration Manual"
 .SH NAME
 quickemu_conf \- Options and parameters in the quickemu <vm>.conf
 .SH DESCRIPTION
--- a/docs/quickemu_conf.1.md
+++ b/docs/quickemu_conf.1.md
@ -1,6 +1,6 @@
 ---
 author: Martin Wimpress
-date: April 30, 2024
+date: May 4, 2024
 footer: quickemu_conf
 header: Quickemu Configuration Manual
 section: 1
--- a/docs/quickget.1
+++ b/docs/quickget.1
@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 3.1.13
 .\"
-.TH "QUICKGET" "1" "April 30, 2024" "quickget" "Quickget User Manual"
+.TH "QUICKGET" "1" "May 4, 2024" "quickget" "Quickget User Manual"
 .SH NAME
 quickget \- download and prepare materials for building a quickemu VM
 .SH SYNOPSIS
@ -110,19 +110,17 @@ wiki
 You can also use \f[CR]quickget\f[R] with advanced options :
 .IP
 .EX
- \-[12345]              <os>           : Show info* about OS
- \-\-download       (\-d) <os> <re> [ed] : Download the ISO only; no VM configuration
- \-\-create\-config (\-cc) <os> [path/url]: Create default VM config for image
- \-\-open\-homepage  (\-o) <os>           : Open homepage for the OS
- \-\-version        (\-v)                : Show version
- \-\-help           (\-h)                : Show this help message
- \-\-url            (\-u) <os> <re> [ed] : Show download URL for an OS release/edition
- \-\-url\-all       (\-ua) <os>           : Show all download URLs for an OS
- \-\-check          (\-c) <os> [re] [ed] : Check download an OS release/edition is available
- \-\-check\-all     (\-ca) <os>           : Check all downloads for an OS are available
- \-\-list           (\-l)                : List all supported systems in plain text
- \-\-list\-csv      (\-lc)                : List all supported systems in csv format
- \-\-list\-json     (\-lj)                : List all supported systems in json format
+  \-[12345]              <os>           : Show info* about OS
+  \-\-download       (\-d) <os> <re> [ed] : Download image; no VM configuration
+  \-\-create\-config (\-cc) <os> [path/url]: Create default VM config for image
+  \-\-open\-homepage  (\-o) <os>           : Open homepage for the OS
+  \-\-version        (\-v)                : Show version
+  \-\-help           (\-h)                : Show this help message
+  \-\-url            (\-u) [os] [re] [ed] : Show image URL(s)
+  \-\-check          (\-c) [os] [re] [ed] : Check image URL(s)
+  \-\-list           (\-l)                : List all supported systems
+  \-\-list\-csv      (\-lc)                : List everything in csv format
+  \-\-list\-json     (\-lj)                : List everything in json format
 .EE
 .PP
 Here are some typical uses
@ -249,6 +247,8 @@ wiki
 .IP \[bu] 2
 \f[CR]nixos\f[R] (NixOS)
 .IP \[bu] 2
+\f[CR]nwg\-shell\f[R] (nwg\-shell)
+.IP \[bu] 2
 \f[CR]openbsd\f[R] (OpenBSD)
 .IP \[bu] 2
 \f[CR]openindiana\f[R] (OpenIndiana)
@ -474,115 +474,13 @@ Sur and newer, but not previous releases.
 And VirtIO Block Media (disks) are supported/stable in Catalina and
 newer.
 .RE
-.SS macOS compatibility
-There are some considerations when running macOS via Quickemu.
-.IP \[bu] 2
-Supported macOS releases:
-.RS 2
-.IP \[bu] 2
-High Sierra
-.IP \[bu] 2
-Mojave
-.IP \[bu] 2
-Catalina \f[B](Recommended)\f[R]
-.IP \[bu] 2
-Big Sur
-.IP \[bu] 2
-Monterey
-.IP \[bu] 2
-Ventura
-.IP \[bu] 2
-Sonoma
-.RE
-.IP \[bu] 2
-\f[CR]quickemu\f[R] will automatically download the required \c
-.UR https://github.com/acidanthera/OpenCorePkg
-OpenCore
-.UE \c
-\ bootloader and OVMF firmware from \c
-.UR https://github.com/kholia/OSX-KVM
-OSX\-KVM
+.PP
+There is further advice and information about macOS guests in the
+project \c
+.UR https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests
+wiki
 .UE \c
 \&.
-.IP \[bu] 2
-Optimised by default, but no GPU acceleration is available.
-.RS 2
-.IP \[bu] 2
-Host CPU vendor is detected and guest CPU is optimised accordingly.
-.IP \[bu] 2
-\c
-.UR https://www.kraxel.org/blog/2019/06/macos-qemu-guest/
-VirtIO Block Media
-.UE \c
-\ is used for the system disk where supported.
-.IP \[bu] 2
-\c
-.UR http://philjordan.eu/osx-virt/
-VirtIO \f[CR]usb\-tablet\f[R]
-.UE \c
-\ is used for the mouse.
-.IP \[bu] 2
-VirtIO Network (\f[CR]virtio\-net\f[R]) is supported and enabled on
-macOS Big Sur and newer but previous releases use \f[CR]vmxnet3\f[R].
-.IP \[bu] 2
-VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and
-newer but disabled for other support macOS releases.
-.RE
-.IP \[bu] 2
-USB host and SPICE pass\-through is:
-.RS 2
-.IP \[bu] 2
-UHCI (USB 2.0) on macOS Catalina and earlier.
-.IP \[bu] 2
-XHCI (USB 3.0) on macOS Big Sur and newer.
-.RE
-.IP \[bu] 2
-Display resolution can only be changed via macOS System Preferences.
-.IP \[bu] 2
-\f[B]Full Duplex audio requires \c
-.UR https://github.com/chris1111/VoodooHDA-OC
-VoodooHDA OC
-.UE \c
-\ or pass\-through a USB audio\-device to the macOS guest VM\f[R].
-.IP \[bu] 2
-NOTE!
-\c
-.UR https://disable-gatekeeper.github.io/
-Gatekeeper
-.UE \c
-\ and \c
-.UR https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection
-System Integrity Protection (SIP)
-.UE \c
-\ need to be disabled to install VoodooHDA OC
-.IP \[bu] 2
-File sharing between guest and host is available via \c
-.UR https://wiki.qemu.org/Documentation/9psetup
-virtio\-9p
-.UE \c
-\ and \c
-.UR https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24
-SPICE webdavd
-.UE \c
-\&.
-.IP \[bu] 2
-Copy/paste via SPICE agent is \f[B]not available on macOS\f[R].
-.SS macOS App Store
-If you see \f[I]\[lq]Your device or computer could not be
-verified\[rq]\f[R] when you try to login to the App Store, make sure
-that your wired ethernet device is \f[CR]en0\f[R].
-Use \f[CR]ifconfig\f[R] in a terminal to verify this.
-.PP
-If the wired ethernet device is not \f[CR]en0\f[R], then then go to
-\f[I]System Preferences\f[R] \-> \f[I]Network\f[R], delete all the
-network devices and apply the changes.
-Next, open a terminal and run the following:
-.IP
-.EX
-sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
-.EE
-.PP
-Now reboot, and the App Store should work.
 .SS \c
 .UR https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines
 Creating Windows guests
@ -646,35 +544,11 @@ Username: \f[CR]Quickemu\f[R]
 .IP \[bu] 2
 Password: \f[CR]quickemu\f[R]
 .RE
-.SS Regional versions
-By default \f[CR]quickget\f[R] will download the \f[I]\[lq]English
-International\[rq]\f[R] release (\f[I]\[lq]English (United
-States)\[rq]\f[R] for server releases), but you can optionally specify
-one of the supported languages: For example:
-.IP
-.EX
-quickget windows 11 \[dq]Chinese (Traditional)\[dq]
-.EE
 .PP
-The default Windows 11 configuration looks like this:
-.IP
-.EX
-guest_os=\[dq]windows\[dq]
-disk_img=\[dq]windows\-11/disk.qcow2\[dq]
-iso=\[dq]windows\-11/windows\-11.iso\[dq]
-fixed_iso=\[dq]windows\-11/virtio\-win.iso\[dq]
-tpm=\[dq]on\[dq]
-secureboot=\[dq]off\[dq]
-.EE
-.IP \[bu] 2
-\f[CR]guest_os=\[dq]windows\[dq]\f[R] instructs \f[CR]quickemu\f[R] to
-optimise for Windows.
-.IP \[bu] 2
-\f[CR]fixed_iso=\f[R] specifies the ISO image that provides VirtIO
-drivers.
-.IP \[bu] 2
-\f[CR]tpm=\[dq]on\[dq]\f[R] instructs \f[CR]quickemu\f[R] to create a
-software emulated TPM device using \f[CR]swtpm\f[R].
+Further information is available from the project \c
+.UR https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines
+wiki
+.UE \c
 .SH AUTHORS
 Written by Martin Wimpress.
 .SH BUGS
--- a/docs/quickget.1.md
+++ b/docs/quickget.1.md
@ -1,6 +1,6 @@
 ---
 author: Martin Wimpress
-date: April 30, 2024
+date: May 4, 2024
 footer: quickget
 header: Quickget User Manual
 section: 1
@ -106,19 +106,17 @@ may have further information.
 You can also use `quickget` with advanced options :

 ``` text
- -[12345]              <os>           : Show info* about OS
- --download       (-d) <os> <re> [ed] : Download the ISO only; no VM configuration
- --create-config (-cc) <os> [path/url]: Create default VM config for image
- --open-homepage  (-o) <os>           : Open homepage for the OS
- --version        (-v)                : Show version
- --help           (-h)                : Show this help message
- --url            (-u) <os> <re> [ed] : Show download URL for an OS release/edition
- --url-all       (-ua) <os>           : Show all download URLs for an OS
- --check          (-c) <os> [re] [ed] : Check download an OS release/edition is available
- --check-all     (-ca) <os>           : Check all downloads for an OS are available
- --list           (-l)                : List all supported systems in plain text
- --list-csv      (-lc)                : List all supported systems in csv format
- --list-json     (-lj)                : List all supported systems in json format
+  -[12345]              <os>           : Show info* about OS
+  --download       (-d) <os> <re> [ed] : Download image; no VM configuration
+  --create-config (-cc) <os> [path/url]: Create default VM config for image
+  --open-homepage  (-o) <os>           : Open homepage for the OS
+  --version        (-v)                : Show version
+  --help           (-h)                : Show this help message
+  --url            (-u) [os] [re] [ed] : Show image URL(s)
+  --check          (-c) [os] [re] [ed] : Check image URL(s)
+  --list           (-l)                : List all supported systems
+  --list-csv      (-lc)                : List everything in csv format
+  --list-json     (-lj)                : List everything in json format
 ```

 Here are some typical uses
@ -194,6 +192,7 @@ Further information is available from the project
 -   `netbsd` (NetBSD)
 -   `nitrux` (Nitrux)
 -   `nixos` (NixOS)
+-   `nwg-shell` (nwg-shell)
 -   `openbsd` (OpenBSD)
 -   `openindiana` (OpenIndiana)
 -   `opensuse` (openSUSE)
@ -348,64 +347,9 @@ macos_release="catalina"
    -   And VirtIO Block Media (disks) are supported/stable in Catalina
        and newer.

-### macOS compatibility
-
-There are some considerations when running macOS via Quickemu.
-
-   Supported macOS releases:
-    -   High Sierra
-    -   Mojave
-    -   Catalina **(Recommended)**
-    -   Big Sur
-    -   Monterey
-    -   Ventura
-    -   Sonoma
-   `quickemu` will automatically download the required
-    [OpenCore](https://github.com/acidanthera/OpenCorePkg) bootloader
-    and OVMF firmware from [OSX-KVM](https://github.com/kholia/OSX-KVM).
-   Optimised by default, but no GPU acceleration is available.
-    -   Host CPU vendor is detected and guest CPU is optimised
-        accordingly.
-    -   [VirtIO Block
-        Media](https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is
-        used for the system disk where supported.
-    -   [VirtIO `usb-tablet`](http://philjordan.eu/osx-virt/) is used
-        for the mouse.
-    -   VirtIO Network (`virtio-net`) is supported and enabled on macOS
-        Big Sur and newer but previous releases use `vmxnet3`.
-    -   VirtIO Memory Ballooning is supported and enabled on macOS Big
-        Sur and newer but disabled for other support macOS releases.
-   USB host and SPICE pass-through is:
-    -   UHCI (USB 2.0) on macOS Catalina and earlier.
-    -   XHCI (USB 3.0) on macOS Big Sur and newer.
-   Display resolution can only be changed via macOS System Preferences.
-   **Full Duplex audio requires [VoodooHDA
-    OC](https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB
-    audio-device to the macOS guest VM**.
-   NOTE! [Gatekeeper](https://disable-gatekeeper.github.io/) and
-    [System Integrity Protection
-    (SIP)](https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection)
-    need to be disabled to install VoodooHDA OC
-   File sharing between guest and host is available via
-    [virtio-9p](https://wiki.qemu.org/Documentation/9psetup) and [SPICE
-    webdavd](https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24).
-   Copy/paste via SPICE agent is **not available on macOS**.
-
-### macOS App Store
-
-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
-is `en0`. Use `ifconfig` in a terminal to verify this.
-
-If the wired ethernet device is not `en0`, then then go to *System
-Preferences* -\> *Network*, delete all the network devices and apply the
-changes. Next, open a terminal and run the following:
-
-``` shell
-sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
-```
-
-Now reboot, and the App Store should work.
+There is further advice and information about macOS guests in the
+project
+[wiki](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests).

 ## [Creating Windows guests](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines) 🪟

@ -441,31 +385,8 @@ quickemu --vm windows-11.conf
    -   Username: `Quickemu`
    -   Password: `quickemu`

-### Regional versions
-
-By default `quickget` will download the *"English International"*
-release (*"English (United States)"* for server releases), but you can
-optionally specify one of the supported languages: For example:
-
-``` shell
-quickget windows 11 "Chinese (Traditional)"
-```
-
-The default Windows 11 configuration looks like this:
-
-``` shell
-guest_os="windows"
-disk_img="windows-11/disk.qcow2"
-iso="windows-11/windows-11.iso"
-fixed_iso="windows-11/virtio-win.iso"
-tpm="on"
-secureboot="off"
-```
-
-   `guest_os="windows"` instructs `quickemu` to optimise for Windows.
-   `fixed_iso=` specifies the ISO image that provides VirtIO drivers.
-   `tpm="on"` instructs `quickemu` to create a software emulated TPM
-    device using `swtpm`.
+Further information is available from the project
+[wiki](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines)

 # AUTHORS

--- a/package.nix
+++ b/package.nix
@ -84,7 +84,7 @@ stdenv.mkDerivation rec {
  passthru.tests = testers.testVersion { package = quickemu; };

  meta = with lib; {
-    description = "Quickly create and run optimised Windows, macOS and Linux desktop virtual machines";
+    description = "Quickly create and run optimised Windows, macOS and Linux virtual machines";
    homepage = "https://github.com/quickemu-project/quickemu";
    license = licenses.mit;
    maintainers = with maintainers; [ fedx-sudo flexiondotorg ];
--- a/45
+++ b/45
@ -40,7 +40,7 @@ function os_info() {
    SIMPLE_NAME="${1}"
    case ${SIMPLE_NAME} in
      #name)            INFO="PrettyName|BasedOf|Credentials|Homepage|Info";;
-      alma)             INFO="Alma Linux|Fedora,RedHat|-|https://almalinux.org/|Community owned and governed, forever-free enterprise Linux distribution, focused on long-term stability, providing a robust production-grade platform. AlmaLinux OS is binary compatible with RHEL®.";;
+      alma)             INFO="Alma Linux|Fedora RedHat|-|https://almalinux.org/|Community owned and governed, forever-free enterprise Linux distribution, focused on long-term stability, providing a robust production-grade platform. AlmaLinux OS is binary compatible with RHEL®.";;
      alpine)           INFO="Alpine Linux|Independent|-|https://alpinelinux.org/|Security-oriented, lightweight Linux distribution based on musl libc and busybox.";;
      android)          INFO="Android x86|Independent|-|https://www.android-x86.org/|Port Android Open Source Project to x86 platform.";;
      antix)            INFO="Antix|Debian|-|https://antixlinux.com/|Fast, lightweight and easy to install systemd-free linux live CD distribution based on Debian Stable for Intel-AMD x86 compatible systems.";;
@ -50,13 +50,13 @@ function os_info() {
      artixlinux)       INFO="Artix Linux|Arch|-|https://artixlinux.org/|The Art of Linux. Simple. Fast. Systemd-free.";;
      athenaos)         INFO="Athena OS|Arch|-|https://athenaos.org/|Offer a different experience than the most used pentesting distributions by providing only tools that fit with the user needs and improving the access to hacking resources and learning materials.";;
      batocera)         INFO="Batocera|Independent|-|https://batocera.org/|Retro-gaming distribution with the aim of turning any computer/nano computer into a gaming console during a game or permanently.";;
-      bazzite)          INFO="Bazzite|Fedora,SteamOS|-|https://github.com/ublue-os/bazzite/|Container native gaming and a ready-to-game SteamOS like.";;
+      bazzite)          INFO="Bazzite|Fedora SteamOS|-|https://github.com/ublue-os/bazzite/|Container native gaming and a ready-to-game SteamOS like.";;
      biglinux)         INFO="BigLinux|unknown|-|https://www.biglinux.com.br/|Is the right choice if you want to have an easy and enriching experience with Linux. It has been perfected over more than 19 years, following our motto: 'In search of the perfect system'.";;
      blendos)          INFO="BlendOS|Arch|-|https://blendos.co/|A seamless blend of all Linux distributions. Allows you to have an immutable, atomic and declarative Arch Linux system, with application support from several Linux distributions & Android.";;
-      bodhi)            INFO="Bodhi|Debian,Ubuntu|-|https://www.bodhilinux.com/|Lightweight distribution featuring the fast & fully customizable Moksha Desktop.";;
+      bodhi)            INFO="Bodhi|Debian Ubuntu|-|https://www.bodhilinux.com/|Lightweight distribution featuring the fast & fully customizable Moksha Desktop.";;
      bunsenlabs)       INFO="BunsenLabs|Debian|-|https://www.bunsenlabs.org/|Light-weight and easily customizable Openbox desktop. The project is a community continuation of CrunchBang Linux.";;
      cachyos)          INFO="CachyOS|Arch|-|https://cachyos.org/|Designed to deliver lightning-fast speeds and stability, ensuring a smooth and enjoyable computing experience every time you use it.";;
-      centos-stream)    INFO="CentOS Stream|Fedora,RedHat|-|https://www.centos.org/centos-stream/|Continuously delivered distro that tracks just ahead of Red Hat Enterprise Linux (RHEL) development, positioned as a midstream between Fedora Linux and RHEL.";;
+      centos-stream)    INFO="CentOS Stream|Fedora RedHat|-|https://www.centos.org/centos-stream/|Continuously delivered distro that tracks just ahead of Red Hat Enterprise Linux (RHEL) development, positioned as a midstream between Fedora Linux and RHEL.";;
      chimeralinux)     INFO="Chimera Linux|Independent|anon:chimera root:chimera|https://chimera-linux.org/|Modern, general-purpose non-GNU Linux distribution.";;
      crunchbang++)     INFO="#!++|Debian|-|https://www.crunchbangplusplus.org/|The classic minimal crunchbang feel, now with debian 12 bookworm.";;
      debian)           INFO="Debian|Independent|-|https://www.debian.org/|Complete Free Operating System with perfect level of ease of use and stability.";;
@ -65,7 +65,7 @@ function os_info() {
      dragonflybsd)     INFO="DragonFlyBSD|FreeBSD|-|https://www.dragonflybsd.org/|Provides an opportunity for the BSD base to grow in an entirely different direction from the one taken in the FreeBSD, NetBSD, and OpenBSD series.";;
      easyos)           INFO="EasyOS|Independent|-|https://easyos.org/|Experimental distribution designed from scratch to support containers.";;
      edubuntu)         INFO="Edubuntu|Ubuntu|-|https://www.edubuntu.org/|Stable, secure and privacy concious option for schools.";;
-      elementary)       INFO="elementary OS|Debian,Ubuntu|-|https://elementary.io/|Thoughtful, capable, and ethical replacement for Windows and macOS.";;
+      elementary)       INFO="elementary OS|Debian Ubuntu|-|https://elementary.io/|Thoughtful, capable, and ethical replacement for Windows and macOS.";;
      endeavouros)      INFO="EndeavourOS|Arch|-|https://endeavouros.com/|Provides an Arch experience without the hassle of installing it manually for both x86_64 and ARM systems.";;
      endless)          INFO="Endless OS|Debian|-|https://www.endlessos.org/os|Completely Free, User-Friendly Operating System Packed with Educational Tools, Games, and More.";;
      fedora)           INFO="Fedora|Independent|-|https://www.fedoraproject.org/|Innovative platform for hardware, clouds, and containers, built with love by you.";;
@ -77,18 +77,18 @@ function os_info() {
      gnomeos)          INFO="GNOME OS|Independent|-|https://os.gnome.org/|Alpha nightly bleeding edge distro of GNOME";;
      guix)             INFO="Guix|Independent|-|https://guix.gnu.org/|Distribution of the GNU operating system developed by the GNU Project—which respects the freedom of computer users.";;
      haiku)            INFO="Haiku|Independent|-|https://www.haiku-os.org/|Specifically targets personal computing. Inspired by the BeOS, Haiku is fast, simple to use, easy to learn and yet very powerful.";;
-      holoiso)          INFO="SteamOS HoloISO|Arch,SteamOS|-|https://github.com/HoloISO/holoiso|Bring the Steam Decks SteamOS Holo redistribution and provide a close-to-official SteamOS experience.";;
+      holoiso)          INFO="SteamOS HoloISO|Arch SteamOS|-|https://github.com/HoloISO/holoiso|Bring the Steam Decks SteamOS Holo redistribution and provide a close-to-official SteamOS experience.";;
      kali)             INFO="Kali|Debian|-|https://www.kali.org/|The most advanced Penetration Testing Distribution.";;
-      kdeneon)          INFO="KDE Neon|Debian,Ubuntu|-|https://neon.kde.org/|Latest and greatest of KDE community software packaged on a rock-solid base.";;
+      kdeneon)          INFO="KDE Neon|Debian Ubuntu|-|https://neon.kde.org/|Latest and greatest of KDE community software packaged on a rock-solid base.";;
      kolibrios)        INFO="KolibriOS|Independent|-|http://kolibrios.org/en/|Tiny yet incredibly powerful and fast operating system.";;
      kubuntu)          INFO="Kubuntu|Ubuntu|-|https://kubuntu.org/|Free, complete, and open-source alternative to Microsoft Windows and Mac OS X which contains everything you need to work, play, or share.";;
-      linuxlite)        INFO="Linux Lite|Debian,Ubuntu|-|https://www.linuxliteos.com/|Your first simple, fast and free stop in the world of Linux.";;
-      linuxmint)        INFO="Linux Mint|Debian,Ubuntu|-|https://linuxmint.com/|Designed to work out of the box and comes fully equipped with the apps most people need.";;
+      linuxlite)        INFO="Linux Lite|Debian Ubuntu|-|https://www.linuxliteos.com/|Your first simple, fast and free stop in the world of Linux.";;
+      linuxmint)        INFO="Linux Mint|Debian Ubuntu|-|https://linuxmint.com/|Designed to work out of the box and comes fully equipped with the apps most people need.";;
      lmde)             INFO="Linux Mint Debian Edition|Debian|-|https://www.linuxmint.com/download_lmde.php|Aims to be as similar as possible to Linux Mint, but without using Ubuntu. The package base is provided by Debian instead.";;
      lubuntu)          INFO="Lubuntu|Ubuntu|-|https://lubuntu.me/|Complete Operating System that ships the essential apps and services for daily use: office applications, PDF reader,  image editor, music and video players, etc. Using lightwave lxde/lxqt.";;
      mageia)           INFO="Mageia|Independent|-|https://www.mageia.org/|Stable, secure operating system for desktop & server.";;
      manjaro)          INFO="Manjaro|Arch|-|https://manjaro.org/|Versatile, free, and open-source Linux operating system designed with a strong focus on safeguarding user privacy and offering extensive control over hardware.";;
-      mxlinux)          INFO="MX Linux|Debian,Antix|-|https://mxlinux.org/|Designed to combine elegant and efficient desktops with high stability and solid performance.";;
+      mxlinux)          INFO="MX Linux|Debian Antix|-|https://mxlinux.org/|Designed to combine elegant and efficient desktops with high stability and solid performance.";;
      netboot)          INFO="netboot.xyz|iPXE|-|https://netboot.xyz/|Your favorite operating systems in one place.";;
      netbsd)           INFO="NetBSD|Independent|-|https://www.netbsd.org/|Free, fast, secure, and highly portable Unix-like Open Source operating system. It is available for a wide range of platforms, from large-scale servers and powerful desktop systems to handheld and embedded devices.";;
      nitrux)           INFO="Nitrux|Debian|-|https://nxos.org/|Powered by Debian, KDE Plasma and Frameworks, and AppImages.";;
@ -96,11 +96,11 @@ function os_info() {
      nwg-shell)        INFO="nwg-shell|Arch|nwg:nwg|https://nwg-piotr.github.io/nwg-shell/|Arch Linux ISO with nwg-shell for sway and Hyprland";;
      macos)            INFO="macOS|proprietary|-|https://www.apple.com/macos/|Work and play on your Mac are even more powerful. Elevate your presence on video calls. Access information in all-new ways. Boost gaming performance. And discover even more ways to personalize your Mac.";;
      openbsd)          INFO="OpenBSD|Independent|-|https://www.openbsd.org/|FREE, multi-platform 4.4BSD-based UNIX-like operating system. Our efforts emphasize portability, standardization, correctness, proactive security and integrated cryptography.";;
-      openindiana)      INFO="OpenIndiana|Solaris,OpenSolaris|-|https://www.openindiana.org/|Community supported illumos-based operating system.";;
+      openindiana)      INFO="OpenIndiana|Solaris OpenSolaris|-|https://www.openindiana.org/|Community supported illumos-based operating system.";;
      opensuse)         INFO="openSUSE|Independent|-|https://www.opensuse.org/|The makers choice for sysadmins, developers and desktop users.";;
      oraclelinux)      INFO="Oracle Linux|RedHat|-|https://www.oracle.com/linux/|Linux with everything required to deploy, optimize, and manage applications on-premises, in the cloud, and at the edge.";;
      parrotsec)        INFO="Parrot Security|Debian|parrot:parrot|https://www.parrotsec.org/|Provides a huge arsenal of tools, utilities and libraries that IT and security professionals can use to test and assess the security of their assets in a reliable, compliant and reproducible way.";;
-      peppermint)       INFO="PeppermintOS|Debian,Devuan|-|https://peppermintos.com/|Provides a user with the opportunity to build the system that best fits their needs. While at the same time providing a functioning OS with minimum hassle out of the box.";;
+      peppermint)       INFO="PeppermintOS|Debian Devuan|-|https://peppermintos.com/|Provides a user with the opportunity to build the system that best fits their needs. While at the same time providing a functioning OS with minimum hassle out of the box.";;
      popos)            INFO="Pop!_OS|Ubuntu|-|https://pop.system76.com/|Operating system for STEM and creative professionals who use their computer as a tool to discover and create.";;
      porteus)          INFO="Porteus|Slackware|-|http://www.porteus.org/|Complete linux operating system that is optimized to run from CD, USB flash drive, hard drive, or other bootable storage media.";;
      primtux)          INFO="PrimTux|Ubuntu|-|https://primtux.fr/|A complete and customizable GNU/Linux operating system intended for primary school students and suitable even for older hardware.";;
@ -118,10 +118,10 @@ function os_info() {
      spirallinux)      INFO="SpiralLinux|Debian|-|https://spirallinux.github.io/|Selection of Linux spins built from Debian GNU/Linux, with a focus on simplicity and out-of-the-box usability across all the major desktop environments.";;
      tails)            INFO="Tails|Debian|-|https://tails.net/|Portable operating system that protects against surveillance and censorship.";;
      tinycore)         INFO="Tiny Core Linux|Independent|-|http://www.tinycorelinux.net/|Highly modular based system with community build extensions.";;
-      trisquel)         INFO="Trisquel|Debian,Ubuntu|-|https://trisquel.info/|Fully free operating system for home users, small enterprises and educational centers.";;
+      trisquel)         INFO="Trisquel|Debian Ubuntu|-|https://trisquel.info/|Fully free operating system for home users, small enterprises and educational centers.";;
      truenas-core)     INFO="TrueNAS Core|FreeBSD|-|https://www.truenas.com/truenas-core/|World’s most popular storage OS because it gives you the power to build your own professional-grade storage system to use in a variety of data-intensive applications without any software costs.";;
      truenas-scale)    INFO="TrueNAS Scale|Debian|-|https://www.truenas.com/truenas-scale/|Open Source Hyperconverged Infrastructure (HCI) solution. In addition to powerful scale-out storage capabilities, SCALE adds Linux Containers and VMs (KVM) so apps run closer to data.";;
-      tuxedo-os)        INFO="Tuxedo OS|Ubuntu|-|https://www.tuxedocomputers.com/en/|KDE Ubuntu LTS designed to go with their Linux hardware.";;
+      tuxedoos)         INFO="Tuxedo OS|Ubuntu|-|https://www.tuxedocomputers.com/en/|KDE Ubuntu LTS designed to go with their Linux hardware.";;
      ubuntu)           INFO="Ubuntu|Debian|-|https://ubuntu.com/|Complete desktop Linux operating system, freely available with both community and professional support.";;
      ubuntu-budgie)    INFO="Ubuntu Budgie|Ubuntu|-|https://ubuntubudgie.org/|Community developed distribution, integrating the Budgie Desktop Environment with Ubuntu at its core.";;
      ubuntucinnamon)   INFO="Ubuntu Cinnamon|Ubuntu|-|https://ubuntucinnamon.org/|Community-driven, featuring Linux Mint’s Cinnamon Desktop with Ubuntu at the core, packed fast and full of features, here is the most traditionally modern desktop you will ever love.";;
@ -130,7 +130,7 @@ function os_info() {
      ubuntu-server)    INFO="Ubuntu Server|Ubuntu|-|https://ubuntu.com/server|Brings economic and technical scalability to your datacentre, public or private. Whether you want to deploy an OpenStack cloud, a Kubernetes cluster or a 50,000-node render farm, Ubuntu Server delivers the best value scale-out performance available.";;
      ubuntustudio)     INFO="Ubuntu Studio|Ubuntu|-|https://ubuntustudio.org/|Comes preinstalled with a selection of the most common free multimedia applications available, and is configured for best performance for various purposes: Audio, Graphics, Video, Photography and Publishing.";;
      ubuntu-unity)     INFO="Ubuntu Unity|Ubuntu|-|https://ubuntuunity.org/|Flavor of Ubuntu featuring the Unity7 desktop environment (the default desktop environment used by Ubuntu from 2010-2017).";;
-      vanillaos)        INFO="Vanilla OS|Debian,Ubuntu|-|https://vanillaos.org/|Designed to be a reliable and productive operating system for your daily work.";;
+      vanillaos)        INFO="Vanilla OS|Debian Ubuntu|-|https://vanillaos.org/|Designed to be a reliable and productive operating system for your daily work.";;
      void)             INFO="Void Linux|Independent|anon:voidlinux|https://voidlinux.org/|General purpose operating system. Its package system allows you to quickly install, update and remove software; software is provided in binary packages or can be built directly from sources.";;
      vxlinux)          INFO="VX Linux|Void|-|https://vxlinux.org/|Pre-configured, secure systemd-free Plasma desktop with focus on convenience, performance and simplicity. Based on the excellent Void Linux.";;
      whonix)           INFO="Whonix|Debian|-|https://www.whonix.org/|Superior Internet Privacy with Whonix™ As handy as an app - delivering maximum anonymity and security.";;
@ -312,6 +312,7 @@ function csv_data() {
    local PNG
    local RELEASE
    local SVG
+    local INFO
    local HAS_ZSYNC=0

    # Check if zsync is available
@ -320,9 +321,11 @@ function csv_data() {
    fi

    for OS in $(os_support); do
+        local INFO=""
        local EDITIONS=""
        DISPLAY_NAME="$(pretty_name "${OS}")"
-
+        INFO=$(os_info "$OS")
+        IFS='|' read -r PRETTY_NAME BASED_ON CREDENTIALS HOMEPAGE INFO_TEXT <<< "$INFO"
        case ${OS} in
          *ubuntu-server*) FUNC="ubuntu-server";;
          *ubuntu*) FUNC="ubuntu";;
@ -346,15 +349,15 @@ function csv_data() {
            # If the OS has an editions_() function, use it.
            if [[ ${EDITIONS} ]]; then
                for OPTION in ${EDITIONS}; do
-                    echo "${DISPLAY_NAME},${OS},${RELEASE},${OPTION},${DOWNLOADER},${PNG},${SVG}"
+                    echo "${DISPLAY_NAME},${OS},${RELEASE},${OPTION},${DOWNLOADER},${PNG},${SVG},${BASED_ON},${CREDENTIALS},${HOMEPAGE},${INFO_TEXT}"
                done
            elif [[ "${OS}" == "windows"* ]]; then
                "languages_${OS}"
                for LANG in "${LANGS[@]}"; do
-                    echo "${DISPLAY_NAME},${OS},${RELEASE},${LANG},${DOWNLOADER},${PNG},${SVG}"
+                    echo "${DISPLAY_NAME},${OS},${RELEASE},${LANG},${DOWNLOADER},${PNG},${SVG},${BASED_ON},${CREDENTIALS},${HOMEPAGE},${INFO_TEXT}"
                done
            else
-                echo "${DISPLAY_NAME},${OS},${RELEASE},,${DOWNLOADER},${PNG},${SVG}"
+                echo "${DISPLAY_NAME},${OS},${RELEASE},,${DOWNLOADER},${PNG},${SVG},${BASED_ON},${CREDENTIALS},${HOMEPAGE},${INFO_TEXT}"
            fi
        done &
    done
@ -3429,10 +3432,11 @@ case "${1}" in
        for OS in $(os_support); do
            (test_all "${OS}")
        done
+        exit 0
    elif [ -z "${2}" ]; then
        test_all "${1}"
+        exit 0
    fi
-    exit 0
    ;;
  '--check'|'-c')
    OPERATION="test"
@ -3448,6 +3452,7 @@ case "${1}" in
    ;;
    #TODO: Argument without dashes should be DEPRECATED!
  '--list-csv'|'-lc'|'list'|'list_csv'|'lc')
+    echo "Pretty Name,OS,Release,Option,Downloader,PNG,SVG,Based on,Credentials,Homepage,Info"
    list_csv
    ;;
    #TODO: Argument without dashes should be DEPRECATED!
Author	SHA1	Message	Date
zenobit	681193ee6e	Merge `6cdd372a8d` into `9eb54db525`	2024-05-05 10:06:06 +01:00
Phil Clifford	9eb54db525	chore: align sub-project	2024-05-05 09:36:41 +01:00
Phil Clifford	67893f5cb1	README.md regenerated, with only pandoc markdown pedantry differences	2024-05-05 09:36:41 +01:00
Phil Clifford	19d09556c6	Regenerated docs to adopt changes from PR 1140 man pages so far retain much of the installation and usage detail. The README.md is now not really requiring regeneration as all the details are referenced in the wiki. It will be added in a seperate commit which can be ignored but serves to show the 'corrections' and style tweaks imposed by pandoc. These principally are line length and whitespace, with some markdown pedantry	2024-05-05 09:36:41 +01:00
Phil Clifford	4c47a2a3ab	docs: Consistent description for package.nix reflect changes made elsewhere	2024-05-05 09:32:10 +01:00
Liam	2acc2f4f40	Fix --url exiting when provided parameters. Closes #1160	2024-05-05 09:31:23 +01:00
zen0bit	6cdd372a8d	fix: + Add OS info to list_csv	2024-05-03 06:34:29 +02:00
zen0bit	2998c94d6a	Leave dashes from os_info (except short info)	2024-05-03 06:29:01 +02:00