The official Vim repository

For translations of this README see the end. What is Vim? Vim is a greatly improved version of the good old UNIX editor Vi. Many new features have been added: multi-level undo, syntax highlighting, command line history

Information

Category: C/C++ / CLI
Watchers: 671
Star: 33.6k
Fork: 5.1k
Last update: Dec 6, 2023

Resource links

http://www.vim.org

https://github.com/vim/vim

README
Issues 1488

Popular

For translations of this README see the end.

What is Vim?

Vim is a greatly improved version of the good old UNIX editor Vi. Many new features have been added: multi-level undo, syntax highlighting, command line history, on-line help, spell checking, filename completion, block operations, script language, etc. There is also a Graphical User Interface (GUI) available. Still, Vi compatibility is maintained, those who have Vi "in the fingers" will feel at home. See runtime/doc/vi_diff.txt for differences with Vi.

This editor is very useful for editing programs and other plain text files. All commands are given with normal keyboard characters, so those who can type with ten fingers can work very fast. Additionally, function keys can be mapped to commands by the user, and the mouse can be used.

Vim runs under MS-Windows (XP, Vista, 7, 8, 10), macOS, Haiku, VMS and almost all flavours of UNIX. Porting to other systems should not be very difficult. Older versions of Vim run on MS-DOS, MS-Windows 95/98/Me/NT/2000, Amiga DOS, Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained.

For Vim9 script see README_VIM9.

Distribution

You can often use your favorite package manager to install Vim. On Mac and Linux a small version of Vim is pre-installed, you still need to install Vim if you want more features.

There are separate distributions for Unix, PC, Amiga and some other systems. This README.md file comes with the runtime archive. It includes the documentation, syntax files and other files that are used at runtime. To run Vim you must get either one of the binary archives or a source archive. Which one you need depends on the system you want to run it on and whether you want or must compile it yourself. Check http://www.vim.org/download.php for an overview of currently available distributions.

Some popular places to get the latest Vim:

Check out the git repository from github.
Get the source code as an archive.
Get a Windows executable from the vim-win32-installer repository.

Compiling

If you obtained a binary distribution you don't need to compile Vim. If you obtained a source distribution, all the stuff for compiling Vim is in the src directory. See src/INSTALL for instructions.

Installation

See one of these files for system-specific instructions. Either in the READMEdir directory (in the repository) or the top directory (if you unpack an archive):

README_ami.txt		Amiga
README_unix.txt		Unix
README_dos.txt		MS-DOS and MS-Windows
README_mac.txt		Macintosh
README_haiku.txt	Haiku
README_vms.txt		VMS

There are other README_*.txt files, depending on the distribution you used.

Documentation

The Vim tutor is a one hour training course for beginners. Often it can be started as vimtutor. See :help tutor for more information.

The best is to use :help in Vim. If you don't have an executable yet, read runtime/doc/help.txt. It contains pointers to the other documentation files. The User Manual reads like a book and is recommended to learn to use Vim. See :help user-manual.

Copying

Vim is Charityware. You can use and copy it as much as you like, but you are encouraged to make a donation to help orphans in Uganda. Please read the file runtime/doc/uganda.txt for details (do :help uganda inside Vim).

Summary of the license: There are no restrictions on using or distributing an unmodified copy of Vim. Parts of Vim may also be distributed, but the license text must always be included. For modified versions a few restrictions apply. The license is GPL compatible, you may compile Vim with GPL libraries and distribute it.

Sponsoring

Fixing bugs and adding new features takes a lot of time and effort. To show your appreciation for the work and motivate Bram and others to continue working on Vim please send a donation.

Since Bram is back to a paid job the money will now be used to help children in Uganda. See runtime/doc/uganda.txt. But at the same time donations increase Bram's motivation to keep working on Vim!

For the most recent information about sponsoring look on the Vim web site: http://www.vim.org/sponsor/

Contributing

If you would like to help making Vim better, see the CONTRIBUTING.md file.

Information

The latest news about Vim can be found on the Vim home page: http://www.vim.org/

If you have problems, have a look at the Vim documentation or tips: http://www.vim.org/docs.php http://vim.wikia.com/wiki/Vim_Tips_Wiki

If you still have problems or any other questions, use one of the mailing lists to discuss them with Vim users and developers: http://www.vim.org/maillist.php

If nothing else works, report bugs directly: Bram Moolenaar [email protected]

Main author

Send any other comments, patches, flowers and suggestions to: Bram Moolenaar [email protected]

This is README.md for version 8.2 of Vim: Vi IMproved.

Translations of this README

Korean

1488 Open More issues

Closed

I'm sad to hear the news.

Moolenaar was a marvelous computer scientist who contributed immensely to the industry throughout his life, and ordinary people outside the industry indirectly benefited from Moolenaar.

It is very sad to learn of his death in his 60s. Wish him a blessed life in the next. I hope that the vim community can carry on his legacy and spirit, so that he can continue to live among us, and together we can make vim better and better.

But, I still feel sad.

Moolenaar是一位了不起的计算机科学家，一生对业界做出了巨大的贡献，业界外的普通人也间接受益于Moolenaar。

得知他60多岁就去世的消息，让人非常的难过。祝福他来生有福报。希望vim社区能继承他的遗志，发扬他的精神，让他继续活在我们之间，一起让vim变得越来越好。

但，我还是感到很悲伤。

ムールネールは生涯を通じてこの業界に多大な貢献をした素晴らしいコンピューター科学者であり、業界外の一般人も間接的にムールネールの恩恵を受けていた。

彼が60代で亡くなったことを知り、とても悲しい。来世での彼の人生が祝福されたものであることを祈ります。ヴィーム・コミュニティが彼の遺産と精神を受け継ぎ、彼が私たちの中で生き続け、共にヴィームをより良いものにしていけることを願っています。

でも、やっぱり寂しい。

Moolenaar war ein hervorragender Informatiker, der sein Leben lang einen enormen Beitrag zur Industrie geleistet hat, und auch der einfache Mann außerhalb der Industrie hat indirekt von Moolenaar profitiert.

Es ist sehr traurig zu erfahren, dass er im Alter von 60 Jahren verstorben ist. Ich wünsche ihm ein gesegnetes Leben im nächsten Leben. Ich hoffe, dass die Vim-Gemeinschaft sein Erbe und seinen Geist weiterführen kann, so dass er weiterhin unter uns leben kann und wir gemeinsam Vim besser und besser machen können.

Aber ich bin immer noch traurig.

Moolenaar était un merveilleux informaticien qui a apporté une immense contribution à l'industrie tout au long de sa vie et l'homme de la rue, en dehors de l'industrie, a bénéficié indirectement de Moolenaar.

Il est très triste d'apprendre qu'il est décédé à l'âge de 60 ans. Je lui souhaite une vie bénie dans l'au-delà. J'espère que la communauté vim pourra perpétuer son héritage et son esprit, afin qu'il puisse continuer à vivre parmi nous et qu'ensemble, nous puissions rendre vim de plus en plus performant.

Mais je me sens toujours triste.

Муленаар был замечательным ученым-компьютерщиком, который на протяжении всей своей жизни вносил огромный вклад в развитие отрасли, а обычные люди, не связанные с отраслью, получали от него косвенную пользу.

Очень печально узнать, что он ушел из жизни в возрасте 60 лет. Я желаю ему благословенной жизни в следующей жизни. Я надеюсь, что сообщество vim сможет продолжить его наследие и дух, чтобы он продолжал жить среди нас, и вместе мы могли бы сделать vim все лучше и лучше.

Но мне все равно грустно.

discuss

opened Aug 5, 2023 by gfsc59 172

Closed

'$q q' shows at the first line

:version
VIM - Vi IMproved 8.0 (2016 Sep 12, compiled Aug 22 2017 18:15:34)
MacOS X (unix) version
Included patches: 1-983
Compiled by Homebrew

I'm using vim version 8.0.983. Everytime i start up vim, it shows $q q at the first line.

This is what the command $ vim shows:

$q q
~                                                                               
~                                                                                                                                                                                        
~                                                                               
~                              VIM - Vi IMproved                                
~                                                                               
~                               version 8.0.983                                 
~                           by Bram Moolenaar et al.                            
~                 Vim is open source and freely distributable                   
~                                                                               
~                        Help poor children in Uganda!                          
~                type  :help iccf<Enter>       for information                  
~                                                                               
~                type  :q<Enter>               to exit                          
~                type  :help<Enter>  or  <F1>  for on-line help                 
~                type  :help version8<Enter>   for version info

And $ vim foo shows:

$q q
~                                                                               
~                                                                               
~                                                                               
~                                                                                                                                               
~                                                                               
"foo" [New File]

opened Aug 22, 2017 by littleylv 160

Closed

[discuss] Popup Window API design.

This is not an issue, but I have no idea how to attach images in vim_dev group. So forgive me create this post in the issues and it can be closed immediately.

The human readable page is here: https://github.com/skywind3000/vim-proposal/blob/master/popup_window.md

Popup Window API Proposal

Problem

Vim has already got some builtin popup-widgets for certain usage, like completion menu or balloon. But users and plugin authors are still asking for more:

In Vim conf 2018, Bram claimed that he has plan for this already:

Popup Windows:

Use for a notification:

Asynchronously show window with text “build done”.

Remove after a few seconds.

Use for picking an item:

Show window where each line is an item

Let user pick an item

A bit like confirm() but much nicer

Summary, there are two types of popup window: interactive and non-interactive.

For non-interactive popup windows, people want to use them to:

Display the documentation for a function:

Display linting errors or warnings:

Preview a portion of file (can be used to preview grep results in quickfix):

Display funny help for newbies (like paperclip assistent in office 2000):

For interactive popup windows, people want to use them to:

pick an item:

display a nice popup menu:

cmd line completion:

use fuzzy finder in a popup window:

There are too many popup-related widgets for certain usage, designing one by one is nearly impossible.

Implementing a neovim's floating window will take too much time (it is working in progress for almost 2-years and still not merge to master).

Can we implement the popup window in a simple and adaptive way ? Is this possible to unify all their needs and simplify API design ?

The following parts of this article will introduce an overlay mechanism similar to Emacs's text overlay which is the backend of various popup windows in Emacs.

API Scope

Popup windows will draw into an overlay layer, A popup will remain after creation until an erase function is called. Everything in the overlay will not interfere vim's states, people can continue editing or using vim commands no matter there is a popup window or not.

So, the APIs are only designed for drawing a popup window and has nothing to do with user input. Dialogs like yes/no box and confirm box require user input, can be simulated with following steps:

function! Dialog_YesNo(...)
    while not_quit
       draw/update the popup window
       get input from getchar()
    endwhile
    erase the popup window
endfunc

Popup window APIs is not responsible for any interactive functionalities. Instead of implementing a complex widget/event system (which is too complex), it is sane to let user to handle the input by getchar().

There can be a popup.vim script contains some predefined popup windows/dialogs and will be shipped with vim itself. User can use the primitive APIs and getchar() to implement other complex dialogs like a popup fuzzy finder or a command line history completion box.

Overlay Buffer

The overlay buffer is a character matrix with the same size of the screen:

|\     |\
| \    | \
|  \   |  \
|   \  |   \
|   |  |   |
| 1 |  | 2 |   <---- Observer
|   |  |   |
|   /  |   /
|  /   |  /
| /    | /
|/     |/

^      ^
|      |
|   Overlay Buffer (M rows and N columns)
|
Ground Vim UI (M rows and N columns)

Similar to Video Buffer (0xb8000) in x86's text mode, the overlay buffer is a 2D array of characters and attributes. Change the content of the 2D array will change the text in the screen.

The overlay buffer is invisible by default and can be enabled by:

set guioptions+=o

Every existent text rendering code in both Vim & GVim needs to be updated to support this overlay buffer, once it finished, we can use it to build powerful popup windows.

There are also some basic APIs for overlay buffer:

add a text string with position and attribute.
erase a rectangle of text.
command redrawoverlay to update the overlay (it uses double buffer to prevent flicker).

With these primitive APIs, user can draw what ever they like on the overlay buffer.

Overlay Panes

Overlay panes is an abstraction of the popup windows, it consists of:

position and size
z order (for overlapping calculation)
background color
border styles
lines of text and text-properties

There can be multiple panes at the same time, the panes can be manipulated by:

pane_create(int row, int col, int width, int height, ...);
pane_destroy(int pane_id);
pane_update(int pane_id, ...);
pane_move(int pane_id, int new_row, int new_col, int new_width, int new_height);
pane_show(int pane_id, bool show_hide);

(PS: they are provided as both C-apis and vim functions).

The life cycle of a pane is between pane_create and pane_destroy.

The (row, col) is using screen coordinate system, and there can be some functions to convert window based coordinate system to screen coordinate system. If you want to display a popup balloon right above your cursor, you can use them to calculate the position.

Finally, there is a function to render the pane list into the overlay buffer:

pane_flush();

If you create some panes, the overlay buffer will not change until pane_flush().

Popup Windows

All the common popup windows are implemented in popup.vim script, they will use panes to display a popup window and getchar() to provide interactive functionalities.

There are some predefined popup windows:

Popup_Message(): display a "build complete" message and hide after a few seconds.
Popup_LinterHint(): display a message right above cursor and hide if cursor moves outside current <cword>.
Popup_Menu(): display a menu (use getchar() to receive user input) and quit after user select an item.
Popup_YesNo(): display a yes/no box and return the result after user made a selection.
...
and so on.

User or plugin authors can use the high level APIs provided by popup.vim or design their own popup window by utilizing lower level pane APIs or overlay APIs.

Summary

It is complex to design an event system or NeoVim's floating window, and nearly impossible to implement every type of popup window for certain usage.

To unify and simplify the interface, this proposal suggests to provide an overlay mechanism with some primitive APIs to:

render a popup window (pane)
erase a popup window
update a popup window

And let user handle input themself by getchar(). At last, makes it possible to enable users to create various popup windows with different styles and functionalities.

2019/3/2 edit: floating window got merged to master.

enhancement discuss

opened Mar 2, 2019 by skywind3000 138

Closed

netrw's "gx" functionality doesn't open URLs anymore in macOS

Describe the bug The latest Vim has updated to a newer version of netrw, which seems to have broken the gx functionality. In the past, positioning the cursor on an URL and press gx would open the URL in a web browser (using the open command). The updated netrw would instead try to curl it, which seems wrong.

To Reproduce Detailed steps to reproduce the behavior:

Run vim --clean (or gvim --clean, etc.) in macOS.
Enter insert mode and type "https://www.vim.org"
Go to normal mode and type gx.
Observe that Vim doesn't open the URL in a web browser.

Expected behavior Vim should open the URL in a web browser.

Screenshots If applicable, copy/paste the text or add screenshots to help explain your problem.

Environment (please complete the following information):

Vim version [e.g. 8.1.1755]
OS: macOS 10.14 (haven't tested others yet)

Additional context Bug was introduced in 85850f3a5ef9f5a9d22e908ef263de8faa265a95. Originally I got this bug filed against MacVim at https://github.com/macvim-dev/macvim/issues/925 so cross-referencing here.

This is a netrw bug so I'm not sure if this is the correct place to post it, but with the ownership question I'm not 100% sure who owns netrw now and where I should file a bug for it to be fixed and updated to Vim's bundled plugin.

plugin-netrw

opened Jul 27, 2019 by ychin 134

Closed

win32: Refactor the NSIS installer

After the discussion in #3485, I have created a new NSIS installer. The appearance is based on @gpwen's work and also uses MUI2, but the rest of the code is based on the original (non-MUI2) NSIS script and this still relies on dosinst.c. So we don't need to maintain duplicated codes. The items I listed at https://github.com/vim/vim/issues/3485#issuecomment-425577841 are all implemented.

And also:

Most of the message boxes were removed like gpwen's.
The command prompt will not be shown. (nsExec::Exec is used instead of ExecWait.)
Uninstallation of the old version will be started after selecting the install location. (same as gpwen's)
The installer now remembers the selections of the user for generating _vimrc. (Key remap and mouse behavior.)
Unicode mode is turned on for future translation. This requires NSIS 3.0. (gpwen's translation uses each encoding for each language. This uses UTF-8 (with BOM) for all languages.)

You can download an installer from here: https://ci.appveyor.com/project/k-takata/vim-win32-installer/build/175/job/jod0d3d3y9fvet3y/artifacts (No need to care about the CI status. It's just failed to push the result to GitHub releases.)

Edited: You can also download it from here: https://github.com/k-takata/vim-win32-installer/releases/tag/v8.1.0443-newinstaller Newer version is also avaliable in my later comment.

platform-windows installer

opened Sep 30, 2018 by k-takata 109

Closed

Proposal: ship with EditorConfig plugin by default

EditorConfig is an editor-independent file format to describe common editor configuration settings for a project, such as tab size, character set, etc.

Many editors and IDEs support EditorConfig files (the web page has a list); for Vim there's the editorconfig-vim plugin.

I think it would be a good idea to ship this with Vim by default. I understand that there are many useful and popular plugins that Vim could ship with by default, but most of those are "personal" plugins that affect only the user's work-flow, whereas this plugin is one which helps Vim users work well with other people (regardless of which editor they use).

Modelines kind of solve the same problem, but are not perfect:

It's specific to Vim.
Needs to be added to every single file (potentially hundreds or thousands of them), which is kind of tedious and makes changing settings or adding new ones hard.
Modelines won't work when creating a new file.

Is this something you're willing to consider? The existing Vim plugin works very well, but if changes need to be made then I can do that.

runtime

opened Nov 4, 2017 by arp242 109

Open

Add overflow_T; used to detect int overflow.

Assumption is sizeof(overflow_T) >= 2 * sizeof(int). This makes overflow_T suitable for detecting int overflow with simple comparisons and makes it easy to find locations with this kind of overflow checking.

@k-takata @chrisbra I'm not sure of the best name or where in the code to put it; please advise. (or if it is even wanted).

A side effect is that it is easier for unsupported and/or older build systems to create vim binaries without changing "C" files.

opened Nov 29, 2023 by errael 0

Open

runtime(cmake): sync runtime files with upstream

null

opened Nov 29, 2023 by e-kwsm 0

Open

a few more safety fixes

Details are in the various commit messages. Those fix various small issues that have been reported to the vim-security list.

opened Nov 29, 2023 by chrisbra 0

Open

runtime(html): Fix syntax test failures

Problem: htmlItalic highlight group dump file differences on macOS are causing test failures. Solution: Remove content from <em> and <i> element examples in the HTML test file.

The included content for these elements was incidental to the primary intent of the test to check element tag highlighting. See #13591.

opened Nov 29, 2023 by dkearns 0

Open

Detect angular & mustache templates

I couldn't find any angular syntax plugin so I set the filetype to html.angular in order to keep the html syntax.

https://angular.io/guide/architecture-components#template-syntax
https://github.com/mustache/mustache#templates

opened Nov 29, 2023 by ObserverOfTime 0

Open

Single quotes break :!start ?

Steps to reproduce

Minimal reproducible example:

Execute :!start 'https://www.google.com'
E371: Command not found

I discovered this because I have disabled netrw and defined a function to open a URL:

function! HandleURL()                                           " Since we disable netrw gx will not work any more. Create a function for it
  let s:uri = matchstr(getline("."), '[a-z]*:\/\/[^ >,;()]*')
  "let s:uri = shellescape(s:uri, 1) 				" Shellslash breaks this. Not sure why! It adds single quotes somehow
    if s:uri != ""
      echom s:uri
      exec "!start " . s:uri
      redraw!
    else
      echo "No URI found in line."
    endif
endfunction

This worked fine until I added set shellslash on my system because I am using bash on windows. Now, it adds single quotes around the URL and breaks this function. Removing the shellescape invocation fixes the issue.

Expected behaviour

Should open the default browser and browse to https://www.google.com.

Version of Vim

8.2.3249

Environment

OS: Windows 10 Shell: Git bash $TERM: xterm

Logs and stack traces

No response

platform-windows bug

opened Nov 26, 2023 by CrispyDrone 9

:herb: Another elegant statusline for vim

Commands for ddu.vim

Operating Kubernetes Cluster from Vim, in Vim

Zsh completion for ddc.vim

Vim plugin for XO

Find your Vim commands faster : An interactive cheat sheet for vim. (Site might be slow to start, please wait )

Markdown preview plugin for Vim

Vim 实操教程（Learning Vim）Vim practical tutorial.

mine sweeping game in vim and neovim

Simple AutoWrite Plugin compatible with most if not all vim distributions (Vim/Neovim)

A package manager for vim (VimApt => Vim's Advanced Package Tools)

Minimum configuration dein.vim setting locally.

Synonyms.vim is a frontend plugin that allows you to show synonyms in a vim split

Using the jedi autocompletion library for VIM.

dadbod.vim: Modern database interface for Vim

Vim editor ported to WebAssembly

:cake: Efficient way of using Vim as a Git mergetool

Vim Bootstrap is generator provides a simple method of generating a .vimrc configuration for vim

🎭 Guise is a Vim/Neovim plugin that opens a new tab page rather than invokes a new nested instance when a user tried to open a new Vim/Neovim through a job or terminal on the instance.

C Compiler written in Vim script

Share this repo

Related Repos

CLI

2.2k

Ly is a lightweight TUI (ncurses-like) display manager for Linux and BSD

Ly - a TUI display manager Ly is a lightweight TUI (ncurses-like) display manager for Linux and BSD. Dependencies a C99 compiler (tested with tcc and

CLI

Broadsheet allows you to check world news anywhere, anytime - from the comfort of your own...

Broadsheet Broadsheet allows you to check world news anywhere, anytime - from the comfort of your own terminal. Table of Contents Broadsheet Table of

CLI

2.4k

Terminal based "The Matrix" like implementation

CMatrix CMatrix is based on the screensaver from The Matrix website. It shows text flying in and out in a terminal like as seen in "The Matrix" movie.

CLI

Generate your license. Yet another lice, but implement with Jinja2 and docopt.

Licen Generate your license. Yet another lice, but implemented with Jinja2 and docopt, should be much more elegant and cleaner. I also get many inspir

CLI

211

Play solitaire in your terminal!

tty-solitaire Ncurses-based klondike solitaire game. Dependencies Terminal emulator with UTF-8 support C library with multibyte locales support Ncurse

CLI

Pi number calculator using 8088 assembly language

PI calculator in 146 bytes (boot sector or COM file) by Oscar Toledo G. Nov/11/2021 http://nanochess.org https://github.com/nanochess This is a simp

CLI

fbsql is a simple command-line client for the Firebird database, inspired by PostgreSQL's ...

fbsql - a command-line client for Firebird fbsql is a simple command-line client for the Firebird database, inspired by PostgreSQL's psql. It is very

CLI

This is a terminal made using C language.

CommandConsole As the name suggests this is a terminal like software. Like a normal terminal in linux or command prompt in windows, it also works like

CLI

Trident provides an easy way to pass the output of one command to any number of targets.

Trident: The multiple-pipe system Trident provides an easy way to pipe the output of one command to not just one but many targets. These targets can b

CLI

104

A C++ high level library for running shell processes

There are many C++ subprocessing libraries out there, but none of them just work. The aim of this library is to allow you to write shell commands in C++ almost as if you were writing them in shell.

CLI

Azure Outlook Command & Control that uses Microsoft Graph API for C2 communications & data...

Azure Outlook Command & Control (C2) - Remotely control a compromised Windows Device from your Outlook mailbox. Threat Emulation Tool for North Korean APT InkySquid / ScarCruft / APT37. TTP: Use Microsoft Graph API for C2 Operations.

CLI

A simple commandline injector using classic DLL injection

CLI

109

Simple command line tool that processes image files using the FidelityFX Super Resolution ...

Simple command line tool that processes image files using the FidelityFX Super Resolution (FSR) or Contrast Adaptive Sharpening (CAS) shader systems.

CLI

sc4cpp is a shellcode framework based on C++

CLI

Command-line flag parsing in C