Uniformisation des documentations
This commit is contained in:
@@ -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 - <canl.sb2023\[at]acemail.fr>
|
||||
.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 :
|
||||
|
||||
@@ -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 - <canl.sb2023\[at]acemail.fr>
|
||||
.SH RAPPORT D\[cq]ERREURS
|
||||
.PP
|
||||
Pour signaler des erreurs ou des problèmes :
|
||||
|
||||
@@ -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 :
|
||||
|
||||
@@ -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 <nombre de fichiers>] [-d <répertoire>] [-o
|
||||
<fichier de sortie>]
|
||||
playlist_gen [-n <nombre de fichiers>] [-d <répertoire>] [-o <fichier de
|
||||
sortie>]
|
||||
.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 <nombre de fichiers>\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 <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.
|
||||
.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 - <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 :
|
||||
|
||||
@@ -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 - <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
|
||||
|
||||
Reference in New Issue
Block a user