"Conversion README en markdown"

This commit is contained in:
Doug Le Tough 2017-07-21 15:19:34 +02:00
parent 4227c2c0a6
commit 71875ca015
1 changed files with 194 additions and 3 deletions

197
README.md
View File

@ -542,12 +542,203 @@ les données applicatives et peuvent être contraints par des conditions d'execu
* "aud" : Script d'audit ne modifiant pas le système. * "aud" : Script d'audit ne modifiant pas le système.
Ces scripts peuvent être executés sans aucun risque. Ces scripts peuvent être executés sans aucun risque.
* <descr> est libre, doit refléter si possible la fonction du script. * &lt;descr&gt; est libre, doit refléter si possible la fonction du script.
* <language> est une des valeurs suivantes : * &lt;language&gt; est une des valeurs suivantes :
"sh" : Script Bash. "sh" : Script Bash.
* <app> est le nom de l'application à laquelle le script est dédié. * &lt;app&gt; est le nom de l'application à laquelle le script est dédié.
Ces scripts sont réservés à une application particulière dans le cadres de l'exploitation Ces scripts sont réservés à une application particulière dans le cadres de l'exploitation
réccurente de l'application. réccurente de l'application.
## V - Description et usage des bibliothèques
### 1 - fct\_message
Syntaxe : fct\_message [-cpt] [-hist] [-nolog] [-debug N] [-color Couleur] "<Message à ecrire>"
Usage : Cette fonction est à utiliser en remplacement de la commande "echo".
Elle ajoute l'horadatage au message et gère la ventilation des écritures dans les differents fichiers de traces.
Fonction : Par défaut le message est affiché sur le terminal et est écrit dans le fichier journal ${NC\_EXPL\_LOG}/<nom\_du\_script>.log
Les options modifient la destination de l'écriture :
* -cpt : Écrit en plus du journal dans le fichier de compte-rendu ${NC\_EXPL\_CPT}/<nom\_du\_script>.cpt
* -hist : Écrit uniquement dans le fichier d'historique des exécutions ${NC\_EXPL\_TRC}/<nom\_du\_script>.hist
* -nolog : Inhibe l'écritutre dans le fichier journal
* -debug N : N'affiche pas le message sur le terminal mais uniquement dans le fichier journal, à condition
que le script soit execute en mode debug de niveau equivalent à "N" via l'option "-dbg N".
Par défaut le niveau de debug est 0, ainsi si "N" vaut zero alors le message est écrit uniquement dans le fichier journal.
* -color : Affiche le message en couleur. Les couleurs reconues sont : vert,rouge,bleu,cyan,jaune,orange,blanc et noir
### 2 - fct\_affiche\_ligne
Syntaxe : fct\_affiche\_ligne [entete|pied] <elements>
Usage : Affiche un tableau sur la sortie standard et dans le fichier compte-rendu ${NC\_EXPL\_ROOT}/<script>.cpt
Fonction : 3 étapes sont nécéssaires pour créer un tableau :
* Définition du tableau
* Affichage des éléments
* Fermeture du tableau
Ces étapes doivent impérativement être suivies et dans cet ordre.
Il n'est pas possible d'imbriquer des tableaux.
* 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 :
fct\_affiche\_ligne entete "{Titre}" "{Colonne\_1},{Taille\_1}" "{Colonne\_2},{Taille\_2}" "{Colonne\_3},{Taille\_3}" "{Colonne\_4},{Taille\_4}" ...
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}:...)"
* Affichage des éléments
fct\_affiche\_ligne "<Element1>" "<Element2>" ...
* Fermeture du tableau
Cette action permet de libérer les variables de session qui ont ete créées
fct\_affiche\_ligne pied
Exemples:
fct\_affiche\_ligne entete "Un tableau" "C1,10" "C2,10" "c3,10"
fct\_affiche\_ligne A B C
fct\_affiche\_ligne 1 "" 3
fct\_affiche\_ligne pied
affichera:
--------------------------------------
Un tableau
--------------------------------------
C1 | C2 | c3
--------------------------------------
A |B |C
1 | |3
--------------------------------------
et
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 1 "" 3 3 4
fct\_affiche\_ligne pied
affichera:
------------------------------------------------------------------------
Un Autre tableau
------------------------------------------------------------------------
| G1 |
C1 |-----------------------------------------| C5
| C2 | C3 | C4 |
------------------------------------------------------------------------
A |B |C |D |E
1 | |3 |3 |4
------------------------------------------------------------------------
3 - fct\_erreur
--- ----------
Syntaxe : fct\_erreur <N>
Usage : Gestion des erreurs d un script
Fonction : Cette fonction doit etre appelee 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 execute eventuellement une fonction rattachee, specifiee dans ce meme fichier.
Elle ferme les fichiers de traces, supprime les fichiers temporaires, libere les semaphores et
renvoi un code retour au script appelant.
N est un entier positif dont les valeurs suivantes sont reservees :
0 : Fin normale du script
250 : <lib:fct\_erreur> Appel de la librairie sans le numero d erreur (<N> non renseigne !)
251 : <lib:fct\_erreur> La description de l erreur <N> n existe pas dans le fichier <script>.msg
252 : <lib:fct\_erreur> Le fichier <script>.msg n existe pas
253 : <lib:fct\_erreur> La description de l erreur dans le fichier <script>.msg est incorrecte
254 : <lib:fct\_params> Erreur a ete remontee par la librairie
255 : <lib:fct\_erreur> Appel de la librairie avec un numero d erreur >= 250
256 : reserve pur un futur usage
Le fichier <script>.msg contient les descriptions des codes erreur.
Un code par ligne de la forme :
<NumErreur> | <type> | <action> | <message> ou <fonction>
<NumErreur> : Entier positif identifiant l erreur
<type> : prend les valeurs erreur, alert ou info
colorise le message en fonction du type respectivement
rouge, orange et bleu
<action> : Action a realiser (continu,stop,exec)
- continu : Affiche le message puis rend la main au script
- stop : Affiche le message puis sort en erreur
- exec : execute la fonction puis rend la main au script
<fonction> : Fonction a executer
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
--- ---------------
Syntaxe : fct\_unique\_exec [<nom>] [<Occurences>]
Usage : Empeche l execution multiple d un code par la l'acquisition de semaphore
Fonction :
5 - fct\_libere\_exec
--- ---------------
Syntaxe : fct\_libere\_exec [<nom>]
Usage : Libere les semaphores
Fonction :
6 - fct\_usage
--- ---------
Syntaxe : fct\_usage
Usage : Affiche l aide du script.
Ce sont les lignes du cartouche commencant par "##"
Fonction : Cette fonction est uniquement a usage interne du socle.
Elle est integree a la fonction fct\_params.
7 - fct\_rotation
--- ------------
Syntaxe :
Usage :
Fonction :
8 - fctpath
--- -------
Syntaxe :
Usage :
Fonction :
9 - fct\_params
--- ----------
Syntaxe : fct\_params
Usage : Gestion des options et arguments du script
Fonction : Cette fonction est uniquement a usage interne du socle.
Elle est appelee a l initialisation des variables de session lors du chargement du fichier ${NC\_EXPL\_CFG}/init.conf
Cette fonction extrait les lignes de declaration "# OPT:" et les compare au arguments sousmis au script
Pour plus d information voir le paragraphe III-1.1.2