--- rxvt-unicode/doc/rxvtperl.3.html 2006/01/13 01:09:37 1.28 +++ rxvt-unicode/doc/rxvtperl.3.html 2006/01/19 19:26:31 1.33 @@ -122,7 +122,7 @@ interesting uses, such as parsing a line from beginning to end.

-

This extension also offers the following bindable keyboard command:

+

This extension also offers following bindable keyboard commands:

rot13
@@ -149,6 +149,30 @@ text into various other formats/action (such as uri unescaping, perl evalution, web-browser starting etc.), depending on content. +
+

Other extensions can extend this popup menu by pushing a code reference +onto @{ $term-{selection_popup_hook} }>, that is called whenever the +popup is displayed.

+
+
+

It's sole argument is the popup menu, which can be modified. The selection +is in $_, which can be used to decide wether to add something or not. +It should either return nothing or a string and a code reference. The +string will be used as button text and the code reference will be called +when the button gets activated and should transform $_.

+
+
+

The following will add an entry a to b that transforms all as in +the selection to bs, but only if the selection currently contains any +as:

+
+
+
+   push @{ $self->{term}{selection_popup_hook} }, sub {
+      /a/ ? ("a to be" => sub { s/a/b/g }
+          : ()
+   };
+

searchable-scrollback<hotkey> (enabled by default)
@@ -191,7 +215,7 @@
-   URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
+ URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/

And this example matches the same,but replaces it with vi-commands you can @@ -199,7 +223,7 @@

-   URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
+ URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/

Of course, this can be modified to suit your needs and your editor :)

@@ -210,8 +234,8 @@
-   URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
-   URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
+ URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) + URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/

The first line tells the selection code to treat the unchanging part of @@ -228,6 +252,18 @@ the URL as first argument.

+
automove-background
+
+
+This is basically a one-line extension that dynamically changes the background pixmap offset +to the window position, in effect creating the same effect as pseudo transparency with +a custom pixmap. No scaling is supported in this mode. Exmaple: +
+
+
+   rxvt -pixmap background.xpm -pe automove-background
+
+

block-graphics-to-ascii
@@ -249,6 +285,48 @@ window. Illustrates overwriting the refresh callbacks to create your own overlays or changes.
+

+
selection-pastebin
+
+
+This is a little rarely useful extension that Uploads the selection as +textfile to a remote site (or does other things). (The implementation is +not currently secure for use in a multiuser environment as it writes to +/tmp directly.). +
+
+

It listens to the selection-pastebin:remote-pastebin keyboard command, +i.e.

+
+
+
+   URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
+
+
+

Pressing this combination runs a command with % replaced by the name of +the textfile. This command can be set via a resource:

+
+
+
+   URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
+
+
+

And the default is likely not useful to anybody but the few people around +here :)

+
+
+

The name of the textfile is the hex encoded md5 sum of the selection, so +the same content should lead to the same filename.

+
+
+

After a successful upload the selection will be replaced by the text given +in the selection-pastebin-url resource (again, the % is the placeholder +for the filename):

+
+
+
+   URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
+

@@ -362,6 +440,19 @@ returning to the mainloop.

+
on_child_start $term, $pid
+
+
+Called just after the child process has been forked. +
+

+
on_child_exit $term, $status
+
+
+Called just after the child process has exited. $status is the status +from waitpid. +
+

on_sel_make $term, $eventtime
@@ -494,6 +585,14 @@ resource in the rxvt(1) manpage).

+
on_x_event $term, $event
+
+
+Called on every X event received on the vt window (and possibly other +windows). Should only be used as a last resort. Most event structure +members are not passed. +
+

on_focus_in $term
@@ -508,6 +607,8 @@ focus out processing.

+
on_configure_notify $term, $event
+
on_key_press $term, $event, $keysym, $octets
on_key_release $term, $event, $keysym
@@ -596,14 +697,6 @@

Messages have a size limit of 1023 bytes currently.

-
$is_safe = urxvt::safe
-
-
-Returns true when it is safe to do potentially unsafe things, such as -evaluating perl code specified by the user. This is true when urxvt was -started setuid or setgid. -
-

$time = urxvt::NOW
@@ -616,6 +709,22 @@ Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, Button5Mask, AnyModifier
+
urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, +ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, +PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, +Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, +KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, +ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, +FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
+
+
urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, +EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, +GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, +UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, +ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, +CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, +SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
+
Various constants for use in X calls and event processing.
@@ -717,6 +826,18 @@ watchers (timers, io watchers) are still active.

+
$term->exec_async ($cmd[, @args])
+
+
+Works like the combination of the fork/exec builtins, which executes +(``starts'') programs in the background. This function takes care of setting +the user environment before exec'ing the command (e.g. PATH) and should +be preferred over explicit calls to exec or system. +
+
+

Returns the pid of the subprocess or undef on error.

+
+

$isset = $term->option ($optval[, $set])
@@ -732,10 +853,10 @@
  borderLess console cursorBlink cursorUnderline hold iconic insecure
  intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
- pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
- scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
- secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
- tripleclickwords utmpInhibit visualBell
+ override-redirect pastableTabs pointerBlank reverseVideo scrollBar + scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput + scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs + transparent tripleclickwords utmpInhibit visualBell

$value = $term->resource ($name[, $newval])
@@ -770,14 +891,15 @@ borderLess color cursorBlink cursorUnderline cutchars delete_key display_name embed ext_bwidth fade font geometry hold iconName imFont imLocale inputMethod insecure int_bwidth intensityStyles - italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier - mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 - perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd - reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating - scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput - scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle - shade term_name title transparent transparent_all tripleclickwords - utmpInhibit visualBell + italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier + mouseWheelScrollPage name override_redirect pastableTabs path perl_eval + perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay + preeditType print_pipe pty_fd reverseVideo saveLines scrollBar + scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness + scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle + secondaryScreen secondaryScroll selectstyle shade term_name title + transient_for transparent transparent_all tripleclickwords utmpInhibit + visualBell

$value = $term->x_resource ($pattern)
@@ -999,6 +1121,17 @@ Return the window id of the terminal window.

+
$term->vt_emask_add ($x_event_mask)
+
+
+Adds the specified events to the vt event mask. Useful e.g. when you want +to receive pointer events all the times: +
+
+
+   $term->vt_emask_add (urxvt::PointerMotionMask);
+
+

$window_width = $term->width
$window_height = $term->height
@@ -1021,7 +1154,7 @@
$nrow_plus_saveLines = $term->total_rows
-
$lines_in_scrollback = $term->nsaved
+
$topmost_scrollback_row = $term->top_row
Return various integers describing terminal characteristics. @@ -1060,8 +1193,8 @@
$view_start = $term->view_start ([$newvalue])
-Returns the negative row number of the topmost line. Minimum value is -0, which displays the normal terminal contents. Larger values scroll +Returns the row number of the topmost displayed line. Maximum value is +0, which displays the normal terminal contents. Lower values scroll this many lines into the scrollback buffer.

@@ -1082,7 +1215,7 @@ Returns the text of the entire row with number $row_number. Row 0 is the topmost terminal line, row $term->$ncol-1 is the bottommost terminal line. The scrollback buffer starts at line -1 and extends to -line -$term->nsaved. Nothing will be returned if a nonexistent line +line -$term->nsaved. Nothing will be returned if a nonexistent line is requested.
@@ -1339,6 +1472,12 @@ Set the event trigger time to $tstamp and start the timer.

+
$timer = $timer->after ($delay)
+
+
+Like start, but sets the expiry timer to c<urxvt::NOW + $delay>. +
+

$timer = $timer->stop