Introduction

Back in 2007, I had a rough beginning as a design engineer at a semiconductor company in terms of using software tools. Linux command line, Vim and Perl were all new to me. I distinctly remember progressing from dd (delete current line) to d↓ (delete current line as well as the line below) and feeling happy that it reduced time spent on editing. Since I was learning on the job, I didn't know about count prefix or the various ways I could've deleted all the lines from the beginning of the file to the line containing a specific phrase. Or even better, I could've automated editing multiple files if I had been familiar with sed or progressed that far with Perl.

I also remember that we got a two-sided printed cheatsheet that we kept pinned to our cabins. That was one of the ways I kept adding commands to my repertoire. But, I didn't have a good insight to Vim's philosophy and I didn't know how to apply many of the cheatsheet commands. At some point, I decided to read the Vim book by Steve Oualline and that helped a lot, but it was also too long and comprehensive for me to read it all. My memory is hazy after that, and I don't recall what other resources I used. However, I'm sure I didn't effectively utilize built-in help. Nor did I know about stackoverflow or /r/vim until after I left my job in 2014.

Still, I knew enough to conduct a few Vim learning sessions for my colleagues. That came in handy when I got chances to teach Vim as part of a scripting course for college students. From 2016 to 2018, I started maintaining my tutorials on Linux command line, Vim and scripting languages as GitHub repos. As you might guess, I then started polishing these materials and published them as ebooks. This is an ongoing process, with Vim Reference Guide being the twelfth ebook.

Why Vim?

You've probably already heard that Vim is a text editor, powerful one at that. Vim's editing features feel like a programming language and you can customize the editor using scripting languages. Apart from a plethora of editing commands and support for regular expressions, you can also incorporate external commands. To sum it up, most editing tasks can be managed from within Vim itself instead of having to write a script.

Now, you might wonder, what is this need for complicated editing features? Why does a text editor require programming capabilities? Why is there even a requirement to learn how to use a text editor? Isn't it enough to have the ability to enter text, use keys like Backspace/Delete/Home/End/Arrow/etc, menubar, toolbar, some shortcuts, a search and replace feature and so on? A simple and short answer — to reduce repetitive manual task.

What I like the most about Vim:

• Lightweight and fast
• Modal editing helps me to think logically based on the type of editing task
• Composing commands and the ability to record them for future use
• Settings customization and creating new commands
• Integration with shell commands

There's a huge ecosystem of plugins, packages and colorschemes as well, but I haven't used them much. I've used Vim for a long time, but not really a power user. I prefer using GVim, tab pages, mouse, arrow keys, etc. So, if you come across tutorials and books suggesting you should avoid using them, remember that they are only subjective preferences.

Here are some more opinions by those who enjoy using Vim:

• stackoverflow: What are the benefits of learning Vim?
• Why Vim
• Vim Creep

Should everybody use Vim? Is it suitable for all kinds of editing tasks? I'd say no. There are plenty of other well established text editors and new ones are coming up all the time. The learning curve isn't worth it for everybody. If Vim wasn't being used at job, I probably wouldn't have bothered with it. Don't use Vim for the wrong reasons article discusses this topic in more detail.

Installation

I use the following command on Ubuntu (a Linux distribution):

sudo apt install vim vim-gui-common

• :h usr_90.txt — user manual for installation on different platforms, common issues, upgrading, uninstallation, etc
• vi.stackexchange: How can I get a newer version of Vim? — building from source, using distribution packages, etc

See https://github.com/vim/vim for source code and other details.

Ice Breaker

Open a terminal and follow these steps:

• gvim ip.txt opens a file named ip.txt for editing
  • You can also use vim if you prefer terminal instead of GUI, or if gvim is not available
• Press i key (yes, the lowercase alphabet i, not some alien key)
• Start typing, for example What a weird editor
• Press Esc key
• Press : key
• Type wq
• Press Enter key
• cat ip.txt — sanity check to see what you typed was saved or not

Phew, what a complicated procedure to write a simple line of text, isn't it? This is the most challenging and confusing part for a Vim newbie. Here's a brief explanation for the above steps:

• Vim is a modal editor. You have to be aware which mode you are in and use commands or type text accordingly
• When you first launch Vim, it starts in Normal mode (primarily used for editing and moving around)
• Pressing i key is one of the ways to enter Insert mode (where you type the text you want to save in a file)
• After you've entered the text, you need to save the file. To do so, you have to go back to Normal mode first by pressing the Esc key
• Then, you have to go to yet another mode! Pressing : key brings up the Command-line mode and awaits further instruction
• wq is a combination of write and quit commands
  • use wq ip.txt if you forgot to specify the filename while launching Vim, or perhaps if you opened Vim from the Start menu instead of a terminal
• Enter key completes the command you've typed

If you launched GVim, you'll likely have Menu and Tool bars, which would've helped with operations like saving, quitting, etc. Nothing wrong with using them, but this book will not discuss those operations. In fact, you'll learn how to configure Vim to hide them in the Customizing Vim chapter.

Don't proceed any further if you aren't comfortable with the above steps. Take help of youtube videos if you must. Master this basic procedure and you will be ready for Vim awesomeness that'll be discussed in the coming sections and chapters.

Material presented here is based on GVim (GUI), which has a few subtle differences compared to Vim (TUI). See this stackoverflow thread for more details.

Options and details related to opening Vim from the command line will be discussed in the CLI options chapter.

Built-in tutor

• gvimtutor command that opens a tutorial session with lessons to get started with Vim
  • don't worry if something goes wrong as you'll be working with a temporary file
  • use vimtutor if gvim is not available
  • pro-tip: go through this short tutorial multiple times, spread over multiple days and make copious notes for future reference

Next step is :h usr_02.txt, which provides enough information about editing files with Vim.

See also vimtutor-sequel, which provides advanced lessons.

Built-in help

Vim comes with comprehensive user and reference manuals. The user manual reads like a text book and reference manual has more details than you are likely to need. There's also an online site with these help contents, which will be linked as appropriate throughout this book.

• You can access built-in help in several ways:
  • type :help from Normal mode (or just the :h short form)
  • GVim has a Help menu
  • press F1 key from Normal mode
• :h usr_toc.txt table of contents for User Manual
  • Task oriented explanations, from simple to complex. Reads from start to end like a book
• :h reference_toc table of contents for Reference Manual
  • Precise description of how everything in Vim works
• :h quickref quick reference guide
• :h help-summary effectively using help depending on the topic/feature you are interested in
  • See also vi.stackexchange: guideline to use help
• :h version9.txt what's new in Vim 9
  • See also VimLog, a ChangeLog for Vim

Here's a neat table from :h help-context:

You can go through a copy of the documentation online at https://vimhelp.org/. As shown above, all the :h hints in this book will also be linked to the appropriate online help section.

Vim learning resources

As mentioned in the Preface chapter, this Vim Reference Guide is more like a cheatsheet instead of a typical book for learning Vim. In addition to built-in features already mentioned in the previous sections, here are some resources you can use:

Tutorials

• Vim primer — learn Vim in a way that will stay with you for life
• Vim galore — everything you need to know about Vim
• Learn Vim progressively — short introduction that covers a lot
• Vim from the ground up — article series for beginners to expert users

Books

• Practical Vim
• Mastering Vim Quickly
• Learn Vim (the Smart Way)

Interactive

• OpenVim — interactive tutorial
• Vim Adventures — learn Vim by playing a game
• Learn vim and learn it fast — interactive lessons designed to help you get better at Vim faster

See my Vim curated list for a more complete list of learning resources, cheatsheets, tips, tricks, forums, etc.

Modes of Operation

As mentioned earlier, Vim is a modal editor. This book will mainly discuss these four modes:

• Insert mode
• Normal mode
• Visual mode
• Command-line mode

This section provides a brief description for these modes. Separate chapters will discuss their features in more detail.

For a complete list of modes, see :h vim-modes-intro and :h mode-switching. See also this comprehensive illustration of navigating modes.

Insert mode

This is the mode where the required text is typed. There are also commands available for moving around, deleting, autocompletion, etc.

Pressing the Esc key takes you back to the Normal mode.

Normal mode

This is the default mode when Vim is opened. This mode is used to run commands for operations like cut, copy, paste, recording, moving around, etc. This is also known as the Command mode.

Visual mode

Visual mode is used to edit text by selecting them first. Selection can either be done using mouse or visual commands.

Pressing the Esc key takes you back to the Normal mode.

Command-line mode

This mode is used to perform file operations like save, quit, search, replace, execute shell commands, etc. An operation is completed by pressing the Enter key after which the mode changes back to the Normal mode. The Esc key can be used to ignore whatever is typed and return to the Normal mode.

The space at the bottom of the screen used for this mode is referred to as Command-line area. It is usually a single line, but can expand for cases like auto completion, shell commands, etc.

Identifying the current mode

• In Insert mode, you get a blinking | cursor
  • also, -- INSERT -- can be seen on the left hand side of the Command-line area
• In Normal mode, you get a blinking rectangular block cursor, something like this █
• In Visual mode, the Command-line area shows -- VISUAL -- or -- VISUAL LINE -- or -- VISUAL BLOCK -- according to the visual command used
• In Command-line mode, the cursor is of course in the Command-line area

See also :h 'showmode' setting.

Vim philosophy and features

Commands discussed in this section will be covered again in later chapters. The idea here is to give you a brief introduction to modes and notable Vim features. See also:

• Best introduction to Vi and its core editing concepts explained as a language (this stackoverflow thread also has numerous Vim tips and tricks)
• Seven habits of effective text editing

As a programmer, I love how composable Vim commands are. For example, you can do this in Normal mode:

• dG delete from the current line to the end of the file
  • where d is the delete command awaiting further instruction
  • and G is a motion command to move to the last line of the file
• yG copy from the current line to the end of the file
  • where y is the yank (copy) command awaiting further instruction

Most Normal mode commands accept a count prefix. For example:

• 3p paste the copied content three times
• 5x delete the character under the cursor and 4 characters to its right (total 5 characters)
• 3 followed by Ctrl+a add 3 to the number under the cursor

There are context aware operations too. For example:

• diw delete a word regardless of where the cursor is on that word
• ya} copy all characters within {} including the {} characters

If you are a fan of selecting text before editing them, you can use the Visual mode. There are several commands you can use to start Visual mode. If enabled, you can even use mouse to select the required portions.

• ~ invert the case of the visually selected text (i.e. lowercase becomes UPPERCASE and vice versa)
• g followed by Ctrl+a for visually selected lines, increment numbers by 1 for the first line, by 2 for the second line, by 3 for the third line and so on

The Command-line mode is useful for file level operations, search and replace, changing Vim configurations, talking to external commands and so on.

• /searchpattern search the given pattern in the forward direction
• :g/call/d delete all lines containing call
• :g/cat/ s/animal/mammal/g replace animal with mammal only for the lines containing cat
• :3,8! sort sort only lines 3 to 8 (uses an external command sort)
• :set incsearch highlights the current match as you type the search pattern

Changes to Vim configurations from the Command-line mode are applicable only for that particular session. You can use the vimrc file to load the settings at startup.

• colorscheme murphy a dark theme
• set tabstop=4 width for the tab character (default is 8)
• nnoremap <F5> :%y+<CR> map F5 key to copy everything to the system clipboard in Normal mode
• inoreabbrev teh the automatically correct teh to the in Insert mode

There are many more Vim features that'd help you with text processing and customizing the editor to your needs, some of which you'll get to know in the coming chapters.

Finally, you can apply your Vim skills elsewhere too. Vim-like features have been adopted across a huge variety of applications and plugins, for example:

• less command supports vim-like navigation
• Extensible vi layer for Emacs
• Vimium (browser extension), qutebrowser (keyboard-driven browser with vim-like navigation), etc
• JetBrains IdeaVim, VSCodeVim, etc
• Huge list of Vim-like applications and plugins

Vim's history

See Where Vim Came From if you are interested in knowing Vim's history that traces back to the 1960s with qed, ed, etc.

Chapters

Here's a list of remaining chapters:

• Insert mode
• Normal mode
• Command-line mode
• Visual mode
• Regular Expressions
• Macro
• Customizing Vim
• CLI options