Skip to content

Commit

Permalink
doc: Various documentation improvements (#210)
Browse files Browse the repository at this point in the history
Improve wording in various parts of the documentation and add the missing documentation for the `--show-config` option and the new 'check services' feature in the main script's help message.
  • Loading branch information
Antiz96 authored Jul 8, 2024
1 parent 988ad2d commit 7a4eb4a
Show file tree
Hide file tree
Showing 7 changed files with 228 additions and 202 deletions.
2 changes: 1 addition & 1 deletion README-fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ Options :
-d, --devel Inclure les mises à jour des paquets de développement AUR
-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`)
-D, --debug Afficher les traces de débogage
--gen-config Générer un fichier de configuration par défaut/exemple (voir la page de manuel arch-update.conf(5) pour plus de détails)
--gen-config Générer un fichier de configuration `arch-update.conf` par défaut/exemple (voir la page de manuel arch-update.conf(5) pour plus de détails)
--show-config Afficher le fichier de configuration `arch-update.conf` actuellement utilisé (s'il existe)
--edit-config Editer le fichier de configuration `arch-update.conf` actuellement utilisé (s'il existe)
--tray Lancer l'applet systray d'Arch-Update, vous pouvez optionnellement ajouter l'argument `--enable` pour la démarrer automatiquement au démarrage du système.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ Options:
-d, --devel Include AUR development packages updates
-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`)
-D, --debug Display debug traces
--gen-config Generate a default/example configuration file (see the arch-update.conf(5) man page for more details)
--gen-config Generate a default/example `arch-update.conf` configuration file (see the arch-update.conf(5) man page for more details)
--show-config Display the `arch-update.conf` configuration file currently used (if it exists)
--edit-config Edit the `arch-update.conf` configuration file currently used (if it exists)
--tray Launch the Arch-Update systray applet, you can optionally add the `--enable` argument to start it automatically at boot.
Expand Down
2 changes: 1 addition & 1 deletion doc/man/arch-update.1
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Display debug traces.

.TP
.B \-\-gen\-config
.RB "Generate a default/example configuration file (see the " "arch-update.conf(5) " "man page for more details)."
.RB "Generate a default/example " "arch-update.conf " "configuration file (see the " "arch-update.conf(5) " "man page for more details)."

.TP
.B \-\-show\-config
Expand Down
2 changes: 1 addition & 1 deletion doc/man/fr/arch-update.1
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Afficher les traces de débogage.

.TP
.B \-\-gen\-config
.RB "Générer un fichier de configuration par défaut/exemple (voir la page de manuel " "arch-update.conf(5) " "pour plus de détails)."
.RB "Générer un fichier de configuration " "arch-update.conf " "par défaut/exemple (voir la page de manuel " "arch-update.conf(5) " "pour plus de détails)."

.TP
.B \-\-show\-config
Expand Down
Loading

0 comments on commit 7a4eb4a

Please sign in to comment.