Tutorial - vim, um editor de texto

Este tutorial está sempre em construção . Caso deseje que algum assunto seja adicionado, ou desejar contribuir, entre em contato:gavri@im.ufba.br , ou clique no botão "editar" ao rodapé da página e escreva você mesmo.

Conteúdo:

Muito mais que um simples editor de texto, o vim é uma poderosa ferramenta de desenvolvimento. Além de poder criar e editar arquivos dos mais diversos formatos, ele oferece muitos outros recursos úteis para quem quer editar textos, desenvolver aplicativos ou páginas para a Web.

Além dos arquivos de texto (.txt) o vim é capaz de criar e editar arquivos HTML, C, C++, JAVA, Perl, Pascal, LISP, Fortran, entre outros, reconhecer e colorir de forma elegante suas tags e palavras reservadas; é capaz ainda de identar automaticamente de maneira clara e organizada, à medida que se programa.

Para os que não estão ainda familiarizados com os comandos e funções do vim, segue um pequeno guia.

Abrindo um arquivo

Para abrir, usando vim, um arquivo já existente, basta digitar na linha de comando:

# vim nome_arquivo

Para criar um novo arquivo, digite :

# vim nome_novo_arquivo, e será aberto um novo documento em branco para edição, ou digite simplesmente vim, e o programa abrirá com um novo documento ainda sem nome, que deverá ser batizado ao fim da edição.

Comece a usar

A utilização do vim baseia-se basicamente em dois modos: o modo de comandos e o modo de inserção. Quando arquivo é aberto, o programa inicia no modo de comando. Para iniciar o modo de inserção, pressione a tecla Insert ou simplesmente a letra i; nesse modo é possível inserir texto. Para retornar ao modo de comando, pressione Esc.

Os comando mostrados abaixo devem ser executados no modo de comando. Se você se encontrar no modo inserção e desejar realizar qualquer operação, deve antes pressionar Esc.

Salvando o arquivo e saindo do vim

Para salvar as alterações feitas num arquivo, vá para o modo de comando (pressionando a tecla Esc), e digite o comando :w (w de write), sem esquecer o "dois-pontos". Se o arquivo já possuía um nome, este comando gravará as alterações feitas depois que ele foi aberto. Caso se trate de um novo arquivo, e que ainda não possua nome, deve-se usar

:w nome_arquivo

e o arquivo será salvo com o nome escolhido. Se o nome digitado já pertencer a outro arquivo, ou seja, já existe no mesmo diretório um arquivo com esse nome, você será alertado com uma mensagem de erro. Há então duas opções: escolher outro nome para o arquivo, ou, se for sua intenção sobrescrever o antigo arquivo, utilize

:w! nome_arquivo

O arquivo existente será substituído pelo novo.

Para sair do editor, digite o comando :q (q de quit). O documento deverá estar salvo, ou o programa não encerrará. Se você quer realmente abandonar o vim sem salvar as alterações no texto, digite :q! e o editor encerrará sem salvar as alterações realizadas desde que o documento foi gravado pela última vez.

Se, após editar seu documento, você desejar salvar as alterações e sair do programa, de uma só vez, use o comando :wq (w salva e q sai) ou simplesmente :x (equivalente ao :wq).

Movimentando-se no vim

O vim possiu algumas facilidades de movimentação dentro de um documento. Por exemplo (sempre no modo de comando), para ir para o início da linha onde se encontra o cursor, digite 0 (isso é um zero). Para deslocar-se até o fim da linha atual tecle $.

Para deslocar-se para a qualquer linha do arquivo, digite :número_da_linha. Por exemplo, para ir para a linha 10, de onde quer que você esteja no arquivo digite :10.

Existe outra forma, utilizando-se a letra G (G de go), G MAIÚSCULO, nesse caso sem o "dois-pontos". Querendo deslocar-se para a linha 10, digite 10G. Para ir para a última linha do arquivo, tecle apenas G.

Para mover-se para baixo você pode utilizar Ctrl+f (f de forward) que equivale à tecla Page Down de seu computador. Da mesma forma, para mover-se para cima (equivalente ao Page Up) utilize Ctrl+b (back).

Ainda no modo de comando, a tecla w leva o cursor ao início da palavra seguinte à que o cursor se encontra atualmente e b o leva ao início da palavra anterior.

Marcas no texto

Há ainda a grande facilidade das marcas. É possível criar uma marca em qualquer ponto do documento e retornar a ela posteriormente. As marcas devem receber "nomes" que são simples caracteres.

Para criar, por exemplo, uma marca chamada 'd' num certo ponto de seu texto, posicione o cursor no local e (não se esqueça, no modo de comando) digite md (marca d). Para retornar a esta marca posteriormente digite `d (acento grave + nome_da_marca), e o cursor será levado exatamente para o local marcado. Você pode criar quantas marcas quiser num documento.

Ctrl+g mostra a você o nome do arquivo, o número da linha em que o cursor se encontra atualmente, além do número total de linhas do documento.

Editando texto

Como já foi dito, para iniciar o modo de inserção, tecle Insert ou apenas i. Isso faz com que o texto digitado seja inserido ANTES do caracter que está sob o cursor. Se você deseja inserir texto APÓS a posição onde o cursor se encontra tecle a (a de after).

No modo inserção, o texto digitado será inserido no texto atual sem sobrescrevê-lo.

Para sobrescrever o texto atual, pressione Insert novamente, se você já se encontrar no modo inserção. A tecla Insert alternará entre os modos INSERT e REPLACE. Estando no modo de comandos, use R (R maiúsculo) para iniciar o modo REPLACE.

Para abrir uma nova linha de texto após a linha atual do cursor tecle o (open). Uma nova linha será criada já colocando você no modo INSERT.

A tecla para apagar no modo de comando, equivalente à tecla Delete, é x.

Para substituir um caracter apenas, tecle r. Por exemplo, você digitou "caza" e quer substituir o 'z' por um 's' sem ter que entrar no modo inserção e apagar.

Posicione o cursor sobre o caracter 'z', tecle r seguido do caracter correto.

Para substituir uma palavra, use cw (change word). O c serve para substituir e o w (word) diz O QUE você quer substituir. Por exemplo:

Para substituir tudo da posição atual até o final da linha digite c$ (c para change e $ é a tecla para mover até o fim da linha, lembram-se?).

Pode-se ainda usar outras combinações, como cG para substituir da posição corrente até o fim do arquivo.

Pode-se ainda combinar o c com referências a marcas, por exemplo, c`l pode ser usado se você desejar sbstituir todo o texto entre a posição corrente e uma marca 'l' pré-estabelecida pelo usuário.

Note que a tecla para substitução c apaga o texto que se deseja substituir e põe o editor atomaticamente no modo INSERT. A tecla de substuição de apenas um caracter, r, não apaga o caracter que se deseja substituir, mas espera que se tecle o novo caracter (o editor permanece no modo de comando).

Copiar, recortar e colar

Os comando para movimentar texto no vim são basicamente d, y, p e P. Mas eles podem ser usados de muitas formas diferentes. Muitas porque, além de poderem ser usados no modo de comando, funcionam também em outros modo de edição do vim, que ainda não foram citados aqui. Eles são o modo VISUAL, VISUAL LINE E VISUAL BLOCK.

Para recortar texto, utiliza-se d. Aí podem ser usadas novamente infinitas combinações com outros comandos. Por exemplo, d$ recorta da posição atual até o fim da linha. dG recorta até o fim do documento. dw recorta uma palavra apenas.

Para recortar uma linha inteira, digite dd.

Se voce deseja recortar, digamos, as 7 próximas linhas de seu texto para colá-las em outra posição, digite 7dd.

Os mesmos recursos usados para recortar são possíveis para copiar um texto, sem apagá-lo da posição original.

Para copiar texto, sem apagá-lo, use y (yank). Para copiar uma linha inteira, yy, e assim por diante, da mesma forma que utilizamos as combinações com o comando d.

As teclas p e P (p de paste) são usadas para colar o texto recortado ou copiado. A diferença é que p (minúsculo) cola o texto a partir da linha abaixo de onde se encontra o cursor e P (maiúsculo) cola o texto acima de onde se encontra o cursor atualmente.

OBSERVAÇÃO: Se você deseja apagar linhas ou palavras de seu texto, pode usar o comando d da mesma forma que o usaria para recortar, mas depois nao cole o texto recortado em lugar algum.

Só mesmo experimentando os comandos você poderá se familiarizar com seus resultados.

VIM X VI

O VIM (vi improved) traz muitas evoluções em relação ao antigo VI.
Entre as principais, estão a possibilidade de usar os modos visuais para edição de texto, e utilizar as teclas de movimento, pois o VI obrigava a usar seus comandos.
Por exemplo, para as teclas End, Home, PageUp e PageDown, temos que usar $, 0, Ctrl + b e Crtl + f. As teclas de setas também não funcionam como esperado, bem como o Backspace e o Delete.

Para falar a verdade, na maioria dos sistemas UNIX, quando se digita VI, e não há o VIM instalado, se utiliza o Evis ou Elvis-tiny, um editor semelhante ao VI, que ocupa bem pouco espaço.

Os modos Visuais

O modo VISUAL é acessado pressionando-se a tecla v no modo de comando. Pode-se então selecionar qualquer quantidade de texto para copiar, recortar ou simplesmente apagar. (usando somente o teclado, nunca o mouse)

O modo VISUAL LINE (Shift+v) permite apenas que se selecione linhas inteiras;

O modo VISUAL BLOCK (Ctrl+v) permite que se selecione blocos retangulares de texto.

Os modos vusuais evitam certos incômodos; permitem, por exemplo, que o usuário apague, recorte ou copie texto muito mais facilmente; permitem que se marque um trecho do texto, onde se quer fazer substituição (que será explicada mais adiante), sem ter que indicar a linha de início e de fim, pois ela será realizada apenas na seção marcada; permitem passar o texto selecionado como parâmetro para um comando do sistema operacional, etc.

Esteja a vontade para experimentar esses modos se quiser, mas vamos tratar aqui mais frequentemente do modo de comando, que funciona tanto no VIM quanto no VI ou no Elvis.

Uso de Buffers de memória

Ao contrário da maioria dos editores de texto, em que só se pode copiar ou recortar um bloco de texto, e colar apenas o último texto que foi copiado, no vim é possível copiar ou recortar quantos trechos de texto quiser, e para colar, escolhe-se qual trecho deve ser inserido.

Para isso o vim faz uso de buffers de memória, que associam um "nome" ao trecho de texto copiado ou recortado.

Parece complicado, mas é muito simples: os buffers recebem como nomes caracteres do teclado (letras, símbolos ou números).

Vamos explicar com um exemplo: para copiar uma linha de texto em um buffer denominado '1', fazemos: "1yy.
Aspas informam que haverá um armazenamento em buffer, '1' é o nome desse buffer e yy copia uma linha.
Agora para recortar 5 linhas para um buffer chamado 'q': "q5dd .

Simples, não? Para colar, é parecido: "1p ou "qp (p de paste), ou qualquer que seja o nome dado ao buffer

OBS: os buffers não são perdidos ao encerrar o programa, pois ficam armazenados no arquivo .viminfo. Falamos dele mais adiante.

Formatação de texto

Os editores que trabalham com texto puro normalmente não delimitam o tamanho da linha.
A linha segue sem fim até que seja quebrada por um Enter.

O VIM também é assim por default, mas você pode definir a largura máxima que terá a linha do texto, antes de começar a digitar, fazendo:

set: textwidth=80

Nesse exemplo, definimos a largura da linha em 80 caracteres, que é a largura normal de um terminal de texto, e das telas do DOS.

Se o texto já está digitado sem quebra de linha, é possível selecionar o texto usando o modo de comando:

Digitando gq, a linha onde está o cursor será quebrada para o tamanho definido, ou para 80 caracteres, caso nada tenha sido indicado. Usando n gq (n é um número), as próximas n linhas serão quebradas.

Fica mais simples se você escolher usar um dos modos visuais (Visual Line). Marque as lihas que quiser formatar e digite gq.

Texto de outros arquivos

O texto contido em um outro arquivo pode ser adicionado ao que você está utilizando sem que seja necessário abri-lo, copiar e colar. Basta usar:

:r nome_arquivo

E o conteúdo desse arquivo será adicionado ao atual a partir da posição do cursor.

Comandos do shell

Você pode executar comandos do shell sem precisar sair do editor. Digite:

:! comando

O comando desejado será executado no shell e você terá volta à edição do arquivo pressionando ENTER.

É possível ainda inserir a saída do comando no corpo do arquivo, por exemplo:

:r! ls

Lista os arquivos do diretório atual e insere o resultado no texto, a partir da posição do cursor, em vez de abrir um shell e retornar para o texto posteriormente.

Abrindo mais de um arquivo

É possível no vim abrir mais de um arquivo para edição ao mesmo tempo. Os arquivos são abertos na mesma janela do editor, que fica dividida horizontalmente, e cada arquivo ocupará um segmento da tela.

Por exemplo, para abrir dois documentos, digite:

# vim -o arquivo1 arquivo2

Depois, para alternar entre os documentos, usa-se Ctrl+w;

Ctrl+w seguido de seta para baixo faz com que o cursor vá para o arquivo uma posição "abaixo" do que estiver sendo editado no momento.

Ctrl+w seguido de seta para cima age de maneira semelhante, posicionando o cursor no arquivo que estiver uma posição "acima" do atual.

Note que todos os comandos que você utilizar se referirão ao arquivo onde o cusor estiver posicionado.

Por Default, o vim divide o igualmente o espaço disponível entre os arquivos abertos.

Se você quiser modificar o tamanho do segmento que algum dos arquivos ocupa na tela, posicione o cursor neste segmento, e depois digite:

Ctrl+w seguido de um sinal '+' para aumentar ou um '-' para diminuir.

Para determinar um tamanho absoluto para o tamanho que um arquivo está ocupando do tamanho total da tela, utilize:

:resize num

Onde num é um valor numérico qualquer.

Se voce já está com o editor aberto e deseja abrir mais um documento digite

:new nome_arquivo

e este arquivo será aberto dividindo horizontalmente a janela com o outro.

Para dividir a janela verticalmente (o que é mais cômodo, uma vez que o monitor é mais largo do que alto) use :vnew em vez de :new.

O recurso autocompletar

O vim conta com recurso de autocompletar palavras. Assim o usuário não tem que digitar repetidamente uma mesma palavra ao longo do texto.

Basta iniciar a digitação e pressinar Ctrl+n, e o editor vai completar com uma palavra que inicie de forma semelhante. Caso haja mais de uma no texto, pressionando Ctrl+n sucessivamente você verá as opções de substituição.

O recurso localizar

Você pode localizar palavras ou expressões (mais rigorosamente, expressões regulares) em um texto no vim.

Para isso, digite:

/string (sem o dois-pontos)

onde a string acima é a expressão que se deseja encontrar.

Essa expressão pode ser uma palavra ou expressão regular. O vim localizará todas as ocorrências da expressão no texto e posicionará o cursor na primeira das ocorrências. Para saltar para a próxima tecle n (de next).

Localizar e substituir

Além de localizar apenas, o vim permite localizar e substituir expressões.

A sintaxe básica é:

:x,ys/exp1/exp2/opções (desta vez tem o dois-pontos)

Onde x e y são a linha inicial e a linha final da pesquisa.

Por exemplo:

:1,9s/caza/casa

vai buscar a palavra caza e substitui-la por casa, das linhas 1 a 9 no texto.

As coordenadas x e y nao sao obrigatorias, e voce pode omiti-las.

Usando :6s/a/b substitui a primeira ocorrencia de 'a' de cada palavra por 'b' somente na linha 6 do arquivo;

Usando :6,s/a/b substitui a primeira ocorrencia de 'a' em cada palavra por 'b' a partir da linha 6 do texto.

:%s/a/b faz a busca em todo o arquivo.

As opçoes dizem respeito ao modo como a substituiçao sera' efetuada.

A opçao g executa a substituiçao em todas as ocorrencia da expressao em cada palavra ( o default e´ substituir apenas a primeira ocorrencia em cada palavra).

A opçao c faz o vim pedir uma confirmaçao antes de cada substituiçao.

Mais de uma opçao pode ser utilizada de uma so vez.

Dicas para Programadores

Sintaxe

Como já foi citado, o vim oferece algumas facilidades para programação, por exemplo reconhecer as palavras reservadas e as tags de linguagens de programação e formatação;

Se você está a editar um código de um programa em uma das linguagens reconhecidas pelo vim, ela deve aparecer com essas palavras ou tags em destaque. Se isso não acontecer use o comando:

:syntax on

E highlight!!! Seu código ficará colorido!

Para desativar: :syntax off .

Para que a sintaxe funcione, é preciso que o arquivo já esteja nomeado com uma extensão que permita ao vim identificar qual linguagem deve ser usada (por exemplo, num arquivo prog.c, o vim usará a sintaxe para a linguagem C).

Se o arquivo ainda não tem nome, ou você quer usar uma sintaxe diferente da que foi escolhida por defaut, faça assim:

:set filetype= linguagem.

Por exemplo, seu arquivo está em C, mas não tem nome ou o nome não tem a extensão .c. Digite :set filetype=c.

O vim atualmente tem suporte a mais de 340 diferentes linguagens de programação e de marcação.
Os arquivos de configuração da sintaxe ficam no diretório:

 /usr/share/vim/vim[versão]/syntax/ 

Há um arquivo definindo cada linguagem, e se você der uma olhada neles verá que eles especificam as palavras reservadas, símbolos e marcas de cada tipo de linguagem e definem qual vai ser o colorido que eles receberão no editor.

Dica para Slackware

Se você usa Slackware, e mesmo seguindo os passos acima, sua sintaxe para linguagens de programação ainda não funciona, tente essa dica:
Você tem que copiar os arquivos de documentação do VIM para o seu ambiente de trabalho, assim:

$ cp /usr/doc/vim*/doc/vimrc_example.vim  ~/.vimrc

Coloração

Para mudar a coloração do fundo da tela e também da fonte, use :colorscheme opção.
Isso muda todo o esquema de cores do editor.
Há várias opções, digite apenas :colorscheme e vá pressionando para ver as opções disponíveis. Experimente!

Indentação de código

Além disso, o vim indenta automaticamente os blocos de comandos.
Mas se você não gosta da indentação automática, ou tem um estilo próprio de indentar seu código, também pode desabilitar a opção usando :set noai ou o equivalente :set noautoindent e :set nosmartindent .

Arquivos de configuração

Os arquivos de configuração servem para personalizar e guardar configurações que você deseja que estejam ativas sempre que o vim for aberto.

Os principais arquivos são o .viminfo e o .vimrc.

O .viminfo é gerado automaticamente e guarda algumas informações como os últimos comandos utilizados, os valores das variáveis do programa, um pequeno backup de textos para recuperação em caso de perda por alguma interrupção, entre outras coisas.

O .vimrc é pessoal e serve para guardar suas preferências e evitar que elas se percam quando o aplicativo é encerrado.
Nele você pode, por exemplo guardar os valores definidos por :set qualquercoisa para não ter que digitá-los toda vez que for editar um arquivo.
Mas atenção, no .vimrc os comandos devem ser colocados diretamente, um por linha, sem o dois-pontos.
Para inserir comentários, inicie uma linha pelo caracter ". Toda a linha a partir daí será ignorada e tratada apenas como comentário.

Como mapear teclas para comandos

Os mapeamentos no vim servem para fazer com que ao apertarmos um tecla, o vim aja como se você tivesse digitado várias. Exemplo: para mapear a tecla F2 para salvar um arquivo, faça:

map <F2> :w<CR>

Quando você apertar F2, o vim agirá como se você tivesse digitado dois-pontos, w e ENTER (<CR>). A forma geral é:

map <Tecla> comando

Onde tecla é uma representação do vim para a tecla (<Space> para espaço, <F1> para F1, <F2> para F2, ..., <CR> para o ENTER, e assim vai.) Veja o help

Usando map, o mapeamento só estará disponível no modo de navegação. Para que o mapeamento esta disponível no modo de inserção, use imap ao invés de map.

Para que qualquer mapeamento seja permanente, você deve adicionar o comando correspondente no seu arquivo .vimrc .

Configurando verificação ortográfica no vim

Para configurar verificação ortográfica no vim - em português do Brasil! - siga os seguintes passos:

1. Instale os pacotes ispell (verificador ortográfico) e ibrazilian (dicionário de português do Brail para o ispell) na máquina (a depender da distribuição de GNU/Linux que você utilize, o modo exato de fazer isso certamente é variado).
2. Instale o plugin do vim chamado vimspell, disponível em http://www.vim.org/script.php?script_id=465:
   • crie - caso já não exista - um diretório .vim dentro do seu diretório HOME, e um subdiretório dele com nome plugin .
   • Faça o download do script do plugin no endereço acima e salve-o no diretório ~/.vim/plugin .

Para utilizar a verificação ortográfica, utilize o comando :SpellSetLanguage brazilian (para dizer ao verificador ortográfico para utilizar o dicionário para português do Brasil), e o comando :SpellCheck para que o vim destaque as palavras grafadas incorretamente colocando-as em vermelho e sublinhadas.

Dica 1: na versão visual do vim (gvim, versão em modo gráfico, com menus), as opções de verificação ortográfica ficam no menu Plugin/Spell.

Dica 2: parece haver um problema com a verificação em português por default. Para resolver isso, adicione a seguinte linha no seu arquivo ~/.vimrc:

au! BufNewFile,BufRead * let b:spell_language="brazilian"

Dica 3: para fazer com que as teclas F7 e F8 ajudem na verificação ortográfica, adicione as seguintes linhas no seu arquivo ~/.vimrc:

map <F7> :SpellCheck<CR>
map <F8> :SpellProposeAlternatives<CR>

O comando SpellProposeAlternatives lista sugestões de correção para a palavra que está sob o cursor (em modo de comando). Para usar essas teclas também é necessário estar em modo de comando.

Dica 4: para habilitar verificação ortográfica automática -- quando o cursor ficar parado por 1 segundo em modo de comando -- para alguns tipos de arquivos, adicione a seguinte linha no seu arquivo ~/.vimrc:

let spell_auto_type="tex,doc,mail"

A string contendo tex,doc,mail pode ser substituída pela listas de tipos de arquivo que você deseja que tenham verificação ortográfica automática.

Dica 5::: alterando o idioma da verificação

Note que o idioma padrão será o idioma configurado como padrão pelo ispell.

1. instale o dicionário do ispell para o idioma desejado.
2. liste no seu .vimrc os idiomas disponíveis, na variável spell_language_list. Por exemplo:

        let spell_language_list="brasileiro,american,castellano"
        

Para alterar o idioma padrão, utilize o comando SpellSetLanguage. Por exemplo, pra alterar o idioma para inglês:

:SpellSetLanguage american

Nota: assim como outros softwares que provêm verificação ortográfica, a verificação automática é imperfeita. Felizmente, é muito mais comum que a verificação marque como incorreta uma palavra correta do que não marcar uma palavra que esteja realmente incorreta. Em geral termos técnicos de áreas específicas e vocábulos de outros idiomas são destacados como incorretos erroneamente.

Gerando HTML a partir de código fonte.

O vim pode gerar HTML a partir do seu código fonte. Para isso, basta rodar o comando:

:runtime! syntax/2html.vim

Uma coisa prática de se fazer é mapear (veja acima) uma tecla para a função desejada:

map <F4> :runtime! syntax/2html.vim<CR>

Exemplo: um script vim com o código acima em HTML fica:

map <F4> :runtime! syntax/2html.vim<CR>

Dica: O vim utiliza as cores que estão em uso para gerar o HTML. Com o vim no modo gráfico (gvim) a pagina é gerada com fundo branco. No vim modo texto, use :set background=dark para gerar a página com fundo negro. As cores do texto serão adaptadas de acordo.

Navegando por diretórios

Basta mandar o vim abrir um diretório (como se fosse editar um arquivo mesmo), a lista do diretório é apresentada no vim. Mova o cursor para um arquivo ou diretório e apertar para editar-lo.

Integrando o VIM com outros programas

CVS

O cvscommand é um plugin que oferece uma série de comandos para o uso do CVS de dentro do vim. Por exemplo:

• :CVSDiff mostra as diferenças do arquivo carregado para a versão do CVS.
• :CVSDiff 1.14 1.13 mostra a diferença entre duas versões do arquivo no CVS.
• :CVSCommit abre uma janela (um :split, na verdade) para que você entre com os comentários, e ao gravar (:w apenas, não dê :wq para não fechar a janela) ele vai dar o commit do cvs e apresentar o resultado.

Outras referências

• http://vimdoc.sourceforge.net/dion/vimum.html - "VIM USER MANUAL", por Bram Moolenaar (autor do vim).
• http://vimdoc.sourceforge.net/cgi-bin/vimfaq2html3.pl - "Vim FAQ" - perguntas frequentes sobre o vim
• http://www.vim.org - vim online: scripts, dicas e curiosidades sobre o vim.