man > ex(1)

man perldoc info pydoc3 ri search

📝 NAME

vim — Vi IMproved, a programmer's text editor

🚀 Quick Reference

Use Case	Command	Description
📄 Edit a file	vim file	Open file in Vim.
📥 Read from stdin	vim -	Read file from standard input.
🔍 Start in diff mode	vim -d file1 file2	Show differences between files.
🔒 Read-only mode	vim -R file	Open file read-only.
🖥️ Start in Ex mode	vim -e	Use Ex mode (line editor).
🖼️ GUI version	gvim	Start Vim with graphical interface.
🔄 Recovery mode	vim -r file	Recover file from swap file.
📐 Open N windows	vim -o[N] file1 file2	Open N stacked windows.
📐 Open N tabs	vim -p[N] file1 file2	Open N tab pages.
📖 Get help	vim --help	Show help message and exit.
ℹ️ Version info	vim --version	Print version information.

📋 SYNOPSIS

vim [options] [file ..]
vim [options] -
vim [options] -t tag
vim [options] -q [errorfile]

ex
view
gvim gview evim eview
rvim rview rgvim rgview

📖 DESCRIPTION

Vim is a text editor that is upwards compatible to Vi. It can be used to edit all kinds of plain text. It is especially useful for editing programs.

There are a lot of enhancements above Vi: multi level undo, multi windows and buffers, syntax highlighting, command line editing, filename completion, on-line help, visual selection, etc. See :help vi_diff.txt for a summary of the differences between Vim and Vi.

While running Vim a lot of help can be obtained from the on-line help system, with the :help command. See the ON-LINE HELP section below.

Most often Vim is started to edit a single file with the command

vim file

More generally Vim is started with:

vim [options] [filelist]

If the filelist is missing, the editor will start with an empty buffer. Otherwise exactly one out of the following four may be used to choose one or more files to be edited.

• file .. — A list of filenames. The first one will be the current file and read into the buffer. The cursor will be positioned on the first line of the buffer. You can get to the other files with the :next command. To edit a file that starts with a dash, precede the filelist with --.
• - — The file to edit is read from stdin. Commands are read from stderr, which should be a tty.
• -t {tag} — The file to edit and the initial cursor position depends on a "tag", a sort of goto label. {tag} is looked up in the tags file, the associated file becomes the current file and the associated command is executed. Mostly this is used for C programs, in which case {tag} could be a function name. The effect is that the file containing that function becomes the current file and the cursor is positioned on the start of the function. See :help tag-commands.
• -q [errorfile] — Start in quickFix mode. The file [errorfile] is read and the first error is displayed. If [errorfile] is omitted, the filename is obtained from the errorfile option (defaults to "AztecC.Err" for the Amiga, "errors.err" on other systems). Further errors can be jumped to with the :cn command. See :help quickfix.

Vim behaves differently, depending on the name of the command (the executable may still be the same file).

• vim — The "normal" way, everything is default.
• ex — Start in Ex mode. Go to Normal mode with the :vi command. Can also be done with the -e argument.
• view — Start in read-only mode. You will be protected from writing the files. Can also be done with the -R argument.
• gvim gview — The GUI version. Starts a new window. Can also be done with the -g argument.
• evim eview — The GUI version in easy mode. Starts a new window. Can also be done with the -y argument.
• rvim rview rgvim rgview — Like the above, but with restrictions. It will not be possible to start shell commands, or suspend Vim. Can also be done with the -Z argument.

⚙️ OPTIONS

The options may be given in any order, before or after filenames. Options without an argument can be combined after a single dash.

• +[num] — For the first file the cursor will be positioned on line "num". 📏 If "num" is missing, the cursor will be positioned on the last line.
• +/{pat} — For the first file the cursor will be positioned in the line with the first occurrence of {pat}. 🔍 See :help search-pattern for the available search patterns.
• +{command} — (also -c {command}) {command} will be executed after the first file has been read. {command} is interpreted as an Ex command. If the {command} contains spaces it must be enclosed in double quotes. Example: vim "+set si" main.c. Note: You can use up to 10 "+" or "-c" commands.
• -S {file} — {file} will be sourced after the first file has been read. 📂 This is equivalent to -c "source {file}". {file} cannot start with '-'. If {file} is omitted "Session.vim" is used (only works when -S is the last argument).
• --cmd {command} — Like using "-c", but the command is executed just before processing any vimrc file. You can use up to 10 of these commands, independently from "-c" commands.
• -A — If Vim has been compiled with ARABIC support, starts in Arabic mode. 🇦🇪 Otherwise an error message is given and Vim aborts.
• -b — Binary mode. Sets options to edit a binary or executable file. 💾
• -C — Compatible. Sets the 'compatible' option, making Vim behave mostly like Vi.
• -d — Start in diff mode. 🔍 There should be two to eight file name arguments. Works like vimdiff(1).
• -d {device} — Open {device} for use as a terminal. Only on the Amiga.
• -D — Debugging. 🐛 Go to debugging mode when executing the first command from a script.
• -e — Start Vim in Ex mode, like the executable was called "ex".
• -E — Start Vim in improved Ex mode, like the executable was called "exim".
• -f — Foreground. For the GUI version, Vim will not fork and detach from the shell. 🖥️
• --nofork — Foreground, same as -f for GUI.
• -F — Farsi mode. 🇮🇷 If compiled with FKMAP support, starts in Farsi mode.
• -g — GUI mode. 🖼️ If compiled with GUI support, enables the GUI.
• -h — Give a bit of help about command line arguments and options, then exit. ❓
• -H — Hebrew mode. 🇮🇱 If compiled with RIGHTLEFT support, starts in Hebrew mode.
• -i {viminfo} — Specifies the viminfo file to use instead of default "~/.viminfo". Use "NONE" to skip.
• -L — Same as -r.
• -l — Lisp mode. Sets 'lisp' and 'showmatch' options on.
• -m — Modifying files is disabled. Resets the 'write' option. You can still modify the buffer, but writing a file is not possible.
• -M — Modifications not allowed. Unsets 'modifiable' and 'write' options.
• -N — No-compatible mode. Resets the 'compatible' option.
• -n — No swap file will be used. 💿 Recovery after a crash will be impossible.
• -nb — Become an editor server for NetBeans.
• -o[N] — Open N windows stacked. 📐 When N is omitted, open one window for each file.
• -O[N] — Open N windows side by side. 📐
• -p[N] — Open N tab pages. 📑
• -R — Read-only mode. 🔒 Sets the 'readonly' option. You can still edit the buffer, but will be prevented from accidentally overwriting a file.
• -r — List swap files, with information about using them for recovery. 🔄
• -r {file} — Recovery mode. Use the swap file to recover a crashed editing session.
• -s — Silent mode. Only when started as "Ex" or when the "-e" option was given before the "-s" option.
• -s {scriptin} — The script file {scriptin} is read. 📜 Characters are interpreted as if typed.
• -T {terminal} — Tell Vim the name of the terminal you are using.
• -u {vimrc} — Use the commands in the file {vimrc} for initializations. Use "NONE" to skip all initializations.
• -U {gvimrc} — Use the commands in the file {gvimrc} for GUI initializations.
• -V[N] — Verbose. Give messages about which files are sourced. Optional number N is the value for 'verbose' (default 10).
• -v — Start Vim in Vi mode, only effective when the executable is called "ex".
• -w {scriptout} — Record all typed characters into the file {scriptout}. 📝 Useful for creating scripts.
• -W {scriptout} — Like -w, but overwrites an existing file.
• -x — Use encryption when writing files. 🔐 Will prompt for a crypt key.
• -X — Don't connect to the X server. Shortens startup time, but window title and clipboard will not be used.
• -y — Start Vim in easy mode, like the executable was called "evim" or "eview". Makes Vim behave like a click-and-type editor.
• -Z — Restricted mode. Works like the executable starts with "r".
• -- — Denotes the end of the options. Arguments after this will be handled as a file name. Useful for editing a filename that starts with a '-'.
• --clean — Do not use any personal configuration (vimrc, plugins, etc.). Useful for testing.
• --echo-wid — GTK GUI only: Echo the Window ID on stdout.
• --help — Give a help message and exit, same as "-h".
• --literal — Take file name arguments literally, do not expand wildcards. No effect on Unix.
• --noplugin — Skip loading plugins. Implied by -u NONE.
• --remote — Connect to a Vim server and make it edit the files given in the rest of the arguments. 🌐 If no server is found, a warning is given and files are edited in the current Vim.
• --remote-expr {expr} — Connect to a Vim server, evaluate {expr} in it and print the result on stdout.
• --remote-send {keys} — Connect to a Vim server and send {keys} to it.
• --remote-silent — As --remote, but without the warning when no server is found.
• --remote-wait — As --remote, but Vim does not exit until the files have been edited.
• --remote-wait-silent — As --remote-wait, but without warning.
• --serverlist — List the names of all Vim servers that can be found. 📋
• --servername {name} — Use {name} as the server name. Used for the current Vim or with --remote.
• --socketid {id} — GTK GUI only: Use the GtkPlug mechanism to run gvim in another window.
• --startuptime {file} — During startup write timing messages to the file {fname}. ⏱️
• --version — Print version information and exit. ℹ️

📚 ON-LINE HELP

Type :help in Vim to get started. Type :help subject to get help on a specific subject. For example: :help ZZ to get help for the "ZZ" command. Use <Tab> and CTRL-D to complete subjects (:help cmdline-completion). Tags are present to jump from one place to another (sort of hypertext links, see :help). All documentation files can be viewed in this way, for example :help syntax.txt.

📁 FILES

• /usr/share/vim/vim82/doc/*.txt — The Vim documentation files. Use :help doc-file-list to get the complete list.
• /usr/share/vim/vim82/doc/tags — The tags file used for finding information in the documentation files.
• /usr/share/vim/vim82/syntax/syntax.vim — System wide syntax initializations.
• /usr/share/vim/vim82/syntax/*.vim — Syntax files for various languages.
• /usr/share/vim/vimrc — System wide Vim initializations.
• ~/.vimrc — Your personal Vim initializations.
• /usr/share/vim/gvimrc — System wide gvim initializations.
• ~/.gvimrc — Your personal gvim initializations.
• /usr/share/vim/vim82/optwin.vim — Script used for the :options command, a nice way to view and set options.
• /usr/share/vim/vim82/menu.vim — System wide menu initializations for gvim.
• /usr/share/vim/vim82/bugreport.vim — Script to generate a bug report. See :help bugs.
• /usr/share/vim/vim82/filetype.vim — Script to detect the type of a file by its name. See :help 'filetype'.
• /usr/share/vim/vim82/scripts.vim — Script to detect the type of a file by its contents. See :help 'filetype'.
• /usr/share/vim/vim82/print/*.ps — Files used for PostScript printing.

For recent info read the VIM home page:
<http://www.vim.org/>

🔗 SEE ALSO

vimtutor(1)

✍️ AUTHOR

Most of Vim was made by Bram Moolenaar, with a lot of help from others. See :help credits in Vim.
Vim is based on Stevie, worked on by: Tim Thompson, Tony Andrews and G.R. (Fred) Walter. Although hardly any of the original code remains.

🐛 BUGS

Probably. See :help todo for a list of known problems.

Note that a number of things that may be regarded as bugs by some, are in fact caused by a too-faithful reproduction of Vi's behaviour. And if you think other things are bugs "because Vi does it differently", you should take a closer look at the vi_diff.txt file (or type :help vi_diff.txt when in Vim). Also have a look at the 'compatible' and 'cpoptions' options.

2006 Apr 11 — VIM(1)

📝 NAME 🚀 Quick Reference 📋 SYNOPSIS 📖 DESCRIPTION ⚙️ OPTIONS 📚 ON-LINE HELP 📁 FILES 🔗 SEE ALSO ✍️ AUTHOR 🐛 BUGS