"Conversion README en markdown"
This commit is contained in:
parent
1133ff19be
commit
6b55c2e32c
71
README.md
71
README.md
@ -561,22 +561,22 @@ réccurente de l'application.
|
|||||||
|
|
||||||
### 1 - fct\_message
|
### 1 - fct\_message
|
||||||
|
|
||||||
Syntaxe : fct\_message [-cpt] [-hist] [-nolog] [-debug N] [-color Couleur] "<Message à ecrire>"
|
* Syntaxe : fct\_message [-cpt] [-hist] [-nolog] [-debug N] [-color Couleur] "<Message à ecrire>"
|
||||||
|
|
||||||
Usage : Cette fonction est à utiliser en remplacement de la commande "echo".
|
* 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.
|
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
|
* 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 :
|
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
|
* -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
|
* -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
|
* -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
|
* -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".
|
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.
|
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
|
* -color : Affiche le message en couleur. Les couleurs reconues sont : vert,rouge,bleu,cyan,jaune,orange,blanc et noir
|
||||||
|
|
||||||
|
|
||||||
### 2 - fct\_affiche\_ligne
|
### 2 - fct\_affiche\_ligne
|
||||||
@ -584,10 +584,10 @@ Par défaut le niveau de debug est 0, ainsi si "N" vaut zero alors le message es
|
|||||||
Syntaxe : fct\_affiche\_ligne [entete|pied] <elements>
|
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
|
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 :
|
* Fonction : 3 étapes sont nécéssaires pour créer un tableau :
|
||||||
* Définition du tableau
|
* Définition du tableau
|
||||||
* Affichage des éléments
|
* Affichage des éléments
|
||||||
* Fermeture du tableau
|
* Fermeture du tableau
|
||||||
|
|
||||||
Ces étapes doivent impérativement être suivies et dans cet ordre.
|
Ces étapes doivent impérativement être suivies et dans cet ordre.
|
||||||
Il n'est pas possible d'imbriquer des tableaux.
|
Il n'est pas possible d'imbriquer des tableaux.
|
||||||
@ -598,7 +598,7 @@ Elle est réalisée par l'appel de la fonction fct\_affiche\_ligne avec l'argume
|
|||||||
|
|
||||||
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}:...)"
|
||||||
|
|
||||||
@ -613,7 +613,7 @@ Cette action permet de libérer les variables de session qui ont été créées
|
|||||||
|
|
||||||
fct_affiche_ligne pied
|
fct_affiche_ligne pied
|
||||||
|
|
||||||
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
|
||||||
@ -654,10 +654,9 @@ affichera:
|
|||||||
|
|
||||||
### 3 - fct\_erreur
|
### 3 - fct\_erreur
|
||||||
|
|
||||||
Syntaxe : fct\_erreur <N>
|
* Syntaxe : fct\_erreur <N>
|
||||||
Usage : Gestion des erreurs d'un script
|
* Usage : Gestion des erreurs d'un script
|
||||||
|
* Fonction : Cette fonction doit etre appelée 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 associé 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}/<script>.msg
|
||||||
Elle exécute éventuellement une fonction rattachée, spécifiée dans ce même 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, libère les semaphores et
|
Elle ferme les fichiers de traces, supprime les fichiers temporaires, libère les semaphores et
|
||||||
@ -665,32 +664,32 @@ renvoie un code retour au script appelant.
|
|||||||
|
|
||||||
N est un entier positif dont les valeurs suivantes sont reservées :
|
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 bibliothèque sans le numero d'erreur (<N> non renseigne !)
|
* 250 : <lib:fct_erreur> Appel de la bibliothèque 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
|
* 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
|
* 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
|
* 253 : <lib:fct_erreur> La description de l'erreur dans le fichier <script>.msg est incorrecte
|
||||||
* 254 : <lib:fct_params> Erreur a été remontée par la bibliothèque
|
* 254 : <lib:fct_params> Erreur a été remontée par la bibliothèque
|
||||||
* 255 : <lib:fct_erreur> Appel de la bibliothèque avec un numero d'erreur >= 250
|
* 255 : <lib:fct_erreur> Appel de la bibliothèque avec un numero d'erreur >= 250
|
||||||
* 256 : réservé pour un futur usage
|
* 256 : réservé pour un futur usage
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Le fichier <script>.msg contient les descriptions des codes erreur.
|
* Le fichier <script>.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> | <type> | <action> | <message> ou <fonction>
|
||||||
|
|
||||||
* <NumErreur> : Entier positif identifiant l'erreur
|
* <NumErreur> : Entier positif identifiant l'erreur
|
||||||
* <type> : prend les valeurs erreur, alert ou info. Colorise le message en fonction
|
* <type> : prend les valeurs erreur, alert ou info. Colorise le message en fonction
|
||||||
du type respectivement rouge, orange et bleu
|
du type respectivement rouge, orange et bleu
|
||||||
* <action> : Action à realiser (continu, stop, exec)
|
* <action> : Action à 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 : exécute la fonction puis rend la main au script
|
||||||
* <fonction> : Fonction à exécuter. Ce champs peut contenir des variables qui seront valorisées.
|
* <fonction> : Fonction à exécuter. Ce champs peut contenir des variables qui seront valorisées.
|
||||||
* <message> : Message à afficher (dans les traces et sur la sortie standard). Ce champs peut contenir
|
* <message> : Message à afficher (dans les traces et sur la sortie standard). Ce champs peut contenir
|
||||||
des variables qui seront valorisées.
|
des variables qui seront valorisées.
|
||||||
|
|
||||||
4 - fct\_unique\_exec
|
4 - fct\_unique\_exec
|
||||||
--- ---------------
|
--- ---------------
|
||||||
|
Loading…
Reference in New Issue
Block a user