scripts-bash/local/share/man/play_tophoraire.1

82 lines
2.2 KiB
Groff
Raw Normal View History

2023-11-19 18:04:34 +01:00
.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "" "" "" "" ""
.hy
.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]
.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
2023-11-19 18:04:34 +01:00
.IP \[bu] 2
Aucune option n\[cq]est requise pour exécuter le script.
.SH CONFIGURATION
2023-11-19 18:04:34 +01:00
.PP
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
2023-11-19 18:04:34 +01:00
.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
2023-11-19 18:04:34 +01:00
.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
2023-11-19 18:04:34 +01:00
.PP
Le script obtient l\[cq]heure actuelle et crée un message d\[cq]annonce
contenant l\[cq]heure.
Il utilise ensuite la commande \f[V]espeak-ng\f[R] pour annoncer
l\[cq]heure en français.
.SH EXEMPLES
.PP
Pour exécuter le script sans aucune option :
.IP
.nf
\f[C]
top_horaire
\f[R]
.fi
.SH AUTEUR
2023-11-19 18:04:34 +01:00
.PP
Ce script a été créé par Cédric Abonnel.
.SH RAPPORT D\[cq]ERREURS
2023-11-19 18:04:34 +01:00
.PP
Pour signaler des erreurs ou des problèmes :
https://git.abonnel.fr/cedricAbonnel/scripts-bash
.SH VOIR AUSSI
.IP \[bu] 2
espeak-ng(1) (https://manpages.debian.org/stretch/espeak-ng/espeak-ng.1.en.html)
.IP \[bu] 2
paplay(1) (https://manpages.debian.org/stretch/pulseaudio/paplay.1.en.html)
.SH REMARQUES
.PP
Ce script est fourni tel quel, sans aucune garantie.
Vous êtes libre de le modifier et de le distribuer selon les termes de
la licence applicable.