From 4b7c9ba709b24fed397ac6fee8e04f743d635608 Mon Sep 17 00:00:00 2001 From: TheOnePath Date: Fri, 4 Jun 2021 19:22:28 +0100 Subject: [PATCH] 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