summaryrefslogtreecommitdiffstats
path: root/lib/Reply/Plugin/Interrupt.pm
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2013-06-03 15:18:17 -0500
committerJesse Luehrs <doy@tozt.net>2013-06-03 15:51:17 -0500
commitec069554b263d4d3a60a315089e170b92badd1d8 (patch)
tree38e4b6cb2196ee0b56aa33c29df3a94c53ad1e20 /lib/Reply/Plugin/Interrupt.pm
parent60f235d03fba8232e7f691550ee715e1cfb9c5b6 (diff)
downloadreply-ec069554b263d4d3a60a315089e170b92badd1d8.tar.gz
reply-ec069554b263d4d3a60a315089e170b92badd1d8.zip
start on some docs
Diffstat (limited to 'lib/Reply/Plugin/Interrupt.pm')
-rw-r--r--lib/Reply/Plugin/Interrupt.pm13
1 files changed, 13 insertions, 0 deletions
diff --git a/lib/Reply/Plugin/Interrupt.pm b/lib/Reply/Plugin/Interrupt.pm
index a5c2b37..1aab2b8 100644
--- a/lib/Reply/Plugin/Interrupt.pm
+++ b/lib/Reply/Plugin/Interrupt.pm
@@ -1,9 +1,22 @@
package Reply::Plugin::Interrupt;
use strict;
use warnings;
+# ABSTRACT: allows using Ctrl+C to interrupt long-running lines
use base 'Reply::Plugin';
+=head1 SYNOPSIS
+
+ ; .replyrc
+ [Interrupt]
+
+=head1 DESCRIPTION
+
+This plugin allows you to use Ctrl+C to interrupt long running commands without
+exiting the Reply shell entirely.
+
+=cut
+
sub compile {
my $self = shift;
my ($next, @args) = @_;