Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readability of documentation in README #91

Merged
merged 1 commit into from
Jan 6, 2024
Merged

Improve readability of documentation in README #91

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,12 +152,15 @@ Finally, `arch-update` will check if there's a pending kernel update requiring a
### arch-update

```text
An update notifier/applier for Arch Linux that assists you with important pre/post update tasks.
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.
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.
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)
Expand All @@ -180,9 +183,11 @@ Certain options can be enabled/disabled or modified via the arch-update.conf con
### 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.
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".
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:

Expand All @@ -193,7 +198,6 @@ The supported options are:
- 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.
Expand Down