diff --git a/local/share/doc/castopod_update.1.md b/local/share/doc/castopod_update.1.md index 4f81090..2af02dd 100644 --- a/local/share/doc/castopod_update.1.md +++ b/local/share/doc/castopod_update.1.md @@ -1,18 +1,21 @@ +\ + # NOM castopod_update - Mise à jour de CASTOPOD # SYNOPSIS -**castopod_update** [OPTION] +castopod_update # DESCRIPTION -Le script **castopod_update** permet de mettre à jour le dossier Web de CASTOPOD en utilisant le fichier de mise à jour au format ZIP fourni. +Le script **castopod_update** permet de mettre à jour le dossier Web de +CASTOPOD en utilisant le fichier de mise à jour au format ZIP fourni. # OPTIONS -- Aucune option n'est nécessaire pour exécuter le script. +Aucune option n'est nécessaire pour exécuter le script. # CONFIGURATION @@ -22,15 +25,19 @@ Le dossier Web de CASTOPOD doit être nommé `castopod`. Le script doit être positionné au même niveau que le dossier Web de CASTOPOD. -Le dossier `save_castopod` contient une copie des données de CASTOPOD, qui est rafraîchie au début de l'exécution du script. S'il n'existe pas, il sera créé. +Le dossier `save_castopod` contient une copie des données de CASTOPOD, qui est +rafraîchie au début de l'exécution du script. S'il n'existe pas, il sera créé. -L'archive de mise à jour doit être spécifiquement nommée `castopod*.zip` et doit être positionnée au même niveau que le script et le dossier Web de CASTOPOD. +L'archive de mise à jour doit être spécifiquement nommée `castopod*.zip` et +doit être positionnée au même niveau que le script et le dossier Web de +CASTOPOD. Le script utilise `php8.1` pour effectuer des tâches de maintenance. # PRÉREQUIS -Téléchargez l'archive de mise à jour disponible sur le site https://castopod.org/. +Téléchargez l'archive de mise à jour disponible sur le site +https://castopod.org/. # EXEMPLES @@ -40,22 +47,26 @@ Pour exécuter le script sans aucune option : castopod_update ``` +# AUTEURS + +Cédric Abonnel - \ + # VERSIONS -Version 23.12.14 -- Suppression de l'archive TAR du dossier `save_castopod`. +-23.12.14 +: Suppression de l'archive TAR du dossier `save_castopod`. -Version 23.12.1 -- Messages des logs améliorés avec plus de détails lors de l'utilisation de 'cp'. +-23.12.1 +: Messages des logs améliorés avec plus de détails lors de l'utilisation de + `cp`. -# 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 +Pour signaler des erreurs ou des problèmes : +https://git.abonnel.fr/cedricAbonnel/scripts-bash # 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. \ No newline at end of file +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. \ No newline at end of file diff --git a/local/share/doc/convertPDF.1.md b/local/share/doc/convertPDF.1.md index 4a9f512..ef4f204 100644 --- a/local/share/doc/convertPDF.1.md +++ b/local/share/doc/convertPDF.1.md @@ -1,24 +1,39 @@ -convertPDF(1) - Compresse des fichiers PDF pour gagner en volume et génère le résultat d'un OCR + +# NOM + +convertPDF - Compresse des fichiers PDF pour gagner en volume et génère le résultat d'un OCR # SYNOPSIS -**convertPDF** + +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`. +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 +# EXEMPLES + Convertir plusieurs fichiers PDF présent dans le dossier et sous-dossiers courants : ``` convertPDF ``` -# AUTEUR -Ce script a été créé par Cédric Abonnel. +# VERSIONS + +-23.12.1 +: Version originale + +# AUTEURS + +Cédric Abonnel - \ # RAPPORT D'ERREURS -Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash + +Pour signaler des erreurs ou des problèmes : +https://git.abonnel.fr/cedricAbonnel/scripts-bash diff --git a/local/share/doc/play_tophoraire.1.md b/local/share/doc/play_tophoraire.1.md index a177c66..cf2fb40 100644 --- a/local/share/doc/play_tophoraire.1.md +++ b/local/share/doc/play_tophoraire.1.md @@ -1,33 +1,30 @@ +\ + # NOM top_horaire - Gestion du jingle et de l'annonce de l'heure # SYNOPSIS -**top_horaire** [OPTION] +top_horaire # 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. +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. +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 @@ -38,10 +35,17 @@ Pour exécuter le script sans aucune option : top_horaire ``` -# AUTEUR -Ce script a été créé par Cédric Abonnel. +# AUTEURS + +Cédric Abonnel - \ + +# VERSIONS + +-23.12.1 +: Version originale # RAPPORT D'ERREURS + Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash # VOIR AUSSI diff --git a/local/share/doc/playlist_gen.1.md b/local/share/doc/playlist_gen.1.md index a4349fa..c53c2a2 100644 --- a/local/share/doc/playlist_gen.1.md +++ b/local/share/doc/playlist_gen.1.md @@ -1,20 +1,31 @@ -# playlist_gen(1) - Génère une playlist M3U à partir de fichiers audio +\ + +# NOM + +playlist_gen - Génère une playlist M3U à partir de fichiers audio # SYNOPSIS -**playlist_gen** [-n \] [-d \] [-o \] +playlist_gen [-n \] [-d \] [-o \] # DESCRIPTION -**playlist_gen** est un script Bash qui permet de générer une playlist M3U à partir de fichiers audio situés dans un répertoire spécifié. +playlist_gen est un script Bash qui permet de générer une playlist M3U à partir +de fichiers audio situés dans un répertoire spécifié. # OPTIONS -- **-n \** : Spécifie le nombre de fichiers à inclure dans la playlist. Par défaut, le nombre de fichiers est 100. +-n +: Spécifie le nombre de fichiers à inclure dans la playlist. Par défaut, le +nombre de fichiers est 100. -- **-d \** : Spécifie le répertoire à scanner pour les fichiers audio. Par défaut, le répertoire actuel est utilisé. +-d +: Spécifie le répertoire à scanner pour les fichiers audio. Par défaut, le + répertoire actuel est utilisé. -- **-o \** : Spécifie le nom du fichier M3U de sortie. Par défaut, le fichier est créé dans le répertoire de la musique de l'utilisateur. +-o +: Spécifie le nom du fichier M3U de sortie. Par défaut, le fichier est créé + dans le répertoire de la musique de l'utilisateur. # UTILISATION @@ -40,9 +51,14 @@ Ce script est compatible avec les fichiers audio aux formats MP3, Opus, Ogg et M playlist_gen -n 25 -d /chemin/vers/repertoire ``` -# AUTEUR +# AUTEURS -Ce script a été écrit par Cédric Abonnel. +Cédric Abonnel - \ + +# VERSIONS + +-23.12.1 +: Version originale # RAPPORTS D'ERREURS diff --git a/local/share/doc/random_music_player.1.md b/local/share/doc/random_music_player.1.md index 243b30d..be99724 100644 --- a/local/share/doc/random_music_player.1.md +++ b/local/share/doc/random_music_player.1.md @@ -1,40 +1,64 @@ -random_music_player(1) - Lecteur de musique aléatoire en ligne de commande +\ + +# NOM + +random_music_player - Lecteur de musique aléatoire en ligne de commande # SYNOPSIS -**random_music_player** [OPTIONS] + +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é. +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. + +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 : + +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. +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. + +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. +# VERSIONS -# RAPPORT D'ERREURS -Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash +-23.12.1 +: Version originale + +# AUTEURS + +Cédric Abonnel - \ + +# RAPPORT D'ERREUR + +Pour signaler des erreurs ou des problèmes : +https://git.abonnel.fr/cedricAbonnel/scripts-bash diff --git a/local/share/man/castopod_update.1 b/local/share/man/castopod_update.1 index 5046c95..5ab0eed 100644 --- a/local/share/man/castopod_update.1 +++ b/local/share/man/castopod_update.1 @@ -16,19 +16,23 @@ .\} .TH "" "" "" "" "" .hy +.PP +.PD 0 +.P +.PD .SH NOM .PP castopod_update - Mise à jour de CASTOPOD .SH SYNOPSIS .PP -\f[B]castopod_update\f[R] [OPTION] +castopod_update .SH DESCRIPTION .PP Le script \f[B]castopod_update\f[R] permet de mettre à jour le dossier Web de CASTOPOD en utilisant le fichier de mise à jour au format ZIP fourni. .SH OPTIONS -.IP \[bu] 2 +.PP Aucune option n\[cq]est nécessaire pour exécuter le script. .SH CONFIGURATION .PP @@ -62,16 +66,17 @@ Pour exécuter le script sans aucune option : castopod_update \f[R] .fi +.SH AUTEURS +.PP +Cédric Abonnel - .SH VERSIONS -.PP -Version 23.12.14 - Suppression de l\[cq]archive TAR du dossier -\f[V]save_castopod\f[R]. -.PP -Version 23.12.1 - Messages des logs améliorés avec plus de détails lors -de l\[cq]utilisation de `cp'. -.SH AUTEUR -.PP -Ce script a été créé par Cédric Abonnel. +.TP +-23.12.14 +Suppression de l\[cq]archive TAR du dossier \f[V]save_castopod\f[R]. +.TP +-23.12.1 +Messages des logs améliorés avec plus de détails lors de +l\[cq]utilisation de \f[V]cp\f[R]. .SH RAPPORT D\[cq]ERREURS .PP Pour signaler des erreurs ou des problèmes : diff --git a/local/share/man/convertPDF.1 b/local/share/man/convertPDF.1 index 368bfc6..ff95633 100644 --- a/local/share/man/convertPDF.1 +++ b/local/share/man/convertPDF.1 @@ -16,12 +16,13 @@ .\} .TH "" "" "" "" "" .hy +.SH NOM .PP -convertPDF(1) - Compresse des fichiers PDF pour gagner en volume et -génère le résultat d\[cq]un OCR +convertPDF - Compresse des fichiers PDF pour gagner en volume et génère +le résultat d\[cq]un OCR .SH SYNOPSIS .PP -\f[B]convertPDF\f[R] +convertPDF .SH DESCRIPTION .PP Ce script convertit des fichiers PDF en d\[cq]autres formats tels que @@ -31,13 +32,17 @@ JPG, TXT, et PDF en utilisant des outils comme \f[V]pdftocairo\f[R], .PP Ce script est compatible avec les fichiers PDF (Portable Document Format). -.SH EXEMPLE +.SH EXEMPLES .PP Convertir plusieurs fichiers PDF présent dans le dossier et sous-dossiers courants : \f[V]convertPDF\f[R] -.SH AUTEUR +.SH VERSIONS +.TP +-23.12.1 +Version originale +.SH AUTEURS .PP -Ce script a été créé par Cédric Abonnel. +Cédric Abonnel - .SH RAPPORT D\[cq]ERREURS .PP Pour signaler des erreurs ou des problèmes : diff --git a/local/share/man/play_tophoraire.1 b/local/share/man/play_tophoraire.1 index 7a0f518..c8f5eb4 100644 --- a/local/share/man/play_tophoraire.1 +++ b/local/share/man/play_tophoraire.1 @@ -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 - +.SH VERSIONS +.TP +-23.12.1 +Version originale .SH RAPPORT D\[cq]ERREURS .PP Pour signaler des erreurs ou des problèmes : diff --git a/local/share/man/playlist_gen.1 b/local/share/man/playlist_gen.1 index 71a0883..c4270f6 100644 --- a/local/share/man/playlist_gen.1 +++ b/local/share/man/playlist_gen.1 @@ -16,28 +16,33 @@ .\} .TH "" "" "" "" "" .hy -.SH playlist_gen(1) - Génère une playlist M3U à partir de fichiers audio +.PP +.PD 0 +.P +.PD +.SH NOM +.PP +playlist_gen - Génère une playlist M3U à partir de fichiers audio .SH SYNOPSIS .PP -\f[B]playlist_gen\f[R] [-n ] [-d ] [-o -] +playlist_gen [-n ] [-d ] [-o ] .SH DESCRIPTION .PP -\f[B]playlist_gen\f[R] est un script Bash qui permet de générer une -playlist M3U à partir de fichiers audio situés dans un répertoire -spécifié. +playlist_gen est un script Bash qui permet de générer une playlist M3U à +partir de fichiers audio situés dans un répertoire spécifié. .SH OPTIONS -.IP \[bu] 2 -\f[B]-n \f[R] : Spécifie le nombre de fichiers à -inclure dans la playlist. +.TP +-n +Spécifie le nombre de fichiers à inclure dans la playlist. Par défaut, le nombre de fichiers est 100. -.IP \[bu] 2 -\f[B]-d \f[R] : Spécifie le répertoire à scanner pour les -fichiers audio. +.TP +-d +Spécifie le répertoire à scanner pour les fichiers audio. Par défaut, le répertoire actuel est utilisé. -.IP \[bu] 2 -\f[B]-o \f[R] : Spécifie le nom du fichier M3U de -sortie. +.TP +-o +Spécifie le nom du fichier M3U de sortie. Par défaut, le fichier est créé dans le répertoire de la musique de l\[cq]utilisateur. .SH UTILISATION @@ -74,9 +79,13 @@ playlist_gen -n 25 -d /chemin/vers/repertoire \f[R] .fi .RE -.SH AUTEUR +.SH AUTEURS .PP -Ce script a été écrit par Cédric Abonnel. +Cédric Abonnel - +.SH VERSIONS +.TP +-23.12.1 +Version originale .SH RAPPORTS D\[cq]ERREURS .PP Pour signaler des erreurs ou des problèmes : diff --git a/local/share/man/random_music_player.1 b/local/share/man/random_music_player.1 index 9cce92e..175a615 100644 --- a/local/share/man/random_music_player.1 +++ b/local/share/man/random_music_player.1 @@ -17,18 +17,22 @@ .TH "" "" "" "" "" .hy .PP -random_music_player(1) - Lecteur de musique aléatoire en ligne de -commande +.PD 0 +.P +.PD +.SH NOM +.PP +random_music_player - Lecteur de musique aléatoire en ligne de commande .SH SYNOPSIS .PP -\f[B]random_music_player\f[R] OPTIONS +random_music_player [options] .SH 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é. .SH OPTIONS -.IP \[bu] 2 +.PP Aucune option n\[cq]est requise. .SH CONFIGURATION .PP @@ -66,10 +70,14 @@ random_music_player $ random_music_player \f[R] .fi -.SH AUTEUR +.SH VERSIONS +.TP +-23.12.1 +Version originale +.SH AUTEURS .PP -Ce script a été créé par Cédric Abonnel. -.SH RAPPORT D\[cq]ERREURS +Cédric Abonnel - +.SH RAPPORT D\[cq]ERREUR .PP Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash diff --git a/prep.sh b/prep.sh index ec1c18b..21d7595 100755 --- a/prep.sh +++ b/prep.sh @@ -122,14 +122,21 @@ ls local/share/man/ -c1 >.config/files_local-share-man for fichier in local/share/doc/*.md; do echo "Résumé pour $fichier :" description_found=0 + empty_line_encountered=false + description_started=0 while IFS= read -r ligne; do - if [ "$description_found" -eq 1 ] && [ -n "$ligne" ]; then + if [ "$description_found" -eq 1 ] && [ "$description_started" -eq 1 ] && [ -n "$ligne" ]; then echo "$ligne" - break + elif [ "$description_found" -eq 1 ] && [ "$description_started" -eq 0 ] && [ -n "$ligne" ]; then + echo "$ligne" + description_started=1 + elif [ "$description_found" -eq 1 ] && [ "$description_started" -eq 1 ] && [ ! -n "$ligne" ]; then + break elif [ "$ligne" = "# DESCRIPTION" ]; then description_found=1 fi + done < "$fichier" echo "..."