Uniformisation des documentations

This commit is contained in:
2023-12-14 21:29:06 +01:00
parent 34e7b33357
commit eb8bf3ed38
11 changed files with 211 additions and 102 deletions

View File

@@ -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 - \<canl.sb2023@acemail.fr>
# 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.
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.