Справочник по Vim: Изменение текста

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

Здесь описываются команды, благодаря которым можно удалять или изменять текст. Под изменением текста понимается удаление фрагмента текста и замена удалённого фрагмента другим текстом при помощи единственной команды. Каждая из рассматриваемых здесь команд может быть отменена. Команды, которые не являются командами Ex могут быть повторены при помощи команды ".".

1. Удаление текста
2. Удаление и вставка
3. Простые изменения
4. Сложные изменения
5. Копирование и перемещение текста
6. Форматирование текста

Справку по вставке текста читайте в Вставка и замена текста.

1. Удаление текста

Эти команды служат для удаления текста. Вы можете повторять их при помощи команды "." (кроме команды ":d"), а также при необходимости их можно отменить. Для удаления блоков текста используйте Визуальный режим. Использование регистров поясняется здесь: регистры.

Исключение составляет команда d{перемещение}: Если перемещение не является построчным, начало и конец перемещения не находятся на одной строке, а перед началом перемещения и после конца перемещения в тексте присутствуют только пробелы, то команда удаления становится построчной. Иными словами, команда удаления также затронет и пробелы, которые вы, возможно, планировали оставить на месте.

Попытка удаления пустой области текста (например, по команде "d0" в первой колонке) приводит к ошибке, если значение опции 'cpoptions' включает флаг 'E'.

Эти команды удаляют символ <EOL> между строками. Это равноценно склеиванию нескольких строк в одну. Эти команды можно повторять (кроме ":j"), а также отменять.

Команды склейки строк, за исключением "gJ", вставляют один пробел вместо символа <EOL>, за исключением ситуаций, когда на конце строки имеется пробел или следующая строка начинается с ')'. Кроме того, эти команды, за исключением "gJ" удаляют все пробелы в начале следующей строки. Если включена опция 'joinspaces', то после символов '.', '!', '?' вставляется два пробела (однако, если в значении опции 'cpoptions' присутствует флаг 'j', то два пробела вставляется только после '.').

Флаги 'B' и 'M' в значении опции 'formatoptions' изменяют поведение при вставке пробелов до и после мультибайтного символа (См значение символов в 'formatoptions').

2. Удаление и вставка

Замечания:
- Выход из режимов Вставки и Замены может быть осуществлён по нажатию на кнопку <Esc>.
- О специальных кнопках в режимах Вставки и Замены см. раздел "Вставка и замена текста" (|режим_вставки_и_замены|).
- Влияние параметра [число] проявляется после того, как Vim выйдет из режима Вставки или Замены.
- Если значение опции 'cpoptions' содержит флаг '$', а изменения затрагивают только одну строку, то Vim продолжает показывать текст, который будет удалён и помещает '$' на месте последнего удалённого символа.

Регистры объясняются в ниже.

В режиме Замены редактор работает так же, как и в режиме Вставки, за исключением того обстоятельства, что каждый перед вставкой каждого символа старый удаляется. При достижении конца строки Vim просто добавляет новые символы, точно так же, как и в режиме Вставки. В режиме Замены кнопка <BS> позволяет восстанавливать первоначальный текст, если таковой имеется.

Подробнее см. раздел "Вставка и замена текста" |режим_вставки_и_замены|.

Особый случай: команды "cw" и "cW" работают также, как и команды "ce" и "cE", если курсор находится в позиции непробельного символа. Это связано с тем, что Vim понимает "cw" как "change-word", "изменить слово", а слово не включает следующий за ним пробел.  

Vi: команда "cw", если курсор находится в позиции пробельного символа, за которым следуют другие пробелы, приводит к замене только первого пробела; это, по всей видимости, ошибка, поскольку "dw" удаляет все пробелы. Если вам по каким-то причинам необходимо, чтобы в Vim эта команда работала так, как в Vi, то добавьте флаг 'w' в значение опции 'cpoptions'.

Если вам больше нравится, чтобы команда "cw" включала пробел после слова, то используйте такую привязку:

:map cw dwi

3. Простые изменения

Параметром для таких команд Обычного режима, как r и |t| является единственный символ. Если в значении опции 'cpo' не указан флаг 'D', то этот символ также может быть введён в виде диграфа. Для этого нужно ввести CTRL-K и затем двойной символ диграфа.
Доступно только в том случае, если Vim скомпилирован с особенностью +digraphs.

Команды, рассматриваемые ниже, позволяют изменять регистр символов. При этом используются активные в данный момент настройки (см. |локаль|). См. также |:language|. В данном случае используется значение переменной LC_CTYPE.

:map! <C-F> <Esc>gUiw`]a

Сложение и вычитание

Команды CTRL-A и CTRL-X можно применять к десятичным числам, в том числе со знаком, беззнаковым восьмеричным и шестнадцатеричным числам, а также к символам алфавита. Это зависит от значения опции 'nrformats'.

• Если в значении опции 'nrformats' указано "alpha", то Vim будет изменять алфавитные символы в позиции курсора или после курсора. Это полезно при создании списков, в которых элементы списка отмечаются символами.
• Если в значении опции 'nrformats' указано "hex", то Vim будет считать числа, начинающиеся с '0x' или '0X' шестнадцатеричными. Регистр символов в полученном в результате сложения или вычитания числе определяется регистром крайнего правого символа. Если в данном числе не используются алфавитные символы, то Vim пользуется регистром символов, который был установлен раннее.
• Если в значении опции 'nrformats' указано "octal", то Vim будет считать числа, начинающиеся с '0' восьмеричными. Все остальные числа считаются десятичными и могут сопровождаться знаком минус. Если курсор находится на числе, то операция производится над этим числом; в противном случае операция производится над числом, расположенном справа от курсора.

Если число начинается с нулей (включая все восьмеричные и шестнадцатеричные числа), то Vim будет пытаться сохранить количество символов в числе, если это возможно. CTRL-A с числом "0077" приводит к числу "0100", CTRL-X с числом "0x100" приводит к числу "0x0ff". Обратите внимание, что если в значении опции 'nrformats' присутствует "octal", то десятичные числа с начальными нулями невозможны, поскольку они будут неотличимы от восьмеричных чисел.

Команда CTRL-A очень полезна в макросах. Например, для создания нумерованного списка можно использовать такую последовательность действий:

1. Создать первый элемент списка, убедившись, что он начинается с числа.
2. qa - начать запись в буфер 'a'.
3. Y - скопировать элемент списка.
4. p - вклеить копию элемента под первым.
5. CTRL-A - увеличить число
6. q - остановить запись
7. <число>@a - повторить копирование, вклейку и увеличение числа заданное <число> раз

СДВИГ СТРОКИ ВЛЕВО ИЛИ ВПРАВО

Команды ">" и "<" очень удобны для изменения отступов в программном коде. Значение опции 'shiftwidth' следует установить равным количеству пробелов, которые будут добавлены или удалены при использовании этих команд. Обычно значение этой опции равно 8, но вы можете установить и меньшее значение для получения меньших сдвигов, например, 3. Сдвиг влево останавливается, когда строка больше не может быть сдвинута. Сдвиг вправо не затрагивает пустые строки.

Если включена опция 'shiftround', то величина отступа округляется до значения, кратного величине 'shiftwidth'.

Если включена опция 'smartindent' или включена опция 'cindent' и в значении опции 'cinkeys' содержится '#', то сдвиг вправо не затрагивает строки, начинающиеся с '#' (поскольку предполагается, что это команды препроцессора языка C, которые должны начинаться в первой колонке).

Если опция 'expandtab' выключена (по умолчанию), то Vim использует как можно больше символов <Tab>, чтобы отобразить отступ. Для замены отступов, выполненных с помощью пробелов, аналогичными, но выполненными преимущественно с помощью символов <Tab>, используйте команду ">><<". Если опция 'expandtab' включена, то Vim использует для отступов только пробелы. В этом случае команда ">><<" может использоваться для замены символов табуляции <Tab> на пробелы. Этой же цели может служить и команда ":retab!".

Для перемещения строки на величину нескольких 'shiftwidth', используйте Визуальный режим или команды, начинающиеся с ":". Например:

Vjj4>       переместить три строки на 4 отступа вправо
:<<<        переместить текущую строку на 3 отступа влево
:>> 5       переместить 5 строк на 2 отступа вправо
:5>>        переместить строку 5 на 2 отступа вправо

4. Сложные изменения

:keepmarks '<,'>!sort

Фильтр - это программа, которая принимает текст на стандартном вводе, производит над ним какие-либо действия и отправляет результат на стандартный вывод. Команды, приведённые выше, могут использоваться для работы с такими программами. Примерами фильтров являются программа "sort", которая сортирует строки по алфавиту, "indent", которая служит для форматирования файлов с исходным кодом на языке C (не все версии программы "indent" являются фильтрами). Опция 'shell' служит для указания оболочки, которую Vim использует для выполнения команды-фильтра (см. также справку по опции 'shelltype'). Команды, работающие с фильтрами, можно повторять с помощью ".". Vim не распознаёт комментарии (начинающиеся с '"') после команды :!.

 С командами замены можно использовать следующие флаги:

:&&
:s/this/that/&        

:s/синий/красный/
/зелёный
:s//красный/   или  :~   или  :&r

:s/синий/красный/
/зелёный
:&

Обратите внимание, что флага, который изменял бы "волшебность" шаблона ("magic") не существует. Вместо этого используются специальные команды. Дело в том, что состояние флагов выясняется уже после прочтения шаблона, а для того, чтобы прочитать шаблон правильно, необходимо знать, волшебный он или нет - проблема яйца и курицы, одним словом.

Если {шаблон} для команды замены не указан, то команда использует шаблон из последней использованной команды замены или команды ":global". Флаг [r] позволяет использовать шаблон из последней команды замены, команды ":global" или команды поиска.

Для совместимости с Vi допустимы два исключения из правил:

• "\/{строка}/" и "\?{строка}?" делают то же, что и "//{строка}/r".
• "\&{строка}&" делает то же, что и "//{строка}/".

Вместо символа '/', который используется для разделения шаблона и строки замены, можно пользоваться любым другим символом, кроме символов алфавита, цифр, '\', '"' или '|'. Это бывает полезно, когда необходимо включить символ '/' в шаблон поиска или в строку замены. Например:

:s+/+//+

Подробнее о шаблонах читайте здесь: |шаблон|.

Если {строка} начинается с "\=", то она рассматривается как выражение, см. |замена-выражение|. В противном случае символы в {строке} имеют специальное значение:

Примеры:

:s/а\|б/xxx\0xxx/g            заменяет "а б"       на "xxxаxxx xxxбxxx"
:s/\([абв]\)\([деж]\)/\2\1/g  заменяет "ае еа бж"  на "еа еа жб"
:s/абвгд/абв^Mгд/             заменяет "абвгд"     на "абв", "гд" (две строки)
:s/$/\^M/                     заменяет "абвгд"     на "абвгд^M"

Замечание: в предыдущих версиях символ CTRL-V обрабатывался особым способом. В дальнейшем это было устранено, поскольку нарушало совместимость с Vi. Вместо этого следует пользоваться символом обратной косой черты.

команда        текст    результат ~
:s/aa/a^Ma/    aa       a<перенос-строки>a
:s/aa/a\^Ma/   aa       a^Ma
:s/aa/a\\^Ma/  aa       a\<перенос-строки>a

(для ввода ^M вам потребуется ввести CTRL-V <CR>)

Нумерация "\1", "\2" и т.д. осуществляется на основании порядка, в котором "\(" впервые встречается в шаблоне (слева направо). Если обнаруживается несколько соответствий для группы скобок, то в качестве "\1", "\2" и т.д. используется последнее обнаруженное соответствие. Например:

:s/\(\(a[a-d] \)*\)/\2/      изменяет "aa ab x" на "ab x"

При использовании скобок в сочетании с '|', как, например, в шаблоне \([ab]\)\|\([cd\), соответствие не будет найдено либо для первого, либо для второго шаблона в скобках, поэтому либо \1, либо \2 будет пустым. Например:

:s/\([ab]\)\|\([cd]\)/\1x/g   изменяет "a b c d"  на "ax bx x x"

Замена с помощью выражений

Если строка для замены начинается с символов "\=", то остальная часть строки рассматривается как выражение, которое должно быть вычислено. Имейте только в виду, что это не работает рекурсивно: функция substitute() внутри выражения не может использовать "\=" в строке замены.

В этом случае особый смысл символов, упомянутых в разделе |спецсимволы_для_замены| не играет роли, за исключением символов "<CR>", "\<CR>" и "\\". Иными словами, в выражении необходимо использовать двойную обратную косую, чтобы получить одну обратную косую черту, для вставки символа <CR> необходимо экранировать его обратной косой, а для вставки переноса строки использовать <CR> как есть.

Для удобства также разрешено использование <NL> в качестве символа переноса строки. Для вставки настоящего символа <NL> (представленного в файле символом NUL) следует предварять <NL> символом обратной косой черты.

К тексту, соответствующему шаблону, можно обратиться с помощью "submatch(0)". Текст, который соответствует первой паре () в шаблоне, доступен с помощью "submatch(1)", и так далее для всех элементов соответствия внутри пары ().

Будьте осторожны: символ-разделитель не должен появляться в выражении! Вы можете использовать в качестве разделителя другие символы, например, "@" или ":". В то же время, результат выражения вполне может содержать символ-разделитель.

Например:

:s@\n@\="\r" . expand("$HOME") . "\r"@

Эта команда выполняет замену символов конца строки новой строкой, содержащей значение переменной окружения $HOME.

Приведём пример использования автокоманд и команды ":retab" для редактирования файла, который был сохранён с использованием ширины табуляции равной 8, но редактировался с табуляцией, равной 4. Предупреждение: пробелы внутри строк могут изменяться! См. также справку по опции 'softtabstop'.

:auto BufReadPost    *.xx    retab! 4
:auto BufWritePre    *.xx    retab! 8
:auto BufWritePost   *.xx    retab! 4
:auto BufNewFile     *.xx    set ts=4

5. Копирование и перемещение текста

:dis 1a

:map <MiddleMouse> <Nop>
:imap <MiddleMouse> <Nop>

:put ='path' . \",/test\"

Все эти команды используются для копирования текста из одного места в другое. Сначала при помощи команд копирования, удаления или изменения текст помещается в регистр, затем содержимое регистра вставляется в буфер при помощи команды вклейки. Эти же команды могут использоваться также и для перемещения текста из одного файла в другой, поскольку Vim сохраняет содержимое регистров при переходе между буферами (для быстрого перехода между двумя файлами используйте команду CTRL-^).

Команду вклейки можно повторить с помощью команды "." (за исключением команды :put) или отменить. Если команда, которая использовалась для копирования текста, была |построчно|й, то Vim вклеивает фрагмент текста под ("p") или над ("P") строкой, в которой находится курсор. В противном случае Vim вставляет текст после ("p") или перед ("P") курсором. По команде ":put" Vim всегда вклеивает фрагмент текста в следующей строке. Для быстрой перестановки двух символов можно пользоваться последовательностью команд "xp". Поменять местами две строки можно при помощи последовательности "ddp". Два слова можно заменить местами с помощью последовательности команд "deep" (курсор должен располагаться в позиции пробела перед первым словом). После выполнения команды вклейки можно пользоваться командами "']" или "`]" для перемещения курсора в конец вклеенного текста, а для перемещения курсора в начало используйте команды "'[" или "`[".

При использовании команды вклейки, такой как |p| или |P| в Визуальном режиме, Vim попытается заменить выделенный текст содержимым регистра. Успех такой операции зависит от типа выделения и типа фрагмента, который хранится в регистре. Если выделение является блоковым, то это также зависит от размера блока и от того, находятся ли углы блока на существующих символах (дело в том, что в действительности при этом сначала вклеивается содержимое регистра после выделенного блока, а уже затем выделенный блок удаляется).

При использовании режима Визуального блока для помещения текста в регистр, текстовый блок будет вклеиваться до ("P") или после ("p") колонки, в которой находится курсор в текущей и последующих строках. Vim позаботится о том, чтобы весь блок располагался в одной и той же колонке. Благодаря этому, вклеенный текст будет выглядеть так же, как и в момент копирования или удаления. Vim может заменить некоторые символы <Tab> на пробелы для достижения такого эффекта. В то же время, если ширина блока не кратна ширине табуляции, а текст после вставленного блока содержит символы <Tab>, выравнивание этого текста может быть нарушено.

Обратите внимание, что после команды посимвольного копирования Vim оставляет курсор на первом символе скопированного фрагмента, который находится ближе к началу буфера. Это приводит к тому, что команда "yl" не перемещает курсор, а команда "yh" перемещает курсор на один символ влево. Логика такого поведения заключается в следующем: в Vi команда "y", за которой следует перемещение в обратном направлении, не всегда перемещает курсор к первому скопированному символу, т.к. экран не обновляется. В Vim курсор всегда перемещается к первому символу, как этого требует Posix. При выполнении построчного копирования курсор помещается в первую строку, но колонка, в которой он расположен, не изменяется, поэтому он не обязательно будет находится в позиции первого скопированного символа.

Существует девять типов регистров:

1. Безымянный регистр ""
2. 10 нумерованных регистров от "0 до "9
3. Регистр небольшого удаления "-
4. 26 именованных регистров от "a до "z или от "A до "Z
5. Четыре регистра только для чтения ":, "., "% и "#
6. Регистр выражения "=
7. Регистры выделения "*, "+ и "~
8. Регистр-"чёрная дыра" "_
9. Регистр последнего шаблона для поиска "/

1. Безымянный регистр ""

Vim заполняет этот регистр текстом, который был удалён с помощью команд "d", "c", "s", "x", или скопирован по команде "y", независимо от того, был ли указан какой-нибудь специальный регистр (например, "xdd). Исключением является регистр "_: команда "_dd не сохраняет удалённый текст вообще нигде. Vim использует содержимое этого регистра в любой команде вклейки, которая не указывает регистр явно. Этот регистр также доступен явно по имени '"', т.е. вам потребуется ввести две двойные кавычки. Запись в регистр "" приводит к записи в регистр "0.
Vi: при переходе к другому файлу содержимое регистров не сохраняется; в Vi нет регистра '"'.

2. Нумерованные регистры от "0 до "9    

Vim заполняет эти регистры фрагментами текста, которые затронуты командами удаления и копирования.

Нумерованный регистр 0 содержит фрагмент от самой последней команды копирования, если в команде не был указан какой-либо специальный регистр ["x].

Нумерованный регистр 1 содержит фрагмент от самой последней команды удаления или изменения текста, если в команде не был указан какой-либо специальный регистр и удалённый фрагмент был больше, чем одна строка (если фрагмент меньше строки, то используется регистр небольшого удаления). Исключение из правила сделано для следующих команд: |%|, |(|, |)|, |`|, |/|, |?|, |n|, |N|, |{| и |}|. С этими командами всегда используется регистр 1, поскольку этого требует совместимость с Vi. При этом, если удаление происходит в пределах строки, то регистр "- также задействуется.

С каждым последующим удалением или изменением Vim сдвигает предыдущее содержимое регистра 1 в регистр 2, регистра 2 - в регистр 3, и т.д.; предыдущее содержимое регистра 9 утрачивается.

Vi: содержимое нумерованных регистров не сохраняется при переходе к другому файлу; в Vi нет регистра 0.

3. Регистр небольшого удаления "-

Этот регистр содержит фрагмент текста от команды удаления, если этот фрагмент меньше одной строки, кроме тех случаев, когда в команде явно указан какой-либо другой регистр ["x].

Vi не имеет такой возможности.

4. Именованные регистры от "a до "z и от "A до "Z

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

5. Регистры только для чтения ":, "., "% и "#

Регистры '%', '#', ':' и '.' предназначены только для чтения. Их можно указывать только с командами "p", "P" и ":put", а также с командой CTRL-R.

Vi не имеет такой возможности.

6. Регистр выражения "=

Это в действительности даже не регистр для хранения текста, а способ использования выражений в командах, которые используют регистры. Регистр выражения открыт только для чтения - в него нельзя поместить текст. После ввода '=' курсор перемещается в командную строку, где можно ввести любое выражение (см. |выражение|). При этом вам доступны все обычные команды для редактирования командной строки, включая просмотр истории выражений. Когда режим ввода командной строки завершается при помощи ввода символа <CR>, то Vim вычисляет результат выражения. Если режим командной строки завершается нажатием <Esc>, то Vim оставляет выражение без внимания. Если выражение не было введено, то Vim использует предыдущее выражение (как по команде "/"). Если регистр "= используется с командой "p", то строка будет разбиваться на символах <NL>. Если строка заканчивается на <NL>, то регистр воспринимается как построчный.

Vi не имеет такой возможности.

7. Регистры выделения "*, "+ и "~

Эти регистры используются для сохранения и получения выделенного в графическом интерфейсе фрагмента текста. См. также |кавычка_звёздочка| и |кавычка+|. Если системный буфер обмена не работает или недоступен, то вместо этих регистров используется безымянный регистр.

Vi не имеет такой возможности.

Обратите внимание, что на системах, которые используют X11 имеется отличие между "* и "+. Это различие подробно объясняется в |x11-выделение|. В MS-Windows использование "* и "+ практически ничем не отличается и идентично обращению к системному буферу обмена, см. |gui-буфер_обмена|.

Регистр только для чтения "~ сохраняет фрагмент текста, который был перед этим перетащен с помощью мыши (т.н. операция drag'n'drop). Если что-то было помещено таким образом в окно редактора Vim, то это что-то помещается в регистр "~ и происходит извещение редактора отправкой псевдокнопки <Drop>. Эта кнопка может быть при желании переопределена привязкой; значением по умолчанию для всех режимов является вставка содержимого регистра "~ в позиции курсора.

Vi не имеет такой возможности.
Доступно в данный момент только для версии с графическим интерфейсом GTK и только в том случае, если Vim скомпилирован с особенностью |+dnd|.

Замечание: Регистр "~ используется только при переноске мышью в редактор Vim обычного текста. Переноска в редактор списков ссылок URI обрабатывается иначе.

8. Регистр-"чёрная дыра" "_

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

Vi не имеет такой возможности.

9. Регистр последнего шаблона для поиска "/

Содержит самый последний из использованных шаблон для поиска. Содержимое этого регистра используется в команде "n" и с опцией 'hlsearch'. В этот регистр можно записывать информацию с помощью команды ":let", что позволяет заставить 'hlsearch' подсвечивать совсем иные соответствия без фактического выполнения поиска. В этот регистр нельзя помещать текст командами копирования или удаления.

Vi не имеет такой возможности.

В регистр можно помещать информацию с помощью команды ":let" |let-@|. Пример:

:let @/ = "the"

Если команда вклейки используется без указания регистра, то Vim использует регистр, который был заполнен в последнюю очередь (это также содержимое безымянного регистра). Если вы чувствуете неуверенность, то воспользуйтесь командой ":dis" для того, чтобы посмотреть, что находится в интересующем вас регистре (по этой команде выдаётся список всех именованных и нумерованных регистров; безымянный регистр показывается как '"').

Три нижеследующих команды всегда работают над целыми строками.

6. Форматирование текста

:nnoremap Q gq

Пример: для форматирования текущего абзаца используйте команду:

gqap

Команда "gq" после своего выполнения оставляет курсор в строке, куда курсор отправляется после совершения перемещения. Это позволяет повторять форматирование с помощью команды ".". Такая техника отлично работает с командами "gqj" (форматировать текущую и следующие строки) и "gq}" (форматировать текст до конца абзаца). Замечание: при включённой опции 'formatprg' "gq" оставляет курсор на первой отформатированной строке (как при работе с командой-фильтром).

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

gwap

Чтобы всегда поддерживать абзацы текста в отформатированном состоянии, следует добавить флаг 'a' к значению опции 'formatoptions', См. |автоформатирование|.

При включённой опции 'autoindent' Vim использует отступ первой строки для всех последующих строк.

Форматирование не изменяет пустые строки (однако изменяет строки, в которых есть только пробелы!).

Опция 'joinspaces' используется при склейке строк.

Вы можете установить значение опции 'formatprg' равным имени внешней программы, которую Vim будет использовать для форматирования текста. При форматировании текста при помощи внешней программы значение опции 'textwidth' и других не учитывается.

В Vim нет встроенной команды для выравнивания текста с двух сторон. Это можно сделать при помощи внешней программы, например "par" (для форматирования до конца абзаца можно ввести, например, команду "!}par"), либо установить значение опции 'formatprg' равным "par".

Vim способен форматировать комментарии особым образом. Vim распознаёт комментарий по специальным символам в начале строки (игнорируя пробелы). При этом можно использовать три типа комментариев:

• Комментарий, который использует повторяющийся символ в начале каждой строки. Примером такого комментария служит комментарий в файлах сценариев оболочки, который начинается с символа '#'.
• Комментарий, который начинается со специального символа в первой строке, но не в последующих. Примером такого комментария служит этот список, в котором каждый элемент начинается с дефиса.
• Комментарий, который состоит из трёх частей, а именно: символы для начала комментария, символы для окончания комментария и необязательные символы для начала строк внутри комментария. Символы, которые используются в начале, середине и конце могут быть разными. Пример такого комментария - комментарий в стиле языка C:

/*
 * это комментарий на языке C 
 */

Значением опции 'comments' является список частей, разделённых запятой. Каждая часть определяет тип символов комментария. Каждая часть выглядит следующим образом:

{флаги}:{строка}

{строка} это буквальный текст, который используется в данном комментария.

{флаги}:

Если строка не имеет флагов 'f', 's', 'm' или 'e', то Vim предполагает, что символы комментария повторяются в начале каждой строки комментария. Поле флагов может быть пустым.

Любой пробел в тексте перед {строкой} и после {строки} является частью {строки}, поэтому не следует включать в строку комментария пробелы, если они не являются обязательной частью комментария.

Если начало одного комментария является частью другого, то эту часть следует указывать после целого. Например, чтобы описать в качестве комментариев как "-", так и "->", используйте

:set comments=f:->,f:-

Трёхчастный комментарий должен всегда описываться в таком порядке: начало комментария, средняя часть и конец комментария, без описания других частей между ними. Пример трёхчастного комментария:

sr:/*,mb:*,ex:*/

В этом примере, в частности, описан комментарий в стиле языка C. Чтобы избежать ошибочного распознавания строки вроде "*ptr" в качестве комментария, средняя часть включает флаг 'b'. В трёхчастных комментариях Vim проверяет текст после начала и средней части в поисках конца комментария. Если Vim обнаруживает конец комментарий, то на следующей строке комментарий не продолжается. Трёхчастные комментарии должны иметь среднюю часть, поскольку иначе Vim не сможет распознать среднюю часть комментария.

Обратите внимание на использование флага "x" в приведённом выше определении трёхчастного комментария. После того как вы нажмёте клавишу <Return> внутри комментария в стиле языка C, Vim вставит в текст символы средней части комментария, например " * ". Для завершения ввода комментария достаточно просто ввести символ "/" перед вводом любого другого текста на новой строке. При этом произойдёт замена средней части комментария на конечную часть комментария и на строке останется только " */". Иными словами, вам не потребуется предварительно нажимать кнопку <Backspace>.

Примеры:

По умолчанию включается "b:#". Это значит, что строка, которая начинается с "#include" не воспринимается как комментарий, однако строка, которая начинается с "# define" будет считаться комментарием.

Зачастую выравнивание по правому краю может быть заменено на выравнивание по левому краю с помощью дополнительного пробела. Например, в комментариях в стиле Javadoc, этим обстоятельством вполне можно пользоваться (при использовании ":set" перед пробелом вставляется косая черта):

s1:/*,mb:*,ex:*/

Обратите внимание, что в начальной части указан отступ, поэтому средняя часть выравнивается по левому краю с начальной частью, а затем добавляется один символ. Это позволяет выравнивать по левому краю начальную и среднюю часть в комментариях следующего вида:

/**
 * комментарий
 */

Доступно только в том случае, если Vim скомпилирован с особенностью |+comments|.

Опция 'formatoptions' может быть использована для контроля над тем, как Vim форматирует текст. Значение опции 'formatoptions' представляет собой строку, которая может содержать любой из перечисленных ниже символов. По умолчанию значением этой опции является строка "tcq". Для удобочитаемости символы в строке можно разбивать запятыми.

1. первый элемент
   переносится
2. второй элемент

    первая строка абзаца
вторая строка того же абзаца
третья строка.

Флаги 't' и 'c' позволяют указать, как Vim осуществляет автоматический перенос строк:

Замечание: если значение опции 'textwidth' равно 0, то Vim не выполняет форматирование, но вставляет начало комментариев в соответствии со значением опции 'comments'.

Замечание: при включённой опции 'paste' Vim вообще не выполняет форматирование.

Замечание: значение опции 'textwidth' может быть ненулевым даже в том случае, если Vim не переносит строки автоматически. В этом случае опция 'textwidth' используется при форматировании вручную с помощью команды "gq".

Если опция 'comments' содержит "/*", "*" и/или "*/", то Vim располагает встроенными механизмами для ещё более разумного обращения с такими комментариями.

Открытие новой строки до или после "/*" или "*/" (при наличии флага 'r' или 'o' в 'formatoptions') вставляет правильное начало строки автоматически. То же самое происходит и при форматировании или автоматическом переносе строк. Открытие строки после строки, которая начинается с "/*" или "*" и содержит "*/", не будет приводить к вставке символов комментария в новой строке, а отступ новой строки будет наследоваться из строки, которая содержит начало комментария. Например:

/* ~
 * Обычный комментарий. ~
 */ ~

 Отступ этой строки такой же, как и у строки, в которой начинается
 комментарий.

Описанные выше возможности действительно впечатляют, особенно в сочетании с новой командой :autocmd, которая позволяет подготавливать разные настройки для различных типов файлов.

Несколько примеров:
  для кода на языке C (форматировать только комментарии):

:set fo=croq

  для почты и конференций новостей (форматировать всё, не подставлять
  символы комментария по команде "o"):

:set fo=tcrq

Автоматическое форматирование

Если в значении опции 'formatoptions' присутствует флаг 'a', то текст будет форматироваться автоматически при каждой вставке или удалении фрагмента текста. Это хорошо подходит для редактирования абзацев текста. Вот несколько советов по использованию этой возможности:

• Вам потребуется явно отделять абзацы. Самый простой способ это сделать - разделять абзацы пустой строкой. Если абзацы не разделены пустой строкой, вам может подойти другой способ -  использование флага 'w' и добавление пробела в конце каждой строки абзаца кроме последней.
• Значение опции 'formatoptions' можно устанавливать на основании типа файла (см. |тип_файла|) или для каждого файла в отдельности при помощи |режимной_строки|).
• Значение опции 'formatoptions' "aw2tq" позволяет создавать текст с таким форматированием:

    Раз, два, тpи, четыpе, пять -
Вышел зайчик погулять.
    Снижена опасность риска 
Если в паспорте прописка.

• Флаг 'c' позволяет затрагивать автоматическим форматированием только комментарии. Это полезно при редактировании исходного кода.

Несколько предупреждений:

• Если часть текста неправильно разбита на абзацы, то внесение изменений в этом фрагменте в любом случае будет приводить к автоматическому форматированию. Подумайте о том, чтобы отключить автоматическое форматирование:

:set fo-=a

• При использовании флага 'w' (пробел на конце строки обозначает продолжение абзаца на следующей строке), при удалении последней строки абзаца по команде |dd| абзац будет склеен со следующим абзацем в одно целое.
• Изменённый текст сохраняется для команды отмены. Любое форматирование также является изменением. Это значит, что любое действие по форматированию текста сохраняет исходное состояние для того, чтобы отмена команды была возможна. Это может потребовать большого количества памяти.
• Форматирование длинного абзаца и/или абзаца со сложными отступами может быть медленным.