*** empty log message ***
authorroot <root>
Mon, 2 Jan 2006 21:41:51 +0000 (21:41 +0000)
committerroot <root>
Mon, 2 Jan 2006 21:41:51 +0000 (21:41 +0000)
doc/rxvt.1.html
doc/rxvt.1.man.in
doc/rxvt.1.pod
doc/rxvt.1.txt
doc/rxvt.7.html
doc/rxvt.7.man.in
doc/rxvt.7.pod
doc/rxvtperl.3.html
doc/rxvtperl.3.man.in
doc/rxvtperl.3.txt
src/urxvt.pm

index 54778b60d00f1ad190d57168d68db9da923d0b3c..f39e2e3802c521f0b60615b788ece9999d74ae38 100644 (file)
@@ -1373,6 +1373,16 @@ when Control-Meta-c is being pressed'':</p>
   URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
 </dd>
 <dd>
+<p>If <em>string</em> takes the form <code>perl:STRING</code>, then the specified <strong>STRING</strong>
+is passed to the <code>on_keyboard_command</code> perl handler. See the <code>rxvtperl(3)</code>
+manpage. For example, the <em>selection</em> extension (activated via
+<code>rxvt -pe selection</code>) listens for <code>selection:rot13</code> events:</p>
+</dd>
+<dd>
+<pre>
+  URxvt.keysym.M-C-c: perl:selection:rot13</pre>
+</dd>
+<dd>
 <p>Due the the large number of modifier combinations, a defined key mapping
 will match if at <em>at least</em> the specified identifiers are being set, and
 no other key mappings with those and more bits are being defined. That
@@ -1437,7 +1447,7 @@ Perl code to be evaluated when all extensions have been registered. See the
 Colon-separated list of additional directories that hold extension
 scripts. When looking for extensions specified by the <code>perl</code> resource,
 rxvt will first look in these directories and then in
-<em>/opt/rxvt/lib/urxvt/perl-ext/</em>.
+<em>/opt/rxvt/lib/urxvt/perl/</em>.
 </dd>
 <dd>
 <p>See the <code>rxvtperl(3)</code> manpage.</p>
index 4f120826ca545ebf333334ad24fef82681550e9d..979dbce9d6ffc2ac79ddc7b01ee772a0b030b917 100644 (file)
@@ -1043,6 +1043,15 @@ when Control-Meta-c is being pressed":
 \&  URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
 .Ve
 .Sp
+If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR
+is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3)
+manpage. For example, the \fIselection\fR extension (activated via
+\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
+.Sp
+.Vb 1
+\&  URxvt.keysym.M-C-c: perl:selection:rot13
+.Ve
+.Sp
 Due the the large number of modifier combinations, a defined key mapping
 will match if at \fIat least\fR the specified identifiers are being set, and
 no other key mappings with those and more bits are being defined. That
@@ -1088,15 +1097,15 @@ if necessary, and bound to the current terminal instance; 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
-\&\fIrxvtperl\fR\|(3) manpage.
+@@RXVT_NAME@@\fIperl\fR\|(3) manpage.
 .IP "\fBperl-lib\fR: \fIpath\fR" 4
 .IX Item "perl-lib: path"
 Colon-separated list of additional directories that hold extension
 scripts. When looking for extensions specified by the \f(CW\*(C`perl\*(C'\fR resource,
 @@RXVT_NAME@@ will first look in these directories and then in
-\&\fI@@RXVT_LIBDIR@@/urxvt/perl\-ext/\fR.
+\&\fI@@RXVT_LIBDIR@@/urxvt/perl/\fR.
 .Sp
-See the \fIrxvtperl\fR\|(3) manpage.
+See the @@RXVT_NAME@@\fIperl\fR\|(3) manpage.
 .SH "THE SCROLLBAR"
 .IX Header "THE SCROLLBAR"
 Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
index d8567a2b8f79add6df68852e3abac3ce5378e215..82f8687c2ad11d2a7cbb51b8160528f37fc25f31 100644 (file)
@@ -1025,7 +1025,7 @@ when Control-Meta-c is being pressed":
   URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
 
 If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
-is passed to the C<on_keyboard_command> perl handler. See the rxvtperl(3)
+is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
 manpage. For example, the F<selection> extension (activated via
 C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
 
@@ -1072,7 +1072,7 @@ if necessary, and bound to the current terminal instance; option B<-pe>.
 =item B<perl-eval>: I<string>
 
 Perl code to be evaluated when all extensions have been registered. See the
-rxvtperl(3) manpage.
+@@RXVT_NAME@@perl(3) manpage.
 
 =item B<perl-lib>: I<path>
 
@@ -1081,7 +1081,7 @@ scripts. When looking for extensions specified by the C<perl> resource,
 @@RXVT_NAME@@ will first look in these directories and then in
 F<@@RXVT_LIBDIR@@/urxvt/perl/>.
 
-See the rxvtperl(3) manpage.
+See the @@RXVT_NAME@@perl(3) manpage.
 
 =back
 
index 458d2e4b2135e3bad97afb0d62c9a5593965ae0b..10a024676fdc05910536d68842356fb450f65ae2 100644 (file)
@@ -887,6 +887,13 @@ RESOURCES (available also as long-options)
 
           URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
 
+        If *string* takes the form "perl:STRING", then the specified STRING
+        is passed to the "on_keyboard_command" perl handler. See the
+        rxvtperl(3) manpage. For example, the selection extension (activated
+        via "rxvt -pe selection") listens for "selection:rot13" events:
+
+          URxvt.keysym.M-C-c: perl:selection:rot13
+
         Due the the large number of modifier combinations, a defined key
         mapping will match if at *at least* the specified identifiers are
         being set, and no other key mappings with those and more bits are
@@ -933,7 +940,7 @@ RESOURCES (available also as long-options)
         Colon-separated list of additional directories that hold extension
         scripts. When looking for extensions specified by the "perl"
         resource, rxvt will first look in these directories and then in
-        /opt/rxvt/lib/urxvt/perl-ext/.
+        /opt/rxvt/lib/urxvt/perl/.
 
         See the rxvtperl(3) manpage.
 
index 1db0e95fc227b286226e601f1e6b9a1ba5fce94c..6be04898697e47f546f6f87374ded27505c7cc86 100644 (file)
@@ -3019,9 +3019,9 @@ Add support to have the pointer disappear when typing or inactive.
 <dt><strong><a name="item_perl">--enable-perl (default: off)</a></strong><br />
 </dt>
 <dd>
-Enable an embedded perl interpreter. See the <strong>rxvtperl(3)</strong> manpage
-(<em>doc/rxvtperl.txt</em>) for more info on this feature, or the files in
-<em>src/perl-ext/</em> for the extensions that are installed by default.
+Enable an embedded perl interpreter. See the <strong>rxvtperl(3)</strong>
+manpage (<em>doc/rxvtperl.txt</em>) for more info on this feature, or the files
+in <em>src/perl-ext/</em> for the extensions that are installed by default.
 </dd>
 <p></p>
 <dt><strong>--with-name=NAME (default: urxvt)</strong><br />
index 79c59b5789a5430f982a9d7669f0ae8f878899c1..d366676add1d9f86963b3dc5e5ddfe32bfb4e8e1 100644 (file)
@@ -2537,9 +2537,9 @@ the screen in a fixed position.
 Add support to have the pointer disappear when typing or inactive.
 .IP "\-\-enable\-perl (default: off)" 4
 .IX Item "--enable-perl (default: off)"
-Enable an embedded perl interpreter. See the \fB\f(BIrxvtperl\fB\|(3)\fR manpage
-(\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files in
-\&\fIsrc/perl\-ext/\fR for the extensions that are installed by default.
+Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR
+manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files
+in \fIsrc/perl\-ext/\fR for the extensions that are installed by default.
 .IP "\-\-with\-name=NAME (default: urxvt)" 4
 .IX Item "--with-name=NAME (default: urxvt)"
 Set the basename for the installed binaries, resulting
index dd2ad4b8f3889d5e7b02c50b57ca7e29c753233c..2f3766261d55a9083cff8c6483b4428790ec810d 100644 (file)
@@ -2568,9 +2568,9 @@ Add support to have the pointer disappear when typing or inactive.
 
 =item --enable-perl (default: off)
 
-Enable an embedded perl interpreter. See the B<rxvtperl(3)> manpage
-(F<doc/rxvtperl.txt>) for more info on this feature, or the files in
-F<src/perl-ext/> for the extensions that are installed by default.
+Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
+manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
+in F<src/perl-ext/> for the extensions that are installed by default.
 
 =item --with-name=NAME (default: urxvt)
 
index 43606e273866f87adae87570fe81625d877b1680..706f9b8e2d4f3cb16dd0a1a09acba9b27c1e8c5d 100644 (file)
 </p>
 <hr />
 <h1><a name="synopsis">SYNOPSIS</a></h1>
-<p>* Put your scripts into <em>/opt/rxvt/lib/urxvt/perl-ext/</em>, they will be loaded automatically.</p>
-<p>* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
-thus must be encoded as UTF-8.</p>
+<pre>
+   # create a file grab_test in $HOME:</pre>
 <pre>
    sub on_sel_grab {
       warn &quot;you selected &quot;, $_[0]-&gt;selection;
       ()
    }</pre>
 <pre>
-   1</pre>
+   # start a rxvt using it:</pre>
+<pre>
+   rxvt --perl-lib $HOME -pe grab_test</pre>
 <p>
 </p>
 <hr />
 <h1><a name="description">DESCRIPTION</a></h1>
 <p>Everytime a terminal object gets created, scripts specified via the
-<code>perl</code> resource are associated with it.</p>
+<code>perl</code> resource are loaded and associated with it.</p>
+<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
+thus must be encoded as UTF-8.</p>
 <p>Each script will only ever be loaded once, even in rxvtd, where
 scripts will be shared (But not enabled) for all terminals.</p>
 <p>
@@ -184,6 +187,14 @@ code is run after this hook, and takes precedence.
 <dd>
 Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
 </dd>
+<p></p>
+<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br />
+</dt>
+<dd>
+Called whenever the user presses a key combination that has a
+<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
+resource in the <code>rxvt(1)</code> manpage).
+</dd>
 <p></p></dl>
 <p>
 </p>
index c00bd9745306c96b51ff3539ffed45bcff24b417..fedbc93df6cf99d1969016ee7c741d917e97ce0f 100644 (file)
 .IX Title "rxvt 3"
 .TH rxvt 3 "2006-01-02" "6.2" "RXVT-UNICODE"
 .SH "NAME"
-rxvtperl \- rxvt\-unicode's embedded perl interpreter
+@@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
-* Put your scripts into \fI@@RXVT_LIBDIR@@/urxvt/perl\-ext/\fR, they will be loaded automatically.
-.PP
-* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
-thus must be encoded as \s-1UTF\-8\s0.
+.Vb 1
+\&   # create a file grab_test in $HOME:
+.Ve
 .PP
 .Vb 4
 \&   sub on_sel_grab {
@@ -147,12 +146,19 @@ thus must be encoded as \s-1UTF\-8\s0.
 .Ve
 .PP
 .Vb 1
-\&   1
+\&   # start a @@RXVT_NAME@@ using it:
+.Ve
+.PP
+.Vb 1
+\&   @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
 .Ve
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
 Everytime a terminal object gets created, scripts specified via the
-\&\f(CW\*(C`perl\*(C'\fR resource are associated with it.
+\&\f(CW\*(C`perl\*(C'\fR resource are loaded and associated with it.
+.PP
+Scripts are compiled in a 'use strict' and 'use utf8' environment, and
+thus must be encoded as \s-1UTF\-8\s0.
 .PP
 Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
 scripts will be shared (But not enabled) for all terminals.
@@ -252,6 +258,12 @@ code is run after this hook, and takes precedence.
 .el .IP "on_refresh_end \f(CW$term\fR" 4
 .IX Item "on_refresh_end $term"
 Called just after the screen gets redrawn. See \f(CW\*(C`on_refresh_begin\*(C'\fR.
+.ie n .IP "on_keyboard_command $term\fR, \f(CW$string" 4
+.el .IP "on_keyboard_command \f(CW$term\fR, \f(CW$string\fR" 4
+.IX Item "on_keyboard_command $term, $string"
+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 "Functions in the ""urxvt"" Package"
 .el .Sh "Functions in the \f(CWurxvt\fP Package"
 .IX Subsection "Functions in the urxvt Package"
index 0a26d6670930751515081c1f549d5625e6ba2b65..b90ba3a52236d0dbb6e2048c1adbf2fe5e7b5170 100644 (file)
@@ -2,22 +2,23 @@ NAME
     rxvtperl - rxvt-unicode's embedded perl interpreter
 
 SYNOPSIS
-    * Put your scripts into /opt/rxvt/lib/urxvt/perl-ext/, they will be
-    loaded automatically.
-
-    * Scripts are evaluated in a 'use strict' and 'use utf8' environment,
-    and thus must be encoded as UTF-8.
+       # create a file grab_test in $HOME:
 
        sub on_sel_grab {
           warn "you selected ", $_[0]->selection;
           ()
        }
 
-       1
+       # start a rxvt using it:
+
+       rxvt --perl-lib $HOME -pe grab_test
 
 DESCRIPTION
     Everytime a terminal object gets created, scripts specified via the
-    "perl" resource are associated with it.
+    "perl" resource are loaded and associated with it.
+
+    Scripts are compiled in a 'use strict' and 'use utf8' environment, and
+    thus must be encoded as UTF-8.
 
     Each script will only ever be loaded once, even in rxvtd, where scripts
     will be shared (But not enabled) for all terminals.
@@ -110,6 +111,11 @@ DESCRIPTION
     on_refresh_end $term
         Called just after the screen gets redrawn. See "on_refresh_begin".
 
+    on_keyboard_command $term, $string
+        Called whenever the user presses a key combination that has a
+        "perl:string" action bound to it (see description of the keysym
+        resource in the rxvt(1) manpage).
+
   Functions in the "urxvt" Package
     urxvt::fatal $errormessage
         Fatally aborts execution with the given error message. Avoid at all
index 34f7d5ae4222f1cfe37897cb1c798817648b44e5..a66212b58f78fd61581272d51cf7717e5f891170 100644 (file)
@@ -1,6 +1,6 @@
 =head1 NAME
 
-rxvtperl - rxvt-unicode's embedded perl interpreter
+@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
 
 =head1 SYNOPSIS
 
@@ -126,6 +126,12 @@ code is run after this hook, and takes precedence.
 
 Called just after the screen gets redrawn. See C<on_refresh_begin>.
 
+=item on_keyboard_command $term, $string
+
+Called whenever the user presses a key combination that has a
+C<perl:string> action bound to it (see description of the B<keysym>
+resource in the @@RXVT_NAME@@(1) manpage).
+
 =back
 
 =head2 Functions in the C<urxvt> Package