From: root Date: Tue, 3 Jan 2006 21:15:22 +0000 (+0000) Subject: *** empty log message *** X-Git-Url: http://git.openbox.org/?a=commitdiff_plain;h=8f671d122676f33a15f5c87588212a8613cacb1e;p=dana%2Furxvt.git *** empty log message *** --- diff --git a/doc/rxvt.1.html b/doc/rxvt.1.html index f39e2e38..91965c16 100644 --- a/doc/rxvt.1.html +++ b/doc/rxvt.1.html @@ -1431,7 +1431,9 @@ info):

Colon-separated list of perl extension scripts to use in this terminal instance. Each extension is looked up in the library directories, loaded -if necessary, and bound to the current terminal instance; option -pe. +if necessary, and bound to the current terminal instance. If this resource +is empty or missing, then the perl interpreter will not be initialized; +option -pe.

perl-eval: string
diff --git a/doc/rxvt.1.man.in b/doc/rxvt.1.man.in index 979dbce9..e74d19be 100644 --- a/doc/rxvt.1.man.in +++ b/doc/rxvt.1.man.in @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "rxvt 1" -.TH rxvt 1 "2006-01-02" "6.2" "RXVT-UNICODE" +.TH rxvt 1 "2006-01-03" "6.2" "RXVT-UNICODE" .SH "NAME" rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) .SH "SYNOPSIS" @@ -1093,7 +1093,9 @@ info): .IX Item "perl-ext: string" Colon-separated list of perl extension scripts to use in this terminal instance. Each extension is looked up in the library directories, loaded -if necessary, and bound to the current terminal instance; option \fB\-pe\fR. +if necessary, and bound to the current terminal instance. If this resource +is empty or missing, then the perl interpreter will not be initialized; +option \fB\-pe\fR. .IP "\fBperl-eval\fR: \fIstring\fR" 4 .IX Item "perl-eval: string" Perl code to be evaluated when all extensions have been registered. See the diff --git a/doc/rxvt.1.txt b/doc/rxvt.1.txt index 10a02467..8fb71b41 100644 --- a/doc/rxvt.1.txt +++ b/doc/rxvt.1.txt @@ -930,7 +930,8 @@ RESOURCES (available also as long-options) Colon-separated list of perl extension scripts to use in this terminal instance. Each extension is looked up in the library directories, loaded if necessary, and bound to the current terminal - instance; option -pe. + instance. If this resource is empty or missing, then the perl + interpreter will not be initialized; option -pe. perl-eval: *string* Perl code to be evaluated when all extensions have been registered. diff --git a/doc/rxvtperl.3.html b/doc/rxvtperl.3.html index e6077677..06c21f16 100644 --- a/doc/rxvtperl.3.html +++ b/doc/rxvtperl.3.html @@ -20,6 +20,7 @@
  • Prepackaged Extensions
  • General API Considerations
  • Hooks
    • +
  • Variables in the urxvt Package
  • Functions in the urxvt Package
  • RENDITION
  • The urxvt::term Class
    • @@ -80,7 +81,11 @@ find them in /opt/rxvt/lib/urxvt/perl/.

    selection
    -Miscellaneous selection modifications. +Intelligent selection. This etxension tries to be more intelligent when the user +extends selections (double-click). +
    +
    +

    It also offers the following bindable event:

    rot13
    @@ -113,7 +118,7 @@ overlays or changes.

    All objects (such as terminals, time watchers etc.) are typical reference-to-hash objects. The hash can be used to store anything you like. All members starting with an underscore (such as _ptr or -_hook) are reserved for internal uses and must not be accessed or +_hook) are reserved for internal uses and MUST NOT be accessed or modified).

    When objects are destroyed on the C++ side, the perl object hashes are emptied, so its best to store related objects such as time watchers and @@ -122,8 +127,13 @@ terminal is destroyed.

    Hooks

    -

    The following subroutines can be declared in loaded scripts, and will be called -whenever the relevant event happens.

    +

    The following subroutines can be declared in loaded scripts, and will be +called whenever the relevant event happens.

    +

    The first argument passed to them is an object private to each terminal +and extension package. You can call all urxvt::term methods on it, but +its not a real urxvt::term object. Instead, the real urxvt::term +object that is shared between all packages is stored in the term +member.

    All of them must return a boolean value. If it is true, then the event counts as being consumed, and the invocation of other hooks is skipped, and the relevant action might not be carried out by the C++ code.

    @@ -174,6 +184,18 @@ by calling $term->selection.

    Returning a true value aborts selection grabbing. It will still be hilighted.

    +
    on_sel_extend $term
    +
    +
    +Called whenever the user tries to extend the selection (e.g. with a double +click) and is either supposed to return false (normal operation), or +should extend the selection itelf and return true to suppress the built-in +processing. +
    +
    +

    See the selection example extension.

    +
    +

    on_focus_in $term
    @@ -240,6 +262,17 @@ resource in the rxvt(1) manpage).

    +

    Variables in the urxvt Package

    +
    +
    $urxvt::TERM
    +
    +
    +The current terminal. Whenever a callback/Hook is bein executed, this +variable stores the current urxvt::term object. +
    +

    +

    +

    Functions in the urxvt Package

    urxvt::fatal $errormessage
    @@ -449,9 +482,9 @@ right/bottom side, respectively.

    as long as the perl object is referenced.

    -

    Currently, the only method on the urxvt::overlay object is set:

    +

    The methods currently supported on urxvt::overlay objects are:

    -

    +
    $overlay->set ($x, $y, $text, $rend)
    @@ -460,6 +493,18 @@ text in rxvt-unicode's special encoding and an array of rendition values at a specific position inside the overlay.

    +
    $overlay->hide
    +
    +
    +If visible, hide the overlay, but do not destroy it. +
    +

    +
    $overlay->show
    +
    +
    +If hidden, display the overlay again. +
    +

    $cellwidth = $term->strwidth $string
    @@ -527,7 +572,8 @@ differ, it redraws the differences. 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. +line -$term->nsaved. Nothing will be returned if a nonexistent line +is requested.

    If $new_text is specified, it will replace characters in the current @@ -548,7 +594,7 @@ that substr and similar functions work on screen cells and not on characters.

    -

    The methods $term->special_encode and $term->special_decode +

    The methods $term->special_encode and $term->special_decode can be used to convert normal strings into this encoding and vice versa.

    @@ -569,12 +615,69 @@ styles and similar information. See also $term->R
    $length = $term->ROW_l ($row_number[, $new_length])
    -Returns the number of screen cells that are in use (``the line length''). If -it is -1, then the line is part of a multiple-row logical ``line'', which -means all characters are in use and it is continued on the next row. +Returns the number of screen cells that are in use (``the line +length''). Unlike the urxvt core, this returns $term->ncol if the +line is joined with the following one. +
    +

    +
    $bool = $term->is_longer ($row_number)
    +
    +
    +Returns true if the row is part of a multiple-row logical ``line'' (i.e. +joined with the following row), which means all characters are in use +and it is continued on the next row (and possibly a continuation of the +previous row(s)).

    -
    $text = $term->special_encode $string
    +
    $line = $term->line ($row_number)
    +
    +
    +Create and return a new urxvt::line object that stores information +about the logical line that row $row_number is part of. It supports the +following methods: +
    +
    +
    $text = $line->t
    +
    +
    +Returns the full text of the line, similar to ROW_t +
    +

    +
    $rend = $line->r
    +
    +
    +Returns the full rendition array of the line, similar to ROW_r +
    +

    +
    $length = $line->l
    +
    +
    +Returns the length of the line in cells, similar to ROW_l. +
    +

    +
    $rownum = $line->beg
    +
    +
    $rownum = $line->end
    +
    +
    +Return the row number of the first/last row of the line, respectively. +
    +

    +
    $offset = $line->offset_of ($row, $col)
    +
    +
    +Returns the character offset of the given row|col pair within the logical +line. +
    +

    +
    ($row, $col) = $line->coord_of ($offset)
    +
    +
    +Translates a string offset into terminal coordinates again. +
    +

    +
    ($row, $col) = $line->coord_of ($offset) +=item $text = $term->special_encode $string
    Converts a perl string into the special encoding used by rxvt-unicode, diff --git a/doc/rxvtperl.3.man.in b/doc/rxvtperl.3.man.in index 008aef02..61a36094 100644 --- a/doc/rxvtperl.3.man.in +++ b/doc/rxvtperl.3.man.in @@ -174,7 +174,10 @@ You can activate them like this: .Ve .IP "selection" 4 .IX Item "selection" -Miscellaneous selection modifications. +Intelligent selection. This etxension tries to be more intelligent when the user +extends selections (double\-click). +.Sp +It also offers the following bindable event: .RS 4 .IP "rot13" 4 .IX Item "rot13" @@ -199,7 +202,7 @@ overlays or changes. All objects (such as terminals, time watchers etc.) are typical reference-to-hash objects. The hash can be used to store anything you like. All members starting with an underscore (such as \f(CW\*(C`_ptr\*(C'\fR or -\&\f(CW\*(C`_hook\*(C'\fR) are reserved for internal uses and must not be accessed or +\&\f(CW\*(C`_hook\*(C'\fR) are reserved for internal uses and \fB\s-1MUST\s0 \s-1NOT\s0\fR be accessed or modified). .PP When objects are destroyed on the \*(C+ side, the perl object hashes are @@ -208,8 +211,14 @@ the like inside the terminal object so they get destroyed as soon as the terminal is destroyed. .Sh "Hooks" .IX Subsection "Hooks" -The following subroutines can be declared in loaded scripts, and will be called -whenever the relevant event happens. +The following subroutines can be declared in loaded scripts, and will be +called whenever the relevant event happens. +.PP +The first argument passed to them is an object private to each terminal +and extension package. You can call all \f(CW\*(C`urxvt::term\*(C'\fR methods on it, but +its not a real \f(CW\*(C`urxvt::term\*(C'\fR object. Instead, the real \f(CW\*(C`urxvt::term\*(C'\fR +object that is shared between all packages is stored in the \f(CW\*(C`term\*(C'\fR +member. .PP All of them must return a boolean value. If it is true, then the event counts as being \fIconsumed\fR, and the invocation of other hooks is skipped, @@ -249,6 +258,15 @@ requested from the server. The selection text can be queried and changed by calling \f(CW\*(C`$term\->selection\*(C'\fR. .Sp Returning a true value aborts selection grabbing. It will still be hilighted. +.ie n .IP "on_sel_extend $term" 4 +.el .IP "on_sel_extend \f(CW$term\fR" 4 +.IX Item "on_sel_extend $term" +Called whenever the user tries to extend the selection (e.g. with a double +click) and is either supposed to return false (normal operation), or +should extend the selection itelf and return true to suppress the built-in +processing. +.Sp +See the \fIselection\fR example extension. .ie n .IP "on_focus_in $term" 4 .el .IP "on_focus_in \f(CW$term\fR" 4 .IX Item "on_focus_in $term" @@ -296,6 +314,13 @@ Called just after the screen gets redrawn. See \f(CW\*(C`on_refresh_begin\*(C'\f Called whenever the user presses a key combination that has a \&\f(CW\*(C`perl:string\*(C'\fR action bound to it (see description of the \fBkeysym\fR resource in the @@RXVT_NAME@@(1) manpage). +.ie n .Sh "Variables in the ""urxvt"" Package" +.el .Sh "Variables in the \f(CWurxvt\fP Package" +.IX Subsection "Variables in the urxvt Package" +.IP "$urxvt::TERM" 4 +.IX Item "$urxvt::TERM" +The current terminal. Whenever a callback/Hook is bein executed, this +variable stores the current \f(CW\*(C`urxvt::term\*(C'\fR object. .ie n .Sh "Functions in the ""urxvt"" Package" .el .Sh "Functions in the \f(CWurxvt\fP Package" .IX Subsection "Functions in the urxvt Package" @@ -470,13 +495,23 @@ right/bottom side, respectively. This method returns an urxvt::overlay object. The overlay will be visible as long as the perl object is referenced. .Sp -Currently, the only method on the \f(CW\*(C`urxvt::overlay\*(C'\fR object is \f(CW\*(C`set\*(C'\fR: +The methods currently supported on \f(CW\*(C`urxvt::overlay\*(C'\fR objects are: +.RS 4 .ie n .IP "$overlay\->set ($x, $y\fR, \f(CW$text\fR, \f(CW$rend)" 4 .el .IP "$overlay\->set ($x, \f(CW$y\fR, \f(CW$text\fR, \f(CW$rend\fR)" 4 .IX Item "$overlay->set ($x, $y, $text, $rend)" Similar to \f(CW\*(C`$term\->ROW_t\*(C'\fR and \f(CW\*(C`$term\->ROW_r\*(C'\fR in that it puts text in rxvt\-unicode's special encoding and an array of rendition values at a specific position inside the overlay. +.IP "$overlay\->hide" 4 +.IX Item "$overlay->hide" +If visible, hide the overlay, but do not destroy it. +.IP "$overlay\->show" 4 +.IX Item "$overlay->show" +If hidden, display the overlay again. +.RE +.RS 4 +.RE .ie n .IP "$cellwidth = $term\fR\->strwidth \f(CW$string" 4 .el .IP "$cellwidth = \f(CW$term\fR\->strwidth \f(CW$string\fR" 4 .IX Item "$cellwidth = $term->strwidth $string" @@ -528,7 +563,8 @@ Used after changing terminal contents to display them. Returns the text of the entire row with number \f(CW$row_number\fR. Row \f(CW0\fR is the topmost terminal line, row \f(CW\*(C`$term\->$ncol\-1\*(C'\fR is the bottommost terminal line. The scrollback buffer starts at line \f(CW\*(C`\-1\*(C'\fR and extends to -line \f(CW\*(C`\-$term\->nsaved\*(C'\fR. +line \f(CW\*(C`\-$term\->nsaved\*(C'\fR. Nothing will be returned if a nonexistent line +is requested. .Sp If \f(CW$new_text\fR is specified, it will replace characters in the current line, starting at column \f(CW$start_col\fR (default \f(CW0\fR), which is useful @@ -560,12 +596,59 @@ See the section on \s-1RENDITION\s0, above. .ie n .IP "$length = $term\fR\->ROW_l ($row_number[, \f(CW$new_length])" 4 .el .IP "$length = \f(CW$term\fR\->ROW_l ($row_number[, \f(CW$new_length\fR])" 4 .IX Item "$length = $term->ROW_l ($row_number[, $new_length])" -Returns the number of screen cells that are in use (\*(L"the line length\*(R"). If -it is \f(CW\*(C`\-1\*(C'\fR, then the line is part of a multiple-row logical \*(L"line\*(R", which -means all characters are in use and it is continued on the next row. -.ie n .IP "$text = $term\fR\->special_encode \f(CW$string" 4 -.el .IP "$text = \f(CW$term\fR\->special_encode \f(CW$string\fR" 4 -.IX Item "$text = $term->special_encode $string" +Returns the number of screen cells that are in use (\*(L"the line +length\*(R"). Unlike the urxvt core, this returns \f(CW\*(C`$term\->ncol\*(C'\fR if the +line is joined with the following one. +.ie n .IP "$bool = $term\->is_longer ($row_number)" 4 +.el .IP "$bool = \f(CW$term\fR\->is_longer ($row_number)" 4 +.IX Item "$bool = $term->is_longer ($row_number)" +Returns true if the row is part of a multiple-row logical \*(L"line\*(R" (i.e. +joined with the following row), which means all characters are in use +and it is continued on the next row (and possibly a continuation of the +previous row(s)). +.ie n .IP "$line = $term\->line ($row_number)" 4 +.el .IP "$line = \f(CW$term\fR\->line ($row_number)" 4 +.IX Item "$line = $term->line ($row_number)" +Create and return a new \f(CW\*(C`urxvt::line\*(C'\fR object that stores information +about the logical line that row \f(CW$row_number\fR is part of. It supports the +following methods: +.RS 4 +.ie n .IP "$text = $line\->t" 4 +.el .IP "$text = \f(CW$line\fR\->t" 4 +.IX Item "$text = $line->t" +Returns the full text of the line, similar to \f(CW\*(C`ROW_t\*(C'\fR +.ie n .IP "$rend = $line\->r" 4 +.el .IP "$rend = \f(CW$line\fR\->r" 4 +.IX Item "$rend = $line->r" +Returns the full rendition array of the line, similar to \f(CW\*(C`ROW_r\*(C'\fR +.ie n .IP "$length = $line\->l" 4 +.el .IP "$length = \f(CW$line\fR\->l" 4 +.IX Item "$length = $line->l" +Returns the length of the line in cells, similar to \f(CW\*(C`ROW_l\*(C'\fR. +.ie n .IP "$rownum = $line\->beg" 4 +.el .IP "$rownum = \f(CW$line\fR\->beg" 4 +.IX Item "$rownum = $line->beg" +.PD 0 +.ie n .IP "$rownum = $line\->end" 4 +.el .IP "$rownum = \f(CW$line\fR\->end" 4 +.IX Item "$rownum = $line->end" +.PD +Return the row number of the first/last row of the line, respectively. +.ie n .IP "$offset = $line\fR\->offset_of ($row, \f(CW$col)" 4 +.el .IP "$offset = \f(CW$line\fR\->offset_of ($row, \f(CW$col\fR)" 4 +.IX Item "$offset = $line->offset_of ($row, $col)" +Returns the character offset of the given row|col pair within the logical +line. +.ie n .IP "($row, $col\fR) = \f(CW$line\->coord_of ($offset)" 4 +.el .IP "($row, \f(CW$col\fR) = \f(CW$line\fR\->coord_of ($offset)" 4 +.IX Item "($row, $col) = $line->coord_of ($offset)" +Translates a string offset into terminal coordinates again. +.RE +.RS 4 +.RE +.ie n .IP "($row, $col\fR) = \f(CW$line\fR\->coord_of ($offset) =item \f(CW$text\fR = \f(CW$term\fR\->special_encode \f(CW$string" 4 +.el .IP "($row, \f(CW$col\fR) = \f(CW$line\fR\->coord_of ($offset) =item \f(CW$text\fR = \f(CW$term\fR\->special_encode \f(CW$string\fR" 4 +.IX Item "($row, $col) = $line->coord_of ($offset) =item $text = $term->special_encode $string" Converts a perl string into the special encoding used by rxvt\-unicode, where one character corresponds to one screen cell. See \&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. diff --git a/doc/rxvtperl.3.txt b/doc/rxvtperl.3.txt index 1233fab6..85258740 100644 --- a/doc/rxvtperl.3.txt +++ b/doc/rxvtperl.3.txt @@ -32,7 +32,10 @@ DESCRIPTION rxvt -pe selection - Miscellaneous selection modifications. + Intelligent selection. This etxension tries to be more intelligent + when the user extends selections (double-click). + + It also offers the following bindable event: rot13 Rot-13 the selection when activated. Used via keyboard trigger: @@ -51,7 +54,7 @@ DESCRIPTION All objects (such as terminals, time watchers etc.) are typical reference-to-hash objects. The hash can be used to store anything you like. All members starting with an underscore (such as "_ptr" or - "_hook") are reserved for internal uses and must not be accessed or + "_hook") are reserved for internal uses and MUST NOT be accessed or modified). When objects are destroyed on the C++ side, the perl object hashes are @@ -63,6 +66,12 @@ DESCRIPTION The following subroutines can be declared in loaded scripts, and will be called whenever the relevant event happens. + The first argument passed to them is an object private to each terminal + and extension package. You can call all "urxvt::term" methods on it, but + its not a real "urxvt::term" object. Instead, the real "urxvt::term" + object that is shared between all packages is stored in the "term" + member. + All of them must return a boolean value. If it is true, then the event counts as being *consumed*, and the invocation of other hooks is skipped, and the relevant action might not be carried out by the C++ @@ -100,6 +109,14 @@ DESCRIPTION Returning a true value aborts selection grabbing. It will still be hilighted. + on_sel_extend $term + Called whenever the user tries to extend the selection (e.g. with a + double click) and is either supposed to return false (normal + operation), or should extend the selection itelf and return true to + suppress the built-in processing. + + See the selection example extension. + on_focus_in $term Called whenever the window gets the keyboard focus, before urxvt does focus in processing. @@ -140,6 +157,11 @@ DESCRIPTION "perl:string" action bound to it (see description of the keysym resource in the rxvt(1) manpage). + Variables in the "urxvt" Package + $urxvt::TERM + The current terminal. Whenever a callback/Hook is bein executed, + this variable stores the current "urxvt::term" object. + Functions in the "urxvt" Package urxvt::fatal $errormessage Fatally aborts execution with the given error message. Avoid at all @@ -275,12 +297,18 @@ DESCRIPTION This method returns an urxvt::overlay object. The overlay will be visible as long as the perl object is referenced. - Currently, the only method on the "urxvt::overlay" object is "set": + The methods currently supported on "urxvt::overlay" objects are: + + $overlay->set ($x, $y, $text, $rend) + Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts + text in rxvt-unicode's special encoding and an array of + rendition values at a specific position inside the overlay. - $overlay->set ($x, $y, $text, $rend) - Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts text in - rxvt-unicode's special encoding and an array of rendition values at - a specific position inside the overlay. + $overlay->hide + If visible, hide the overlay, but do not destroy it. + + $overlay->show + If hidden, display the overlay again. $cellwidth = $term->strwidth $string Returns the number of screen-cells this string would need. Correctly @@ -323,7 +351,8 @@ DESCRIPTION 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". + to line "-$term->nsaved". Nothing will be returned if a nonexistent + line is requested. If $new_text is specified, it will replace characters in the current line, starting at column $start_col (default 0), which is useful to @@ -354,11 +383,43 @@ DESCRIPTION $length = $term->ROW_l ($row_number[, $new_length]) Returns the number of screen cells that are in use ("the line - length"). If it is -1, then the line is part of a multiple-row - logical "line", which means all characters are in use and it is - continued on the next row. + length"). Unlike the urxvt core, this returns "$term->ncol" if the + line is joined with the following one. + + $bool = $term->is_longer ($row_number) + Returns true if the row is part of a multiple-row logical "line" + (i.e. joined with the following row), which means all characters are + in use and it is continued on the next row (and possibly a + continuation of the previous row(s)). + + $line = $term->line ($row_number) + Create and return a new "urxvt::line" object that stores information + about the logical line that row $row_number is part of. It supports + the following methods: + + $text = $line->t + Returns the full text of the line, similar to "ROW_t" + + $rend = $line->r + Returns the full rendition array of the line, similar to "ROW_r" + + $length = $line->l + Returns the length of the line in cells, similar to "ROW_l". + + $rownum = $line->beg + $rownum = $line->end + Return the row number of the first/last row of the line, + respectively. + + $offset = $line->offset_of ($row, $col) + Returns the character offset of the given row|col pair within + the logical line. + + ($row, $col) = $line->coord_of ($offset) + Translates a string offset into terminal coordinates again. - $text = $term->special_encode $string + ($row, $col) = $line->coord_of ($offset) =item $text = + $term->special_encode $string Converts a perl string into the special encoding used by rxvt-unicode, where one character corresponds to one screen cell. See "$term->ROW_t" for details.