Syntaxe du fichier d'options

Auteur: gwen (gwenael.remond(at)ac-dijon.fr)
Version: draft
Description:documentation sphynx
Info:cf http://eole.orion.education.fr/depot Eole1/sphynx/sphynx-vpn/tunnel/doc/

détail de la syntaxe du fichier d'options pour l'ajout d'établissement

Parties du fichier

Le séparateur des parties du fichier est une ligne constituée d'au moins quatre tirets:

----

Définition des variables

La syntaxe des notations de variables est du type nom=valeur:

nom = valeur

Le type de séparateur de définition de la variable peut être :

Le séparateur peut-être entouré de caractères d'espacement :

La définition du nom de variable ne fait pas de différence entre majuscule et minuscule, de préférence en majuscule.

Des valeurs vides sont autorisées du type:

nom1 =

et dans ce cas, une chaîne vide est affectée à la variable.

Note

Il est inutile, même pour une valeur composée de plusieurs mots, d'utiliser des guillemets. Si néanmoins une valeur est entourée de guillemets, la valeur de la variable inclus les guillemets.

Important

Si le contenu de la variable est lui-même composé de séparateurs, ces séparateurs seront inclus dans le contenu de la variable par exemple pour une variable renseignée comme suit : nom = coin:plop, la valeur est coin:plop

Attention!

Toute valeur présente plusieurs fois dans une même partie du document sera comptabilité autant de fois que mentionné.

Lignes non prises en compte

Ces lignes sont considérées comme des lignes de remarques et ne sont donc pas prises en compte.

Un séparateur de ce type peut apparaître en cours de ligne, auquel cas la suite de la ligne n'est pas non plus prise en compte, par exemple:

nom = variable # définition de la variable nom