added new quickget features to README and man page

quickemu-project · Nov 12, 2023 · b05dd50 · b05dd50
1 parent acca8cc
commit b05dd50
Show file tree

Hide file tree

Showing 8 changed files with 100 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -242,6 +242,21 @@ with your preferred flavour.
 -   `ubuntu-unity` (Ubuntu Unity)
 -   `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
 
 `quickget` also supports:

diff --git a/build-docs b/build-docs
diff --git a/docs/quickemu.1 b/docs/quickemu.1
@@ -1,6 +1,6 @@
 .\" 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
 quickemu - A quick VM builder and manager
 .SH SYNOPSIS
@@ -425,6 +425,21 @@ All the official Ubuntu flavours are supported, just replace
 \f[CR]ubuntu-unity\f[R] (Ubuntu Unity)
 .IP \[bu] 2
 \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
 \f[CR]quickget\f[R] also supports:
 .IP \[bu] 2

diff --git a/docs/quickemu.1.md b/docs/quickemu.1.md
@@ -1,6 +1,6 @@
 ---
 author: Martin Wimpress
-date: November 10, 2023
+date: November 11, 2023
 footer: quickemu
 header: Quickemu User Manual
 section: 1
@@ -261,6 +261,21 @@ with your preferred flavour.
 -   `ubuntu-unity` (Ubuntu Unity)
 -   `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
 
 `quickget` also supports:

diff --git a/docs/quickemu_conf.1 b/docs/quickemu_conf.1
@@ -1,6 +1,6 @@
 .\" 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
 quickemu_conf - Options and parameters in the quickemu <vm>.conf
 .SH DESCRIPTION

diff --git a/docs/quickemu_conf.1.md b/docs/quickemu_conf.1.md
@@ -1,6 +1,6 @@
 ---
 author: Martin Wimpress
-date: November 10, 2023
+date: November 11, 2023
 footer: quickemu_conf
 header: Quickemu Configuration Manual
 section: 1

diff --git a/docs/quickget.1 b/docs/quickget.1
@@ -1,6 +1,6 @@
 .\" 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
 quickget - download and prepare materials for building a quickemu VM
 .SH SYNOPSIS
@@ -17,6 +17,15 @@ show version (from Quickemu)
 \f[B]list | list_csv | list_json\f[R]
 provide a csv list of all supported guest OSes, versions and variants.
 .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]
 specify the OS and release (and optional edition) if insufficient input
 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)
 .IP \[bu] 2
 \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
 \f[CR]quickget\f[R] also supports:
 .IP \[bu] 2

diff --git a/docs/quickget.1.md b/docs/quickget.1.md
@@ -1,6 +1,6 @@
 ---
 author: Martin Wimpress
-date: November 10, 2023
+date: November 11, 2023
 footer: quickget
 header: Quickget User Manual
 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
     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\]**
 :   specify the OS and release (and optional edition) if insufficient
     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)
 -   `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
 
 `quickget` also supports: