Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Shell VimL Python Makefile Perl Awk
Latest commit f417c2f @rkitover use sed instd of tr to remove spaces in fname #129
Because many versions of tr do not support POSIX character classes such
as [:space:], rewrite the tr command in #129 as a portable sed command.

% VIMPAGER(1) vimpager user manual % Rafael Kitover % August 4, 2015


vimpager - pager using vim and less.vim


vimpager [options] 'some file'

# or (this won't always syntax highlight as well)

cat 'some file' | vimpager [options]

For vimcat see here or 'man vimcat'.


  • vim


  • sharutils or some uuencode (only if you change the src/*.vim sources)
  • pandoc (for man pages and html, optional)


On Ubuntu or Debian, use the following to install a package:

git clone git://
cd vimpager
sudo make install-deb

Otherwise use 'make install' instead:

git clone git://
cd vimpager
sudo make install

If you got vimpager from the scripts section, just put it somewhere in your PATH, e.g.:

cp vimpager ~/bin
chmod +x ~/bin/vimpager

In your ~/.bashrc add the following:

export PAGER=/usr/local/bin/vimpager
alias less=$PAGER
alias zless=$PAGER


A PAGER using less.vim with support for highlighting of man pages and many other features. Works on most UNIX-like systems as well as Cygwin and MSYS.

On GitHub:

To use a different vimrc with vimpager, put your settings into a ~/.vimpagerrc or ~/.vim/vimpagerrc or a file pointed to by the VIMPAGER_RC environment variable.

You can also have a global config file for all users in /etc/vimpagerrc, users can override it by creating a ~/.vimpagerrc or a ~/.vim/vimpagerrc.

These are the keys for paging while in vimpager, they are the same as in less for the most part:

Key Action Key Action
Space One page forward b One page backward
d Half a page forward u Half a page backward
Enter One line forward k One line backward
G End of file g Start of file
N% percentage in file ,h Display this help
/pattern Search forward ?pattern Search backward
n next match N Previous match
ESC-u toggle search highlight
q Quit ,v Toggle Less Mode

To disable loading plugins, put "set noloadplugins" into a vimpagerrc file.

You can also switch on the "vimpager" variable in your vimrc to set alternate settings for vimpager.

If you want to disable less compatibility mode, and use regular vim motion commands, put this into your .vimrc/vimpagerrc:

let g:vimpager_less_mode = 0

You can still enable less mode with this setting by pressing ",v".

At runtime whenever less mode is toggled with ,v , this variable will reflect the current state, regardless of the initial value.

Put the following into your .vimrc/vimpagerrc if you want to use gvim/MacVim for your pager window:

let g:vimpager_use_gvim = 1

To turn off the feature of passing through text that is smaller than the terminal height use this:

let g:vimpager_passthrough = 0

See "PASSTHROUGH MODE" further down.

To start vim with -X (no x11 connection, a bit faster startup) put the following into your .vimrc/vimpagerrc:

let g:vimpager_disable_x11 = 1

The scroll offset (:help scrolloff), may be specified by placing the following into your .vimrc/vimpagerrc (default = 5, disable = 0):

let g:vimpager_scrolloff = 5

The default is 5 only in less mode, with less mode disabled the default is the user's scrolloff setting.

The process tree of vimpager is available in the "vimpager_ptree" variable, an example usage is as follows:

if exists("vimpager")
  if exists("vimpager_ptree") && vimpager_ptree[-2] == 'wman'
    set ft=man

To disable the use of AnsiEsc.vim to display ANSI colors in the source, set:

let g:vimpager_disable_ansiesc = 1

see the section "ANSI ESCAPE SEQUENCES AND OVERSTRIKES" for more details.


+ | +G

Start at the end of the file, just like less.

-c cmd

Run a vim command after opening the file. Multiple -c arguments are supported.

--cmd cmd

Run a vim command when entering vim before anything else. Multiple --cmd arguments are supported.

-u vimrc

Use alternate .vimrc or .vimpagerrc.


Squeeze blank lines into a single blank line. GNU man passes this option to /usr/bin/pager.


If your source is using ANSI escape codes, the AnsiEsc plugin will be used to show them, rather than the normal vim highlighting, however read the caveats below. If this is not possible, they will be stripped out and normal vim highlighting will be used instead.

Overstrikes such as in man pages will always be removed.

vimpager bundles the AnsiEsc plugin (it is expanded at runtime, there is nothing you have to do to enable it.)

However, your vim must have been compiled with the 'conceal' feature enabled. To check, try

:echo has("conceal")

if the result is '1' you have conceal, if it's '0' you do not, and the AnsiEsc plugin will not be enabled.

If you're on a Mac, the system vim does not enable this feature, install vim from Homebrew.

To disable the use of AnsiEsc.vim, set:

let g:vimpager_disable_ansiesc = 1

in your .vimrc.

If the file has a modeline that sets ft or syntax, the setting will override the use of AnsiEsc.

To turn off AnsiEsc while viewing a file, simply run


To turn off AnsiEsc on the commandline, use an invocation such as the following:

vimpager -c 'au VimEnter * exe "setlocal syntax=".&syntax' somefile


If the text sent to the pager is smaller than the terminal window, then it will be displayed without vim as text. If it has ansi codes, they will be preserved, otherwise the text will be highlighted with vimcat.

You can turn this off by putting

let g:vimpager_passthrough = 0

Passthrough mode requires a POSIX shell with arithmetic expansion, if there is one on your system and it is not detected please submit an issue with the path and your OS version.


vimpager works correctly with the native Windows gvim, just put it in your PATH and set the vimpager_use_gvim option as described above.

Something went wrong with that request. Please try again.