From 2f9c60dc6ac9e5368b311ce7bd495deb1be8251d Mon Sep 17 00:00:00 2001 From: Phil Clifford Date: Mon, 22 Apr 2024 01:32:42 +0100 Subject: [PATCH] chore: Regenerated docs to reflect these fixes NB This also includes documentation changes linking to the wiki that identified these possible issues --- README.md | 113 +++++++++++++++++++++++----------------- build-docs | 2 +- docs/quickemu.1 | 100 +++++++++++++++++++++++++---------- docs/quickemu.1.md | 81 +++++++++++++++++++--------- docs/quickemu_conf.1 | 2 +- docs/quickemu_conf.1.md | 2 +- docs/quickget.1 | 78 ++++++++++++++++++++------- docs/quickget.1.md | 61 ++++++++++++++++------ 8 files changed, 300 insertions(+), 139 deletions(-) diff --git a/README.md b/README.md index 37af19b..2e9c63d 100644 --- a/README.md +++ b/README.md @@ -91,9 +91,9 @@ virtual machines. - EFI (with or without SecureBoot) and Legacy BIOS boot - Graphical user interfaces available -## Installation +## [Installation](https://github.com/quickemu-project/quickemu/wiki/01-Installation) -### Arch Linux hosts +### [Arch Linux hosts](https://github.com/quickemu-project/quickemu/wiki/01-Installation#arch-linux) Quickemu is available from the AUR (Arch user repository), and can be installed via any AUR helper. Assuming your AUR helper is yay, Run the @@ -103,18 +103,17 @@ following command: yay -Sy quickemu ``` -### Debian and derivatives +### [Debian and derivatives](https://github.com/quickemu-project/quickemu/wiki/01-Installation#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`. +A [.deb package](https://github.com/quickemu-project/quickemu/releases) +is available for Debian and derivatives in this project's GitHub +releases page. Download the .deb and install it with `apt-get`. ``` shell sudo apt-get install ./quickemu_x.y.z-1_all.deb ``` -### Ubuntu hosts +### [Ubuntu hosts](https://github.com/quickemu-project/quickemu/wiki/01-Installation#ubuntu) Quickemu is available from a PPA for Ubuntu users. The Quickemu PPA also includes a back port of QEMU 6.0.0 for 20.04 (Focal) and 21.04 @@ -127,7 +126,7 @@ sudo apt update sudo apt install quickemu ``` -### NixOS hosts +### [NixOS hosts](https://github.com/quickemu-project/quickemu/wiki/01-Installation#nixos-hosts) To quickly try quickemu: @@ -158,11 +157,13 @@ To install via Flakes: # TODO (flake users, please add an example!) ``` -### Other Linux hosts (installing from source) +### [Other Linux hosts (installing from source)](https://github.com/quickemu-project/quickemu/wiki/01-Installation#any-linux-installing-from-source) ``` shell git clone --filter=blob:none https://github.com/quickemu-project/quickemu cd quickemu +# optionally +sudo make install ``` When installing from source, you will need to install the following @@ -208,13 +209,13 @@ These examples may save a little typing: This also applies to derivatives: ``` shell -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 +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 ``` #### Install requirements on Fedora hosts ``` shell -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 +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 ``` #### Install requirements on macOS hosts @@ -224,10 +225,12 @@ This is a **work in progress** (see [issue steps and changes that may enable running on MacOS) ``` shell -brew install qemu bash coreutils grep jq python@3.10 cdrtools gnu-sed spice-gtk wget zsync +brew install qemu bash coreutils curl grep jq python@3.10 cdrtools gnu-sed spice-gtk wget zsync ``` -## GUI (quickgui) +## [Alternative Frontends](https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends) + +### Quickgui While `quickemu` and `quickget` are designed for the terminal, a graphical user interface is also available: @@ -248,12 +251,12 @@ Many thanks to [Luke Wesley-Holley](https://github.com/Lukewh) and [Philipp Kiemle](https://github.com/daPhipz) for creating the **[Quickemu icons](https://github.com/Lukewh/quickemu-icons)** 🎨 -## TUI (qqx) +### qqX -From Nov 2023, there is also a multi option desktop integrated text -interface, the **quickemu quickget X terminal project**, a.k.a. **qqX**, -with lots of unique tools and utilities to help you make light work of -installations, snapshots and disk management +There is also a multi option desktop integrated text interface, the +**quickemu quickget X terminal project**, or **qqX**, with lots of +unique tools and utilities to help you make light work of installations, +snapshots and disk management - **[qqX](https://github.com/TuxVinyards/qqX)** is independently curated by [Alex Genovese](https://github.com/TuxVinyards) (see the @@ -301,6 +304,10 @@ switch to a new series. All the official Ubuntu flavours are supported, just replace `ubuntu` with your preferred flavour. +The project +[wiki](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines) +may have further information. + - `edubuntu` (Edubuntu) - `kubuntu` (Kubuntu) - `lubuntu` (Lubuntu) @@ -314,21 +321,44 @@ with your preferred flavour. - `ubuntu-unity` (Ubuntu Unity) - `xubuntu` (Xubuntu) -You can also use `quickget` with options to: +You can also use `quickget` with advanced options : + +``` text + -[12345] : Show info* about OS + --download (-d) [ed] : Download the ISO only; no VM configuration + --create-config (-cc) [path/url]: Create default VM config for image + --open-homepage (-o) : Open homepage for the OS + --version (-v) : Show version + --help (-h) : Show this help message + --url (-u) [ed] : Show download URL for an OS release/edition + --check (-c) [re] [ed] : Check download an OS release/edition is available + --url-all (-ua) : Show all download URLs for an OS + --check-all (-ca) : 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 + --list-urls (-lu) : List all supported systems download URLs + --test-urls (-tu) : Check all downloads for all OSs are available +``` + +Here are some typical uses ``` shell # show an OS ISO download URL for {os} {release} [edition] - quickget --show-iso-url fedora 38 Silverblue + quickget --url fedora 38 Silverblue # test if an OS ISO is available for {os} {release} [edition] - quickget --test-iso-url nixos 23.05 plasma5 + quickget --check nixos unstable plasma5 # open an OS distribution homepage in a browser - quickget --open-distro-homepage ubuntu-mate + quickget --open-homepage ubuntu-mate # Only download image file into current directory, without creating VM - quickget --download-iso elementary 7.1 + quickget --download elementary 7.1 ``` -The `--show-iso-url`, `--test-iso-url`, and `--download-iso` options are -fully functional for all operating systems, including Windows and macOS. +The `--url`, `--check`, and `--download` options are fully functional +for all operating systems, including Windows and macOS. + +Further information is available from the project +[wiki](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features) ### Other Operating Systems @@ -342,17 +372,17 @@ fully functional for all operating systems, including Windows and macOS. - `archlinux` (Arch Linux) - `arcolinux` (Arco Linux) - `artixlinux` (Artix Linux) -- `athenaos` (Athenaos) +- `athenaos` (Athena OS) - `batocera` (Batocera) - `bazzite` (Bazzite) - `biglinux` (BigLinux) - `blendos` (BlendOS) - `bodhi` (Bodhi) -- `bunsenlabs` (Bunsenlabs) +- `bunsenlabs` (BunsenLabs) - `cachyos` (CachyOS) - `centos-stream` (CentOS Stream) - `chimeralinux` (Chimera Linux) -- `crunchbang++` (Crunchbang++) +- `crunchbang++` (#!++) - `debian` (Debian) - `deepin` (Deepin) - `devuan` (Devuan) @@ -392,7 +422,7 @@ fully functional for all operating systems, including Windows and macOS. - `peppermint` (PeppermintOS) - `popos` (Pop!\_OS) - `porteus` (Porteus) -- `primtux` (Primtux) +- `primtux` (PrimTux) - `pureos` (PureOS) - `reactos` (ReactOS) - `rebornos` (RebornOS) @@ -401,10 +431,10 @@ fully functional for all operating systems, including Windows and macOS. - `slackware` (Slackware) - `slax` (Slax) - `slint` (Slint) -- `slitaz` (SliTaz GNU/Linux) +- `slitaz` (SliTaz) - `solus` (Solus) - `sparkylinux` (SparkyLinux) -- `spirallinux` (Spirallinux) +- `spirallinux` (SpiralLinux) - `tails` (Tails) - `tinycore` (Tiny Core Linux) - `trisquel` (Trisquel) @@ -416,7 +446,7 @@ fully functional for all operating systems, including Windows and macOS. - `vxlinux` (VX Linux) - `zorin` (Zorin OS) -### Custom Linux guests +### [Custom Linux guests](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests) Or you can download a Linux image and manually create a VM configuration. @@ -443,7 +473,7 @@ quickemu --vm debian-bullseye.conf - Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to enable file sharing. -## Creating macOS Guests 🍏 +## [Creating macOS Guests](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests) 🍏 `quickget` automatically downloads a macOS recovery image and creates a virtual machine configuration. @@ -597,7 +627,7 @@ sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist Now reboot, and the App Store should work. -## Creating Windows guests 🪟 +## [Creating Windows guests](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines) 🪟 `quickget` can download [**Windows 10**](https://www.microsoft.com/software-download/windows10) and @@ -911,17 +941,6 @@ machines. Here are the usage instructions: - - - ``` text Usage @@ -963,9 +982,7 @@ List of optional parameters: --sound-card : Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370', 'sb16', 'none' --extra_args : Pass additional arguments to qemu --version : Print version - ``` - ## Desktop shortcuts diff --git a/build-docs b/build-docs index 473517e..ddfea9d 160000 --- a/build-docs +++ b/build-docs @@ -1 +1 @@ -Subproject commit 473517e75e9a71dc3126a95e579d97b631960e3c +Subproject commit ddfea9dc4c9b40e3136c7462eba9bbf45e84e88b diff --git a/docs/quickemu.1 b/docs/quickemu.1 index 2b11714..b57059e 100644 --- a/docs/quickemu.1 +++ b/docs/quickemu.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 3.1.13 .\" -.TH "QUICKEMU" "1" "April 21, 2024" "quickemu" "Quickemu User Manual" +.TH "QUICKEMU" "1" "April 22, 2024" "quickemu" "Quickemu User Manual" .SH NAME quickemu \- A quick VM builder and manager .SH SYNOPSIS @@ -353,12 +353,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 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 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 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 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 @@ -368,9 +368,13 @@ issue 248 \ for other steps and changes that may enable running on MacOS) .IP .EX -brew install qemu bash coreutils 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 wget zsync .EE -.SS GUI (quickgui) +.SS \c +.UR https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends +Alternative Frontends +.UE \c +.SS Quickgui While \f[CR]quickemu\f[R] and \f[CR]quickget\f[R] are designed for the terminal, a graphical user interface is also available: .IP \[bu] 2 @@ -409,11 +413,11 @@ Philipp Kiemle Quickemu icons .UE \c \f[R] 🎨 -.SS TUI (qqx) -From Nov 2023, there is also a multi option desktop integrated text -interface, the \f[B]quickemu quickget X terminal project\f[R], a.k.a. -\f[B]qqX\f[R], with lots of unique tools and utilities to help you make -light work of installations, snapshots and disk management +.SS qqX +There is also a multi option desktop integrated text interface, the +\f[B]quickemu quickget X terminal project\f[R], or \f[B]qqX\f[R], with +lots of unique tools and utilities to help you make light work of +installations, snapshots and disk management .IP \[bu] 2 \f[B]\c .UR https://github.com/TuxVinyards/qqX @@ -474,6 +478,12 @@ switch to a new series. .SS Ubuntu Flavours All the official Ubuntu flavours are supported, just replace \f[CR]ubuntu\f[R] with your preferred flavour. +.PP +The project \c +.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines +wiki +.UE \c +\ may have further information. .IP \[bu] 2 \f[CR]edubuntu\f[R] (Edubuntu) .IP \[bu] 2 @@ -499,22 +509,47 @@ All the official Ubuntu flavours are supported, just replace .IP \[bu] 2 \f[CR]xubuntu\f[R] (Xubuntu) .PP -You can also use \f[CR]quickget\f[R] with options to: +You can also use \f[CR]quickget\f[R] with advanced options : +.IP +.EX + \-[12345] : Show info* about OS + \-\-download (\-d) [ed] : Download the ISO only; no VM configuration + \-\-create\-config (\-cc) [path/url]: Create default VM config for image + \-\-open\-homepage (\-o) : Open homepage for the OS + \-\-version (\-v) : Show version + \-\-help (\-h) : Show this help message + \-\-url (\-u) [ed] : Show download URL for an OS release/edition + \-\-check (\-c) [re] [ed] : Check download an OS release/edition is available + \-\-url\-all (\-ua) : Show all download URLs for an OS + \-\-check\-all (\-ca) : 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 + \-\-list\-urls (\-lu) : List all supported systems download URLs + \-\-test\-urls (\-tu) : Check all downloads for all OSs are available +.EE +.PP +Here are some typical uses .IP .EX # show an OS ISO download URL for {os} {release} [edition] - quickget \-\-show\-iso\-url fedora 38 Silverblue + quickget \-\-url fedora 38 Silverblue # test if an OS ISO is available for {os} {release} [edition] - quickget \-\-test\-iso\-url nixos 23.05 plasma5 + quickget \-\-check nixos unstable plasma5 # open an OS distribution homepage in a browser - quickget \-\-open\-distro\-homepage ubuntu\-mate + quickget \-\-open\-homepage ubuntu\-mate # Only download image file into current directory, without creating VM - quickget \-\-download\-iso elementary 7.1 + quickget \-\-download elementary 7.1 .EE .PP -The \f[CR]\-\-show\-iso\-url\f[R], \f[CR]\-\-test\-iso\-url\f[R], and -\f[CR]\-\-download\-iso\f[R] options are fully functional for all -operating systems, including Windows and macOS. +The \f[CR]\-\-url\f[R], \f[CR]\-\-check\f[R], and +\f[CR]\-\-download\f[R] options are fully functional for all operating +systems, including Windows and macOS. +.PP +Further information is available from the project \c +.UR https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features +wiki +.UE \c .SS Other Operating Systems \f[CR]quickget\f[R] also supports: .IP \[bu] 2 @@ -534,7 +569,7 @@ operating systems, including Windows and macOS. .IP \[bu] 2 \f[CR]artixlinux\f[R] (Artix Linux) .IP \[bu] 2 -\f[CR]athenaos\f[R] (Athenaos) +\f[CR]athenaos\f[R] (Athena OS) .IP \[bu] 2 \f[CR]batocera\f[R] (Batocera) .IP \[bu] 2 @@ -546,7 +581,7 @@ operating systems, including Windows and macOS. .IP \[bu] 2 \f[CR]bodhi\f[R] (Bodhi) .IP \[bu] 2 -\f[CR]bunsenlabs\f[R] (Bunsenlabs) +\f[CR]bunsenlabs\f[R] (BunsenLabs) .IP \[bu] 2 \f[CR]cachyos\f[R] (CachyOS) .IP \[bu] 2 @@ -554,7 +589,7 @@ operating systems, including Windows and macOS. .IP \[bu] 2 \f[CR]chimeralinux\f[R] (Chimera Linux) .IP \[bu] 2 -\f[CR]crunchbang++\f[R] (Crunchbang++) +\f[CR]crunchbang++\f[R] (#!++) .IP \[bu] 2 \f[CR]debian\f[R] (Debian) .IP \[bu] 2 @@ -634,7 +669,7 @@ operating systems, including Windows and macOS. .IP \[bu] 2 \f[CR]porteus\f[R] (Porteus) .IP \[bu] 2 -\f[CR]primtux\f[R] (Primtux) +\f[CR]primtux\f[R] (PrimTux) .IP \[bu] 2 \f[CR]pureos\f[R] (PureOS) .IP \[bu] 2 @@ -652,13 +687,13 @@ operating systems, including Windows and macOS. .IP \[bu] 2 \f[CR]slint\f[R] (Slint) .IP \[bu] 2 -\f[CR]slitaz\f[R] (SliTaz GNU/Linux) +\f[CR]slitaz\f[R] (SliTaz) .IP \[bu] 2 \f[CR]solus\f[R] (Solus) .IP \[bu] 2 \f[CR]sparkylinux\f[R] (SparkyLinux) .IP \[bu] 2 -\f[CR]spirallinux\f[R] (Spirallinux) +\f[CR]spirallinux\f[R] (SpiralLinux) .IP \[bu] 2 \f[CR]tails\f[R] (Tails) .IP \[bu] 2 @@ -679,7 +714,10 @@ operating systems, including Windows and macOS. \f[CR]vxlinux\f[R] (VX Linux) .IP \[bu] 2 \f[CR]zorin\f[R] (Zorin OS) -.SS Custom Linux guests +.SS \c +.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests +Custom Linux guests +.UE \c Or you can download a Linux image and manually create a VM configuration. .IP \[bu] 2 @@ -711,7 +749,11 @@ enable copy/paste and USB redirection. Install the SPICE WebDAV agent (\f[CR]spice\-webdavd\f[R]) in the guest to enable file sharing. .RE -.SS Creating macOS Guests 🍏 +.SS \c +.UR https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests +Creating macOS Guests +.UE \c +\ 🍏 \f[CR]quickget\f[R] automatically downloads a macOS recovery image and creates a virtual machine configuration. .IP @@ -945,7 +987,11 @@ sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist .EE .PP Now reboot, and the App Store should work. -.SS Creating Windows guests 🪟 +.SS \c +.UR https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines +Creating Windows guests +.UE \c +\ 🪟 \f[CR]quickget\f[R] can download \c .UR https://www.microsoft.com/software-download/windows10 \f[B]Windows 10\f[R] diff --git a/docs/quickemu.1.md b/docs/quickemu.1.md index 5d36db1..ccf7a56 100644 --- a/docs/quickemu.1.md +++ b/docs/quickemu.1.md @@ -1,6 +1,6 @@ --- author: Martin Wimpress -date: April 21, 2024 +date: April 22, 2024 footer: quickemu header: Quickemu User Manual section: 1 @@ -231,13 +231,13 @@ These examples may save a little typing: This also applies to derivatives: ``` shell -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 +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 ``` #### Install requirements on Fedora hosts ``` shell -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 +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 ``` #### Install requirements on macOS hosts @@ -247,10 +247,12 @@ This is a **work in progress** (see [issue steps and changes that may enable running on MacOS) ``` shell -brew install qemu bash coreutils grep jq python@3.10 cdrtools gnu-sed spice-gtk wget zsync +brew install qemu bash coreutils curl grep jq python@3.10 cdrtools gnu-sed spice-gtk wget zsync ``` -## GUI (quickgui) +## [Alternative Frontends](https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends) + +### Quickgui While `quickemu` and `quickget` are designed for the terminal, a graphical user interface is also available: @@ -271,12 +273,12 @@ Many thanks to [Luke Wesley-Holley](https://github.com/Lukewh) and [Philipp Kiemle](https://github.com/daPhipz) for creating the **[Quickemu icons](https://github.com/Lukewh/quickemu-icons)** 🎨 -## TUI (qqx) +### qqX -From Nov 2023, there is also a multi option desktop integrated text -interface, the **quickemu quickget X terminal project**, a.k.a. **qqX**, -with lots of unique tools and utilities to help you make light work of -installations, snapshots and disk management +There is also a multi option desktop integrated text interface, the +**quickemu quickget X terminal project**, or **qqX**, with lots of +unique tools and utilities to help you make light work of installations, +snapshots and disk management - **[qqX](https://github.com/TuxVinyards/qqX)** is independently curated by [Alex Genovese](https://github.com/TuxVinyards) (see the @@ -324,6 +326,10 @@ switch to a new series. All the official Ubuntu flavours are supported, just replace `ubuntu` with your preferred flavour. +The project +[wiki](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines) +may have further information. + - `edubuntu` (Edubuntu) - `kubuntu` (Kubuntu) - `lubuntu` (Lubuntu) @@ -337,21 +343,44 @@ with your preferred flavour. - `ubuntu-unity` (Ubuntu Unity) - `xubuntu` (Xubuntu) -You can also use `quickget` with options to: +You can also use `quickget` with advanced options : + +``` text + -[12345] : Show info* about OS + --download (-d) [ed] : Download the ISO only; no VM configuration + --create-config (-cc) [path/url]: Create default VM config for image + --open-homepage (-o) : Open homepage for the OS + --version (-v) : Show version + --help (-h) : Show this help message + --url (-u) [ed] : Show download URL for an OS release/edition + --check (-c) [re] [ed] : Check download an OS release/edition is available + --url-all (-ua) : Show all download URLs for an OS + --check-all (-ca) : 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 + --list-urls (-lu) : List all supported systems download URLs + --test-urls (-tu) : Check all downloads for all OSs are available +``` + +Here are some typical uses ``` shell # show an OS ISO download URL for {os} {release} [edition] - quickget --show-iso-url fedora 38 Silverblue + quickget --url fedora 38 Silverblue # test if an OS ISO is available for {os} {release} [edition] - quickget --test-iso-url nixos 23.05 plasma5 + quickget --check nixos unstable plasma5 # open an OS distribution homepage in a browser - quickget --open-distro-homepage ubuntu-mate + quickget --open-homepage ubuntu-mate # Only download image file into current directory, without creating VM - quickget --download-iso elementary 7.1 + quickget --download elementary 7.1 ``` -The `--show-iso-url`, `--test-iso-url`, and `--download-iso` options are -fully functional for all operating systems, including Windows and macOS. +The `--url`, `--check`, and `--download` options are fully functional +for all operating systems, including Windows and macOS. + +Further information is available from the project +[wiki](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features) ### Other Operating Systems @@ -365,17 +394,17 @@ fully functional for all operating systems, including Windows and macOS. - `archlinux` (Arch Linux) - `arcolinux` (Arco Linux) - `artixlinux` (Artix Linux) -- `athenaos` (Athenaos) +- `athenaos` (Athena OS) - `batocera` (Batocera) - `bazzite` (Bazzite) - `biglinux` (BigLinux) - `blendos` (BlendOS) - `bodhi` (Bodhi) -- `bunsenlabs` (Bunsenlabs) +- `bunsenlabs` (BunsenLabs) - `cachyos` (CachyOS) - `centos-stream` (CentOS Stream) - `chimeralinux` (Chimera Linux) -- `crunchbang++` (Crunchbang++) +- `crunchbang++` (#!++) - `debian` (Debian) - `deepin` (Deepin) - `devuan` (Devuan) @@ -415,7 +444,7 @@ fully functional for all operating systems, including Windows and macOS. - `peppermint` (PeppermintOS) - `popos` (Pop!\_OS) - `porteus` (Porteus) -- `primtux` (Primtux) +- `primtux` (PrimTux) - `pureos` (PureOS) - `reactos` (ReactOS) - `rebornos` (RebornOS) @@ -424,10 +453,10 @@ fully functional for all operating systems, including Windows and macOS. - `slackware` (Slackware) - `slax` (Slax) - `slint` (Slint) -- `slitaz` (SliTaz GNU/Linux) +- `slitaz` (SliTaz) - `solus` (Solus) - `sparkylinux` (SparkyLinux) -- `spirallinux` (Spirallinux) +- `spirallinux` (SpiralLinux) - `tails` (Tails) - `tinycore` (Tiny Core Linux) - `trisquel` (Trisquel) @@ -439,7 +468,7 @@ fully functional for all operating systems, including Windows and macOS. - `vxlinux` (VX Linux) - `zorin` (Zorin OS) -### Custom Linux guests +### [Custom Linux guests](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests) Or you can download a Linux image and manually create a VM configuration. @@ -466,7 +495,7 @@ quickemu --vm debian-bullseye.conf - Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to enable file sharing. -## Creating macOS Guests 🍏 +## [Creating macOS Guests](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests) 🍏 `quickget` automatically downloads a macOS recovery image and creates a virtual machine configuration. @@ -620,7 +649,7 @@ sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist Now reboot, and the App Store should work. -## Creating Windows guests 🪟 +## [Creating Windows guests](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines) 🪟 `quickget` can download [**Windows 10**](https://www.microsoft.com/software-download/windows10) and diff --git a/docs/quickemu_conf.1 b/docs/quickemu_conf.1 index db799f3..f0b304b 100644 --- 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 21, 2024" "quickemu_conf" "Quickemu Configuration Manual" +.TH "QUICKEMU_CONF" "1" "April 22, 2024" "quickemu_conf" "Quickemu Configuration Manual" .SH NAME quickemu_conf \- Options and parameters in the quickemu .conf .SH DESCRIPTION diff --git a/docs/quickemu_conf.1.md b/docs/quickemu_conf.1.md index 3334f9c..cfb19f5 100644 --- a/docs/quickemu_conf.1.md +++ b/docs/quickemu_conf.1.md @@ -1,6 +1,6 @@ --- author: Martin Wimpress -date: April 21, 2024 +date: April 22, 2024 footer: quickemu_conf header: Quickemu Configuration Manual section: 1 diff --git a/docs/quickget.1 b/docs/quickget.1 index a0dc705..74dc65b 100644 --- a/docs/quickget.1 +++ b/docs/quickget.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 3.1.13 .\" -.TH "QUICKGET" "1" "April 21, 2024" "quickget" "Quickget User Manual" +.TH "QUICKGET" "1" "April 22, 2024" "quickget" "Quickget User Manual" .SH NAME quickget \- download and prepare materials for building a quickemu VM .SH SYNOPSIS @@ -76,6 +76,12 @@ switch to a new series. .SS Ubuntu Flavours All the official Ubuntu flavours are supported, just replace \f[CR]ubuntu\f[R] with your preferred flavour. +.PP +The project \c +.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines +wiki +.UE \c +\ may have further information. .IP \[bu] 2 \f[CR]edubuntu\f[R] (Edubuntu) .IP \[bu] 2 @@ -101,22 +107,47 @@ All the official Ubuntu flavours are supported, just replace .IP \[bu] 2 \f[CR]xubuntu\f[R] (Xubuntu) .PP -You can also use \f[CR]quickget\f[R] with options to: +You can also use \f[CR]quickget\f[R] with advanced options : +.IP +.EX + \-[12345] : Show info* about OS + \-\-download (\-d) [ed] : Download the ISO only; no VM configuration + \-\-create\-config (\-cc) [path/url]: Create default VM config for image + \-\-open\-homepage (\-o) : Open homepage for the OS + \-\-version (\-v) : Show version + \-\-help (\-h) : Show this help message + \-\-url (\-u) [ed] : Show download URL for an OS release/edition + \-\-check (\-c) [re] [ed] : Check download an OS release/edition is available + \-\-url\-all (\-ua) : Show all download URLs for an OS + \-\-check\-all (\-ca) : 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 + \-\-list\-urls (\-lu) : List all supported systems download URLs + \-\-test\-urls (\-tu) : Check all downloads for all OSs are available +.EE +.PP +Here are some typical uses .IP .EX # show an OS ISO download URL for {os} {release} [edition] - quickget \-\-show\-iso\-url fedora 38 Silverblue + quickget \-\-url fedora 38 Silverblue # test if an OS ISO is available for {os} {release} [edition] - quickget \-\-test\-iso\-url nixos 23.05 plasma5 + quickget \-\-check nixos unstable plasma5 # open an OS distribution homepage in a browser - quickget \-\-open\-distro\-homepage ubuntu\-mate + quickget \-\-open\-homepage ubuntu\-mate # Only download image file into current directory, without creating VM - quickget \-\-download\-iso elementary 7.1 + quickget \-\-download elementary 7.1 .EE .PP -The \f[CR]\-\-show\-iso\-url\f[R], \f[CR]\-\-test\-iso\-url\f[R], and -\f[CR]\-\-download\-iso\f[R] options are fully functional for all -operating systems, including Windows and macOS. +The \f[CR]\-\-url\f[R], \f[CR]\-\-check\f[R], and +\f[CR]\-\-download\f[R] options are fully functional for all operating +systems, including Windows and macOS. +.PP +Further information is available from the project \c +.UR https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features +wiki +.UE \c .SS Other Operating Systems \f[CR]quickget\f[R] also supports: .IP \[bu] 2 @@ -136,7 +167,7 @@ operating systems, including Windows and macOS. .IP \[bu] 2 \f[CR]artixlinux\f[R] (Artix Linux) .IP \[bu] 2 -\f[CR]athenaos\f[R] (Athenaos) +\f[CR]athenaos\f[R] (Athena OS) .IP \[bu] 2 \f[CR]batocera\f[R] (Batocera) .IP \[bu] 2 @@ -148,7 +179,7 @@ operating systems, including Windows and macOS. .IP \[bu] 2 \f[CR]bodhi\f[R] (Bodhi) .IP \[bu] 2 -\f[CR]bunsenlabs\f[R] (Bunsenlabs) +\f[CR]bunsenlabs\f[R] (BunsenLabs) .IP \[bu] 2 \f[CR]cachyos\f[R] (CachyOS) .IP \[bu] 2 @@ -156,7 +187,7 @@ operating systems, including Windows and macOS. .IP \[bu] 2 \f[CR]chimeralinux\f[R] (Chimera Linux) .IP \[bu] 2 -\f[CR]crunchbang++\f[R] (Crunchbang++) +\f[CR]crunchbang++\f[R] (#!++) .IP \[bu] 2 \f[CR]debian\f[R] (Debian) .IP \[bu] 2 @@ -236,7 +267,7 @@ operating systems, including Windows and macOS. .IP \[bu] 2 \f[CR]porteus\f[R] (Porteus) .IP \[bu] 2 -\f[CR]primtux\f[R] (Primtux) +\f[CR]primtux\f[R] (PrimTux) .IP \[bu] 2 \f[CR]pureos\f[R] (PureOS) .IP \[bu] 2 @@ -254,13 +285,13 @@ operating systems, including Windows and macOS. .IP \[bu] 2 \f[CR]slint\f[R] (Slint) .IP \[bu] 2 -\f[CR]slitaz\f[R] (SliTaz GNU/Linux) +\f[CR]slitaz\f[R] (SliTaz) .IP \[bu] 2 \f[CR]solus\f[R] (Solus) .IP \[bu] 2 \f[CR]sparkylinux\f[R] (SparkyLinux) .IP \[bu] 2 -\f[CR]spirallinux\f[R] (Spirallinux) +\f[CR]spirallinux\f[R] (SpiralLinux) .IP \[bu] 2 \f[CR]tails\f[R] (Tails) .IP \[bu] 2 @@ -281,7 +312,10 @@ operating systems, including Windows and macOS. \f[CR]vxlinux\f[R] (VX Linux) .IP \[bu] 2 \f[CR]zorin\f[R] (Zorin OS) -.SS Custom Linux guests +.SS \c +.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests +Custom Linux guests +.UE \c Or you can download a Linux image and manually create a VM configuration. .IP \[bu] 2 @@ -313,7 +347,11 @@ enable copy/paste and USB redirection. Install the SPICE WebDAV agent (\f[CR]spice\-webdavd\f[R]) in the guest to enable file sharing. .RE -.SS Creating macOS Guests 🍏 +.SS \c +.UR https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests +Creating macOS Guests +.UE \c +\ 🍏 \f[CR]quickget\f[R] automatically downloads a macOS recovery image and creates a virtual machine configuration. .IP @@ -547,7 +585,11 @@ sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist .EE .PP Now reboot, and the App Store should work. -.SS Creating Windows guests 🪟 +.SS \c +.UR https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines +Creating Windows guests +.UE \c +\ 🪟 \f[CR]quickget\f[R] can download \c .UR https://www.microsoft.com/software-download/windows10 \f[B]Windows 10\f[R] diff --git a/docs/quickget.1.md b/docs/quickget.1.md index 4848c10..0d8abd5 100644 --- a/docs/quickget.1.md +++ b/docs/quickget.1.md @@ -1,6 +1,6 @@ --- author: Martin Wimpress -date: April 21, 2024 +date: April 22, 2024 footer: quickget header: Quickget User Manual section: 1 @@ -86,6 +86,10 @@ switch to a new series. All the official Ubuntu flavours are supported, just replace `ubuntu` with your preferred flavour. +The project +[wiki](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines) +may have further information. + - `edubuntu` (Edubuntu) - `kubuntu` (Kubuntu) - `lubuntu` (Lubuntu) @@ -99,21 +103,44 @@ with your preferred flavour. - `ubuntu-unity` (Ubuntu Unity) - `xubuntu` (Xubuntu) -You can also use `quickget` with options to: +You can also use `quickget` with advanced options : + +``` text + -[12345] : Show info* about OS + --download (-d) [ed] : Download the ISO only; no VM configuration + --create-config (-cc) [path/url]: Create default VM config for image + --open-homepage (-o) : Open homepage for the OS + --version (-v) : Show version + --help (-h) : Show this help message + --url (-u) [ed] : Show download URL for an OS release/edition + --check (-c) [re] [ed] : Check download an OS release/edition is available + --url-all (-ua) : Show all download URLs for an OS + --check-all (-ca) : 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 + --list-urls (-lu) : List all supported systems download URLs + --test-urls (-tu) : Check all downloads for all OSs are available +``` + +Here are some typical uses ``` shell # show an OS ISO download URL for {os} {release} [edition] - quickget --show-iso-url fedora 38 Silverblue + quickget --url fedora 38 Silverblue # test if an OS ISO is available for {os} {release} [edition] - quickget --test-iso-url nixos 23.05 plasma5 + quickget --check nixos unstable plasma5 # open an OS distribution homepage in a browser - quickget --open-distro-homepage ubuntu-mate + quickget --open-homepage ubuntu-mate # Only download image file into current directory, without creating VM - quickget --download-iso elementary 7.1 + quickget --download elementary 7.1 ``` -The `--show-iso-url`, `--test-iso-url`, and `--download-iso` options are -fully functional for all operating systems, including Windows and macOS. +The `--url`, `--check`, and `--download` options are fully functional +for all operating systems, including Windows and macOS. + +Further information is available from the project +[wiki](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features) ### Other Operating Systems @@ -127,17 +154,17 @@ fully functional for all operating systems, including Windows and macOS. - `archlinux` (Arch Linux) - `arcolinux` (Arco Linux) - `artixlinux` (Artix Linux) -- `athenaos` (Athenaos) +- `athenaos` (Athena OS) - `batocera` (Batocera) - `bazzite` (Bazzite) - `biglinux` (BigLinux) - `blendos` (BlendOS) - `bodhi` (Bodhi) -- `bunsenlabs` (Bunsenlabs) +- `bunsenlabs` (BunsenLabs) - `cachyos` (CachyOS) - `centos-stream` (CentOS Stream) - `chimeralinux` (Chimera Linux) -- `crunchbang++` (Crunchbang++) +- `crunchbang++` (#!++) - `debian` (Debian) - `deepin` (Deepin) - `devuan` (Devuan) @@ -177,7 +204,7 @@ fully functional for all operating systems, including Windows and macOS. - `peppermint` (PeppermintOS) - `popos` (Pop!\_OS) - `porteus` (Porteus) -- `primtux` (Primtux) +- `primtux` (PrimTux) - `pureos` (PureOS) - `reactos` (ReactOS) - `rebornos` (RebornOS) @@ -186,10 +213,10 @@ fully functional for all operating systems, including Windows and macOS. - `slackware` (Slackware) - `slax` (Slax) - `slint` (Slint) -- `slitaz` (SliTaz GNU/Linux) +- `slitaz` (SliTaz) - `solus` (Solus) - `sparkylinux` (SparkyLinux) -- `spirallinux` (Spirallinux) +- `spirallinux` (SpiralLinux) - `tails` (Tails) - `tinycore` (Tiny Core Linux) - `trisquel` (Trisquel) @@ -201,7 +228,7 @@ fully functional for all operating systems, including Windows and macOS. - `vxlinux` (VX Linux) - `zorin` (Zorin OS) -### Custom Linux guests +### [Custom Linux guests](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests) Or you can download a Linux image and manually create a VM configuration. @@ -228,7 +255,7 @@ quickemu --vm debian-bullseye.conf - Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to enable file sharing. -## Creating macOS Guests 🍏 +## [Creating macOS Guests](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests) 🍏 `quickget` automatically downloads a macOS recovery image and creates a virtual machine configuration. @@ -382,7 +409,7 @@ sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist Now reboot, and the App Store should work. -## Creating Windows guests 🪟 +## [Creating Windows guests](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines) 🪟 `quickget` can download [**Windows 10**](https://www.microsoft.com/software-download/windows10) and