Skip to content

Commit

Permalink
Add documentation for the new behavior regarding news displaying
Browse files Browse the repository at this point in the history
  • Loading branch information
Antiz96 committed Feb 22, 2024
1 parent d09dade commit 28691b8
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 17 deletions.
6 changes: 3 additions & 3 deletions README-fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,14 +110,14 @@ Lorsque l'on clique sur l'icône, cela lance la série de fonctions adéquates p
![listing-packages](https://github.com/Antiz96/arch-update/assets/53110319/43a990c8-ed93-420f-8c46-d50d60bff03f)

Une fois que vous avez donné la confirmation pour procéder, `arch-update` propose d'afficher les dernières Arch news.
Les Arch news publiées au cours des 15 derniers jours sont étiquetées comme « [NOUVEAU] ».
Par défaut, les Arch news sont seulement affichées si au moins une nouvelle news a été publiée depuis la dernière exécution. Les Arch news publiées depuis la dernière exécution sont étiquetées comme `[NOUVEAU]`.
Sélectionnez la news à lire en tapant le numéro associé.
Après avoir lu une news, `arch-update` vous proposera à nouveau d'afficher les dernières Arch news, afin que vous puissiez lire plusieurs news à la fois.
Appuyez simplement sur « Entrée » sans saisir de chiffre pour procéder à la mise à jour :

*Les Arch news peuvent être affichées à tout moment en exécutant la commande `arch-update --news`.*
*Le nombre par défaut de Arch news à afficher avant la mise à jour et avec l'option `-n/--news` est de 5 mais il peut être modifié avec l'option `NewsNum=[Num]` dans le fichier de configuration `arch-update.conf`.*
*Le listing/affichage des Arch news peut être ignoré avec l'option `NoNews` dans le fichier de configuration `arch-update.conf`.*
*Les Arch news peuvent être systématiquement affichées avant la mise à jour, peu importe s'il y en a une nouvelle depuis la dernière exécution ou non, en paramétrant l'option `AlwaysShowNews` dans le fichier de configuration `arch-update.conf`*
*Notez que l'utilisation de cette option générera un message d'avertissement pour rappeler que les utilisateurs sont censés consulter régulièrement les Arch news.*
*Voir le [chapitre de documentation](#Documentation) pour plus de détails.*

Expand Down Expand Up @@ -200,7 +200,7 @@ Les options prises en charge sont :
- NoColor # Ne pas coloriser la sortie.
- NoVersion # Ne pas afficher les modifications de versions des paquets lors du listing des mises à jour en attente.
- NoNews # Ne pas afficher les Arch news. Notez que l'utilisation de cette option générera un message d'avertissement pour rappeler que les utilisateurs sont censés consulter régulièrement les Arch news.
- AlwaysShowNews # Toujours afficher les Arch news avant de mettre à jour, peu importe s'il y en a une nouvelle depuis la dernière exécution ou non.
- NewsNum=[Num] # Nombre de Arch news à affcher avant la mise à jour et avec l'option `-n/--news` (voir la page de manuel arch-update(1) pour plus de details). La valeur par défaut est 5.
- KeepOldPackages=[Num] # Nombre d'anciennes versions de paquets à conserver dans le cache de pacman. La valeur par défaut est 3.
- KeepUninstalledPackages=[Num] # Nombre de versions de paquets désinstallés à conserver dans le cache de pacman. La valeur par défaut est 0.
Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,15 +108,14 @@ When the icon is clicked, it launches the relevant series of functions to perfor
![listing-packages](https://github.com/Antiz96/arch-update/assets/53110319/43a990c8-ed93-420f-8c46-d50d60bff03f)

Once you gave the confirmation to proceed, `arch-update` offers to display latest Arch Linux news.
Arch news that have been published within the last 15 days are tagged as `[NEW]`.
By default, Arch news are only displayed if at least a new one has been published since the last run. Arch news published since the last run 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 display latest Arch Linux news, so you can read multiple news at once.
Simply press "enter" without typing any number to proceed with update:

*Arch news can be displayed at any time by running the `arch-update --news` command.*
*The number of Arch news to display before updating and with the `-n/--news` option defaults to 5 but can be customised with the `NewsNum=[Num]` option in the `arch-update.conf` configuration file.*
*The Arch news listing/displaying 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.*
*Arch news can be displayed everytime before updating, regardless of whether there's a new one since the last run or not, by setting the `AlwaysShowNews` option in the `arch-update.conf` configuration file.*
*See the [documentation chapter](#Documentation) for more details.*

![list-news](https://github.com/Antiz96/arch-update/assets/53110319/b6883ec4-8c44-4b97-86d9-4d0a304b748b)
Expand Down Expand Up @@ -198,7 +197,7 @@ The supported options are:
- NoColor # Do not colorize output.
- NoVersion # Do not show versions changes for packages when listing pending updates.
- NoNews # Do not display Arch news. Note that using this option will generate a warning message as a reminder that users are expected to regularly check Arch news.
- AlwaysShowNews # Always display Arch news before updating, regardless of whether there's a new one since the last run or not.
- NewsNum=[Num] # Number of Arch news to display before updating and with the `-n/--news` option (see the arch-update(1) man page for more details). Defaults to 5.
- 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.
Expand Down
4 changes: 2 additions & 2 deletions doc/man/arch-update.1
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ An update notifier/applier for Arch Linux that assists you with important pre/po
.br
.RB "It also supports AUR packages update (if " "yay " "or " "paru " "is installed) and Flatpak packages update (if " "flatpak " "is installed)."
.br
.RB "Before performing the update, it offers to display the latest Arch Linux news to the user. Arch news that have been published within the last 15 days are tagged as '[NEW]'."
.RB "Before performing the update, it offers to display the latest Arch Linux news to the user. By default, Arch news are only displayed if at least a new one has been published since the last run. Arch news published since the last run are tagged as '[NEW]'."
.br
.RB "It also checks for orphan packages, unused Flatpak packages, old and/or uninstalled cached packages in pacman's cache, pacnew/pacsave files and pending kernel update requiring a reboot to be applied and, if there are, offers to process them."
.br
Expand All @@ -42,7 +42,7 @@ An update notifier/applier for Arch Linux that assists you with important pre/po
.B \-n, \-\-news
Display latest Arch news.
.br
.RB "The default number of Arch news displayed is 5 but you can specify another one as an argument, like so: " "arch-update --news 10" "."
.RB "You can optionally specify how much Arch news to display as an argument, like so: " "arch-update --news 10" ". Defaults to 5."

.TP
.B \-v, \-\-version
Expand Down
6 changes: 3 additions & 3 deletions doc/man/arch-update.conf.5
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "ARCH-UPDATE.CONF" "5" "January 2024" "Arch-Update 1.11.0" "Arch-Update Manual"
.TH "ARCH-UPDATE.CONF" "5" "February 2024" "Arch-Update 1.11.0" "Arch-Update Manual"

.SH NAME
arch-update.conf \- arch-update configuration file.
Expand Down Expand Up @@ -26,8 +26,8 @@ Do not colorize output.
Do not show versions changes for packages when listing pending updates.

.TP
.B NoNews
Do not display Arch news. Note that using this option will generate a warning message as a reminder that users are expected to regularly check Arch news.
.B AlwaysShowNews
Always display Arch news before updating, regardless of whether there's a new one since the last run or not.

.TP
.B NewsNum=[Num]
Expand Down
4 changes: 2 additions & 2 deletions doc/man/fr/arch-update.1
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Un notificateur/applicateur de mises à jour pour Arch Linux qui vous assiste da
.br
.RB "Supporte les mises à jour des paquets AUR (si " "yay " "ou " "paru " "est installé) et des paquets Flatpak (si " "flatpak " "est installé)."
.br
.RB "Avant d'effectuer la mise à jour, propose d'afficher les dernières Arch news à l'utilisateur. Les Arch news publiées au cours des 15 derniers jours sont étiquetées comme '[NEW]'."
.RB "Avant d'effectuer la mise à jour, propose d'afficher les dernières Arch news à l'utilisateur. Par défaut, les Arch news sont seulement affichées si au moins une nouvelle news a été publiée depuis la dernière exécution. Les Arch news publiées depuis la dernière exécution sont étiquetées comme '[NOUVEAU]'."
.br
.RB "Arch-Update vérifie aussi la présence de paquets orphelins/inutilisés, d'anciens paquets mis en cache, de fichiers pacnew/pacsave et de mise à jour du noyau en attente et, s'il y en a, propose de les traiter."
.br
Expand All @@ -42,7 +42,7 @@ Un notificateur/applicateur de mises à jour pour Arch Linux qui vous assiste da
.B \-n, \-\-news
Afficher les dernières Arch news.
.br
.RB "Le nombre par défaut de Arch news affichées est 5 mais vous pouvez en spécifier un autre en tant qu'argument, comme ceci : " "arch-update --news 10" "."
.RB "Vous pouvez optionellement spécifier combien de Arch news afficher en tant qu'argument, comme ceci : " "arch-update --news 10" ". La valeur par défaut est 5."

.TP
.B \-v, \-\-version
Expand Down
6 changes: 3 additions & 3 deletions doc/man/fr/arch-update.conf.5
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "ARCH-UPDATE.CONF" "5" "Janvier 2024" "Arch-Update 1.11.0" "Manuel de Arch-Update"
.TH "ARCH-UPDATE.CONF" "5" "Février 2024" "Arch-Update 1.11.0" "Manuel de Arch-Update"

.SH NAME
arch-update.conf \- fichier de configuration pour arch-update.
Expand Down Expand Up @@ -26,8 +26,8 @@ Ne pas coloriser la sortie.
Ne pas afficher les modifications de versions des paquets lors du listing des mises à jour en attente.

.TP
.B NoNews
Ne pas afficher les Arch news. Notez que l'utilisation de cette option générera un message d'avertissement pour rappeler que les utilisateurs sont censés consulter régulièrement les Arch news.
.B AlwaysShowNews
Toujours afficher les Arch news avant de mettre à jour, peu importe s'il y en a une nouvelle depuis la dernière exécution ou non.

.TP
.B NewsNum=[Num]
Expand Down

0 comments on commit 28691b8

Please sign in to comment.