Uniformisation des documentations

Uniformisation des pages manuels
Changes to be committed: modified: .config/files_local-share-doc modified: .config/files_local-share-man modified: local/share/doc/castopod_update.1.md modified: local/share/doc/convertPDF.1.md modified: local/share/doc/play_tophoraire.1.md modified: local/share/doc/playlist_gen.1.md modified: local/share/doc/random_music_player.1.md modified: local/share/man/castopod_update.1 modified: local/share/man/convertPDF.1 modified: local/share/man/play_tophoraire.1 modified: local/share/man/playlist_gen.1 modified: local/share/man/random_music_player.1 modified: prep.sh
2023-12-14 21:29:06 +01:00 · 2023-12-14 21:27:49 +01:00 · 2023-12-14 17:29:52 +01:00 · 2023-12-14 17:27:50 +01:00
14 changed files with 288 additions and 155 deletions
--- a/.config/files_local-share-doc
+++ b/.config/files_local-share-doc
@ -1,5 +1,5 @@
-castopod_update.1.md
-convertPDF.1.md
 play_tophoraire.1.md
+convertPDF.1.md
+castopod_update.1.md
 random_music_player.1.md
 playlist_gen.1.md
--- a/.config/files_local-share-man
+++ b/.config/files_local-share-man
@ -1,5 +1,5 @@
 playlist_gen.1
 random_music_player.1
-play_tophoraire.1
-convertPDF.1
 castopod_update.1
+convertPDF.1
+play_tophoraire.1
--- a/README.md
+++ b/README.md
@ -8,7 +8,10 @@ Le script modifie également le chemin d'accès (PATH) de l'utilisateur ainsi qu
 Pour utiliser ces scripts, suivez ces étapes :

 1. Clonez ce dépôt Git.
+`git clone https://git.abonnel.fr/cedricAbonnel/scripts-bash.git`
+
 2. Exécutez le script en utilisant la commande `./install.sh`.
+Le script copiera les fichiers du programme, les pages d'aide et les paramètres dans votre dossier personnel. Il est possible qu'un compte `sudo `soit requis pour l'installation de binaires externes.

 Toutes les opérations et les messages d'erreur sont enregistrés dans un fichier journal (`~/log/a5l-scripts_bash-<date et heure de l'instant>-<PID>.log`) situé dans le répertoire personnel de l'utilisateur. Le journal inclut la date, l'heure et les détails de chaque opération.

--- a/local/share/doc/castopod_update.1.md
+++ b/local/share/doc/castopod_update.1.md
@ -1,20 +1,23 @@
+\
+
 # 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
+# OPTIONS

- Aucune option n'est nécessaire pour exécuter le script.
+Aucune option n'est nécessaire pour exécuter le script.

-## CONFIGURATION
+# CONFIGURATION

 Le script a sa propre configuration qui n'est pas modifiable.

@ -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
+# 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,23 +47,26 @@ Pour exécuter le script sans aucune option :
 castopod_update
 ```

+# AUTEURS
+
+Cédric Abonnel - \<canl.sb2023@acemail.fr>
+
 # VERSIONS

-Version 23.12.1
- Messages des logs améliorés avec plus de détails lors de l'utilisation de 'cp'.
+-23.12.14
+:   Suppression de l'archive TAR du dossier `save_castopod`.

-Version 23.12.14
- Suppression de l'archive TAR du dossier `save_castopod`.
+-23.12.1
+:    Messages des logs améliorés avec plus de détails lors de l'utilisation de 
+    `cp`.


-## AUTEUR
+# RAPPORT D'ERREURS

-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.
+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.
--- a/local/share/doc/convertPDF.1.md
+++ b/local/share/doc/convertPDF.1.md
@ -1,23 +1,39 @@
-convertPDF(1) - Compresse des fichiers PDF pour gagner en volume et génère le résultat d'un OCR

-## SYNOPSIS
-**convertPDF**
+# NOM

-## 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`.
+convertPDF - Compresse des fichiers PDF pour gagner en volume et génère le résultat d'un OCR

-## COMPATIBILITÉ
+# 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
+# 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

-## 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 - \<canl.sb2023@acemail.fr>
+
+# RAPPORT D'ERREURS
+
+Pour signaler des erreurs ou des problèmes : 
+https://git.abonnel.fr/cedricAbonnel/scripts-bash
--- 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
+# OPTIONS

- Aucune option n'est requise pour exécuter le script.
+Aucune option n'est requise pour exécuter le script.

-## CONFIGURATION
+# 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 - \<canl.sb2023@acemail.fr>
+
+# VERSIONS
+
+-23.12.1
+:    Version originale
+
+# RAPPORT D'ERREURS

-## RAPPORT D'ERREURS
 Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash

 # VOIR AUSSI
--- a/local/share/doc/playlist_gen.1.md
+++ b/local/share/doc/playlist_gen.1.md
@ -1,32 +1,43 @@
-# playlist_gen(1) - Génère une playlist M3U à partir de fichiers audio
+\

-## SYNOPSIS
+# NOM

-**playlist_gen** [-n \<nombre de fichiers\>] [-d \<répertoire\>] [-o \<fichier de sortie\>]
+playlist_gen - Génère une playlist M3U à partir de fichiers audio

-## DESCRIPTION
+# SYNOPSIS

-**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 [-n \<nombre de fichiers\>] [-d \<répertoire\>] [-o \<fichier de sortie\>]

-## OPTIONS
+# DESCRIPTION

- **-n \<nombre de fichiers\>** : Spécifie le nombre de fichiers à inclure dans la playlist. Par défaut, le nombre de fichiers est 100.
+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é.

- **-d \<répertoire\>** : Spécifie le répertoire à scanner pour les fichiers audio. Par défaut, le répertoire actuel est utilisé.
+# OPTIONS

- **-o \<fichier de sortie\>** : 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.
+-n
+:  Spécifie le nombre de fichiers à inclure dans la playlist. Par défaut, le
+nombre de fichiers est 100.

-## UTILISATION
+-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.
+
+# UTILISATION

 ```
 playlist_gen -n 50 -d /chemin/vers/repertoire -o playlist.m3u
 ```

-## COMPATIBILITÉ
+# COMPATIBILITÉ

 Ce script est compatible avec les fichiers audio aux formats MP3, Opus, Ogg et M4A.

-## EXEMPLES
+# EXEMPLES

 1. Générer une playlist M3U à partir du répertoire de musique par défaut de l'utilisateur :

@ -40,11 +51,16 @@ 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 - \<canl.sb2023@acemail.fr>

-## RAPPORTS D'ERREURS
+# VERSIONS
+
+-23.12.1
+:    Version originale
+
+# RAPPORTS D'ERREURS

 Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash

--- a/local/share/doc/random_music_player.1.md
+++ b/local/share/doc/random_music_player.1.md
@ -1,39 +1,64 @@
-random_music_player(1) - Lecteur de musique aléatoire en ligne de commande
+\

-## Synopsis
-**random_music_player** [OPTIONS]
+# NOM

-## 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é.
+random_music_player - Lecteur de musique aléatoire en ligne de commande

-## Options
- Aucune option n'est requise.
+# 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 :

-## 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.
+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.
+# 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
+# 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 - \<canl.sb2023@acemail.fr>
+
+# RAPPORT D'ERREUR
+
+Pour signaler des erreurs ou des problèmes :
+https://git.abonnel.fr/cedricAbonnel/scripts-bash

--- a/local/share/man/castopod_update.1
+++ b/local/share/man/castopod_update.1
@ -16,21 +16,25 @@
 .\}
 .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.
-.SS OPTIONS
-.IP \[bu] 2
+.SH OPTIONS
+.PP
 Aucune option n\[cq]est nécessaire pour exécuter le script.
-.SS CONFIGURATION
+.SH CONFIGURATION
 .PP
 Le script a sa propre configuration qui n\[cq]est pas modifiable.
 .PP
@ -49,7 +53,7 @@ script et le dossier Web de CASTOPOD.
 .PP
 Le script utilise \f[V]php8.1\f[R] pour effectuer des tâches de
 maintenance.
-.SS PRÉREQUIS
+.SH PRÉREQUIS
 .PP
 Téléchargez l\[cq]archive de mise à jour disponible sur le site
 https://castopod.org/.
@ -62,17 +66,18 @@ Pour exécuter le script sans aucune option :
 castopod_update
 \f[R]
 .fi
+.SH AUTEURS
+.PP
+Cédric Abonnel - <canl.sb2023\[at]acemail.fr>
 .SH VERSIONS
-.PP
-Version 23.12.1 - Messages des logs améliorés avec plus de détails lors
-de l\[cq]utilisation de `cp'.
-.PP
-Version 23.12.14 - Suppression de l\[cq]archive TAR du dossier
-\f[V]save_castopod\f[R].
-.SS AUTEUR
-.PP
-Ce script a été créé par Cédric Abonnel.
-.SS RAPPORT D\[cq]ERREURS
+.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 :
 https://git.abonnel.fr/cedricAbonnel/scripts-bash
--- a/local/share/man/convertPDF.1
+++ b/local/share/man/convertPDF.1
@ -16,29 +16,34 @@
 .\}
 .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
-.SS SYNOPSIS
+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]
-.SS DESCRIPTION
+convertPDF
+.SH 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É
+.SH COMPATIBILITÉ
 .PP
 Ce script est compatible avec les fichiers PDF (Portable Document
 Format).
-.SS EXEMPLE
+.SH EXEMPLES
 .PP
 Convertir plusieurs fichiers PDF présent dans le dossier et
 sous-dossiers courants : \f[V]convertPDF\f[R]
-.SS AUTEUR
+.SH VERSIONS
+.TP
+-23.12.1
+Version originale
+.SH AUTEURS
 .PP
-Ce script a été créé par Cédric Abonnel.
-.SS RAPPORT D\[cq]ERREURS
+Cédric Abonnel - <canl.sb2023\[at]acemail.fr>
+.SH RAPPORT D\[cq]ERREURS
 .PP
 Pour signaler des erreurs ou des problèmes :
 https://git.abonnel.fr/cedricAbonnel/scripts-bash
--- a/local/share/man/play_tophoraire.1
+++ b/local/share/man/play_tophoraire.1
@ -16,38 +16,39 @@
 .\}
 .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.
-.SS OPTIONS
-.IP \[bu] 2
+.SH OPTIONS
+.PP
 Aucune option n\[cq]est requise pour exécuter le script.
-.SS CONFIGURATION
+.SH 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.
@ -62,10 +63,14 @@ Pour exécuter le script sans aucune option :
 top_horaire
 \f[R]
 .fi
-.SS AUTEUR
+.SH AUTEURS
 .PP
-Ce script a été créé par Cédric Abonnel.
-.SS RAPPORT D\[cq]ERREURS
+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 :
 https://git.abonnel.fr/cedricAbonnel/scripts-bash
--- a/local/share/man/playlist_gen.1
+++ b/local/share/man/playlist_gen.1
@ -16,42 +16,47 @@
 .\}
 .TH "" "" "" "" ""
 .hy
-.SH playlist_gen(1) - Génère une playlist M3U à partir de fichiers audio
-.SS SYNOPSIS
 .PP
-\f[B]playlist_gen\f[R] [-n <nombre de fichiers>] [-d <répertoire>] [-o
-<fichier de sortie>]
-.SS DESCRIPTION
+.PD 0
+.P
+.PD
+.SH NOM
 .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é.
-.SS OPTIONS
-.IP \[bu] 2
-\f[B]-n <nombre de fichiers>\f[R] : Spécifie le nombre de fichiers à
-inclure dans la playlist.
+playlist_gen - Génère une playlist M3U à partir de fichiers audio
+.SH SYNOPSIS
+.PP
+playlist_gen [-n <nombre de fichiers>] [-d <répertoire>] [-o <fichier de
+sortie>]
+.SH DESCRIPTION
+.PP
+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
+.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 <répertoire>\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 <fichier de sortie>\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.
-.SS UTILISATION
+.SH UTILISATION
 .IP
 .nf
 \f[C]
 playlist_gen -n 50 -d /chemin/vers/repertoire -o playlist.m3u
 \f[R]
 .fi
-.SS COMPATIBILITÉ
+.SH COMPATIBILITÉ
 .PP
 Ce script est compatible avec les fichiers audio aux formats MP3, Opus,
 Ogg et M4A.
-.SS EXEMPLES
+.SH EXEMPLES
 .IP "1." 3
 Générer une playlist M3U à partir du répertoire de musique par défaut de
 l\[cq]utilisateur :
@ -74,10 +79,14 @@ playlist_gen -n 25 -d /chemin/vers/repertoire
 \f[R]
 .fi
 .RE
-.SS AUTEUR
+.SH AUTEURS
 .PP
-Ce script a été écrit par Cédric Abonnel.
-.SS RAPPORTS D\[cq]ERREURS
+Cédric Abonnel - <canl.sb2023\[at]acemail.fr>
+.SH VERSIONS
+.TP
+-23.12.1
+Version originale
+.SH RAPPORTS D\[cq]ERREURS
 .PP
 Pour signaler des erreurs ou des problèmes :
 https://git.abonnel.fr/cedricAbonnel/scripts-bash
--- a/local/share/man/random_music_player.1
+++ b/local/share/man/random_music_player.1
@ -17,20 +17,24 @@
 .TH "" "" "" "" ""
 .hy
 .PP
-random_music_player(1) - Lecteur de musique aléatoire en ligne de
-commande
-.SS Synopsis
+.PD 0
+.P
+.PD
+.SH NOM
 .PP
-\f[B]random_music_player\f[R] OPTIONS
-.SS Description
+random_music_player - Lecteur de musique aléatoire en ligne de commande
+.SH SYNOPSIS
+.PP
+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é.
-.SS Options
-.IP \[bu] 2
+.SH OPTIONS
+.PP
 Aucune option n\[cq]est requise.
-.SS Configuration
+.SH CONFIGURATION
 .PP
 Le script utilise un fichier de configuration situé à
 \f[V]\[ti]/.config/random_music_player\f[R].
@ -47,7 +51,7 @@ volume=0.06
 .PP
 Vous pouvez éditer ce fichier de configuration pour personnaliser les
 réglages du lecteur de musique.
-.SS Utilisation
+.SH UTILISATION
 .PP
 Pour utiliser le lecteur de musique aléatoire, exécutez simplement le
 script sans aucune option.
@ -59,17 +63,21 @@ spécifié dans le fichier de configuration et le lira.
 random_music_player
 \f[R]
 .fi
-.SS Exemple
+.SH EXEMPLE
 .IP
 .nf
 \f[C]
 $ random_music_player
 \f[R]
 .fi
-.SS Auteur
+.SH VERSIONS
+.TP
+-23.12.1
+Version originale
+.SH AUTEURS
 .PP
-Ce script a été créé par Cédric Abonnel.
-.SS Rapport d\[cq]erreurs
+Cédric Abonnel - <canl.sb2023\[at]acemail.fr>
+.SH RAPPORT D\[cq]ERREUR
 .PP
 Pour signaler des erreurs ou des problèmes :
 https://git.abonnel.fr/cedricAbonnel/scripts-bash
--- a/prep.sh
+++ b/prep.sh
@ -1,5 +1,13 @@
 #!/bin/bash

+# Script Bash - prep.sh
+# Auteur : Cédric Abonnel
+
+# Description : Prépare les fichiers de DOC et listing.
+
+# Version 23.12.14
+# - Modification du traitement des résumés des DOC. La fonctionnalité n'est pas encore accessible.
+

 # Spécifier le chemin du fichier journal
 log_dir="$HOME/log"
@ -107,11 +115,30 @@ ls local/share/man/ -c1 >.config/files_local-share-man



+########
+# Résumé des DOC

-## Résumé des DOC

 for fichier in local/share/doc/*.md; do
  echo "Résumé pour $fichier :"
-  awk '/DESCRIPTION/{flag=1; next} /^$/{flag=0} flag' "$fichier"
+  description_found=0
+  empty_line_encountered=false
+  description_started=0
+
+  while IFS= read -r ligne; do
+    if [ "$description_found" -eq 1 ] && [ "$description_started" -eq 1 ] && [ -n "$ligne" ]; then
+      echo "$ligne"
+    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 "..."
 done
+
Author	SHA1	Message	Date
Cédric Abonnel	eb8bf3ed38	Uniformisation des documentations	2023-12-14 21:29:06 +01:00
Cédric Abonnel	34e7b33357	Uniformisation des pages manuels Changes to be committed: modified: .config/files_local-share-doc modified: .config/files_local-share-man modified: local/share/doc/castopod_update.1.md modified: local/share/doc/convertPDF.1.md modified: local/share/doc/play_tophoraire.1.md modified: local/share/doc/playlist_gen.1.md modified: local/share/doc/random_music_player.1.md modified: local/share/man/castopod_update.1 modified: local/share/man/convertPDF.1 modified: local/share/man/play_tophoraire.1 modified: local/share/man/playlist_gen.1 modified: local/share/man/random_music_player.1 modified: prep.sh	2023-12-14 21:27:49 +01:00
Cédric Abonnel	7f7c74c288	Précisions sur git clone apportée dans README cedricAbonnel/scripts-bash#4	2023-12-14 17:29:52 +01:00
Cédric Abonnel	83e524aee3	Détail dans README concernant install.sh cedricAbonnel/scripts-bash#5	2023-12-14 17:27:50 +01:00