Справочник по Vim: Введение в Vim

СПРАВОЧНИК ПО VIM  Брам Мооленаар

1. Введение
2. Vim в интернете
3. Авторы
4. Соглашения
5. Введение в режимы Vim
6. Переключение между режимами
7. Содержимое окна
8. Определения

1. Введение

Vim это сокращение от Vi IMproved (Улучшенный Vi). Первоначально это сокращение использовалось для Vi IMitation ("Имитация Vi"), но улучшений было настолько много, что изменение названия оказалось оправданным. Vim это текстовый редактор, который включает практически все команды из программы "Vi", распространённой в системе Unix, а также множество новых. Он чрезвычайно полезен для редактирования программ и другой текстовой информации.

Все команды можно отдавать при помощи клавиатуры. Для тех, кто любит держать руки на клавиатуре и смотреть на экран это большое преимущество. Кроме того, имеется версия с графическим интерфейсом, с прокруткой документа, меню и поддержкой мыши (см. |gui.txt|).

Краткое содержание этого руководства можно найти в файле "help.txt", |help.txt|. Из Vim этот файл доступен при нажатии кнопки <Help> или <F1> и при помощи команды |:help| (просто наберите ":help", без кавычек и вертикальных линий).

Опция 'helpfile' может указывать на другое имя файла, в том случае, если он находится в каком-то другом месте. По темам можно перемещаться при помощи меток: для перемещения к теме, расположенной под курсором нажмите CTRL-], для возврата нажмите CTRL-T.

Повсюду в этом руководстве различия между Vi и Vim отмечаются в фигурных скобках, например: {Vi не имеет встроенного справочника}. См. |vi_diff.txt| для общей информации о различиях между Vim и Vi.

Это руководство относится к использованию Vim на различных машинах. Между разными компьютерами и терминалами могут быть незначительные различия. Помимо комментариев в этом документе, существует также отдельный документ для каждой системы, на которой присутствует Vim, см. |список_файлов_о_системах|.

Это руководство является справочником по всем командам и опциям Vim. Оно не является введением в использование Vi или Vim, но подробно описывает детали, связанные с работой в редакторе. Для начинающих существует небольшой |учебник|. Для изучения Vim также читайте руководство пользователя |usr_toc.txt|.

Vi посвящено множество книг, в которых содержатся сведения для начинающих. Я могу порекомендовать, в частности, две книги:

"Vim - Vi Improved" Стива Уаллина (Steve Oualline) - Это самая первая книга, целиком посвященная Vim. Она очень хороша для начинающих. Наиболее часто используемые команды объясняются на примерах и с иллюстрациями. В книге также разбираются и менее часто используемые команды, обобщенно даются и более сложные особенности. В книге есть подробный указатель и краткий справочник. Частично материалы из книги входят в руководство |из_книги|. Книга издана New Riders Publishing.  ISBN: 0735710015. Более подробную информацию можно получить в интернете: https://iccf-holland.org/click5.html или https://www.vim.org/iccf/click5.html

"Learning the Vi editor" Линды Ламб (Linda Lamb) и Арнольда Роббинса (Arnold Robbins) - Это книга о редакторе Vi, в которой также есть глава о Vim (в шестом издании). Первые шаги в редакторе Vi объясняются в ней очень хорошо. Команды, которые есть только в Vim затронуты только вскользь. Эта книга переведена на немецкий. Книга издана O'Reilly.  ISBN: 1-56592-426-6.

2. Vim в интернете

На страницах Vim в интернете содержится самая последняя информация о Vim. Там также содержатся ссылки на самые последние версии Vim. FAQ это список наиболее часто задаваемых вопросов. Вы можете обратиться к нему, если столкнетесь с проблемами.

• Домашняя страница VIM: https://www.vim.org/
• VIM FAQ: https://vimdoc.sf.net/
• Скачать программу: ftp://ftp.vim.org/pub/vim/MIRRORS

Группы новостей Usenet, где обсуждается Vim is discussed: comp.editors

В этой группе новостей также обсуждаются и другие программы-редакторы. Если вы пишите о Vim, то не забывайте это указывать.

Vim посвящено несколько почтовых рассылок:

<Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра.;
    Для обсуждения существующих версий Vim: полезные настройки, вопросы, ответы, где взять ту или иную версию и т.д.

<Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра.;
    Для обсуждения изменений в Vim: новые особенности, портирование на другие платформы, исправления, бета-версии и т.д.
    
<Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра.;
    Объявления о новых версиях Vim; также для бета-версий и портах на различные системы.
    
<Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра.;
    Для обсуждений об использовании и улучшении мультибайтовых аспектов Vim.
    
<Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра.;
    Для обсуждения использования и улучшения версии Vim для Macintosh.

См. свежую информацию в интернете по адресу https://www.vim.org/maillist.php.

ЗАМЕЧАНИЕ:
- В эти списки рассылки можно отправлять письма только если вы подписаны!
- Письма в список можно отправлять только с того же адреса, с которого вы подписаны (чтобы спама не было).
- Максимальный размер сообщений 40000 символов.

Если вы хотите подписаться, то отправьте сообщение по адресу <Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра.; Убедитесь, что ваш адрес "From:" правильный. Сервер рассылки пришлет вам дальнейшие указания о том, как подписаться.

Сервер также может выслать вам старые сообщения и список сообщений. Все инструкции содержатся в ответе от vim-help.

Архивы рассылки хранятся:
https://groups.yahoo.com/group/vim
https://groups.yahoo.com/group/vimdev
https://groups.yahoo.com/group/vimannounce
https://groups.yahoo.com/group/vim-multibyte
https://groups.yahoo.com/group/vim-mac

Дополнительные почтовые рассылки:

<Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра.;
    Рассылка Vim на французском. Подписаться можно отправив сообщение на <Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра.; Или можно посмотреть здесь: https://groups.yahoo.com/group/vim-fr.

Сообщения об ошибках в программе:

Сообщения об ошибках отправляйте по адресу: Vim bugs <Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра.; Это не список рассылки, но все сообщения, приходящие по этому адресу, переадресуются разработчикам. Постарайтесь быть краткими; время, которое приходится тратить, отвечая на письма, вычитается из времени, предназначенного для улучшения Vim! Всегда приводите пример, который можно повторить и постарайтесь найти самостоятельно какие настройки способствуют появлению ошибки. Если есть возможность, попробуйте повторить пример на различных системах. Если Вы можете, то присылайте готовый код с исправлениями!

При возникновении сомнений используйте:

:so $VIMRUNTIME/bugreport.vim

Эта команда создаст файл "bugreport.txt" в текущем каталоге, в котором содержится масса информации о вашей системе. Перед отправкой убедитесь, что в нем не содержится какой-либо конфиденциальной информации!

Если Vim аварийно прекращает работу с одним из тестовых файлов, и вы используете для компиляции gcc, то, чтобы выяснить где именно Vim прекращает работу, можно проделать следующее:

1. Скомпилируйте Vim с ключом "-g" (В Makefile есть строка, которая включает этот ключ, которую нужно раскомментировать).

2. Выполните следующие команды (замените "11" на тест, который приводит к завершению работы):

cd testdir
gdb ../vim
run -u unix.vim -U NONE -s dotest.in test11.in

3. Проверьте, где Vim прекращает работу, gdb должен выдать сообщение об этом.

4. Получите от gdb состояние стека:

    where

    Различные места в стеке можно проверить командой:

frame 3

    "3" надо заменить на один из номеров в диагностике состоянии стека.

Поскольку внутренний код Vim не использует для работы даты, то проблема 2000 года как таковая не имеет отношения к редактору. Vim использует время в форме секунд, прошедших после 1 января 1970 года. Это время используется для проверки и сравнения отметок о времени редактирования в текущем файле и в своп-файле, что не является критическим и приводит только к предупреждающим сообщениям.

Возможно возникновение проблемы 2038 года, когда количество секунд, прошедших после 1 января 1970 года больше не будет умещаться в 32-битное целое число. Данная проблема напрямую связана с компилятором, библиотеками и операционной системой. Говоря точнее, используются time_t и функция ctime(). Значение time_t хранится в своп-файле в четырех байтах, но используется только для диагностики времени и даты файла при восстановлении и никак не влияет на обычное редактирование.

Функция Vim strftime() напрямую использует системную функцию strftime(). localtime() использует системную функцию time(). getftime() использует время, возвращаемое системной функцией stat(). Если ваши системные библиотеки готовы к 2000-му году, то можно сказать тоже самое и о Vim.

Пользователь может создать сценарии для Vim, которые используют внешние команды. Такие сценарии могут быть подвержены проблеме 2000 года, но они не имеют прямого отношения к самому редактору Vim.

3. Авторы

Большая часть Vim написана Брамом Мооленаар (Bram Moolenaar) <Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра.;.

Отдельные фрагменты документации взяты из нескольких руководств по Vi, написанных У.Н. Джой (W.N. Joy), Аланом П.У. Хьюитт (Alan P.W. Hewett), Марком Хортоном (Mark Horton)

Редактор Vim основан на Stevie и включает идеи и фрагменты из другого программного обеспечения, над которым работали люди, упомянутые здесь. Другие оказали помощь с исправлениями, предложениями и своими мнениями о том, что в Vim хорошо и что плохо.

Vim никогда не был бы тем, чем он является, без помощи этих людей!

Я хочу поблагодарить всех людей, кто отправлял мне сообщения об ошибках и предложения. Список был бы слишком длинным, если упомянуть всех и каждого. Vim не был бы таким, какой он есть, если бы не идеи всех этих людей: благодаря им Vim жив!

В документации есть несколько ссылок на другие версии Vi:

  4. Соглашения

При использовании подсветки синтаксиса текст, который не набран буквально часто подсвечен при помощи группы Special. Это касается элементов в скобках [], {} и <>, и CTRL-X.

Замечание: Vim использует в командах все возможные символы. Иногда [], {} и <> являются просто частью набора; значение как правило ясно из контекста.

Имена клавиш, указанные ниже, используются в документации. Их также можно использовать совместно с командой ":map" (имя клавиши вставляется при помощи CTRL-K с последующим нажатием нужной клавиши).

Замечание: кнопки перемещениям курсора с shift, кнопка справки и отмены доступны только на некоторых терминалах. На Amiga, функциональная клавиша F10 с shift выдаёт специальный код (CSI), также используемый в последовательностях. Он будет распознаваться только после ввода следующего символа.

Замечание: кнопка delete имеет два кода. 127 это десятичный код для кнопки delete, который будет распознаваться всегда. В некоторых случаях кнопка delete посылает еще один код, и в этом случае значение берется из символа termcap "kD". Оба значения имеют одинаковый эффект. См. также |:fixdel|.

Замечание: кнопки на дополнительной клавиатуре используются также, как и их аналоги на основной. Например, <kHome>имеет тот же эффект, что и <Home>. Если кнопка на дополнительной клавиатуре отправляет тот же код, что и кнопка на основной клавиатуре, то она будет распознаваться как нажатие кнопки на основной клавиатуре. Например, если <kHome> отправляет тот же код, что и <Home>, то при нажатии <kHome> Vim будет думать, что нажата <Home>. В этих случаях привязка к <kHome> работать не будет.

Примеры часто приводятся в угловых скобках <>. Иногда это просто указание на то, что нужно нажать, но часто бывает так, что символы должны быть набраны буквально, например в команде ":map". Вот правила:

1. Любой печатный символ набирается напрямую, за исключением обратной косой черты и '<'
2. Обратная косая черта представляется "\\", двойной обратной косой чертой или в виде <Bslash>.
3. Настоящий символ '<' представлен в виде "\<" или "<lt>". Если перепутать нельзя, то может использоваться и просто '<'.
4. "<key>" означает нажатие специальной кнопки. Соглашения объясняются в таблице наверху. Несколько примеров:

Если вы желаете использовать <> полностью в Vim, убедитесь, что флаг '<' отсутствует в 'cpoptions' (при выключенной опции 'compatible', что является значением по умолчанию).

:set cpo-=<

Соглашение <> использует <lt> для того, чтобы скрыть специальное значение названий кнопок. Использование обратной косой черты также будет работать, но только в том случае, если 'cpoptions' не включает флага 'B'.

Примеры установки соответствия CTRL-H и слова "<Home>":

:imap <C-H> \<Home>
:imap <C-H> <lt>Home>

Первый пример работает только если в 'cpoptions' нет флага 'B'. Второй пример работает всегда.

Чтобы получить буквальное значение "<lt>" в привязке:
:map <C-L> <lt>lt>

Для привязок кнопок, сокращений и команд меню вы можете копировать-вставлять примеры и использовать их напрямую. Либо, вы можете набирать их буквально как они есть, включая символы '<' и '>'. Это не будет работать для других команд, таких как ":set" и ":autocmd"!

5. Введение в режимы Vim

В Vim есть шесть ОСНОВНЫХ режимов:

Также существует пять ДОПОЛНИТЕЛЬНЫХ режимов. Все они являются вариантами ОСНОВНЫХ режимов.

6. Переключение между режимами

Если вы по какой-либо причине не знаете в каком режиме находитесь в данный момент, то вы всегда можете вернуться в обычный режим, если дважды нажмёте <Esc>, за исключением режима Ex, в котором вам придётся использовать команду ":visual". При переходе в обычный режим после нажатия <Esc> экран моргнёт или вы услышите сигнал. В то же время, после нажатия <Esc> при использовании в режиме вставки CTRL-O вы также услышите сигнал, но по прежнему будете находиться в режиме вставки, поэтому вам потребуется набрать <Esc> еще раз.

-  не доступно
-- не возможно

*1 Из Обычного режима в режим Вставки можно перейти при помощи команд "i", "I", "a", "A", "o", "O", "c", "C", "s" или "S".

*2 Из Визуального в Обычный режим можно перейти при помощи команды, не являющейся командой перемещения, при этом команда будет выполнена, или при помощи <Esc> "v", "V" или "CTRL-V" (см. |v_v|), что приводит просто к остановке Визуального режима без каких-либо последствий.

*3 Из режима Командной строки к Обычному режиму можно перейти следующим образом:
   - По нажатию <CR> или <NL>, что приводит к выполнению введенной команды.
   - При уничтожении всей командной строки (например, при помощи CTRL-U) и введении завершающего <BS>.
   - По нажатию CTRL-C или <Esc>, что приводит к завершению режима командной строки без выполнения команды.
В последнем случае <Esc> может быть также символом, определенным с помощью опции 'wildchar'; в этом случае будет отработано автодополнение командной строки. Автодополнение можно проигнорировать и повторно нажать <Esc>. {Vi: при нажатии <Esc> командная строка выполняется. Для большинства людей такое поведение является неожиданным, поэтому оно было изменено в Vim. Однако, если <Esc> является частью команды привязки, то командная строка будет выполнена. Если вы хотите, чтобы Vim вёл себя как Vi при отработке <Esc>, то используйте ":cmap ^V<Esc> ^V^M"}

*4 Переход из Обычного режима в режим Выделения выполняется следующим образом:
   - при помощи выделения текста мышью, если 'selectmode' содержит "mouse"
   - при помощи непечатной команды для перемещения курсора в комбинации с нажатым Shift, если 'selectmode' содержит "key"
   - при помощи "v", "V" или "CTRL-V", если 'selectmode' содержит "cmd"
   - при помощи "gh", "gH" или "g CTRL-H"  |g_CTRL-H|

*5 Переход из режима Выделения в Обычный режим выполняется при помощи непечатной команды для перемещения курсора без нажатой клавиши Shift.
*6 Переход из режима Выделения в режим Вставки выполняется при помощи набора печатного символа. Выделение при этом удаляется и осуществляется вставка набранного символа.

Если включена опция 'insertmode', то редактирование файла начинается в режиме Вставки.

Дополнительно можно использовать команды CTRL-\ CTRL-N или <C-\><C-N> для перехода в Обычный режим из любого другого режима. Это можно использовать для того, чтобы быть уверенным в том, что Vim перешел в Обычный режим. При этом звуковой сигнал, как в случае с <Esc>, не подаётся. Однако, этот метод не работает в режиме Ex. При использовании после команды, которая принимает параметр, такой как |f| или |m|, применяется временной интервал ожидания, который задаётся с помощью опции 'ttimeoutlen'.

Команда CTRL-\ CTRL-G или <C-\><C-G> может использоваться для перехода в режим Вставки при включённой опции 'insertmode'. При выключенной опции эта команда осуществляет переход в Обычный режим. Это обстоятельство может использоваться для быстрого перехода в режим, указанный в опции 'insertmode', без необходимости знать в каком режиме Vim находится в данный момент.

Q - Переход в режим "Ex". Этот режим напоминает наборкоманд ":" со следующими отличиями:

• Вы не должны набирать ":".
• Экран не обновляется после каждой команды.
• Нормальное редактирование командной строки отсутствует.
• Привязки и сокращения не работают.

Фактически, вы редактируете строки при помощи "стандартных" средств ввода строки (<Del> или <BS> для стирания символов, CTRL-U для уничтожения всей строки).

Vim переходит в этот режим по умолчанию, если вызывается с командной строки как "ex". Для выхода из режима "Ex" пользуйтесь командой ":vi" |:visual|. Замечание: В старых версиях Vim "Q" использовалось для форматирования текста, теперь эта операция выполняется с |gq|. Однако, если вы используете сценарий |vimrc_example.vim|, то "Q" работает как "gq".

gQ - Переход в режим "Ex", но при этом поведение редактора остаётся таким же, как если бы ":" команды отдавались одна за другой. Доступны все функции автодополнения, редактирования командной строки и т.д. Для выхода из режима "Ex" используйте команду ":vi". {Vi не имеет этой функции}

7. Содержимое окна

В Обычном режиме и в режима Вставки/Замены в окне будет отображаться текущее содержимое буфера: Вы Видите То, Что Есть. Существует два исключения:

• Если опция 'cpoptions' содержит '$', и изменения затрагивают одну строку, то текст не удаляется мгновенно, но на месте последнего удаленного символа помещается '$'.
• При изменении текста в одном окне, другие окна, содержащие тот же самый текст не будут обновляться до тех пор, пока не завершен режим Вставки.

{Vi: Экран не всегда обновляется на медленных терминалах}

Строки, которые длиннее чем ширина окна, будут переноситься, если только не отключена опция 'wrap' (см. ниже). Опция 'linebreak' может быть установлена таким образом, чтобы перенос происходил на пустом символе.

Если в окне остаётся место после последней строки, то Vim будет показывать '~' в первой колонке последних строк окна, например так:

+-----------------------+
|строка                 |
|последняя строка       |
|~                      |
|~                      |
+-----------------------+

Таким образом, строки, начинающиеся с '~', указывают на конец буфера.

Если последняя строка в экране не умещается, то Vim будет указывать на это с помощью символа '@' в первой колонке последних строк окна, например так:

+-----------------------+
|первая строка          |
|вторая строка          |
|@                      |
|@                      |
+-----------------------+

Таким образом, строки, начинающиеся с '@', указывают, что строка не умещается в окне целиком.

Если в опции 'display' присутствует флаг "lastline", то вы не увидите символов '@' в левой части окна. Если последняя строка не умещается в окне полностью, то показывается та часть строки, которая умещается в экране, а последние три символа меняются на "@@@", например:

+-----------------------+
|первая строка          |
|вторая строка          |
|очень длинная строка, к|
|оторая не умещается @@@|
+-----------------------+

Если есть одна единственная строка, которая тем не менее слишком длинна, чтобы уместится в окне, то возникает особая ситуация. Vim будет показывать ту часть строки, на которую указывает курсор. При этом никаких специальных символов показано не будет, чтобы вы могли редактировать все части строки. {Vi: при попытке редактирования строк, не умещающихся в окне, происходит "внутренняя ошибка"}

Опция 'highlight' позволяет указывать '@' для использования специальной подсветки символов '@' и '~'. Это позволяет отличать их от "настоящих" символов в буфере.

Опция 'showbreak' содержит строку, которая должна размещаться перед перенесенными строками.

Если опция 'wrap' отключена, то длинные строки переноситься не будут. На экране будет показана только та часть строки, которая убирается в ширину экрана. Если курсор перемещается к непоказанной части строки, то экран прокручивается по горизонтали. Преимущества этого метода в том, что колонки показаны так как есть и можно редактировать строки, которые не убираются на экране. Минус заключается в том, что вы не можете видеть все символы строки сразу. Опция 'sidescroll' позволяет указать минимальное количество колонок для прокрутки. {Vi: опция 'wrap' отсутствует}

Все обычные символы ASCII отображаются на экране напрямую. <Tab> заменяется пробелами в требуемом количестве. Другие непечатные символы заменяются "^{символ}", где {символ} это непечатный символ плюс 64. Таким образом, 7 (bell) будет показан как "^G". Символы между 127 и 160 заменяются "~{символ}", где {символ} это символ минус 64. Такие символы занимают на экране больше одной позиции, курсор может быть подведен только к первой позиции.

При помощи опции 'number' все строки на экране будут предваряться порядковым номером. Совет: Если вам не хочется, чтобы перенесенные строки мешались с номерами строк, установите опцию 'showbreak' в 8 пробелов:

":set showbreak=\ \ \ \ \ \ \ \ "

Опция 'list' позволяет показывать символы <Tab> как "^I" вместо нескольких пробелов. В этом случае в конце строки также будет помещен символ '$', чтобы вы могли видеть лишние пробелы на конце строки.

В режиме командной строки корректно отображается только сама командная строка. Содержимое буфера будет обновлено как только вы вернетесь в Обычный режим.

Последняя строка экрана используется для сообщений и отображения состояния. Сообщения о состоянии будут использоваться только в следующих случаях:

Под текущим режимом подразумевается "-- ВСТАВКА --" или "-- ЗАМЕНА --", см. |'showmode'|. Символы команды это те символы, которые уже набраны, но пока не использованы. {Vi: набранные символы или позиция курсора не отображается}

На медленных терминалах можно выключить статусные сообщения для ускорения редактирования:

:set nosc noru nosm

При возникновении ошибок, сообщение об ошибке будет показано не менее одной секунды (в инверсном видеорежиме). {Vi: сообщения об ошибках могут быть перезаписаны другими сообщениями до того, как вы сможете прочитать их}

Некоторые команды показывают сколько именно строк было затронуто. Порог, при котором это отражается, может быть установлен опцией 'report' (по умолчанию 2).

На Amiga Vim выполняется в окне CLI. В заголовке окна отражается название Vim и полное имя текущего файла. При изменении размеров окна Vim автоматически обновляет его. Вы можете сделать окно таким маленьким, каким пожелаете, но если оно окажется слишком маленьким, то в нём может не убираться ни одна строка. Пусть ваше окно будет хотя бы 40 символов в ширину, чтобы у вас была возможность читать большинство сообщений на последней строке.

На большинстве систем Unix изменение размера окна также распознается и правильно отрабатывается. {Vi: с этим есть проблемы}

8. Определения

Экран состоит из одного или нескольких окон, разделенных строками состояния и командной строки в самом низу экрана.

       +-----------------------------------------+
экран  | окно 1             | окно 2             |
       |                    |                    |
       |                    |                    |
       |= строка состояния =|= строка состояния =|
       | окно 3                                  |
       |                                         |
       |                                         |
       |==== строка состояния ===================|
       |командная строка                         |
       +-----------------------------------------+

Командная строка также используется для сообщений. Если для командной строки недостаточно места, то экран прокручивается.

Существует четыре различных типа строк: