--- rxvt-unicode/src/perl/xim-onthespot 2007/06/02 05:07:12 1.3 +++ rxvt-unicode/src/perl/xim-onthespot 2012/06/10 17:31:53 1.6 @@ -1,9 +1,26 @@ #! 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, i.e.: + + urxvt -pt OnTheSpot -pe xim-onthespot + +=cut + # # problems with this implementation include -# -# - primary, secondary, tertiary are NO different to other hilighting styles +# +# - primary, secondary, tertiary are NO different to other highlighting styles # - if rend values are missing, they are not being interpolated #