view release on metacpan or  search on metacpan

tkdb.pm  view on Meta::CPAN

=over 4

=item Hot Variable Inspection (currently disabled)

=item Breakpoint Control Panel

=item Expression List

=item Subroutine Tree

=back

=head1 Usage

To debug a script using tkdb invoke perl like this:

    perl -d:tkdb myscript.pl

=head1 Code Pane

=over 4

=item Line Numbers

Line numbers are presented on the left side of the window. Lines that
have lines through them are not breakable. Lines that are plain text
are breakable. Clicking on these line numbers will insert a
breakpoint on that line and change the line number color to red.
Clicking on the number again will remove the breakpoint.  If you
disable the breakpoint with
the controls on the BrkPt notebook page the color will change to green.

=item Cursor Motion

If you place the cursor over a variable (i.e. $myVar, @myVar, or
%myVar) and pause for a second the debugger will evaluate the current
value of the variable and pop a balloon up with the evaluated
result.

If there is an active selection, the text of that selection will be evaluated.

=back

=head1 Notebook Pane

=over 2

=item Exprs

This is a list of expressions that are evaluated each time the
debugger stops. The results of the expresssion are presented
heirarchically for expression that result in hashes or lists.  Double
clicking on such an expression will cause it to collapse; double
clicking again will cause the expression to expand. Expressions are
entered through B<Enter Expr> entry, or by Alt-E when text is
selected in the code pane.

The B<Quick Expr> entry, will take an expression, evaluate it, and
replace the entries contents with the result.  The result is also
transfered to the 'clipboard' for pasting.

=item Subs

Displays a list of all the packages invoked with the script
heirarchially. At the bottom of the heirarchy are the subroutines
within the packages.  Double click on a package to expand
it. Subroutines are listed by their full package names.

=item BrkPts

Presents a list of the breakpoints current in use. The pushbutton
allows a breakpoint to be 'disabled' without removing it. Expressions
can be applied to the breakpoint.  If the expression evaluates to be
'true' (results in a defined value that is not 0) the debugger will
stop the script.  Pressing the 'Goto' button will set the text pane
to that file and line where the breakpoint is set.  Pressing the
'Delete' button will delete the breakpoint.

=back

=head1 Menus

=head2 File Menu

=over

=item About...

Presents a dialog box telling you about the version of tkdb.  It
recovers your OS name, version of perl, version of Tcl/Tk, and some other
information

=item Open

Presents a list of files that are part of the invoked perl
script. Selecting a file from this list will present this file in the
text window.

=item Save Config...

Prompts for a filename to save the
configuration to. Saves the breakpoints, expressions, eval text and
window geometry. If the name given as the default is used and the
script is reinvoked, this configuration will be reloaded automatically.

=item Restore Config...

Prompts for a filename to restore a configuration saved with
the "Save Config..." menu item.  

=item Goto Line...

Prompts for a line number.  Pressing the "Okay" button sends the window
to the line number entered.

=item Find Text...

Prompts for text to search for.  Options include forward search,
backwards search, and regular expression searching.