Curso de Vim: La ayuda de #Vim

Aprendamos a utilizar y consultar la propia ayuda que ofrece el editor Vim

La documentación de un proyecto es una pieza fundamental. Tener una documentación actualizada, detallada y que cubra los aspectos de uso y explotación de una herramienta es un punto extra.

Dentro de esa documentación la ayuda que pueda ofrecer una herramienta es una buena forma de resolver dudas y dar a conocer todas las posibilidades que ofrece dicha herramienta.

El edito Vim, en ese aspecto es un buen ejemplo. La propia ayuda de Vim es útil y explora todas las posibles opciones que ofrece Vim. Veamos cómo explorar la ayuda de Vim y ver qué opciones ofrece.

Este artículo es una nueva entrega del curso “improVIMsado” que desde hace meses vengo publicando en mi blog sobre el editor Vim y que puedes seguir en estos enlaces:

• https://victorhckinthefreeworld.com/tag/vim/
• https://victorhck.gitlab.io/comandos_vim/articulos.html

La ayuda de Vim

Dentro del editor Vim, siempre podemos cosultar la propia ayuda que ofrece (en inglés) estando en modo normal con el comando:

:help

O con :h que es el modo abreviado. Y nos abrirá una ventana (normalmente en la parte superior) con la ayuda de Vim.

Ayuda de un término

Pero también podemos buscar información de forma más específica sobre un tema o consulta con:

:h <consulta>

Con esto, Vim nos mostrará la ayuda que existe para la <consulta> que hagamos.

Por ejemplo, si queremos buscar sobre el comando :quit, escribiremos lo siguiente:

:h quit

Al pulsar Enter, Vim nos abrirá una ventana en la parte inferior que muestra la ayuda que existe sobre ese comando. Pero ¿qué pasa si no sabemos exactamente el comando que buscamos y queremos escribir algo y que Vim nos muestre si hay temas sobre eso?

En Vim funciona muy bien el autocompletado. Podemos buscar ayuda sobre lo que tenga Vim con la palabra «run». Para ello tenemos dos opciones:

• Podemos escribir :h run y pulsar sobre Ctrl+D y Vim nos mostrará una lista de comandos que contienen dicha palabra
• Podemos escribir :h run y pulsar la tecla Tabulador y Vim nos irá pasando por los comandos que hemos visto que aparecían anteriormente hasta que encontremos el que nos interesa.

Buscando en la ayuda

Si abrimos la ayuda en general con :help (o con :h en modo abreviado) también podemos buscar dentro de la ayuda de la manera usual en que buscamos en Vim con /. Por ejemplo:

/ quit

Podremos ir navegando por todas las coincidencias que Vim nos encuentre de la palabra buscada, de la manera normal que lo hacemos en Vim.

Dentro de la ayuda de Vim, a veces aparecen enlaces a otras partes o secciones de la ayuda. Para navegar por esos enlaces deberemos utilizar Ctrl ]

Y una vez consultado ese enlace, si queremos regresar al punto desde el que saltamos podemos hacer con Ctrl o

Helpgrep

También podemos utilizar el comando :helpgrep <consulta>. Por ejemplo:

:helpgrep quit

Que nos busca un término dentro de toda la ayuda de Vim y nos muestra donde se utiliza. Para ver en una pantalla inferior todas las partes donde aparece el término buscado pulsaremos

:copen

Podremos ir navegando por todas las opciones mostradas y cuando queramos consultar una pulsaremos sobre ella Enter.

También podemos ir recorriendo todas las opciones hacia adelante o atrás respectivamente con estos comandos:

Estos son solo unos fundamentos esenciales a la hora de buscar en la ayuda de Vim. Si quieres más información, ahora ya sabes…

:help help