"Conversion README en markdown"
This commit is contained in:
parent
71875ca015
commit
5eea73ae12
78
README.md
78
README.md
@ -200,15 +200,15 @@ l'option par defaut "-h".
|
|||||||
|
|
||||||
##### 1.1.1 Meta-données
|
##### 1.1.1 Meta-données
|
||||||
|
|
||||||
<Action> : peut prendre les valeurs suivantes -> cre, ano, evo, typo
|
<Action> : peut prendre les valeurs suivantes -> cre, ano, evo, typo
|
||||||
* cre : Création du script.
|
* cre : Création du script.
|
||||||
* evo : Évolution du script -> Ajout de nouvelles fonctionnalités, Amélioration du code.
|
* evo : Évolution du script -> Ajout de nouvelles fonctionnalités, Amélioration du code.
|
||||||
* ano : Correction du code suite à un comportement inattendu.
|
* ano : Correction du code suite à un comportement inattendu.
|
||||||
* typo : Ajout de commentaires, de texte ou corrections gramaticales sans influence sur le code.
|
* typo : Ajout de commentaires, de texte ou corrections gramaticales sans influence sur le code.
|
||||||
|
|
||||||
<Auteur> : <Prenom> <Nom>
|
<Auteur> : <Prenom> <Nom>
|
||||||
|
|
||||||
<Version> : Format x.y.z
|
<Version> : Format x.y.z
|
||||||
Pour le suivi des versions on utilisera le versionnement sémantique (voir paragraphe III-1.2).
|
Pour le suivi des versions on utilisera le versionnement sémantique (voir paragraphe III-1.2).
|
||||||
|
|
||||||
##### 1.1.2 Paragraphe
|
##### 1.1.2 Paragraphe
|
||||||
@ -254,43 +254,43 @@ Exemple de déclaration valide :
|
|||||||
# @OPT: oM:i:G_INSTANCE:1/1:ALL:dbid:
|
# @OPT: oM:i:G_INSTANCE:1/1:ALL:dbid:
|
||||||
# @OPT: oM:pr:G_PR_NOM:1/1:sq,t,l:
|
# @OPT: oM:pr:G_PR_NOM:1/1:sq,t,l:
|
||||||
|
|
||||||
* <type> : Propriété de l'attribu défini par l'aggrégation des lettres suivantes:
|
* <type> : Propriété de l'attribu défini par l'aggrégation des lettres suivantes:
|
||||||
* f -> Option falcultative
|
* f -> Option falcultative
|
||||||
* b -> Booléen
|
* b -> Booléen
|
||||||
* o -> Option obligatoire
|
* o -> Option obligatoire
|
||||||
* M -> Argument transformé en majuscule
|
* M -> Argument transformé en majuscule
|
||||||
|
|
||||||
* <nom> : nom de l'option (sans le tiret). Attention le nom de l'option est sensible à la casse.
|
* <nom> : nom de l'option (sans le tiret). Attention le nom de l'option est sensible à la casse.
|
||||||
|
|
||||||
* <var> : nom de la variable dans laquelle sera stockée le(s) argument(s)
|
* <var> : nom de la variable dans laquelle sera stockée le(s) argument(s)
|
||||||
si plusieurs arguments alors un tableau sera initialisé <var[n]>
|
si plusieurs arguments alors un tableau sera initialisé <var[n]>
|
||||||
L'index [n] commence à zero.
|
L'index [n] commence à zero.
|
||||||
Le nombre d'arguments éffectivement passés a la commande est "${#<var>[*]}".
|
Le nombre d'arguments éffectivement passés a la commande est "${#<var>[*]}".
|
||||||
La valeur max de l'index [n] est "${#<var>[*]} - 1".
|
La valeur max de l'index [n] est "${#<var>[*]} - 1".
|
||||||
|
|
||||||
* <nb\_arg> : nombre d'arguments attendus de la forme "min/max", "min/", "max" ou ""
|
* <nb\_arg> : nombre d'arguments attendus de la forme "min/max", "min/", "max" ou ""
|
||||||
si vide ou "0" alors l'option est booléene.
|
si vide ou "0" alors l'option est booléene.
|
||||||
la forme "min/" considere le nombre max non determiné (infini)
|
la forme "min/" considere le nombre max non determiné (infini)
|
||||||
|
|
||||||
* <def\_val> : Valeur par défaut assignée à <var>
|
* <def\_val> : Valeur par défaut assignée à <var>
|
||||||
Fonctionne si <nb\_arg> vaut 0/1 1/1
|
Fonctionne si <nb\_arg> vaut 0/1 1/1
|
||||||
|
|
||||||
* <OptE> : Liste des options mutellement exclusives séparées par une virgule.
|
* <OptE> : Liste des options mutellement exclusives séparées par une virgule.
|
||||||
|
|
||||||
* <OptI> : Liste des options inclusives séparées par une virgule.
|
* <OptI> : Liste des options inclusives séparées par une virgule.
|
||||||
|
|
||||||
Lors de l'initialisation les marqueurs "@OPT" sont lues et analysées.
|
Lors de l'initialisation les marqueurs "@OPT" sont lues et analysées.
|
||||||
Le résultat est comparé aux arguments et options sousmis au script
|
Le résultat est comparé aux arguments et options sousmis au script
|
||||||
et les variables suivantes son initialisées ...
|
et les variables suivantes son initialisées ...
|
||||||
|
|
||||||
* SH\_OPTION\_<nom> : Initialisée à "1" (Vrai) ou "0" (Faux) selon que l'option est respectivement utilisée ou non.
|
* SH\_OPTION\_<nom> : Initialisée à "1" (Vrai) ou "0" (Faux) selon que l'option est respectivement utilisée ou non.
|
||||||
Il existe toujours une variable par option déclarée. Ceci concerne aussi les options par défaut géré par la bibliothèque params.lib
|
Il existe toujours une variable par option déclarée. Ceci concerne aussi les options par défaut géré par la bibliothèque params.lib
|
||||||
|
|
||||||
* SH\_ARG\_<nom> : Cette variable existe uniquement si le champ <var> est null et si le type n'est pas booléen.
|
* SH\_ARG\_<nom> : Cette variable existe uniquement si le champ <var> est null et si le type n'est pas booléen.
|
||||||
Par défaut elle est initialisée à null ou avec la valeur <def\_val>
|
Par défaut elle est initialisée à null ou avec la valeur <def\_val>
|
||||||
Si le champ <var> est renseigné, alors SH\_ARG\_<nom> est remplacée pas <var>.
|
Si le champ <var> est renseigné, alors SH\_ARG\_<nom> est remplacée pas <var>.
|
||||||
Si l'option associée peut prendre plusieurs arguments, alors les variables SH\_ARG\_<nom> ou <var> sont des tableaux dont l'index commence a zéro.
|
Si l'option associée peut prendre plusieurs arguments, alors les variables SH\_ARG\_<nom> ou <var> sont des tableaux dont l'index commence a zéro.
|
||||||
La taille du tableau peut etre récuperée via ${#SH\_ARG\_<nom>[*]} ou ${#<var>[*]}.
|
La taille du tableau peut etre récuperée via ${#SH\_ARG\_<nom>[*]} ou ${#<var>[*]}.
|
||||||
|
|
||||||
Les options -h, -s, -log [id], -hist [N] et -dbg N sont prises en charge automatiquement. Ces noms sont donc reservées.
|
Les options -h, -s, -log [id], -hist [N] et -dbg N sont prises en charge automatiquement. Ces noms sont donc reservées.
|
||||||
|
|
||||||
@ -326,26 +326,26 @@ La description consiste en une liste de paramètres séparés par ":"
|
|||||||
|
|
||||||
L'ordre des paramètres est figé et tous doivent être présents.
|
L'ordre des paramètres est figé et tous doivent être présents.
|
||||||
|
|
||||||
* <type> : Propriéte de l'attribu défini par l'aggrégation des lettres suivantes:
|
* <type> : Propriéte de l'attribu défini par l'aggrégation des lettres suivantes:
|
||||||
|
|
||||||
f -> Argument falcultative
|
f -> Argument falcultative
|
||||||
o -> Argument obligatoire
|
o -> Argument obligatoire
|
||||||
M -> Argument transforme en majuscule
|
M -> Argument transforme en majuscule
|
||||||
|
|
||||||
* <var> : nom de la variable dans laquelle sera stockée le(s) argument(s)
|
* <var> : nom de la variable dans laquelle sera stockée le(s) argument(s)
|
||||||
si plusieurs arguments alors un tableau sera initialisé <var[n]>
|
si plusieurs arguments alors un tableau sera initialisé <var[n]>
|
||||||
L'index [n] commence a zero.
|
L'index [n] commence a zero.
|
||||||
Le nombre d'arguments effectivement passés à la commande est "${#<var>[*]}".
|
Le nombre d'arguments effectivement passés à la commande est "${#<var>[*]}".
|
||||||
La valeur max de l'index [n] est "${#<var>[*]} - 1".
|
La valeur max de l'index [n] est "${#<var>[*]} - 1".
|
||||||
|
|
||||||
Si <var> n'est pas renseigné alors la variable SH\_ARGS[] est initialisée
|
Si <var> n'est pas renseigné alors la variable SH\_ARGS[] est initialisée
|
||||||
|
|
||||||
* <nb\_arg> : nombre d'arguments attendus de la forme "min/max", "min/", "max" ou "".
|
* <nb\_arg> : nombre d'arguments attendus de la forme "min/max", "min/", "max" ou "".
|
||||||
si vide alors on considère que le nombre d'arguments est a minima de 1.
|
si vide alors on considère que le nombre d'arguments est a minima de 1.
|
||||||
la forme "min/" considère le nombre est a minima de "min".
|
la forme "min/" considère le nombre est a minima de "min".
|
||||||
|
|
||||||
* <def\_val> : Valeur par défaut assignée a <var>
|
* <def\_val> : Valeur par défaut assignée a <var>
|
||||||
Fonctionne si <nb\_arg> vaut 0/1 1/1
|
Fonctionne si <nb\_arg> vaut 0/1 1/1
|
||||||
|
|
||||||
ATTENTION:
|
ATTENTION:
|
||||||
Si le caractère "&" est présent dans la valeur d'un argument, alors cette valeur doit être encadrée
|
Si le caractère "&" est présent dans la valeur d'un argument, alors cette valeur doit être encadrée
|
||||||
@ -481,7 +481,7 @@ assurer une homogénéite dans l'ensemble du socle.
|
|||||||
|
|
||||||
|
|
||||||
Note : La construction G\_VAR1=${G\_AVR1:="Valeur par défaut"} permet de définir une variable avec une
|
Note : La construction G\_VAR1=${G\_AVR1:="Valeur par défaut"} permet de définir une variable avec une
|
||||||
valeur par défaut, qui peut être surchargée dans le fichier de configuration {NC\_EXPL\_CFG}/<Nom\_du\_script>.conf
|
valeur par défaut, qui peut être surchargée dans le fichier de configuration {NC\_EXPL\_CFG}/<Nom\_du\_script>.conf
|
||||||
|
|
||||||
Concernant les fonctions /fct\_message/ et /fct\_erreur/ voir le chapitre V.
|
Concernant les fonctions /fct\_message/ et /fct\_erreur/ voir le chapitre V.
|
||||||
|
|
||||||
@ -510,7 +510,7 @@ Cette analyse ne fonctionne que si les options ont été déclarées dans l'ent
|
|||||||
### 1 - Fichiers temporaires
|
### 1 - Fichiers temporaires
|
||||||
|
|
||||||
Les fichiers temporaires doivent etre écrits dans le répertoire ${NC\_EXPL\_TMP}.
|
Les fichiers temporaires doivent etre écrits dans le répertoire ${NC\_EXPL\_TMP}.
|
||||||
Les noms des fichiers temporaires sont de la forme : <Libre>\_${SH\_SESSION\_ID}.tmp
|
Les noms des fichiers temporaires sont de la forme : <Libre>\_${SH\_SESSION\_ID}.tmp
|
||||||
De cette facon il seront gérés par le socle (Suppresion automatique).
|
De cette facon il seront gérés par le socle (Suppresion automatique).
|
||||||
|
|
||||||
### 2 - Nom des exécutables (fichiers du dossier ${EXPL\_ROOT}/bin )
|
### 2 - Nom des exécutables (fichiers du dossier ${EXPL\_ROOT}/bin )
|
||||||
@ -558,13 +558,15 @@ 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".
|
|
||||||
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
|
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 :
|
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".
|
||||||
@ -574,8 +576,8 @@ Par défaut le niveau de debug est 0, ainsi si "N" vaut zero alors le message es
|
|||||||
|
|
||||||
### 2 - fct\_affiche\_ligne
|
### 2 - fct\_affiche\_ligne
|
||||||
|
|
||||||
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
|
||||||
@ -644,8 +646,8 @@ 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 appelee pour sortir d un script du socle.
|
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 affiche le message d erreur associe au code qui est lu dans le fichier ${NC\_EXPL\_MSG}/<script>.msg
|
||||||
|
Loading…
Reference in New Issue
Block a user