From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

KABLAMO / Vim-Debug-0.10 / lib / Vim / Debug / Manual.pm 

            

              
1
2
3
4
5
6
7
8
—
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

              
# ABSTRACT: What is Vim::Debug and how do I use it?
package Vim::Debug::Manual;
{
  $Vim::Debug::Manual::VERSION = '0.10';
}
__END__
=pod
=head1 NAME
Vim::Debug::Manual - What is Vim::Debug and how do I use it?
=head1 VERSION
version 0.10
=head1 DESCRIPTION
Vim::Debug integrates the Perl debugger with Vim, allowing developers to
visually step through their code and examine variables.  
Please note that this code is in beta.
=head1 PREREQUISITES
=over 4
=item Unix/Ubuntu/OSX
=item Vim with +signs, and +perl compiled in
=item Perl 5.6.0+
=item The Vim::Debug Perl module
=back
=head1 INSTALL INSTRUCTIONS
=head2 With cpanm
    TODO
=head2 With github
    git clone git@github.com:kablamo/VimDebug.git
    cd VimDebug
    perl Makefile.PL
    make
    sudo make install
    cp -r vim/* $VIMHOME/
Replace $VIMHOME with your vim configuration directory.  (/home/username/.vim on unix.)
head1 KEY BINDINGS
These are the default key bindings.  To change them, edit VimDebug.vim:
    <F12>      Start the debugger
    <Leader>s/ Start the debugger.  Prompts for command line arguments.
    <F10>      Restart debugger. Break points are ALWAYS saved (for all dbgrs).
    <F11>      Exit the debugger
    <F6>       Next
    <F7>       Step
    <F8>       Continue
    <Leader>b  Set break point on the current line
    <Leader>c  Clear break point on the current line
    <Leader>v  Print the value of the variable under the cursor
    <Leader>v/ Print the value of an expression thats entered
    <Leader>/  Type a command for the debugger to execute and echo the result
=head1 DEVELOPERS
Fork it on github: http://github.com/kablamo/VimDebug
=head1 AUTHOR
Eric Johnson <vimdebug at iijo dot org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Eric Johnson.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut