Como navego para os tópicos na documentação do Vim?

No sistema de ajuda interno do Vim, como faço para…

procurar tópicos nos quais quero ajuda?
seguir hiperlinks?
procurar material relacionado?

— romainl
fonte

Nunca me lembro das chaves para isso de uma vez para usar a ajuda da próxima, mas, felizmente, o conteúdo da ajuda está online. vimhelp.appspot.com

— chicks

Respostas:

101

O Vim vem com uma documentação exaustiva e totalmente indexada que contém as respostas para a maioria das perguntas que você pode ter ao usar o Vim.

Mas a documentação é enorme e pode parecer ao neófito um labirinto impenetrável. Aqui estão algumas diretrizes para ajudá-lo a encontrar o que você precisa ...

O :helpcomando é o seu gateway para a documentação do Vim. Leia a primeira tela agora .
```
:help
```
Vamos meta:
```
:help help
```
Você pode concluir os argumentos com <Tab>e exibir a lista de possíveis conclusões com <C-d>.
```
:help buf<Tab>
:help :w<C-d>
```
A propósito, aqui está uma explicação da notação chave:
```
:help key-notation
```
A maioria dos comandos Ex pode ser reduzida para alguns caracteres. Isso também é verdade :help:
```
:h
```
O :helpcomando e a conclusão de tabulação não diferenciam maiúsculas de minúsculas, portanto os dois comandos abaixo levarão você à mesma seção:
```
:h BufWritePost
:h bufwritepost
```
Observe que ae Asão ambos comandos legítimos, portanto, a distinção entre maiúsculas e minúsculas não se aplica.
Se você tiver apenas uma palavra-chave genérica para pesquisar, use :helpgrepe abra a janela do quickfix:
```
:helpgrep quickfix
:copen
```
Use <C-]>nas palavras destacadas para pular para a tag correspondente, use <C-t>para voltar.

Veja :help tagspara mais.
Role para ver se há uma opção ou comando relacionado que melhor se adapte às suas necessidades. Essa é uma ótima maneira de aprender novos truques também.

Use a sintaxe correta para pesquisar com mais eficiência:

: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'

Exemplos:

: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

Anatomia de uma :helpseção:
```
:help ballooneval'
```
- As palavras destacadas em vermelho são as tags associadas a essa opção.
- As palavras em verde são a forma longa e a forma abreviada do nome da opção.
- A primeira linha em branco diz que é uma opção booleana e está desativada por padrão, veja :help options.
- A segunda linha em branco diz que a opção é global, veja :help option-summary.
- As linhas roxas são auto-explicativas.
- Em seguida, vem a descrição da opção.
- As palavras turquesas são "tags" que permitem saltar para outra parte da documentação. Não tenha medo de segui-los.
Use seu cérebro, encontre padrões lógicos que o ajudarão em pesquisas futuras.

Depois de encontrar o útil :help list-functions, onde procurar funções relacionadas a strings?

Depois de encontrar :help i_ctrl-x_ctrl-o, como encontrar ajuda <C-x><C-l>no modo de inserção?
RTFM não é um insulto. Você vai aprender muito mais lendo a documentação do que fazendo perguntas míopes para estranhos aleatórios para ter certeza de pelo menos tentou R ead T ele F antastic M anual antes de pedir.

— romainl
fonte

Bom post :-) Para sua informação, sua captura de tela é bastante difícil de ler na minha tela devido ao baixo contraste (especialmente o vermelho e, em menor grau, o roxo).

— Martin Tournoij 23/02

Na verdade, eu atualizei a ajuda para incluir uma lista similar :h help-summary(precisa de uma Vim recente)

— Christian Brabandt

> 4. The :help command and its tab-completion are case-insensitive<← Isso não é exatamente verdade: por exemplo, :h ae :h Ase distinguem.

— Aaron Thoma

:helpgreppode ser abreviado :helpgpara um uso diário mais eficiente.

— Aaron Thoma

-0.1 faça anotações sobre o vim em um arquivo. Use-o como referência e contêiner.

maneira rápida de encontrar ajuda vim de key | :cmd | 'option' | etc
- :h giou :h g;para giou g;no modo normal
- :h ^ipara Ctrl- ino modo normal
- :h ^w^wpara Ctrl- wCtrl- wno modo normal
- :h ^wfpara Ctrl- wfno modo normal
- :h i^npara o modo de inserção Ctrl-n
- :h c^r^rpara o modo cmdline Ctrl- r Ctrl-r
- :h :pu para ex-comando :put
- :h 'cb'para opção clipboard.
- :h `>para marca <.
- :h @:para opção repeat last ex command by eval register :(mesmo mecanismo que macro).
- Tipo :h range, neste momento você está em modo cmdline, então:
  - type Ctrl- apara completar todos os candidatos que contenhamrange
  - type Ctrl- fpara abrir uma pequena janela de edição[Command Line]
  - digite "*ddpara cortá-lo na área de transferência do sistema.
  - digite oe Enterpara cancelar e sair da janela[Command Line]
  - h :range range() <range> [range] :func-range ... é um trecho
  - Da mesma forma, h mode-Ex mode-replace mode-cmdline mode-switching ...é um trecho para mode-.
  - palavra semelhante que possa interessar buf win tab line:, etc.
  - resumo: este mostra uma maneira de encontrar itens interessantes, com uma palavra-chave com a ajuda de cmdline-completion.

-0.2 define um mapeamento de chave local do buffer para chamar a ajuda do vim da palavra sob o cursor, quando no arquivo de notas do vim mencionado anteriormente.
(e possivelmente com pós-processamento após extração <cword>, em uma função vimscript)

— qeatzy
fonte

> Definir uma chave de mapeamento de tampão-local para invocar vim ajuda da palavra sob o cursor <Você também pode fazer setl keywordprg=:help, então Kjá trabalha

— Mass

Sim, essa é uma das minhas configurações, Kpara raw <cword>, a outra que eu uso é <Space>kpara <cWORD>pós-precessing. ( <Space>É um dos minha chave líder também, ser fluente, 'timeoutlen' sendo definido.)

— qeatzy