ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.man.in
(Generate patch)

Comparing rxvt-unicode/doc/rxvtperl.3.man.in (file contents):
Revision 1.39 by root, Wed Jan 25 00:57:57 2006 UTC vs.
Revision 1.40 by root, Wed Jan 25 21:48:47 2006 UTC

… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 3" 131.IX Title "rxvt 3"
132.TH rxvt 3 "2006-01-25" "7.2" "RXVT-UNICODE" 132.TH rxvt 3 "2006-01-25" "7.3" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134@@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter 134@@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 1 137.Vb 1
… …
388by replacing all line-drawing characters (U+2500 .. U+259F) by a 388by replacing all line-drawing characters (U+2500 .. U+259F) by a
389similar-looking ascii character. 389similar-looking ascii character.
390.IP "digital-clock" 4 390.IP "digital-clock" 4
391.IX Item "digital-clock" 391.IX Item "digital-clock"
392Displays a digital clock using the built-in overlay. 392Displays a digital clock using the built-in overlay.
393.IP "example-refresh-hooks" 4 393.IP "remote-clipboard" 4
394.IX Item "example-refresh-hooks" 394.IX Item "remote-clipboard"
395Displays a very simple digital clock in the upper right corner of the 395Somewhat of a misnomer, this extension adds two menu entries to the
396window. Illustrates overwriting the refresh callbacks to create your own 396selection popup that allows one ti run external commands to store the
397overlays or changes. 397selection somewhere and fetch it again.
398.Sp
399We use it to implement a \*(L"distributed selection mechanism\*(R", which just
400means that one command uploads the file to a remote server, and another
401reads it.
402.Sp
403The commands can be set using the \f(CW\*(C`URxvt.remote\-selection.store\*(C'\fR and
404\&\f(CW\*(C`URxvt.remote\-selection.fetch\*(C'\fR resources. The first should read the
405selection to store from \s-1STDIN\s0 (always in \s-1UTF\-8\s0), the second should provide
406the selection data on \s-1STDOUT\s0 (also in \s-1UTF\-8\s0).
407.Sp
408The defaults (which are likely useless to you) use rsh and cat:
409.Sp
410.Vb 2
411\& URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
412\& URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
413.Ve
398.IP "selection-pastebin" 4 414.IP "selection-pastebin" 4
399.IX Item "selection-pastebin" 415.IX Item "selection-pastebin"
400This is a little rarely useful extension that Uploads the selection as 416This is a little rarely useful extension that Uploads the selection as
401textfile to a remote site (or does other things). (The implementation is 417textfile to a remote site (or does other things). (The implementation is
402not currently secure for use in a multiuser environment as it writes to 418not currently secure for use in a multiuser environment as it writes to
… …
427for the filename): 443for the filename):
428.Sp 444.Sp
429.Vb 1 445.Vb 1
430\& URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 446\& URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
431.Ve 447.Ve
448.IP "example-refresh-hooks" 4
449.IX Item "example-refresh-hooks"
450Displays a very simple digital clock in the upper right corner of the
451window. Illustrates overwriting the refresh callbacks to create your own
452overlays or changes.
432.SH "API DOCUMENTATION" 453.SH "API DOCUMENTATION"
433.IX Header "API DOCUMENTATION" 454.IX Header "API DOCUMENTATION"
434.Sh "General \s-1API\s0 Considerations" 455.Sh "General \s-1API\s0 Considerations"
435.IX Subsection "General API Considerations" 456.IX Subsection "General API Considerations"
436All objects (such as terminals, time watchers etc.) are typical 457All objects (such as terminals, time watchers etc.) are typical
… …
627code is run after this hook, and takes precedence. 648code is run after this hook, and takes precedence.
628.ie n .IP "on_refresh_end $term" 4 649.ie n .IP "on_refresh_end $term" 4
629.el .IP "on_refresh_end \f(CW$term\fR" 4 650.el .IP "on_refresh_end \f(CW$term\fR" 4
630.IX Item "on_refresh_end $term" 651.IX Item "on_refresh_end $term"
631Called just after the screen gets redrawn. See \f(CW\*(C`on_refresh_begin\*(C'\fR. 652Called just after the screen gets redrawn. See \f(CW\*(C`on_refresh_begin\*(C'\fR.
632.ie n .IP "on_keyboard_command $term\fR, \f(CW$string" 4 653.ie n .IP "on_user_command $term\fR, \f(CW$string" 4
633.el .IP "on_keyboard_command \f(CW$term\fR, \f(CW$string\fR" 4 654.el .IP "on_user_command \f(CW$term\fR, \f(CW$string\fR" 4
634.IX Item "on_keyboard_command $term, $string" 655.IX Item "on_user_command $term, $string"
635Called whenever the user presses a key combination that has a 656Called whenever the a user-configured event is being activated (e.g. via
636\&\f(CW\*(C`perl:string\*(C'\fR action bound to it (see description of the \fBkeysym\fR 657a \f(CW\*(C`perl:string\*(C'\fR action bound to a key, see description of the \fBkeysym\fR
637resource in the @@RXVT_NAME@@(1) manpage). 658resource in the @@RXVT_NAME@@(1) manpage).
659.Sp
660The event is simply the action string. This interface is assumed to change
661slightly in the future.
638.ie n .IP "on_x_event $term\fR, \f(CW$event" 4 662.ie n .IP "on_x_event $term\fR, \f(CW$event" 4
639.el .IP "on_x_event \f(CW$term\fR, \f(CW$event\fR" 4 663.el .IP "on_x_event \f(CW$term\fR, \f(CW$event\fR" 4
640.IX Item "on_x_event $term, $event" 664.IX Item "on_x_event $term, $event"
641Called on every X event received on the vt window (and possibly other 665Called on every X event received on the vt window (and possibly other
642windows). Should only be used as a last resort. Most event structure 666windows). Should only be used as a last resort. Most event structure

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines