|
|
1 | <?xml version="1.0" encoding="UTF-8"?> |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> |
3 | <head> |
4 | <head> |
4 | <title>urxvtperl - rxvt-unicode's embedded perl interpreter</title> |
5 | <title>rxvtperl</title> |
5 | <link rev="made" href="mailto:perl-binary@plan9.de" /> |
6 | <meta name="description" content="Pod documentation for rxvtperl" /> |
6 | </head> |
7 | <meta name="inputfile" content="<standard input>" /> |
7 | |
8 | <meta name="outputfile" content="<standard output>" /> |
8 | <body style="background-color: white"> |
9 | <meta name="created" content="Mon Jun 25 00:30:34 2007" /> |
9 | |
10 | <meta name="generator" content="Pod::Xhtml 1.57" /> |
10 | <p><a name="__index__"></a></p> |
11 | <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> |
|
|
12 | <body> |
|
|
13 | <div class="pod"> |
11 | <!-- INDEX BEGIN --> |
14 | <!-- INDEX START --> |
|
|
15 | <h3 id="TOP">Index</h3> |
12 | |
16 | |
13 | <ul> |
|
|
14 | |
|
|
15 | <li><a href="#name">NAME</a></li> |
17 | <ul><li><a href="#NAME">NAME</a></li> |
16 | <li><a href="#synopsis">SYNOPSIS</a></li> |
18 | <li><a href="#SYNOPSIS">SYNOPSIS</a></li> |
17 | <li><a href="#description">DESCRIPTION</a></li> |
19 | <li><a href="#DESCRIPTION">DESCRIPTION</a></li> |
18 | <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li> |
20 | <li><a href="#PREPACKAGED_EXTENSIONS">PREPACKAGED EXTENSIONS</a></li> |
19 | <li><a href="#api_documentation">API DOCUMENTATION</a></li> |
21 | <li><a href="#API_DOCUMENTATION">API DOCUMENTATION</a> |
20 | <ul> |
|
|
21 | |
|
|
22 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
22 | <ul><li><a href="#General_API_Considerations">General API Considerations</a></li> |
23 | <li><a href="#extension_objects">Extension Objects</a></li> |
23 | <li><a href="#Extension_Objects">Extension Objects</a></li> |
24 | <li><a href="#hooks">Hooks</a></li> |
24 | <li><a href="#Hooks">Hooks</a></li> |
25 | <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
25 | <li><a href="#Variables_in_the_code_urxvt_code_Pac">Variables in the <code>urxvt</code> Package</a></li> |
26 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
26 | <li><a href="#Functions_in_the_code_urxvt_code_Pac">Functions in the <code>urxvt</code> Package</a></li> |
27 | <li><a href="#rendition">RENDITION</a></li> |
27 | <li><a href="#RENDITION">RENDITION</a></li> |
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
28 | <li><a href="#The_code_urxvt_anyevent_code_Class">The <code>urxvt::anyevent</code> Class</a></li> |
29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
29 | <li><a href="#The_code_urxvt_term_code_Class">The <code>urxvt::term</code> Class</a></li> |
30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
30 | <li><a href="#The_code_urxvt_popup_code_Class">The <code>urxvt::popup</code> Class</a></li> |
31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
31 | <li><a href="#The_code_urxvt_timer_code_Class">The <code>urxvt::timer</code> Class</a></li> |
32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
32 | <li><a href="#The_code_urxvt_iow_code_Class">The <code>urxvt::iow</code> Class</a></li> |
33 | </ul> |
33 | <li><a href="#The_code_urxvt_iw_code_Class">The <code>urxvt::iw</code> Class</a></li> |
34 | |
34 | <li><a href="#The_code_urxvt_pw_code_Class">The <code>urxvt::pw</code> Class</a></li> |
35 | <li><a href="#environment">ENVIRONMENT</a></li> |
|
|
36 | <ul> |
|
|
37 | |
|
|
38 | <li><a href="#urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></li> |
|
|
39 | </ul> |
|
|
40 | |
|
|
41 | <li><a href="#author">AUTHOR</a></li> |
|
|
42 | </ul> |
35 | </ul> |
|
|
36 | </li> |
|
|
37 | <li><a href="#ENVIRONMENT">ENVIRONMENT</a> |
|
|
38 | <ul><li><a href="#URXVT_PERL_VERBOSITY">URXVT_PERL_VERBOSITY</a></li> |
|
|
39 | </ul> |
|
|
40 | </li> |
|
|
41 | <li><a href="#AUTHOR">AUTHOR</a> |
|
|
42 | </li> |
|
|
43 | </ul><hr /> |
43 | <!-- INDEX END --> |
44 | <!-- INDEX END --> |
44 | |
45 | |
45 | <hr /> |
46 | <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p> |
46 | <p> |
47 | <div id="NAME_CONTENT"> |
47 | </p> |
|
|
48 | <hr /> |
|
|
49 | <h1><a name="name">NAME</a></h1> |
|
|
50 | <p>urxvtperl - rxvt-unicode's embedded perl interpreter</p> |
48 | <p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> |
51 | <p> |
49 | |
52 | </p> |
50 | </div> |
53 | <hr /> |
51 | <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
54 | <h1><a name="synopsis">SYNOPSIS</a></h1> |
52 | <div id="SYNOPSIS_CONTENT"> |
55 | <pre> |
|
|
56 | # create a file grab_test in $HOME:</pre> |
53 | <pre> # create a file grab_test in $HOME: |
57 | <pre> |
54 | |
58 | sub on_sel_grab { |
55 | sub on_sel_grab { |
59 | warn "you selected ", $_[0]->selection; |
56 | warn "you selected ", $_[0]->selection; |
60 | () |
57 | () |
61 | }</pre> |
58 | } |
62 | <pre> |
59 | |
63 | # start a urxvt using it:</pre> |
60 | # start a rxvt using it: |
64 | <pre> |
61 | |
65 | urxvt --perl-lib $HOME -pe grab_test</pre> |
62 | rxvt --perl-lib $HOME -pe grab_test |
66 | <p> |
63 | |
67 | </p> |
64 | </pre> |
68 | <hr /> |
65 | |
69 | <h1><a name="description">DESCRIPTION</a></h1> |
66 | </div> |
|
|
67 | <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
|
|
68 | <div id="DESCRIPTION_CONTENT"> |
70 | <p>Everytime a terminal object gets created, extension scripts specified via |
69 | <p>Every time a terminal object gets created, extension scripts specified via |
71 | the <code>perl</code> resource are loaded and associated with it.</p> |
70 | the <code>perl</code> resource are loaded and associated with it.</p> |
72 | <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
71 | <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
73 | thus must be encoded as UTF-8.</p> |
72 | thus must be encoded as UTF-8.</p> |
74 | <p>Each script will only ever be loaded once, even in urxvtd, where |
73 | <p>Each script will only ever be loaded once, even in rxvtd, where |
75 | scripts will be shared (but not enabled) for all terminals.</p> |
74 | scripts will be shared (but not enabled) for all terminals.</p> |
76 | <p> |
75 | <p>You can disable the embedded perl interpreter by setting both "perl-ext" |
77 | </p> |
76 | and "perl-ext-common" resources to the empty string.</p> |
78 | <hr /> |
77 | |
79 | <h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1> |
78 | </div> |
|
|
79 | <h1 id="PREPACKAGED_EXTENSIONS">PREPACKAGED EXTENSIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
|
|
80 | <div id="PREPACKAGED_EXTENSIONS_CONTENT"> |
80 | <p>This section describes the extensions delivered with this release. You can |
81 | <p>This section describes the extensions delivered with this release. You can |
81 | find them in <em>/usr/local/lib/urxvt/perl/</em>.</p> |
82 | find them in <cite>/opt/rxvt/lib/urxvt/perl/</cite>.</p> |
82 | <p>You can activate them like this:</p> |
83 | <p>You can activate them like this:</p> |
|
|
84 | <pre> rxvt -pe <extensionname> |
|
|
85 | |
83 | <pre> |
86 | </pre> |
84 | urxvt -pe <extensionname></pre> |
87 | <p>Or by adding them to the resource for extensions loaded by default:</p> |
|
|
88 | <pre> URxvt.perl-ext-common: default,automove-background,selection-autotransform |
|
|
89 | |
|
|
90 | </pre> |
85 | <dl> |
91 | <dl> |
86 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
92 | <dt>selection (enabled by default)</dt> |
87 | </dt> |
|
|
88 | <dd> |
93 | <dd> |
89 | (More) intelligent selection. This extension tries to be more intelligent |
94 | <p>(More) intelligent selection. This extension tries to be more intelligent |
90 | when the user extends selections (double-click and further clicks). Right |
95 | when the user extends selections (double-click and further clicks). Right |
91 | now, it tries to select words, urls and complete shell-quoted |
96 | now, it tries to select words, urls and complete shell-quoted |
92 | arguments, which is very convenient, too, if your <em>ls</em> supports |
97 | arguments, which is very convenient, too, if your <cite>ls</cite> supports |
93 | <code>--quoting-style=shell</code>. |
98 | <code>--quoting-style=shell</code>.</p> |
94 | </dd> |
|
|
95 | <dd> |
|
|
96 | <p>A double-click usually selects the word under the cursor, further clicks |
99 | <p>A double-click usually selects the word under the cursor, further clicks |
97 | will enlarge the selection.</p> |
100 | will enlarge the selection.</p> |
98 | </dd> |
|
|
99 | <dd> |
|
|
100 | <p>The selection works by trying to match a number of regexes and displaying |
101 | <p>The selection works by trying to match a number of regexes and displaying |
101 | them in increasing order of length. You can add your own regexes by |
102 | them in increasing order of length. You can add your own regexes by |
102 | specifying resources of the form:</p> |
103 | specifying resources of the form:</p> |
103 | </dd> |
|
|
104 | <dd> |
|
|
105 | <pre> |
|
|
106 | URxvt.selection.pattern-0: perl-regex |
104 | <pre> URxvt.selection.pattern-0: perl-regex |
107 | URxvt.selection.pattern-1: perl-regex |
105 | URxvt.selection.pattern-1: perl-regex |
108 | ...</pre> |
106 | ... |
109 | </dd> |
107 | |
110 | <dd> |
108 | </pre> |
111 | <p>The index number (0, 1...) must not have any holes, and each regex must |
109 | <p>The index number (0, 1...) must not have any holes, and each regex must |
112 | contain at least one pair of capturing parentheses, which will be used for |
110 | contain at least one pair of capturing parentheses, which will be used for |
113 | the match. For example, the followign adds a regex that matches everything |
111 | the match. For example, the following adds a regex that matches everything |
114 | between two vertical bars:</p> |
112 | between two vertical bars:</p> |
115 | </dd> |
113 | <pre> URxvt.selection.pattern-0: \\|([^|]+)\\| |
116 | <dd> |
114 | |
117 | <pre> |
115 | </pre> |
|
|
116 | <p>Another example: Programs I use often output "absolute path: " at the |
|
|
117 | beginning of a line when they process multiple files. The following |
|
|
118 | pattern matches the filename (note, there is a single space at the very |
|
|
119 | end):</p> |
118 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
120 | <pre> URxvt.selection.pattern-0: ^(/[^:]+):\ |
119 | </dd> |
121 | |
120 | <dd> |
122 | </pre> |
121 | <p>You can look at the source of the selection extension to see more |
123 | <p>You can look at the source of the selection extension to see more |
122 | interesting uses, such as parsing a line from beginning to end.</p> |
124 | interesting uses, such as parsing a line from beginning to end.</p> |
123 | </dd> |
|
|
124 | <dd> |
|
|
125 | <p>This extension also offers the following bindable keyboard command:</p> |
125 | <p>This extension also offers following bindable keyboard commands:</p> |
126 | </dd> |
126 | <p> |
127 | <dl> |
127 | <dl> |
128 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
128 | <dt>rot13</dt> |
129 | </dt> |
129 | <dd> |
130 | <dd> |
|
|
131 | Rot-13 the selection when activated. Used via keyboard trigger: |
130 | <p>Rot-13 the selection when activated. Used via keyboard trigger:</p> |
132 | </dd> |
131 | <pre> URxvt.keysym.C-M-r: perl:selection:rot13 |
133 | <dd> |
132 | |
134 | <pre> |
133 | </pre> |
135 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
134 | </dd> |
|
|
135 | </dl> |
|
|
136 | </p> |
136 | </dd> |
137 | </dd> |
137 | <p></p></dl> |
138 | <dt>option-popup (enabled by default)</dt> |
138 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
|
|
139 | </dt> |
|
|
140 | <dd> |
139 | <dd> |
141 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
140 | <p>Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
142 | runtime. |
141 | runtime.</p> |
|
|
142 | <p>Other extensions can extend this popup menu by pushing a code reference |
|
|
143 | onto <code>@{ $term-</code>{option_popup_hook} }>, which gets called whenever the |
|
|
144 | popup is being displayed.</p> |
|
|
145 | <p>It's sole argument is the popup menu, which can be modified. It should |
|
|
146 | either return nothing or a string, the initial boolean value and a code |
|
|
147 | reference. The string will be used as button text and the code reference |
|
|
148 | will be called when the toggle changes, with the new boolean value as |
|
|
149 | first argument.</p> |
|
|
150 | <p>The following will add an entry <code>myoption</code> that changes |
|
|
151 | <code>$self-</code>{myoption}>:</p> |
|
|
152 | <pre> push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
153 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
154 | }; |
|
|
155 | |
|
|
156 | </pre> |
143 | </dd> |
157 | </dd> |
144 | <p></p> |
|
|
145 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
158 | <dt>selection-popup (enabled by default)</dt> |
146 | </dt> |
|
|
147 | <dd> |
159 | <dd> |
148 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
160 | <p>Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
149 | text into various other formats/action (such as uri unescaping, perl |
161 | text into various other formats/action (such as uri unescaping, perl |
150 | evalution, web-browser starting etc.), depending on content. |
162 | evaluation, web-browser starting etc.), depending on content.</p> |
|
|
163 | <p>Other extensions can extend this popup menu by pushing a code reference |
|
|
164 | onto <code>@{ $term-</code>{selection_popup_hook} }>, which gets called whenever the |
|
|
165 | popup is being displayed.</p> |
|
|
166 | <p>It's sole argument is the popup menu, which can be modified. The selection |
|
|
167 | is in <code>$_</code>, which can be used to decide whether to add something or not. |
|
|
168 | It should either return nothing or a string and a code reference. The |
|
|
169 | string will be used as button text and the code reference will be called |
|
|
170 | when the button gets activated and should transform <code>$_</code>.</p> |
|
|
171 | <p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in |
|
|
172 | the selection to <code>b</code>s, but only if the selection currently contains any |
|
|
173 | <code>a</code>s:</p> |
|
|
174 | <pre> push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
175 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
176 | : () |
|
|
177 | }; |
|
|
178 | |
|
|
179 | </pre> |
151 | </dd> |
180 | </dd> |
152 | <p></p> |
181 | <dt>searchable-scrollback<hotkey> (enabled by default)</dt> |
153 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
|
|
154 | </dt> |
|
|
155 | <dd> |
182 | <dd> |
156 | Adds regex search functionality to the scrollback buffer, triggered |
183 | <p>Adds regex search functionality to the scrollback buffer, triggered |
157 | by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
184 | by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
158 | input/output is suspended and a regex is displayed at the bottom of the |
185 | input/output is suspended and a regex is displayed at the bottom of the |
159 | screen. |
186 | screen.</p> |
160 | </dd> |
|
|
161 | <dd> |
|
|
162 | <p>Inputting characters appends them to the regex and continues incremental |
187 | <p>Inputting characters appends them to the regex and continues incremental |
163 | search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
188 | search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
164 | search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the |
189 | search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the |
165 | bottom. <code>Escape</code> leaves search mode and returns to the point where search |
190 | bottom. <code>Escape</code> leaves search mode and returns to the point where search |
166 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
191 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
167 | additionally stores the first match in the current line into the primary |
192 | additionally stores the first match in the current line into the primary |
168 | selection.</p> |
193 | selection.</p> |
|
|
194 | <p>The regex defaults to "(?i)", resulting in a case-insensitive search. To |
|
|
195 | get a case-sensitive search you can delete this prefix using <code>BackSpace</code> |
|
|
196 | or simply use an uppercase character which removes the "(?i)" prefix.</p> |
|
|
197 | <p>See <cite>perlre</cite> for more info about perl regular expression syntax.</p> |
169 | </dd> |
198 | </dd> |
170 | <p></p> |
199 | <dt>readline (enabled by default)</dt> |
171 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
|
|
172 | </dt> |
|
|
173 | <dd> |
200 | <dd> |
|
|
201 | <p>A support package that tries to make editing with readline easier. At |
|
|
202 | the moment, it reacts to clicking shift-left mouse button by trying to |
|
|
203 | move the text cursor to this position. It does so by generating as many |
|
|
204 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
205 | for programs that correctly support wide characters).</p> |
|
|
206 | <p>To avoid too many false positives, this is only done when:</p> |
|
|
207 | <p> |
|
|
208 | <dl> |
|
|
209 | <dt>- the tty is in ICANON state.</dt> |
|
|
210 | <dt>- the text cursor is visible.</dt> |
|
|
211 | <dt>- the primary screen is currently being displayed.</dt> |
|
|
212 | <dt>- the mouse is on the same (multi-row-) line as the text cursor.</dt> |
|
|
213 | </dl> |
|
|
214 | </p> |
|
|
215 | <p>The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
216 | might interfere with selection creation in harmless ways.</p> |
|
|
217 | </dd> |
|
|
218 | <dt>selection-autotransform</dt> |
|
|
219 | <dd> |
174 | This selection allows you to do automatic transforms on a selection |
220 | <p>This selection allows you to do automatic transforms on a selection |
175 | whenever a selection is made. |
221 | whenever a selection is made.</p> |
176 | </dd> |
|
|
177 | <dd> |
|
|
178 | <p>It works by specifying perl snippets (most useful is a single <code>s///</code> |
222 | <p>It works by specifying perl snippets (most useful is a single <code>s///</code> |
179 | operator) that modify <code>$_</code> as resources:</p> |
223 | operator) that modify <code>$_</code> as resources:</p> |
180 | </dd> |
|
|
181 | <dd> |
|
|
182 | <pre> |
|
|
183 | URxvt.selection-autotransform.0: transform |
224 | <pre> URxvt.selection-autotransform.0: transform |
184 | URxvt.selection-autotransform.1: transform |
225 | URxvt.selection-autotransform.1: transform |
185 | ...</pre> |
226 | ... |
186 | </dd> |
227 | |
187 | <dd> |
228 | </pre> |
188 | <p>For example, the following will transform selections of the form |
229 | <p>For example, the following will transform selections of the form |
189 | <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
230 | <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
190 | $word</code>:</p> |
231 | $word</code>:</p> |
191 | </dd> |
|
|
192 | <dd> |
|
|
193 | <pre> |
|
|
194 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> |
232 | <pre> URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
195 | </dd> |
233 | |
196 | <dd> |
234 | </pre> |
197 | <p>And this example matches the same,but replaces it with vi-commands you can |
235 | <p>And this example matches the same,but replaces it with vi-commands you can |
198 | paste directly into your (vi :) editor:</p> |
236 | paste directly into your (vi :) editor:</p> |
199 | </dd> |
|
|
200 | <dd> |
|
|
201 | <pre> |
|
|
202 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
237 | <pre> URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
203 | </dd> |
238 | |
204 | <dd> |
239 | </pre> |
205 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
240 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
206 | </dd> |
|
|
207 | <dd> |
|
|
208 | <p>To expand the example above to typical perl error messages (``XXX at |
241 | <p>To expand the example above to typical perl error messages ("XXX at |
209 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
242 | FILENAME line YYY."), you need a slightly more elaborate solution:</p> |
210 | </dd> |
|
|
211 | <dd> |
|
|
212 | <pre> |
|
|
213 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
243 | <pre> URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
214 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
244 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
215 | </dd> |
245 | |
216 | <dd> |
246 | </pre> |
217 | <p>The first line tells the selection code to treat the unchanging part of |
247 | <p>The first line tells the selection code to treat the unchanging part of |
218 | every error message as a selection pattern, and the second line transforms |
248 | every error message as a selection pattern, and the second line transforms |
219 | the message into vi commands to load the file.</p> |
249 | the message into vi commands to load the file.</p> |
220 | </dd> |
250 | </dd> |
221 | <p></p> |
251 | <dt>tabbed</dt> |
222 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
|
|
223 | </dt> |
|
|
224 | <dd> |
252 | <dd> |
225 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
253 | <p>This transforms the terminal into a tabbar with additional terminals, that |
226 | make them clickable. When middle-clicked, the program specified in the |
254 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
227 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
255 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
228 | the URL as first argument. |
256 | button per tab.</p> |
|
|
257 | <p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and |
|
|
258 | <strong>Shift-Right</strong> will switch to the tab left or right of the current one, |
|
|
259 | while <strong>Shift-Down</strong> creates a new tab.</p> |
|
|
260 | <p>The tabbar itself can be configured similarly to a normal terminal, but |
|
|
261 | with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the |
|
|
262 | following four resources (shown with defaults):</p> |
|
|
263 | <pre> URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
264 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
265 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
266 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
267 | |
|
|
268 | </pre> |
|
|
269 | <p>See <i>COLOR AND GRAPHICS</i> in the rxvt(1) manpage for valid |
|
|
270 | indices.</p> |
229 | </dd> |
271 | </dd> |
230 | <p></p> |
272 | <dt>matcher</dt> |
231 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
|
|
232 | </dt> |
|
|
233 | <dd> |
273 | <dd> |
|
|
274 | <p>Uses per-line display filtering (<code>on_line_update</code>) to underline text |
|
|
275 | matching a certain pattern and make it clickable. When clicked with the |
|
|
276 | mouse button specified in the <code>matcher.button</code> resource (default 2, or |
|
|
277 | middle), the program specified in the <code>matcher.launcher</code> resource |
|
|
278 | (default, the <code>urlLauncher</code> resource, <code>sensible-browser</code>) will be started |
|
|
279 | with the matched text as first argument. The default configuration is |
|
|
280 | suitable for matching URLs and launching a web browser, like the |
|
|
281 | former "mark-urls" extension.</p> |
|
|
282 | <p>The default pattern to match URLs can be overridden with the |
|
|
283 | <code>matcher.pattern.0</code> resource, and additional patterns can be specified |
|
|
284 | with numbered patterns, in a manner similar to the "selection" extension. |
|
|
285 | The launcher can also be overridden on a per-pattern basis.</p> |
|
|
286 | <p>It is possible to activate the most recently seen match from the keyboard. |
|
|
287 | Simply bind a keysym to "perl:matcher" as seen in the example below.</p> |
|
|
288 | <p>Example configuration:</p> |
|
|
289 | <pre> URxvt.perl-ext: default,matcher |
|
|
290 | URxvt.urlLauncher: sensible-browser |
|
|
291 | URxvt.keysym.C-Delete: perl:matcher |
|
|
292 | URxvt.matcher.button: 1 |
|
|
293 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
294 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
295 | URxvt.matcher.launcher.2: gvim +$2 $1 |
|
|
296 | |
|
|
297 | </pre> |
|
|
298 | </dd> |
|
|
299 | <dt>xim-onthespot</dt> |
|
|
300 | <dd> |
|
|
301 | <p>This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
302 | not work perfectly, and some input methods don't seem to work well with |
|
|
303 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
304 | kinput2.</p> |
|
|
305 | <p>You enable it by specifying this extension and a preedit style of |
|
|
306 | <code>OnTheSpot</code>, i.e.:</p> |
|
|
307 | <pre> rxvt -pt OnTheSpot -pe xim-onthespot |
|
|
308 | |
|
|
309 | </pre> |
|
|
310 | </dd> |
|
|
311 | <dt>kuake<hotkey></dt> |
|
|
312 | <dd> |
|
|
313 | <p>A very primitive quake-console-like extension. It was inspired by a |
|
|
314 | description of how the programs <code>kuake</code> and <code>yakuake</code> work: Whenever the |
|
|
315 | user presses a global accelerator key (by default <code>F10</code>), the terminal |
|
|
316 | will show or hide itself. Another press of the accelerator key will hide |
|
|
317 | or show it again.</p> |
|
|
318 | <p>Initially, the window will not be shown when using this extension.</p> |
|
|
319 | <p>This is useful if you need a single terminal thats not using any desktop |
|
|
320 | space most of the time but is quickly available at the press of a key.</p> |
|
|
321 | <p>The accelerator key is grabbed regardless of any modifiers, so this |
|
|
322 | extension will actually grab a physical key just for this function.</p> |
|
|
323 | <p>If you want a quake-like animation, tell your window manager to do so |
|
|
324 | (fvwm can do it).</p> |
|
|
325 | </dd> |
|
|
326 | <dt>automove-background</dt> |
|
|
327 | <dd> |
|
|
328 | <p>This is basically a very small extension that dynamically changes the |
|
|
329 | background pixmap offset to the window position, in effect creating the |
|
|
330 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
331 | supported in this mode. Example:</p> |
|
|
332 | <pre> rxvt -pixmap background.xpm -pe automove-background |
|
|
333 | |
|
|
334 | </pre> |
|
|
335 | <p><a href="http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions">http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions</a> |
|
|
336 | shows how this extension can be used to implement an automatically blurred |
|
|
337 | transparent background.</p> |
|
|
338 | </dd> |
|
|
339 | <dt>block-graphics-to-ascii</dt> |
|
|
340 | <dd> |
234 | A not very useful example of filtering all text output to the terminal, |
341 | <p>A not very useful example of filtering all text output to the terminal |
235 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
342 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
236 | similar-looking ascii character. |
343 | similar-looking ascii character.</p> |
237 | </dd> |
344 | </dd> |
238 | <p></p> |
345 | <dt>digital-clock</dt> |
239 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
240 | </dt> |
|
|
241 | <dd> |
346 | <dd> |
242 | Displays a digital clock using the built-in overlay. |
347 | <p>Displays a digital clock using the built-in overlay.</p> |
243 | </dd> |
348 | </dd> |
244 | <p></p> |
349 | <dt>remote-clipboard</dt> |
245 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
|
|
246 | </dt> |
|
|
247 | <dd> |
350 | <dd> |
|
|
351 | <p>Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
352 | selection popup that allows one ti run external commands to store the |
|
|
353 | selection somewhere and fetch it again.</p> |
|
|
354 | <p>We use it to implement a "distributed selection mechanism", which just |
|
|
355 | means that one command uploads the file to a remote server, and another |
|
|
356 | reads it.</p> |
|
|
357 | <p>The commands can be set using the <code>URxvt.remote-selection.store</code> and |
|
|
358 | <code>URxvt.remote-selection.fetch</code> resources. The first should read the |
|
|
359 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
360 | the selection data on STDOUT (also in UTF-8).</p> |
|
|
361 | <p>The defaults (which are likely useless to you) use rsh and cat:</p> |
|
|
362 | <pre> URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
363 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
|
|
364 | |
|
|
365 | </pre> |
|
|
366 | </dd> |
|
|
367 | <dt>selection-pastebin</dt> |
|
|
368 | <dd> |
|
|
369 | <p>This is a little rarely useful extension that Uploads the selection as |
|
|
370 | textfile to a remote site (or does other things). (The implementation is |
|
|
371 | not currently secure for use in a multiuser environment as it writes to |
|
|
372 | <cite>/tmp</cite> directly.).</p> |
|
|
373 | <p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, |
|
|
374 | i.e.</p> |
|
|
375 | <pre> URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
376 | |
|
|
377 | </pre> |
|
|
378 | <p>Pressing this combination runs a command with <code>%</code> replaced by the name of |
|
|
379 | the textfile. This command can be set via a resource:</p> |
|
|
380 | <pre> URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
381 | |
|
|
382 | </pre> |
|
|
383 | <p>And the default is likely not useful to anybody but the few people around |
|
|
384 | here :)</p> |
|
|
385 | <p>The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
386 | the same content should lead to the same filename.</p> |
|
|
387 | <p>After a successful upload the selection will be replaced by the text given |
|
|
388 | in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder |
|
|
389 | for the filename):</p> |
|
|
390 | <pre> URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
391 | |
|
|
392 | </pre> |
|
|
393 | <p><i>Note to xrdb users:</i> xrdb uses the C preprocessor, which might interpret |
|
|
394 | the double <code>/</code> characters as comment start. Use <code>\057\057</code> instead, |
|
|
395 | which works regardless of wether xrdb is used to parse the resource file |
|
|
396 | or not.</p> |
|
|
397 | </dd> |
|
|
398 | <dt>example-refresh-hooks</dt> |
|
|
399 | <dd> |
248 | Displays a very simple digital clock in the upper right corner of the |
400 | <p>Displays a very simple digital clock in the upper right corner of the |
249 | window. Illustrates overwriting the refresh callbacks to create your own |
401 | window. Illustrates overwriting the refresh callbacks to create your own |
250 | overlays or changes. |
402 | overlays or changes.</p> |
251 | </dd> |
403 | </dd> |
252 | <p></p></dl> |
404 | </dl> |
253 | <p> |
405 | |
254 | </p> |
406 | </div> |
255 | <hr /> |
407 | <h1 id="API_DOCUMENTATION">API DOCUMENTATION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
256 | <h1><a name="api_documentation">API DOCUMENTATION</a></h1> |
408 | <div id="API_DOCUMENTATION_CONTENT"> |
257 | <p> |
409 | |
258 | </p> |
410 | </div> |
259 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
411 | <h2 id="General_API_Considerations">General API Considerations</h2> |
|
|
412 | <div id="General_API_Considerations_CONTENT"> |
260 | <p>All objects (such as terminals, time watchers etc.) are typical |
413 | <p>All objects (such as terminals, time watchers etc.) are typical |
261 | reference-to-hash objects. The hash can be used to store anything you |
414 | reference-to-hash objects. The hash can be used to store anything you |
262 | like. All members starting with an underscore (such as <code>_ptr</code> or |
415 | like. All members starting with an underscore (such as <code>_ptr</code> or |
263 | <code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or |
416 | <code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or |
264 | modified).</p> |
417 | modified).</p> |
… | |
… | |
267 | the like inside the terminal object so they get destroyed as soon as the |
420 | the like inside the terminal object so they get destroyed as soon as the |
268 | terminal is destroyed.</p> |
421 | terminal is destroyed.</p> |
269 | <p>Argument names also often indicate the type of a parameter. Here are some |
422 | <p>Argument names also often indicate the type of a parameter. Here are some |
270 | hints on what they mean:</p> |
423 | hints on what they mean:</p> |
271 | <dl> |
424 | <dl> |
272 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
425 | <dt>$text</dt> |
273 | </dt> |
|
|
274 | <dd> |
426 | <dd> |
275 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
427 | <p>Rxvt-unicodes special way of encoding text, where one "unicode" character |
276 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
428 | always represents one screen cell. See <cite>ROW_t</cite> for a discussion of this format.</p> |
277 | </dd> |
429 | </dd> |
278 | <p></p> |
430 | <dt>$string</dt> |
279 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
|
|
280 | </dt> |
|
|
281 | <dd> |
431 | <dd> |
282 | A perl text string, with an emphasis on <em>text</em>. It can store all unicode |
432 | <p>A perl text string, with an emphasis on <i>text</i>. It can store all unicode |
283 | characters and is to be distinguished with text encoded in a specific |
433 | characters and is to be distinguished with text encoded in a specific |
284 | encoding (often locale-specific) and binary data. |
434 | encoding (often locale-specific) and binary data.</p> |
285 | </dd> |
435 | </dd> |
286 | <p></p> |
436 | <dt>$octets</dt> |
287 | <dt><strong><a name="item__24octets">$octets</a></strong><br /> |
|
|
288 | </dt> |
|
|
289 | <dd> |
437 | <dd> |
290 | Either binary data or - more common - a text string encoded in a |
438 | <p>Either binary data or - more common - a text string encoded in a |
291 | locale-specific way. |
439 | locale-specific way.</p> |
292 | </dd> |
440 | </dd> |
293 | <p></p></dl> |
441 | </dl> |
294 | <p> |
442 | |
295 | </p> |
443 | </div> |
296 | <h2><a name="extension_objects">Extension Objects</a></h2> |
444 | <h2 id="Extension_Objects">Extension Objects</h2> |
|
|
445 | <div id="Extension_Objects_CONTENT"> |
297 | <p>Very perl extension is a perl class. A separate perl object is created |
446 | <p>Every perl extension is a perl class. A separate perl object is created |
298 | for each terminal and each extension and passed as the first parameter to |
447 | for each terminal, and each terminal has its own set of extenion objects, |
299 | hooks. So extensions can use their <code>$self</code> object without having to think |
448 | which are passed as the first parameter to hooks. So extensions can use |
300 | about other extensions, with the exception of methods and members that |
449 | their <code>$self</code> object without having to think about clashes with other |
|
|
450 | extensions or other terminals, with the exception of methods and members |
301 | begin with an underscore character <code>_</code>: these are reserved for internal |
451 | that begin with an underscore character <code>_</code>: these are reserved for |
302 | use.</p> |
452 | internal use.</p> |
303 | <p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the |
453 | <p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the |
304 | <code>urxvt::term</code> class on this object.</p> |
454 | <code>urxvt::term</code> class on this object.</p> |
305 | <p>It has the following methods and data members:</p> |
455 | <p>It has the following methods and data members:</p> |
306 | <dl> |
456 | <dl> |
307 | <dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self->{term}</a></strong><br /> |
457 | <dt>$urxvt_term = $self->{term}</dt> |
308 | </dt> |
|
|
309 | <dd> |
458 | <dd> |
310 | Returns the <code>urxvt::term</code> object associated with this instance of the |
459 | <p>Returns the <code>urxvt::term</code> object associated with this instance of the |
311 | extension. This member <em>must not</em> be changed in any way. |
460 | extension. This member <i>must not</i> be changed in any way.</p> |
312 | </dd> |
461 | </dd> |
313 | <p></p> |
462 | <dt>$self->enable ($hook_name => $cb, [$hook_name => $cb..])</dt> |
314 | <dt><strong><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a></strong><br /> |
|
|
315 | </dt> |
|
|
316 | <dd> |
463 | <dd> |
317 | Dynamically enable the given hooks (named without the <code>on_</code> prefix) for |
464 | <p>Dynamically enable the given hooks (named without the <code>on_</code> prefix) for |
318 | this extension, replacing any previous hook. This is useful when you want |
465 | this extension, replacing any previous hook. This is useful when you want |
319 | to overwrite time-critical hooks only temporarily. |
466 | to overwrite time-critical hooks only temporarily.</p> |
320 | </dd> |
467 | </dd> |
321 | <p></p> |
468 | <dt>$self->disable ($hook_name[, $hook_name..])</dt> |
322 | <dt><strong><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a></strong><br /> |
|
|
323 | </dt> |
|
|
324 | <dd> |
469 | <dd> |
325 | Dynamically disable the given hooks. |
470 | <p>Dynamically disable the given hooks.</p> |
326 | </dd> |
471 | </dd> |
327 | <p></p></dl> |
472 | </dl> |
328 | <p> |
473 | |
329 | </p> |
474 | </div> |
330 | <h2><a name="hooks">Hooks</a></h2> |
475 | <h2 id="Hooks">Hooks</h2> |
|
|
476 | <div id="Hooks_CONTENT"> |
331 | <p>The following subroutines can be declared in extension files, and will be |
477 | <p>The following subroutines can be declared in extension files, and will be |
332 | called whenever the relevant event happens.</p> |
478 | called whenever the relevant event happens.</p> |
333 | <p>The first argument passed to them is an extension oject as described in |
479 | <p>The first argument passed to them is an extension object as described in |
334 | the in the <code>Extension Objects</code> section.</p> |
480 | the in the <code>Extension Objects</code> section.</p> |
335 | <p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the |
481 | <p><strong>All</strong> of these hooks must return a boolean value. If any of the called |
336 | event counts as being <em>consumed</em>, and the invocation of other hooks is |
482 | hooks returns true, then the event counts as being <i>consumed</i>, and the |
337 | skipped, and the relevant action might not be carried out by the C++ code.</p> |
483 | relevant action might not be carried out by the C++ code.</p> |
338 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
484 | <p><i>When in doubt, return a false value (preferably <code>()</code>).</i></p> |
339 | <dl> |
485 | <dl> |
340 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
486 | <dt>on_init $term</dt> |
341 | </dt> |
|
|
342 | <dd> |
487 | <dd> |
343 | Called after a new terminal object has been initialized, but before |
488 | <p>Called after a new terminal object has been initialized, but before |
344 | windows are created or the command gets run. Most methods are unsafe to |
489 | windows are created or the command gets run. Most methods are unsafe to |
345 | call or deliver senseless data, as terminal size and other characteristics |
490 | call or deliver senseless data, as terminal size and other characteristics |
346 | have not yet been determined. You can safely query and change resources, |
491 | have not yet been determined. You can safely query and change resources |
347 | though. |
492 | and options, though. For many purposes the <code>on_start</code> hook is a better |
|
|
493 | place.</p> |
348 | </dd> |
494 | </dd> |
349 | <p></p> |
495 | <dt>on_start $term</dt> |
350 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
|
|
351 | </dt> |
|
|
352 | <dd> |
496 | <dd> |
|
|
497 | <p>Called at the very end of initialisation of a new terminal, just before |
|
|
498 | trying to map (display) the toplevel and returning to the main loop.</p> |
|
|
499 | </dd> |
|
|
500 | <dt>on_destroy $term</dt> |
|
|
501 | <dd> |
|
|
502 | <p>Called whenever something tries to destroy terminal, when the terminal is |
|
|
503 | still fully functional (not for long, though).</p> |
|
|
504 | </dd> |
|
|
505 | <dt>on_reset $term</dt> |
|
|
506 | <dd> |
353 | Called after the screen is ``reset'' for any reason, such as resizing or |
507 | <p>Called after the screen is "reset" for any reason, such as resizing or |
354 | control sequences. Here is where you can react on changes to size-related |
508 | control sequences. Here is where you can react on changes to size-related |
355 | variables. |
509 | variables.</p> |
356 | </dd> |
510 | </dd> |
357 | <p></p> |
511 | <dt>on_child_start $term, $pid</dt> |
358 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
|
|
359 | </dt> |
|
|
360 | <dd> |
512 | <dd> |
361 | Called at the very end of initialisation of a new terminal, just before |
513 | <p>Called just after the child process has been <code>fork</code>ed.</p> |
362 | returning to the mainloop. |
|
|
363 | </dd> |
514 | </dd> |
364 | <p></p> |
515 | <dt>on_child_exit $term, $status</dt> |
365 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
|
|
366 | </dt> |
|
|
367 | <dd> |
516 | <dd> |
|
|
517 | <p>Called just after the child process has exited. <code>$status</code> is the status |
|
|
518 | from <code>waitpid</code>.</p> |
|
|
519 | </dd> |
|
|
520 | <dt>on_sel_make $term, $eventtime</dt> |
|
|
521 | <dd> |
368 | Called whenever a selection has been made by the user, but before the |
522 | <p>Called whenever a selection has been made by the user, but before the |
369 | selection text is copied, so changes to the beginning, end or type of the |
523 | selection text is copied, so changes to the beginning, end or type of the |
370 | selection will be honored. |
524 | selection will be honored.</p> |
371 | </dd> |
|
|
372 | <dd> |
|
|
373 | <p>Returning a true value aborts selection making by urxvt, in which case you |
525 | <p>Returning a true value aborts selection making by urxvt, in which case you |
374 | have to make a selection yourself by calling <a href="#item_selection_grab"><code>$term->selection_grab</code></a>.</p> |
526 | have to make a selection yourself by calling <code>$term->selection_grab</code>.</p> |
375 | </dd> |
527 | </dd> |
376 | <p></p> |
528 | <dt>on_sel_grab $term, $eventtime</dt> |
377 | <dt><strong><a name="item_on_sel_grab__24term_2c__24eventtime">on_sel_grab $term, $eventtime</a></strong><br /> |
|
|
378 | </dt> |
|
|
379 | <dd> |
529 | <dd> |
380 | Called whenever a selection has been copied, but before the selection is |
530 | <p>Called whenever a selection has been copied, but before the selection is |
381 | requested from the server. The selection text can be queried and changed |
531 | requested from the server. The selection text can be queried and changed |
382 | by calling <a href="#item_selection"><code>$term->selection</code></a>. |
532 | by calling <code>$term->selection</code>.</p> |
383 | </dd> |
|
|
384 | <dd> |
|
|
385 | <p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> |
533 | <p>Returning a true value aborts selection grabbing. It will still be highlighted.</p> |
386 | </dd> |
534 | </dd> |
387 | <p></p> |
535 | <dt>on_sel_extend $term</dt> |
388 | <dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br /> |
|
|
389 | </dt> |
|
|
390 | <dd> |
536 | <dd> |
391 | Called whenever the user tries to extend the selection (e.g. with a double |
537 | <p>Called whenever the user tries to extend the selection (e.g. with a double |
392 | click) and is either supposed to return false (normal operation), or |
538 | click) and is either supposed to return false (normal operation), or |
393 | should extend the selection itelf and return true to suppress the built-in |
539 | should extend the selection itself and return true to suppress the built-in |
394 | processing. This can happen multiple times, as long as the callback |
540 | processing. This can happen multiple times, as long as the callback |
395 | returns true, it will be called on every further click by the user and is |
541 | returns true, it will be called on every further click by the user and is |
396 | supposed to enlarge the selection more and more, if possible. |
542 | supposed to enlarge the selection more and more, if possible.</p> |
397 | </dd> |
|
|
398 | <dd> |
|
|
399 | <p>See the <em>selection</em> example extension.</p> |
543 | <p>See the <cite>selection</cite> example extension.</p> |
400 | </dd> |
544 | </dd> |
401 | <p></p> |
545 | <dt>on_view_change $term, $offset</dt> |
402 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
|
|
403 | </dt> |
|
|
404 | <dd> |
546 | <dd> |
405 | Called whenever the view offset changes, i..e the user or program |
547 | <p>Called whenever the view offset changes, i.e. the user or program |
406 | scrolls. Offset <code>0</code> means display the normal terminal, positive values |
548 | scrolls. Offset <code>0</code> means display the normal terminal, positive values |
407 | show this many lines of scrollback. |
549 | show this many lines of scrollback.</p> |
408 | </dd> |
550 | </dd> |
409 | <p></p> |
551 | <dt>on_scroll_back $term, $lines, $saved</dt> |
410 | <dt><strong><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a></strong><br /> |
|
|
411 | </dt> |
|
|
412 | <dd> |
552 | <dd> |
413 | Called whenever lines scroll out of the terminal area into the scrollback |
553 | <p>Called whenever lines scroll out of the terminal area into the scrollback |
414 | buffer. <code>$lines</code> is the number of lines scrolled out and may be larger |
554 | buffer. <code>$lines</code> is the number of lines scrolled out and may be larger |
415 | than the scroll back buffer or the terminal. |
555 | than the scroll back buffer or the terminal.</p> |
416 | </dd> |
|
|
417 | <dd> |
|
|
418 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
556 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
419 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
557 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
420 | number of lines that will be in the scrollback buffer.</p> |
558 | number of lines that will be in the scrollback buffer.</p> |
421 | </dd> |
559 | </dd> |
422 | <p></p> |
560 | <dt>on_osc_seq $term, $op, $args</dt> |
423 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
|
|
424 | </dt> |
|
|
425 | <dd> |
561 | <dd> |
|
|
562 | <p>Called on every OSC sequence and can be used to suppress it or modify its |
|
|
563 | behaviour. The default should be to return an empty list. A true value |
|
|
564 | suppresses execution of the request completely. Make sure you don't get |
|
|
565 | confused by recursive invocations when you output an osc sequence within |
|
|
566 | this callback.</p> |
|
|
567 | <p><code>on_osc_seq_perl</code> should be used for new behaviour.</p> |
|
|
568 | </dd> |
|
|
569 | <dt>on_osc_seq_perl $term, $string</dt> |
|
|
570 | <dd> |
426 | Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC = |
571 | <p>Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC = |
427 | operating system command) is processed. Cursor position and other state |
572 | operating system command) is processed. Cursor position and other state |
428 | information is up-to-date when this happens. For interoperability, the |
573 | information is up-to-date when this happens. For interoperability, the |
429 | string should start with the extension name and a colon, to distinguish |
574 | string should start with the extension name and a colon, to distinguish |
430 | it from commands for other extensions, and this might be enforced in the |
575 | it from commands for other extensions, and this might be enforced in the |
431 | future. |
576 | future.</p> |
432 | </dd> |
|
|
433 | <dd> |
|
|
434 | <p>Be careful not ever to trust (in a security sense) the data you receive, |
577 | <p>Be careful not ever to trust (in a security sense) the data you receive, |
435 | as its source can not easily be controleld (e-mail content, messages from |
578 | as its source can not easily be controlled (e-mail content, messages from |
436 | other users on the same system etc.).</p> |
579 | other users on the same system etc.).</p> |
437 | </dd> |
580 | </dd> |
438 | <p></p> |
581 | <dt>on_add_lines $term, $string</dt> |
439 | <dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br /> |
|
|
440 | </dt> |
|
|
441 | <dd> |
582 | <dd> |
442 | Called whenever text is about to be output, with the text as argument. You |
583 | <p>Called whenever text is about to be output, with the text as argument. You |
443 | can filter/change and output the text yourself by returning a true value |
584 | can filter/change and output the text yourself by returning a true value |
444 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
585 | and calling <code>$term->scr_add_lines</code> yourself. Please note that this |
445 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
586 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
446 | output. |
587 | output.</p> |
447 | </dd> |
588 | </dd> |
448 | <p></p> |
589 | <dt>on_tt_write $term, $octets</dt> |
449 | <dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br /> |
|
|
450 | </dt> |
|
|
451 | <dd> |
590 | <dd> |
452 | Called whenever some data is written to the tty/pty and can be used to |
591 | <p>Called whenever some data is written to the tty/pty and can be used to |
453 | suppress or filter tty input. |
592 | suppress or filter tty input.</p> |
454 | </dd> |
593 | </dd> |
455 | <p></p> |
594 | <dt>on_line_update $term, $row</dt> |
456 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
|
|
457 | </dt> |
|
|
458 | <dd> |
595 | <dd> |
459 | Called whenever a line was updated or changed. Can be used to filter |
596 | <p>Called whenever a line was updated or changed. Can be used to filter |
460 | screen output (e.g. underline urls or other useless stuff). Only lines |
597 | screen output (e.g. underline urls or other useless stuff). Only lines |
461 | that are being shown will be filtered, and, due to performance reasons, |
598 | that are being shown will be filtered, and, due to performance reasons, |
462 | not always immediately. |
599 | not always immediately.</p> |
463 | </dd> |
|
|
464 | <dd> |
|
|
465 | <p>The row number is always the topmost row of the line if the line spans |
600 | <p>The row number is always the topmost row of the line if the line spans |
466 | multiple rows.</p> |
601 | multiple rows.</p> |
467 | </dd> |
|
|
468 | <dd> |
|
|
469 | <p>Please note that, if you change the line, then the hook might get called |
602 | <p>Please note that, if you change the line, then the hook might get called |
470 | later with the already-modified line (e.g. if unrelated parts change), so |
603 | later with the already-modified line (e.g. if unrelated parts change), so |
471 | you cannot just toggle rendition bits, but only set them.</p> |
604 | you cannot just toggle rendition bits, but only set them.</p> |
472 | </dd> |
605 | </dd> |
473 | <p></p> |
606 | <dt>on_refresh_begin $term</dt> |
474 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
|
|
475 | </dt> |
|
|
476 | <dd> |
607 | <dd> |
477 | Called just before the screen gets redrawn. Can be used for overlay |
608 | <p>Called just before the screen gets redrawn. Can be used for overlay |
478 | or similar effects by modify terminal contents in refresh_begin, and |
609 | or similar effects by modify terminal contents in refresh_begin, and |
479 | restoring them in refresh_end. The built-in overlay and selection display |
610 | restoring them in refresh_end. The built-in overlay and selection display |
480 | code is run after this hook, and takes precedence. |
611 | code is run after this hook, and takes precedence.</p> |
481 | </dd> |
612 | </dd> |
482 | <p></p> |
613 | <dt>on_refresh_end $term</dt> |
483 | <dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> |
|
|
484 | </dt> |
|
|
485 | <dd> |
614 | <dd> |
486 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
615 | <p>Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.</p> |
487 | </dd> |
616 | </dd> |
488 | <p></p> |
617 | <dt>on_user_command $term, $string</dt> |
489 | <dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> |
|
|
490 | </dt> |
|
|
491 | <dd> |
618 | <dd> |
492 | Called whenever the user presses a key combination that has a |
619 | <p>Called whenever a user-configured event is being activated (e.g. via |
493 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
620 | a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong> |
494 | resource in the <code>urxvt(1)</code> manpage). |
621 | resource in the rxvt(1) manpage).</p> |
|
|
622 | <p>The event is simply the action string. This interface is assumed to change |
|
|
623 | slightly in the future.</p> |
495 | </dd> |
624 | </dd> |
496 | <p></p> |
625 | <dt>on_resize_all_windows $tern, $new_width, $new_height</dt> |
497 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
|
|
498 | </dt> |
|
|
499 | <dd> |
626 | <dd> |
|
|
627 | <p>Called just after the new window size has been calculated, but before |
|
|
628 | windows are actually being resized or hints are being set. If this hook |
|
|
629 | returns TRUE, setting of the window hints is being skipped.</p> |
|
|
630 | </dd> |
|
|
631 | <dt>on_x_event $term, $event</dt> |
|
|
632 | <dd> |
500 | Called on every X event received on the vt window (and possibly other |
633 | <p>Called on every X event received on the vt window (and possibly other |
501 | windows). Should only be used as a last resort. Most event structure |
634 | windows). Should only be used as a last resort. Most event structure |
502 | members are not passed. |
635 | members are not passed.</p> |
503 | </dd> |
636 | </dd> |
504 | <p></p> |
637 | <dt>on_root_event $term, $event</dt> |
505 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
|
|
506 | </dt> |
|
|
507 | <dd> |
638 | <dd> |
|
|
639 | <p>Like <code>on_x_event</code>, but is called for events on the root window.</p> |
|
|
640 | </dd> |
|
|
641 | <dt>on_focus_in $term</dt> |
|
|
642 | <dd> |
508 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
643 | <p>Called whenever the window gets the keyboard focus, before rxvt-unicode |
509 | does focus in processing. |
644 | does focus in processing.</p> |
510 | </dd> |
645 | </dd> |
511 | <p></p> |
646 | <dt>on_focus_out $term</dt> |
512 | <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
|
|
513 | </dt> |
|
|
514 | <dd> |
647 | <dd> |
515 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
648 | <p>Called whenever the window loses keyboard focus, before rxvt-unicode does |
516 | focus out processing. |
649 | focus out processing.</p> |
517 | </dd> |
650 | </dd> |
518 | <p></p> |
651 | <dt>on_configure_notify $term, $event</dt> |
519 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
652 | <dt>on_property_notify $term, $event</dt> |
520 | </dt> |
653 | <dt>on_key_press $term, $event, $keysym, $octets</dt> |
521 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
654 | <dt>on_key_release $term, $event, $keysym</dt> |
522 | </dt> |
655 | <dt>on_button_press $term, $event</dt> |
523 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
656 | <dt>on_button_release $term, $event</dt> |
524 | </dt> |
657 | <dt>on_motion_notify $term, $event</dt> |
525 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
658 | <dt>on_map_notify $term, $event</dt> |
526 | </dt> |
659 | <dt>on_unmap_notify $term, $event</dt> |
527 | <dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br /> |
|
|
528 | </dt> |
|
|
529 | <dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br /> |
|
|
530 | </dt> |
|
|
531 | <dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br /> |
|
|
532 | </dt> |
|
|
533 | <dd> |
660 | <dd> |
534 | Called whenever the corresponding X event is received for the terminal If |
661 | <p>Called whenever the corresponding X event is received for the terminal If |
535 | the hook returns true, then the even will be ignored by rxvt-unicode. |
662 | the hook returns true, then the even will be ignored by rxvt-unicode.</p> |
536 | </dd> |
|
|
537 | <dd> |
|
|
538 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
663 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
539 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
664 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the |
540 | and column under the mouse cursor.</p> |
665 | (real, not screen-based) row and column under the mouse cursor.</p> |
541 | </dd> |
|
|
542 | <dd> |
|
|
543 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
666 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
544 | output, if any, in locale-specific encoding.</p> |
667 | output, if any, in locale-specific encoding.</p> |
545 | </dd> |
|
|
546 | <dd> |
|
|
547 | <p>subwindow.</p> |
668 | <p>subwindow.</p> |
548 | </dd> |
669 | </dd> |
549 | <p></p></dl> |
670 | <dt>on_client_message $term, $event</dt> |
550 | <p> |
671 | <dt>on_wm_protocols $term, $event</dt> |
551 | </p> |
672 | <dt>on_wm_delete_window $term, $event</dt> |
|
|
673 | <dd> |
|
|
674 | <p>Called when various types of ClientMessage events are received (all with |
|
|
675 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).</p> |
|
|
676 | </dd> |
|
|
677 | </dl> |
|
|
678 | |
|
|
679 | </div> |
552 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
680 | <h2 id="Variables_in_the_code_urxvt_code_Pac">Variables in the <code>urxvt</code> Package</h2> |
|
|
681 | <div id="Variables_in_the_code_urxvt_code_Pac-2"> |
553 | <dl> |
682 | <dl> |
554 | <dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br /> |
683 | <dt>$urxvt::LIBDIR</dt> |
555 | </dt> |
|
|
556 | <dd> |
684 | <dd> |
557 | The rxvt-unicode library directory, where, among other things, the perl |
685 | <p>The rxvt-unicode library directory, where, among other things, the perl |
558 | modules and scripts are stored. |
686 | modules and scripts are stored.</p> |
559 | </dd> |
687 | </dd> |
560 | <p></p> |
688 | <dt>$urxvt::RESCLASS, $urxvt::RESCLASS</dt> |
561 | <dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br /> |
|
|
562 | </dt> |
|
|
563 | <dd> |
689 | <dd> |
564 | The resource class and name rxvt-unicode uses to look up X resources. |
690 | <p>The resource class and name rxvt-unicode uses to look up X resources.</p> |
565 | </dd> |
691 | </dd> |
566 | <p></p> |
692 | <dt>$urxvt::RXVTNAME</dt> |
567 | <dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br /> |
|
|
568 | </dt> |
|
|
569 | <dd> |
693 | <dd> |
570 | The basename of the installed binaries, usually <code>urxvt</code>. |
694 | <p>The basename of the installed binaries, usually <code>urxvt</code>.</p> |
571 | </dd> |
695 | </dd> |
572 | <p></p> |
696 | <dt>$urxvt::TERM</dt> |
573 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
|
|
574 | </dt> |
|
|
575 | <dd> |
697 | <dd> |
576 | The current terminal. This variable stores the current <code>urxvt::term</code> |
698 | <p>The current terminal. This variable stores the current <code>urxvt::term</code> |
577 | object, whenever a callback/hook is executing. |
699 | object, whenever a callback/hook is executing.</p> |
578 | </dd> |
700 | </dd> |
579 | <p></p></dl> |
701 | <dt>@urxvt::TERM_INIT</dt> |
580 | <p> |
702 | <dd> |
581 | </p> |
703 | <p>All code references in this array will be called as methods of the next newly |
|
|
704 | created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array |
|
|
705 | gets cleared before the code references that were in it are being executed, |
|
|
706 | so references can push themselves onto it again if they so desire.</p> |
|
|
707 | <p>This complements to the perl-eval command line option, but gets executed |
|
|
708 | first.</p> |
|
|
709 | </dd> |
|
|
710 | <dt>@urxvt::TERM_EXT</dt> |
|
|
711 | <dd> |
|
|
712 | <p>Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which |
|
|
713 | get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code> |
|
|
714 | but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.</p> |
|
|
715 | </dd> |
|
|
716 | </dl> |
|
|
717 | |
|
|
718 | </div> |
582 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
719 | <h2 id="Functions_in_the_code_urxvt_code_Pac">Functions in the <code>urxvt</code> Package</h2> |
|
|
720 | <div id="Functions_in_the_code_urxvt_code_Pac-2"> |
583 | <dl> |
721 | <dl> |
584 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
722 | <dt>urxvt::fatal $errormessage</dt> |
585 | </dt> |
|
|
586 | <dd> |
723 | <dd> |
587 | Fatally aborts execution with the given error message. Avoid at all |
724 | <p>Fatally aborts execution with the given error message. Avoid at all |
588 | costs! The only time this is acceptable is when the terminal process |
725 | costs! The only time this is acceptable is when the terminal process |
589 | starts up. |
726 | starts up.</p> |
590 | </dd> |
727 | </dd> |
591 | <p></p> |
728 | <dt>urxvt::warn $string</dt> |
592 | <dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br /> |
|
|
593 | </dt> |
|
|
594 | <dd> |
729 | <dd> |
595 | Calls <code>rxvt_warn</code> with the given string which should not include a |
730 | <p>Calls <code>rxvt_warn</code> with the given string which should not include a |
596 | newline. The module also overwrites the <code>warn</code> builtin with a function |
731 | newline. The module also overwrites the <code>warn</code> builtin with a function |
597 | that calls this function. |
732 | that calls this function.</p> |
598 | </dd> |
|
|
599 | <dd> |
|
|
600 | <p>Using this function has the advantage that its output ends up in the |
733 | <p>Using this function has the advantage that its output ends up in the |
601 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
734 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
602 | </dd> |
|
|
603 | <dd> |
|
|
604 | <p>Messages have a size limit of 1023 bytes currently.</p> |
735 | <p>Messages have a size limit of 1023 bytes currently.</p> |
605 | </dd> |
736 | </dd> |
606 | <p></p> |
737 | <dt>@terms = urxvt::termlist</dt> |
607 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
|
|
608 | </dt> |
|
|
609 | <dd> |
738 | <dd> |
610 | Returns true when it is safe to do potentially unsafe things, such as |
739 | <p>Returns all urxvt::term objects that exist in this process, regardless of |
611 | evaluating perl code specified by the user. This is true when urxvt was |
740 | whether they are started, being destroyed etc., so be careful. Only term |
612 | started setuid or setgid. |
741 | objects that have perl extensions attached will be returned (because there |
|
|
742 | is no urxvt::term objet associated with others).</p> |
613 | </dd> |
743 | </dd> |
614 | <p></p> |
744 | <dt>$time = urxvt::NOW</dt> |
615 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
|
|
616 | </dt> |
|
|
617 | <dd> |
745 | <dd> |
618 | Returns the ``current time'' (as per the event loop). |
746 | <p>Returns the "current time" (as per the event loop).</p> |
619 | </dd> |
747 | </dd> |
620 | <p></p> |
748 | <dt>urxvt::CurrentTime</dt> |
621 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
749 | <dt>urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
622 | </dt> |
|
|
623 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
624 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
750 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
625 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
751 | Button4Mask, Button5Mask, AnyModifier</dt> |
626 | </dt> |
752 | <dt>urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
627 | <dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
628 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
753 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
629 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
754 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
630 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
755 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
631 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
756 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
632 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
757 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
633 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> |
758 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</dt> |
634 | </dt> |
759 | <dt>urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
635 | <dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
636 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
760 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
637 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
761 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
638 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
762 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
639 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
763 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
640 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
764 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
641 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> |
765 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</dt> |
642 | </dt> |
|
|
643 | <dd> |
766 | <dd> |
644 | Various constants for use in X calls and event processing. |
767 | <p>Various constants for use in X calls and event processing.</p> |
645 | </dd> |
768 | </dd> |
646 | <p></p></dl> |
769 | </dl> |
647 | <p> |
770 | |
648 | </p> |
771 | </div> |
649 | <h2><a name="rendition">RENDITION</a></h2> |
772 | <h2 id="RENDITION">RENDITION</h2> |
|
|
773 | <div id="RENDITION_CONTENT"> |
650 | <p>Rendition bitsets contain information about colour, font, font styles and |
774 | <p>Rendition bitsets contain information about colour, font, font styles and |
651 | similar information for each screen cell.</p> |
775 | similar information for each screen cell.</p> |
652 | <p>The following ``macros'' deal with changes in rendition sets. You should |
776 | <p>The following "macros" deal with changes in rendition sets. You should |
653 | never just create a bitset, you should always modify an existing one, |
777 | never just create a bitset, you should always modify an existing one, |
654 | as they contain important information required for correct operation of |
778 | as they contain important information required for correct operation of |
655 | rxvt-unicode.</p> |
779 | rxvt-unicode.</p> |
656 | <dl> |
780 | <dl> |
657 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br /> |
781 | <dt>$rend = urxvt::DEFAULT_RSTYLE</dt> |
658 | </dt> |
|
|
659 | <dd> |
782 | <dd> |
660 | Returns the default rendition, as used when the terminal is starting up or |
783 | <p>Returns the default rendition, as used when the terminal is starting up or |
661 | being reset. Useful as a base to start when creating renditions. |
784 | being reset. Useful as a base to start when creating renditions.</p> |
662 | </dd> |
785 | </dd> |
663 | <p></p> |
786 | <dt>$rend = urxvt::OVERLAY_RSTYLE</dt> |
664 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br /> |
|
|
665 | </dt> |
|
|
666 | <dd> |
787 | <dd> |
667 | Return the rendition mask used for overlays by default. |
788 | <p>Return the rendition mask used for overlays by default.</p> |
668 | </dd> |
789 | </dd> |
669 | <p></p> |
790 | <dt>$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</dt> |
670 | <dt><strong><a name="item__24rendbit__3d_urxvt_3a_3ars_bold_2c_rs_italic_2c_">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong><br /> |
|
|
671 | </dt> |
|
|
672 | <dd> |
791 | <dd> |
673 | Return the bit that enabled bold, italic, blink, reverse-video and |
792 | <p>Return the bit that enabled bold, italic, blink, reverse-video and |
674 | underline, respectively. To enable such a style, just logically OR it into |
793 | underline, respectively. To enable such a style, just logically OR it into |
675 | the bitset. |
794 | the bitset.</p> |
676 | </dd> |
795 | </dd> |
677 | <p></p> |
796 | <dt>$foreground = urxvt::GET_BASEFG $rend</dt> |
678 | <dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br /> |
797 | <dt>$background = urxvt::GET_BASEBG $rend</dt> |
679 | </dt> |
|
|
680 | <dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br /> |
|
|
681 | </dt> |
|
|
682 | <dd> |
798 | <dd> |
683 | Return the foreground/background colour index, respectively. |
799 | <p>Return the foreground/background colour index, respectively.</p> |
684 | </dd> |
800 | </dd> |
685 | <p></p> |
801 | <dt>$rend = urxvt::SET_FGCOLOR $rend, $new_colour</dt> |
686 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
802 | <dt>$rend = urxvt::SET_BGCOLOR $rend, $new_colour</dt> |
687 | </dt> |
803 | <dt>$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</dt> |
688 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
|
|
689 | </dt> |
|
|
690 | <dd> |
804 | <dd> |
691 | Replace the foreground/background colour in the rendition mask with the |
805 | <p>Replace the foreground/background colour in the rendition mask with the |
692 | specified one. |
806 | specified one.</p> |
693 | </dd> |
807 | </dd> |
694 | <p></p> |
808 | <dt>$value = urxvt::GET_CUSTOM $rend</dt> |
695 | <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br /> |
|
|
696 | </dt> |
|
|
697 | <dd> |
809 | <dd> |
698 | Return the ``custom'' value: Every rendition has 5 bits for use by |
810 | <p>Return the "custom" value: Every rendition has 5 bits for use by |
699 | extensions. They can be set and changed as you like and are initially |
811 | extensions. They can be set and changed as you like and are initially |
700 | zero. |
812 | zero.</p> |
701 | </dd> |
813 | </dd> |
702 | <p></p> |
814 | <dt>$rend = urxvt::SET_CUSTOM $rend, $new_value</dt> |
703 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br /> |
|
|
704 | </dt> |
|
|
705 | <dd> |
815 | <dd> |
706 | Change the custom value. |
816 | <p>Change the custom value.</p> |
707 | </dd> |
817 | </dd> |
708 | <p></p></dl> |
818 | </dl> |
709 | <p> |
819 | |
710 | </p> |
820 | </div> |
711 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
821 | <h2 id="The_code_urxvt_anyevent_code_Class">The <code>urxvt::anyevent</code> Class</h2> |
|
|
822 | <div id="The_code_urxvt_anyevent_code_Class_C"> |
712 | <p>The sole purpose of this class is to deliver an interface to the |
823 | <p>The sole purpose of this class is to deliver an interface to the |
713 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
824 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
714 | further programming. The only exception is that you cannot wait on |
825 | further programming. The only exception is that you cannot wait on |
715 | condition variables, but non-blocking condvar use is ok. What this means |
826 | condition variables, but non-blocking condvar use is ok. What this means |
716 | is that you cannot use blocking APIs, but the non-blocking variant should |
827 | is that you cannot use blocking APIs, but the non-blocking variant should |
717 | work.</p> |
828 | work.</p> |
718 | <p> |
829 | |
719 | </p> |
830 | </div> |
720 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
831 | <h2 id="The_code_urxvt_term_code_Class">The <code>urxvt::term</code> Class</h2> |
|
|
832 | <div id="The_code_urxvt_term_code_Class_CONTE"> |
721 | <dl> |
833 | <dl> |
722 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
834 | <dt>$term = new urxvt::term $envhashref, $rxvtname, [arg...]</dt> |
723 | </dt> |
|
|
724 | <dd> |
835 | <dd> |
725 | Creates a new terminal, very similar as if you had started it with system |
836 | <p>Creates a new terminal, very similar as if you had started it with system |
726 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
837 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
727 | hash which defines the environment of the new terminal. |
838 | hash which defines the environment of the new terminal.</p> |
728 | </dd> |
|
|
729 | <dd> |
|
|
730 | <p>Croaks (and probably outputs an error message) if the new instance |
839 | <p>Croaks (and probably outputs an error message) if the new instance |
731 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
840 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
732 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
841 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
733 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
842 | <code>start</code> hooks will be called before this call returns, and are free to |
|
|
843 | refer to global data (which is race free).</p> |
734 | </dd> |
844 | </dd> |
735 | <p></p> |
845 | <dt>$term->destroy</dt> |
736 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
|
|
737 | </dt> |
|
|
738 | <dd> |
846 | <dd> |
739 | Destroy the terminal object (close the window, free resources |
847 | <p>Destroy the terminal object (close the window, free resources |
740 | etc.). Please note that urxvt will not exit as long as any event |
848 | etc.). Please note that rxvt will not exit as long as any event |
741 | watchers (timers, io watchers) are still active. |
849 | watchers (timers, io watchers) are still active.</p> |
742 | </dd> |
850 | </dd> |
743 | <p></p> |
851 | <dt>$term->exec_async ($cmd[, @args])</dt> |
744 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
|
|
745 | </dt> |
|
|
746 | <dd> |
852 | <dd> |
|
|
853 | <p>Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes |
|
|
854 | ("starts") programs in the background. This function takes care of setting |
|
|
855 | the user environment before exec'ing the command (e.g. <code>PATH</code>) and should |
|
|
856 | be preferred over explicit calls to <code>exec</code> or <code>system</code>.</p> |
|
|
857 | <p>Returns the pid of the subprocess or <code>undef</code> on error.</p> |
|
|
858 | </dd> |
|
|
859 | <dt>$isset = $term->option ($optval[, $set])</dt> |
|
|
860 | <dd> |
747 | Returns true if the option specified by <code>$optval</code> is enabled, and |
861 | <p>Returns true if the option specified by <code>$optval</code> is enabled, and |
748 | optionally change it. All option values are stored by name in the hash |
862 | optionally change it. All option values are stored by name in the hash |
749 | <code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash. |
863 | <code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.</p> |
750 | </dd> |
|
|
751 | <dd> |
|
|
752 | <p>Here is a a likely non-exhaustive list of option names, please see the |
864 | <p>Here is a likely non-exhaustive list of option names, please see the |
753 | source file <em>/src/optinc.h</em> to see the actual list:</p> |
865 | source file <cite>/src/optinc.h</cite> to see the actual list:</p> |
754 | </dd> |
|
|
755 | <dd> |
|
|
756 | <pre> |
|
|
757 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
866 | <pre> borderLess console cursorBlink cursorUnderline hold iconic insecure |
758 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
867 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
759 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
868 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
760 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
869 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
761 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
870 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
762 | tripleclickwords utmpInhibit visualBell</pre> |
871 | transparent tripleclickwords utmpInhibit visualBell |
|
|
872 | |
|
|
873 | </pre> |
763 | </dd> |
874 | </dd> |
764 | <p></p> |
875 | <dt>$value = $term->resource ($name[, $newval])</dt> |
765 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
|
|
766 | </dt> |
|
|
767 | <dd> |
876 | <dd> |
768 | Returns the current resource value associated with a given name and |
877 | <p>Returns the current resource value associated with a given name and |
769 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
878 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
770 | hook. Unset resources are returned and accepted as <code>undef</code>. |
879 | hook. Unset resources are returned and accepted as <code>undef</code>.</p> |
771 | </dd> |
|
|
772 | <dd> |
|
|
773 | <p>The new value must be properly encoded to a suitable character encoding |
880 | <p>The new value must be properly encoded to a suitable character encoding |
774 | before passing it to this method. Similarly, the returned value may need |
881 | before passing it to this method. Similarly, the returned value may need |
775 | to be converted from the used encoding to text.</p> |
882 | to be converted from the used encoding to text.</p> |
776 | </dd> |
|
|
777 | <dd> |
|
|
778 | <p>Resource names are as defined in <em>src/rsinc.h</em>. Colours can be specified |
883 | <p>Resource names are as defined in <cite>src/rsinc.h</cite>. Colours can be specified |
779 | as resource names of the form <code>color+<index></code>, e.g. <code>color+5</code>. (will |
884 | as resource names of the form <code>color+<index></code>, e.g. <code>color+5</code>. (will |
780 | likely change).</p> |
885 | likely change).</p> |
781 | </dd> |
|
|
782 | <dd> |
|
|
783 | <p>Please note that resource strings will currently only be freed when the |
886 | <p>Please note that resource strings will currently only be freed when the |
784 | terminal is destroyed, so changing options frequently will eat memory.</p> |
887 | terminal is destroyed, so changing options frequently will eat memory.</p> |
785 | </dd> |
|
|
786 | <dd> |
|
|
787 | <p>Here is a a likely non-exhaustive list of resource names, not all of which |
888 | <p>Here is a likely non-exhaustive list of resource names, not all of which |
788 | are supported in every build, please see the source file <em>/src/rsinc.h</em> |
889 | are supported in every build, please see the source file <cite>/src/rsinc.h</cite> |
789 | to see the actual list:</p> |
890 | to see the actual list:</p> |
790 | </dd> |
|
|
791 | <dd> |
|
|
792 | <pre> |
|
|
793 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
891 | <pre> answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
794 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
892 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
795 | display_name embed ext_bwidth fade font geometry hold iconName |
893 | display_name embed ext_bwidth fade font geometry hold iconName |
796 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
894 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
797 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
895 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
798 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
896 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
799 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
897 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
800 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
898 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
801 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
899 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
802 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
900 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
803 | shade term_name title transparent transparent_all tripleclickwords |
901 | secondaryScreen secondaryScroll selectstyle shade term_name title |
804 | utmpInhibit visualBell</pre> |
902 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
|
|
903 | visualBell |
|
|
904 | |
|
|
905 | </pre> |
805 | </dd> |
906 | </dd> |
806 | <p></p> |
907 | <dt>$value = $term->x_resource ($pattern)</dt> |
807 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
|
|
808 | </dt> |
|
|
809 | <dd> |
908 | <dd> |
810 | Returns the X-Resource for the given pattern, excluding the program or |
909 | <p>Returns the X-Resource for the given pattern, excluding the program or |
811 | class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the |
910 | class name, i.e. <code>$term->x_resource ("boldFont")</code> should return the |
812 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
911 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
813 | resource with that pattern exists. |
912 | resource with that pattern exists.</p> |
814 | </dd> |
|
|
815 | <dd> |
|
|
816 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
913 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
817 | only one resource database per display, and later invocations might return |
914 | only one resource database per display, and later invocations might return |
818 | the wrong resources.</p> |
915 | the wrong resources.</p> |
819 | </dd> |
916 | </dd> |
820 | <p></p> |
917 | <dt>$success = $term->parse_keysym ($keysym_spec, $command_string)</dt> |
821 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
|
|
822 | </dt> |
|
|
823 | <dd> |
918 | <dd> |
824 | Adds a keymap translation exactly as specified via a resource. See the |
919 | <p>Adds a keymap translation exactly as specified via a resource. See the |
825 | <code>keysym</code> resource in the <code>urxvt(1)</code> manpage. |
920 | <code>keysym</code> resource in the rxvt(1) manpage.</p> |
826 | </dd> |
921 | </dd> |
827 | <p></p> |
922 | <dt>$rend = $term->rstyle ([$new_rstyle])</dt> |
828 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
|
|
829 | </dt> |
|
|
830 | <dd> |
923 | <dd> |
831 | Return and optionally change the current rendition. Text that is output by |
924 | <p>Return and optionally change the current rendition. Text that is output by |
832 | the terminal application will use this style. |
925 | the terminal application will use this style.</p> |
833 | </dd> |
926 | </dd> |
834 | <p></p> |
927 | <dt>($row, $col) = $term->screen_cur ([$row, $col])</dt> |
835 | <dt><strong><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a></strong><br /> |
|
|
836 | </dt> |
|
|
837 | <dd> |
928 | <dd> |
838 | Return the current coordinates of the text cursor position and optionally |
929 | <p>Return the current coordinates of the text cursor position and optionally |
839 | set it (which is usually bad as applications don't expect that). |
930 | set it (which is usually bad as applications don't expect that).</p> |
840 | </dd> |
931 | </dd> |
841 | <p></p> |
932 | <dt>($row, $col) = $term->selection_mark ([$row, $col])</dt> |
842 | <dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong><br /> |
933 | <dt>($row, $col) = $term->selection_beg ([$row, $col])</dt> |
843 | </dt> |
934 | <dt>($row, $col) = $term->selection_end ([$row, $col])</dt> |
844 | <dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong><br /> |
|
|
845 | </dt> |
|
|
846 | <dt><strong><a name="item_selection_end">($row, $col) = $term->selection_end ([$row, $col])</a></strong><br /> |
|
|
847 | </dt> |
|
|
848 | <dd> |
935 | <dd> |
849 | Return the current values of the selection mark, begin or end positions, |
936 | <p>Return the current values of the selection mark, begin or end positions, |
850 | and optionally set them to new values. |
937 | and optionally set them to new values.</p> |
851 | </dd> |
938 | </dd> |
852 | <p></p> |
939 | <dt>$term->selection_make ($eventtime[, $rectangular])</dt> |
853 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong><br /> |
|
|
854 | </dt> |
|
|
855 | <dd> |
940 | <dd> |
856 | Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and |
941 | <p>Tries to make a selection as set by <code>selection_beg</code> and |
857 | <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a |
942 | <code>selection_end</code>. If <code>$rectangular</code> is true (default: false), a |
858 | rectangular selection will be made. This is the prefered function to make |
943 | rectangular selection will be made. This is the prefered function to make |
859 | a selection. |
944 | a selection.</p> |
860 | </dd> |
945 | </dd> |
861 | <p></p> |
946 | <dt>$success = $term->selection_grab ($eventtime)</dt> |
862 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
|
|
863 | </dt> |
|
|
864 | <dd> |
947 | <dd> |
865 | Try to request the primary selection text from the server (for example, as |
948 | <p>Try to request the primary selection text from the server (for example, as |
866 | set by the next method). No visual feedback will be given. This function |
949 | set by the next method). No visual feedback will be given. This function |
867 | is mostly useful from within <code>on_sel_grab</code> hooks. |
950 | is mostly useful from within <code>on_sel_grab</code> hooks.</p> |
868 | </dd> |
951 | </dd> |
869 | <p></p> |
|
|
870 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
952 | <dt>$oldtext = $term->selection ([$newtext])</dt> |
871 | </dt> |
|
|
872 | <dd> |
953 | <dd> |
873 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
954 | <p>Return the current selection text and optionally replace it by <code>$newtext</code>.</p> |
874 | </dd> |
955 | </dd> |
875 | <p></p> |
956 | <dt>$term->overlay_simple ($x, $y, $text)</dt> |
876 | <dt><strong><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a></strong><br /> |
|
|
877 | </dt> |
|
|
878 | <dd> |
957 | <dd> |
879 | Create a simple multi-line overlay box. See the next method for details. |
958 | <p>Create a simple multi-line overlay box. See the next method for details.</p> |
880 | </dd> |
959 | </dd> |
881 | <p></p> |
960 | <dt>$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</dt> |
882 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
|
|
883 | </dt> |
|
|
884 | <dd> |
961 | <dd> |
885 | Create a new (empty) overlay at the given position with the given |
962 | <p>Create a new (empty) overlay at the given position with the given |
886 | width/height. <code>$rstyle</code> defines the initial rendition style |
963 | width/height. <code>$rstyle</code> defines the initial rendition style |
887 | (default: <code>OVERLAY_RSTYLE</code>). |
964 | (default: <code>OVERLAY_RSTYLE</code>).</p> |
888 | </dd> |
|
|
889 | <dd> |
|
|
890 | <p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put |
965 | <p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put |
891 | around the box.</p> |
966 | around the box.</p> |
892 | </dd> |
|
|
893 | <dd> |
|
|
894 | <p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the |
967 | <p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the |
895 | right/bottom side, respectively.</p> |
968 | right/bottom side, respectively.</p> |
896 | </dd> |
|
|
897 | <dd> |
|
|
898 | <p>This method returns an urxvt::overlay object. The overlay will be visible |
969 | <p>This method returns an urxvt::overlay object. The overlay will be visible |
899 | as long as the perl object is referenced.</p> |
970 | as long as the perl object is referenced.</p> |
900 | </dd> |
|
|
901 | <dd> |
|
|
902 | <p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p> |
971 | <p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p> |
903 | </dd> |
972 | <p> |
904 | <dl> |
973 | <dl> |
905 | <dt><strong><a name="item_set">$overlay->set ($x, $y, $text, $rend)</a></strong><br /> |
974 | <dt>$overlay->set ($x, $y, $text, $rend)</dt> |
906 | </dt> |
975 | <dd> |
907 | <dd> |
976 | <p>Similar to <code>$term->ROW_t</code> and <code>$term->ROW_r</code> in that it puts |
908 | Similar to <a href="#item_row_t"><code>$term->ROW_t</code></a> and <a href="#item_row_r"><code>$term->ROW_r</code></a> in that it puts |
|
|
909 | text in rxvt-unicode's special encoding and an array of rendition values |
977 | text in rxvt-unicode's special encoding and an array of rendition values |
910 | at a specific position inside the overlay. |
978 | at a specific position inside the overlay.</p> |
|
|
979 | </dd> |
|
|
980 | <dt>$overlay->hide</dt> |
|
|
981 | <dd> |
|
|
982 | <p>If visible, hide the overlay, but do not destroy it.</p> |
|
|
983 | </dd> |
|
|
984 | <dt>$overlay->show</dt> |
|
|
985 | <dd> |
|
|
986 | <p>If hidden, display the overlay again.</p> |
|
|
987 | </dd> |
|
|
988 | </dl> |
|
|
989 | </p> |
911 | </dd> |
990 | </dd> |
912 | <p></p> |
991 | <dt>$popup = $term->popup ($event)</dt> |
913 | <dt><strong><a name="item_hide">$overlay->hide</a></strong><br /> |
|
|
914 | </dt> |
|
|
915 | <dd> |
992 | <dd> |
916 | If visible, hide the overlay, but do not destroy it. |
|
|
917 | </dd> |
|
|
918 | <p></p> |
|
|
919 | <dt><strong><a name="item_show">$overlay->show</a></strong><br /> |
|
|
920 | </dt> |
|
|
921 | <dd> |
|
|
922 | If hidden, display the overlay again. |
|
|
923 | </dd> |
|
|
924 | <p></p></dl> |
|
|
925 | <dt><strong>$popup = $term->popup ($event)</strong><br /> |
|
|
926 | </dt> |
|
|
927 | <dd> |
|
|
928 | Creates a new <code>urxvt::popup</code> object that implements a popup menu. The |
993 | <p>Creates a new <code>urxvt::popup</code> object that implements a popup menu. The |
929 | <code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, |
994 | <code>$event</code> <i>must</i> be the event causing the menu to pop up (a button event, |
930 | currently). |
995 | currently).</p> |
931 | </dd> |
996 | </dd> |
932 | <p></p> |
997 | <dt>$cellwidth = $term->strwidth ($string)</dt> |
933 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a></strong><br /> |
|
|
934 | </dt> |
|
|
935 | <dd> |
998 | <dd> |
936 | Returns the number of screen-cells this string would need. Correctly |
999 | <p>Returns the number of screen-cells this string would need. Correctly |
937 | accounts for wide and combining characters. |
1000 | accounts for wide and combining characters.</p> |
938 | </dd> |
1001 | </dd> |
939 | <p></p> |
1002 | <dt>$octets = $term->locale_encode ($string)</dt> |
940 | <dt><strong><a name="item_locale_encode">$octets = $term->locale_encode ($string)</a></strong><br /> |
|
|
941 | </dt> |
|
|
942 | <dd> |
1003 | <dd> |
943 | Convert the given text string into the corresponding locale encoding. |
1004 | <p>Convert the given text string into the corresponding locale encoding.</p> |
944 | </dd> |
1005 | </dd> |
945 | <p></p> |
1006 | <dt>$string = $term->locale_decode ($octets)</dt> |
946 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
|
|
947 | </dt> |
|
|
948 | <dd> |
1007 | <dd> |
949 | Convert the given locale-encoded octets into a perl string. |
1008 | <p>Convert the given locale-encoded octets into a perl string.</p> |
950 | </dd> |
1009 | </dd> |
951 | <p></p> |
1010 | <dt>$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</dt> |
952 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
|
|
953 | </dt> |
|
|
954 | <dd> |
1011 | <dd> |
955 | XORs the rendition values in the given span with the provided value |
1012 | <p>XORs the rendition values in the given span with the provided value |
956 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
1013 | (default: <code>RS_RVid</code>), which <i>MUST NOT</i> contain font styles. Useful in |
957 | refresh hooks to provide effects similar to the selection. |
1014 | refresh hooks to provide effects similar to the selection.</p> |
958 | </dd> |
1015 | </dd> |
959 | <p></p> |
|
|
960 | <dt><strong><a name="item_scr_xor_rect">$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong><br /> |
1016 | <dt>$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</dt> |
961 | </dt> |
|
|
962 | <dd> |
1017 | <dd> |
963 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
1018 | <p>Similar to <code>scr_xor_span</code>, but xors a rectangle instead. Trailing |
964 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
1019 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
965 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
1020 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
966 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
1021 | it instead. Both styles <i>MUST NOT</i> contain font styles.</p> |
967 | </dd> |
1022 | </dd> |
968 | <p></p> |
1023 | <dt>$term->scr_bell</dt> |
969 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
|
|
970 | </dt> |
|
|
971 | <dd> |
1024 | <dd> |
972 | Ring the bell! |
1025 | <p>Ring the bell!</p> |
973 | </dd> |
1026 | </dd> |
974 | <p></p> |
1027 | <dt>$term->scr_add_lines ($string)</dt> |
975 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
|
|
976 | </dt> |
|
|
977 | <dd> |
1028 | <dd> |
978 | Write the given text string to the screen, as if output by the application |
1029 | <p>Write the given text string to the screen, as if output by the application |
979 | running inside the terminal. It may not contain command sequences (escape |
1030 | running inside the terminal. It may not contain command sequences (escape |
980 | codes), but is free to use line feeds, carriage returns and tabs. The |
1031 | codes), but is free to use line feeds, carriage returns and tabs. The |
981 | string is a normal text string, not in locale-dependent encoding. |
1032 | string is a normal text string, not in locale-dependent encoding.</p> |
982 | </dd> |
|
|
983 | <dd> |
|
|
984 | <p>Normally its not a good idea to use this function, as programs might be |
1033 | <p>Normally its not a good idea to use this function, as programs might be |
985 | confused by changes in cursor position or scrolling. Its useful inside a |
1034 | confused by changes in cursor position or scrolling. Its useful inside a |
986 | <code>on_add_lines</code> hook, though.</p> |
1035 | <code>on_add_lines</code> hook, though.</p> |
987 | </dd> |
1036 | </dd> |
988 | <p></p> |
1037 | <dt>$term->scr_change_screen ($screen)</dt> |
989 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
|
|
990 | </dt> |
|
|
991 | <dd> |
1038 | <dd> |
|
|
1039 | <p>Switch to given screen - 0 primary, 1 secondary.</p> |
|
|
1040 | </dd> |
|
|
1041 | <dt>$term->cmd_parse ($octets)</dt> |
|
|
1042 | <dd> |
992 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
1043 | <p>Similar to <code>scr_add_lines</code>, but the argument must be in the |
993 | locale-specific encoding of the terminal and can contain command sequences |
1044 | locale-specific encoding of the terminal and can contain command sequences |
994 | (escape codes) that will be interpreted. |
1045 | (escape codes) that will be interpreted.</p> |
995 | </dd> |
1046 | </dd> |
996 | <p></p> |
1047 | <dt>$term->tt_write ($octets)</dt> |
997 | <dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
|
|
998 | </dt> |
|
|
999 | <dd> |
1048 | <dd> |
1000 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
1049 | <p>Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
1001 | pass characters instead of octets, you should convert your strings first |
1050 | pass characters instead of octets, you should convert your strings first |
1002 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
1051 | to the locale-specific encoding using <code>$term->locale_encode</code>.</p> |
1003 | </dd> |
1052 | </dd> |
1004 | <p></p> |
1053 | <dt>$old_events = $term->pty_ev_events ([$new_events])</dt> |
1005 | <dt><strong><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a></strong><br /> |
|
|
1006 | </dt> |
|
|
1007 | <dd> |
1054 | <dd> |
1008 | Replaces the event mask of the pty watcher by the given event mask. Can |
1055 | <p>Replaces the event mask of the pty watcher by the given event mask. Can |
1009 | be used to suppress input and output handling to the pty/tty. See the |
1056 | be used to suppress input and output handling to the pty/tty. See the |
1010 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
1057 | description of <code>urxvt::timer->events</code>. Make sure to always restore |
1011 | the previous value. |
1058 | the previous value.</p> |
1012 | </dd> |
1059 | </dd> |
1013 | <p></p> |
1060 | <dt>$fd = $term->pty_fd</dt> |
1014 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
|
|
1015 | </dt> |
|
|
1016 | <dd> |
1061 | <dd> |
1017 | Return the window id of the toplevel window. |
1062 | <p>Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty |
|
|
1063 | is used.</p> |
1018 | </dd> |
1064 | </dd> |
1019 | <p></p> |
1065 | <dt>$windowid = $term->parent</dt> |
1020 | <dt><strong><a name="item_vt">$windowid = $term->vt</a></strong><br /> |
|
|
1021 | </dt> |
|
|
1022 | <dd> |
1066 | <dd> |
1023 | Return the window id of the terminal window. |
1067 | <p>Return the window id of the toplevel window.</p> |
1024 | </dd> |
1068 | </dd> |
1025 | <p></p> |
1069 | <dt>$windowid = $term->vt</dt> |
1026 | <dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong><br /> |
|
|
1027 | </dt> |
|
|
1028 | <dd> |
1070 | <dd> |
|
|
1071 | <p>Return the window id of the terminal window.</p> |
|
|
1072 | </dd> |
|
|
1073 | <dt>$term->vt_emask_add ($x_event_mask)</dt> |
|
|
1074 | <dd> |
1029 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1075 | <p>Adds the specified events to the vt event mask. Useful e.g. when you want |
1030 | to receive pointer events all the times: |
1076 | to receive pointer events all the times:</p> |
1031 | </dd> |
1077 | <pre> $term->vt_emask_add (urxvt::PointerMotionMask); |
1032 | <dd> |
1078 | |
1033 | <pre> |
1079 | </pre> |
1034 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
|
|
1035 | </dd> |
1080 | </dd> |
1036 | <p></p> |
1081 | <dt>$term->focus_in</dt> |
1037 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1082 | <dt>$term->focus_out</dt> |
1038 | </dt> |
1083 | <dt>$term->key_press ($state, $keycode[, $time])</dt> |
1039 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
1084 | <dt>$term->key_release ($state, $keycode[, $time])</dt> |
1040 | </dt> |
|
|
1041 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
|
|
1042 | </dt> |
|
|
1043 | <dt><strong><a name="item_fheight">$font_height = $term->fheight</a></strong><br /> |
|
|
1044 | </dt> |
|
|
1045 | <dt><strong><a name="item_fbase">$font_ascent = $term->fbase</a></strong><br /> |
|
|
1046 | </dt> |
|
|
1047 | <dt><strong><a name="item_nrow">$terminal_rows = $term->nrow</a></strong><br /> |
|
|
1048 | </dt> |
|
|
1049 | <dt><strong><a name="item_ncol">$terminal_columns = $term->ncol</a></strong><br /> |
|
|
1050 | </dt> |
|
|
1051 | <dt><strong><a name="item_focus">$has_focus = $term->focus</a></strong><br /> |
|
|
1052 | </dt> |
|
|
1053 | <dt><strong><a name="item_mapped">$is_mapped = $term->mapped</a></strong><br /> |
|
|
1054 | </dt> |
|
|
1055 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
|
|
1056 | </dt> |
|
|
1057 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
|
|
1058 | </dt> |
|
|
1059 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
|
|
1060 | </dt> |
|
|
1061 | <dd> |
1085 | <dd> |
|
|
1086 | <p>Deliver various fake events to to terminal.</p> |
|
|
1087 | </dd> |
|
|
1088 | <dt>$window_width = $term->width</dt> |
|
|
1089 | <dt>$window_height = $term->height</dt> |
|
|
1090 | <dt>$font_width = $term->fwidth</dt> |
|
|
1091 | <dt>$font_height = $term->fheight</dt> |
|
|
1092 | <dt>$font_ascent = $term->fbase</dt> |
|
|
1093 | <dt>$terminal_rows = $term->nrow</dt> |
|
|
1094 | <dt>$terminal_columns = $term->ncol</dt> |
|
|
1095 | <dt>$has_focus = $term->focus</dt> |
|
|
1096 | <dt>$is_mapped = $term->mapped</dt> |
|
|
1097 | <dt>$max_scrollback = $term->saveLines</dt> |
|
|
1098 | <dt>$nrow_plus_saveLines = $term->total_rows</dt> |
|
|
1099 | <dt>$topmost_scrollback_row = $term->top_row</dt> |
|
|
1100 | <dd> |
1062 | Return various integers describing terminal characteristics. |
1101 | <p>Return various integers describing terminal characteristics.</p> |
1063 | </dd> |
1102 | </dd> |
1064 | <p></p> |
1103 | <dt>$x_display = $term->display_id</dt> |
1065 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
1066 | </dt> |
|
|
1067 | <dd> |
1104 | <dd> |
1068 | Return the DISPLAY used by rxvt-unicode. |
1105 | <p>Return the DISPLAY used by rxvt-unicode.</p> |
1069 | </dd> |
1106 | </dd> |
1070 | <p></p> |
1107 | <dt>$lc_ctype = $term->locale</dt> |
1071 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
|
|
1072 | </dt> |
|
|
1073 | <dd> |
1108 | <dd> |
1074 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1109 | <p>Returns the LC_CTYPE category string used by this rxvt-unicode.</p> |
1075 | </dd> |
1110 | </dd> |
1076 | <p></p> |
1111 | <dt>$env = $term->env</dt> |
1077 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
|
|
1078 | </dt> |
|
|
1079 | <dd> |
1112 | <dd> |
1080 | Returns a copy of the environment in effect for the terminal as a hashref |
1113 | <p>Returns a copy of the environment in effect for the terminal as a hashref |
1081 | similar to <code>\%ENV</code>. |
1114 | similar to <code>\%ENV</code>.</p> |
1082 | </dd> |
1115 | </dd> |
1083 | <p></p> |
1116 | <dt>@envv = $term->envv</dt> |
1084 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
|
|
1085 | </dt> |
|
|
1086 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
|
|
1087 | </dt> |
|
|
1088 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
|
|
1089 | </dt> |
|
|
1090 | <dd> |
1117 | <dd> |
|
|
1118 | <p>Returns the environment as array of strings of the form <code>VAR=VALUE</code>.</p> |
|
|
1119 | </dd> |
|
|
1120 | <dt>@argv = $term->argv</dt> |
|
|
1121 | <dd> |
|
|
1122 | <p>Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1123 | includes the program name as first element.</p> |
|
|
1124 | </dd> |
|
|
1125 | <dt>$modifiermask = $term->ModLevel3Mask</dt> |
|
|
1126 | <dt>$modifiermask = $term->ModMetaMask</dt> |
|
|
1127 | <dt>$modifiermask = $term->ModNumLockMask</dt> |
|
|
1128 | <dd> |
1091 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
1129 | <p>Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1092 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1130 | AltGr), the meta key (often Alt) and the num lock key, if applicable.</p> |
1093 | </dd> |
1131 | </dd> |
1094 | <p></p> |
1132 | <dt>$screen = $term->current_screen</dt> |
1095 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
|
|
1096 | </dt> |
|
|
1097 | <dd> |
1133 | <dd> |
|
|
1134 | <p>Returns the currently displayed screen (0 primary, 1 secondary).</p> |
|
|
1135 | </dd> |
|
|
1136 | <dt>$cursor_is_hidden = $term->hidden_cursor</dt> |
|
|
1137 | <dd> |
|
|
1138 | <p>Returns whether the cursor is currently hidden or not.</p> |
|
|
1139 | </dd> |
|
|
1140 | <dt>$view_start = $term->view_start ([$newvalue])</dt> |
|
|
1141 | <dd> |
1098 | Returns the negative row number of the topmost line. Minimum value is |
1142 | <p>Returns the row number of the topmost displayed line. Maximum value is |
1099 | <code>0</code>, which displays the normal terminal contents. Larger values scroll |
1143 | <code>0</code>, which displays the normal terminal contents. Lower values scroll |
1100 | this many lines into the scrollback buffer. |
1144 | this many lines into the scrollback buffer.</p> |
1101 | </dd> |
1145 | </dd> |
1102 | <p></p> |
1146 | <dt>$term->want_refresh</dt> |
1103 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
|
|
1104 | </dt> |
|
|
1105 | <dd> |
1147 | <dd> |
1106 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1148 | <p>Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1107 | compare the on-screen display with its stored representation. If they |
1149 | compare the on-screen display with its stored representation. If they |
1108 | differ, it redraws the differences. |
1150 | differ, it redraws the differences.</p> |
1109 | </dd> |
|
|
1110 | <dd> |
|
|
1111 | <p>Used after changing terminal contents to display them.</p> |
1151 | <p>Used after changing terminal contents to display them.</p> |
1112 | </dd> |
1152 | </dd> |
1113 | <p></p> |
1153 | <dt>$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</dt> |
1114 | <dt><strong><a name="item_row_t">$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br /> |
|
|
1115 | </dt> |
|
|
1116 | <dd> |
1154 | <dd> |
1117 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
1155 | <p>Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
1118 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
1156 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
1119 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
1157 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
1120 | line <a href="#item_nsaved"><code>-$term->nsaved</code></a>. Nothing will be returned if a nonexistent line |
1158 | line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line |
1121 | is requested. |
1159 | is requested.</p> |
1122 | </dd> |
|
|
1123 | <dd> |
|
|
1124 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
1160 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
1125 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
1161 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
1126 | to replace only parts of a line. The font index in the rendition will |
1162 | to replace only parts of a line. The font index in the rendition will |
1127 | automatically be updated.</p> |
1163 | automatically be updated.</p> |
1128 | </dd> |
|
|
1129 | <dd> |
|
|
1130 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
1164 | <p><code>$text</code> is in a special encoding: tabs and wide characters that use more |
1131 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1165 | than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535) |
1132 | (<code>chr 65535</code>). Characters with combining characters and other characters |
1166 | characters. Characters with combining characters and other characters that |
1133 | that do not fit into the normal tetx encoding will be replaced with |
1167 | do not fit into the normal tetx encoding will be replaced with characters |
1134 | characters in the private use area.</p> |
1168 | in the private use area.</p> |
1135 | </dd> |
|
|
1136 | <dd> |
|
|
1137 | <p>You have to obey this encoding when changing text. The advantage is |
1169 | <p>You have to obey this encoding when changing text. The advantage is |
1138 | that <code>substr</code> and similar functions work on screen cells and not on |
1170 | that <code>substr</code> and similar functions work on screen cells and not on |
1139 | characters.</p> |
1171 | characters.</p> |
1140 | </dd> |
1172 | <p>The methods <code>$term->special_encode</code> and <code>$term->special_decode</code> |
1141 | <dd> |
|
|
1142 | <p>The methods <a href="#item_special_encode"><code>$term->special_encode</code></a> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
|
|
1143 | can be used to convert normal strings into this encoding and vice versa.</p> |
1173 | can be used to convert normal strings into this encoding and vice versa.</p> |
1144 | </dd> |
1174 | </dd> |
1145 | <p></p> |
1175 | <dt>$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</dt> |
1146 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
|
|
1147 | </dt> |
|
|
1148 | <dd> |
1176 | <dd> |
1149 | Like <a href="#item_row_t"><code>$term->ROW_t</code></a>, but returns an arrayref with rendition |
1177 | <p>Like <code>$term->ROW_t</code>, but returns an arrayref with rendition |
1150 | bitsets. Rendition bitsets contain information about colour, font, font |
1178 | bitsets. Rendition bitsets contain information about colour, font, font |
1151 | styles and similar information. See also <a href="#item_row_t"><code>$term->ROW_t</code></a>. |
1179 | styles and similar information. See also <code>$term->ROW_t</code>.</p> |
1152 | </dd> |
|
|
1153 | <dd> |
|
|
1154 | <p>When setting rendition, the font mask will be ignored.</p> |
1180 | <p>When setting rendition, the font mask will be ignored.</p> |
1155 | </dd> |
|
|
1156 | <dd> |
|
|
1157 | <p>See the section on RENDITION, above.</p> |
1181 | <p>See the section on RENDITION, above.</p> |
1158 | </dd> |
1182 | </dd> |
1159 | <p></p> |
1183 | <dt>$length = $term->ROW_l ($row_number[, $new_length])</dt> |
1160 | <dt><strong><a name="item_row_l">$length = $term->ROW_l ($row_number[, $new_length])</a></strong><br /> |
|
|
1161 | </dt> |
|
|
1162 | <dd> |
1184 | <dd> |
1163 | Returns the number of screen cells that are in use (``the line |
1185 | <p>Returns the number of screen cells that are in use ("the line |
1164 | length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term->ncol</code></a> if the |
1186 | length"). Unlike the urxvt core, this returns <code>$term->ncol</code> if the |
1165 | line is joined with the following one. |
1187 | line is joined with the following one.</p> |
1166 | </dd> |
1188 | </dd> |
1167 | <p></p> |
1189 | <dt>$bool = $term->is_longer ($row_number)</dt> |
1168 | <dt><strong><a name="item_is_longer">$bool = $term->is_longer ($row_number)</a></strong><br /> |
|
|
1169 | </dt> |
|
|
1170 | <dd> |
1190 | <dd> |
1171 | Returns true if the row is part of a multiple-row logical ``line'' (i.e. |
1191 | <p>Returns true if the row is part of a multiple-row logical "line" (i.e. |
1172 | joined with the following row), which means all characters are in use |
1192 | joined with the following row), which means all characters are in use |
1173 | and it is continued on the next row (and possibly a continuation of the |
1193 | and it is continued on the next row (and possibly a continuation of the |
1174 | previous row(s)). |
1194 | previous row(s)).</p> |
1175 | </dd> |
1195 | </dd> |
1176 | <p></p> |
1196 | <dt>$line = $term->line ($row_number)</dt> |
1177 | <dt><strong><a name="item_line">$line = $term->line ($row_number)</a></strong><br /> |
|
|
1178 | </dt> |
|
|
1179 | <dd> |
1197 | <dd> |
1180 | Create and return a new <code>urxvt::line</code> object that stores information |
1198 | <p>Create and return a new <code>urxvt::line</code> object that stores information |
1181 | about the logical line that row <code>$row_number</code> is part of. It supports the |
1199 | about the logical line that row <code>$row_number</code> is part of. It supports the |
1182 | following methods: |
1200 | following methods:</p> |
|
|
1201 | <p> |
|
|
1202 | <dl> |
|
|
1203 | <dt>$text = $line->t ([$new_text])</dt> |
|
|
1204 | <dd> |
|
|
1205 | <p>Returns or replaces the full text of the line, similar to <code>ROW_t</code></p> |
|
|
1206 | </dd> |
|
|
1207 | <dt>$rend = $line->r ([$new_rend])</dt> |
|
|
1208 | <dd> |
|
|
1209 | <p>Returns or replaces the full rendition array of the line, similar to <code>ROW_r</code></p> |
|
|
1210 | </dd> |
|
|
1211 | <dt>$length = $line->l</dt> |
|
|
1212 | <dd> |
|
|
1213 | <p>Returns the length of the line in cells, similar to <code>ROW_l</code>.</p> |
|
|
1214 | </dd> |
|
|
1215 | <dt>$rownum = $line->beg</dt> |
|
|
1216 | <dt>$rownum = $line->end</dt> |
|
|
1217 | <dd> |
|
|
1218 | <p>Return the row number of the first/last row of the line, respectively.</p> |
|
|
1219 | </dd> |
|
|
1220 | <dt>$offset = $line->offset_of ($row, $col)</dt> |
|
|
1221 | <dd> |
|
|
1222 | <p>Returns the character offset of the given row|col pair within the logical |
|
|
1223 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1224 | offsets outside the string.</p> |
|
|
1225 | </dd> |
|
|
1226 | <dt>($row, $col) = $line->coord_of ($offset)</dt> |
|
|
1227 | <dd> |
|
|
1228 | <p>Translates a string offset into terminal coordinates again.</p> |
|
|
1229 | </dd> |
|
|
1230 | </dl> |
|
|
1231 | </p> |
1183 | </dd> |
1232 | </dd> |
|
|
1233 | <dt>$text = $term->special_encode $string</dt> |
|
|
1234 | <dd> |
|
|
1235 | <p>Converts a perl string into the special encoding used by rxvt-unicode, |
|
|
1236 | where one character corresponds to one screen cell. See |
|
|
1237 | <code>$term->ROW_t</code> for details.</p> |
|
|
1238 | </dd> |
|
|
1239 | <dt>$string = $term->special_decode $text</dt> |
|
|
1240 | <dd> |
|
|
1241 | <p>Converts rxvt-unicodes text representation into a perl string. See |
|
|
1242 | <code>$term->ROW_t</code> for details.</p> |
|
|
1243 | </dd> |
|
|
1244 | <dt>$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])</dt> |
|
|
1245 | <dt>$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])</dt> |
|
|
1246 | <dd> |
|
|
1247 | <p>Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1248 | manpage.</p> |
|
|
1249 | </dd> |
|
|
1250 | <dt>$success = $term->grab ($eventtime[, $sync])</dt> |
|
|
1251 | <dd> |
|
|
1252 | <p>Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1253 | synchronous (<code>$sync</code> is true). Also remembers the grab timestamp.</p> |
|
|
1254 | </dd> |
|
|
1255 | <dt>$term->allow_events_async</dt> |
|
|
1256 | <dd> |
|
|
1257 | <p>Calls XAllowEvents with AsyncBoth for the most recent grab.</p> |
|
|
1258 | </dd> |
|
|
1259 | <dt>$term->allow_events_sync</dt> |
|
|
1260 | <dd> |
|
|
1261 | <p>Calls XAllowEvents with SyncBoth for the most recent grab.</p> |
|
|
1262 | </dd> |
|
|
1263 | <dt>$term->allow_events_replay</dt> |
|
|
1264 | <dd> |
|
|
1265 | <p>Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1266 | recent grab.</p> |
|
|
1267 | </dd> |
|
|
1268 | <dt>$term->ungrab</dt> |
|
|
1269 | <dd> |
|
|
1270 | <p>Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1271 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1272 | the session.</p> |
|
|
1273 | </dd> |
|
|
1274 | <dt>$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</dt> |
|
|
1275 | <dt>$atom_name = $term->XGetAtomName ($atom)</dt> |
|
|
1276 | <dt>@atoms = $term->XListProperties ($window)</dt> |
|
|
1277 | <dt>($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</dt> |
|
|
1278 | <dt>$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</dt> |
|
|
1279 | <dt>$term->XDeleteProperty ($window, $property)</dt> |
|
|
1280 | <dt>$window = $term->DefaultRootWindow</dt> |
|
|
1281 | <dt>$term->XReparentWindow ($window, $parent, [$x, $y])</dt> |
|
|
1282 | <dt>$term->XMapWindow ($window)</dt> |
|
|
1283 | <dt>$term->XUnmapWindow ($window)</dt> |
|
|
1284 | <dt>$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</dt> |
|
|
1285 | <dt>($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</dt> |
|
|
1286 | <dt>$term->XChangeInput ($window, $add_events[, $del_events])</dt> |
|
|
1287 | <dd> |
|
|
1288 | <p>Various X or X-related functions. The <code>$term</code> object only serves as |
|
|
1289 | the source of the display, otherwise those functions map more-or-less |
|
|
1290 | directory onto the X functions of the same name.</p> |
|
|
1291 | </dd> |
|
|
1292 | </dl> |
|
|
1293 | |
|
|
1294 | </div> |
|
|
1295 | <h2 id="The_code_urxvt_popup_code_Class">The <code>urxvt::popup</code> Class</h2> |
|
|
1296 | <div id="The_code_urxvt_popup_code_Class_CONT"> |
1184 | <dl> |
1297 | <dl> |
1185 | <dt><strong><a name="item_t">$text = $line->t ([$new_text])</a></strong><br /> |
1298 | <dt>$popup->add_title ($title)</dt> |
1186 | </dt> |
|
|
1187 | <dd> |
1299 | <dd> |
1188 | Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
1300 | <p>Adds a non-clickable title to the popup.</p> |
1189 | </dd> |
1301 | </dd> |
1190 | <p></p> |
1302 | <dt>$popup->add_separator ([$sepchr])</dt> |
1191 | <dt><strong><a name="item_r">$rend = $line->r ([$new_rend])</a></strong><br /> |
|
|
1192 | </dt> |
|
|
1193 | <dd> |
1303 | <dd> |
1194 | Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
|
|
1195 | </dd> |
|
|
1196 | <p></p> |
|
|
1197 | <dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
|
|
1198 | </dt> |
|
|
1199 | <dd> |
|
|
1200 | Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>. |
|
|
1201 | </dd> |
|
|
1202 | <p></p> |
|
|
1203 | <dt><strong><a name="item_beg">$rownum = $line->beg</a></strong><br /> |
|
|
1204 | </dt> |
|
|
1205 | <dt><strong><a name="item_end">$rownum = $line->end</a></strong><br /> |
|
|
1206 | </dt> |
|
|
1207 | <dd> |
|
|
1208 | Return the row number of the first/last row of the line, respectively. |
|
|
1209 | </dd> |
|
|
1210 | <p></p> |
|
|
1211 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
|
|
1212 | </dt> |
|
|
1213 | <dd> |
|
|
1214 | Returns the character offset of the given row|col pair within the logical |
|
|
1215 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1216 | offsets outside the string. |
|
|
1217 | </dd> |
|
|
1218 | <p></p> |
|
|
1219 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
|
|
1220 | </dt> |
|
|
1221 | <dd> |
|
|
1222 | Translates a string offset into terminal coordinates again. |
|
|
1223 | </dd> |
|
|
1224 | <p></p></dl> |
|
|
1225 | <dt><strong><a name="item_special_encode">$text = $term->special_encode $string</a></strong><br /> |
|
|
1226 | </dt> |
|
|
1227 | <dd> |
|
|
1228 | Converts a perl string into the special encoding used by rxvt-unicode, |
|
|
1229 | where one character corresponds to one screen cell. See |
|
|
1230 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
|
|
1231 | </dd> |
|
|
1232 | <p></p> |
|
|
1233 | <dt><strong><a name="item_special_decode">$string = $term->special_decode $text</a></strong><br /> |
|
|
1234 | </dt> |
|
|
1235 | <dd> |
|
|
1236 | Converts rxvt-unicodes text reprsentation into a perl string. See |
|
|
1237 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
|
|
1238 | </dd> |
|
|
1239 | <p></p> |
|
|
1240 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
|
|
1241 | </dt> |
|
|
1242 | <dd> |
|
|
1243 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
1244 | </dd> |
|
|
1245 | <p></p> |
|
|
1246 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
|
|
1247 | </dt> |
|
|
1248 | <dd> |
|
|
1249 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1250 | synchronous (<code>$sync</code> is true). Also remembers the grab timestampe. |
|
|
1251 | </dd> |
|
|
1252 | <p></p> |
|
|
1253 | <dt><strong><a name="item_allow_events_async">$term->allow_events_async</a></strong><br /> |
|
|
1254 | </dt> |
|
|
1255 | <dd> |
|
|
1256 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1257 | </dd> |
|
|
1258 | <p></p> |
|
|
1259 | <dt><strong><a name="item_allow_events_sync">$term->allow_events_sync</a></strong><br /> |
|
|
1260 | </dt> |
|
|
1261 | <dd> |
|
|
1262 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1263 | </dd> |
|
|
1264 | <p></p> |
|
|
1265 | <dt><strong><a name="item_allow_events_replay">$term->allow_events_replay</a></strong><br /> |
|
|
1266 | </dt> |
|
|
1267 | <dd> |
|
|
1268 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1269 | recent grab. |
|
|
1270 | </dd> |
|
|
1271 | <p></p> |
|
|
1272 | <dt><strong><a name="item_ungrab">$term->ungrab</a></strong><br /> |
|
|
1273 | </dt> |
|
|
1274 | <dd> |
|
|
1275 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1276 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1277 | the session. |
|
|
1278 | </dd> |
|
|
1279 | <p></p></dl> |
|
|
1280 | <p> |
|
|
1281 | </p> |
|
|
1282 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
|
|
1283 | <dl> |
|
|
1284 | <dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong><br /> |
|
|
1285 | </dt> |
|
|
1286 | <dd> |
|
|
1287 | Adds a non-clickable title to the popup. |
|
|
1288 | </dd> |
|
|
1289 | <p></p> |
|
|
1290 | <dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong><br /> |
|
|
1291 | </dt> |
|
|
1292 | <dd> |
|
|
1293 | Creates a separator, optionally using the character given as <code>$sepchr</code>. |
1304 | <p>Creates a separator, optionally using the character given as <code>$sepchr</code>.</p> |
1294 | </dd> |
1305 | </dd> |
1295 | <p></p> |
1306 | <dt>$popup->add_button ($text, $cb)</dt> |
1296 | <dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong><br /> |
|
|
1297 | </dt> |
|
|
1298 | <dd> |
1307 | <dd> |
1299 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
1308 | <p>Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
1300 | selected. |
1309 | selected.</p> |
1301 | </dd> |
1310 | </dd> |
1302 | <p></p> |
1311 | <dt>$popup->add_toggle ($text, $initial_value, $cb)</dt> |
1303 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
|
|
1304 | </dt> |
|
|
1305 | <dd> |
1312 | <dd> |
1306 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1313 | <p>Adds a toggle/checkbox item to the popup. The callback gets called |
1307 | whenever it gets toggled, with a boolean indicating its value as its first |
1314 | whenever it gets toggled, with a boolean indicating its new value as its |
1308 | argument. |
1315 | first argument.</p> |
1309 | </dd> |
1316 | </dd> |
1310 | <p></p> |
1317 | <dt>$popup->show</dt> |
1311 | <dt><strong>$popup->show</strong><br /> |
|
|
1312 | </dt> |
|
|
1313 | <dd> |
1318 | <dd> |
1314 | Displays the popup (which is initially hidden). |
1319 | <p>Displays the popup (which is initially hidden).</p> |
1315 | </dd> |
1320 | </dd> |
1316 | <p></p></dl> |
1321 | </dl> |
1317 | <p> |
1322 | |
1318 | </p> |
1323 | </div> |
1319 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1324 | <h2 id="The_code_urxvt_timer_code_Class">The <code>urxvt::timer</code> Class</h2> |
|
|
1325 | <div id="The_code_urxvt_timer_code_Class_CONT"> |
1320 | <p>This class implements timer watchers/events. Time is represented as a |
1326 | <p>This class implements timer watchers/events. Time is represented as a |
1321 | fractional number of seconds since the epoch. Example:</p> |
1327 | fractional number of seconds since the epoch. Example:</p> |
1322 | <pre> |
|
|
1323 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
1328 | <pre> $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
1324 | $term->{timer} = urxvt::timer |
1329 | $term->{timer} = urxvt::timer |
1325 | ->new |
1330 | ->new |
1326 | ->interval (1) |
1331 | ->interval (1) |
1327 | ->cb (sub { |
1332 | ->cb (sub { |
1328 | $term->{overlay}->set (0, 0, |
1333 | $term->{overlay}->set (0, 0, |
1329 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1334 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1330 | });</pre> |
1335 | }); |
|
|
1336 | |
|
|
1337 | </pre> |
1331 | <dl> |
1338 | <dl> |
1332 | <dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> |
1339 | <dt>$timer = new urxvt::timer</dt> |
1333 | </dt> |
|
|
1334 | <dd> |
1340 | <dd> |
1335 | Create a new timer object in started state. It is scheduled to fire |
1341 | <p>Create a new timer object in started state. It is scheduled to fire |
1336 | immediately. |
1342 | immediately.</p> |
1337 | </dd> |
1343 | </dd> |
1338 | <p></p> |
1344 | <dt>$timer = $timer->cb (sub { my ($timer) = @_; ... })</dt> |
1339 | <dt><strong><a name="item_cb">$timer = $timer->cb (sub { my ($timer) = @_; ... })</a></strong><br /> |
|
|
1340 | </dt> |
|
|
1341 | <dd> |
1345 | <dd> |
1342 | Set the callback to be called when the timer triggers. |
1346 | <p>Set the callback to be called when the timer triggers.</p> |
1343 | </dd> |
1347 | </dd> |
1344 | <p></p> |
1348 | <dt>$tstamp = $timer->at</dt> |
1345 | <dt><strong><a name="item_at">$tstamp = $timer->at</a></strong><br /> |
|
|
1346 | </dt> |
|
|
1347 | <dd> |
1349 | <dd> |
1348 | Return the time this watcher will fire next. |
1350 | <p>Return the time this watcher will fire next.</p> |
1349 | </dd> |
1351 | </dd> |
1350 | <p></p> |
|
|
1351 | <dt><strong>$timer = $timer->set ($tstamp)</strong><br /> |
1352 | <dt>$timer = $timer->set ($tstamp)</dt> |
1352 | </dt> |
|
|
1353 | <dd> |
1353 | <dd> |
1354 | Set the time the event is generated to $tstamp. |
1354 | <p>Set the time the event is generated to $tstamp.</p> |
1355 | </dd> |
1355 | </dd> |
1356 | <p></p> |
1356 | <dt>$timer = $timer->interval ($interval)</dt> |
1357 | <dt><strong><a name="item_interval">$timer = $timer->interval ($interval)</a></strong><br /> |
|
|
1358 | </dt> |
|
|
1359 | <dd> |
1357 | <dd> |
1360 | Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically |
1358 | <p>Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically |
1361 | stop after it has fired once. If <code>$interval</code> is non-zero, then the timer |
1359 | stop after it has fired once. If <code>$interval</code> is non-zero, then the timer |
1362 | is automatically rescheduled at the given intervals. |
1360 | is automatically rescheduled at the given intervals.</p> |
1363 | </dd> |
1361 | </dd> |
1364 | <p></p> |
1362 | <dt>$timer = $timer->start</dt> |
1365 | <dt><strong><a name="item_start">$timer = $timer->start</a></strong><br /> |
|
|
1366 | </dt> |
|
|
1367 | <dd> |
1363 | <dd> |
1368 | Start the timer. |
1364 | <p>Start the timer.</p> |
1369 | </dd> |
1365 | </dd> |
1370 | <p></p> |
|
|
1371 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
1366 | <dt>$timer = $timer->start ($tstamp)</dt> |
1372 | </dt> |
|
|
1373 | <dd> |
1367 | <dd> |
1374 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
1368 | <p>Set the event trigger time to <code>$tstamp</code> and start the timer.</p> |
1375 | </dd> |
1369 | </dd> |
1376 | <p></p> |
1370 | <dt>$timer = $timer->after ($delay)</dt> |
1377 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
|
|
1378 | </dt> |
|
|
1379 | <dd> |
1371 | <dd> |
1380 | Stop the timer. |
1372 | <p>Like <code>start</code>, but sets the expiry timer to c<urxvt::NOW + $delay>.</p> |
1381 | </dd> |
1373 | </dd> |
1382 | <p></p></dl> |
1374 | <dt>$timer = $timer->stop</dt> |
1383 | <p> |
1375 | <dd> |
1384 | </p> |
1376 | <p>Stop the timer.</p> |
|
|
1377 | </dd> |
|
|
1378 | </dl> |
|
|
1379 | |
|
|
1380 | </div> |
1385 | <h2><a name="the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></h2> |
1381 | <h2 id="The_code_urxvt_iow_code_Class">The <code>urxvt::iow</code> Class</h2> |
|
|
1382 | <div id="The_code_urxvt_iow_code_Class_CONTEN"> |
1386 | <p>This class implements io watchers/events. Example:</p> |
1383 | <p>This class implements io watchers/events. Example:</p> |
1387 | <pre> |
|
|
1388 | $term->{socket} = ... |
1384 | <pre> $term->{socket} = ... |
1389 | $term->{iow} = urxvt::iow |
1385 | $term->{iow} = urxvt::iow |
1390 | ->new |
1386 | ->new |
1391 | ->fd (fileno $term->{socket}) |
1387 | ->fd (fileno $term->{socket}) |
1392 | ->events (urxvt::EVENT_READ) |
1388 | ->events (urxvt::EVENT_READ) |
1393 | ->start |
1389 | ->start |
1394 | ->cb (sub { |
1390 | ->cb (sub { |
1395 | my ($iow, $revents) = @_; |
1391 | my ($iow, $revents) = @_; |
1396 | # $revents must be 1 here, no need to check |
1392 | # $revents must be 1 here, no need to check |
1397 | sysread $term->{socket}, my $buf, 8192 |
1393 | sysread $term->{socket}, my $buf, 8192 |
1398 | or end-of-file; |
1394 | or end-of-file; |
1399 | });</pre> |
1395 | }); |
|
|
1396 | |
|
|
1397 | |
|
|
1398 | |
|
|
1399 | |
|
|
1400 | </pre> |
1400 | <dl> |
1401 | <dl> |
1401 | <dt><strong><a name="item__24iow__3d_new_urxvt_3a_3aiow">$iow = new urxvt::iow</a></strong><br /> |
1402 | <dt>$iow = new urxvt::iow</dt> |
1402 | </dt> |
|
|
1403 | <dd> |
1403 | <dd> |
1404 | Create a new io watcher object in stopped state. |
1404 | <p>Create a new io watcher object in stopped state.</p> |
1405 | </dd> |
1405 | </dd> |
1406 | <p></p> |
|
|
1407 | <dt><strong>$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })</strong><br /> |
1406 | <dt>$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })</dt> |
1408 | </dt> |
|
|
1409 | <dd> |
1407 | <dd> |
1410 | Set the callback to be called when io events are triggered. <code>$reventmask</code> |
1408 | <p>Set the callback to be called when io events are triggered. <code>$reventmask</code> |
1411 | is a bitset as described in the <a href="#item_events"><code>events</code></a> method. |
1409 | is a bitset as described in the <code>events</code> method.</p> |
1412 | </dd> |
1410 | </dd> |
1413 | <p></p> |
1411 | <dt>$iow = $iow->fd ($fd)</dt> |
1414 | <dt><strong><a name="item_fd">$iow = $iow->fd ($fd)</a></strong><br /> |
|
|
1415 | </dt> |
|
|
1416 | <dd> |
1412 | <dd> |
1417 | Set the filedescriptor (not handle) to watch. |
1413 | <p>Set the file descriptor (not handle) to watch.</p> |
1418 | </dd> |
1414 | </dd> |
1419 | <p></p> |
1415 | <dt>$iow = $iow->events ($eventmask)</dt> |
1420 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
|
|
1421 | </dt> |
|
|
1422 | <dd> |
1416 | <dd> |
1423 | Set the event mask to watch. The only allowed values are |
1417 | <p>Set the event mask to watch. The only allowed values are |
1424 | <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
1418 | <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
1425 | together, or <code>urxvt::EVENT_NONE</code>. |
1419 | together, or <code>urxvt::EVENT_NONE</code>.</p> |
1426 | </dd> |
1420 | </dd> |
1427 | <p></p> |
1421 | <dt>$iow = $iow->start</dt> |
1428 | <dt><strong>$iow = $iow->start</strong><br /> |
|
|
1429 | </dt> |
|
|
1430 | <dd> |
1422 | <dd> |
1431 | Start watching for requested events on the given handle. |
1423 | <p>Start watching for requested events on the given handle.</p> |
1432 | </dd> |
1424 | </dd> |
1433 | <p></p> |
1425 | <dt>$iow = $iow->stop</dt> |
1434 | <dt><strong>$iow = $iow->stop</strong><br /> |
|
|
1435 | </dt> |
|
|
1436 | <dd> |
1426 | <dd> |
1437 | Stop watching for events on the given filehandle. |
1427 | <p>Stop watching for events on the given file handle.</p> |
1438 | </dd> |
1428 | </dd> |
1439 | <p></p></dl> |
1429 | </dl> |
1440 | <p> |
1430 | |
|
|
1431 | </div> |
|
|
1432 | <h2 id="The_code_urxvt_iw_code_Class">The <code>urxvt::iw</code> Class</h2> |
|
|
1433 | <div id="The_code_urxvt_iw_code_Class_CONTENT"> |
|
|
1434 | <p>This class implements idle watchers, that get called automatically when |
|
|
1435 | the process is idle. They should return as fast as possible, after doing |
|
|
1436 | some useful work.</p> |
|
|
1437 | <dl> |
|
|
1438 | <dt>$iw = new urxvt::iw</dt> |
|
|
1439 | <dd> |
|
|
1440 | <p>Create a new idle watcher object in stopped state.</p> |
|
|
1441 | </dd> |
|
|
1442 | <dt>$iw = $iw->cb (sub { my ($iw) = @_; ... })</dt> |
|
|
1443 | <dd> |
|
|
1444 | <p>Set the callback to be called when the watcher triggers.</p> |
|
|
1445 | </dd> |
|
|
1446 | <dt>$timer = $timer->start</dt> |
|
|
1447 | <dd> |
|
|
1448 | <p>Start the watcher.</p> |
|
|
1449 | </dd> |
|
|
1450 | <dt>$timer = $timer->stop</dt> |
|
|
1451 | <dd> |
|
|
1452 | <p>Stop the watcher.</p> |
|
|
1453 | </dd> |
|
|
1454 | </dl> |
|
|
1455 | |
|
|
1456 | </div> |
|
|
1457 | <h2 id="The_code_urxvt_pw_code_Class">The <code>urxvt::pw</code> Class</h2> |
|
|
1458 | <div id="The_code_urxvt_pw_code_Class_CONTENT"> |
|
|
1459 | <p>This class implements process watchers. They create an event whenever a |
|
|
1460 | process exits, after which they stop automatically.</p> |
|
|
1461 | <pre> my $pid = fork; |
|
|
1462 | ... |
|
|
1463 | $term->{pw} = urxvt::pw |
|
|
1464 | ->new |
|
|
1465 | ->start ($pid) |
|
|
1466 | ->cb (sub { |
|
|
1467 | my ($pw, $exit_status) = @_; |
|
|
1468 | ... |
|
|
1469 | }); |
|
|
1470 | |
1441 | </p> |
1471 | </pre> |
1442 | <hr /> |
1472 | <dl> |
1443 | <h1><a name="environment">ENVIRONMENT</a></h1> |
1473 | <dt>$pw = new urxvt::pw</dt> |
1444 | <p> |
1474 | <dd> |
1445 | </p> |
1475 | <p>Create a new process watcher in stopped state.</p> |
1446 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1476 | </dd> |
|
|
1477 | <dt>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</dt> |
|
|
1478 | <dd> |
|
|
1479 | <p>Set the callback to be called when the timer triggers.</p> |
|
|
1480 | </dd> |
|
|
1481 | <dt>$pw = $timer->start ($pid)</dt> |
|
|
1482 | <dd> |
|
|
1483 | <p>Tells the watcher to start watching for process <code>$pid</code>.</p> |
|
|
1484 | </dd> |
|
|
1485 | <dt>$pw = $pw->stop</dt> |
|
|
1486 | <dd> |
|
|
1487 | <p>Stop the watcher.</p> |
|
|
1488 | </dd> |
|
|
1489 | </dl> |
|
|
1490 | |
|
|
1491 | </div> |
|
|
1492 | <h1 id="ENVIRONMENT">ENVIRONMENT</h1><p><a href="#TOP" class="toplink">Top</a></p> |
|
|
1493 | <div id="ENVIRONMENT_CONTENT"> |
|
|
1494 | |
|
|
1495 | </div> |
|
|
1496 | <h2 id="URXVT_PERL_VERBOSITY">URXVT_PERL_VERBOSITY</h2> |
|
|
1497 | <div id="URXVT_PERL_VERBOSITY_CONTENT"> |
1447 | <p>This variable controls the verbosity level of the perl extension. Higher |
1498 | <p>This variable controls the verbosity level of the perl extension. Higher |
1448 | numbers indicate more verbose output.</p> |
1499 | numbers indicate more verbose output.</p> |
1449 | <dl> |
1500 | <dl> |
1450 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1501 | <dt>== 0 - fatal messages</dt> |
1451 | </dt> |
1502 | <dt>>= 3 - script loading and management</dt> |
1452 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1503 | <dt>>=10 - all called hooks</dt> |
1453 | </dt> |
1504 | <dt>>=11 - hook return values</dt> |
1454 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong><br /> |
|
|
1455 | </dt> |
|
|
1456 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong><br /> |
|
|
1457 | </dt> |
|
|
1458 | </dl> |
1505 | </dl> |
1459 | <p> |
1506 | |
1460 | </p> |
1507 | </div> |
1461 | <hr /> |
1508 | <h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> |
1462 | <h1><a name="author">AUTHOR</a></h1> |
1509 | <div id="AUTHOR_CONTENT"> |
1463 | <pre> |
|
|
1464 | Marc Lehmann <pcg@goof.com> |
1510 | <pre> Marc Lehmann <pcg@goof.com> |
1465 | <a href="http://software.schmorp.de/pkg/rxvt-unicode">http://software.schmorp.de/pkg/rxvt-unicode</a></pre> |
1511 | http://software.schmorp.de/pkg/rxvt-unicode |
1466 | |
1512 | |
1467 | </body> |
1513 | </pre> |
1468 | |
1514 | |
|
|
1515 | </div> |
|
|
1516 | </div></body> |
1469 | </html> |
1517 | </html> |