Neovim help files

This is an HTML version of the Neovim help pages, current as of Neovim 0.8.1. They are kept up-to-date automatically from the Neovim source repository.

Help pages for the original Vim are also available.

Quick links: help overview · quick reference · user manual toc · reference manual toc
help.txt      Nvim

                        VIM - main help file
                                                                         k
      Move around:  Use the cursor keys, or "h" to go left,            h   l
                    "j" to go down, "k" to go up, "l" to go right.       j
Close this window:  Use ":q<Enter>".
   Get out of Vim:  Use ":qa!<Enter>" (careful, all changes are lost!).

Jump to a subject:  Position the cursor on a tag (e.g. bars) and hit CTRL-].
   With the mouse:  Double-click the left mouse button on a tag, e.g. bars.
        Jump back:  Type CTRL-O.  Repeat to go further back.

Get specific help:  It is possible to go directly to whatever you want help
                    on, by giving an argument to the :help command.
                    Prepend something to specify the context:  help-context

                          WHAT                  PREPEND    EXAMPLE      
                      Normal mode command                  :help x
                      Visual mode command         v_       :help v_u
                      Insert mode command         i_       :help i_<Esc>
                      Command-line command        :        :help :quit
                      Command-line editing        c_       :help c_<Del>
                      Vim command argument        -        :help -r
                      Option                      '        :help 'textwidth'
                      Regular expression          /        :help /[
                    See help-summary for more contexts and an explanation.
                    See notation for an explanation of the help syntax.

  Search for help:  Type ":help word", then hit CTRL-D to see matching
                    help entries for "word".
                    Or use ":helpgrep word". :helpgrep

  Getting started:  Do the Vim tutor, a 30-minute interactive course for the
                    basic commands, see vimtutor.
                    Read the user manual from start to end: usr_01.txt

Vim stands for Vi IMproved.  Most of Vim was made by Bram Moolenaar, but only
through the help of many others.  See credits.
------------------------------------------------------------------------------
                                                doc-file-list Q_ct
BASIC:
quickref      Overview of the most common commands you will use
tutor         30-minute interactive course for beginners
copying       About copyrights
iccf          Helping poor children in Uganda
sponsor       Sponsor Vim development, become a registered Vim user
www           Vim on the World Wide Web
bugs          Where to send bug reports

USER MANUAL: These files explain how to accomplish an editing task.

usr_toc.txt   Table Of Contents

Getting Started 
usr_01.txt  About the manuals
usr_02.txt  The first steps in Vim
usr_03.txt  Moving around
usr_04.txt  Making small changes
usr_05.txt  Set your settings
usr_06.txt  Using syntax highlighting
usr_07.txt  Editing more than one file
usr_08.txt  Splitting windows
usr_09.txt  Using the GUI
usr_10.txt  Making big changes
usr_11.txt  Recovering from a crash
usr_12.txt  Clever tricks

Editing Effectively 
usr_20.txt  Typing command-line commands quickly
usr_21.txt  Go away and come back
usr_22.txt  Finding the file to edit
usr_23.txt  Editing other files
usr_24.txt  Inserting quickly
usr_25.txt  Editing formatted text
usr_26.txt  Repeating
usr_27.txt  Search commands and patterns
usr_28.txt  Folding
usr_29.txt  Moving through programs
usr_30.txt  Editing programs
usr_31.txt  Exploiting the GUI
usr_32.txt  The undo tree

Tuning Vim 
usr_40.txt  Make new commands
usr_41.txt  Write a Vim script
usr_42.txt  Add new menus
usr_43.txt  Using filetypes
usr_44.txt  Your own syntax highlighted
usr_45.txt  Select your language


REFERENCE MANUAL: These files explain every detail of Vim.      reference_toc

General subjects 
intro.txt     general introduction to Vim; notation used in help files
nvim.txt      Transitioning from Vim
help.txt      overview and quick reference (this file)
helphelp.txt  about using the help files
index.txt     alphabetical index of all commands
tips.txt      various tips on using Vim
message.txt   (error) messages and explanations
develop.txt   development of Nvim
debug.txt     debugging Vim itself
uganda.txt    Vim distribution conditions and what to do with your money

Basic editing 
starting.txt  starting Vim, Vim command arguments, initialisation
editing.txt   editing and writing files
motion.txt    commands for moving around
scroll.txt    scrolling the text in the window
insert.txt    Insert and Replace mode
change.txt    deleting and replacing text
undo.txt      Undo and Redo
repeat.txt    repeating commands, Vim scripts and debugging
visual.txt    using the Visual mode (selecting a text area)
various.txt   various remaining commands
recover.txt   recovering from a crash

Advanced editing 
cmdline.txt   Command-line editing
options.txt   description of all options
pattern.txt   regexp patterns and search commands
map.txt       key mapping and abbreviations
tagsrch.txt   tags and special searches
windows.txt   commands for using multiple windows and buffers
tabpage.txt   commands for using multiple tab pages
spell.txt     spell checking
diff.txt      working with two to eight versions of the same file
autocmd.txt   automatically executing commands on an event
eval.txt      expression evaluation, conditional commands
builtin.txt   builtin functions
userfunc.txt  defining user functions
fold.txt      hide (fold) ranges of lines
lua.txt       Lua API
api.txt       Nvim API via RPC, Lua and VimL

Special issues 
testing.txt       testing Vim and Vim scripts
print.txt         printing
remote_plugin.txt   Nvim support for remote plugins

Programming language support 
indent.txt       automatic indenting for C and other languages
lsp.txt          Language Server Protocol (LSP)
treesitter.txt   tree-sitter library for incremental parsing of buffers
diagnostic.txt   Diagnostic framework
syntax.txt       syntax highlighting
filetype.txt     settings done specifically for a type of file
quickfix.txt     commands for a quick edit-compile-fix cycle
provider.txt     Built-in remote plugin hosts
ft_ada.txt       Ada (the programming language) support
ft_ps1.txt       Filetype plugin for Windows PowerShell
ft_raku.txt      Filetype plugin for Raku
ft_rust.txt      Filetype plugin for Rust
ft_sql.txt       about the SQL filetype plugin

Language support 
digraph.txt   list of available digraphs
mbyte.txt     multibyte text support
mlang.txt     non-English language support
rileft.txt    right-to-left editing mode
arabic.txt    Arabic language support and editing
hebrew.txt    Hebrew language support and editing
russian.txt   Russian language support and editing

GUI 
gui.txt       Graphical User Interface (GUI)

Interfaces 
if_cscop.txt  using Cscope with Vim
if_perl.txt   Perl interface
if_pyth.txt   Python interface
if_ruby.txt   Ruby interface
sign.txt      debugging signs

Versions 
vim_diff.txt  Main differences between Nvim and Vim
vi_diff.txt   Main differences between Vim and Vi
deprecated.txt  Deprecated items that have been or will be removed

Other 
terminal_emulator.txt Terminal buffers
term.txt              Terminal UI
ui.txt                Nvim UI protocol
channel.txt           Nvim asynchronous IO
dev_style.txt         Nvim style guide
job_control.txt       Spawn and control multiple processes
luaref.txt            Lua reference manual
luvref.txt            Luv (vim.loop) reference manual

                                                standard-plugin-list
Standard plugins 
matchit.txt      Extended % matching
pi_gzip.txt      Reading and writing compressed files
pi_health.txt    Healthcheck framework
pi_msgpack.txt   msgpack utilities
pi_netrw.txt     Reading and writing files over a network
pi_paren.txt     Highlight matching parens
pi_spec.txt      Filetype plugin to work with rpm spec files
pi_tar.txt       Tar file explorer
pi_zip.txt       Zip archive explorer

LOCAL ADDITIONS:                                local-additions

------------------------------------------------------------------------------
bars          Bars example

Now that you've jumped here with CTRL-] or a double mouse click, you can use
CTRL-T, CTRL-O, g<RightMouse>, or <C-RightMouse> to go back to where you were.

Note that tags are within | characters, but when highlighting is enabled these
characters are hidden.  That makes it easier to read a command.

Anyway, you can use CTRL-] on any word, also when it is not within |, and Vim
will try to find help for it.  Especially for options in single quotes, e.g.
'hlsearch'.

------------------------------------------------------------------------------
 vim:tw=78:isk=!-~,^*,^\|,^\":ts=8:noet:ft=help:norl:


Quick links: help overview · quick reference · user manual toc · reference manual toc