--- rxvt-unicode/doc/rxvtperl.3.txt 2006/01/22 20:39:56 1.35 +++ rxvt-unicode/doc/rxvtperl.3.txt 2006/01/25 21:48:47 1.37 @@ -60,6 +60,13 @@ URxvt.selection.pattern-0: \\|([^|]+)\\| + Another example: Programs I use often output "absolute path: " at + the beginning of a line when they process multiple files. The + following pattern matches the filename (note, there is a single + space at the very end): + + URxvt.selection.pattern-0: ^(/[^:]+):\ + You can look at the source of the selection extension to see more interesting uses, such as parsing a line from beginning to end. @@ -184,6 +191,17 @@ in the resource "urlLauncher" (default "x-www-browser") will be started with the URL as first argument. + xim-onthespot + This (experimental) 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 + leats for SCIM and kinput2. + + You enable it by specifying this extension and a preedit style of + "OnTheSpot", i.e.: + + rxvt -pt OnTheSpot -pe xim-onthespot + automove-background This is basically a one-line extension that dynamically changes the background pixmap offset to the window position, in effect creating @@ -200,10 +218,24 @@ digital-clock Displays a digital clock using the built-in overlay. - example-refresh-hooks - Displays a very simple digital clock in the upper right corner of - the window. Illustrates overwriting the refresh callbacks to create - your own overlays or changes. + remote-clipboard + Somewhat of a misnomer, this extension adds two menu entries to the + selection popup that allows one ti run external commands to store + the selection somewhere and fetch it again. + + We use it to implement a "distributed selection mechanism", which + just means that one command uploads the file to a remote server, and + another reads it. + + The commands can be set using the "URxvt.remote-selection.store" and + "URxvt.remote-selection.fetch" resources. The first should read the + selection to store from STDIN (always in UTF-8), the second should + provide the selection data on STDOUT (also in UTF-8). + + The defaults (which are likely useless to you) use rsh and cat: + + URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' + URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' selection-pastebin This is a little rarely useful extension that Uploads the selection @@ -233,6 +265,11 @@ URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% + example-refresh-hooks + Displays a very simple digital clock in the upper right corner of + the window. Illustrates overwriting the refresh callbacks to create + your own overlays or changes. + API DOCUMENTATION General API Considerations All objects (such as terminals, time watchers etc.) are typical @@ -315,9 +352,8 @@ mainloop. on_destroy $term - Called whenever something tries to destroy terminal, before doing - anything yet. If this hook returns true, then destruction is - skipped, but this is rarely a good idea. + Called whenever something tries to destroy terminal, when the + terminal is still fully functional (not for long, though). on_reset $term Called after the screen is "reset" for any reason, such as resizing @@ -419,10 +455,13 @@ on_refresh_end $term Called just after the screen gets redrawn. See "on_refresh_begin". - on_keyboard_command $term, $string - Called whenever the user presses a key combination that has a - "perl:string" action bound to it (see description of the keysym - resource in the rxvt(1) manpage). + on_user_command $term, $string + Called whenever the a user-configured event is being activated (e.g. + via a "perl:string" action bound to a key, see description of the + keysym resource in the rxvt(1) manpage). + + The event is simply the action string. This interface is assumed to + change slightly in the future. on_x_event $term, $event Called on every X event received on the vt window (and possibly