Skip to content

Commit

Permalink
Allow to customise the number of Arch news to display before updating…
Browse files Browse the repository at this point in the history
… and with the `-n/--news` option (#114)

* Add documentation for the '--news [Num]' and 'NewsNum=[Num]' options

* Fix typo in man page

* Fix trailing spaces in README

* Add the '--news [Num]' and 'NewsNum=[Num]' options to the script

* Add translation for the '--news [Num]' and 'NewsNum=[Num]' options

* Correct spacing on french translation

* Little fixes to READMEs

* Little fixes to man pages

* Little improvements for man pages
  • Loading branch information
Antiz96 authored Feb 22, 2024
1 parent 7adc462 commit d09dade
Show file tree
Hide file tree
Showing 9 changed files with 251 additions and 212 deletions.
20 changes: 11 additions & 9 deletions README-fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,11 @@ 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`*
*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`.*
*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 arch-update.conf](#Fichier-de-configuration-arch-update) pour plus de détails.*
*Voir le [chapitre de documentation](#Documentation) pour plus de détails.*

![list-news](https://github.com/Antiz96/arch-update/assets/53110319/b6883ec4-8c44-4b97-86d9-4d0a304b748b)

Expand All @@ -139,7 +140,7 @@ Une fois la mise à jour terminée, l'icône change en conséquence :
`arch-update` recherchera également les anciens paquets et/ou paquets désinstallés mis en cache et proposera de les supprimer (s'il y en a) :

*Le comportement par défaut consiste à conserver les 3 dernières versions en cache des paquets installés et à supprimer toutes les versions en cache des paquets désinstallés.*
*Vous pouvez modifier le nombre d'anciennes versions de paquets et de versions de paquets désinstallés à conserver respectivement dans le cache de pacman avec les options `KeepOldPackages=Num` et `KeepUninstalledPackages=Num` dans le fichier de configuration `arch-update.conf`.*
*Vous pouvez modifier le nombre d'anciennes versions de paquets et de versions de paquets désinstallés à conserver respectivement dans le cache de pacman avec les options `KeepOldPackages=[Num]` et `KeepUninstalledPackages=[Num]` dans le fichier de configuration `arch-update.conf`.*
*Voir le [chapitre de documentation arch-update.conf](#Fichier-de-configuration-arch-update) pour plus de détails.*

![cached-packages](https://github.com/Antiz96/arch-update/assets/53110319/7199bbf1-acd8-49a1-80eb-e9874b94fba6)
Expand Down Expand Up @@ -168,10 +169,10 @@ Après la mise à jour, vérification de la présence de paquets orphelins/inuti
de fichiers pacnew/pacsave et de mise à jour du noyau en attente et, s'il y en a, propose de les traiter.
Options :
-c, --check Vérifier les mises à jour disponibles, envoyer une notification de bureau contenant le nombre de mises à jour disponibles (si libnotify est installé)
-n, --news Afficher les dernières Arch News
-h, --help Afficher ce message d'aide et quitter
-V, --version Afficher les informations de version et quitter
-c, --check Vérifier les mises à jour disponibles, envoyer une notification de bureau contenant le nombre de mises à jour disponibles (si libnotify est installé)
-n, --news [Num] Afficher les dernieres Arch News, vous pouvez optionellement spécifier le nombre de Arch news à afficher avec `--news [Num]` (e.g. `--news 10`)
-h, --help Afficher ce message d'aide et quitter
-V, --version Afficher les informations de version et quitter
Codes de sortie :
0 OK
Expand Down Expand Up @@ -200,8 +201,9 @@ 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.
- 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.
- 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.
Les options sont sensibles à la casse, les majuscules doivent donc être respectées.
```
Expand Down
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,10 @@ After your read a news, `arch-update` will once again offers to display latest A
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.*
*See the [arch-update.conf documentation chapter](#arch-update-configuration-file) for more details.*
*See the [documentation chapter](#Documentation) for more details.*

![list-news](https://github.com/Antiz96/arch-update/assets/53110319/b6883ec4-8c44-4b97-86d9-4d0a304b748b)

Expand All @@ -137,7 +138,7 @@ When the update is over, the icon changes accordingly:
`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.*
*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.*

![cached-packages](https://github.com/Antiz96/arch-update/assets/53110319/7199bbf1-acd8-49a1-80eb-e9874b94fba6)
Expand Down Expand Up @@ -166,10 +167,10 @@ Post update, check for orphan/unused packages, old cached packages, pacnew/pacsa
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)
-n, --news Display latest Arch News
-h, --help Display this help message and exit
-V, --version Display version information and exit
-c, --check Check for available updates, send a desktop notification containing the number of available updates (if libnotify is installed)
-n, --news [Num] Display latest Arch News, you can optionally specify the number of Arch news to display with `--news [Num]` (e.g. `--news 10`)
-h, --help Display this help message and exit
-V, --version Display version information and exit
Exit Codes:
0 OK
Expand Down Expand Up @@ -198,8 +199,9 @@ 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.
- 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.
- 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.
Options are case sensitive, so capital letters have to be respected.
```
Expand Down
2 changes: 2 additions & 0 deletions doc/man/arch-update.1
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ An update notifier/applier for Arch Linux that assists you with important pre/po
.TP
.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" "."

.TP
.B \-v, \-\-version
Expand Down
8 changes: 6 additions & 2 deletions doc/man/arch-update.conf.5
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,15 @@ Do not show versions changes for packages when listing pending updates.
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.

.TP
.B KeepOldPackages=Num
.B NewsNum=[Num]
.RB "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."

.TP
.B KeepOldPackages=[Num]
Number of old packages' versions to keep in pacman's cache. Defaults to 3.

.TP
.B KeepUninstalledPackages=Num
.B KeepUninstalledPackages=[Num]
Number of uninstalled packages' versions to keep in pacman's cache. Defaults to 0.

.SH SEE ALSO
Expand Down
2 changes: 2 additions & 0 deletions doc/man/fr/arch-update.1
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ Un notificateur/applicateur de mises à jour pour Arch Linux qui vous assiste da
.TP
.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" "."

.TP
.B \-v, \-\-version
Expand Down
8 changes: 6 additions & 2 deletions doc/man/fr/arch-update.conf.5
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,15 @@ Ne pas afficher les modifications de versions des paquets lors du listing des mi
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.

.TP
.B KeepOldPackages=Num
.B NewsNum=[Num]
.RB "Nombre de Arch news à afficher avant la mise à jour et avec l'option " "-n/--news " "(voir la page de man " "arch-update(1) " "pour plus de détails). La valeur par défaut est 5."

.TP
.B KeepOldPackages=[Num]
Nombre d'anciennes versions de paquets à conserver dans le cache de pacman. La valeur par défaut est 3.

.TP
.B KeepUninstalledPackages=Num
.B KeepUninstalledPackages=[Num]
Nombre de versions de paquets désinstallés à conserver dans le cache de pacman. La valeur par défaut est 0.

.SH VOIR AUSSI
Expand Down
Loading

0 comments on commit d09dade

Please sign in to comment.