aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2018-02-15 00:28:18 +0100
committerTeddy Wing2018-02-15 00:45:03 +0100
commit1c89f65861cd8366770b9ac2804852fbc4b9f346 (patch)
tree4b2ab5daf4907ee3af2d68aaedbdce9eb2b055db
parentba6d179bc02538b476291b547cbc567d42371d68 (diff)
downloadirssi-dimpid-1c89f65861cd8366770b9ac2804852fbc4b9f346.tar.bz2
Add header documentation comment
Describe the plugin and how to use it (by setting `dimpid_nicks`).
-rw-r--r--dimpid.pl10
1 files changed, 10 insertions, 0 deletions
diff --git a/dimpid.pl b/dimpid.pl
index 3ed54c6..b809dab 100644
--- a/dimpid.pl
+++ b/dimpid.pl
@@ -1,5 +1,15 @@
# dimpid.pl
#
+# Outputs public messages from certain nicks in grey instead of standard black.
+#
+# Settings:
+#
+# dimpid_nicks: a space-separated list of nicks whose public messages will
+# be printed in grey.
+#
+# Example: /set dimpid_nicks nibbler hermes zoidberg
+#
+#
# Copyright (c) 2018 Teddy Wing
#
# This program is free software: you can redistribute it and/or modify