Difference between revisions of "Irssi-otr"

From ArchWiki
Jump to: navigation, search
(Extended article slightly.)
m (Some minor formatting)
Line 24: Line 24:
 
==Loading the module on startup==
 
==Loading the module on startup==
  
If you are tired of typing /load otr you can put the following in your ~/.irssi/startup:
+
If you are tired of typing <tt>/LOAD otr</tt> you can put the following
 +
in your <tt>~/.irssi/startup</tt>:
  
 
  LOAD otr
 
  LOAD otr
Line 30: Line 31:
 
==Finishing conversations on /quit==
 
==Finishing conversations on /quit==
  
If otr_finishonunload is set irssi-otr will finish all your OTR sessions
+
If <tt>otr_finishonunload</tt> is set irssi-otr will finish all your OTR
when the module is unloaded.  However when you /quit, Irssi disconnects
+
sessions when the module is unloaded.  However when you <tt>/QUIT</tt>,
from the IRC networks first and unloads its modules afterwards.  Of course
+
Irssi disconnects from the IRC networks first and unloads its modules
this will prevent your OTR sessions form being finished correctly.
+
afterwards.  Of course this will prevent your OTR sessions form being
To circumvent this you can define the following alias:
+
finished correctly. To circumvent this you can define the following
 +
alias:
  
  /alias QUIT unload otr; quit
+
  /ALIAS quit unload otr; quit
  
 
=Stripping HTML=
 
=Stripping HTML=
Line 47: Line 49:
 
[http://wouter.coekaerts.be/site/irssi/trigger Trigger script].  Just make
 
[http://wouter.coekaerts.be/site/irssi/trigger Trigger script].  Just make
 
sure you load the script before the otr module.  You can either do this
 
sure you load the script before the otr module.  You can either do this
manually or again make your ~/.irssi/startup look like this:
+
manually or again make your <tt>~/.irssi/startup</tt> look like this:
  
 
  SCRIPT LOAD trigger.pl
 
  SCRIPT LOAD trigger.pl
 
  LOAD otr
 
  LOAD otr
  
Also make sure that trigger.pl is not in ~/.irssi/scripts/autorun since
+
Also make sure that trigger.pl is not in <tt>~/.irssi/scripts/autorun</tt>
the files from this directory are loaded after ~/.irssi/startup.
+
since the files from this directory are loaded after
 +
<tt>~/.irssi/startup</tt>.
  
 
We will take a somewhat conservative approach.  We will only strip HTML
 
We will take a somewhat conservative approach.  We will only strip HTML
Line 69: Line 72:
  
 
<!--
 
<!--
vim: filetype=Wikipedia spell
+
vim: filetype=Wikipedia nowrap spell spelllang=en
 
-->
 
-->

Revision as of 20:21, 21 February 2009


About

The irssi-otr module brings Off-the-Record Messaging to your favorite IRC client.

Installing

You can install the Irssi OTR module from the AUR. If you like to test bleeding edge software, there is also a Git version.

Usage

See the README.

Automatic loading & unloading

Loading the module on startup

If you are tired of typing /LOAD otr you can put the following in your ~/.irssi/startup:

LOAD otr

Finishing conversations on /quit

If otr_finishonunload is set irssi-otr will finish all your OTR sessions when the module is unloaded. However when you /QUIT, Irssi disconnects from the IRC networks first and unloads its modules afterwards. Of course this will prevent your OTR sessions form being finished correctly. To circumvent this you can define the following alias:

/ALIAS quit unload otr; quit

Stripping HTML

If you use irssi-otr with BitlBee you will notice that some clients send you HTML formatted messages. Normally BitlBee automatically strips the HTML formatting, but since the messages are encrypted this doesn't work anymore. Nevertheless you can achieve the same by stripping the HTML with regular expressions using the Trigger script. Just make sure you load the script before the otr module. You can either do this manually or again make your ~/.irssi/startup look like this:

SCRIPT LOAD trigger.pl
LOAD otr

Also make sure that trigger.pl is not in ~/.irssi/scripts/autorun since the files from this directory are loaded after ~/.irssi/startup.

We will take a somewhat conservative approach. We will only strip HTML tags we explicitly specified from PRIVMSGS from the BitlBee network, where we assume you added you server.

-privmsgs -nocase -tags 'BitlBee' -regexp '</?(a|b|body|div|em|font|i|s|u)( +\w+=".*?")*>' -replace  

Finally convert some escaped HTML characters:

-privmsgs -nocase -tags 'BitlBee' -regexp '&amp;' -replace '&' 
-privmsgs -nocase -tags 'BitlBee' -regexp '&gt;' -replace '>' 
-privmsgs -nocase -tags 'BitlBee' -regexp '&lt;' -replace '<' 
-privmsgs -nocase -tags 'BitlBee' -regexp '&quot;' -replace '"'