Mise à jour de la doc

README.md

@@ -10,65 +10,7 @@ Le script `install.sh` a été créé pour automatiser le processus de copie de
 
 Toutes les opérations et les messages d'erreur sont enregistrés dans un fichier journal (`~/log/copy_files.log`) situé dans le répertoire personnel de l'utilisateur. Le journal comprend la date, l'heure, le numéro de processus (PID) et les messages d'exécution du script.
 
-Voici un aperçu des commandes.
+Le dossier `local/share/doc` contient la documentation de chaque script.
-
-## convertPDF
-Create a new PDF with `pdf2cairo` and `convert`, create a file text with OCR `Tresseract`, and create an other PDF file with `gs` tool. Apply on all pdf files in the current folder.
-
-## run_music_background
-Play audio file with the play program, all the musics present in the desinged folder. In the script, indicate the music folder and the desired volume.
-![img/scr_run_music_background_exemple.png](img/scr_run_music_background_exemple.png)
-
-## tophoraire
-Play audio file and vocal speech. To program with cron task.
-
-```0 * * * * /home/cedric24c/scripts/tophoraire >/dev/null 2>&1```
-
-
-## generate_playlist
-Générateur de Playlist M3U
-
-Ce script Bash vous permet de générer facilement une playlist au format M3U à partir des fichiers audio les plus récents dans un répertoire donné. Vous pouvez personnaliser le nombre de fichiers à inclure dans la playlist, le répertoire à scanner, et le nom du fichier de sortie.
-
-### Utilisation
-
-Pour utiliser ce script, suivez ces étapes :
-
-1. Assurez-vous que vous avez les permissions d'exécution pour le script en utilisant la commande suivante :
-   ```bash
-   chmod +x generate_playlist
-   ```
-
-2. Exécutez le script en utilisant la commande suivante avec les options appropriées :
-   ```bash
-   generate_playlist -n <nombre de fichiers> -d <répertoire> -o <fichier de sortie>
-   ```
-
-   - `-n` : Le nombre de fichiers à inclure dans la playlist (par défaut : 100).
-   - `-d` : Le répertoire à scanner (y compris les sous-répertoires) (par défaut : le répertoire actuel).
-   - `-o` : Le nom du fichier M3U de sortie (par défaut : un fichier dans le répertoire de la musique de l'utilisateur).
-
-3. Le script générera la playlist M3U avec les fichiers audio les plus récents et vous indiquera l'emplacement du fichier de sortie.
-
-### Exemples
-
-- Générer une playlist M3U avec les 50 fichiers audio les plus récents dans le répertoire `/chemin/vers/ma/musique` et enregistrer le fichier en tant que `playlist.m3u` :
-   ```bash
-   ./generate_playlist -n 50 -d /chemin/vers/ma/musique -o playlist.m3u
-   ```
-
-- Générer une playlist M3U avec les 25 fichiers audio les plus récents dans le répertoire par défaut et enregistrer le fichier dans le répertoire de musique de l'utilisateur :
-   ```bash
-   ./generate_playlist -n 25 -o ~/playlist.m3u
-   ```
-
-### Remarques
-
-- Assurez-vous que les fichiers audio dans le répertoire spécifié ont les extensions suivantes : `.mp3`, `.opus`, `.ogg`, `.m4a`.
-- Si le répertoire de musique de l'utilisateur est défini dans le fichier `~/.config/user-dirs.dirs`, le script utilisera cet emplacement par défaut pour enregistrer le fichier M3U.
-
-
-
 
 
 

files_local-bin

@@ -1,8 +1,7 @@
+play_tophaire.sh
 mkv_extract.sh
 generate_playlist.sh
 install_check_update.sh
 convertPDF.sh
-run_music_background.sh
-tophoraire.sh
 check_domain_cert.sh
 convertMKV.sh

files_local-share-doc

@@ -1 +1,4 @@
+play_tophoraire.1.md
+random_music_player.1.md
 playlist_gen.1.md
+convertPDF

files_local-share-man

@@ -1 +1,4 @@
+convertPDF
 playlist_gen.1
+random_music_player.1
+play_tophoraire.1

install.sh

@@ -38,7 +38,6 @@ log "Debut du script"
 create_dir ${log_dir}
 
 log "Rafraichissement des listes de fichiers"
-./prep.sh
 
 
 
@@ -86,7 +85,7 @@ fi
 ## Declarations ##
 
 # Spécifier le chemin du répertoire ~/.local/bin
-destination_dir="$HOME/.local/share/man"
+destination_dir="$HOME/.local/share/man/man1"
 
 # Spécifier le chemin du répertoire du dépôt Git local
 source_dir="local/share/man"

local/bin/play_tophaire.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+## Read config file or create/update
+config_filename=~/.config/$(basename "${0}")
+test -f "${config_filename}" && . "${config_filename}" || echo "# Fichier de configuration créé $(date +%c)" | tee "${config_filename}"
+
+### edit directory path music background
+if [[ -z "${jingle_tophoraire+set}" ]]; then
+    jingle_tophoraire=$(xdg-user-dir MUSIC)/jingles/t1.top_h_hkc.mp3
+    echo "jingle_tophoraire=${jingle_tophoraire}" | tee -a "${config_filename}"
+fi
+
+
+# Lecture du jingle en arrière-plan
+echo "$jingle_tophoraire"
+paplay "$jingle_tophoraire" >/dev/null 2>&1 &
+
+# Annonce de l'heure actuelle en utilisant espeak-ng
+heure_actuelle=$(date +'%k')
+message_annonce="top horaire. $heure_actuelle heures"
+espeak-ng "$message_annonce" -v fr+f5 -p 25 -s 135

local/bin/tophoraire.sh

@@ -1,2 +0,0 @@
-play /home/cedric24c/Musique/jingles/t1.top_h_hkc.mp3 >/dev/null 2>&1 &
-espeak-ng "top horaire. $(date +\'%k\') heures" -v fr+f5 -p 25 -s 135

local/share/doc/convertPDF

@@ -0,0 +1,23 @@
+convertPDF(1) - Compresse des fichiers PDF pour gagner en volume et génère le résultat d'un OCR
+
+## SYNOPSIS
+**convertPDF**
+
+## DESCRIPTION
+Ce script convertit des fichiers PDF en d'autres formats tels que JPG, TXT, et PDF en utilisant des outils comme `pdftocairo`, `pdftotext`, `tesseract`, et `convert`.
+
+## COMPATIBILITÉ
+
+Ce script est compatible avec les fichiers PDF (Portable Document Format).
+
+## EXEMPLE
+Convertir plusieurs fichiers PDF présent dans le dossier et sous-dossiers courants :
+   ```
+   convertPDF
+   ```
+
+## AUTEUR
+Ce script a été créé par Cédric Abonnel.
+
+## RAPPORT D'ERREURS
+Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash

local/share/doc/play_tophoraire.1.md

@@ -0,0 +1,54 @@
+# NOM
+
+top_horaire - Gestion du jingle et de l'annonce de l'heure
+
+# SYNOPSIS
+
+**top_horaire** [OPTION]
+
+# DESCRIPTION
+
+Le script **top_horaire** permet de gérer la lecture d'un jingle en arrière-plan suivi de l'annonce de l'heure actuelle en utilisant espeak-ng.
+
+## OPTIONS
+
+- Aucune option n'est requise pour exécuter le script.
+
+## CONFIGURATION
+
+Le script peut lire la configuration à partir d'un fichier de configuration situé dans le répertoire `~/.config/`. Si le fichier de configuration n'existe pas, il sera créé avec un commentaire indiquant la date de création.
+
+## CONFIGURATION DU CHEMIN DU JINGLE
+
+Le chemin du jingle est configuré par la variable `jingle_tophoraire`. Si cette variable n'est pas définie dans le fichier de configuration, elle sera initialisée avec le chemin par défaut du jingle.
+
+## LECTURE DU JINGLE EN ARRIÈRE-PLAN
+
+Une fois le chemin du jingle configuré, le script utilise la commande `paplay` pour lire le jingle en arrière-plan.
+
+## ANNONCE DE L'HEURE ACTUELLE
+
+Le script obtient l'heure actuelle et crée un message d'annonce contenant l'heure. Il utilise ensuite la commande `espeak-ng` pour annoncer l'heure en français.
+
+# EXEMPLES
+
+Pour exécuter le script sans aucune option :
+
+```
+top_horaire
+```
+
+## AUTEUR
+Ce script a été créé par Cédric Abonnel.
+
+## RAPPORT D'ERREURS
+Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash
+
+# VOIR AUSSI
+
+- [espeak-ng(1)](https://manpages.debian.org/stretch/espeak-ng/espeak-ng.1.en.html)
+- [paplay(1)](https://manpages.debian.org/stretch/pulseaudio/paplay.1.en.html)
+
+# REMARQUES
+
+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.

local/share/doc/playlist_gen.1.md

@@ -46,11 +46,5 @@ Ce script a été écrit par Cédric Abonnel.
 
 ## RAPPORTS D'ERREURS
 
-Pour signaler des erreurs ou des problèmes, veuillez contacter a5l.scripts_bash@acemail.fr.
+Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash
-
-## VOIR AUSSI
-
-- [man(1)](https://linux.die.net/man/1/man)
-- [find(1)](https://linux.die.net/man/1/find)
-- [stat(1)](https://linux.die.net/man/1/stat)
 

local/share/doc/random_music_player.1.md

@@ -0,0 +1,39 @@
+random_music_player(1) - Lecteur de musique aléatoire en ligne de commande
+
+## Synopsis
+**random_music_player** [OPTIONS]
+
+## Description
+Le script **random_music_player** est un lecteur de musique aléatoire en ligne de commande qui lit des fichiers audio à partir d'un répertoire spécifié.
+
+## Options
+- Aucune option n'est requise.
+
+## Configuration
+Le script utilise un fichier de configuration situé à `~/.config/random_music_player`. Si ce fichier de configuration n'existe pas, il sera créé avec les paramètres par défaut suivants :
+```shell
+# Fichier de configuration créé [date de création]
+path_music_files=~/Music
+volume=0.06
+```
+
+Vous pouvez éditer ce fichier de configuration pour personnaliser les réglages du lecteur de musique.
+
+## Utilisation
+Pour utiliser le lecteur de musique aléatoire, exécutez simplement le script sans aucune option. Il sélectionnera au hasard un fichier audio à partir du répertoire spécifié dans le fichier de configuration et le lira.
+
+```shell
+random_music_player
+```
+
+## Exemple
+```shell
+$ random_music_player
+```
+
+## Auteur
+Ce script a été créé par Cédric Abonnel.
+
+## Rapport d'erreurs
+Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash
+

local/share/man/convertPDF

@@ -0,0 +1,44 @@
+.\" 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
+.PP
+convertPDF(1) - Compresse des fichiers PDF pour gagner en volume et
+génère le résultat d\[cq]un OCR
+.SS SYNOPSIS
+.PP
+\f[B]convertPDF\f[R]
+.SS DESCRIPTION
+.PP
+Ce script convertit des fichiers PDF en d\[cq]autres formats tels que
+JPG, TXT, et PDF en utilisant des outils comme \f[V]pdftocairo\f[R],
+\f[V]pdftotext\f[R], \f[V]tesseract\f[R], et \f[V]convert\f[R].
+.SS COMPATIBILITÉ
+.PP
+Ce script est compatible avec les fichiers PDF (Portable Document
+Format).
+.SS EXEMPLE
+.PP
+Convertir plusieurs fichiers PDF présent dans le dossier et
+sous-dossiers courants : \f[V]convertPDF\f[R]
+.SS AUTEUR
+.PP
+Ce script a été créé par Cédric Abonnel.
+.SS RAPPORT D\[cq]ERREURS
+.PP
+Pour signaler des erreurs ou des problèmes :
+https://git.abonnel.fr/cedricAbonnel/scripts-bash

local/share/man/play_tophoraire.1

@@ -0,0 +1,81 @@
+.\" 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.
+.SS OPTIONS
+.IP \[bu] 2
+Aucune option n\[cq]est requise pour exécuter le script.
+.SS CONFIGURATION
+.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.
+.SS 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.
+.SS 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.
+.SS 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.
+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
+.SS AUTEUR
+.PP
+Ce script a été créé par Cédric Abonnel.
+.SS RAPPORT D\[cq]ERREURS
+.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.

local/share/man/playlist_gen.1

@@ -79,12 +79,5 @@ playlist_gen -n 25 -d /chemin/vers/repertoire
 Ce script a été écrit par Cédric Abonnel.
 .SS RAPPORTS D\[cq]ERREURS
 .PP
-Pour signaler des erreurs ou des problèmes, veuillez contacter
+Pour signaler des erreurs ou des problèmes :
-a5l.scripts_bash\[at]acemail.fr.
+https://git.abonnel.fr/cedricAbonnel/scripts-bash
-.SS VOIR AUSSI
-.IP \[bu] 2
-man(1) (https://linux.die.net/man/1/man)
-.IP \[bu] 2
-find(1) (https://linux.die.net/man/1/find)
-.IP \[bu] 2
-stat(1) (https://linux.die.net/man/1/stat)

local/share/man/random_music_player.1

@@ -0,0 +1,75 @@
+.\" 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
+.PP
+random_music_player(1) - Lecteur de musique aléatoire en ligne de
+commande
+.SS Synopsis
+.PP
+\f[B]random_music_player\f[R] OPTIONS
+.SS Description
+.PP
+Le script \f[B]random_music_player\f[R] est un lecteur de musique
+aléatoire en ligne de commande qui lit des fichiers audio à partir
+d\[cq]un répertoire spécifié.
+.SS Options
+.IP \[bu] 2
+Aucune option n\[cq]est requise.
+.SS Configuration
+.PP
+Le script utilise un fichier de configuration situé à
+\f[V]\[ti]/.config/random_music_player\f[R].
+Si ce fichier de configuration n\[cq]existe pas, il sera créé avec les
+paramètres par défaut suivants :
+.IP
+.nf
+\f[C]
+# Fichier de configuration créé [date de création]
+path_music_files=\[ti]/Music
+volume=0.06
+\f[R]
+.fi
+.PP
+Vous pouvez éditer ce fichier de configuration pour personnaliser les
+réglages du lecteur de musique.
+.SS Utilisation
+.PP
+Pour utiliser le lecteur de musique aléatoire, exécutez simplement le
+script sans aucune option.
+Il sélectionnera au hasard un fichier audio à partir du répertoire
+spécifié dans le fichier de configuration et le lira.
+.IP
+.nf
+\f[C]
+random_music_player
+\f[R]
+.fi
+.SS Exemple
+.IP
+.nf
+\f[C]
+$ random_music_player
+\f[R]
+.fi
+.SS Auteur
+.PP
+Ce script a été créé par Cédric Abonnel.
+.SS Rapport d\[cq]erreurs
+.PP
+Pour signaler des erreurs ou des problèmes :
+https://git.abonnel.fr/cedricAbonnel/scripts-bash