Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 88 lines (58 sloc) 2.602 kB
41bd44e @joonty Updated README
joonty authored
1 # Vdebug
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
2
41bd44e @joonty Updated README
joonty authored
3 Vdebug is a new, fast, powerful debugger client for Vim. It's multi-language,
9d7e8b7 @joonty More README tweaks
joonty authored
4 and has been tested with PHP, Python, Ruby and Perl. It interfaces with **any**
5 debugger that faithfully uses the DBGP protocol, such as Xdebug for PHP.
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
6
41bd44e @joonty Updated README
joonty authored
7 It builds on the experience gained through the legacy of the Xdebug Vim script
8 originally created by Seung Woo Shin and extended by so many others, but it's a
9 total rebuild to allow for a nicer interface and support of new features.
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
10
41bd44e @joonty Updated README
joonty authored
11 It's written in Python, and has an object-oriented interface that is easy to extend
12 and can even be used from the command-line.
d176830 Updated README
Jon Cairns authored
13
41bd44e @joonty Updated README
joonty authored
14 # How to use
d176830 Updated README
Jon Cairns authored
15
41bd44e @joonty Updated README
joonty authored
16 There is *extensive* help provided in the form of a Vim help file. This goes
17 through absolutely everything, from installation to configuration, setting up
18 debuggers for various languages, explanation of the interface, options, remote
19 server debugging and more.
20
21 To get this help, type:
22
23 ```
24 :help Vdebug
25 ```
26
27 after installing the plugin.
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
28
29 # Installation
30
31 **Requirements**:
32
41bd44e @joonty Updated README
joonty authored
33 * Vim compiled with Python 2 support, tabs and signs
34 * A programming language that has a DBGP debugger, e.g. PHP, Python, Ruby,
35 Perl, Tcl...
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
36
37 ## Classic
38
39 Clone or download a tarball of the plugin and move its content in your
40 `~/.vim/` directory.
41
41bd44e @joonty Updated README
joonty authored
42 Your `~/.vim/plugins/` directory should now contain vdebug.vim and a directory
43 called "python".
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
44
45 ## Using git and Pathogen
46
41bd44e @joonty Updated README
joonty authored
47 Clone this repository in your `~/.vim/bundle` directory
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
48
d176830 Updated README
Jon Cairns authored
49 ## Using vundle
50
51 Add this to your `~/.vimrc` file:
52
53 ```vim
41bd44e @joonty Updated README
joonty authored
54 Bundle 'joonty/vdebug.git'
d176830 Updated README
Jon Cairns authored
55 ```
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
56
df69c6f Updated README and set debug mode to 0
Jon Cairns authored
57 Then, from the command line, run:
58
59 ```bash
60 vim +BundleInstall +qall
61 ```
62
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
63 # Quick guide
64
0ffe68c @joonty Even more README tweaks
joonty authored
65 Set up any DBGP protocol debugger, e.g. Xdebug. (See :help VdebugSetUp). Start Vdebug with `<F5>`, which will make it wait for an incoming connection. Run the script you want to debug, with the debugging engine enabled. A new tab will open with the debugging interface.
66
67 Once in debugging mode, the following default mappings are available:
9d7e8b7 @joonty More README tweaks
joonty authored
68
69 * `<F1>`: run to cursor
70 * `<F2>`: step over
71 * `<F3>`: step into
72 * `<F4>`: step out
73 * `<F5>`: run (to next breakpoint/end of script)
74 * `<F6>`: stop debugging
75 * `<F10>`: set line breakpoint
76 * `:Breakpoint <type> <args>`: set a breakpoint of any type (see :help
77 VdebugBreakpoints)
78 * `:DebuggerEval <code>`: evaluate some code and display the result
79 * `<Leader>e`: evaluate the expression under visual highlight and display the result
0ffe68c @joonty Even more README tweaks
joonty authored
80
81 To stop debugging, press `<F6>`. Press it again to close the debugger interface.
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
82
83 # Licence
84
41bd44e @joonty Updated README
joonty authored
85 This plugin is released under the [MIT License][6].
86
87 [1]: https://raw.github.com/joonty/vdebug/master/LICENSE
Something went wrong with that request. Please try again.