From d87f446ae41ea9b4dc703552e6b0e1efc014a990 Mon Sep 17 00:00:00 2001 From: TheOnePath Date: Sun, 23 May 2021 23:33:09 +0100 Subject: [PATCH 1/7] Added manpage markdown file --- updater.1.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 updater.1.md diff --git a/updater.1.md b/updater.1.md new file mode 100644 index 0000000..e69de29 From 59f8991c61248a2158e4f3ccf235fba336f321e6 Mon Sep 17 00:00:00 2001 From: TheOnePath Date: Mon, 24 May 2021 13:26:33 +0100 Subject: [PATCH 2/7] Updated manpage markdown --- updater.1.md | 81 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) diff --git a/updater.1.md b/updater.1.md index e69de29..9c878d0 100644 --- a/updater.1.md +++ b/updater.1.md @@ -0,0 +1,81 @@ +| title | section | header | footer | date | +|:-------:|:-------:|:-----------:|:---------------:|:-----------:| +| UPDATER | 1 | User Manual | updater VERSION | May 23 2021 | + +# NAME +`updater` --- Automatically update Microsoft Edge on Solus + +# SYNOPSIS +**`updater`**`[OPTION]` + +# OPTIONS +``` +-y, --yes-all Assume yes to all yes/no decisions. +-v, --version Print out the version of the script and exit. + --help Print this help message and exit +``` + +# DESCRIPTION + +Microsoft Edge Updater is a program which will download and update your installation of Microsoft Edge to the latest release version identified. The main script is `updater` and while the system is akin to a package manager, it's much, much simpler. + +Systems that run Debian-based distros (using the `apt` package manager) or Fedora/openSUSE (using the `dnf` packagaer manager), should install Microsoft Edge to their package manager according to the official guide over at [Microsoft Edge Insider - Command line installation](https://www.microsoftedgeinsider.com/en-us/download/). + +For those systems that use the amd64 architecture but not the perviously mentioned bases/distros, or package managers, may benefit from this program. `updater` uses the Debian (`.deb`) release versions of Microsoft Edge and automatically installs them to your system so you don't have to again! + +### DISCLAIMER!! +This version (0.1.2 - Beta) only works for Microsoft Edge Beta on amd64 architecture. A later release may allow for update of Dev build and potentially both. + +### Testing Systems +`updater` has been known to successfully run, download and update Microsoft Edge (Beta) on Solus 4.2 Fortitude, Kernel version 5.11.21-179. + +# DEPENDENCIES +* Bash +* wget +* gunzip +* tar +* sort (>= 8.32) + +# FILES +* `source.list` --- + + This file contains a list of URL end-points to the official Microsoft Edge packages page. There are 3 lines with dedicated purposes: + * `[host]` --- a URL to the front page of Microsoft's Packages site used to check connectivity and if the site is reachable. + * `[dists]` --- most iconic line and resembles that of an APT entry for package information. This line can be broken into 4 parts + 1. `[dists=amd64]` - this tells the updater which package architecture it should download for the system. + 2. `` - the URL which points to the distribution repository on the Microsoft Packages server. + 3. `main` - the main branch of the distribution repository. + 4. `stable` - the type of release that should be installed to the system. + * `[pool]` --- the prefix URL to the repository end-point that stores the latest releases. The suffix comes from the Release information. +* `logs/` --- + + This is a directory which holds the session and history logs. + * `logs/updater.log` --- a full report log of the previous update session. Replaced after every next update session. + * `logs/updater.history` --- a history of all the previous update sessions. Never replaced, only appended to after every next update session. +* `utils/` --- + + Resource directory which contains any utility scripts. These are stand-alone; however, don't have any specific purpose being executed by a user. + * `utils/common` --- a utility file with common functions for updater. + +# EXIT STATUS +* 0 --- Successful +* 1 --- General Error (Errors not severe enough to the cause of the updater to stop) +* 2 --- Could not find `source.list` for the update +* 3 --- Host could not be reached. Check Internet connectivity and/or host URL +* 4 --- Failed to download either the Packages information or Content information files +* 5 --- Pool end-point could not be reached +* 6 --- Failed to download the identified Debian (`.deb`) file from the host's pool +* 7 --- Checksum verification of Debian (`.deb`) file failed. At this point, the downloaded file is removed +* 8 --- Failed to unarchive the Debian (`.deb`) file or decompress the `data.tar.gz` file +* 9 --- Failed to copy the new files to the system. At this point, the backup is restored to the system to prevent corruption +* 10 --- The archive function failed to create an archive of the system +* 11 --- If the system successfully restored files on an update failure, the updater will exit with this code stating the update failed but restoration was successful +* 12 --- The restore function failed to restore the files to their original location +* 255 --- EOF flag was set when reading the Packages information file +* Other --- an exit code not related to updater may have been raised. Consult the logs to identify which command returned the exit code. + +# AUTHORS +* Ethan Smith-Coss + +## Contacting +All contacts should be done through Issues on Gitea. From 21c208a32669ae0b6059877b8299d00ce7b74683 Mon Sep 17 00:00:00 2001 From: Robert Morrison Date: Mon, 24 May 2021 16:24:56 +0100 Subject: [PATCH 3/7] Formatting of Markdown MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I have formatted the markdown so it does what I understand you want. The dash used is an em dash `—` The pandoc command for converting the markdown into a manpage is `pandoc INFILE -s -t man -o OUTFILE` I have also provided a generated manpage --- updater.1 | 216 +++++++++++++++++++++++++++++++++++++++++++++++++++ updater.1.md | 137 +++++++++++++++++++++----------- 2 files changed, 307 insertions(+), 46 deletions(-) create mode 100644 updater.1 diff --git a/updater.1 b/updater.1 new file mode 100644 index 0000000..47a602f --- /dev/null +++ b/updater.1 @@ -0,0 +1,216 @@ +.\" Automatically generated by Pandoc 2.11.4 +.\" +.TH "UPDATER" "1" "May 24, 2021" "updater VERSION" "User Manual" +.hy +.SH NAME +.PP +\f[C]updater\f[R] \[em] Automatically update Microsoft Edge on Solus +.SH SYNOPSIS +.PP +\f[B]\f[CB]updater\f[B]\f[R] +.PD 0 +.P +.PD +\f[B]\f[CB]updater -y|--yes-all\f[B]\f[R] +.PD 0 +.P +.PD +\f[B]\f[CB]updater -v|--version\f[B]\f[R] +.PD 0 +.P +.PD +\f[B]\f[CB]updater --help\f[B]\f[R] +.SH OPTIONS +.PP +\f[C]-y, --yes-all\f[R] Assume yes to all yes/no decisions. +.PD 0 +.P +.PD +\f[C]-v, --version\f[R] Print out the version of the script and exit. +.PD 0 +.P +.PD +\f[C]--help\f[R] Print this help message and exit +.SH DESCRIPTION +.PP +Microsoft Edge Updater is a program which will download and update your +installation of Microsoft Edge to the latest release version identified. +The main script is \f[C]updater\f[R] and while the system is akin to a +package manager, it\[cq]s much, much simpler. +.PP +Systems that run Debian-based distros (using the \f[C]apt\f[R] package +manager) or Fedora/openSUSE (using the \f[C]dnf\f[R] package manager), +should install Microsoft Edge to their package manager according to the +official guide over at Microsoft Edge Insider - Command line +installation (https://www.microsoftedgeinsider.com/en-us/download/). +.PP +For those systems that use the amd64 architecture but not the perviously +mentioned bases/distros, or package managers, may benefit from this +program. +\f[C]updater\f[R] uses the Debian (\f[C].deb\f[R]) release versions of +Microsoft Edge and automatically installs them to your system so you +don\[cq]t have to again! +.SS DISCLAIMER!! +.PP +This version (0.1.2 - Beta) only works for Microsoft Edge Beta on amd64 +architecture. +A later release may allow for update of Dev build and potentially both. +.SS Testing Systems +.PP +\f[C]updater\f[R] has been known to successfully run, download and +update Microsoft Edge (Beta) on Solus 4.2 Fortitude, Kernel version +5.11.21-179. +.SH DEPENDENCIES +.IP \[bu] 2 +bash +.IP \[bu] 2 +wget +.IP \[bu] 2 +gunzip +.IP \[bu] 2 +tar +.IP \[bu] 2 +sort (>= 8.32) +.SH FILES +.IP \[bu] 2 +\f[C]source.list\f[R] \[em] +.RS 2 +.PP +This file contains a list of URL end-points to the official Microsoft +Edge packages page. +There are 3 lines with dedicated purposes: +.IP \[bu] 2 +\f[C][host]\f[R] \[em] +.PD 0 +.P +.PD +A URL to the front page of Microsoft\[cq]s Packages site, used to check +connectivity and if the site is reachable. +.IP \[bu] 2 +\f[C][dists]\f[R] \[em] +.PD 0 +.P +.PD +Most iconic line and resembles that of an APT entry for package +information. +This line can be broken into 4 parts +.RS 2 +.IP "1." 3 +\f[C][dists=amd64]\f[R] - +.PD 0 +.P +.PD +This tells the updater which package architecture it should download for +the system. +.IP "2." 3 +\f[C]\f[R] - +.PD 0 +.P +.PD +The URL which points to the distribution repository on the Microsoft +Packages server. +.IP "3." 3 +\f[C]main\f[R] - +.PD 0 +.P +.PD +The main branch of the distribution repository. +.IP "4." 3 +\f[C]stable\f[R] - +.PD 0 +.P +.PD +The type of release that should be installed to the system. +.RE +.IP \[bu] 2 +\f[C][pool]\f[R] \[em] +.PD 0 +.P +.PD +The prefix URL to the repository end-point that stores the latest +releases. +The suffix comes from the Release information. +.RE +.IP \[bu] 2 +\f[C]logs/\f[R] \[em] +.RS 2 +.PP +This is a directory which holds the session and history logs. +.IP \[bu] 2 +\f[C]logs/updater.log\f[R] \[em] +.PD 0 +.P +.PD +A full report log of the previous update session. +Replaced after every next update session. +.IP \[bu] 2 +\f[C]logs/updater.history\f[R] \[em] +.PD 0 +.P +.PD +A history of all the previous update sessions. +Never replaced, only appended to after every next update session. +.RE +.IP \[bu] 2 +\f[C]utils/\f[R] \[em] +.RS 2 +.PP +Resource directory which contains any utility scripts. +These are stand-alone; however, don\[cq]t have any specific purpose +being executed by a user. +.IP \[bu] 2 +\f[C]utils/common\f[R] \[em] +.PD 0 +.P +.PD +A utility file with common functions for updater. +.RE +.SH EXIT STATUS +.IP \[bu] 2 +0 \[em] Successful +.IP \[bu] 2 +1 \[em] General Error (Errors not severe enough to the cause of the +updater to stop) +.IP \[bu] 2 +2 \[em] Could not find \f[C]source.list\f[R] for the update +.IP \[bu] 2 +3 \[em] Host could not be reached. +Check Internet connectivity and/or host URL +.IP \[bu] 2 +4 \[em] Failed to download either the Packages information or Content +information files +.IP \[bu] 2 +5 \[em] Pool end-point could not be reached +.IP \[bu] 2 +6 \[em] Failed to download the identified Debian (\f[C].deb\f[R]) file +from the host\[cq]s pool +.IP \[bu] 2 +7 \[em] Checksum verification of Debian (\f[C].deb\f[R]) file failed. +At this point, the downloaded file is removed +.IP \[bu] 2 +8 \[em] Failed to unarchive the Debian (\f[C].deb\f[R]) file or +decompress the \f[C]data.tar.gz\f[R] file +.IP \[bu] 2 +9 \[em] Failed to copy the new files to the system. +At this point, the backup is restored to the system to prevent +corruption +.IP \[bu] 2 +10 \[em] The archive function failed to create an archive of the system +.IP \[bu] 2 +11 \[em] If the system successfully restored files on an update failure, +the updater will exit with this code stating the update failed but +restoration was successful +.IP \[bu] 2 +12 \[em] The restore function failed to restore the files to their +original location +.IP \[bu] 2 +255 \[em] EOF flag was set when reading the Packages information file +.IP \[bu] 2 +Other \[em] an exit code not related to updater may have been raised. +Consult the logs to identify which command returned the exit code. +.SH AUTHORS +.IP \[bu] 2 +Ethan Smith-Coss +.SS Contacting +.PP +All contacts should be done through Issues on Gitea. diff --git a/updater.1.md b/updater.1.md index 9c878d0..20e9030 100644 --- a/updater.1.md +++ b/updater.1.md @@ -1,78 +1,123 @@ -| title | section | header | footer | date | -|:-------:|:-------:|:-----------:|:---------------:|:-----------:| -| UPDATER | 1 | User Manual | updater VERSION | May 23 2021 | +--- +title: UPDATER +section: 1 +header: User Manual +footer: updater VERSION +date: May 24, 2021 +--- # NAME -`updater` --- Automatically update Microsoft Edge on Solus +`updater` — Automatically update Microsoft Edge on Solus # SYNOPSIS -**`updater`**`[OPTION]` +**`updater`** +**`updater -y|--yes-all`** +**`updater -v|--version`** +**`updater --help`** # OPTIONS -``` --y, --yes-all Assume yes to all yes/no decisions. --v, --version Print out the version of the script and exit. - --help Print this help message and exit -``` +`-y, --yes-all` Assume yes to all yes/no decisions. +`-v, --version` Print out the version of the script and exit. +` --help` Print this help message and exit # DESCRIPTION -Microsoft Edge Updater is a program which will download and update your installation of Microsoft Edge to the latest release version identified. The main script is `updater` and while the system is akin to a package manager, it's much, much simpler. +Microsoft Edge Updater is a program which will download +and update your installation of Microsoft Edge to the latest release version identified. +The main script is `updater` and while the system is akin to a package manager, +it's much, much simpler. -Systems that run Debian-based distros (using the `apt` package manager) or Fedora/openSUSE (using the `dnf` packagaer manager), should install Microsoft Edge to their package manager according to the official guide over at [Microsoft Edge Insider - Command line installation](https://www.microsoftedgeinsider.com/en-us/download/). +Systems that run Debian-based distros (using the `apt` package manager) +or Fedora/openSUSE (using the `dnf` package manager), +should install Microsoft Edge to their package manager +according to the official guide over at +[Microsoft Edge Insider - Command line installation](https://www.microsoftedgeinsider.com/en-us/download/). -For those systems that use the amd64 architecture but not the perviously mentioned bases/distros, or package managers, may benefit from this program. `updater` uses the Debian (`.deb`) release versions of Microsoft Edge and automatically installs them to your system so you don't have to again! +For those systems that use the amd64 architecture +but not the perviously mentioned bases/distros, +or package managers, may benefit from this program. +`updater` uses the Debian (`.deb`) release versions of Microsoft Edge +and automatically installs them to your system so you don't have to again! ### DISCLAIMER!! -This version (0.1.2 - Beta) only works for Microsoft Edge Beta on amd64 architecture. A later release may allow for update of Dev build and potentially both. +This version (0.1.2 - Beta) only works for Microsoft Edge Beta on amd64 architecture. +A later release may allow for update of Dev build and potentially both. ### Testing Systems -`updater` has been known to successfully run, download and update Microsoft Edge (Beta) on Solus 4.2 Fortitude, Kernel version 5.11.21-179. +`updater` has been known to successfully run, +download and update Microsoft Edge (Beta) on Solus 4.2 Fortitude, +Kernel version 5.11.21-179. # DEPENDENCIES -* Bash +* bash * wget * gunzip * tar * sort (>= 8.32) # FILES -* `source.list` --- +* `source.list` — - This file contains a list of URL end-points to the official Microsoft Edge packages page. There are 3 lines with dedicated purposes: - * `[host]` --- a URL to the front page of Microsoft's Packages site used to check connectivity and if the site is reachable. - * `[dists]` --- most iconic line and resembles that of an APT entry for package information. This line can be broken into 4 parts - 1. `[dists=amd64]` - this tells the updater which package architecture it should download for the system. - 2. `` - the URL which points to the distribution repository on the Microsoft Packages server. - 3. `main` - the main branch of the distribution repository. - 4. `stable` - the type of release that should be installed to the system. - * `[pool]` --- the prefix URL to the repository end-point that stores the latest releases. The suffix comes from the Release information. -* `logs/` --- + This file contains a list of URL end-points + to the official Microsoft Edge packages page. + There are 3 lines with dedicated purposes: + + * `[host]` — + A URL to the front page of Microsoft's Packages site, + used to check connectivity and if the site is reachable. + * `[dists]` — + Most iconic line and resembles that of an APT entry for package information. + This line can be broken into 4 parts + 1. `[dists=amd64]` - + This tells the updater which package architecture it + should download for the system. + 2. `` - + The URL which points to the distribution repository + on the Microsoft Packages server. + 3. `main` - + The main branch of the distribution repository. + 4. `stable` - + The type of release that should be installed to the system. + * `[pool]` — + The prefix URL to the repository end-point that stores the latest releases. + The suffix comes from the Release information. + +* `logs/` — This is a directory which holds the session and history logs. - * `logs/updater.log` --- a full report log of the previous update session. Replaced after every next update session. - * `logs/updater.history` --- a history of all the previous update sessions. Never replaced, only appended to after every next update session. -* `utils/` --- + + * `logs/updater.log` — + A full report log of the previous update session. + Replaced after every next update session. + * `logs/updater.history` — + A history of all the previous update sessions. + Never replaced, only appended to after every next update session. - Resource directory which contains any utility scripts. These are stand-alone; however, don't have any specific purpose being executed by a user. - * `utils/common` --- a utility file with common functions for updater. +* `utils/` — + + Resource directory which contains any utility scripts. + These are stand-alone; + however, don't have any specific purpose being executed by a user. + + * `utils/common` — + A utility file with common functions for updater. # EXIT STATUS -* 0 --- Successful -* 1 --- General Error (Errors not severe enough to the cause of the updater to stop) -* 2 --- Could not find `source.list` for the update -* 3 --- Host could not be reached. Check Internet connectivity and/or host URL -* 4 --- Failed to download either the Packages information or Content information files -* 5 --- Pool end-point could not be reached -* 6 --- Failed to download the identified Debian (`.deb`) file from the host's pool -* 7 --- Checksum verification of Debian (`.deb`) file failed. At this point, the downloaded file is removed -* 8 --- Failed to unarchive the Debian (`.deb`) file or decompress the `data.tar.gz` file -* 9 --- Failed to copy the new files to the system. At this point, the backup is restored to the system to prevent corruption -* 10 --- The archive function failed to create an archive of the system -* 11 --- If the system successfully restored files on an update failure, the updater will exit with this code stating the update failed but restoration was successful -* 12 --- The restore function failed to restore the files to their original location -* 255 --- EOF flag was set when reading the Packages information file -* Other --- an exit code not related to updater may have been raised. Consult the logs to identify which command returned the exit code. +* 0 — Successful +* 1 — General Error (Errors not severe enough to the cause of the updater to stop) +* 2 — Could not find `source.list` for the update +* 3 — Host could not be reached. Check Internet connectivity and/or host URL +* 4 — Failed to download either the Packages information or Content information files +* 5 — Pool end-point could not be reached +* 6 — Failed to download the identified Debian (`.deb`) file from the host's pool +* 7 — Checksum verification of Debian (`.deb`) file failed. At this point, the downloaded file is removed +* 8 — Failed to unarchive the Debian (`.deb`) file or decompress the `data.tar.gz` file +* 9 — Failed to copy the new files to the system. At this point, the backup is restored to the system to prevent corruption +* 10 — The archive function failed to create an archive of the system +* 11 — If the system successfully restored files on an update failure, the updater will exit with this code stating the update failed but restoration was successful +* 12 — The restore function failed to restore the files to their original location +* 255 — EOF flag was set when reading the Packages information file +* Other — an exit code not related to updater may have been raised. Consult the logs to identify which command returned the exit code. # AUTHORS * Ethan Smith-Coss From 93c0db0201e82527c10195c075e56e459f985c8d Mon Sep 17 00:00:00 2001 From: Robert Morrison Date: Tue, 1 Jun 2021 18:04:38 +0100 Subject: [PATCH 4/7] Updated To fix issues in review --- updater.1 | 36 +++++++++++++++++++----------------- updater.1.md | 14 +++++++------- 2 files changed, 26 insertions(+), 24 deletions(-) diff --git a/updater.1 b/updater.1 index 47a602f..d5874f3 100644 --- a/updater.1 +++ b/updater.1 @@ -7,30 +7,32 @@ \f[C]updater\f[R] \[em] Automatically update Microsoft Edge on Solus .SH SYNOPSIS .PP -\f[B]\f[CB]updater\f[B]\f[R] -.PD 0 -.P -.PD -\f[B]\f[CB]updater -y|--yes-all\f[B]\f[R] -.PD 0 -.P -.PD -\f[B]\f[CB]updater -v|--version\f[B]\f[R] -.PD 0 -.P -.PD -\f[B]\f[CB]updater --help\f[B]\f[R] +\f[B]\f[CB]updater\f[B]\f[R] [ \f[I]option\f[R] ] .SH OPTIONS -.PP -\f[C]-y, --yes-all\f[R] Assume yes to all yes/no decisions. +.IP \[bu] 2 +\f[C]-y, --yes-all\f[R] .PD 0 .P .PD -\f[C]-v, --version\f[R] Print out the version of the script and exit. +Assume yes to all yes/no decisions. .PD 0 .P .PD -\f[C]--help\f[R] Print this help message and exit +.IP \[bu] 2 +\f[C]-v, --version\f[R] +.PD 0 +.P +.PD +Print out the version of the script and exit. +.PD 0 +.P +.PD +.IP \[bu] 2 +\f[C]--help\f[R] +.PD 0 +.P +.PD +Print this help message and exit .SH DESCRIPTION .PP Microsoft Edge Updater is a program which will download and update your diff --git a/updater.1.md b/updater.1.md index 20e9030..020e90e 100644 --- a/updater.1.md +++ b/updater.1.md @@ -10,15 +10,15 @@ date: May 24, 2021 `updater` — Automatically update Microsoft Edge on Solus # SYNOPSIS -**`updater`** -**`updater -y|--yes-all`** -**`updater -v|--version`** -**`updater --help`** +**`updater`** [ _option_ ] # OPTIONS -`-y, --yes-all` Assume yes to all yes/no decisions. -`-v, --version` Print out the version of the script and exit. -` --help` Print this help message and exit +* `-y, --yes-all` + Assume yes to all yes/no decisions. +* `-v, --version` + Print out the version of the script and exit. +* `--help` + Print this help message and exit # DESCRIPTION From 5f5f97b106f061e0fba7ff5af9fa39bed25f0167 Mon Sep 17 00:00:00 2001 From: TheOnePath Date: Fri, 4 Jun 2021 18:33:00 +0100 Subject: [PATCH 5/7] Updated markdown manpage to match v0.1.3 --- updater.1.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/updater.1.md b/updater.1.md index 020e90e..0d25f2e 100644 --- a/updater.1.md +++ b/updater.1.md @@ -13,11 +13,13 @@ date: May 24, 2021 **`updater`** [ _option_ ] # OPTIONS +* `-nn, --no-notify` + Prevent notifications from being sent after a session. * `-y, --yes-all` Assume yes to all yes/no decisions. * `-v, --version` Print out the version of the script and exit. -* `--help` +* `-h, --help` Print this help message and exit # DESCRIPTION @@ -39,8 +41,13 @@ or package managers, may benefit from this program. `updater` uses the Debian (`.deb`) release versions of Microsoft Edge and automatically installs them to your system so you don't have to again! +## NOTE + +`updater` must be ran with root privilages. If the script fails to identify its elevation, +it will exit and display a message to STDOUT. + ### DISCLAIMER!! -This version (0.1.2 - Beta) only works for Microsoft Edge Beta on amd64 architecture. +This version (VERSION) only works for Microsoft Edge Beta on amd64 architecture. A later release may allow for update of Dev build and potentially both. ### Testing Systems @@ -122,5 +129,8 @@ Kernel version 5.11.21-179. # AUTHORS * Ethan Smith-Coss +# CONTRIBUTORS +* Robert Morrison - Documentation + ## Contacting All contacts should be done through Issues on Gitea. From 4b7c9ba709b24fed397ac6fee8e04f743d635608 Mon Sep 17 00:00:00 2001 From: TheOnePath Date: Fri, 4 Jun 2021 19:22:28 +0100 Subject: [PATCH 6/7] Updated documentation to v0.1.3 --- updater.1 | 50 ++++++++++++++++++++++++++++++++------------------ updater.1.md | 6 +++--- 2 files changed, 35 insertions(+), 21 deletions(-) diff --git a/updater.1 b/updater.1 index d5874f3..82cc2c4 100644 --- a/updater.1 +++ b/updater.1 @@ -1,6 +1,6 @@ -.\" Automatically generated by Pandoc 2.11.4 +.\" Automatically generated by Pandoc 2.5 .\" -.TH "UPDATER" "1" "May 24, 2021" "updater VERSION" "User Manual" +.TH "UPDATER" "1" "May 24, 2021" "updater 0.1.3" "User Manual" .hy .SH NAME .PP @@ -10,7 +10,13 @@ \f[B]\f[CB]updater\f[B]\f[R] [ \f[I]option\f[R] ] .SH OPTIONS .IP \[bu] 2 -\f[C]-y, --yes-all\f[R] +\f[C]\-nn, \-\-no\-notify\f[R] +.PD 0 +.P +.PD +Prevent notifications from being sent after a session. +.IP \[bu] 2 +\f[C]\-y, \-\-yes\-all\f[R] .PD 0 .P .PD @@ -19,7 +25,7 @@ Assume yes to all yes/no decisions. .P .PD .IP \[bu] 2 -\f[C]-v, --version\f[R] +\f[C]\-v, \-\-version\f[R] .PD 0 .P .PD @@ -28,7 +34,7 @@ Print out the version of the script and exit. .P .PD .IP \[bu] 2 -\f[C]--help\f[R] +\f[C]\-h, \-\-help\f[R] .PD 0 .P .PD @@ -40,10 +46,10 @@ installation of Microsoft Edge to the latest release version identified. The main script is \f[C]updater\f[R] and while the system is akin to a package manager, it\[cq]s much, much simpler. .PP -Systems that run Debian-based distros (using the \f[C]apt\f[R] package +Systems that run Debian\-based distros (using the \f[C]apt\f[R] package manager) or Fedora/openSUSE (using the \f[C]dnf\f[R] package manager), should install Microsoft Edge to their package manager according to the -official guide over at Microsoft Edge Insider - Command line +official guide over at Microsoft Edge Insider \- Command line installation (https://www.microsoftedgeinsider.com/en-us/download/). .PP For those systems that use the amd64 architecture but not the perviously @@ -52,16 +58,21 @@ program. \f[C]updater\f[R] uses the Debian (\f[C].deb\f[R]) release versions of Microsoft Edge and automatically installs them to your system so you don\[cq]t have to again! +.SS NOTE +.PP +\f[C]updater\f[R] must be ran with root privilages. +If the script fails to identify its elevation, it will exit and display +a message to STDOUT. .SS DISCLAIMER!! .PP -This version (0.1.2 - Beta) only works for Microsoft Edge Beta on amd64 +This version (0.1.3) only works for Microsoft Edge Beta on amd64 architecture. A later release may allow for update of Dev build and potentially both. .SS Testing Systems .PP \f[C]updater\f[R] has been known to successfully run, download and update Microsoft Edge (Beta) on Solus 4.2 Fortitude, Kernel version -5.11.21-179. +5.11.21\-179. .SH DEPENDENCIES .IP \[bu] 2 bash @@ -78,7 +89,7 @@ sort (>= 8.32) \f[C]source.list\f[R] \[em] .RS 2 .PP -This file contains a list of URL end-points to the official Microsoft +This file contains a list of URL end\-points to the official Microsoft Edge packages page. There are 3 lines with dedicated purposes: .IP \[bu] 2 @@ -98,27 +109,27 @@ information. This line can be broken into 4 parts .RS 2 .IP "1." 3 -\f[C][dists=amd64]\f[R] - +\f[C][dists=amd64]\f[R] \- .PD 0 .P .PD This tells the updater which package architecture it should download for the system. .IP "2." 3 -\f[C]\f[R] - +\f[C]\f[R] \- .PD 0 .P .PD The URL which points to the distribution repository on the Microsoft Packages server. .IP "3." 3 -\f[C]main\f[R] - +\f[C]main\f[R] \- .PD 0 .P .PD The main branch of the distribution repository. .IP "4." 3 -\f[C]stable\f[R] - +\f[C]stable\f[R] \- .PD 0 .P .PD @@ -129,7 +140,7 @@ The type of release that should be installed to the system. .PD 0 .P .PD -The prefix URL to the repository end-point that stores the latest +The prefix URL to the repository end\-point that stores the latest releases. The suffix comes from the Release information. .RE @@ -158,7 +169,7 @@ Never replaced, only appended to after every next update session. .RS 2 .PP Resource directory which contains any utility scripts. -These are stand-alone; however, don\[cq]t have any specific purpose +These are stand\-alone; however, don\[cq]t have any specific purpose being executed by a user. .IP \[bu] 2 \f[C]utils/common\f[R] \[em] @@ -182,7 +193,7 @@ Check Internet connectivity and/or host URL 4 \[em] Failed to download either the Packages information or Content information files .IP \[bu] 2 -5 \[em] Pool end-point could not be reached +5 \[em] Pool end\-point could not be reached .IP \[bu] 2 6 \[em] Failed to download the identified Debian (\f[C].deb\f[R]) file from the host\[cq]s pool @@ -212,7 +223,10 @@ Other \[em] an exit code not related to updater may have been raised. Consult the logs to identify which command returned the exit code. .SH AUTHORS .IP \[bu] 2 -Ethan Smith-Coss +Ethan Smith\-Coss +.SH CONTRIBUTORS +.IP \[bu] 2 +Robert Morrison \- Documentation .SS Contacting .PP All contacts should be done through Issues on Gitea. diff --git a/updater.1.md b/updater.1.md index 0d25f2e..f965f8c 100644 --- a/updater.1.md +++ b/updater.1.md @@ -2,7 +2,7 @@ title: UPDATER section: 1 header: User Manual -footer: updater VERSION +footer: updater 0.1.3 date: May 24, 2021 --- @@ -13,7 +13,7 @@ date: May 24, 2021 **`updater`** [ _option_ ] # OPTIONS -* `-nn, --no-notify` +* `-nn, --no-notify` Prevent notifications from being sent after a session. * `-y, --yes-all` Assume yes to all yes/no decisions. @@ -47,7 +47,7 @@ and automatically installs them to your system so you don't have to again! it will exit and display a message to STDOUT. ### DISCLAIMER!! -This version (VERSION) only works for Microsoft Edge Beta on amd64 architecture. +This version (0.1.3) only works for Microsoft Edge Beta on amd64 architecture. A later release may allow for update of Dev build and potentially both. ### Testing Systems From 5163e7c6b90d46ba0712d4baab9750df6613cceb Mon Sep 17 00:00:00 2001 From: TheOnePath Date: Fri, 4 Jun 2021 21:04:44 +0100 Subject: [PATCH 7/7] Applied patch to markdown provided by @robert --- updater.1 | 3 +++ updater.1.md | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/updater.1 b/updater.1 index 82cc2c4..698a309 100644 --- a/updater.1 +++ b/updater.1 @@ -15,6 +15,9 @@ .P .PD Prevent notifications from being sent after a session. +.PD 0 +.P +.PD .IP \[bu] 2 \f[C]\-y, \-\-yes\-all\f[R] .PD 0 diff --git a/updater.1.md b/updater.1.md index f965f8c..6059abb 100644 --- a/updater.1.md +++ b/updater.1.md @@ -13,8 +13,8 @@ date: May 24, 2021 **`updater`** [ _option_ ] # OPTIONS -* `-nn, --no-notify` - Prevent notifications from being sent after a session. +* `-nn, --no-notify` + Prevent notifications from being sent after a session. * `-y, --yes-all` Assume yes to all yes/no decisions. * `-v, --version`