view runtime/doc/vim-ru.1 @ 32936:c517845bd10e v9.0.1776

patch 9.0.1776: No support for stable Python 3 ABI Commit: https://github.com/vim/vim/commit/c13b3d1350b60b94fe87f0761ea31c0e7fb6ebf3 Author: Yee Cheng Chin <ychin.git@gmail.com> Date: Sun Aug 20 21:18:38 2023 +0200 patch 9.0.1776: No support for stable Python 3 ABI Problem: No support for stable Python 3 ABI Solution: Support Python 3 stable ABI Commits: 1) Support Python 3 stable ABI to allow mixed version interoperatbility Vim currently supports embedding Python for use with plugins, and the "dynamic" linking option allows the user to specify a locally installed version of Python by setting `pythonthreedll`. However, one caveat is that the Python 3 libs are not binary compatible across minor versions, and mixing versions can potentially be dangerous (e.g. let's say Vim was linked against the Python 3.10 SDK, but the user sets `pythonthreedll` to a 3.11 lib). Usually, nothing bad happens, but in theory this could lead to crashes, memory corruption, and other unpredictable behaviors. It's also difficult for the user to tell something is wrong because Vim has no way of reporting what Python 3 version Vim was linked with. For Vim installed via a package manager, this usually isn't an issue because all the dependencies would already be figured out. For prebuilt Vim binaries like MacVim (my motivation for working on this), AppImage, and Win32 installer this could potentially be an issue as usually a single binary is distributed. This is more tricky when a new Python version is released, as there's a chicken-and-egg issue with deciding what Python version to build against and hard to keep in sync when a new Python version just drops and we have a mix of users of different Python versions, and a user just blindly upgrading to a new Python could lead to bad interactions with Vim. Python 3 does have a solution for this problem: stable ABI / limited API (see https://docs.python.org/3/c-api/stable.html). The C SDK limits the API to a set of functions that are promised to be stable across versions. This pull request adds an ifdef config that allows us to turn it on when building Vim. Vim binaries built with this option should be safe to freely link with any Python 3 libraies without having the constraint of having to use the same minor version. Note: Python 2 has no such concept and this doesn't change how Python 2 integration works (not that there is going to be a new version of Python 2 that would cause compatibility issues in the future anyway). --- Technical details: ====== The stable ABI can be accessed when we compile with the Python 3 limited API (by defining `Py_LIMITED_API`). The Python 3 code (in `if_python3.c` and `if_py_both.h`) would now handle this and switch to limited API mode. Without it set, Vim will still use the full API as before so this is an opt-in change. The main difference is that `PyType_Object` is now an opaque struct that we can't directly create "static types" out of, and we have to create type objects as "heap types" instead. This is because the struct is not stable and changes from version to version (e.g. 3.8 added a `tp_vectorcall` field to it). I had to change all the types to be allocated on the heap instead with just a pointer to them. Other functions are also simply missing in limited API, or they are introduced too late (e.g. `PyUnicode_AsUTF8AndSize` in 3.10) to it that we need some other ways to do the same thing, so I had to abstract a few things into macros, and sometimes re-implement functions like `PyObject_NEW`. One caveat is that in limited API, `OutputType` (used for replacing `sys.stdout`) no longer inherits from `PyStdPrinter_Type` which I don't think has any real issue other than minor differences in how they convert to a string and missing a couple functions like `mode()` and `fileno()`. Also fixed an existing bug where `tp_basicsize` was set incorrectly for `BufferObject`, `TabListObject, `WinListObject`. Technically, there could be a small performance drop, there is a little more indirection with accessing type objects, and some APIs like `PyUnicode_AsUTF8AndSize` are missing, but in practice I didn't see any difference, and any well-written Python plugin should try to avoid excessing callbacks to the `vim` module in Python anyway. I only tested limited API mode down to Python 3.7, which seemes to compile and work fine. I haven't tried earlier Python versions. 2) Fix PyIter_Check on older Python vers / type##Ptr unused warning For PyIter_Check, older versions exposed them as either macros (used in full API), or a function (for use in limited API). A previous change exposed PyIter_Check to the dynamic build because Python just moved it to function-only in 3.10 anyway. Because of that, just make sure we always grab the function in dynamic builds in earlier versions since that's what Python eventually did anyway. 3) Move Py_LIMITED_API define to configure script Can now use --with-python-stable-abi flag to customize what stable ABI version to target. Can also use an env var to do so as well. 4) Show +python/dyn-stable in :version, and allow has() feature query Not sure if the "/dyn-stable" suffix would break things, or whether we should do it another way. Or just don't show it in version and rely on has() feature checking. 5) Documentation first draft. Still need to implement v:python3_version 6) Fix PyIter_Check build breaks when compiling against Python 3.8 7) Add CI coverage stable ABI on Linux/Windows / make configurable on Windows This adds configurable options for Windows make files (both MinGW and MSVC). CI will also now exercise both traditional full API and stable ABI for Linux and Windows in the matrix for coverage. Also added a "dynamic" option to Linux matrix as a drive-by change to make other scripting languages like Ruby / Perl testable under both static and dynamic builds. 8) Fix inaccuracy in Windows docs Python's own docs are confusing but you don't actually want to use `python3.dll` for the dynamic linkage. 9) Add generated autoconf file 10) Add v:python3_version support This variable indicates the version of Python3 that Vim was built against (PY_VERSION_HEX), and will be useful to check whether the Python library you are loading in dynamically actually fits it. When built with stable ABI, it will be the limited ABI version instead (`Py_LIMITED_API`), which indicates the minimum version of Python 3 the user should have, rather than the exact match. When stable ABI is used, we won't be exposing PY_VERSION_HEX in this var because it just doesn't seem necessary to do so (the whole point of stable ABI is the promise that it will work across versions), and I don't want to confuse the user with too many variables. Also, cleaned up some documentation, and added help tags. 11) Fix Python 3.7 compat issues Fix a couple issues when using limited API < 3.8 - Crash on exit: In Python 3.7, if a heap-allocated type is destroyed before all instances are, it would cause a crash later. This happens when we destroyed `OptionsType` before calling `Py_Finalize` when using the limited API. To make it worse, later versions changed the semantics and now each instance has a strong reference to its own type and the recommendation has changed to have each instance de-ref its own type and have its type in GC traversal. To avoid dealing with these cross-version variations, we just don't free the heap type. They are static types in non-limited-API anyway and are designed to last through the entirety of the app, and we also don't restart the Python runtime and therefore do not need it to have absolutely 0 leaks. See: - https://docs.python.org/3/whatsnew/3.8.html#changes-in-the-c-api - https://docs.python.org/3/whatsnew/3.9.html#changes-in-the-c-api - PyIter_Check: This function is not provided in limited APIs older than 3.8. Previously I was trying to mock it out using manual PyType_GetSlot() but it was brittle and also does not actually work properly for static types (it will generate a Python error). Just return false. It does mean using limited API < 3.8 is not recommended as you lose the functionality to handle iterators, but from playing with plugins I couldn't find it to be an issue. - Fix loading of PyIter_Check so it will be done when limited API < 3.8. Otherwise loading a 3.7 Python lib will fail even if limited API was specified to use it. 12) Make sure to only load `PyUnicode_AsUTF8AndSize` in needed in limited API We don't use this function unless limited API >= 3.10, but we were loading it regardless. Usually it's ok in Unix-like systems where Python just has a single lib that we load from, but in Windows where there is a separate python3.dll this would not work as the symbol would not have been exposed in this more limited DLL file. This makes it much clearer under what condition is this function needed. closes: #12032 Signed-off-by: Christian Brabandt <cb@256bit.org> Co-authored-by: Yee Cheng Chin <ychin.git@gmail.com>
author Christian Brabandt <cb@256bit.org>
date Sun, 20 Aug 2023 21:30:04 +0200
parents de5a43c5eedc
children ecb5d46edd81
line wrap: on
line source

.TH VIM 1 "2002 Feb 22"
.SH ИМЯ
vim \- Vi IMproved (Улучшенный Vi), текстовый редактор для программистов
.SH КОМАНДНАЯ СТРОКА
.br
.B vim
[ключи] [файл ..]
.br
.B vim
[ключи] \-
.br
.B vim
[ключи] \-t метка
.br
.B vim
[ключи] \-q [файл ошибок]
.PP
.br
.B ex
.br
.B view
.br
.B gvim
.B gview
.br
.B rvim
.B rview
.B rgvim
.B rgview
.SH ОПИСАНИЕ
.B Vim
-- текстовый редактор, обратно-совместимый с Vi.
Он может быть использован для правки всех видов простого текста.
Особенно он хорош для правки исходных текстов программ.
.PP
По сравнению с Vi, 
.B Vim
имеет много усовершенствований: многократная отмена операций,
множественность окон и буферов, подсветка синтаксиса, правка командной строки,
автодополнение имён файлов, встроенная справка, визуальное выделение и т.п.
См. ":help vi_diff.txt" для получения полного списка различий между
.B Vim
и Vi.
.PP
Во время работы в
.B Vim
можно получить справку с помощью системы встроенной справки (команда ":help").
См. раздел "ВСТРОЕННАЯ СПРАВКА" ниже по тексту.
.PP
Чаще всего
.B Vim
запускают для правки одного файла при помощи команды
.PP
	vim файл
.PP
В общем виде команда запуска
.B Vim
выглядит так:
.PP
	vim [ключи] [список файлов]
.PP
Если список файлов отсутствует, редактор начнёт работу с пустым буфером.
В противном случае имя файла должно быть указано одним из следующих четырёх способов:
.TP 12
файл ..
Список имён файлов.
Первый файл будет объявлен активным и загружен в буфер. Курсор будет помещён
в первой строке буфера. Доступ к другим файлам может быть осуществлён при
помощи команды ":next". Чтобы править файл, имя которого начинается с символа
"дефис" (-), перед списком файлов необходимо поставить "--".
.TP
\-
Файл будет прочитан из потока стандартного ввода. Команды будут считываться
из стандартного потока диагностики (stderr), который должен быть 
терминалом.
.TP
\-t {метка}
Имя файла и начальная позиция курсора зависят от "метки", похожей на метку goto.
{метка} ищется в файле меток, соответствующий файл становится активным, а 
соответствующая команда исполняется.
Чаще всего используется в программах на языке Си, где {метка} может быть именем
функции.
Файл, содержащий функцию, становится активным, а курсор помещается в начало функции.
См. ":help tag-commands".
.TP
\-q [файл ошибок]
Начать работу в режиме быстрого исправления.
При этом считывается [файл ошибок] и первая ошибка выводится на экран.
Если [файл ошибок] не указан, имя файла берётся из значения опции 'errorfile'
(по умолчанию: "AztecC.Err" для Amiga, "errors.err" для других систем).
К следующим ошибкам можно перейти по команде ":cn".
См. ":help quickfix".
.PP
.B Vim
ведёт себя по-разному в зависимости от имени команды (исполняемый файл может
быть одним и тем же).
.TP 10
vim
"Нормальный" запуск, всё по умолчанию.
.TP
ex
Запуск в режиме Ex. Для перехода в нормальный режим
необходимо выполнить команду ":vi". Режим Ex включает
также ключ "\-e".
.TP
view
Запуск в режиме "только для чтения". Вы будете защищены от случайной записи 
файла. То же самое можно сделать ключом "\-R".
.TP
gvim gview
Версия с графическим интерфейсом. Запускается в новом окне.
То же самое можно сделать при запуске с ключом "\-g".
.TP
rvim rview rgvim rgview
Как и предыдущие команды, но с ограничениями. Нельзя запускать команды оболочки
или приостанавливать работу
.B Vim.
Вместо приставки "r" можно использовать ключ "\-Z".
.SH КЛЮЧИ
Ключи могут быть указаны в любом порядке, до или после имён
файлов. Ключи без аргументов могут быть объединены под одним
дефисом.
.TP 12
+[номер]
В первом файле курсор будет помещён на строку с указанным номером.
Если "номер" не указан, курсор будет помещён на последнюю строку.
.TP
+/{шаблон}
В первом файле курсор будет помещён на место первого совпадения
с указанным шаблоном. См. ":help search-pattern" для получения
списка допустимых шаблонов.
.TP
+{команда}
.TP
\-c {команда}
{команда} исполняется после загрузки первого файла как команда Ex.
Если {команда} содержит пробелы, то она должна быть заключена в
двойные кавычки (в зависимости от используемой оболочки).
Пример: vim "+set si" main.c
.br
Примечание: Можно указывать до десяти команд "+" или "\-c".
.TP
\-\-cmd {команда}
Как "\-c", но команда исполняется перед обработкой любого файла
настроек (vimrc).
Можно указывать до десяти таких команд, независимо от количества
команд "\-c".
.TP
\-A
Если
.B Vim
был собран с поддержкой арабского языка для правки файлов,
набранных справа налево, и с поддержкой арабской клавиатуры,
этот ключ запускает
.B Vim
в арабском режиме, с включенной опцией 'arabic'. В противном 
случае
.B Vim
завершает работу с ошибкой.
.TP
\-b
Двоичный режим.
Производится настройка некоторых опций, делающих возможной правку
двоичного или исполняемого файла.
.TP
\-C
Режим совместимости. Включает опцию 'compatible'.
.B Vim
будет работать почти как Vi, даже если существует файл .vimrc.
.TP
\-d
Режим поиска различий.
Должно быть указано два или три имени файла.
.B Vim
откроет все файлы и покажет различия между ними
(как vimdiff(1)).
.TP
\-d {устройство}
Открыть {устройство} для использования в качестве терминала (только на Amiga).
Пример:
"\-d con:20/30/600/150".
.TP
\-e
Запустить
.B Vim
в режиме Ex, как будто исполняемый файл имеет имя "ex".
.TP
\-f
Режим активного приложения. Версия
.B Vim
с графическим интерфейсом не будет ветвиться и отключаться
от запустившей её оболочки. На платформе Amiga
.B Vim
не будет создавать новое окно. Этот ключ нужно использовать,
когда
.B Vim
запускается программой, которая должна ждать завершения
сеанса правки (например, программа для работы с электронной почтой).
На платформе Amiga команды ":sh" и ":!" не будут работать.
.TP
\-\-nofork
Режим активного приложения. Версия
.B Vim
с графическим интерфейсом не будет ветвиться и отключаться
от запустившей её оболочки.
.TP
\-F
Если
.B Vim
был собран с поддержкой FKMAP для правки текста справа налево
и настроек клавиатуры для языка фарси, этот ключ запускает
.B Vim
в режиме фарси, иначе говоря, с включёнными опциями 
\&'fkmap' и 'rightleft'.
В противном случае
.B Vim
завершает работу с сообщением об ошибке.
.TP
\-g
Если
.B Vim
был собран с поддержкой графического интерфейса, этот ключ
включает графический интерфейс. В противном случае
.B Vim
завершает работу с сообщением об ошибке.
.TP
\-h
Выводит краткую информацию об аргументах и ключах командной строки.
После этого
.B Vim
завершает работу.
.TP
\-H
Если
.B Vim
был собран с поддержкой правки текста справа налево
и настроек клавиатуры для иврита, этот ключ запускает
.B Vim
в режиме иврита, иначе говоря, с включёнными опциями 'hkmap' и 'rightleft'.
В противном случае
.B Vim
завершает работу с сообщением об ошибке.
.TP
\-i {viminfo}
Если используется файл viminfo, то этот ключ задаёт имя такого файла (вместо
"~/.viminfo" по умолчанию). Можно также избежать использования файла viminfo
путём указания имени "NONE".
.TP
\-L
То же, что и \-r.
.TP
\-l
Режим Lisp. Включаются опции 'lisp' и 'showmatch'.
.TP
\-m
Изменение файлов запрещено. При этом отключается опция 'write', поэтому
запись файлов становится невозможной.
.TP
\-N
Режим неполной совместимости. Отключается 'compatible'.
.B Vim
будет работать лучше, но не будет полностью совместим с Vi, даже если
отсутствует файл сценария настроек (.vimrc).
.TP
\-n
Не использовать своп-файл. Восстановление при сбое в работе будет невозможно.
Удобно для правки файла на очень медленном носителе (например, гибком диске).
То же самое можно сделать командой ":set uc=0". Отмена -- ":set uc=200".
.TP
\-o[N]
Открыть N окон, разделённых по горизонтали. Если N не указано, то открывается 
по одному окну на каждый файл.
.TP
\-O[N]
Открыть N окон, разделённых по вертикали. Если N не указано, то открывается 
по одному окну на каждый файл.
.TP
\-R
Режим "только для чтения". Включается опция 'readonly'.
Файл в буфере доступен для редактирования, но его копию на диске нельзя
случайно перезаписать. Для сохранения файла необходимо добавить восклицательный
знак к соответствующей команде Ex (например, ":w!").
Ключ "\-R" подразумевает также, что используется и ключ "\-n" (см. выше).
Опция 'readonly' может быть выключена по команде ":set noro".
См. ":help 'readonly'".
.TP
\-r
Вывести список своп-файлов и информацию об их использовании для восстановления после сбоя.
.TP
\-r {файл}
Режим восстановления.
Для восстановления после сбоя будет использован своп-файл.
Своп-файл имеет то же имя, что и текстовый файл, но с добавлением расширения ".swp".
См. ":help recovery".
.TP
\-s
Тихий режим. Только при запуске как "Ex" или если перед "\-s" указан ключ "\-e".
.TP
\-s {scriptin}
Считывается файл сценария {scriptin}. При этом, содержимое файла воспринимается
в виде команд, как если бы они были набраны на консоли. 
То же самое достигается командой ":source! {scriptin}".
Если конец файла считывается до завершения работы редактора, то в дальнейшем 
ввод осуществляется с клавиатуры.
.TP
\-T {terminal}
Сообщает
.B Vim
тип используемого терминала. Необходимо только в тех ситуациях, когда 
автоматическое определение терминала не работает. Имя терминала должно быть 
известно
.B Vim
(встроено в него) или определено в файлах termcap или terminfo.
.TP
\-u {vimrc}
Использовать команды из файла сценария {vimrc} для настройки.
Все остальные файлы настроек пропускаются.
Удобно для редактирования специальных типов файлов.
Чтобы избежать использования сценариев настроек вообще, можно использовать
имя "NONE". См. ":help initialization".
.TP
\-U {gvimrc}
Использовать команды из файла сценария {gvimrc} для настройки графического 
интерфейса.
Все остальные файлы настроек для графического интерфейса пропускаются.
Чтобы избежать использования сценариев настроек графического интерфейса вообще, 
можно использовать имя "NONE". См. ":help gui-init".
.TP
\-V
"Болтливый" режим. Выводить сообщения о том, какие файлы читаются, и о
чтении-записи файла viminfo.
.TP
\-v
Запустить
.B Vim
в режиме Vi, как будто исполняемый файл имеет имя "vi". Имеет смысл только если
исполняемый файл имеет имя "ex".
.TP
\-w {scriptout}
Все символы, введённые с клавиатуры вплоть до момента завершения работы, 
записываются в файл {scriptout}.
Удобно в том случае, когда вы хотите создать файл сценария для последующего 
использования с "vim \-s" или ":source!". Если файл {scriptout} уже существует, 
то новые символы будут добавляются в конец файла.
.TP
\-W {scriptout}
Как "\-w", но уже существующий файл будет перезаписан.
.TP
\-x
Шифровать записываемые файлы. Будет выдано приглашение ввести пароль.
.TP
\-X
Не подключаться к X-серверу. Ускоряет загрузку на консоли, но делает невозможным
использование заголовка окна и буфера обмена.
.TP
\-Z
Ограниченный режим. Работает так же, как и программы, начинающиеся с "r".
.TP
\-\-
Конец ключей. Все остальные аргументы рассматриваются как имена файлов.
Может быть использовано для правки файлов, имена которых начинаются с дефиса.
.TP
\-\-help
Вывести краткую справку и завершить работу. То же, что и "\-h".
.TP
\-\-version
Вывести информацию о версии программы и завершить работу.
.TP
\-\-remote
Подключиться к серверу Vim и заставить его править файлы, указанные в
последующих аргументах. Если сервер не найден, выводится предупреждение,
а файлы правятся в местной копии Vim.
.TP
\-\-remote\-expr {выражение}
Подключиться к серверу Vim и вычислить на нём указанное {выражение}. 
Результат вычисления будет выведен в поток стандартного вывода (stdout).
.TP
\-\-remote\-send {ключи}
Подключиться к серверу Vim и передать ему указанные {ключи}.
.TP
\-\-remote\-silent
Как "\-\-remote", но без вывода предупреждения, если сервер не найден.
.TP
\-\-remote\-wait
Как "\-\-remote", но Vim не будет завершать работу до тех пор, пока не будет 
выполнена правка всех файлов.
.TP
\-\-remote\-wait\-silent
Как "\-\-remote\-wait", но без вывода предупреждения, если сервер не найден.
.TP
\-\-serverlist
Вывести список всех доступных серверов Vim.
.TP
\-\-servername {имя}
Использовать указанное {имя} в качестве имени сервера. Если ключ 
"\-\-remote" не указан, то {имя} присваивается данной копии Vim, 
в противном случае указывает на имя сервера, к которому следует 
подключиться.
.TP
\-\-socketid {id}
Только для графического интерфейса GTK: использовать механизм GtkPlug для
запуска gvim в отдельном окне.
.TP
\-\-echo\-wid
Только для графического интерфейса GTK: вывести идентификатор окна (Window ID)
в поток стандартного вывода (stdout).
.SH ВСТРОЕННАЯ СПРАВКА
Для начала, наберите команду ":help".
Введите ":help тема", чтобы получить справку по конкретной теме.
Например, команда ":help ZZ" выведет информацию о команде "ZZ".
Используйте <Tab> и CTRL-D для автоматического дополнения
названий тем (":help cmdline-completion").
Для быстрого перемещения по справочнику используются метки (что-то 
вроде гипертекстовых ссылок, см. ":help"). Таким образом можно 
просматривать все файлы справки, например ":help syntax.txt".
.SH ФАЙЛЫ
.TP 15
/usr/local/lib/vim/doc/*.txt
Файлы справочника
.B Vim.
См. ":help doc-file-list" для получения полного списка.
.TP
/usr/local/lib/vim/doc/tags
Файл меток, используемый для поиска информации в файлах справки.
.TP
/usr/local/lib/vim/syntax/syntax.vim
Системные настройки синтаксиса.
.TP
/usr/local/lib/vim/syntax/*.vim
Файлы синтаксиса для разных языков.
.TP
/usr/local/lib/vim/vimrc
Системные настройки
.B Vim.
.TP
/usr/local/lib/vim/gvimrc
Системный настройки графического интерфейса.
.TP
/usr/local/lib/vim/optwin.vim
Сценарий, используемый при выполнении команды ":options". 
Хороший способ просматривать и изменять настройки.
.TP
/usr/local/lib/vim/menu.vim
Системные настройки меню для gvim.
.TP
/usr/local/lib/vim/bugreport.vim
Сценарий для создания отчёта об обнаруженных глюках. См. ":help bugs".
.TP
/usr/local/lib/vim/filetype.vim
Сценарий для определения типа файла по имени. См. ":help 'filetype'".
.TP
/usr/local/lib/vim/scripts.vim
Сценарий для определения типа файла по содержимому. См. ":help 'filetype'".
.TP
/usr/local/lib/vim/print/*.ps
Файлы для печати PostScript.
.PP
Более свежая информация -- на сайте VIM:
.br
<URL:http://www.vim.org/>
.SH СМОТРИ ТАКЖЕ
vimtutor(1)
.SH АВТОРЫ
Большая часть
.B Vim
создана Брамом Мооленааром (Bram Moolenaar), которому помогает огромное 
количество людей. См. ":help credits" в
.B Vim.
.br
.B Vim
базируется на коде редактора Stevie, написанного Тимом Томпсоном (Tim Thompson),
Тони Эндрюсом (Tony Andrews) и Г. Р. (Фредом) Уолтером (G.R. (Fred) Walter). 
Однако, в настоящее время в Vim почти не осталось ничего от исторического кода 
его предшественника.
.br
Русская локализация 
.B Vim 
выполняется в рамках проекта "РуВим", 
см. <URL:http://sourceforge.net/projects/ruvim/>.
.SH ГЛЮКИ
Скорее всего есть.
См. ":help todo" -- список известных проблем.
.PP
Заметим, что многие вещи, которые считаются глюками, на самом деле
являются результатом слишком полного воспроизведения поведения Vi.
Если вы думаете, что что-то является ошибкой только потому, что 
"Vi делает это по-другому", внимательно прочитайте файл vi_diff.txt 
(или наберите ":help vi_diff.txt" в Vim) и используйте опции 'compatible'
и 'cpoptions'.