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.4

Browse Source 
Added the '--mode' flag and desciption.

Updated the dependencies required for updater to run. With these
installed on any system, the program should run.

Adjusted spacing layout of document.
Updated manpage according to markdown using pandoc
This commit is contained in:
Ethan Smith-Coss 2021-06-22 16:26:18 +01:00
parent 8f21f3903d
commit 198ee1d4dc
2 changed files with 28 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
updater.1
View File

@ -15,27 +15,29 @@
.P .P
.PD .PD
Prevent notifications from being sent after a session. Prevent notifications from being sent after a session.
.IP \[bu] 2
\f[C]\-\-mode=[debug]\f[R]
.PD 0 .PD 0
.P .P
.PD .PD
Set the mode of the program to be ran in.
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.
.RE
.IP \[bu] 2 .IP \[bu] 2
\f[C]\-y, \-\-yes\-all\f[R] \f[C]\-y, \-\-yes\-all\f[R]
.PD 0 .PD 0
.P .P
.PD .PD
Assume yes to all yes/no decisions. Assume yes to all yes/no decisions.
.PD 0
.P
.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
Print out the version of the script and exit. Print out the version of the script and exit.
.PD 0
.P
.PD
.IP \[bu] 2 .IP \[bu] 2
\f[C]\-h, \-\-help\f[R] \f[C]\-h, \-\-help\f[R]
.PD 0 .PD 0
@ -75,18 +77,24 @@ A later release may allow for update of Dev build and potentially both.
.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 and later.
.SH DEPENDENCIES .SH DEPENDENCIES
.IP \[bu] 2 .IP \[bu] 2
bash bash
.IP \[bu] 2 .IP \[bu] 2
wget wget
.IP \[bu] 2 .IP \[bu] 2
git
.IP \[bu] 2
gunzip gunzip
.IP \[bu] 2 .IP \[bu] 2
tar tar
.IP \[bu] 2 .IP \[bu] 2
sort (>= 8.32) coreutils (>=8.32)
.IP \[bu] 2
binutils (>=2.35.1)
.IP \[bu] 2
procps
.SH FILES .SH FILES
.IP \[bu] 2 .IP \[bu] 2
\f[C]source.list\f[R] \[em] \f[C]source.list\f[R] \[em]

18
updater.1.md
View File

@ -14,13 +14,16 @@ date: May 24, 2021
# OPTIONS # OPTIONS
* `-nn, --no-notify` * `-nn, --no-notify`
Prevent notifications from being sent after a session. Prevent notifications from being sent after a session.
* `--mode=[debug]`
Set the mode of the program to be ran in. Default mode occurs without this flag.
* ___debug___ - run program in debug mode.
* `-y, --yes-all` * `-y, --yes-all`
Assume yes to all yes/no decisions. Assume yes to all yes/no decisions.
* `-v, --version` * `-v, --version`
Print out the version of the script and exit. Print out the version of the script and exit.
* `-h, --help` * `-h, --help`
Print this help message and exit Print this help message and exit
# DESCRIPTION # DESCRIPTION
@ -53,14 +56,17 @@ A later release may allow for update of Dev build and potentially both.
### Testing Systems ### Testing Systems
`updater` has been known to successfully run, `updater` has been known to successfully run,
download and update Microsoft Edge (Beta) on Solus 4.2 Fortitude, download and update Microsoft Edge (Beta) on Solus 4.2 Fortitude,
Kernel version 5.11.21-179. Kernel version 5.11.21-179 and later.
# DEPENDENCIES # DEPENDENCIES
* bash * bash
* wget * wget
* git
* gunzip * gunzip
* tar * tar
* sort (>= 8.32) * coreutils (>=8.32)
* binutils (>=2.35.1)
* procps
# FILES # FILES
* `source.list` — * `source.list` —