Comment naviguer dans les rubriques de la documentation de Vim?

Dans le système d'aide intégré de Vim, comment puis-je…

• rechercher des sujets pour lesquels je souhaite de l'aide?
• suivre des hyperliens?
• parcourir autour pour le matériel connexe?

Vim est livré avec une documentation exhaustive et entièrement indexée qui contient les réponses à la plupart des questions que vous pourriez avoir sur l’utilisation de Vim.

Mais la documentation est énorme et peut considérer le néophyte comme un labyrinthe impénétrable. Voici quelques lignes directrices pour vous aider à trouver ce dont vous avez besoin…

1. La :helpcommande est votre passerelle vers la documentation de Vim. Lire le premier écran maintenant .

   :help
   

   Allons méta:

   :help help
   

2. Vous pouvez compléter les arguments avec <Tab>et afficher la liste des complétions possibles avec <C-d>.

   :help buf<Tab>
   :help :w<C-d>
   

   À propos, voici une explication de la notation de la clé:

   :help key-notation
   

3. La plupart des commandes Ex peuvent être réduites à quelques caractères. C'est vrai pour :helpaussi:

   :h
   

4. La :helpcommande et sa complétion par des tabulations sont sensibles à la casse. Les deux commandes ci-dessous vous mèneront à la même section:

   :h BufWritePost
   :h bufwritepost
   

   Notez que aet Asont les deux commandes légitimes si insensibilité à la casse ne joue pas.

5. Si vous ne recherchez qu'un mot-clé générique, utilisez :helpgrepet ouvrez la fenêtre de correction rapide:

   :helpgrep quickfix
   :copen
   

6. Utilisez <C-]>sur les mots en surbrillance <C-t>pour accéder à la balise correspondante, utilisez pour revenir.

   Voir :help tagspour plus.

7. Faites défiler la liste pour voir s'il existe une option ou une commande associée qui répond le mieux à vos besoins. C'est aussi un excellent moyen d'apprendre de nouvelles astuces.

8. Utilisez la bonne syntaxe pour rechercher plus efficacement:

   :h :command                        " help for ex-command 'command'
   :h 'option'                        " help for option 'option'
   :h function()                      " help for function 'function'
   :h modifier-key                    " help for 'modifier'-'key' in normal mode
   :h mode_modifier-key               " help for 'modifier'-'key' in 'mode'
   :h mode_modifier-key_modifier-key  " help for 'modifier'-'key' 'modifier'-'key' in 'mode'
   

   Exemples:

   :h :sort
   :h 'ai                " only one quote needed
   :h bufnr(             " no need for both parenthesis
   :h v_ctrl-g
   :h i_ctrl-x_ctrl-o
   :h ctrl-w             " no mode required for normal mode
   

9. Anatomie d'une :helpsection:

   :help ballooneval'
   

   

   • Les mots surlignés en rouge sont les balises associées à cette option.
   • Les mots en vert sont la forme longue et la forme courte du nom de l’option.
   • La première ligne en blanc indique que c'est une option booléenne et qu'elle est désactivée par défaut, voir :help options.
   • La deuxième ligne en blanc indique que l'option est globale, voir :help option-summary.
   • Les lignes violettes sont explicites.
   • Vient ensuite la description de l'option.
   • Les mots turquoises sont des "balises" qui vous permettent de passer à une autre partie de la documentation. N'ayez pas peur de les suivre.

10. Utilisez votre cerveau, trouvez des modèles logiques qui vous aideront pour vos recherches futures.

    Une fois que vous avez trouvé le moyen pratique :help list-functions, où chercher des fonctions liées aux chaînes?

    Une fois que vous avez trouvé :help i_ctrl-x_ctrl-o, comment pouvez-vous trouver de l'aide <C-x><C-l>en mode insertion?

11. RTFM n'est pas une insulte. Vous apprendrez beaucoup plus en lisant la documentation que en posant des questions à courte vue à des étrangers au hasard alors assurez-vous au moins essayé de R ead T il F antastic M anuel avant de demander.

-0.1 prendre des notes sur vim dans un fichier. Utilisez-le comme référence et conteneur.

1. moyen rapide de trouver de l'aide vim key | :cmd | 'option' | etc

   • :h giou :h g;pour giou g;en mode normal
   • :h ^ipour Ctrl- ien mode normal
   • :h ^w^wpour Ctrl- wCtrl- wen mode normal
   • :h ^wfpour Ctrl- wfen mode normal
   • :h i^npour le mode insertion Ctrl-n
   • :h c^r^rpour le mode cmdline Ctrl- r Ctrl-r
   • :h :pu pour ex-command :put
   • :h 'cb'pour option clipboard.
   • :h `>pour la marque <.
   • :h @:pour option repeat last ex command by eval register :(même mécanisme que macro).

   • tapez :h range, à ce stade, vous êtes en mode cmdline, puis:

     • type Ctrl- apour compléter tous les candidats qui contiennentrange
     • type Ctrl- fpour afficher une petite fenêtre d'édition[Command Line]
     • tapez "*ddpour le couper dans le presse-papier du système.
     • tapez oet Enterpour annuler et quitter la fenêtre[Command Line]
     • h :range range() <range> [range] :func-range ... est extrait
     • de même, h mode-Ex mode-replace mode-cmdline mode-switching ...est extrait pour mode-.
     • mot similaire qui pourrait être intéressant:, buf win tab lineetc.
     • summary: celui-ci montre un moyen de trouver des éléments intéressants à partir d’un mot-clé à l’aide de cmdline-completion.

-0.2 Définir un mappage de clé local avec un tampon pour appeler vim help du mot sous le curseur, dans le fichier vim notes mentionné précédemment.
(et éventuellement avec post-traitement après extraction <cword>, dans une fonction vimscript)