[eos-apps-info] gathered many EOS app docs here

eos-apps-info/PKGBUILD

@@ -2,7 +2,7 @@
 
 pkgname=eos-apps-info
 pkgdesc="Documentation about apps in the EndeavourOS repository."
-pkgver=24.6
+pkgver=24.6.1
 pkgrel=1
 arch=('any')
 license=('GPL')
@@ -34,10 +34,10 @@ source=(
 
 sha512sums=('be26da9037149c7801d9aa075bcf9e7feefe82aeba583587acb61e3dbf8fb2ae16e055dbd40e4003104860944a336c6e908d43db963de37aff71c0ab01b9ee18'
             '264b2ce9f3981728bb45e52ab9d2ec782a5e9a291ca2b9249a5558529f4717c868545524677185cb5cc2f370f373818dd2c690fa79f1a107c34c65b3d6ea53a0'
-            '13d2d4cbe1be937512bb023e543efbc67be3ba04b78fb5af4fac05a76d7554edb6a249f5bc54bd63f675edfbd0c89034a3a502651a0c2d7c28be649528775b14'
+            '53e387eb1af9693dce6cc83636de399fc8ceedbce3e237c51c84e330766caec728808a2cf65ab653289b5da7c0648f47d17009f3e3669a15ddb0eb7772bae073'
             '8a0692ff5e714a0690c7a90d04a928b2edf2e01515f8707b345d0da36ee95cab7f4f9badf3dca6cbd280438a08519957c5852be92e7936da9f0affef3d895b17'
             '4b5eef3ce297cfa66d38b6ad92739eee905050228f72bd2c58d7f05700269b0ef434b0aa5c6ff8423a98af33918089f1255858bd2385ef3db2967d71e0d1d350'
-            '190a46697f6b6fd827528ac7d89198ba3fdf7a55c787b4d3e1ca762931931733b060e56670c1d07e85d74bb85b2a1f786ee8bbdcf98d585c4ebb9f8cae4675c6')
+            '0c72506bf26f8baf878df56c5f327de14093da5f52c1e1710e51f83d272d1a1221ee8ca3fcf345a6a79e40e7accc06c9179da23966ad3e72d975fb69b8acfeb3')
 
 package() {
   local xx

eos-apps-info/eos-apps-info-collect

@@ -10,7 +10,6 @@ popd()  { builtin popd  "$@" >/dev/null ; }
 
 MakePicSmaller() {
     local picfile="$1"
-    # /usr/bin/convert "$picfile" -depth 3 "$picfile"
     /bin/magick "$picfile" -depth 3 "$picfile"
 }
 
@@ -22,10 +21,7 @@ Md2html() {
     if [ "${dir::1}" = "/" ] ; then
         pkgbuildsdir=""
     else
-        case "$app" in
-            welcome) pkgbuildsdir=../../.. ;;    # welcome src separated from PKGBUILD!
-            *)       pkgbuildsdir=../.. ;;
-        esac
+        pkgbuildsdir=../..
         [ -n "$dir" ] && dir="/$dir"
     fi
     mkdir -p $app
@@ -175,13 +171,7 @@ Main()
         fi
     done
 
-    # direct pages
-    for app in akm eos-log-tool eos-rankmirrors pahis reflector-simple
-    do
-        Md2html $app
-    done
-
-    # indirect via man folder
+    # pages in eos-apps-info/man folder
     pushd ../man
     local apps=(*)
     popd
@@ -190,26 +180,6 @@ Main()
         Md2html $app $appname/man
     done
 
-    for app in checkupdatesext eos-update-notifier eos-update-notifier-configure
-    do
-        Md2html $app eos-update-notifier/man
-    done
-
-    Md2html mirrorlist-rank-info   reflector-simple/man
-
-    #for app in nvidia-driver-supported-branches ; do
-    #    Md2html $app nvidia-installer-common/man         # does not exist?
-    #done
-
-    # Md2html nvidia-installer-dkms  nvidia-installer-dkms/man
-    Md2html welcome                welcome/man
-
-    # man page to html: no more needed...
-    #for app in #downgrade #yad # yay polybar inxi
-    #do
-    #    Man2html $app
-    #done
-
     # update the tar.gz archive
     cd ..
     local archive=${appname}-pages.tar.gz

eos-apps-info/man/akm/README.md

@@ -0,0 +1,97 @@
+# akm
+Simple kernel manager for EndeavourOS and Arch.<br>
+Note: does not support kernels in the AUR.
+
+![](akm.png)
+
+## Usage
+```
+akm [options]
+
+Options:
+    --connect-header      Make kernel and header package go together at install or uninstall.
+    --small               Make the akm window smaller, meant for helping with small displays at 1366x768 resolution.
+    --help | -h           This help.
+```
+Option `--scroll` (enables scrolling in the window) is also available, but it is enabled by default.
+
+## Options
+
+Without options, `akm` installs selected packages and uninstalls unselected packages.<br>
+<br>
+If option `--connect-header` is used, then `akm` ties kernel and header package into one atomic "unit" when installing or uninstalling.<br>
+If selections of a kernel and its header conflict, kernel selection is used for both packages.
+For example, if you only choose to install package `linux-zen` but not its header, option `--connect-header` would cause installing `linux-zen-headers` too.
+
+Option `--scroll` may be useful when using kernels from additional repositories.
+
+## Configuration file
+
+Configuration file `/etc/akm.conf` manages how `akm` works.<br>
+Currently the supported configurations are:
+
+Variable | Description | Supported values
+:--- | :--- | :---
+KERNEL_HEADER_WITH_KERNEL | Tie header package with the kernel package.<br>Does the same as option `--connect-header`. | "no" (=default) and "yes"
+AKM_KERNELS_HEADERS | Additional kernel and header names. | List of `reponame/pkgname` entries.
+AKM_WINDOW_WIDTH | Width of the `akm` window in pixels. | A positive number, default is 900.
+
+<br>
+
+## Advanced example: add a new (unofficial) package repository
+
+You can add more (unofficial) package repositories into `/etc/pacman.conf`.<br>
+If the repository contains linux kernel packages, `akm` tries to automagically add them to the list.
+
+The picture below shows `akm` window after adding the following unofficial repo:
+```
+# NOTE: this particular repo is no more supported!
+
+[kernel-lts]
+Server = https://repo.m2x.dev/current/$repo/$arch
+```
+
+<br>
+
+![](akm-added-repo.png)
+
+### Caveat
+
+This method of automatically detecting kernel names is limited because kernels can be named in various ways.<br>
+Use configuration variable AKM_KERNELS_HEADERS (mentioned above) to add a list of kernel and header names from an additional repository. This is useful if the automatic kernel name detection does not recognize certain kernel names.
+
+Just as an example, to use the info from the picture above, your `/etc/akm.conf` could look something like this:
+
+```
+#!/bin/bash
+
+### Config file for akm.
+
+# When installing/uninstalling a kernel, you may configure to
+# install/uninstall the related header too.
+# Values: "yes" or "no"
+# Default: no
+local KERNEL_HEADER_WITH_KERNEL=yes
+
+# List of kernel and header names when using additional repos.
+# Example:
+#   local AKM_KERNELS_HEADERS=(
+#       reponame/linux-xxx  reponame/linux-xxx-headers
+#       reponame/linux-yyy  reponame/linux-yyy-headers
+#       ...
+#   )
+# where
+#    reponame   The name of an additional repository.
+#    linux-xxx  The name of a kernel.
+#
+local AKM_KERNELS_HEADERS=(
+    kernel-lts/linux-lts414  kernel-lts/linux-lts414-headers
+    kernel-lts/linux-lts419  kernel-lts/linux-lts419-headers
+    kernel-lts/linux-lts44   kernel-lts/linux-lts44-headers
+    # and so on...
+)
+
+# Width of the akm window in pixels.
+# Default: 900
+local AKM_WINDOW_WIDTH=1000
+```

eos-apps-info/man/checkupdatesext/checkupdatesext.md

@@ -0,0 +1,17 @@
+# checkupdatesext
+
+A`checkupdates` wrapper. Instead shows the updates with columnized layout and a header.
+
+![](checkupdatesext.png)
+
+## Synopsis
+
+```
+checkupdatesext
+```
+## Returns
+The same as `checkupdates`.
+
+## See also
+
+[checkupdates](https://man.archlinux.org/man/checkupdates.8)

eos-apps-info/man/eos-log-tool/README.md

@@ -0,0 +1,22 @@
+# eos-log-tool
+A GUI tool for copying various system logs to the internet.
+
+![](eos-log-tool.png)
+
+## Options
+
+Name   |   Description
+:--- | :---
+`-j`<br>`--enable-journal` | Enable showing journal logs. Note that some logs *may* include personal data.
+`-h`<br>`--help` | This help.
+
+## Use cases
+
+If a user wants help in troubleshooting an issue, with this tool user
+can share logs for other users to see e.g. on the EndeavourOS forum.<br>
+Note that without logs and/or other system information troubleshooting can be practically impossible.
+
+This tool aims to hide all personal information from the logs that will be sent to the internet. But hiding is not perfect (especially on journals), so it is a good idea to **Save logs locally** before sending.
+
+Button **Share logs to the internet** sends the logs to the internet, and an <u>URL</u> is returned after a successful send.<br>
+This <u>URL</u> is the thing to share with those that help troubleshooting the issue.

eos-apps-info/man/eos-rankmirrors/README.md

@@ -0,0 +1,99 @@
+# eos-rankmirrors
+
+`eos-rankmirrors` ranks the mirrors that provide the EndeavourOS repository.<br>
+
+## Synopsis
+```
+eos-rankmirrors [options]
+```
+
+## Options
+```
+  --help, -h
+             This help.
+
+  --ignore '<wordlist>'
+             Mirrors to be ignored from the result.
+             This is useful for e.g. ignoring non-functional mirrors.
+             The <wordlist> is a list of words separated by a pipe '|' character.
+             Each word should be a unique part of a mirror address.
+             Note that the list should be enclosed in single quotes
+             if it includes more than one word.
+             Example:
+                 eos-rankmirrors --ignore='funami|accum|moson'
+
+  --mirror-verbosity <value>
+             How much information will be shown when a mirror fails.
+             Supported values: see file /etc/eos-rankmirrors.conf, setting
+             EOS_RANKMIRRORS_EXIT_CODE_VERBOSITY.
+
+  --no-save, -n
+             Don't save the generated mirrorlist.
+
+  --prefer '<wordlist>'
+             List of preferred mirrors.
+             Adds given mirror addresses as the first in the EndeavourOS mirrorlist.
+             The <wordlist> is as with option --ignore.
+             Example:
+                 eos-rankmirrors --prefer='funami|accum|moson'
+
+  --show-orig-list
+             Add the original mirror list into /etc/pacman.d/endeavouros-mirrorlist.
+             Supported values: yes, no.
+             Default: yes.
+
+  --show-rank-info
+             Show the ranking data in /etc/pacman.d/endeavouros-mirrorlist.
+             Supported values: "yes" (default) or "no".
+
+  --sort <value>
+             Primary key for sorting the mirrors.
+             Supported key values:
+                 age     (latest first)
+                 rate    (fastest first)
+             Default: age.
+
+  --timeout, -t <value>
+             Set the timeout value (in seconds) for checking a mirror.
+             Default: 30.
+
+  --use-local-mirrorlist
+             For testing purposes.
+             Uses information in local /etc/pacman.d/endeavouros-mirrorlist as the base for ranking.
+
+  --verbose
+             Show more detailed output.
+
+Advanced options:
+  --list-only
+             Save only the mirrorlist without the ranking statistics.
+
+  --mirror-add
+             Temporarily add a mirror URL for ranking (for testing purposes only).
+```
+## Configuration
+
+### Configurable variables in file /etc/eos-rankmirrors.conf
+
+For detailed info, see the comments in file `/etc/eos-rankmirrors.conf`.<br>
+
+Variable name | Default value | Description
+:---- | :---- | :----
+EOS_AUTO_MIRROR_RANKING | no | Write the ranking result to file `/etc/endeavouros-mirrorlist`<br>or `/etc/endeavouros-mirrorlist.pacnew`.
+EOS_AUTORANK_TIMEOUT | 30 | Timeout in seconds for each mirror to respond.
+ALWAYS_FIRST_EOS_MIRRORS | `''` (an empty string) | A list of mirrors to set as first in the ranking result.
+EOS_IGNORED_MIRRORS | () | Array of mirrors to ignore when ranking.
+EOS_RANKMIRRORS_EXIT_CODE_VERBOSITY | show | How much information will be shown a mirror fails to rank.<br>Supported values: `all`, `code`, `show`, `none`.<br>See `/etc/eos-rankmirrors.conf` for more details.
+
+
+Example:
+```
+# Partial contents of file /etc/eos-rankmirrors.conf.
+# Note: use bash syntax.
+
+EOS_AUTO_MIRROR_RANKING=no
+EOS_AUTORANK_TIMEOUT=10
+ALWAYS_FIRST_EOS_MIRRORS='tsinghua|pizza|funami'
+EOS_IGNORED_MIRRORS=(belnet accum jingk)
+EOS_RANKMIRRORS_EXIT_CODE_VERBOSITY=none
+```

eos-apps-info/man/eos-update-notifier-configure/eos-update-notifier-configure.md

@@ -0,0 +1,21 @@
+# eos-update-notifier-configure
+
+Manages and configures certain features of `eos-update-notifier` with a small GUI.
+
+![](eos-update-notifier-configure.png)
+
+## Synopsis
+```
+eos-update-notifier-configure
+```
+## Tips
+Variable `EOS_SUDO_EDITORS` in configuration file
+```
+/etc/eos-script-lib-yad.conf
+```
+determines which editor will be used when editing the configuration file
+```
+/etc/eos-update-notifier.conf
+```
+after clicking the **Edit config** button above.<br>
+Note that environment variables `SUDO_EDITOR`, `VISUAL`, or `EDITOR` can be used if `EOS_SUDO_EDITORS` is not set.

eos-apps-info/man/eos-update-notifier/eos-update-notifier.md

@@ -0,0 +1,30 @@
+# eos-update-notifier
+
+Checks the availability of package updates (EndeavourOS, Arch, and AUR), and offers to perform the actual update.
+
+## Synopsis
+```
+eos-update-notifier [options]
+```
+## Options
+```
+-init        Initialize the eos-update-notifier systemd service for
+             the current user.
+-init-force  Same as -init, but may overwrite existing user service files.
+-conf        Configure the schedule of checking for the updates.
+-show-timer  Show the status of the systemd timer.
+-iw=X        Initial sleep time. Value syntax from 'sleep' program.
+             Default: 5s.
+-nw=X        Max time (seconds) to show the "No updates available" window.
+             Default: 10.
+-q           Be quieter with dialogs.
+--changelog  Show the changelog of this package.
+```
+
+## Tips
+
+Configuration file: `/etc/eos-update-notifier.conf`.
+
+## See also
+
+[eos-update-notifier-configure](/etc/eos-apps-info/pageinfo/eos-update-notifier-configure/eos-update-notifier-configure.html)

eos-apps-info/man/eos-welcome

@@ -0,0 +1 @@
+welcome

eos-apps-info/man/mirrorlist-rank-info/mirrorlist-rank-info.md

@@ -0,0 +1,18 @@
+# mirrorlist-rank-info
+
+`mirrorlist-rank-info` shows up-to-date ranking information about the mirrors in file `/etc/pacman.d/mirrorlist`.
+
+![](mirrorlist-rank-info.png)
+
+## Synopsis
+```
+mirrorlist-rank-info [options]
+```
+## Options
+
+```
+    --age          Sorting precedence: 'age' over 'rate'
+    --rate         Sorting precedence: 'rate' over 'age'
+    --help
+    -h             Show this help
+```