Add help for `/swhois`

Include a help document that can be accessed from inside Irssi showing a
description of the `swhois` command and some examples.

Leaned how to do this and format the output from:
- https://github.com/irssi/scripts.irssi.org/blob/master/scripts/trackbar.pl
- https://github.com/irssi/scripts.irssi.org/blob/22060fc4669627a9859c92efa2d6651e3673d494/scripts/spotify.pl
- https://github.com/irssi/irssi/blob/b1ffd5f6472584aa3966746da9728c5afefcc4ce/docs/help/in/rehash.in
- https://github.com/irssi/scripts.irssi.org/blob/22060fc4669627a9859c92efa2d6651e3673d494/scripts/clearable.pl

1 files changed, 27 insertions, 0 deletions

diff --git a/slack_profile.pl b/slack_profile.pl
index 20a102d..86038ce 100644
--- a/slack_profile.pl
+++ b/slack_profile.pl
@@ -54,6 +54,32 @@ $VERSION = '1.00';
 
 my @users_list;
 
+sub help {
+	my ($args) = @_;
+
+	if ($args =~ /^swhois\s*$/) {
+		my $help = <<HELP;
+%9Syntax:%9
+
+SWHOIS [<nick>]
+
+%9Description:%9
+
+    Displays WHOIS-style profile information from Slack for the given nick. If
+    no nick argument is provided, the current nick is used.
+
+%9Examples:%9
+
+    /SWHOIS
+    /SWHOIS farnsworth
+    /SWHOIS \@farnsworth
+HELP
+
+		Irssi::print($help, MSGLEVEL_CLIENTCRAP);
+		Irssi::signal_stop();
+	}
+}
+
 sub users_list_cache {
 	Irssi::get_irssi_dir() . '/scripts/users.list.plstore';
 }
@@ -164,5 +190,6 @@ sub swhois {
 }
 
 Irssi::command_bind('swhois', 'swhois');
+Irssi::command_bind('help', 'help');
 
 Irssi::settings_add_str('slack_profile', 'slack_profile_token', '');