10.3. Aide par un Nom de Commande ou de Variable

C-h f (describe-function) attend le nom d'une fonction Lisp dans le mini-tampon, puis affiche la cha^ine de documentation de cette fonction dans une fenêtre. Les commandes étant des fonctions Lisp, vous pouvez utiliser cette touche pour obtenir la documentation d'une commande dont vous connaissez le nom. Par exemple,

C-h f auto-fill-mode RET

affiche la documentation de auto-fill-mode. C'est le seul moyen d'obtenir la documentation d'une commande qui n'est reliée à aucune touche (et que vous exécutez en utilisant M-x).

C-h f est aussi utile pour des fonctions Lisp que vous envisagez d'utiliser dans un programme Lisp. Par exemple, si vous avez juste écrit l'expression (make-vector lg) et voulez vérifier que vous utilisez correctement make-vector, tapez C-h f make-vector RET. Puisque C-h f permet tout nom de fonction, et non seulement les noms de commandes, il est possible que vous trouviez que certaines de vos abbréviations favorites qui marchent avec M-x ne marchent plus avec C-h f. Une abbréviation peut être unique parmi les noms de commandes mais peut ne pas l'être lorsque l'on ajoute les noms de fonctions à la liste des possibilités.

Le nom de la fonction à décrire par C-h f a une valeur par défaut utilisée si vous tapez RET en laissant le mini-tampon vide. La valeur par défaut est la fonction appelée par l'expression Lisp la plus profonde contenant le point, à condition que ce soit un nom de fonction Lisp définie et valide. Par exemple, si le point se trouve juste à la suite du texte (make-vector (car x), la liste la plus profonde contenant le point est celle commençant par (make-vector, le défaut est donc de décrire la fonction make-vector.

C-h f est aussi utile pour seulement vérifier qu'un nom de fonction est bien orthographié. Si C-h f mentionne un nom du tampon comme défaut, c'est que ce nom doit être défini comme une fonction Lisp. Si c'est tout ce que vous voulez savoir, tapez juste C-g pour annuler la commande C-h f et revenir à l'édition.

C-h w commande RET vous indique quelles touches sont reliées à command. Elle affiche une liste de touches dans la zone de répercussion. Si elle dit que cette commande n'est reliée à aucune touche, vous devez utiliser M-x pour l'exécuter. C-h w exécute la commande where-is.

C-h v (describe-variable) est similaire à C-h f mais décrit des variables Lisp plutôt que des fonctions Lisp. La valeur par défaut est le symbole Lisp autour ou avant le point, mais seulement si c'est le nom d'une variable Lisp connue. Section 32.2.

Les tampons d'aide décrivant des variables ou des fonctions définies en Lisp ont normalement un hyperlien vers la définition Lisp, si vous avez installé les fichiers sources Lisp. Si vous connaissez Lisp, ceci fournit la documentation ultime. Si vous ne connaissez pas Lisp, vous devriez l'apprendre. Si vous traitez Emacs comme un fichier objet, alors vous utilisez seulement Emacs. Pour une réelle intimité avec Emacs, vous devez lire le code source.