Aide utilisateur sous GRASS

lun 01-11-2010 Eve Rousseau

SIG OpenSource

Utiliser l'aide sous GRASS. Les différents systèmes d'aide : mode de consultation et contenu.

Le manuel GRASS

Le manuel constitue la seule aide officielle GRASS, ce qui n'empêche pas des documentations complémentaires d'exister. Il existe un manuel utilisateur pour chaque version de GRASS : GRASS 5.4, GRASS 6.0, GRASS 6.1.

Appel du manuel (format html)

Selon l'interface GRASS que vous utilisez, vous l'appelerez soit directement à partir de la barre de menu (Gestionnaire SIG), soit à partir de l'onglet manuel de la GRASS ToolBox (pour chacune des commandes disponibles dans la boîte à outils GRASS de l'interface QGIS).
Dans tous les cas, vous pouvez accéder directement aux pages du manuel pour la commande qui vous intéresse en entrant dans la console g.manual machin.patin.couffin. GRASS lance alors un navigateur internet pour afficher la page au format html.

Cette aide vous fournit des précisions sur :

l'usage de la commande avec l'ensemble des options et paramètres possibles,
une description étendue de l'utilisation de la commande, de son contexte précis d'utilisation,
très souvent, des exemples de passage de commande,
les auteurs du module et de ses différentes mises à jour.

Appel de l'aide concise (en console)

Il est également possible d'appeler l'aide concise d'une commande qui s'affiche directement dans la console GRASS machin.patin.couffin -help.
Dans la capture ci-dessous : on peut voir l'appel de l'aide pour la commande d.rast. L'aide concise comprend :

une courte description de l'utilisation de la commande,
la manière d'exécuter la commande où :
- les drapeaux (flags) doivent être précédés d'un tiret - par exemple, d.rast -o,
- les paramètres non optionnels sont présentés sans crochets - d.rast map=une_couche_raster,
- les paramètres optionnels sont présentés entre crochets,
- les paramètres qui peuvent recevoir des listes de valeurs, et la façon de séparer les éléments de la liste (ici des virgules),
la signification des différentes options (les drapeaux précédés d'un tiret), avec les éventuelles restrictions d'usage),
la signification des différents paramètres avec les éventuelles restrictions d'usage ou les valeurs que peuvent prendre certains paramètres comme ici la couleur de fond.