ClosedLess/Microsoft-Edge-Updater
ClosedLess/Microsoft-Edge-Updater
2
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated documentation to v0.1.3

Browse Source
This commit is contained in:
Ethan Smith-Coss 2021-06-04 19:22:28 +01:00
parent 5f5f97b106
commit 4b7c9ba709
2 changed files with 35 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
updater.1
View File

@ -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 .hy
.SH NAME .SH NAME
.PP .PP
@ -10,7 +10,13 @@
\f[B]\f[CB]updater\f[B]\f[R] [ \f[I]option\f[R] ] \f[B]\f[CB]updater\f[B]\f[R] [ \f[I]option\f[R] ]
.SH OPTIONS .SH OPTIONS
.IP \[bu] 2 .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 .PD 0
.P .P
.PD .PD
@ -19,7 +25,7 @@ Assume yes to all yes/no decisions.
.P .P
.PD .PD
.IP \[bu] 2 .IP \[bu] 2
\f[C]-v, --version\f[R] \f[C]\-v, \-\-version\f[R]
.PD 0 .PD 0
.P .P
.PD .PD
@ -28,7 +34,7 @@ Print out the version of the script and exit.
.P .P
.PD .PD
.IP \[bu] 2 .IP \[bu] 2
\f[C]--help\f[R] \f[C]\-h, \-\-help\f[R]
.PD 0 .PD 0
.P .P
.PD .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 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. package manager, it\[cq]s much, much simpler.
.PP .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), manager) or Fedora/openSUSE (using the \f[C]dnf\f[R] package manager),
should install Microsoft Edge to their package manager according to the 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/). installation (https://www.microsoftedgeinsider.com/en-us/download/).
.PP .PP
For those systems that use the amd64 architecture but not the perviously 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 \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 Microsoft Edge and automatically installs them to your system so you
don\[cq]t have to again! 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!! .SS DISCLAIMER!!
.PP .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. architecture.
A later release may allow for update of Dev build and potentially both. A later release may allow for update of Dev build and potentially both.
.SS Testing Systems .SS Testing Systems
.PP .PP
\f[C]updater\f[R] has been known to successfully run, download and \f[C]updater\f[R] has been known to successfully run, download and
update Microsoft Edge (Beta) on Solus 4.2 Fortitude, Kernel version update Microsoft Edge (Beta) on Solus 4.2 Fortitude, Kernel version
5.11.21-179. 5.11.21\-179.
.SH DEPENDENCIES .SH DEPENDENCIES
.IP \[bu] 2 .IP \[bu] 2
bash bash
@ -78,7 +89,7 @@ sort (>= 8.32)
\f[C]source.list\f[R] \[em] \f[C]source.list\f[R] \[em]
.RS 2 .RS 2
.PP .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. Edge packages page.
There are 3 lines with dedicated purposes: There are 3 lines with dedicated purposes:
.IP \[bu] 2 .IP \[bu] 2
@ -98,27 +109,27 @@ information.
This line can be broken into 4 parts This line can be broken into 4 parts
.RS 2 .RS 2
.IP "1." 3 .IP "1." 3
\f[C][dists=amd64]\f[R] - \f[C][dists=amd64]\f[R] \-
.PD 0 .PD 0
.P .P
.PD .PD
This tells the updater which package architecture it should download for This tells the updater which package architecture it should download for
the system. the system.
.IP "2." 3 .IP "2." 3
\f[C]<https URL>\f[R] - \f[C]<https URL>\f[R] \-
.PD 0 .PD 0
.P .P
.PD .PD
The URL which points to the distribution repository on the Microsoft The URL which points to the distribution repository on the Microsoft
Packages server. Packages server.
.IP "3." 3 .IP "3." 3
\f[C]main\f[R] - \f[C]main\f[R] \-
.PD 0 .PD 0
.P .P
.PD .PD
The main branch of the distribution repository. The main branch of the distribution repository.
.IP "4." 3 .IP "4." 3
\f[C]stable\f[R] - \f[C]stable\f[R] \-
.PD 0 .PD 0
.P .P
.PD .PD
@ -129,7 +140,7 @@ The type of release that should be installed to the system.
.PD 0 .PD 0
.P .P
.PD .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. releases.
The suffix comes from the Release information. The suffix comes from the Release information.
.RE .RE
@ -158,7 +169,7 @@ Never replaced, only appended to after every next update session.
.RS 2 .RS 2
.PP .PP
Resource directory which contains any utility scripts. 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. being executed by a user.
.IP \[bu] 2 .IP \[bu] 2
\f[C]utils/common\f[R] \[em] \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 4 \[em] Failed to download either the Packages information or Content
information files information files
.IP \[bu] 2 .IP \[bu] 2
5 \[em] Pool end-point could not be reached 5 \[em] Pool end\-point could not be reached
.IP \[bu] 2 .IP \[bu] 2
6 \[em] Failed to download the identified Debian (\f[C].deb\f[R]) file 6 \[em] Failed to download the identified Debian (\f[C].deb\f[R]) file
from the host\[cq]s pool 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. Consult the logs to identify which command returned the exit code.
.SH AUTHORS .SH AUTHORS
.IP \[bu] 2 .IP \[bu] 2
Ethan Smith-Coss Ethan Smith\-Coss
.SH CONTRIBUTORS
.IP \[bu] 2
Robert Morrison \- Documentation
.SS Contacting .SS Contacting
.PP .PP
All contacts should be done through Issues on Gitea. All contacts should be done through Issues on Gitea.

4
updater.1.md
View File

@ -2,7 +2,7 @@
title: UPDATER title: UPDATER
section: 1 section: 1
header: User Manual header: User Manual
footer: updater VERSION footer: updater 0.1.3
date: May 24, 2021 date: May 24, 2021
--- ---
@ -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. it will exit and display a message to STDOUT.
### DISCLAIMER!! ### 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. A later release may allow for update of Dev build and potentially both.
### Testing Systems ### Testing Systems