"Conversion README en markdown"

This commit is contained in:
Doug Le Tough 2017-07-21 12:58:27 +02:00
parent 964fd90a77
commit b5ad5d135b
1 changed files with 13 additions and 1 deletions

View File

@ -55,6 +55,8 @@ Sous l'arborescence ${NC\_EXPL\_ROOT} on trouve les dossiers suivants :
| {Racine}/tmp | Contient les fichiers temporaires des scripts | | {Racine}/tmp | Contient les fichiers temporaires des scripts |
+-----------------+-----------------------------------------------------------------------------------------------+ +-----------------+-----------------------------------------------------------------------------------------------+
Note : Sous chaque dossier vous trouverez un fichier texte lisezmoi.txt decrivant l'usage du répertoire. Note : Sous chaque dossier vous trouverez un fichier texte lisezmoi.txt decrivant l'usage du répertoire.
@ -102,6 +104,8 @@ Il y a cependant une spécificite pour SH\_RETENTION\_CPT et SH\_RETENTION\_LOG:
| NC_EXPL_SRVBATCH | Nom du serveur Batch | | NC_EXPL_SRVBATCH | Nom du serveur Batch |
+-------------------+----------------------------+ +-------------------+----------------------------+
Les variables NC\_EXPL\_ROOT, EXPL\_ROOT et NC\_EXPL\_SRVBATCH sont définies dans le fichier "tetalab.sh" Les variables NC\_EXPL\_ROOT, EXPL\_ROOT et NC\_EXPL\_SRVBATCH sont définies dans le fichier "tetalab.sh"
Les autres variables NC\_* sont définies dans le fichier "profile\_init.env" Les autres variables NC\_* sont définies dans le fichier "profile\_init.env"
@ -131,6 +135,8 @@ Cette liste n'est pas exhaustive, seules les principales variables sont citées.
| SH_RETENTION_LOG | Vaut 8 par défaut. Duree de rétention en jours des fichiers de traces | | SH_RETENTION_LOG | Vaut 8 par défaut. Duree de rétention en jours des fichiers de traces |
+--------------------+-------------------------------------------------------------------------------+ +--------------------+-------------------------------------------------------------------------------+
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. si la gestion des options a été activée.
@ -187,7 +193,9 @@ 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 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 pour garantir la fiabilité de l'information. Ce sont ces lignes, qui sont lues lors de l'utilisation de
l'option par defaut "-h". l'option par defaut "-h".
@ -419,6 +427,7 @@ Remarque: L'analyse des options et arguments est aussi réalisée par "${NC\_EXP
+----------------------------------------------------------------------------------------------------+ +----------------------------------------------------------------------------------------------------+
### 3 - Structure d'un script ### 3 - Structure d'un script
Voici les éléments qui devraient être présents a minima dans les script Bash. Ceci est recommandé pour Voici les éléments qui devraient être présents a minima dans les script Bash. Ceci est recommandé pour
@ -481,6 +490,8 @@ 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
@ -523,6 +534,7 @@ Les noms des fichiers doivent être de la forme :
<pre>_<app_source>_<app_dest>[_<libre>].<language> <pre>_<app_source>_<app_dest>[_<libre>].<language>
<app>_<descr>.<language> <app>_<descr>.<language>
* <pre> : est une des valeurs suivantes : "sys", "dba", "exp", "ctl", "aud", "int" * <pre> : est une des valeurs suivantes : "sys", "dba", "exp", "ctl", "aud", "int"
* "sys" : Scrits d'administration système. * "sys" : Scrits d'administration système.
* "dba" : Scripts d'administration base de données * "dba" : Scripts d'administration base de données