post

Vim fr:Aide

Contents

Introduction

Vim possède une telle richesse de commandes, raccourcis claviers, buffers, et ainsi de suite, qu’il est impossible de tous les mémoriser. En fait, il n’est même pas utile de tous les connaître. La meilleure approche est de savoir où chercher une fonctionnalité dans Vim quand vous en avez besoin.

Par exemple, vous voulez éviter de saisir un nom long de nombreuses fois, vous vous souvenez que Vim a une fonctionnalité sur les abréviations, vous ne vous souvenez pas comment l’utiliser. Que faîtes-vous?

Regardons les différentes manières de trouver de l’aide pour utiliser Vim.

La commande:help

Le premier et plus important endroit où chercher de l’aide est la documentation fournie, et Vim a l’une des documentations les plus détaillées que je connaisse..

Dans notre cas, tapez juste :help abbreviation et vous aurez l’aide pour abbreviations et vous saurez comment utiliser les commandes :ab et :iab.

Parfois, c’est aussi simple que cela. Si vous ne savez pas ce que vous cherchez, vous pouvez taper :help user-manual et parcourir le sommaire de tout le manuel utilisateur et lire le chapitre qui vous semble s’appliquer à ce que vous essayez de faire.

Comment lire le:help topic

Prenons un peu de l’aide de :help abbreviate:

  :ab[breviate] [<expr>] {lhs} {rhs}
               add abbreviation for {lhs} to {rhs}.  If {lhs} already
               existed it is replaced with the new {rhs}.  {rhs} may
               contain spaces.
               See |:map-<expr>| for the optional <expr> argument.

Notez la manière standard pour écrire help dans Vim, afin de nous aider à découvrir les parties qui nous intéressent, au lieu d’essayer de comprendre la commande complète.

La première ligne explique la syntaxe, c’est à dire comment utiliser cette commande.

Les crochets ([]) dans :ab[breviate] indiquent que la dernière partie de la commande est optionnelle. Le minimum à taper est :ab afin que Vim reconnaisse la commande. Vous pouvez aussi utiliser :abb ou :abbr ou :abbre et ainsi de suite jusqu’à la commande complète :abbreviate. La plupart des personnes ont tendance à utiliser la forme la plus courte.

Les crochets ([]) dans [<expr>] indiquent à nouveau que l’ ‘expression’ est optionnelle.

Les accolades ({}) {lhs} {rhs} indiquent que ces placeholders pour les arguments doivent être fournis. Ce sont les abréviations pour ‘left hand side’ et ‘right hand side’ respectivement.

Il y a après la première ligne un paragraphe indenté qui explique brièvement ce que fait la commande.

Notez que le deuxième paragraphe vous indique plus d’informations. Vous pouvez positionner le curseur dans le texte entreles deux symboles pipe (|) et taper ctrl-] pour suivre le “lien” vers le sujet correspondant :help. Pour revenir, tapez ctrl-o.

La commande:helpgrep

Si vous ne connaissez pas le nom du topic que vous cherchez, vous pouvez rechercher une phrase dans la documentation complète en faisant :helpgrep. Supposons que vous cherchez comment trouver le début d’un mot, lancez juste :helpgrep beginning of a word.

Vous pouvez utiliser :cnext et :cprev pour vous déplacer à la partie suivante et précédente de la documentation contenant la phrase. Utilisez :clist pour voir la liste complète de toutes les occurrences de la phrase.

Une aide rapide

Copiez le texte suivant dans un fichier dans Vim et aussi lancez-le:

:let &keywordprg=':help'

Maintenant, positionnez votre curseur n’importe où sur le mot keywordprg et tapez juste K. Vous aurez immédiatement l’aide pour ce mot. Ce raccourci évite de taper :help keywordprg.

Les forums en ligne et IRC

Si vous n’arrivez pas à comprendre ce que vous voulez faire, la meilleure chose est de contacter des utilisateurs de Vim. Ne vous inquiétez pas, c’est très facile, c’est étonnant de constater combien les Vimmers sont serviables.

D’abord recherchez dans la mailing list Vim pour voir si quelqu’un a déjà répondu à votre question. Allez à Vim Group search page et entrez les mots-clés de votre question. La plupart du temps, beaucoup de questions communes ont déjà été répondues, car cette liste a une activité élevée.

Si vous ne trouvez pas de réponse pour votre cas, vous pouvez visiter le forum IRC Vim. Ouvrez une application IRC comme XChat (disponible pour Windows, Linux, BSD) ou Colloquy (pour Mac OS X), connectez-vous au réseau “FreeNode”, rejoignez le canal #vim et posez poliment votre question et attendez une réponse. La plupart du temps, quelqu’un répondra en quelques minutes. Il existe également un salon Jabber pour utilisateurs francophones: vim-fr@chat.jabberfr.org

Si personne ne répond à votre question, ils sont sans doute occupés, donc re-essayez plus tard ou reformulez votre question pour que l’on puisse vous répondre. Sinon, postez un message dans la mailing list mentionnée ci-dessus.

Récapitulatif

Il y a une richesse d’information sur la manière de faire des choses en utilisant Vim, et de nombreux Vimmers vous aideront volontiers. La communauté Vim est l’une des plus grandes forces de l’éditeur Vim, donc utilisez ses ressources et rejoignez également cette communauté qui grandit.

The true delight is in the finding out rather than in the knowing.

— Isaac Asimov