summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2013-06-26 14:58:04 -0400
committerJesse Luehrs <doy@tozt.net>2013-06-26 14:58:04 -0400
commit3263c0b2de7f46ffc552640838b7323746ceda0d (patch)
tree22726479196aad545c8c101e9a9d6cb3aa023f6e
parent1902a33675b5e405f90909d62dbb89e80ab3e38b (diff)
downloadcarp-reply-3263c0b2de7f46ffc552640838b7323746ceda0d.tar.gz
carp-reply-3263c0b2de7f46ffc552640838b7323746ceda0d.zip
improve documentation (RT86274)
-rw-r--r--lib/Carp/Reply.pm9
1 files changed, 8 insertions, 1 deletions
diff --git a/lib/Carp/Reply.pm b/lib/Carp/Reply.pm
index 366bc8c..b791cd4 100644
--- a/lib/Carp/Reply.pm
+++ b/lib/Carp/Reply.pm
@@ -31,10 +31,17 @@ The package and lexical environment are set to the package and lexical
environment of the current stack frame (and are updated when you use any of the
commands which move around the stack frames).
-Carp::Reply also installs a C<__DIE__> handler which automatically launches a
+You can start a repl at any given point in your program by inserting a call to
+C<Carp::Reply::repl> in your code. In addition, the default C<import> method
+for C<Carp::Reply> installs a C<__DIE__> handler which automatically launches a
repl when an exception is thrown. You can suppress this behavior by passing an
empty import list, either via C<use Carp::Reply ();> or C<perl -mCarp::Reply>.
+If the repl was invoked manually (via calling C<repl>), you can resume
+execution of your code by exiting the repl, typically via C<Ctrl+D>. If it was
+invoked via the C<__DIE__> handler, there is no way to resume execution (this
+is a limitation of perl itself).
+
=head1 COMMANDS
=over 4