[eos-apps-info] updated doc about options of eos-update

endeavouros-team · Jan 11, 2024 · 1b7af73 · 1b7af73
1 parent 64de089
commit 1b7af73
Showing 1 changed file with 20 additions and 17 deletions.
diff --git a/eos-apps-info/man/eos-update/eos-update.md b/eos-apps-info/man/eos-update/eos-update.md
@@ -2,7 +2,8 @@
 
 Package updater for EndeavourOS and Arch.
 
-Basically does about the same as<br>
+Basically does about the same as
+
 ```
 sudo pacman -Syu
 ```
@@ -14,26 +15,28 @@ sudo pacman -Syu
 - runs `sync` after update
 
 and optionally
-- updates AUR packages with the given AUR helper (yay or paru)
-- checks update compatibility between Nvidia driver and kernel (only on EndeavourOS)
-
 
+- updates AUR packages with the given AUR helper (`yay` or `paru`)
+- checks update compatibility between Nvidia driver and kernel (only on EndeavourOS)
 
 ## Synopsis
+
 ```
 eos-update [options]
-
-Options:
-  --help, -h                This help.
-  --nvidia                  Check also nvidia driver vs. kernel updates.
-  --helper <helper>         AUR helper name. Supported: yay, paru, pacman. Default: pacman.
-                            Others supporting option -Sua should work as well.
-  --paru                    Same as --helper=paru.
-  --yay                     Same as --helper=yay.
-  --pacman                  Same as --helper=pacman. Default.
-  --min-free-bytes <bytes>  Minimal amount of free space (in bytes) that the root partition
-                            should have before updating.
-                            Otherwise a warning message will be displayed.
-                            Default: 1000 000 000 (~1 GB)
 ```
 
+## Options
+
+Option | Purpose
+:--- | :---
+  `--help`<br>`-h`     | This help.
+  `--nvidia`           | Simple validity check for non-dkms Nvidia driver vs. kernel updates.
+  `--no-keyring`       | Do not try to update keyrings first.
+  `--keyrings-reset`   | Resets Arch and EndeavourOS keyrings.<br>Try this if keyring issues constantly make system update fail.
+  `--no-sync`          | Do not run `sync` after update.
+  `--helper`           | Give the name of an AUR helper. Supported values: yay, paru, pacman.<br>Default: pacman (i.e. no AUR helper)<br>Other AUR helpers supporting option `-Sua` like in `yay` should work as well.
+  `--paru`             | Same as `--helper=paru`.
+  `--yay`              | Same as `--helper=yay`.
+  `--aur`              | Uses the AUR helper configured in /etc/eos-script-lib-yad.conf.
+  `--pacman`           | Same as `--helper=pacman`. Default. (Note: pacman does not support AUR directly).
+  `--min-free-bytes`   | Minimal amount of free space (in bytes) that the root partition should have before updating. Otherwise a warning message will be displayed.<br>Default: 1000000000