help

Scilab Function
Last update : 25/04/2007

help - commande d'aide en ligne

### Calling Sequence

  `help(key)`

### Parameters

- `key` : Une chaîne de caractères. Donne le nom de la page d'aide à visualiser.

### Description

`help` sans argument, visualise la page hypertexte contenat la liste des chapitres d'aide.

`help(key)` visualise la page d'aide associé avec le nom donné par `key` . S'il n'y a pas de page d'aide, `help(key)` appele automatiquement `apropos(key)` .

Scilab comprend son propre browser html écrit en TCL/TK. Il est possible de choisir un autre browser. La variable globale `%browsehelp` contient une chaîne de caractères définissant quel browser doit être utilisé. Sa valeur initiale est fixée par le fichier startup `SCIHOME/.scilab` ou `SCIHOME/scilab.ini` est peut être changée.

Si cette variable est affectée à la matrice vide ( `global %browsehelp; %browsehelp=[]` ) alors une fenêtre de dialogue apparait au lancement du help et permet de choisir le browser désiré. Attention, les differents browsers on des synatxes d'appel différentes. Aussi si vous souhaitez ajouter un nouveau browser à la liste vous devrez modifier la fonction Scilab `browsehelp` dont le code source est dans `SCI/macros/util/browsehelp.sci` .

Voir `man` pour apprendre à écrire de nouvelles pages d'aide.

### See Also

`apropos` , `man` ,