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
This commit is contained in:
@@ -10,11 +10,11 @@ castopod_update - Mise à jour de CASTOPOD
|
||||
|
||||
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.
|
||||
|
||||
## CONFIGURATION
|
||||
# CONFIGURATION
|
||||
|
||||
Le script a sa propre configuration qui n'est pas modifiable.
|
||||
|
||||
@@ -28,7 +28,7 @@ L'archive de mise à jour doit être spécifiquement nommée `castopod*.zip` et
|
||||
|
||||
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/.
|
||||
|
||||
@@ -42,18 +42,17 @@ castopod_update
|
||||
|
||||
# VERSIONS
|
||||
|
||||
Version 23.12.1
|
||||
- Messages des logs améliorés avec plus de détails lors de l'utilisation de 'cp'.
|
||||
|
||||
Version 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'.
|
||||
|
||||
## AUTEUR
|
||||
# AUTEUR
|
||||
|
||||
Ce script a été créé par Cédric Abonnel.
|
||||
|
||||
## RAPPORT D'ERREURS
|
||||
# RAPPORT D'ERREURS
|
||||
|
||||
Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash
|
||||
|
||||
|
||||
@@ -1,23 +1,24 @@
|
||||
convertPDF(1) - Compresse des fichiers PDF pour gagner en volume et génère le résultat d'un OCR
|
||||
|
||||
## SYNOPSIS
|
||||
# SYNOPSIS
|
||||
**convertPDF**
|
||||
|
||||
## DESCRIPTION
|
||||
# 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É
|
||||
# COMPATIBILITÉ
|
||||
|
||||
Ce script est compatible avec les fichiers PDF (Portable Document Format).
|
||||
|
||||
## EXEMPLE
|
||||
# EXEMPLE
|
||||
Convertir plusieurs fichiers PDF présent dans le dossier et sous-dossiers courants :
|
||||
```
|
||||
convertPDF
|
||||
```
|
||||
|
||||
## AUTEUR
|
||||
# AUTEUR
|
||||
Ce script a été créé par Cédric Abonnel.
|
||||
|
||||
## RAPPORT D'ERREURS
|
||||
# RAPPORT D'ERREURS
|
||||
Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash
|
||||
|
||||
@@ -10,23 +10,23 @@ top_horaire - Gestion du jingle et de l'annonce de l'heure
|
||||
|
||||
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.
|
||||
|
||||
## 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
|
||||
# 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
|
||||
# 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
|
||||
# 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.
|
||||
|
||||
@@ -38,10 +38,10 @@ Pour exécuter le script sans aucune option :
|
||||
top_horaire
|
||||
```
|
||||
|
||||
## AUTEUR
|
||||
# AUTEUR
|
||||
Ce script a été créé par Cédric Abonnel.
|
||||
|
||||
## RAPPORT D'ERREURS
|
||||
# RAPPORT D'ERREURS
|
||||
Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash
|
||||
|
||||
# VOIR AUSSI
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
# playlist_gen(1) - Génère une playlist M3U à partir de fichiers audio
|
||||
|
||||
## SYNOPSIS
|
||||
# SYNOPSIS
|
||||
|
||||
**playlist_gen** [-n \<nombre de fichiers\>] [-d \<répertoire\>] [-o \<fichier de sortie\>]
|
||||
|
||||
## DESCRIPTION
|
||||
# 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é.
|
||||
|
||||
## OPTIONS
|
||||
# OPTIONS
|
||||
|
||||
- **-n \<nombre de fichiers\>** : Spécifie le nombre de fichiers à inclure dans la playlist. Par défaut, le nombre de fichiers est 100.
|
||||
|
||||
@@ -16,17 +16,17 @@
|
||||
|
||||
- **-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.
|
||||
|
||||
## UTILISATION
|
||||
# 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 +40,11 @@ Ce script est compatible avec les fichiers audio aux formats MP3, Opus, Ogg et M
|
||||
playlist_gen -n 25 -d /chemin/vers/repertoire
|
||||
```
|
||||
|
||||
## AUTEUR
|
||||
# AUTEUR
|
||||
|
||||
Ce script a été écrit par Cédric Abonnel.
|
||||
|
||||
## RAPPORTS D'ERREURS
|
||||
# RAPPORTS D'ERREURS
|
||||
|
||||
Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash
|
||||
|
||||
|
||||
@@ -1,15 +1,16 @@
|
||||
random_music_player(1) - Lecteur de musique aléatoire en ligne de commande
|
||||
|
||||
## Synopsis
|
||||
# SYNOPSIS
|
||||
**random_music_player** [OPTIONS]
|
||||
|
||||
## Description
|
||||
# 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
|
||||
# OPTIONS
|
||||
- Aucune option n'est requise.
|
||||
|
||||
## Configuration
|
||||
# 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]
|
||||
@@ -19,21 +20,21 @@ volume=0.06
|
||||
|
||||
Vous pouvez éditer ce fichier de configuration pour personnaliser les réglages du lecteur de musique.
|
||||
|
||||
## Utilisation
|
||||
# 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
|
||||
# AUTEUR
|
||||
Ce script a été créé par Cédric Abonnel.
|
||||
|
||||
## Rapport d'erreurs
|
||||
# RAPPORT D'ERREURS
|
||||
Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash
|
||||
|
||||
|
||||
Reference in New Issue
Block a user