--- rxvt-unicode/src/perl/xim-onthespot	2006/01/25 01:53:33	1.2
+++ rxvt-unicode/src/perl/xim-onthespot	2012/06/10 17:31:53	1.6
@@ -1,10 +1,27 @@
 #! perl
 
+=head1 NAME
+
+   xim-onthespot - implement XIM "on-the-spot" behaviour
+
+=head1 DESCRIPTION
+
+This perl extension implements OnTheSpot editing. It does not work
+perfectly, and some input methods don't seem to work well with OnTheSpot
+editing in general, but it seems to work at least for SCIM and kinput2.
+
+You enable it by specifying this extension and a preedit style of
+C<OnTheSpot>, i.e.:
+
+   urxvt -pt OnTheSpot -pe xim-onthespot
+
+=cut
+
 #
 # problems with this implementation include
-# 
-# - primary, secondary, teriary is NOT different to other hilighting
-# - if rend values are missing, they are not interpolated
+#
+# - primary, secondary, tertiary are NO different to other highlighting styles
+# - if rend values are missing, they are not being interpolated
 #
 
 my $SIZEOF_LONG = length pack "l!", 0;