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.33 by root, Wed Jan 18 09:40:53 2006 UTC vs.
Revision 1.34 by root, Thu Jan 19 19:26:31 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-18" "7.1" "RXVT-UNICODE" 132.TH rxvt 3 "2006-01-19" "7.1" "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
… …
224.IP "selection-popup (enabled by default)" 4 224.IP "selection-popup (enabled by default)" 4
225.IX Item "selection-popup (enabled by default)" 225.IX Item "selection-popup (enabled by default)"
226Binds a popup menu to Ctrl\-Button3 that lets you convert the selection 226Binds a popup menu to Ctrl\-Button3 that lets you convert the selection
227text into various other formats/action (such as uri unescaping, perl 227text into various other formats/action (such as uri unescaping, perl
228evalution, web-browser starting etc.), depending on content. 228evalution, web-browser starting etc.), depending on content.
229.Sp
230Other extensions can extend this popup menu by pushing a code reference
231onto \f(CW\*(C`@{ $term\-\*(C'\fR{selection_popup_hook} }>, that is called whenever the
232popup is displayed.
233.Sp
234It's sole argument is the popup menu, which can be modified. The selection
235is in \f(CW$_\fR, which can be used to decide wether to add something or not.
236It should either return nothing or a string and a code reference. The
237string will be used as button text and the code reference will be called
238when the button gets activated and should transform \f(CW$_\fR.
239.Sp
240The following will add an entry \f(CW\*(C`a to b\*(C'\fR that transforms all \f(CW\*(C`a\*(C'\fRs in
241the selection to \f(CW\*(C`b\*(C'\fRs, but only if the selection currently contains any
242\&\f(CW\*(C`a\*(C'\fRs:
243.Sp
244.Vb 4
245\& push @{ $self->{term}{selection_popup_hook} }, sub {
246\& /a/ ? ("a to be" => sub { s/a/b/g }
247\& : ()
248\& };
249.Ve
229.IP "searchable\-scrollback<hotkey> (enabled by default)" 4 250.IP "searchable\-scrollback<hotkey> (enabled by default)" 4
230.IX Item "searchable-scrollback<hotkey> (enabled by default)" 251.IX Item "searchable-scrollback<hotkey> (enabled by default)"
231Adds regex search functionality to the scrollback buffer, triggered 252Adds regex search functionality to the scrollback buffer, triggered
232by a hotkey (default: \f(CW\*(C`M\-s\*(C'\fR). While in search mode, normal terminal 253by a hotkey (default: \f(CW\*(C`M\-s\*(C'\fR). While in search mode, normal terminal
233input/output is suspended and a regex is displayed at the bottom of the 254input/output is suspended and a regex is displayed at the bottom of the
… …
264.Sp 285.Sp
265And this example matches the same,but replaces it with vi-commands you can 286And this example matches the same,but replaces it with vi-commands you can
266paste directly into your (vi :) editor: 287paste directly into your (vi :) editor:
267.Sp 288.Sp
268.Vb 1 289.Vb 1
269\& URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\e\ed+):?$/\e\ex1b:e \e\eQ$1\e\eE\e\ex0d:$2\e\ex0d/ 290\& URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\e\ed+):?$/:e \e\eQ$1\e\eE\e\ex0d:$2\e\ex0d/
270.Ve 291.Ve
271.Sp 292.Sp
272Of course, this can be modified to suit your needs and your editor :) 293Of course, this can be modified to suit your needs and your editor :)
273.Sp 294.Sp
274To expand the example above to typical perl error messages (\*(L"\s-1XXX\s0 at 295To expand the example above to typical perl error messages (\*(L"\s-1XXX\s0 at
275\&\s-1FILENAME\s0 line \s-1YYY\s0.\*(R"), you need a slightly more elaborate solution: 296\&\s-1FILENAME\s0 line \s-1YYY\s0.\*(R"), you need a slightly more elaborate solution:
276.Sp 297.Sp
277.Vb 2 298.Vb 2
278\& URxvt.selection.pattern-0: ( at .*? line \e\ed+\e\e.) 299\& URxvt.selection.pattern-0: ( at .*? line \e\ed+[,.])
279\& URxvt.selection-autotransform.0: s/^ at (.*?) line (\e\ed+)\e\e.$/\ex1b:e \e\eQ$1\eE\e\ex0d:$2\e\ex0d/ 300\& URxvt.selection-autotransform.0: s/^ at (.*?) line (\e\ed+)[,.]$/:e \e\eQ$1\eE\e\ex0d:$2\e\ex0d/
280.Ve 301.Ve
281.Sp 302.Sp
282The first line tells the selection code to treat the unchanging part of 303The first line tells the selection code to treat the unchanging part of
283every error message as a selection pattern, and the second line transforms 304every error message as a selection pattern, and the second line transforms
284the message into vi commands to load the file. 305the message into vi commands to load the file.
… …
286.IX Item "mark-urls" 307.IX Item "mark-urls"
287Uses per-line display filtering (\f(CW\*(C`on_line_update\*(C'\fR) to underline urls and 308Uses per-line display filtering (\f(CW\*(C`on_line_update\*(C'\fR) to underline urls and
288make them clickable. When middle\-clicked, the program specified in the 309make them clickable. When middle\-clicked, the program specified in the
289resource \f(CW\*(C`urlLauncher\*(C'\fR (default \f(CW\*(C`x\-www\-browser\*(C'\fR) will be started with 310resource \f(CW\*(C`urlLauncher\*(C'\fR (default \f(CW\*(C`x\-www\-browser\*(C'\fR) will be started with
290the \s-1URL\s0 as first argument. 311the \s-1URL\s0 as first argument.
312.IP "automove-background" 4
313.IX Item "automove-background"
314This is basically a one-line extension that dynamically changes the background pixmap offset
315to the window position, in effect creating the same effect as pseudo transparency with
316a custom pixmap. No scaling is supported in this mode. Exmaple:
317.Sp
318.Vb 1
319\& @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
320.Ve
291.IP "block-graphics-to-ascii" 4 321.IP "block-graphics-to-ascii" 4
292.IX Item "block-graphics-to-ascii" 322.IX Item "block-graphics-to-ascii"
293A not very useful example of filtering all text output to the terminal, 323A not very useful example of filtering all text output to the terminal,
294by replacing all line-drawing characters (U+2500 .. U+259F) by a 324by replacing all line-drawing characters (U+2500 .. U+259F) by a
295similar-looking ascii character. 325similar-looking ascii character.
… …
423.ie n .IP "on_start $term" 4 453.ie n .IP "on_start $term" 4
424.el .IP "on_start \f(CW$term\fR" 4 454.el .IP "on_start \f(CW$term\fR" 4
425.IX Item "on_start $term" 455.IX Item "on_start $term"
426Called at the very end of initialisation of a new terminal, just before 456Called at the very end of initialisation of a new terminal, just before
427returning to the mainloop. 457returning to the mainloop.
458.ie n .IP "on_child_start $term\fR, \f(CW$pid" 4
459.el .IP "on_child_start \f(CW$term\fR, \f(CW$pid\fR" 4
460.IX Item "on_child_start $term, $pid"
461Called just after the child process has been \f(CW\*(C`fork\*(C'\fRed.
462.ie n .IP "on_child_exit $term\fR, \f(CW$status" 4
463.el .IP "on_child_exit \f(CW$term\fR, \f(CW$status\fR" 4
464.IX Item "on_child_exit $term, $status"
465Called just after the child process has exited. \f(CW$status\fR is the status
466from \f(CW\*(C`waitpid\*(C'\fR.
428.ie n .IP "on_sel_make $term\fR, \f(CW$eventtime" 4 467.ie n .IP "on_sel_make $term\fR, \f(CW$eventtime" 4
429.el .IP "on_sel_make \f(CW$term\fR, \f(CW$eventtime\fR" 4 468.el .IP "on_sel_make \f(CW$term\fR, \f(CW$eventtime\fR" 4
430.IX Item "on_sel_make $term, $eventtime" 469.IX Item "on_sel_make $term, $eventtime"
431Called whenever a selection has been made by the user, but before the 470Called whenever a selection has been made by the user, but before the
432selection text is copied, so changes to the beginning, end or type of the 471selection text is copied, so changes to the beginning, end or type of the
… …
540.ie n .IP "on_focus_out $term" 4 579.ie n .IP "on_focus_out $term" 4
541.el .IP "on_focus_out \f(CW$term\fR" 4 580.el .IP "on_focus_out \f(CW$term\fR" 4
542.IX Item "on_focus_out $term" 581.IX Item "on_focus_out $term"
543Called wheneever the window loses keyboard focus, before rxvt-unicode does 582Called wheneever the window loses keyboard focus, before rxvt-unicode does
544focus out processing. 583focus out processing.
584.ie n .IP "on_configure_notify $term\fR, \f(CW$event" 4
585.el .IP "on_configure_notify \f(CW$term\fR, \f(CW$event\fR" 4
586.IX Item "on_configure_notify $term, $event"
587.PD 0
545.ie n .IP "on_key_press $term\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets" 4 588.ie n .IP "on_key_press $term\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets" 4
546.el .IP "on_key_press \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets\fR" 4 589.el .IP "on_key_press \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets\fR" 4
547.IX Item "on_key_press $term, $event, $keysym, $octets" 590.IX Item "on_key_press $term, $event, $keysym, $octets"
548.PD 0
549.ie n .IP "on_key_release $term\fR, \f(CW$event\fR, \f(CW$keysym" 4 591.ie n .IP "on_key_release $term\fR, \f(CW$event\fR, \f(CW$keysym" 4
550.el .IP "on_key_release \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR" 4 592.el .IP "on_key_release \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR" 4
551.IX Item "on_key_release $term, $event, $keysym" 593.IX Item "on_key_release $term, $event, $keysym"
552.ie n .IP "on_button_press $term\fR, \f(CW$event" 4 594.ie n .IP "on_button_press $term\fR, \f(CW$event" 4
553.el .IP "on_button_press \f(CW$term\fR, \f(CW$event\fR" 4 595.el .IP "on_button_press \f(CW$term\fR, \f(CW$event\fR" 4
… …
704.IP "$term\->destroy" 4 746.IP "$term\->destroy" 4
705.IX Item "$term->destroy" 747.IX Item "$term->destroy"
706Destroy the terminal object (close the window, free resources 748Destroy the terminal object (close the window, free resources
707etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 749etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
708watchers (timers, io watchers) are still active. 750watchers (timers, io watchers) are still active.
751.ie n .IP "$term\->exec_async ($cmd[, @args])" 4
752.el .IP "$term\->exec_async ($cmd[, \f(CW@args\fR])" 4
753.IX Item "$term->exec_async ($cmd[, @args])"
754Works like the combination of the \f(CW\*(C`fork\*(C'\fR/\f(CW\*(C`exec\*(C'\fR builtins, which executes
755(\*(L"starts\*(R") programs in the background. This function takes care of setting
756the user environment before exec'ing the command (e.g. \f(CW\*(C`PATH\*(C'\fR) and should
757be preferred over explicit calls to \f(CW\*(C`exec\*(C'\fR or \f(CW\*(C`system\*(C'\fR.
758.Sp
759Returns the pid of the subprocess or \f(CW\*(C`undef\*(C'\fR on error.
709.ie n .IP "$isset = $term\fR\->option ($optval[, \f(CW$set])" 4 760.ie n .IP "$isset = $term\fR\->option ($optval[, \f(CW$set])" 4
710.el .IP "$isset = \f(CW$term\fR\->option ($optval[, \f(CW$set\fR])" 4 761.el .IP "$isset = \f(CW$term\fR\->option ($optval[, \f(CW$set\fR])" 4
711.IX Item "$isset = $term->option ($optval[, $set])" 762.IX Item "$isset = $term->option ($optval[, $set])"
712Returns true if the option specified by \f(CW$optval\fR is enabled, and 763Returns true if the option specified by \f(CW$optval\fR is enabled, and
713optionally change it. All option values are stored by name in the hash 764optionally change it. All option values are stored by name in the hash
… …
717source file \fI/src/optinc.h\fR to see the actual list: 768source file \fI/src/optinc.h\fR to see the actual list:
718.Sp 769.Sp
719.Vb 6 770.Vb 6
720\& borderLess console cursorBlink cursorUnderline hold iconic insecure 771\& borderLess console cursorBlink cursorUnderline hold iconic insecure
721\& intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 772\& intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
722\& pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 773\& override-redirect pastableTabs pointerBlank reverseVideo scrollBar
723\& scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 774\& scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
724\& secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 775\& scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
725\& tripleclickwords utmpInhibit visualBell 776\& transparent tripleclickwords utmpInhibit visualBell
726.Ve 777.Ve
727.ie n .IP "$value = $term\fR\->resource ($name[, \f(CW$newval])" 4 778.ie n .IP "$value = $term\fR\->resource ($name[, \f(CW$newval])" 4
728.el .IP "$value = \f(CW$term\fR\->resource ($name[, \f(CW$newval\fR])" 4 779.el .IP "$value = \f(CW$term\fR\->resource ($name[, \f(CW$newval\fR])" 4
729.IX Item "$value = $term->resource ($name[, $newval])" 780.IX Item "$value = $term->resource ($name[, $newval])"
730Returns the current resource value associated with a given name and 781Returns the current resource value associated with a given name and
… …
744.Sp 795.Sp
745Here is a a likely non-exhaustive list of resource names, not all of which 796Here is a a likely non-exhaustive list of resource names, not all of which
746are supported in every build, please see the source file \fI/src/rsinc.h\fR 797are supported in every build, please see the source file \fI/src/rsinc.h\fR
747to see the actual list: 798to see the actual list:
748.Sp 799.Sp
749.Vb 12 800.Vb 13
750\& answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 801\& answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
751\& borderLess color cursorBlink cursorUnderline cutchars delete_key 802\& borderLess color cursorBlink cursorUnderline cutchars delete_key
752\& display_name embed ext_bwidth fade font geometry hold iconName 803\& display_name embed ext_bwidth fade font geometry hold iconName
753\& imFont imLocale inputMethod insecure int_bwidth intensityStyles 804\& imFont imLocale inputMethod insecure int_bwidth intensityStyles
754\& italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 805\& italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
755\& mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 806\& mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
756\& perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 807\& perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
757\& reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 808\& preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
758\& scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 809\& scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
759\& scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 810\& scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
760\& shade term_name title transparent transparent_all tripleclickwords 811\& secondaryScreen secondaryScroll selectstyle shade term_name title
761\& utmpInhibit visualBell 812\& transient_for transparent transparent_all tripleclickwords utmpInhibit
813\& visualBell
762.Ve 814.Ve
763.ie n .IP "$value = $term\->x_resource ($pattern)" 4 815.ie n .IP "$value = $term\->x_resource ($pattern)" 4
764.el .IP "$value = \f(CW$term\fR\->x_resource ($pattern)" 4 816.el .IP "$value = \f(CW$term\fR\->x_resource ($pattern)" 4
765.IX Item "$value = $term->x_resource ($pattern)" 817.IX Item "$value = $term->x_resource ($pattern)"
766Returns the X\-Resource for the given pattern, excluding the program or 818Returns the X\-Resource for the given pattern, excluding the program or
… …
1201Start the timer. 1253Start the timer.
1202.ie n .IP "$timer = $timer\->start ($tstamp)" 4 1254.ie n .IP "$timer = $timer\->start ($tstamp)" 4
1203.el .IP "$timer = \f(CW$timer\fR\->start ($tstamp)" 4 1255.el .IP "$timer = \f(CW$timer\fR\->start ($tstamp)" 4
1204.IX Item "$timer = $timer->start ($tstamp)" 1256.IX Item "$timer = $timer->start ($tstamp)"
1205Set the event trigger time to \f(CW$tstamp\fR and start the timer. 1257Set the event trigger time to \f(CW$tstamp\fR and start the timer.
1258.ie n .IP "$timer = $timer\->after ($delay)" 4
1259.el .IP "$timer = \f(CW$timer\fR\->after ($delay)" 4
1260.IX Item "$timer = $timer->after ($delay)"
1261Like \f(CW\*(C`start\*(C'\fR, but sets the expiry timer to c<urxvt::NOW + \f(CW$delay\fR>.
1206.ie n .IP "$timer = $timer\->stop" 4 1262.ie n .IP "$timer = $timer\->stop" 4
1207.el .IP "$timer = \f(CW$timer\fR\->stop" 4 1263.el .IP "$timer = \f(CW$timer\fR\->stop" 4
1208.IX Item "$timer = $timer->stop" 1264.IX Item "$timer = $timer->stop"
1209Stop the timer. 1265Stop the timer.
1210.ie n .Sh "The ""urxvt::iow"" Class" 1266.ie n .Sh "The ""urxvt::iow"" Class"

Diff Legend

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