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

docs: Incorporate changes from PR 1063 

Man pages aligned. Also picked up arrival of HoloIso
This commit is contained in:
Phil Clifford 2024-04-19 13:24:00 +01:00 committed by Martin Wimpress
parent a8be31056e
commit f5c805c25c
8 changed files with 25 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -370,6 +370,7 @@ fully functional for all operating systems, including Windows and macOS.
- `gnomeos` (GNOME OS)
- `guix` (Guix)
- `haiku` (Haiku)
- `holoiso` (SteamOS HoloISO)
- `kali` (Kali)
- `kdeneon` (KDE Neon)
- `kolibrios` (KolibriOS)

2
build-docs

@ -1 +1 @@
Subproject commit 8b09498e47749ccdd3de397deb71bea95c95ca8b
Subproject commit 948964b57daa874144f4eb413c1c9f649e748f88

13
docs/quickemu.1
View File

@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 3.1.13
.\"
.TH "QUICKEMU" "1" "April 17, 2024" "quickemu" "Quickemu User Manual"
.TH "QUICKEMU" "1" "April 19, 2024" "quickemu" "Quickemu User Manual"
.SH NAME
quickemu \- A quick VM builder and manager
.SH SYNOPSIS
@ -233,6 +233,11 @@ Coreutils
.UE \c
.IP \[bu] 2
\c
.UR https://curl.se/
curl
.UE \c
.IP \[bu] 2
\c
.UR https://github.com/tianocore/edk2
EDK II
.UE \c
@ -497,8 +502,8 @@ All the official Ubuntu flavours are supported, just replace
You can also use \f[CR]quickget\f[R] with options to:
.IP
.EX
# show an OS ISO download URL for {os} {release} [edition]
quickget \-\-show\-iso\-url fedora 38 Silverblue
# show an OS ISO download URL for {os} {release} [edition]
quickget \-\-show\-iso\-url fedora 38 Silverblue
# test if an OS ISO is available for {os} {release} [edition]
quickget \-\-test\-iso\-url nixos 23.05 plasma5
# open an OS distribution homepage in a browser
@ -585,6 +590,8 @@ operating systems, including Windows and macOS.
.IP \[bu] 2
\f[CR]haiku\f[R] (Haiku)
.IP \[bu] 2
\f[CR]holoiso\f[R] (SteamOS HoloISO)
.IP \[bu] 2
\f[CR]kali\f[R] (Kali)
.IP \[bu] 2
\f[CR]kdeneon\f[R] (KDE Neon)

3
docs/quickemu.1.md
View File

@ -1,6 +1,6 @@
---
author: Martin Wimpress
date: April 17, 2024
date: April 19, 2024
footer: quickemu
header: Quickemu User Manual
section: 1
@ -393,6 +393,7 @@ fully functional for all operating systems, including Windows and macOS.
- `gnomeos` (GNOME OS)
- `guix` (Guix)
- `haiku` (Haiku)
- `holoiso` (SteamOS HoloISO)
- `kali` (Kali)
- `kdeneon` (KDE Neon)
- `kolibrios` (KolibriOS)

2
docs/quickemu_conf.1
View File

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

2
docs/quickemu_conf.1.md
View File

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

8
docs/quickget.1
View File

@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 3.1.13
.\"
.TH "QUICKGET" "1" "April 17, 2024" "quickget" "Quickget User Manual"
.TH "QUICKGET" "1" "April 19, 2024" "quickget" "Quickget User Manual"
.SH NAME
quickget \- download and prepare materials for building a quickemu VM
.SH SYNOPSIS
@ -104,8 +104,8 @@ All the official Ubuntu flavours are supported, just replace
You can also use \f[CR]quickget\f[R] with options to:
.IP
.EX
# show an OS ISO download URL for {os} {release} [edition]
quickget \-\-show\-iso\-url fedora 38 Silverblue
# show an OS ISO download URL for {os} {release} [edition]
quickget \-\-show\-iso\-url fedora 38 Silverblue
# test if an OS ISO is available for {os} {release} [edition]
quickget \-\-test\-iso\-url nixos 23.05 plasma5
# open an OS distribution homepage in a browser
@ -192,6 +192,8 @@ operating systems, including Windows and macOS.
.IP \[bu] 2
\f[CR]haiku\f[R] (Haiku)
.IP \[bu] 2
\f[CR]holoiso\f[R] (SteamOS HoloISO)
.IP \[bu] 2
\f[CR]kali\f[R] (Kali)
.IP \[bu] 2
\f[CR]kdeneon\f[R] (KDE Neon)

7
docs/quickget.1.md
View File

@ -1,6 +1,6 @@
---
author: Martin Wimpress
date: April 17, 2024
date: April 19, 2024
footer: quickget
header: Quickget User Manual
section: 1
@ -102,8 +102,8 @@ with your preferred flavour.
You can also use `quickget` with options to:
``` shell
# show an OS ISO download URL for {os} {release} [edition]
quickget --show-iso-url fedora 38 Silverblue
# show an OS ISO download URL for {os} {release} [edition]
quickget --show-iso-url fedora 38 Silverblue
# test if an OS ISO is available for {os} {release} [edition]
quickget --test-iso-url nixos 23.05 plasma5
# open an OS distribution homepage in a browser
@ -155,6 +155,7 @@ fully functional for all operating systems, including Windows and macOS.
- `gnomeos` (GNOME OS)
- `guix` (Guix)
- `haiku` (Haiku)
- `holoiso` (SteamOS HoloISO)
- `kali` (Kali)
- `kdeneon` (KDE Neon)
- `kolibrios` (KolibriOS)