From 5eea73ae127db783a2a336447115b890155194f0 Mon Sep 17 00:00:00 2001 From: Doug Le Tough Date: Fri, 21 Jul 2017 15:30:30 +0200 Subject: [PATCH] "Conversion README en markdown" --- README.md | 78 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 40 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 6c1f710..1c0d9ae 100755 --- a/README.md +++ b/README.md @@ -200,15 +200,15 @@ l'option par defaut "-h". ##### 1.1.1 Meta-données - : peut prendre les valeurs suivantes -> cre, ano, evo, typo +<Action> : peut prendre les valeurs suivantes -> cre, ano, evo, typo * cre : Création du script. * evo : Évolution du script -> Ajout de nouvelles fonctionnalités, Amélioration du code. * ano : Correction du code suite à un comportement inattendu. * typo : Ajout de commentaires, de texte ou corrections gramaticales sans influence sur le code. - : +<Auteur> : <Prenom> <Nom> - : 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). ##### 1.1.2 Paragraphe @@ -254,43 +254,43 @@ Exemple de déclaration valide : # @OPT: oM:i:G_INSTANCE:1/1:ALL:dbid: # @OPT: oM:pr:G_PR_NOM:1/1:sq,t,l: - * : 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 * b -> Booléen * o -> Option obligatoire * M -> Argument transformé en majuscule - * : 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. - * : nom de la variable dans laquelle sera stockée le(s) argument(s) -si plusieurs arguments alors un tableau sera initialisé + * <var> : nom de la variable dans laquelle sera stockée le(s) argument(s) +si plusieurs arguments alors un tableau sera initialisé <var[n]> L'index [n] commence à zero. Le nombre d'arguments éffectivement passés a la commande est "${#[*]}". La valeur max de l'index [n] est "${#[*]} - 1". - * : 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. la forme "min/" considere le nombre max non determiné (infini) - * : Valeur par défaut assignée à -Fonctionne si vaut 0/1 1/1 + * <def\_val> : Valeur par défaut assignée à <var> +Fonctionne si <nb\_arg> vaut 0/1 1/1 - * : Liste des options mutellement exclusives séparées par une virgule. + * <OptE> : Liste des options mutellement exclusives séparées par une virgule. - * : 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. Le résultat est comparé aux arguments et options sousmis au script et les variables suivantes son initialisées ... - * SH\_OPTION\_ : 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 - * SH\_ARG\_ : Cette variable existe uniquement si le champ est null et si le type n'est pas booléen. -Par défaut elle est initialisée à null ou avec la valeur -Si le champ est renseigné, alors SH\_ARG\_ est remplacée pas . -Si l'option associée peut prendre plusieurs arguments, alors les variables SH\_ARG\_ ou sont des tableaux dont l'index commence a zéro. -La taille du tableau peut etre récuperée via ${#SH\_ARG\_[*]} ou ${#[*]}. + * 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> +Si le champ 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. +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. @@ -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. - * : 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 o -> Argument obligatoire M -> Argument transforme en majuscule - * : nom de la variable dans laquelle sera stockée le(s) argument(s) -si plusieurs arguments alors un tableau sera initialisé + * <var> : nom de la variable dans laquelle sera stockée le(s) argument(s) +si plusieurs arguments alors un tableau sera initialisé <var[n]> L'index [n] commence a zero. -Le nombre d'arguments effectivement passés à la commande est "${#[*]}". -La valeur max de l'index [n] est "${#[*]} - 1". +Le nombre d'arguments effectivement passés à la commande est "${#<var>[*]}". +La valeur max de l'index [n] est "${#<var>[*]} - 1". -Si 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 - * : 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. la forme "min/" considère le nombre est a minima de "min". - * : Valeur par défaut assignée a -Fonctionne si vaut 0/1 1/1 + * <def\_val> : Valeur par défaut assignée a <var> +Fonctionne si <nb\_arg> vaut 0/1 1/1 ATTENTION: 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 -valeur par défaut, qui peut être surchargée dans le fichier de configuration {NC\_EXPL\_CFG}/.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. @@ -510,7 +510,7 @@ Cette analyse ne fonctionne que si les options ont été déclarées dans l'ent ### 1 - Fichiers temporaires Les fichiers temporaires doivent etre écrits dans le répertoire ${NC\_EXPL\_TMP}. -Les noms des fichiers temporaires sont de la forme : \_${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). ### 2 - Nom des exécutables (fichiers du dossier ${EXPL\_ROOT}/bin ) @@ -558,13 +558,15 @@ réccurente de l'application. ### 1 - fct\_message Syntaxe : fct\_message [-cpt] [-hist] [-nolog] [-debug N] [-color Couleur] "" -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}/.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 : -* -cpt : Écrit en plus du journal dans le fichier de compte-rendu ${NC\_EXPL\_CPT}/.cpt -* -hist : Écrit uniquement dans le fichier d'historique des exécutions ${NC\_EXPL\_TRC}/.hist +* -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". @@ -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 -Syntaxe : fct\_affiche\_ligne [entete|pied] -Usage : Affiche un tableau sur la sortie standard et dans le fichier compte-rendu ${NC\_EXPL\_ROOT}/