"Conversion README en markdown"

This commit is contained in:
Doug Le Tough 2017-07-21 23:34:15 +02:00
parent d39c37bbc6
commit 83a92eb3a1
1 changed files with 40 additions and 53 deletions

View File

@ -661,14 +661,14 @@ renvoie un code retour au script appelant.
N est un entier positif dont les valeurs suivantes sont reservées :
* 0 : Fin normale du script
* 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
* 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 été remontée par la bibliothèque
* 255 : <lib:fct_erreur> Appel de la bibliothèque avec un numero d'erreur >= 250
* 256 : réservé pour un futur usage
0 : Fin normale du script
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
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 été remontée par la bibliothèque
255 : <lib:fct_erreur> Appel de la bibliothèque avec un numero d'erreur >= 250
256 : réservé pour un futur usage
@ -688,58 +688,45 @@ Un code par ligne de la forme :
* <message> : Message à afficher (dans les traces et sur la sortie standard). Ce champs peut contenir
des variables qui seront valorisées.
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 :
### 4 - fct\_unique\_exec
5 - fct\_libere\_exec
--- ---------------
Syntaxe : fct\_libere\_exec [<nom>]
Usage : Libere les semaphores
Fonction :
* Syntaxe : fct\_unique\_exec [<nom>] [<Occurences>]
* Usage : Empeche l'exécution multiple d'un code par l'acquisition de sémaphore
* Fonction : [DOCUMENTATION MANQUANTE]
6 - fct\_usage
--- ---------
### 5 - fct\_libere\_exec
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 :
* Syntaxe : fct\_libere\_exec [<nom>]
* Usage : Libère les sémaphores
* Fonction : [DOCUMENTATION MANQUANTE]
8 - fctpath
--- -------
### 6 - fct\_usage
Syntaxe :
Usage :
* Syntaxe : fct\_usage
* Usage : Affiche l'aide du script. Ce sont les lignes du cartouche commencant par "##"
* Fonction : Cette fonction est uniquement à usage interne du socle. Elle est intégrée à la fonction fct\_params.
Fonction :
### 7 - fct\_rotation
9 - fct\_params
--- ----------
* Syntaxe : [DOCUMENTATION MANQUANTE]
* Usage : [DOCUMENTATION MANQUANTE]
* Fonction : [DOCUMENTATION MANQUANTE]
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
### 8 - fctpath
* Syntaxe : [DOCUMENTATION MANQUANTE]
* Usage : [DOCUMENTATION MANQUANTE]
* Fonction : [DOCUMENTATION MANQUANTE]
### 9 - fct\_params
* Syntaxe: fct\_params
* Usage: Gestion des options et arguments du script
* Fonction : Cette fonction est uniquement à usage interne du socle.
Elle est appelée à l initialisation des variables de session lors du chargement du fichier ${NC\_EXPL\_CFG}/init.conf
Cette fonction extrait les lignes de déclaration "# OPT:" et les compare aux arguments sousmis au script.
Pour plus d information voir le paragraphe III-1.1.2