# Aide memoire pour l'écriture de scripts avec le socle bash
# Historique
* Sommaire
Le **socle Bash** est **une version allégée** d'un ensemble de bibliothèques et fonctions
écrit en grande partie par **Emmanuel Confrère**, émminent DBA Calédonien qui nous a
autorisé à l'utiliser au sein du Tetalab, et dont l'utilité est d'assurer la cohérence
des scripts qui s'appuient dessus.
Ce **socle Bash** est fiable et robuste. Il peut sans aucun doute être utilisé en production
à la condition que l'ensemble des conseils listés dans la documentation soient respectés.
Entre autres fonctionalités ce **socle Bash** permet aux scripts qui s'appuient dessus:
* La gestion de l'historique d'execution
* La gestion des logs
* La gestion des fichiers temporaires
* La gestion des options et arguments
* La gestion des erreurs
* La standadisation de l'affichage
* ...
# Installation
L'installlation du script bash est simple et nécessite les droits **root**.
* Éditez le fichier de configuration **./conf/install_init.conf** de manière à ce
que les variables qui y sont définies correspondent à vos besoins.
* Lancez l'installation en tant qu'utilisateur **root** (ou sudo):
sudo ./install.sh
# Documentation
* **Sommaire**
* I - Arborescence du socle
* II - Variables d'environement
* 1 - Variables globales
@ -32,7 +61,7 @@
@@ -32,7 +61,7 @@
## I - Arborescence du socle
La racine des dossiers utilisée par le Socle Bash est définie par la variable d'environement NC\_EXPL\_ROOT.
La racine des dossiers utilisée par le **socle Bash** est définie par la variable d'environement NC\_EXPL\_ROOT.
Cette dernière est initialisée à la connexion par l'appel au script /etc/profile.d/tetalab.sh
Cette arborescence est utilisée pour tous scripts Bash ainsi que les variables d'environement qui
en découlent.
@ -306,7 +335,7 @@ Les options par défaut réalisent les actions suivantes :
@@ -306,7 +335,7 @@ Les options par défaut réalisent les actions suivantes :
-log [id] : Affiche le dernier journal ou le journal "id" (identifiant de session d'exécution).
-cpt [id] : Affiche le dernier compte-rendu ou le Compte-rendu "id" (identifiant de session d'execution).
-hist [N] : Affiche l'historique des "N" dernières executions (N=10 par défaut)
-dbg N : Activation du mode debug au niveau "N". Active les messages gérés par la librairie fct_message
-dbg N : Activation du mode debug au niveau "N". Active les messages gérés par la bibliothèque fct_message
dont l'option -debug est utilisée.
@ -473,7 +502,7 @@ assurer une homogénéite dans l'ensemble du socle.
@@ -473,7 +502,7 @@ assurer une homogénéite dans l'ensemble du socle.
G_VAR1=${G_AVR1:="Valeur par defaut"} # <Comentaire>
exit_on_error "Erreur lors de l'initialisation de l'environnement d'installation. Vérifier les permissions sur les fichiers ${PKG_INSTALL_CONF} et ${PKG_SOCLE_INIT_CONF}"