diff --git a/README.md b/README.md index c5e525b..4d0003b 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,7 @@ DISCLAIMER: Currently this program can only update the Beta release of Microsoft Options: -nn, --no-notify Prevent notifications from being set after a session. - --mode= Set the mode of the program to be ran in. Default mode - occurs without this flag. + --mode= 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 Assume yes to all yes/no decisions. -v, --version Print out the version of the script and exit. diff --git a/updater.1 b/updater.1 index 982a4ca..663ede0 100644 --- a/updater.1 +++ b/updater.1 @@ -15,27 +15,29 @@ .P .PD Prevent notifications from being sent after a session. +.IP \[bu] 2 +\f[C]\-\-mode=[debug]\f[R] .PD 0 .P .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 \f[C]\-y, \-\-yes\-all\f[R] .PD 0 .P .PD Assume yes to all yes/no decisions. -.PD 0 -.P -.PD .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]\-h, \-\-help\f[R] .PD 0 @@ -75,18 +77,24 @@ A later release may allow for update of Dev build and potentially both. .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 and later. .SH DEPENDENCIES .IP \[bu] 2 bash .IP \[bu] 2 wget .IP \[bu] 2 +git +.IP \[bu] 2 gunzip .IP \[bu] 2 tar .IP \[bu] 2 -sort (>= 8.32) +coreutils (>=8.32) +.IP \[bu] 2 +binutils (>=2.35.1) +.IP \[bu] 2 +procps (only Busybox\-based systems) .SH FILES .IP \[bu] 2 \f[C]source.list\f[R] \[em] @@ -112,27 +120,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] \[em] .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] \[em] .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] \[em] .PD 0 .P .PD The main branch of the distribution repository. .IP "4." 3 -\f[C]stable\f[R] \- +\f[C]stable\f[R] \[em] .PD 0 .P .PD @@ -229,7 +237,7 @@ Consult the logs to identify which command returned the exit code. Ethan Smith\-Coss .SH CONTRIBUTORS .IP \[bu] 2 -Robert Morrison \- Documentation +Robert Morrison \[em] Documentation .SS Contacting .PP All contacts should be done through Issues on Gitea. diff --git a/updater.1.md b/updater.1.md index 9f4c860..865e66b 100644 --- a/updater.1.md +++ b/updater.1.md @@ -14,13 +14,16 @@ date: May 24, 2021 # OPTIONS * `-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` - Assume yes to all yes/no decisions. + Assume yes to all yes/no decisions. * `-v, --version` - Print out the version of the script and exit. + Print out the version of the script and exit. * `-h, --help` - Print this help message and exit + Print this help message and exit # DESCRIPTION @@ -53,14 +56,17 @@ 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. +Kernel version 5.11.21-179 and later. # DEPENDENCIES * bash * wget +* git * gunzip * tar -* sort (>= 8.32) +* coreutils (>=8.32) +* binutils (>=2.35.1) +* procps (only Busybox-based systems) # FILES * `source.list` — @@ -75,15 +81,15 @@ Kernel version 5.11.21-179. * `[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]` — This tells the updater which package architecture it should download for the system. - 2. `` - + 2. `` — The URL which points to the distribution repository on the Microsoft Packages server. - 3. `main` - + 3. `main` — The main branch of the distribution repository. - 4. `stable` - + 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. @@ -130,7 +136,7 @@ Kernel version 5.11.21-179. * Ethan Smith-Coss # CONTRIBUTORS -* Robert Morrison - Documentation +* Robert Morrison — Documentation ## Contacting All contacts should be done through Issues on Gitea.