added new quickget features to README and man page

This commit is contained in:
Phil Clifford 2023-11-11 02:08:07 +00:00 committed by Martin Wimpress
parent acca8cc224
commit b05dd50aea
8 changed files with 100 additions and 7 deletions

View File

@ -242,6 +242,21 @@ with your preferred flavour.
- `ubuntu-unity` (Ubuntu Unity) - `ubuntu-unity` (Ubuntu Unity)
- `xubuntu` (Xubuntu) - `xubuntu` (Xubuntu)
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
# test if and OS ISO is available for {os} {release} [edition]
quickget --test-iso-url nixos 23.05 plasma5
# open an OS distribution homepage in a browser
quickget --open-distro-homepage ubuntu-mate
```
The `--show-iso-url` and `--test-iso-url` options **do not** work for
`Windows` (`quickget` will begin downloading the requested release and
edition of windows)
## Other Operating Systems ## Other Operating Systems
`quickget` also supports: `quickget` also supports:

@ -1 +1 @@
Subproject commit d9beb09f107f1d97d548d0524926e8246aa5c119 Subproject commit 8c7079452690b58a157798b336981927f5944b9e

View File

@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 3.1.9 .\" Automatically generated by Pandoc 3.1.9
.\" .\"
.TH "QUICKEMU" "1" "November 10, 2023" "quickemu" "Quickemu User Manual" .TH "QUICKEMU" "1" "November 11, 2023" "quickemu" "Quickemu User Manual"
.SH NAME .SH NAME
quickemu - A quick VM builder and manager quickemu - A quick VM builder and manager
.SH SYNOPSIS .SH SYNOPSIS
@ -425,6 +425,21 @@ All the official Ubuntu flavours are supported, just replace
\f[CR]ubuntu-unity\f[R] (Ubuntu Unity) \f[CR]ubuntu-unity\f[R] (Ubuntu Unity)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]xubuntu\f[R] (Xubuntu) \f[CR]xubuntu\f[R] (Xubuntu)
.PP
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
# test if and OS ISO is available for {os} {release} [edition]
quickget --test-iso-url nixos 23.05 plasma5
# open an OS distribution homepage in a browser
quickget --open-distro-homepage ubuntu-mate
.EE
.PP
The \f[CR]--show-iso-url\f[R] and \f[CR]--test-iso-url\f[R] options
\f[B]do not\f[R] work for \f[CR]Windows\f[R] (\f[CR]quickget\f[R] will
begin downloading the requested release and edition of windows)
.SS Other Operating Systems .SS Other Operating Systems
\f[CR]quickget\f[R] also supports: \f[CR]quickget\f[R] also supports:
.IP \[bu] 2 .IP \[bu] 2

View File

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: November 10, 2023 date: November 11, 2023
footer: quickemu footer: quickemu
header: Quickemu User Manual header: Quickemu User Manual
section: 1 section: 1
@ -261,6 +261,21 @@ with your preferred flavour.
- `ubuntu-unity` (Ubuntu Unity) - `ubuntu-unity` (Ubuntu Unity)
- `xubuntu` (Xubuntu) - `xubuntu` (Xubuntu)
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
# test if and OS ISO is available for {os} {release} [edition]
quickget --test-iso-url nixos 23.05 plasma5
# open an OS distribution homepage in a browser
quickget --open-distro-homepage ubuntu-mate
```
The `--show-iso-url` and `--test-iso-url` options **do not** work for
`Windows` (`quickget` will begin downloading the requested release and
edition of windows)
## Other Operating Systems ## Other Operating Systems
`quickget` also supports: `quickget` also supports:

View File

@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 3.1.9 .\" Automatically generated by Pandoc 3.1.9
.\" .\"
.TH "QUICKEMU_CONF" "1" "November 10, 2023" "quickemu_conf" "Quickemu Configuration Manual" .TH "QUICKEMU_CONF" "1" "November 11, 2023" "quickemu_conf" "Quickemu Configuration Manual"
.SH NAME .SH NAME
quickemu_conf - Options and parameters in the quickemu <vm>.conf quickemu_conf - Options and parameters in the quickemu <vm>.conf
.SH DESCRIPTION .SH DESCRIPTION

View File

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: November 10, 2023 date: November 11, 2023
footer: quickemu_conf footer: quickemu_conf
header: Quickemu Configuration Manual header: Quickemu Configuration Manual
section: 1 section: 1

View File

@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 3.1.9 .\" Automatically generated by Pandoc 3.1.9
.\" .\"
.TH "QUICKGET" "1" "November 10, 2023" "quickget" "Quickget User Manual" .TH "QUICKGET" "1" "November 11, 2023" "quickget" "Quickget User Manual"
.SH NAME .SH NAME
quickget - download and prepare materials for building a quickemu VM quickget - download and prepare materials for building a quickemu VM
.SH SYNOPSIS .SH SYNOPSIS
@ -17,6 +17,15 @@ show version (from Quickemu)
\f[B]list | list_csv | list_json\f[R] \f[B]list | list_csv | list_json\f[R]
provide a csv list of all supported guest OSes, versions and variants. provide a csv list of all supported guest OSes, versions and variants.
.TP .TP
\f[B]\f[CB]--show-iso-url\f[B] | -s\f[R] {\f[B]os\f[R]} {\f[B]release\f[R]} [\f[B]edition\f[R]]
show ISO download URL
.TP
\f[B]\f[CB]--test-iso-url\f[B] | -t\f[R] {\f[B]os\f[R]} {\f[B]release\f[R]} [\f[B]edition\f[R]]
test if ISO is available
.TP
\f[B]\f[CB]--open-distro-homepage\f[B] | -o\f[R] {\f[B]os\f[R]}
open OS homepage in browser
.TP
\f[B][OS] [Release] [Edition]\f[R] \f[B][OS] [Release] [Edition]\f[R]
specify the OS and release (and optional edition) if insufficient input specify the OS and release (and optional edition) if insufficient input
is provided a list of missing options will be reported and the script is provided a list of missing options will be reported and the script
@ -90,6 +99,21 @@ All the official Ubuntu flavours are supported, just replace
\f[CR]ubuntu-unity\f[R] (Ubuntu Unity) \f[CR]ubuntu-unity\f[R] (Ubuntu Unity)
.IP \[bu] 2 .IP \[bu] 2
\f[CR]xubuntu\f[R] (Xubuntu) \f[CR]xubuntu\f[R] (Xubuntu)
.PP
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
# test if and OS ISO is available for {os} {release} [edition]
quickget --test-iso-url nixos 23.05 plasma5
# open an OS distribution homepage in a browser
quickget --open-distro-homepage ubuntu-mate
.EE
.PP
The \f[CR]--show-iso-url\f[R] and \f[CR]--test-iso-url\f[R] options
\f[B]do not\f[R] work for \f[CR]Windows\f[R] (\f[CR]quickget\f[R] will
begin downloading the requested release and edition of windows)
.SS Other Operating Systems .SS Other Operating Systems
\f[CR]quickget\f[R] also supports: \f[CR]quickget\f[R] also supports:
.IP \[bu] 2 .IP \[bu] 2

View File

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: November 10, 2023 date: November 11, 2023
footer: quickget footer: quickget
header: Quickget User Manual header: Quickget User Manual
section: 1 section: 1
@ -29,6 +29,15 @@ configuration for `quickemu` to use to build and run
: provide a csv list of all supported guest OSes, versions and : provide a csv list of all supported guest OSes, versions and
variants. variants.
**`--show-iso-url` \| -s** {**os**} {**release**} \[**edition**\]
: show ISO download URL
**`--test-iso-url` \| -t** {**os**} {**release**} \[**edition**\]
: test if ISO is available
**`--open-distro-homepage` \| -o** {**os**}
: open OS homepage in browser
**\[OS\] \[Release\] \[Edition\]** **\[OS\] \[Release\] \[Edition\]**
: specify the OS and release (and optional edition) if insufficient : specify the OS and release (and optional edition) if insufficient
input is provided a list of missing options will be reported and the input is provided a list of missing options will be reported and the
@ -88,6 +97,21 @@ with your preferred flavour.
- `ubuntu-unity` (Ubuntu Unity) - `ubuntu-unity` (Ubuntu Unity)
- `xubuntu` (Xubuntu) - `xubuntu` (Xubuntu)
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
# test if and OS ISO is available for {os} {release} [edition]
quickget --test-iso-url nixos 23.05 plasma5
# open an OS distribution homepage in a browser
quickget --open-distro-homepage ubuntu-mate
```
The `--show-iso-url` and `--test-iso-url` options **do not** work for
`Windows` (`quickget` will begin downloading the requested release and
edition of windows)
## Other Operating Systems ## Other Operating Systems
`quickget` also supports: `quickget` also supports: