Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Document new features and settings

  • Loading branch information...
commit 10c8cbcdd9488552af72a6cd7514110f96223cbb 1 parent f19c006
@henrikbrixandersen authored
Showing with 47 additions and 5 deletions.
  1. +47 −5 README.md
View
52 README.md
@@ -10,13 +10,16 @@
* Notifications on private actions (``/me``) when away
* Manual notifications using the ``/prowl`` command
* Customizable priority levels for Prowl notifications
+* Customizable IRC URLs for Prowl notifications
+* Customizable event strings for Prowl notifications
## Installation
-This script depends on
-[WebService::Prowl](http://search.cpan.org/dist/WebService-Prowl/). To
-install this dependency, run the following command in your terminal
-(Hint: You don't need root access to install perl modules, check out
+This script depends on the
+[WebService::Prowl](http://search.cpan.org/dist/WebService-Prowl/)
+perl module. To install this dependency, run the following command in
+your terminal (Hint: You don't need root access to install perl
+modules, check out
[local::lib](http://search.cpan.org/dist/local-lib/)):
cpan WebService::Prowl
@@ -43,18 +46,57 @@ using the ``/prowl`` command:
/prowl Hello, world
/prowl -url https://github.com/henrikbrixandersen/irssi-prowl -priority 2 Check out this cool irssi-prowl script!
-To change the priority of the Prowl notifications for private
+## Configuration
+
+### Settings
+
+To change the priority level of the Prowl notifications for private
messages, hilights and the default priority for the ``/prowl``
command, use the following settings:
/set prowl_priority_msgs 1
/set prowl_priority_hilight 0
/set prowl_priority_cmd -2
+ /save
To assist in debugging, turn on the ``prowl_debug`` setting:
/set prowl_debug on
+### Theming
+
+To change the Prowl event strings for private messages, hilights and
+the ``/prowl`` command, use the following settings:
+
+ /format prowl_event_msgs PM from $0
+ /format prowl_event_hilight Mentioned in $0
+ /format prowl_event_cmd Remember
+ /save
+
+For the first two, ``$0`` will be replaced with the respective nick or channel.
+
+The format of the URLs passed to Prowl for private messages and
+hilights can be controlled with the following settings:
+
+ /format prowl_url_msgs $0://$1:$3/
+ /format prowl_url_hilight $0://$1:$3/$4
+ /save
+
+For both of these, ``$0`` will be replaced with either ``irc`` or
+``ircs`` depending on whether the respective server uses SSL or
+not. ``$1`` will be replaced with the server address, ``$2`` with the
+name of the chat network, ``$3`` with the server port number and
+``$4`` with the respective nick or channel.
+
+The default URL formats are rather conservative in order to support
+the largest number of iOS IRC clients. For
+[draft-butcher-irc-url-04](http://tools.ietf.org/html/draft-butcher-irc-url-04)
+compliant IRC URLs, one could use the following formats:
+
+ /format prowl_url_msgs $0://$1:$3/$4,isuser,isserver
+ /format prowl_url_hilight $0://$2:$3/$4,ischannel,isnetwork
+ /save
+
## License
This software is licensed under the 2-clause BSD license. See the
Please sign in to comment.
Something went wrong with that request. Please try again.