"Conversion README en markdown"
This commit is contained in:
parent
aa4596c8b7
commit
484fc432d7
70
README.md
70
README.md
@ -128,8 +128,8 @@ script.
|
||||
|
||||
Il y a cependant une spécificite pour **SH\_RETENTION\_CPT** et **SH\_RETENTION\_LOG**:
|
||||
|
||||
ces variables sont definies une et une seule fois lors de la première initialisation. Ce qui signinfie qu'un
|
||||
script qui aurait surchargé ces variables ignorera l'initialisation de ces variable si il est appelé par un
|
||||
ces variables sont définies une et une seule fois lors de la première initialisation. Ce qui signifie qu'un
|
||||
script qui aurait surchargé ces variables ignorera l'initialisation de ces variables si il est appelé par un
|
||||
autre script.
|
||||
|
||||
|
||||
@ -190,7 +190,7 @@ Cette liste n'est pas exhaustive, seules les principales variables sont citées.
|
||||
|
||||
|
||||
|
||||
Remarque : Les variables SH\_SILENCE et SH\_NIV\_DEBUG sont controlées par les options "-s" et "-dbg"
|
||||
Remarque : Les variables **SH\_SILENCE** et **SH\_NIV\_DEBUG** sont controlées par les options "**-s**" et "**-dbg**"
|
||||
si la gestion des options a été activée.
|
||||
|
||||
|
||||
@ -245,39 +245,40 @@ Les scripts doivent commencer par le cartouche ci-dessous :
|
||||
|
||||
|
||||
|
||||
Note : Les lignes commençant par 2 "#" sont utilisées pour générer l'aide, leur maintient est donc nécéssaire
|
||||
pour garantir la fiabilité de l'information. Ce sont ces lignes, qui sont lues lors de l'utilisation de
|
||||
l'option par defaut "-h".
|
||||
**Note:** Les lignes commençant par 2 "#" sont utilisées pour générer l'aide, leur maintient est donc nécéssaire
|
||||
pour garantir la fiabilité de l'information. Ce sont ces lignes qui sont lues lors de l'utilisation de
|
||||
l'option par defaut "**-h**".
|
||||
|
||||
#### 1.1 Elements du cartouche
|
||||
|
||||
##### 1.1.1 Meta-données
|
||||
|
||||
* <Action> : peut prendre les valeurs suivantes:
|
||||
* **<Action>**: peut prendre les valeurs suivantes:
|
||||
|
||||
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>
|
||||
* **<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).
|
||||
|
||||
##### 1.1.2 Paragraphe
|
||||
|
||||
* Mise à jour : Ce paragraphe est utilisé pour suivre l'evolution des versions. La dernière version en
|
||||
* **Mise à 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.
|
||||
|
||||
* Dépendance : Permet de définir la liste ainsi que la version des scripts qui sont appelés.
|
||||
* **Dépendance**: Permet de définir la liste ainsi que la version des scripts qui sont appelé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.
|
||||
|
||||
* Liste des options : La déclaration des options n'est pas obligatoire.
|
||||
* **Liste des options**: La déclaration des options n'est pas obligatoire.
|
||||
|
||||
Si aucune déclaration n'est présente alors la bibliothèque params.lib ne fait aucune action.
|
||||
Dans ce cas les options par défaut -h, -log, -hist, -cpt, -s et -dbg ne seront pas disponible.
|
||||
Dans ce cas les options par défaut **-h**, **-log**, **-hist**, **-cpt**, **-s** et **-dbg** ne
|
||||
seront pas disponibles.
|
||||
|
||||
Si le script ne nécessite pas d'option mais que l'on souhaite disposer des options par défaut, il
|
||||
faudra déclarer une option bidon.
|
||||
@ -285,8 +286,9 @@ faudra déclarer une option bidon.
|
||||
# @OPT: f:bidon::::::
|
||||
|
||||
Si la déclaration existe alors le socle gèrera les paramètres en entrée du script, ainsi que
|
||||
les options par défaut -h, -log, -hist, -cpt, -s et -dbg. Ces mots clé sont reservés et ne
|
||||
peuvent pas être utilisé par le script.
|
||||
les options par défaut **-h**, **-log**, **-hist**, **-cpt**, **-s** et **-dbg**.
|
||||
|
||||
**Ces mots clé sont reservés et ne peuvent pas être utilisés par le script.**
|
||||
|
||||
La déclaration est réalisée dans le paragraphe "Liste des options et arguments". Chaque
|
||||
option est identifiée par l'entête de ligne "# @OPT:" suivi de la description.
|
||||
@ -297,7 +299,7 @@ La description consiste en une liste de paramètres séparés par ":"
|
||||
|
||||
L'ordre des paramètres est figé et tous doivent etre présents.
|
||||
|
||||
8 champs sont obligatoires, soit 7 caractères ":" (on ne compte pas le caracatère ":" suivant @OPT).
|
||||
**8 champs sont obligatoires**, soit 7 caractères ":" (on ne compte pas le caracatère ":" suivant @OPT).
|
||||
|
||||
Exemple de déclaration valide :
|
||||
|
||||
@ -309,7 +311,7 @@ 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:
|
||||
|
||||
* <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
|
||||
b -> Booléen
|
||||
@ -317,37 +319,37 @@ Exemple de déclaration valide :
|
||||
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]>
|
||||
L'index [n] commence à zero.
|
||||
Le nombre d'arguments effectivement passés à la commande est ${#<var>[\*]}.
|
||||
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.
|
||||
la forme "min/" considere le nombre max non determiné (infini)
|
||||
la forme "**min/**" considère le nombre max non determiné (infini)
|
||||
|
||||
* <def\_val> : Valeur par défaut assignée à <var>
|
||||
Fonctionne si <nb\_arg> vaut 0/1 1/1
|
||||
* **<def\_val>**: Valeur par défaut assignée à **<var>**
|
||||
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.
|
||||
Le résultat est comparé aux arguments et options sousmis au script
|
||||
et les variables suivantes son initialisé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 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
|
||||
|
||||
* 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 champs <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.
|
||||
La taille du tableau peut etre récuperée via ${#SH\_ARG\_<nom>[\*]} ou ${#<var>[\*]}.
|
||||
* **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 champs **<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. 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.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user