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îne 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 venez d'écrire l'expression (make-vector lg), pour vérifier que vous utilisez correctement make-vector, tapez C-h f make-vector RET. Puisque C-h f accepte tout nom de fonction, et pas seulement les noms de commandes, il est possible que certaines de vos abréviations favorites qui marchent avec M-x ne marchent plus avec C-h f. Une abréviation peut être unique parmi les noms de commandes mais ne plus l'être quand 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, qui est 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 le nom d'une fonction Lisp définie et valide. Par exemple, si le point se trouve juste après le texte (make-vector (car x), la liste la plus profonde contenant le point est celle commençant par (make-vector, le comportement par 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 une fonction Lisp définie. Si c'est tout ce que vous vouliez 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 à commande. 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 de 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.