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

Merge branch 'main' of https://robmc.duckdns.org/git/TheOnePath/Microsoft-Edge-Updater

Browse Source
This commit is contained in:
Ethan Smith-Coss 2021-07-01 13:53:55 +01:00
commit 664655bc65
2 changed files with 76 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
updater.1
View File

@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 2.5
.\"
.TH "UPDATER" "1" "May 24, 2021" "updater 0.1.4" "User Manual"
.TH "UPDATER" "1" "June 30, 2021" "updater 0.2.0" "User Manual"
.hy
.SH NAME
.PP
@ -16,7 +16,29 @@
.PD
Prevent notifications from being sent after a session.
.IP \[bu] 2
\f[C]\-\-mode=[debug]\f[R]
\f[C]\-c, \-\-set\-channel=\f[R]
.PD 0
.P
.PD
Change the channel to be updated for Microsoft Edge.
Will default to the value defined in \f[C]source.list\f[R] if flag is
not present.
.RS 2
.IP \[bu] 2
beta \- update the Beta channel release.
.IP \[bu] 2
dev \- update the Dev channel release.
.RE
.IP \[bu] 2
\f[C]\-q, \-\-quiet\f[R]
.PD 0
.P
.PD
Operate strictly with no output on \f[C]STDOUT\f[R] or \f[C]STDERR\f[R],
prompts will \f[B]NOT\f[R] assume yes however.
Logging still occurs in background.
.IP \[bu] 2
\f[C]\-\-mode=\f[R]
.PD 0
.P
.PD
@ -25,8 +47,16 @@ Default mode occurs without this flag.
.RS 2
.IP \[bu] 2
\f[B]\f[BI]debug\f[B]\f[R] \- run program in debug mode.
(\f[B]WIP\f[R])
.RE
.IP \[bu] 2
\f[C]\-\-full\-clean\f[R]
.PD 0
.P
.PD
Remove all content generated by updater after a session, this includes
all logs.
.IP \[bu] 2
\f[C]\-y, \-\-yes\-all\f[R]
.PD 0
.P
@ -65,19 +95,26 @@ 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.
\f[C]updater\f[R] must be ran with root privileges.
If the script fails to identify its elevation, it will exit and display
a message to STDOUT.
.SS DISCLAIMER!!
.PP
This version (0.1.4) only works for Microsoft Edge Beta on amd64
architecture.
A later release may allow for update of Dev build and potentially both.
Currently this program has only updated Microsoft Edge for amd64
architectures, other architectures might be possible but not tested.
.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 and later.
.PP
The test environment is a custom Docker image built from the Alpine
base.
Due to certain dependencies of Microsoft Edge, \f[C]updater\f[R] will
currently finish with exit code 11 on a successful session due to the
binary, \f[C]msedge\f[R], not being able to run.
This issue is only known for Busybox systems using \f[C]musl\f[R], and
not \f[C]glibc\f[R], which Microsoft Edge is built using.
.SH DEPENDENCIES
.IP \[bu] 2
bash
@ -120,12 +157,15 @@ information.
This line can be broken into 4 parts
.RS 2
.IP "1." 3
\f[C][dists=amd64]\f[R] \[em]
\f[C][dists=amd64,<beta | dev>]\f[R] \[em]
.PD 0
.P
.PD
This tells the updater which package architecture it should download for
the system.
Comma delimited to that, determine which channel of Microsoft Edge to
update by default, and can be changed or override by flag arguments.
The default value of \f[C]dists\f[R] is \f[C]amd64,beta\f[R].
.IP "2." 3
\f[C]<https URL>\f[R] \[em]
.PD 0
@ -228,6 +268,10 @@ restoration was successful
12 \[em] The restore function failed to restore the files to their
original location
.IP \[bu] 2
254 \[em] The channel to update cannot be identified.
Most likely cause is \f[C]source.list\f[R] is corrupt and \f[C]\-c\f[R]
was not passed.
.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.

34
updater.1.md
View File

@ -2,8 +2,8 @@
title: UPDATER
section: 1
header: User Manual
footer: updater 0.1.4
date: May 24, 2021
footer: updater 0.2.0
date: June 30, 2021
---
# NAME
@ -15,9 +15,17 @@ date: May 24, 2021
# OPTIONS
* `-nn, --no-notify`
Prevent notifications from being sent after a session.
* `--mode=[debug]`
* `-c, --set-channel=`
Change the channel to be updated for Microsoft Edge. Will default to the value defined in `source.list` if flag is not present.
* beta - update the Beta channel release.
* dev - update the Dev channel release.
* `-q, --quiet`
Operate strictly with no output on `STDOUT` or `STDERR`, prompts will __NOT__ assume yes however. Logging still occurs in background.
* `--mode=`
Set the mode of the program to be ran in. Default mode occurs without this flag.
* ___debug___ - run program in debug mode.
* ___debug___ - run program in debug mode. (__WIP__)
* `--full-clean`
Remove all content generated by updater after a session, this includes all logs.
* `-y, --yes-all`
Assume yes to all yes/no decisions.
* `-v, --version`
@ -46,18 +54,23 @@ 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,
`updater` must be ran with root privileges. If the script fails to identify its elevation,
it will exit and display a message to STDOUT.
### DISCLAIMER!!
This version (0.1.4) only works for Microsoft Edge Beta on amd64 architecture.
A later release may allow for update of Dev build and potentially both.
Currently this program has only updated Microsoft Edge for amd64 architectures, other architectures
might be possible but not tested.
### 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 and later.
The test environment is a custom Docker image built from the Alpine base. Due to certain dependencies
of Microsoft Edge, `updater` will currently finish with exit code 11 on a successful session due to
the binary, `msedge`, not being able to run. This issue is only known for Busybox systems using `musl`,
and not `glibc`, which Microsoft Edge is built using.
# DEPENDENCIES
* bash
* wget
@ -81,9 +94,11 @@ Kernel version 5.11.21-179 and later.
* `[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]` —
1. `[dists=amd64,<beta | dev>]` —
This tells the updater which package architecture it
should download for the system.
should download for the system. Comma delimited to that, determine which
channel of Microsoft Edge to update by default, and can be changed or override
by flag arguments. The default value of `dists` is `amd64,beta`.
2. `<https URL>` —
The URL which points to the distribution repository
on the Microsoft Packages server.
@ -129,6 +144,7 @@ Kernel version 5.11.21-179 and later.
* 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
* 254 — The channel to update cannot be identified. Most likely cause is `source.list` is corrupt and `-c` was not passed.
* 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.