Skip to content

Commit

Permalink
Add an option in the configuration file to explicitely set which comm…
Browse files Browse the repository at this point in the history
…and to use for privilege elevation (#175)

This commit introduces the 'PrivilegeElevationCommand' option to the arch-update.conf configuration file which allows to explicitely set the command to be used to elevate privileges (sudo, doas, run0), so people can choose between if they have multiple of them installed.

If this option isn't set, the default behavior is applied (first look for `sudo`, then `doas`, then `run0`).

Closes #173
  • Loading branch information
Antiz96 authored Jun 20, 2024
1 parent 3460538 commit fbd3ca2
Show file tree
Hide file tree
Showing 10 changed files with 236 additions and 198 deletions.
3 changes: 2 additions & 1 deletion README-fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ Options :
Codes de sortie :
0 OK
1 Option invalide
2 Aucune méthode d'élévation de privilège (sudo, doas ou run0) n'est installée
2 Aucune commande d'élévation de privilège (sudo, doas ou run0) n'est installée ou celle définie dans le fichier de configuration `arch-update.conf` n'est pas disponible
3 Erreur lors du lancement de l'applet systray d'Arch-Update
4 L'utilisateur n'a pas donné la confirmation de procéder
5 Erreur lors de la mise à jour des paquets
Expand Down Expand Up @@ -196,6 +196,7 @@ Les options prises en charge sont :
- 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.
- PrivilegeElevationCommand=[Cmd] # Commande à utiliser pour l'élévation de privilège. Les options valides sont `sudo`, `doas` ou `run0`. Si cette option n'est pas spécifiée, Arch-Update utilisera la première commande disponible dans l'odre suivant: `sudo`, `doas` puis `run0`.
Les options sont sensibles à la casse, les majuscules doivent donc être respectées.
```
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ Options:
Exit Codes:
0 OK
1 Invalid option
2 No privilege elevation method (sudo, doas or run0) is installed
2 No privilege elevation command (sudo, doas or run0) is installed or the one set in the `arch-update.conf` configuration file isn't found
3 Error when launching the Arch-Update systray applet
4 User didn't gave the confirmation to proceed
5 Error when updating the packages
Expand Down Expand Up @@ -196,6 +196,7 @@ The supported options are:
- 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.
- PrivilegeElevationCommand=[Cmd] # Command to be used for privilege elevation. Valid options are `sudo`, `doas` or `run0`. If this option is not set, Arch-Update will use the first available command in the following order: `sudo`, `doas` then `run0`.
Options are case sensitive, so capital letters have to be respected.
```
Expand Down
4 changes: 2 additions & 2 deletions doc/man/arch-update.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "ARCH-UPDATE" "1" "May 2024" "Arch-Update 2.0.2" "Arch-Update Manual"
.TH "ARCH-UPDATE" "1" "June 2024" "Arch-Update 2.0.2" "Arch-Update Manual"

.SH NAME
arch-update \- An update notifier/applier for Arch Linux that assists you with important pre/post update tasks.
Expand Down Expand Up @@ -185,7 +185,7 @@ Invalid option

.TP
.B 2
No privilege elevation method (sudo, doas or run0) is installed
No privilege elevation command (sudo, doas or run0) is installed or the one set in the arch-update.conf configuration file isn't found

.TP
.B 3
Expand Down
6 changes: 5 additions & 1 deletion 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" "March 2024" "Arch-Update 2.0.2" "Arch-Update Manual"
.TH "ARCH-UPDATE.CONF" "5" "June 2024" "Arch-Update 2.0.2" "Arch-Update Manual"

.SH NAME
arch-update.conf \- arch-update configuration file.
Expand Down Expand Up @@ -43,6 +43,10 @@ Number of old packages' versions to keep in pacman's cache. Defaults to 3.
.B KeepUninstalledPackages=[Num]
Number of uninstalled packages' versions to keep in pacman's cache. Defaults to 0.

.TP
.B PrivilegeElevationCommand=[Cmd]
Command to be used for privilege elevation. Valid options are sudo, doas or run0. If this option is not set, Arch-Update will use the first available command in the following order: sudo, doas then run0.

.SH SEE ALSO
.BR arch-update (1)

Expand Down
4 changes: 2 additions & 2 deletions doc/man/fr/arch-update.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "ARCH-UPDATE" "1" "Mai 2024" "Arch-Update 2.0.2" "Manuel de Arch-Update"
.TH "ARCH-UPDATE" "1" "Juin 2024" "Arch-Update 2.0.2" "Manuel de Arch-Update"

.SH NAME
arch-update \- Un notificateur/applicateur de mises à jour pour Arch Linux qui vous assiste dans les tâches importantes d'avant/après mise à jour.
Expand Down Expand Up @@ -185,7 +185,7 @@ Option invalide

.TP
.B 2
Aucune méthode d'élévation de privilège (sudo, doas ou run0) n'est installée
Aucune commande d'élévation de privilège (sudo, doas ou run0) n'est installée ou celle définie dans le fichier de configuration arch-update.conf n'est pas disponible

.TP
.B 3
Expand Down
6 changes: 5 additions & 1 deletion 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" "Mars 2024" "Arch-Update 2.0.2" "Manuel de Arch-Update"
.TH "ARCH-UPDATE.CONF" "5" "Juin 2024" "Arch-Update 2.0.2" "Manuel de Arch-Update"

.SH NAME
arch-update.conf \- fichier de configuration pour arch-update.
Expand Down Expand Up @@ -43,6 +43,10 @@ Nombre d'anciennes versions de paquets à conserver dans le cache de pacman. La
.B KeepUninstalledPackages=[Num]
Nombre de versions de paquets désinstallés à conserver dans le cache de pacman. La valeur par défaut est 0.

.TP
.B PrivilegeElevationCommand=[Cmd]
Commande à utiliser pour l'élévation de privilège. Les options valides sont sudo, doas ou run0. Si cette option n'est pas spécifiée, Arch-Update utilisera la première commande disponible dans l'odre suivant: sudo, doas puis run0.

.SH VOIR AUSSI
.BR arch-update (1)

Expand Down
Loading

0 comments on commit fbd3ca2

Please sign in to comment.