Daniel Malea ac4ce0cd4a Add Vim frontend to LLDB.
- Access any LLDB CLI command in Vim by typing ":L<command>". Tab-completion
  works too!
- See source locations for breakpoints and the current PC with vim "marks"
  and highlights.
- Examine backtraces, locals, disassembly, registers, and breakpoints in
  dedicated Vim windows.
- See when in-scope variables and registers change by watching for (red)
  highlights.

This plugin opens multiple Vim "windows" to display debugger information.
To quit all windows at the same time use ":qa". The alternative would be
":q" to close each window separately.

This plugin is known to work on Mac OS X (Mountain Lion) with MacVim and
the system-provided terminal Vim, and on Linux (Ubuntu 12.04 and 12.10)
with GVim and the terminal Vim from the "vim-gnome" package.

llvm-svn: 174892
2013-02-11 17:18:14 +00:00

60 lines
1.5 KiB
Plaintext

=================
LLDB Vim Frontend
=================
Prerequisites
-------------
This plugin is known to work with the following flavours of Vim:
* Linux (tested on Ubuntu 12.04/12.10):
* vim/gvim (from vim-gnome package version 7.3)
* Mac OS X (tested on Mountain Lion)
* Vim command-line (7.3 from Xcode)
* MacVim 7.3
To install the plugin, ensure you have
* a working version of lldb on your path, or the environment variable LLDB
pointing to the lldb binary you would like to use.
* a python-enabled vim (check with ":python print 2")
Installation
------------
1) Install the Vim pathogen plugin (it keeps installed plugins organized):
https://github.com/tpope/vim-pathogen
Or, for the impatient:
mkdir -p ~/.vim/autoload ~/.vim/bundle; \
curl -Sso ~/.vim/autoload/pathogen.vim \
https://raw.github.com/tpope/vim-pathogen/master/autoload/pathogen.vim
2) Symlink (or copy) ~/.vim/bundle/vim-lldb to this directory:
ln -sf <lldb-dir>/utils/vim-lldb ~/.vim/bundle/vim-lldb
3) Update your help-tags. Start vim, do:
:Helptags
4) Have fun!
Usage/Getting Help
------------------
All LLDB commands (with tab-completion) can be accessed in Vim's
command mode. Try it out by typing:
:L<tab>
There are several sources of help available:
:help lldb -- Documentation for this plugin
:Lhelp -- LLDB's built-in help system (i.e lldb 'help' command)
:Lscript help (lldb) -- Complete LLDB Python API reference