aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2017-12-17 02:38:27 +0100
committerTeddy Wing2017-12-17 02:38:27 +0100
commit95716a26dd67635715b17df925d7f802ade97b22 (patch)
treef9b9cb4852b010b85114cdfdb04be5b99000ea15
parent0ff1eb62d053d4e6de33e14bc9d65209ba17c9e3 (diff)
downloadirssi-vimput-95716a26dd67635715b17df925d7f802ade97b22.tar.bz2
Add a script header comment
Copy the help description (since it's already written) to give users who haven't installed the script an idea of what it does and how it works. Add copyright and license information.
-rw-r--r--vimput.pl27
1 files changed, 27 insertions, 0 deletions
diff --git a/vimput.pl b/vimput.pl
index 1ab536e..5a7f08a 100644
--- a/vimput.pl
+++ b/vimput.pl
@@ -1,3 +1,30 @@
+# vimput.pl
+#
+# Opens the current input line in a new Tmux split in Vim. When the Vim
+# buffer is written, Irssi's prompt will be updated from the contents of the
+# buffer.
+#
+# **Note:** In order to use this script, you'll have to make a key binding to
+# Vimput. For example, to bind Ctrl-X:
+#
+# /BIND ^X command script exec Irssi::Script::vimput::vimput
+#
+#
+# Copyright (c) 2017 Teddy Wing
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
use strict;
use File::Temp qw(tmpnam);