BOFH/socle_bash
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

"Conversion README en markdown"

Browse Source
This commit is contained in:
Doug Le Tough 2017-07-21 22:00:04 +02:00
parent 09c69e2efd
commit c90ddb15ec
1 changed files with 44 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
README.md
View File

@ -217,8 +217,8 @@ Pour le suivi des versions on utilisera le versionnement sémantique (voir parag
* Mise a jour : Ce paragraphe est utilisé pour suivre l'evolution des versions. La dernière version en * Mise a jour : Ce paragraphe est utilisé pour suivre l'evolution des versions. La dernière version en
vigueur doit être reportée dans le premier paragraphe. vigueur doit être reportée dans le premier paragraphe.
* Dependance : Permêt de définir la liste ainsi que la version des scripts qui sont appelés. * Dependance : Permet de définir la liste ainsi que la version des scripts qui sont appelés.
Dans le cas d'un changement cela permêt de connaître les scripts qui sont impactés. Dans le cas d'un changement cela permet de connaître les scripts qui sont impactés.
Pour le moment aucun script n'exploite cette méta-donnée qui est presente pour un future usage. Pour le moment aucun script n'exploite cette méta-donnée qui est presente pour un future usage.
* Liste des options : La déclaration des options n'est pas obligatoire. * Liste des options : La déclaration des options n'est pas obligatoire.
@ -595,14 +595,14 @@ Il n'est pas possible d'imbriquer des tableaux.
* Définition * Définition
Elle est réalisée par l'appel de la fonction fct\_affiche\_ligne avec l'argument entête. La forme est alors la suivante : Elle est réalisée par l'appel de la fonction fct\_affiche\_ligne avec l'argument entête. La forme est alors la suivante :
fct\_affiche\_ligne entete "{Titre}" "{Colonne\_1},{Taille\_1}" "{Colonne\_2},{Taille\_2}" "{Colonne\_3},{Taille\_3}" "{Colonne\_4},{Taille\_4}" ... fct_affiche_ligne entete "{Titre}" "{Colonne_1},{Taille_1}" "{Colonne_2},{Taille_2}" "{Colonne_3},{Taille_3}" "{Colonne_4},{Taille_4}" ...
ou bien: ou bien:
fct\_affiche\_ligne entete "{Titre}" "Groupe1({Colonne\_1},{Taille\_1}:{Colonne\_2},{Taille\_2})" "{Colonne\_3},{Taille\_3}" "{Colonne\_4},{Taille\_4}" "Groupe2({Colonne\_4},{Taille\_4}:...)" fct_affiche_ligne entete "{Titre}" "Groupe1({Colonne_1},{Taille_1}:{Colonne_2},{Taille_2})" "{Colonne_3},{Taille_3}" "{Colonne_4},{Taille_4}" "Groupe2({Colonne_4},{Taille_4}:...)"
* Affichage des éléments * Affichage des éléments
fct\_affiche\_ligne "<Element1>" "<Element2>" ... fct\_affiche\_ligne "&lt;Element1&gt;" "&lt;Element2&gt:" ...
* Fermeture du tableau * Fermeture du tableau
Cette action permet de libérer les variables de session qui ont ete créées Cette action permet de libérer les variables de session qui ont ete créées
@ -611,10 +611,10 @@ Cette action permet de libérer les variables de session qui ont ete créées
Exemples: Exemples:
fct\_affiche\_ligne entete "Un tableau" "C1,10" "C2,10" "c3,10" fct_affiche_ligne entete "Un tableau" "C1,10" "C2,10" "c3,10"
fct\_affiche\_ligne A B C fct_affiche_ligne A B C
fct\_affiche\_ligne 1 "" 3 fct_affiche_ligne 1 "" 3
fct\_affiche\_ligne pied fct_affiche_ligne pied
affichera: affichera:
@ -629,10 +629,10 @@ affichera:
et et
fct\_affiche\_ligne entete "Un Autre tableau" "C1,10" "G1(C2,20:C3,10:C4,3)" "C5,15" fct_affiche_ligne entete "Un Autre tableau" "C1,10" "G1(C2,20:C3,10:C4,3)" "C5,15"
fct\_affiche\_ligne A B C D E fct_affiche_ligne A B C D E
fct\_affiche\_ligne 1 "" 3 3 4 fct_affiche_ligne 1 "" 3 3 4
fct\_affiche\_ligne pied fct_affiche_ligne pied
affichera: affichera:
@ -648,51 +648,45 @@ affichera:
------------------------------------------------------------------------ ------------------------------------------------------------------------
3 - fct\_erreur ### 3 - fct\_erreur
--- ----------
Syntaxe : fct\_erreur &lt;N&gt; Syntaxe : fct\_erreur &lt;N&gt;
Usage : Gestion des erreurs d'un script Usage : Gestion des erreurs d'un script
Fonction : Cette fonction doit etre appelee pour sortir d un script du socle. Fonction : Cette fonction doit etre appelée pour sortir d'un script du socle.
Elle affiche le message d erreur associe au code qui est lu dans le fichier ${NC\_EXPL\_MSG}/<script>.msg Elle affiche le message d'erreur associé au code qui est lu dans le fichier ${NC\_EXPL\_MSG}/&lt;script&gt;.msg
Elle execute eventuellement une fonction rattachee, specifiee dans ce meme fichier. Elle exécute éventuellement une fonction rattachée, spécifiée dans ce même fichier.
Elle ferme les fichiers de traces, supprime les fichiers temporaires, libere les semaphores et Elle ferme les fichiers de traces, supprime les fichiers temporaires, libère les semaphores et
renvoi un code retour au script appelant. renvoie un code retour au script appelant.
N est un entier positif dont les valeurs suivantes sont reservees : N est un entier positif dont les valeurs suivantes sont reservées :
0 : Fin normale du script * 0 : Fin normale du script
250 : <lib:fct\_erreur> Appel de la librairie sans le numero d erreur (<N> non renseigne !) * 250 : &lt;lib:fct_erreur&gt; Appel de la bibliothèque sans le numero d'erreur (&lt;N&gt; non renseigne !)
251 : <lib:fct\_erreur> La description de l erreur <N> n existe pas dans le fichier <script>.msg * 251 : &lt;lib:fct_erreur&gt; La description de l'erreur &lt;N&gt; n'existe pas dans le fichier &lt;script&gt;.msg
252 : <lib:fct\_erreur> Le fichier <script>.msg n existe pas * 252 : &lt;lib:fct_erreur&gt; Le fichier &lt;script&gt;.msg n'existe pas
253 : <lib:fct\_erreur> La description de l erreur dans le fichier <script>.msg est incorrecte * 253 : &lt;lib:fct_erreur&gt; La description de l'erreur dans le fichier &lt;script&gt;.msg est incorrecte
254 : <lib:fct\_params> Erreur a ete remontee par la librairie * 254 : &lt;lib:fct_params&gt; Erreur a été remontée par la bibliothèque
255 : <lib:fct\_erreur> Appel de la librairie avec un numero d erreur >= 250 * 255 : &lt;lib:fct_erreur&gt; Appel de la bibliothèque avec un numero d'erreur &gt;= 250
256 : reserve pur un futur usage * 256 : réservé pour un futur usage
Le fichier <script>.msg contient les descriptions des codes erreur. Le fichier &lt;script&gt;.msg contient les descriptions des codes erreur.
Un code par ligne de la forme : Un code par ligne de la forme :
<NumErreur> | <type> | <action> | <message> ou <fonction>
<NumErreur> : Entier positif identifiant l erreur <NumErreur> | <type> | <action> | <message> ou <fonction>
<type> : prend les valeurs erreur, alert ou info * &lt;NumErreur&gt; : Entier positif identifiant l'erreur
colorise le message en fonction du type respectivement * &lt;type&gt; : prend les valeurs erreur, alert ou info. Colorise le message en fonction
rouge, orange et bleu du type respectivement rouge, orange et bleu
* &lt;action&gt; : Action à realiser (continu, stop, exec)
<action> : Action a realiser (continu,stop,exec) * continu : Affiche le message puis rend la main au script
- continu : Affiche le message puis rend la main au script * stop : Affiche le message puis sort en erreur
- stop : Affiche le message puis sort en erreur * exec : exécute la fonction puis rend la main au script
- exec : execute la fonction puis rend la main au script * &lt;fonction&gt; : Fonction à exécuter. Ce champs peut contenir des variables qui seront valorisées.
* &lt;message&gt; : Message à afficher (dans les traces et sur la sortie standard). Ce champs peut contenir
<fonction> : Fonction a executer des variables qui seront valorisées.
Ce champs peut contenir des variables qui seront valorisees.
<message> : Message a afficher (dans les traces et sur la sortie standard)
Ce champs peut contenir des variables qui seront valorisees.
4 - fct\_unique\_exec 4 - fct\_unique\_exec
--- --------------- --- ---------------