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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.30 by root, Wed Jan 18 09:40:53 2006 UTC vs.
Revision 1.31 by root, Thu Jan 19 19:26:31 2006 UTC

73 selection-popup (enabled by default) 73 selection-popup (enabled by default)
74 Binds a popup menu to Ctrl-Button3 that lets you convert the 74 Binds a popup menu to Ctrl-Button3 that lets you convert the
75 selection text into various other formats/action (such as uri 75 selection text into various other formats/action (such as uri
76 unescaping, perl evalution, web-browser starting etc.), depending on 76 unescaping, perl evalution, web-browser starting etc.), depending on
77 content. 77 content.
78
79 Other extensions can extend this popup menu by pushing a code
80 reference onto "@{ $term-"{selection_popup_hook} }>, that is called
81 whenever the popup is displayed.
82
83 It's sole argument is the popup menu, which can be modified. The
84 selection is in $_, which can be used to decide wether to add
85 something or not. It should either return nothing or a string and a
86 code reference. The string will be used as button text and the code
87 reference will be called when the button gets activated and should
88 transform $_.
89
90 The following will add an entry "a to b" that transforms all "a"s in
91 the selection to "b"s, but only if the selection currently contains
92 any "a"s:
93
94 push @{ $self->{term}{selection_popup_hook} }, sub {
95 /a/ ? ("a to be" => sub { s/a/b/g }
96 : ()
97 };
78 98
79 searchable-scrollback<hotkey> (enabled by default) 99 searchable-scrollback<hotkey> (enabled by default)
80 Adds regex search functionality to the scrollback buffer, triggered 100 Adds regex search functionality to the scrollback buffer, triggered
81 by a hotkey (default: "M-s"). While in search mode, normal terminal 101 by a hotkey (default: "M-s"). While in search mode, normal terminal
82 input/output is suspended and a regex is displayed at the bottom of 102 input/output is suspended and a regex is displayed at the bottom of
108 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ 128 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
109 129
110 And this example matches the same,but replaces it with vi-commands 130 And this example matches the same,but replaces it with vi-commands
111 you can paste directly into your (vi :) editor: 131 you can paste directly into your (vi :) editor:
112 132
113 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 133 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
114 134
115 Of course, this can be modified to suit your needs and your editor 135 Of course, this can be modified to suit your needs and your editor
116 :) 136 :)
117 137
118 To expand the example above to typical perl error messages ("XXX at 138 To expand the example above to typical perl error messages ("XXX at
119 FILENAME line YYY."), you need a slightly more elaborate solution: 139 FILENAME line YYY."), you need a slightly more elaborate solution:
120 140
121 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 141 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
122 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ 142 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
123 143
124 The first line tells the selection code to treat the unchanging part 144 The first line tells the selection code to treat the unchanging part
125 of every error message as a selection pattern, and the second line 145 of every error message as a selection pattern, and the second line
126 transforms the message into vi commands to load the file. 146 transforms the message into vi commands to load the file.
127 147
128 mark-urls 148 mark-urls
129 Uses per-line display filtering ("on_line_update") to underline urls 149 Uses per-line display filtering ("on_line_update") to underline urls
130 and make them clickable. When middle-clicked, the program specified 150 and make them clickable. When middle-clicked, the program specified
131 in the resource "urlLauncher" (default "x-www-browser") will be 151 in the resource "urlLauncher" (default "x-www-browser") will be
132 started with the URL as first argument. 152 started with the URL as first argument.
153
154 automove-background
155 This is basically a one-line extension that dynamically changes the
156 background pixmap offset to the window position, in effect creating
157 the same effect as pseudo transparency with a custom pixmap. No
158 scaling is supported in this mode. Exmaple:
159
160 rxvt -pixmap background.xpm -pe automove-background
133 161
134 block-graphics-to-ascii 162 block-graphics-to-ascii
135 A not very useful example of filtering all text output to the 163 A not very useful example of filtering all text output to the
136 terminal, by replacing all line-drawing characters (U+2500 .. 164 terminal, by replacing all line-drawing characters (U+2500 ..
137 U+259F) by a similar-looking ascii character. 165 U+259F) by a similar-looking ascii character.
254 size-related variables. 282 size-related variables.
255 283
256 on_start $term 284 on_start $term
257 Called at the very end of initialisation of a new terminal, just 285 Called at the very end of initialisation of a new terminal, just
258 before returning to the mainloop. 286 before returning to the mainloop.
287
288 on_child_start $term, $pid
289 Called just after the child process has been "fork"ed.
290
291 on_child_exit $term, $status
292 Called just after the child process has exited. $status is the
293 status from "waitpid".
259 294
260 on_sel_make $term, $eventtime 295 on_sel_make $term, $eventtime
261 Called whenever a selection has been made by the user, but before 296 Called whenever a selection has been made by the user, but before
262 the selection text is copied, so changes to the beginning, end or 297 the selection text is copied, so changes to the beginning, end or
263 type of the selection will be honored. 298 type of the selection will be honored.
361 396
362 on_focus_out $term 397 on_focus_out $term
363 Called wheneever the window loses keyboard focus, before 398 Called wheneever the window loses keyboard focus, before
364 rxvt-unicode does focus out processing. 399 rxvt-unicode does focus out processing.
365 400
401 on_configure_notify $term, $event
366 on_key_press $term, $event, $keysym, $octets 402 on_key_press $term, $event, $keysym, $octets
367 on_key_release $term, $event, $keysym 403 on_key_release $term, $event, $keysym
368 on_button_press $term, $event 404 on_button_press $term, $event
369 on_button_release $term, $event 405 on_button_release $term, $event
370 on_motion_notify $term, $event 406 on_motion_notify $term, $event
500 $term->destroy 536 $term->destroy
501 Destroy the terminal object (close the window, free resources etc.). 537 Destroy the terminal object (close the window, free resources etc.).
502 Please note that rxvt will not exit as long as any event watchers 538 Please note that rxvt will not exit as long as any event watchers
503 (timers, io watchers) are still active. 539 (timers, io watchers) are still active.
504 540
541 $term->exec_async ($cmd[, @args])
542 Works like the combination of the "fork"/"exec" builtins, which
543 executes ("starts") programs in the background. This function takes
544 care of setting the user environment before exec'ing the command
545 (e.g. "PATH") and should be preferred over explicit calls to "exec"
546 or "system".
547
548 Returns the pid of the subprocess or "undef" on error.
549
505 $isset = $term->option ($optval[, $set]) 550 $isset = $term->option ($optval[, $set])
506 Returns true if the option specified by $optval is enabled, and 551 Returns true if the option specified by $optval is enabled, and
507 optionally change it. All option values are stored by name in the 552 optionally change it. All option values are stored by name in the
508 hash %urxvt::OPTION. Options not enabled in this binary are not in 553 hash %urxvt::OPTION. Options not enabled in this binary are not in
509 the hash. 554 the hash.
511 Here is a a likely non-exhaustive list of option names, please see 556 Here is a a likely non-exhaustive list of option names, please see
512 the source file /src/optinc.h to see the actual list: 557 the source file /src/optinc.h to see the actual list:
513 558
514 borderLess console cursorBlink cursorUnderline hold iconic insecure 559 borderLess console cursorBlink cursorUnderline hold iconic insecure
515 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 560 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
516 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 561 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
517 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 562 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
518 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 563 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
519 tripleclickwords utmpInhibit visualBell 564 transparent tripleclickwords utmpInhibit visualBell
520 565
521 $value = $term->resource ($name[, $newval]) 566 $value = $term->resource ($name[, $newval])
522 Returns the current resource value associated with a given name and 567 Returns the current resource value associated with a given name and
523 optionally sets a new value. Setting values is most useful in the 568 optionally sets a new value. Setting values is most useful in the
524 "init" hook. Unset resources are returned and accepted as "undef". 569 "init" hook. Unset resources are returned and accepted as "undef".
541 586
542 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 587 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
543 borderLess color cursorBlink cursorUnderline cutchars delete_key 588 borderLess color cursorBlink cursorUnderline cutchars delete_key
544 display_name embed ext_bwidth fade font geometry hold iconName 589 display_name embed ext_bwidth fade font geometry hold iconName
545 imFont imLocale inputMethod insecure int_bwidth intensityStyles 590 imFont imLocale inputMethod insecure int_bwidth intensityStyles
546 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 591 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
547 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 592 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
548 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 593 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
549 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 594 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
550 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 595 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
551 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 596 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
597 secondaryScreen secondaryScroll selectstyle shade term_name title
552 shade term_name title transparent transparent_all tripleclickwords 598 transient_for transparent transparent_all tripleclickwords utmpInhibit
553 utmpInhibit visualBell 599 visualBell
554 600
555 $value = $term->x_resource ($pattern) 601 $value = $term->x_resource ($pattern)
556 Returns the X-Resource for the given pattern, excluding the program 602 Returns the X-Resource for the given pattern, excluding the program
557 or class name, i.e. "$term->x_resource ("boldFont")" should return 603 or class name, i.e. "$term->x_resource ("boldFont")" should return
558 the same value as used by this instance of rxvt-unicode. Returns 604 the same value as used by this instance of rxvt-unicode. Returns
903 Start the timer. 949 Start the timer.
904 950
905 $timer = $timer->start ($tstamp) 951 $timer = $timer->start ($tstamp)
906 Set the event trigger time to $tstamp and start the timer. 952 Set the event trigger time to $tstamp and start the timer.
907 953
954 $timer = $timer->after ($delay)
955 Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
956
908 $timer = $timer->stop 957 $timer = $timer->stop
909 Stop the timer. 958 Stop the timer.
910 959
911 The "urxvt::iow" Class 960 The "urxvt::iow" Class
912 This class implements io watchers/events. Example: 961 This class implements io watchers/events. Example:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines