Skip to content
Newer
Older
100644 89 lines (59 sloc) 2.62 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
f63bfbb @joonty Mentioned tests in README
joonty authored
12 and can even be used from the command-line. It even has unit tests covering
13 some of the more critical parts of the code.
d176830 Updated README
Jon Cairns authored
14
41bd44e @joonty Updated README
joonty authored
15 # How to use
d176830 Updated README
Jon Cairns authored
16
41bd44e @joonty Updated README
joonty authored
17 There is *extensive* help provided in the form of a Vim help file. This goes
18 through absolutely everything, from installation to configuration, setting up
19 debuggers for various languages, explanation of the interface, options, remote
20 server debugging and more.
21
22 To get this help, type:
23
24 ```
25 :help Vdebug
26 ```
27
28 after installing the plugin.
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
29
30 # Installation
31
32 **Requirements**:
33
41bd44e @joonty Updated README
joonty authored
34 * Vim compiled with Python 2 support, tabs and signs
35 * A programming language that has a DBGP debugger, e.g. PHP, Python, Ruby,
36 Perl, Tcl...
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
37
38 ## Classic
39
40 Clone or download a tarball of the plugin and move its content in your
41 `~/.vim/` directory.
42
41bd44e @joonty Updated README
joonty authored
43 Your `~/.vim/plugins/` directory should now contain vdebug.vim and a directory
44 called "python".
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
45
46 ## Using git and Pathogen
47
41bd44e @joonty Updated README
joonty authored
48 Clone this repository in your `~/.vim/bundle` directory
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
49
d176830 Updated README
Jon Cairns authored
50 ## Using vundle
51
52 Add this to your `~/.vimrc` file:
53
54 ```vim
41bd44e @joonty Updated README
joonty authored
55 Bundle 'joonty/vdebug.git'
d176830 Updated README
Jon Cairns authored
56 ```
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
57
df69c6f Updated README and set debug mode to 0
Jon Cairns authored
58 Then, from the command line, run:
59
60 ```bash
61 vim +BundleInstall +qall
62 ```
63
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
64 # Quick guide
65
0ffe68c @joonty Even more README tweaks
joonty authored
66 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.
67
68 Once in debugging mode, the following default mappings are available:
9d7e8b7 @joonty More README tweaks
joonty authored
69
70 * `<F1>`: run to cursor
71 * `<F2>`: step over
72 * `<F3>`: step into
73 * `<F4>`: step out
74 * `<F5>`: run (to next breakpoint/end of script)
75 * `<F6>`: stop debugging
76 * `<F10>`: set line breakpoint
77 * `:Breakpoint <type> <args>`: set a breakpoint of any type (see :help
78 VdebugBreakpoints)
79 * `:DebuggerEval <code>`: evaluate some code and display the result
80 * `<Leader>e`: evaluate the expression under visual highlight and display the result
0ffe68c @joonty Even more README tweaks
joonty authored
81
82 To stop debugging, press `<F6>`. Press it again to close the debugger interface.
cd28efe @K-Phoen Add: licence and readme files
K-Phoen authored
83
84 # Licence
85
22b934d @joonty Fixed LICENSE url in README
joonty authored
86 This plugin is released under the [MIT License][1].
41bd44e @joonty Updated README
joonty authored
87
74bf425 @joonty Fixed the frickin' LICENSE url for the last time
joonty authored
88 [1]: https://raw.github.com/joonty/vdebug/master/LICENCE
Something went wrong with that request. Please try again.