-
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
239 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,240 @@ | ||
| # antiz.fr | ||
| # Arch-Update | ||
|
|
||
| Git repo for my personal website: <https://antiz.fr> | ||
| ## Table of contents | ||
|
|
||
| - [Description](#description) | ||
| - [Installation](#installation) | ||
| - [Usage](#usage) | ||
| - [Documentation](#documentation) | ||
| - [Tips and tricks](#tips-and-tricks) | ||
| - [Contributing](#contributing) | ||
|
|
||
| ## Description | ||
|
|
||
| An update notifier/applier for Arch Linux that assists you with important pre/post update tasks and that includes a (.desktop) clickeable icon that can easily be integrated with any DE/WM, dock, status/launch bar or app menu. | ||
| Optional support for AUR/Flatpak packages updates and desktop notifications. | ||
|
|
||
| Features: | ||
|
|
||
| - Includes a (.desktop) clickeable icon that automatically changes to act as an update notifier/applier. Easy to integrate with any DE/WM, dock, status/launch bar, app menu, etc... | ||
| - Automatic check and listing of every packages available for update (through [checkupdates](https://archlinux.org/packages/extra/x86_64/pacman-contrib/ "pacman-contrib package")). | ||
| - Offers to print the latest Arch Linux news before applying updates (through [curl](https://archlinux.org/packages/core/x86_64/curl/ "curl package") and [htmlq](https://archlinux.org/packages/extra/x86_64/htmlq/ "htmlq package")). | ||
| - Automatic check and listing of orphan packages and offering you to remove them. | ||
| - Automatic check for old and/or uninstalled cached packages in `pacman`'s cache and offering you to remove them (through [paccache](https://archlinux.org/packages/extra/x86_64/pacman-contrib/ "pacman-contrib package")). | ||
| - Helps you processing pacnew/pacsave files (through [pacdiff](https://archlinux.org/packages/extra/x86_64/pacman-contrib/ "pacman-contrib package"), optionally requires [vim](https://archlinux.org/packages/extra/x86_64/vim/ "vim package") as the default [merge program](https://wiki.archlinux.org/title/Pacman/Pacnew_and_Pacsave#pacdiff "pacdiff merge program")). | ||
| - Automatic check for pending kernel updates requiring a reboot to be applied and offers to do so if there's one. | ||
| - Support for both [sudo](https://archlinux.org/packages/core/x86_64/sudo/ "sudo package") and [doas](https://archlinux.org/packages/extra/x86_64/opendoas/ "opendoas package"). | ||
| - Optional support for AUR packages update (through [yay](https://aur.archlinux.org/packages/yay "yay AUR package") or [paru](https://aur.archlinux.org/packages/paru "paru AUR package")). | ||
| - Optional support for Flatpak packages update (through [flatpak](https://archlinux.org/packages/extra/x86_64/flatpak "Flatpak package")). | ||
| - Optional support for desktop notifications (through [libnotify](https://archlinux.org/packages/extra/x86_64/libnotify "libnotify package"), see <https://wiki.archlinux.org/title/Desktop_notifications>). | ||
|
|
||
| ## Installation | ||
|
|
||
| ### AUR | ||
|
|
||
| Install the [arch-update](https://aur.archlinux.org/packages/arch-update "arch-update AUR package") AUR package. | ||
|
|
||
| ### From Source | ||
|
|
||
| Install dependencies: | ||
|
|
||
| ```bash | ||
| sudo pacman -S --needed pacman-contrib curl htmlq diffutils | ||
| ``` | ||
|
|
||
| Download the archive of the [latest stable release](https://github.com/Antiz96/arch-update/releases/latest) and extract it *(alternatively, you can clone this repository via `git`)*. | ||
|
|
||
| To install `arch-update`, go into the extracted/cloned directory and run the following command: | ||
|
|
||
| ```bash | ||
| sudo make install | ||
| ``` | ||
|
|
||
| To uninstall `arch-update`, go into the extracted/cloned directory and run the following command: | ||
|
|
||
| ```bash | ||
| sudo make uninstall | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| The usage consist of integrating [the .desktop file](#the-desktop-file) anywhere (could be your desktop, your dock, your status/launch bar and/or your app menu) and enabling the [systemd timer](#the-systemd-timer). | ||
|
|
||
| Here is a little YouTube presentation/review of `arch-update` that [Cardiac](https://github.com/Cardiacman13) and I made on [his YouTube channel](https://www.youtube.com/@Cardiacman) (**videos there, including this one, are in french**): | ||
|
|
||
| *Warning: Arch-Update's features and default behavior may have changed/evolved since then!* | ||
|
|
||
| [](https://www.youtube.com/watch?v=QkOkX70SEmo) | ||
|
|
||
| ### The .desktop file | ||
|
|
||
| The .desktop file is located in `/usr/share/applications/arch-update.desktop` (or `/usr/local/share/applications/arch-update.desktop` if you installed `arch-update` [from source](#from-source)). | ||
| Its icon will automatically change depending on the different states (checking for updates, updates available, installing updates, up to date). | ||
| It will launch the relevant series of functions to perform a complete and proper update when clicked (see the [Documentation](#documentation) chapter). It is easy to integrate with any DE/WM, dock, status/launch bar or app menu. | ||
|
|
||
| ### The systemd timer | ||
|
|
||
| There is a systemd service in `/usr/lib/systemd/user/arch-update.service` (or in `/usr/local/lib/systemd/user/arch-update.service` if you installed `arch-update` [from source](#from-source)) that executes the `check` function when started (see the [Documentation](#documentation) chapter). | ||
| To start it automatically **at boot and then once every hour**, enable the associated systemd timer (you can modify the auto-check cycle to your liking, see the [Tips and tricks - Modify the auto-check cycle](#modify-the-auto-check-cycle) chapter): | ||
|
|
||
| ```bash | ||
| systemctl --user enable --now arch-update.timer | ||
| ``` | ||
|
|
||
| ### Screenshot | ||
|
|
||
| Personally, I integrated the .desktop icon in my top bar. | ||
| It is the first icon from the left. | ||
|
|
||
|  | ||
|
|
||
| When `arch-update` is checking for updates, the icon changes accordingly (the `check` function is automatically triggered at boot and then once every hour if you enabled the [systemd timer](#the-systemd-timer) and can be manually triggered by running the `arch-update -c` command): | ||
|
|
||
|  | ||
|
|
||
| If there are new available updates, the icon will show a bell sign and a desktop notification indicating the number of available updates will be sent (requires [libnotify/notify-send](https://archlinux.org/packages/extra/x86_64/libnotify/ "libnotify package")): | ||
|
|
||
|  | ||
|  | ||
|
|
||
| When the icon is clicked, it launches the relevant series of functions to perform a complete and proper update starting by refreshing the list of packages available for updates, print it inside a terminal window and asks for the user's confirmation to proceed with the installation (it can also be launched by running the `arch-update` command, requires [yay](https://aur.archlinux.org/packages/yay "yay") or [paru](https://aur.archlinux.org/packages/paru "paru") for AUR packages update support and [flatpak](https://archlinux.org/packages/extra/x86_64/flatpak/) for Flatpak packages update support): | ||
|
|
||
| *The colored output can be disabled with the `NoColor` option in the `arch-update.conf` configuration file.* | ||
| *The versions changes in the packages listing can be hidden with the `NoVersion` option in the `arch-update.conf` configuration file.* | ||
| *See the [arch-update.conf documentation chapter](#arch-update-configuration-file) for more details.* | ||
|
|
||
|  | ||
|
|
||
| Once you gave the confirmation to proceed, `arch-update` offers to print latest Arch Linux news. | ||
| Arch news that have been published within the last 15 days are tagged as `[NEW]`. | ||
| Select which news to read by typing its associated number. | ||
| After your read a news, `arch-update` will once again offers to print latest Arch Linux news, so you can read multiple news at once. | ||
| Simply press "enter" without typing any number to proceed with update: | ||
|
|
||
| *The Arch news listing/printing can be skipped with the `NoNews` option in the `arch-update.conf` configuration file.* | ||
| *Note that using this option will generate a warning message as a reminder that users are expected to regularly check Arch news.* | ||
| *See the [arch-update.conf documentation chapter](#arch-update-configuration-file) for more details.* | ||
|
|
||
|  | ||
|
|
||
| While `arch-update` is performing updates, the icon changes accordingly: | ||
|
|
||
|  | ||
|
|
||
| When the update is over, the icon changes accordingly: | ||
|
|
||
|  | ||
|
|
||
| `arch-update` will then search for orphan packages/unused Flatpak packages and offers to remove them (if there are): | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| `arch-update` will also search for old and/or uninstalled cached packages and offers to remove them (if there are): | ||
|
|
||
| *The default behavior is to keep the last 3 cached versions of installed packages and remove every cached versions of uninstalled packages.* | ||
| *You can modify the number of old packages' versions and uninstalled packages' versions to keep in pacman's cache respectively with the `KeepOldPackages=Num` and `KeepUninstalledPackages=Num` options in the `arch-update.conf` configuration file.* | ||
| *See the [arch-update.conf documentation chapter](#arch-update-configuration-file) for more details.* | ||
|
|
||
|  | ||
|
|
||
| Additionally `arch-update` will search for pacnew/pacsave files and offers to process them via `pacdiff` (if there are): | ||
|
|
||
|  | ||
|
|
||
| Finally, `arch-update` will check if there's a pending kernel update requiring a reboot to be applied and offers you to do so (if there is): | ||
|
|
||
|  | ||
|
|
||
| ## Documentation | ||
|
|
||
| ### arch-update | ||
|
|
||
| ```text | ||
| An update notifier/applier for Arch Linux that assists you with | ||
| important pre/post update tasks. | ||
| Run arch-update to perform the main "update" function: | ||
| Print the list of packages available for update, then ask for the user's confirmation | ||
| to proceed with the installation. | ||
| Before performing the update, offer to print the latest Arch Linux news. | ||
| Post update, check for orphan/unused packages, old cached packages, pacnew/pacsave files | ||
| and pending kernel update and, if there are, offers to process them. | ||
| Options: | ||
| -c, --check Check for available updates, send a desktop notification containing the number of available updates (if libnotify is installed) | ||
| -h, --help Display this message and exit | ||
| -V, --version Display version information and exit | ||
| Exit Codes: | ||
| 0 OK | ||
| 1 Invalid option | ||
| 2 No privilege method (sudo or doas) is installed | ||
| 3 Error when changing icon | ||
| 4 User didn't gave the confirmation to proceed | ||
| 5 Error when updating the packages | ||
| 6 Error when calling the reboot command to apply a pending kernel update | ||
| ``` | ||
|
|
||
| For more information, see the arch-update(1) man page. | ||
| Certain options can be enabled/disabled or modified via the arch-update.conf configuration file, see the arch-update.conf(5) man page. | ||
|
|
||
| ### arch-update configuration file | ||
|
|
||
| ```text | ||
| The arch-update.conf file is an optional configuration file for arch-update to enable/disable | ||
| or modify certain options within the script. | ||
| This configuration file has to be located in "${XDG_CONFIG_HOME}/arch-update/arch-update.conf" | ||
| or "${HOME}/.config/arch-update/arch-update.conf". | ||
| The supported options are: | ||
| - NoColor # Do not colorize output. | ||
| - NoVersion # Do not show versions changes for packages when listing pending updates. | ||
| - NoNews # Do not print Arch news. Note that using this option will generate a warning message as a reminder that users are expected to regularly check Arch news. | ||
| - KeepOldPackages=Num # Number of old packages' versions to keep in pacman's cache. Defaults to 3. | ||
| - KeepUninstalledPackages=Num # Number of uninstalled packages' versions to keep in pacman's cache. Defaults to 0. | ||
| Options are case sensitive, so capital letters have to be respected. | ||
| ``` | ||
|
|
||
| For more information, see the arch-update(5) man page. | ||
|
|
||
| ## Tips and tricks | ||
|
|
||
| ### AUR Support | ||
|
|
||
| Arch-Update supports AUR packages update when checking and installing updates if **yay** or **paru** is installed: | ||
| See <https://github.com/Jguer/yay> and <https://aur.archlinux.org/packages/yay> | ||
| See <https://github.com/morganamilo/paru> and <https://aur.archlinux.org/packages/paru> | ||
|
|
||
| ### Flatpak Support | ||
|
|
||
| Arch-Update supports Flatpak packages update when checking and installing updates (as well as removing unused Flatpak packages) if **flatpak** is installed: | ||
| See <https://www.flatpak.org/> and <https://archlinux.org/packages/extra/x86_64/flatpak/> | ||
|
|
||
| ### Desktop notifications Support | ||
|
|
||
| Arch-Update supports desktop notifications when performing the `--check` function if **libnotify (notify-send)** is installed: | ||
| See <https://wiki.archlinux.org/title/Desktop_notifications> | ||
|
|
||
| ### Modify the auto-check cycle | ||
|
|
||
| If you enabled the [systemd.timer](#the-systemd-timer), the `--check` option is automatically launched at boot and then once per hour. | ||
|
|
||
| If you want to change the check cycle, run `systemctl --user edit arch-update.timer` to create an override configuration for the timer and input the following in it: | ||
|
|
||
| ```text | ||
| [Timer] | ||
| OnUnitActiveSec=10m | ||
| ``` | ||
|
|
||
| Time units are `s` for seconds, `m` for minutes, `h` for hours, `d` for days... | ||
| See <https://www.freedesktop.org/software/systemd/man/systemd.time.html> for more details. | ||
|
|
||
| ## Contributing | ||
|
|
||
| You can raise your issues, feedbacks and suggestions in the [issues tab](https://github.com/Antiz96/arch-update/issues). | ||
| [Pull requests](https://github.com/Antiz96/arch-update/pulls) are welcomed as well! |