Uniformisation des documentations
This commit is contained in:
@@ -16,19 +16,23 @@
|
||||
.\}
|
||||
.TH "" "" "" "" ""
|
||||
.hy
|
||||
.PP
|
||||
.PD 0
|
||||
.P
|
||||
.PD
|
||||
.SH NOM
|
||||
.PP
|
||||
top_horaire - Gestion du jingle et de l\[cq]annonce de l\[cq]heure
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\f[B]top_horaire\f[R] [OPTION]
|
||||
top_horaire
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Le script \f[B]top_horaire\f[R] permet de gérer la lecture d\[cq]un
|
||||
jingle en arrière-plan suivi de l\[cq]annonce de l\[cq]heure actuelle en
|
||||
utilisant espeak-ng.
|
||||
.SH OPTIONS
|
||||
.IP \[bu] 2
|
||||
.PP
|
||||
Aucune option n\[cq]est requise pour exécuter le script.
|
||||
.SH CONFIGURATION
|
||||
.PP
|
||||
@@ -36,18 +40,15 @@ Le script peut lire la configuration à partir d\[cq]un fichier de
|
||||
configuration situé dans le répertoire \f[V]\[ti]/.config/\f[R].
|
||||
Si le fichier de configuration n\[cq]existe pas, il sera créé avec un
|
||||
commentaire indiquant la date de création.
|
||||
.SH CONFIGURATION DU CHEMIN DU JINGLE
|
||||
.PP
|
||||
Le chemin du jingle est configuré par la variable
|
||||
\f[V]jingle_tophoraire\f[R].
|
||||
Si cette variable n\[cq]est pas définie dans le fichier de
|
||||
configuration, elle sera initialisée avec le chemin par défaut du
|
||||
jingle.
|
||||
.SH LECTURE DU JINGLE EN ARRIÈRE-PLAN
|
||||
.PP
|
||||
Une fois le chemin du jingle configuré, le script utilise la commande
|
||||
\f[V]paplay\f[R] pour lire le jingle en arrière-plan.
|
||||
.SH ANNONCE DE L\[cq]HEURE ACTUELLE
|
||||
.PP
|
||||
Le script obtient l\[cq]heure actuelle et crée un message d\[cq]annonce
|
||||
contenant l\[cq]heure.
|
||||
@@ -62,9 +63,13 @@ Pour exécuter le script sans aucune option :
|
||||
top_horaire
|
||||
\f[R]
|
||||
.fi
|
||||
.SH AUTEUR
|
||||
.SH AUTEURS
|
||||
.PP
|
||||
Ce script a été créé par Cédric Abonnel.
|
||||
Cédric Abonnel - <canl.sb2023\[at]acemail.fr>
|
||||
.SH VERSIONS
|
||||
.TP
|
||||
-23.12.1
|
||||
Version originale
|
||||
.SH RAPPORT D\[cq]ERREURS
|
||||
.PP
|
||||
Pour signaler des erreurs ou des problèmes :
|
||||
|
||||
Reference in New Issue
Block a user