aboutsummaryrefslogtreecommitdiff
path: root/development/pyclewn/README
diff options
context:
space:
mode:
Diffstat (limited to 'development/pyclewn/README')
-rw-r--r--development/pyclewn/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/development/pyclewn/README b/development/pyclewn/README
new file mode 100644
index 0000000000000..8ea36a0a7f430
--- /dev/null
+++ b/development/pyclewn/README
@@ -0,0 +1,18 @@
+Pyclewn allows using vim as a front end to a debugger.
+Pyclewn currently supports gdb and pdb.
+
+The debugger output is redirected to a vim window,
+the pyclewn console. The debugger commands are mapped to vim
+user-defined commands with a common letter prefix, and with completion
+available on the commands and their first argument.
+
+When running gvim, the controlling terminal of the program to debug is
+the terminal used to launch pyclewn. Any other terminal can be used
+when the debugger allows it, for example after using the attach or tty
+gdb commands or using the --tty option with pdb.
+
+Required Vim 7.0 or above with the netbeans_intg feature enabled,
+and with the autocmd feature enabled.
+
+You can use the :help pyclewn command within vim, to get access
+to the documentation.