Skip to content

Commit

Permalink
Add: licence and readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
K-Phoen committed Nov 26, 2011
1 parent 0d61a7b commit cd28efe
Show file tree
Hide file tree
Showing 2 changed files with 91 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENCE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Copyright © 2011 Ludovic Pelle <ludovic_pelle AT carpe-hora.com>
2011 Kévin Gomez <contact AT kevingomez.fr>
2007 Sam Ghods <sam AT box.net>
2004 Seung Woo Shin <segv AT sayclub.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

The Software is provided "as is", without warranty of any kind, express or
implied, including but not limited to the warranties of merchantability,
fitness for a particular purpose and noninfringement. In no event shall the
authors or copyright holders be liable for any claim, damages or other liability,
whether in an action of contract, tort or otherwise, arising from, out of or in
connection with the software or the use or other dealings in the Software.
70 changes: 70 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Vim-Xdebug

This vim plugin provides a debugger interface to DBGp protocol, and therefore
Xdebug (only tested on Xdebug 2).

This is a fork of [this plugin](http://www.vim.org/scripts/script.php?script_id=1152), which
is a bit buggy, limited is many ways and not maintained anymore.


# Installation

**Requirements**:

* Vim compiled with Python (2) support
* DBGp protocol enabled debugging module, such as Xdebug.

## Classic

Clone or download a tarball of the plugin and move its content in your
`~/.vim/` directory.

Your `~/.vim/plugins/` directory should now have two more files: `debugger.py`
and `debugger.vim`.

## Using git and Pathogen

Clone this repository in your `~/.vim/bundle` directory (and yeah, you're done).


# Quick guide

1. setup Xdebug - or other DBGp enabled server - correctly (with proper remote
debug option)
2. press `F5` to make Vim wait for a debugging connection and browse your PHP
file (you have five seconds to do it once you press `F5`).

All the currently opened windows will be closed and debugging interface
will appear.
3. Once in debugging mode, the following mappings are available:

* `<F1>`: resizing windows
* `<F2>`: step into
* `<F3>`: step over
* `<F4>`: step out
* `<F6>`: stop debugging
* `<F11>`: shows all variables
* `<F12>`: shows variable on current cursor
* `,e`: evaluate an expression and display the result
4. To stop debugging, press `<F6>`


## Notes

* You'll see some python's exception message. They happen when connection is
closed, because Xdebug doesn't send message for last file/line information.
* This plugin doesn't implement all DBGP's features, just the very essential
parts.


# Contributors

* Ludovic Pelle <ludovic_pelle AT carpe-hora.com>
* [Kévin Gomez](https://github.com/K-Phoen) <contact AT kevingomez.fr>
* Sam Ghods <sam AT box.net>
* Seung Woo Shin <segv AT sayclub.com>


# Licence

The MIT/Expat licence.

0 comments on commit cd28efe

Please sign in to comment.