[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvtperl.3.html

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.47 by root, Thu Nov 2 17:37:47 2006 UTC vs.
Revision 1.54 by root, Wed Aug 1 18:38:16 2007 UTC

…		…
1	<?xml version="1.0" ?>	1	<?xml version="1.0" encoding="UTF-8"?>
2	<!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">
3	<html xmlns="http://www.w3.org/1999/xhtml">	3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4	<head>	4	<head>
5	<title>rxvtperl - rxvt-unicode's embedded perl interpreter</title>	5	<title>rxvtperl</title>
6	<meta http-equiv="content-type" content="text/html; charset=utf-8" />	6	<meta name="description" content="Pod documentation for rxvtperl" />
7	<link rev="made" href="mailto:perl-binary@plan9.de" />	7	<meta name="inputfile" content="<standard input>" />
8	</head>	8	<meta name="outputfile" content="<standard output>" />
9		9	<meta name="created" content="Wed Aug 1 20:30:04 2007" />
10	<body style="background-color: white">	10	<meta name="generator" content="Pod::Xhtml 1.57" />
11		11	<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
12	<p><a name="__index__"></a></p>	12	<body>
		13	<div class="pod">
13	<!-- INDEX BEGIN -->	14	<!-- INDEX START -->
		15	<h3 id="TOP">Index</h3>
14		16
15	<ul>
16
17	<li><a href="#name">NAME</a></li>	17	<ul><li><a href="#NAME">NAME</a></li>
18	<li><a href="#synopsis">SYNOPSIS</a></li>	18	<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
19	<li><a href="#description">DESCRIPTION</a></li>	19	<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
20	<li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li>	20	<li><a href="#PREPACKAGED_EXTENSIONS">PREPACKAGED EXTENSIONS</a></li>
21	<li><a href="#api_documentation">API DOCUMENTATION</a></li>	21	<li><a href="#API_DOCUMENTATION">API DOCUMENTATION</a>
22	<ul>
23
24	<li><a href="#general_api_considerations">General API Considerations</a></li>	22	<ul><li><a href="#General_API_Considerations">General API Considerations</a></li>
25	<li><a href="#extension_objects">Extension Objects</a></li>	23	<li><a href="#Extension_Objects">Extension Objects</a></li>
26	<li><a href="#hooks">Hooks</a></li>	24	<li><a href="#Hooks">Hooks</a></li>
27	<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>
28	<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>
29	<li><a href="#rendition">RENDITION</a></li>	27	<li><a href="#RENDITION">RENDITION</a></li>
30	<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>
31	<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>
32	<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>
33	<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>
34	<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>
35	<li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li>	33	<li><a href="#The_code_urxvt_iw_code_Class">The <code>urxvt::iw</code> Class</a></li>
36	<li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li>	34	<li><a href="#The_code_urxvt_pw_code_Class">The <code>urxvt::pw</code> Class</a></li>
37	</ul>
38
39	<li><a href="#environment">ENVIRONMENT</a></li>
40	<ul>
41
42	<li><a href="#urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></li>
43	</ul>
44
45	<li><a href="#author">AUTHOR</a></li>
46	</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 />
47	<!-- INDEX END -->	44	<!-- INDEX END -->
48		45
49	<hr />	46	<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
50	<p>	47	<div id="NAME_CONTENT">
51	</p>
52	<hr />
53	<h1><a name="name">NAME</a></h1>
54	<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>	48	<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
55	<p>	49
56	</p>	50	</div>
57	<hr />	51	<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
58	<h1><a name="synopsis">SYNOPSIS</a></h1>	52	<div id="SYNOPSIS_CONTENT">
59	<pre>
60	# create a file grab_test in $HOME:</pre>	53	<pre> # create a file grab_test in $HOME:
61	<pre>	54
62	sub on_sel_grab {	55	sub on_sel_grab {
63	warn "you selected ", $_[0]->selection;	56	warn "you selected ", $_[0]->selection;
64	()	57	()
65	}</pre>	58	}
66	<pre>	59
67	# start a rxvt using it:</pre>	60	# start a rxvt using it:
68	<pre>	61
69	rxvt --perl-lib $HOME -pe grab_test</pre>	62	rxvt --perl-lib $HOME -pe grab_test
70	<p>	63
71	</p>	64	</pre>
72	<hr />	65
73	<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">
74	<p>Every time a terminal object gets created, extension scripts specified via	69	<p>Every time a terminal object gets created, extension scripts specified via
75	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>
76	<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
77	thus must be encoded as UTF-8.</p>	72	thus must be encoded as UTF-8.</p>
78	<p>Each script will only ever be loaded once, even in rxvtd, where	73	<p>Each script will only ever be loaded once, even in rxvtd, where
79	scripts will be shared (but not enabled) for all terminals.</p>	74	scripts will be shared (but not enabled) for all terminals.</p>
80	<p>	75	<p>You can disable the embedded perl interpreter by setting both "perl-ext"
81	</p>	76	and "perl-ext-common" resources to the empty string.</p>
82	<hr />	77
83	<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">
84	<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
85	find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>	82	find them in <cite>/opt/rxvt/lib/urxvt/perl/</cite>.</p>
86	<p>You can activate them like this:</p>	83	<p>You can activate them like this:</p>
		84	<pre> rxvt -pe <extensionname>
		85
87	<pre>	86	</pre>
88	rxvt -pe <extensionname></pre>
89	<p>Or by adding them to the resource for extensions loaded by default:</p>	87	<p>Or by adding them to the resource for extensions loaded by default:</p>
90	<pre>
91	URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre>	88	<pre> URxvt.perl-ext-common: default,automove-background,selection-autotransform
		89
		90	</pre>
92	<dl>	91	<dl>
93	<dt><strong><a name="item_selection">selection (enabled by default)</a></strong>	92	<dt>selection (enabled by default)</dt>
94
95	<dd>	93	<dd>
96	<p>(More) intelligent selection. This extension tries to be more intelligent	94	<p>(More) intelligent selection. This extension tries to be more intelligent
97	when the user extends selections (double-click and further clicks). Right	95	when the user extends selections (double-click and further clicks). Right
98	now, it tries to select words, urls and complete shell-quoted	96	now, it tries to select words, urls and complete shell-quoted
99	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
100	<code>--quoting-style=shell</code>.</p>	98	<code>--quoting-style=shell</code>.</p>
101	</dd>
102	<dd>
103	<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
104	will enlarge the selection.</p>	100	will enlarge the selection.</p>
105	</dd>
106	<dd>
107	<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
108	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
109	specifying resources of the form:</p>	103	specifying resources of the form:</p>
110	</dd>
111	<dd>
112	<pre>
113	URxvt.selection.pattern-0: perl-regex	104	<pre> URxvt.selection.pattern-0: perl-regex
114	URxvt.selection.pattern-1: perl-regex	105	URxvt.selection.pattern-1: perl-regex
115	...</pre>	106	...
116	</dd>	107
117	<dd>	108	</pre>
118	<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
119	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
120	the match. For example, the following adds a regex that matches everything	111	the match. For example, the following adds a regex that matches everything
121	between two vertical bars:</p>	112	between two vertical bars:</p>
122	</dd>	113	<pre> URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
123	<dd>	114
124	<pre>	115	</pre>
125	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|</pre>
126	</dd>
127	<dd>
128	<p>Another example: Programs I use often output ``absolute path: '' at the	116	<p>Another example: Programs I use often output "absolute path: " at the
129	beginning of a line when they process multiple files. The following	117	beginning of a line when they process multiple files. The following
130	pattern matches the filename (note, there is a single space at the very	118	pattern matches the filename (note, there is a single space at the very
131	end):</p>	119	end):</p>
132	</dd>	120	<pre> URxvt.selection.pattern-0: ^(/[^:]+):\
133	<dd>	121
134	<pre>	122	</pre>
135	URxvt.selection.pattern-0: ^(/[^:]+):\</pre>
136	</dd>
137	<dd>
138	<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
139	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>
140	</dd>
141	<dd>
142	<p>This extension also offers following bindable keyboard commands:</p>	125	<p>This extension also offers following bindable keyboard commands:</p>
143	</dd>	126	<p>
144	<dl>	127	<dl>
145	<dt><strong><a name="item_rot13">rot13</a></strong>	128	<dt>rot13</dt>
146		129	<dd>
147	<dd>
148	<p>Rot-13 the selection when activated. Used via keyboard trigger:</p>	130	<p>Rot-13 the selection when activated. Used via keyboard trigger:</p>
149	</dd>	131	<pre> URxvt.keysym.C-M-r: perl:selection:rot13
150	<dd>	132
151	<pre>	133	</pre>
152	URxvt.keysym.C-M-r: perl:selection:rot13</pre>	134	</dd>
		135	</dl>
		136	</p>
153	</dd>	137	</dd>
154	</li>	138	<dt>option-popup (enabled by default)</dt>
155	</dl>
156	<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong>
157
158	<dd>	139	<dd>
159	<p>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
160	runtime.</p>	141	runtime.</p>
161	</dd>
162	<dd>
163	<p>Other extensions can extend this popup menu by pushing a code reference	142	<p>Other extensions can extend this popup menu by pushing a code reference
164	onto <code>@{ $term-</code>{option_popup_hook} }>, which gets called whenever the	143	onto <code>@{ $term-</code>{option_popup_hook} }>, which gets called whenever the
165	popup is being displayed.</p>	144	popup is being displayed.</p>
166	</dd>
167	<dd>
168	<p>It's sole argument is the popup menu, which can be modified. It should	145	<p>It's sole argument is the popup menu, which can be modified. It should
169	either return nothing or a string, the initial boolean value and a code	146	either return nothing or a string, the initial boolean value and a code
170	reference. The string will be used as button text and the code reference	147	reference. The string will be used as button text and the code reference
171	will be called when the toggle changes, with the new boolean value as	148	will be called when the toggle changes, with the new boolean value as
172	first argument.</p>	149	first argument.</p>
173	</dd>
174	<dd>
175	<p>The following will add an entry <code>myoption</code> that changes	150	<p>The following will add an entry <code>myoption</code> that changes
176	<code>$self-</code>{myoption}>:</p>	151	<code>$self-</code>{myoption}>:</p>
177	</dd>
178	<dd>
179	<pre>
180	push @{ $self->{term}{option_popup_hook} }, sub {	152	<pre> push @{ $self->{term}{option_popup_hook} }, sub {
181	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	153	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
182	};</pre>	154	};
		155
		156	</pre>
183	</dd>	157	</dd>
184	</li>
185	<dt><strong>selection-popup (enabled by default)</strong>	158	<dt>selection-popup (enabled by default)</dt>
186
187	<dd>	159	<dd>
188	<p>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
189	text into various other formats/action (such as uri unescaping, perl	161	text into various other formats/action (such as uri unescaping, perl
190	evaluation, web-browser starting etc.), depending on content.</p>	162	evaluation, web-browser starting etc.), depending on content.</p>
191	</dd>
192	<dd>
193	<p>Other extensions can extend this popup menu by pushing a code reference	163	<p>Other extensions can extend this popup menu by pushing a code reference
194	onto <code>@{ $term-</code>{selection_popup_hook} }>, which gets called whenever the	164	onto <code>@{ $term-</code>{selection_popup_hook} }>, which gets called whenever the
195	popup is being displayed.</p>	165	popup is being displayed.</p>
196	</dd>
197	<dd>
198	<p>It's sole argument is the popup menu, which can be modified. The selection	166	<p>It's sole argument is the popup menu, which can be modified. The selection
199	is in <code>$_</code>, which can be used to decide whether to add something or not.	167	is in <code>$_</code>, which can be used to decide whether to add something or not.
200	It should either return nothing or a string and a code reference. The	168	It should either return nothing or a string and a code reference. The
201	string will be used as button text and the code reference will be called	169	string will be used as button text and the code reference will be called
202	when the button gets activated and should transform <code>$_</code>.</p>	170	when the button gets activated and should transform <code>$_</code>.</p>
203	</dd>
204	<dd>
205	<p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in	171	<p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in
206	the selection to <code>b</code>s, but only if the selection currently contains any	172	the selection to <code>b</code>s, but only if the selection currently contains any
207	<code>a</code>s:</p>	173	<code>a</code>s:</p>
208	</dd>
209	<dd>
210	<pre>
211	push @{ $self->{term}{selection_popup_hook} }, sub {	174	<pre> push @{ $self->{term}{selection_popup_hook} }, sub {
212	/a/ ? ("a to be" => sub { s/a/b/g }	175	/a/ ? ("a to be" => sub { s/a/b/g }
213	: ()	176	: ()
214	};</pre>	177	};
		178
		179	</pre>
215	</dd>	180	</dd>
216	</li>	181	<dt>searchable-scrollback<hotkey> (enabled by default)</dt>
217	<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong>
218
219	<dd>	182	<dd>
220	<p>Adds regex search functionality to the scrollback buffer, triggered	183	<p>Adds regex search functionality to the scrollback buffer, triggered
221	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
222	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
223	screen.</p>	186	screen.</p>
224	</dd>
225	<dd>
226	<p>Inputting characters appends them to the regex and continues incremental	187	<p>Inputting characters appends them to the regex and continues incremental
227	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>
228	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
229	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
230	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
231	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
232	selection.</p>	193	selection if the <code>Shift</code> modifier is active.</p>
233	</dd>
234	<dd>
235	<p>The regex defaults to ``(?i)'', resulting in a case-insensitive search. To	194	<p>The regex defaults to "(?i)", resulting in a case-insensitive search. To
236	get a case-sensitive search you can delete this prefix using <code>BackSpace</code>	195	get a case-sensitive search you can delete this prefix using <code>BackSpace</code>
237	or simply use an uppercase character which removes the ``(?i)'' prefix.</p>	196	or simply use an uppercase character which removes the "(?i)" prefix.</p>
238	</dd>
239	<dd>
240	<p>See <em>perlre</em> for more info about perl regular expression syntax.</p>	197	<p>See <cite>perlre</cite> for more info about perl regular expression syntax.</p>
241	</dd>	198	</dd>
242	</li>	199	<dt>readline (enabled by default)</dt>
243	<dt><strong><a name="item_readline">readline (enabled by default)</a></strong>
244
245	<dd>	200	<dd>
246	<p>A support package that tries to make editing with readline easier. At	201	<p>A support package that tries to make editing with readline easier. At
247	the moment, it reacts to clicking shift-left mouse button by trying to	202	the moment, it reacts to clicking shift-left mouse button by trying to
248	move the text cursor to this position. It does so by generating as many	203	move the text cursor to this position. It does so by generating as many
249	cursor-left or cursor-right keypresses as required (the this only works	204	cursor-left or cursor-right keypresses as required (the this only works
250	for programs that correctly support wide characters).</p>	205	for programs that correctly support wide characters).</p>
251	</dd>
252	<dd>
253	<p>To avoid too many false positives, this is only done when:</p>	206	<p>To avoid too many false positives, this is only done when:</p>
254	</dd>	207	<p>
255	<dl>	208	<dl>
256	<dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong>	209	<dt>- the tty is in ICANON state.</dt>
257		210	<dt>- the text cursor is visible.</dt>
258	<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong>	211	<dt>- the primary screen is currently being displayed.</dt>
259
260	<dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong>
261
262	<dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong>	212	<dt>- the mouse is on the same (multi-row-) line as the text cursor.</dt>
263
264	</dl>	213	</dl>
		214	</p>
265	<p>The normal selection mechanism isn't disabled, so quick successive clicks	215	<p>The normal selection mechanism isn't disabled, so quick successive clicks
266	might interfere with selection creation in harmless ways.</p>	216	might interfere with selection creation in harmless ways.</p>
267	<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong>	217	</dd>
268		218	<dt>selection-autotransform</dt>
269	<dd>	219	<dd>
270	<p>This selection allows you to do automatic transforms on a selection	220	<p>This selection allows you to do automatic transforms on a selection
271	whenever a selection is made.</p>	221	whenever a selection is made.</p>
272	</dd>
273	<dd>
274	<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>
275	operator) that modify <code>$_</code> as resources:</p>	223	operator) that modify <code>$_</code> as resources:</p>
276	</dd>
277	<dd>
278	<pre>
279	URxvt.selection-autotransform.0: transform	224	<pre> URxvt.selection-autotransform.0: transform
280	URxvt.selection-autotransform.1: transform	225	URxvt.selection-autotransform.1: transform
281	...</pre>	226	...
282	</dd>	227
283	<dd>	228	</pre>
284	<p>For example, the following will transform selections of the form	229	<p>For example, the following will transform selections of the form
285	<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
286	$word</code>:</p>	231	$word</code>:</p>
287	</dd>
288	<dd>
289	<pre>
290	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/
291	</dd>	233
292	<dd>	234	</pre>
293	<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
294	paste directly into your (vi :) editor:</p>	236	paste directly into your (vi :) editor:</p>
295	</dd>
296	<dd>
297	<pre>
298	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre>	237	<pre> URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
299	</dd>	238
300	<dd>	239	</pre>
301	<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>
302	</dd>
303	<dd>
304	<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
305	FILENAME line YYY.''), you need a slightly more elaborate solution:</p>	242	FILENAME line YYY."), you need a slightly more elaborate solution:</p>
306	</dd>
307	<dd>
308	<pre>
309	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])	243	<pre> URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
310	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre>	244	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
311	</dd>	245
312	<dd>	246	</pre>
313	<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
314	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
315	the message into vi commands to load the file.</p>	249	the message into vi commands to load the file.</p>
316	</dd>	250	</dd>
317	</li>	251	<dt>tabbed</dt>
318	<dt><strong><a name="item_tabbed">tabbed</a></strong>
319
320	<dd>	252	<dd>
321	<p>This transforms the terminal into a tabbar with additional terminals, that	253	<p>This transforms the terminal into a tabbar with additional terminals, that
322	is, it implements what is commonly referred to as ``tabbed terminal''. The topmost line	254	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
323	displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one	255	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
324	button per tab.</p>	256	button per tab.</p>
325	</dd>
326	<dd>
327	<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and	257	<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and
328	<strong>Shift-Right</strong> will switch to the tab left or right of the current one,	258	<strong>Shift-Right</strong> will switch to the tab left or right of the current one,
329	while <strong>Shift-Down</strong> creates a new tab.</p>	259	while <strong>Shift-Down</strong> creates a new tab.</p>
330	</dd>
331	<dd>
332	<p>The tabbar itself can be configured similarly to a normal terminal, but	260	<p>The tabbar itself can be configured similarly to a normal terminal, but
333	with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the	261	with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the
334	following four resources (shown with defaults):</p>	262	following four resources (shown with defaults):</p>
335	</dd>
336	<dd>
337	<pre>
338	URxvt.tabbed.tabbar-fg: <colour-index, default 3>	263	<pre> URxvt.tabbed.tabbar-fg: <colour-index, default 3>
339	URxvt.tabbed.tabbar-bg: <colour-index, default 0>	264	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
340	URxvt.tabbed.tab-fg: <colour-index, default 0>	265	URxvt.tabbed.tab-fg: <colour-index, default 0>
341	URxvt.tabbed.tab-bg: <colour-index, default 1></pre>	266	URxvt.tabbed.tab-bg: <colour-index, default 1>
342	</dd>	267
343	<dd>	268	</pre>
344	<p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid	269	<p>See <i>COLOR AND GRAPHICS</i> in the rxvt(1) manpage for valid
345	indices.</p>	270	indices.</p>
346	</dd>	271	</dd>
347	</li>	272	<dt>matcher</dt>
348	<dt><strong><a name="item_matcher">matcher</a></strong>
349
350	<dd>	273	<dd>
351	<p>Uses per-line display filtering (<code>on_line_update</code>) to underline text	274	<p>Uses per-line display filtering (<code>on_line_update</code>) to underline text
352	matching a certain pattern and make it clickable. When clicked with the	275	matching a certain pattern and make it clickable. When clicked with the
353	mouse button specified in the <code>matcher.button</code> resource (default 2, or	276	mouse button specified in the <code>matcher.button</code> resource (default 2, or
354	middle), the program specified in the <code>matcher.launcher</code> resource	277	middle), the program specified in the <code>matcher.launcher</code> resource
355	(default, the <code>urlLauncher</code> resource, <code>sensible-browser</code>) will be started	278	(default, the <code>urlLauncher</code> resource, <code>sensible-browser</code>) will be started
356	with the matched text as first argument. The default configuration is	279	with the matched text as first argument. The default configuration is
357	suitable for matching URLs and launching a web browser, like the	280	suitable for matching URLs and launching a web browser, like the
358	former ``mark-urls'' extension.</p>	281	former "mark-urls" extension.</p>
359	</dd>
360	<dd>
361	<p>The default pattern to match URLs can be overridden with the	282	<p>The default pattern to match URLs can be overridden with the
362	<code>matcher.pattern.0</code> resource, and additional patterns can be specified	283	<code>matcher.pattern.0</code> resource, and additional patterns can be specified
363	with numbered patterns, in a manner similar to the ``selection'' extension.	284	with numbered patterns, in a manner similar to the "selection" extension.
364	The launcher can also be overridden on a per-pattern basis.</p>	285	The launcher can also be overridden on a per-pattern basis.</p>
365	</dd>	286	<p>It is possible to activate the most recently seen match from the keyboard.
366	<dd>	287	Simply bind a keysym to "perl:matcher" as seen in the example below.</p>
367	<p>Example configuration:</p>	288	<p>Example configuration:</p>
368	</dd>
369	<dd>
370	<pre>
371	URxvt.perl-ext: default,matcher	289	<pre> URxvt.perl-ext: default,matcher
372	URxvt.urlLauncher: sensible-browser	290	URxvt.urlLauncher: sensible-browser
		291	URxvt.keysym.C-Delete: perl:matcher
373	URxvt.matcher.button: 1	292	URxvt.matcher.button: 1
374	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]	293	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
375	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)	294	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
376	URxvt.matcher.launcher.2: gvim +$2 $1</pre>	295	URxvt.matcher.launcher.2: gvim +$2 $1
		296
		297	</pre>
377	</dd>	298	</dd>
378	</li>	299	<dt>xim-onthespot</dt>
379	<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong>
380
381	<dd>	300	<dd>
382	<p>This (experimental) perl extension implements OnTheSpot editing. It does	301	<p>This (experimental) perl extension implements OnTheSpot editing. It does
383	not work perfectly, and some input methods don't seem to work well with	302	not work perfectly, and some input methods don't seem to work well with
384	OnTheSpot editing in general, but it seems to work at leats for SCIM and	303	OnTheSpot editing in general, but it seems to work at leats for SCIM and
385	kinput2.</p>	304	kinput2.</p>
386	</dd>
387	<dd>
388	<p>You enable it by specifying this extension and a preedit style of	305	<p>You enable it by specifying this extension and a preedit style of
389	<code>OnTheSpot</code>, i.e.:</p>	306	<code>OnTheSpot</code>, i.e.:</p>
390	</dd>	307	<pre> rxvt -pt OnTheSpot -pe xim-onthespot
391	<dd>	308
392	<pre>	309	</pre>
393	rxvt -pt OnTheSpot -pe xim-onthespot</pre>
394	</dd>	310	</dd>
395	</li>	311	<dt>kuake<hotkey></dt>
396	<dt><strong><a name="item_kuake_3chotkey_3e">kuake<hotkey></a></strong>
397
398	<dd>	312	<dd>
399	<p>A very primitive quake-console-like extension. It was inspired by a	313	<p>A very primitive quake-console-like extension. It was inspired by a
400	description of how the programs <code>kuake</code> and <code>yakuake</code> work: Whenever the	314	description of how the programs <code>kuake</code> and <code>yakuake</code> work: Whenever the
401	user presses a global accelerator key (by default <code>F10</code>), the terminal	315	user presses a global accelerator key (by default <code>F10</code>), the terminal
402	will show or hide itself. Another press of the accelerator key will hide	316	will show or hide itself. Another press of the accelerator key will hide
403	or show it again.</p>	317	or show it again.</p>
404	</dd>
405	<dd>
406	<p>Initially, the window will not be shown when using this extension.</p>	318	<p>Initially, the window will not be shown when using this extension.</p>
407	</dd>
408	<dd>
409	<p>This is useful if you need a single terminal thats not using any desktop	319	<p>This is useful if you need a single terminal thats not using any desktop
410	space most of the time but is quickly available at the press of a key.</p>	320	space most of the time but is quickly available at the press of a key.</p>
411	</dd>
412	<dd>
413	<p>The accelerator key is grabbed regardless of any modifiers, so this	321	<p>The accelerator key is grabbed regardless of any modifiers, so this
414	extension will actually grab a physical key just for this function.</p>	322	extension will actually grab a physical key just for this function.</p>
415	</dd>
416	<dd>
417	<p>If you want a quake-like animation, tell your window manager to do so	323	<p>If you want a quake-like animation, tell your window manager to do so
418	(fvwm can do it).</p>	324	(fvwm can do it).</p>
419	</dd>	325	</dd>
420	</li>	326	<dt>automove-background</dt>
421	<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong>
422
423	<dd>	327	<dd>
424	<p>This is basically a very small extension that dynamically changes the	328	<p>This is basically a very small extension that dynamically changes the
425	background pixmap offset to the window position, in effect creating the	329	background pixmap offset to the window position, in effect creating the
426	same effect as pseudo transparency with a custom pixmap. No scaling is	330	same effect as pseudo transparency with a custom pixmap. No scaling is
427	supported in this mode. Example:</p>	331	supported in this mode. Example:</p>
428	</dd>	332	<pre> rxvt -pixmap background.xpm -pe automove-background
429	<dd>	333
430	<pre>	334	</pre>
431	rxvt -pixmap background.xpm -pe automove-background</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>
432	</dd>	338	</dd>
433	</li>	339	<dt>block-graphics-to-ascii</dt>
434	<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong>
435
436	<dd>	340	<dd>
437	<p>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
438	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
439	similar-looking ascii character.</p>	343	similar-looking ascii character.</p>
440	</dd>	344	</dd>
441	</li>	345	<dt>digital-clock</dt>
442	<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong>
443
444	<dd>	346	<dd>
445	<p>Displays a digital clock using the built-in overlay.</p>	347	<p>Displays a digital clock using the built-in overlay.</p>
446	</dd>	348	</dd>
447	</li>	349	<dt>remote-clipboard</dt>
448	<dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong>
449
450	<dd>	350	<dd>
451	<p>Somewhat of a misnomer, this extension adds two menu entries to the	351	<p>Somewhat of a misnomer, this extension adds two menu entries to the
452	selection popup that allows one ti run external commands to store the	352	selection popup that allows one ti run external commands to store the
453	selection somewhere and fetch it again.</p>	353	selection somewhere and fetch it again.</p>
454	</dd>
455	<dd>
456	<p>We use it to implement a ``distributed selection mechanism'', which just	354	<p>We use it to implement a "distributed selection mechanism", which just
457	means that one command uploads the file to a remote server, and another	355	means that one command uploads the file to a remote server, and another
458	reads it.</p>	356	reads it.</p>
459	</dd>
460	<dd>
461	<p>The commands can be set using the <code>URxvt.remote-selection.store</code> and	357	<p>The commands can be set using the <code>URxvt.remote-selection.store</code> and
462	<code>URxvt.remote-selection.fetch</code> resources. The first should read the	358	<code>URxvt.remote-selection.fetch</code> resources. The first should read the
463	selection to store from STDIN (always in UTF-8), the second should provide	359	selection to store from STDIN (always in UTF-8), the second should provide
464	the selection data on STDOUT (also in UTF-8).</p>	360	the selection data on STDOUT (also in UTF-8).</p>
465	</dd>
466	<dd>
467	<p>The defaults (which are likely useless to you) use rsh and cat:</p>	361	<p>The defaults (which are likely useless to you) use rsh and cat:</p>
468	</dd>
469	<dd>
470	<pre>
471	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	362	<pre> URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
472	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre>	363	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		364
		365	</pre>
473	</dd>	366	</dd>
474	</li>	367	<dt>selection-pastebin</dt>
475	<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong>
476
477	<dd>	368	<dd>
478	<p>This is a little rarely useful extension that Uploads the selection as	369	<p>This is a little rarely useful extension that Uploads the selection as
479	textfile to a remote site (or does other things). (The implementation is	370	textfile to a remote site (or does other things). (The implementation is
480	not currently secure for use in a multiuser environment as it writes to	371	not currently secure for use in a multiuser environment as it writes to
481	<em>/tmp</em> directly.).</p>	372	<cite>/tmp</cite> directly.).</p>
482	</dd>
483	<dd>
484	<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,	373	<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
485	i.e.</p>	374	i.e.</p>
486	</dd>
487	<dd>
488	<pre>
489	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre>	375	<pre> URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
490	</dd>	376
491	<dd>	377	</pre>
492	<p>Pressing this combination runs a command with <code>%</code> replaced by the name of	378	<p>Pressing this combination runs a command with <code>%</code> replaced by the name of
493	the textfile. This command can be set via a resource:</p>	379	the textfile. This command can be set via a resource:</p>
494	</dd>
495	<dd>
496	<pre>
497	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>	380	<pre> URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
498	</dd>	381
499	<dd>	382	</pre>
500	<p>And the default is likely not useful to anybody but the few people around	383	<p>And the default is likely not useful to anybody but the few people around
501	here :)</p>	384	here :)</p>
502	</dd>
503	<dd>
504	<p>The name of the textfile is the hex encoded md5 sum of the selection, so	385	<p>The name of the textfile is the hex encoded md5 sum of the selection, so
505	the same content should lead to the same filename.</p>	386	the same content should lead to the same filename.</p>
506	</dd>
507	<dd>
508	<p>After a successful upload the selection will be replaced by the text given	387	<p>After a successful upload the selection will be replaced by the text given
509	in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder	388	in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
510	for the filename):</p>	389	for the filename):</p>
511	</dd>	390	<pre> URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
512	<dd>	391
513	<pre>	392	</pre>
514	URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
515	</dd>
516	<dd>
517	<p><em>Note to xrdb users:</em> xrdb uses the C preprocessor, which might interpret	393	<p><i>Note to xrdb users:</i> xrdb uses the C preprocessor, which might interpret
518	the double <code>/</code> characters as comment start. Use <code>\057\057</code> instead,	394	the double <code>/</code> characters as comment start. Use <code>\057\057</code> instead,
519	which works regardless of wether xrdb is used to parse the resource file	395	which works regardless of wether xrdb is used to parse the resource file
520	or not.</p>	396	or not.</p>
521	</dd>	397	</dd>
522	</li>	398	<dt>example-refresh-hooks</dt>
523	<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong>
524
525	<dd>	399	<dd>
526	<p>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
527	window. Illustrates overwriting the refresh callbacks to create your own	401	window. Illustrates overwriting the refresh callbacks to create your own
528	overlays or changes.</p>	402	overlays or changes.</p>
529	</dd>	403	</dd>
530	</li>
531	</dl>	404	</dl>
532	<p>	405
533	</p>	406	</div>
534	<hr />	407	<h1 id="API_DOCUMENTATION">API DOCUMENTATION</h1><p><a href="#TOP" class="toplink">Top</a></p>
535	<h1><a name="api_documentation">API DOCUMENTATION</a></h1>	408	<div id="API_DOCUMENTATION_CONTENT">
536	<p>	409
537	</p>	410	</div>
538	<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">
539	<p>All objects (such as terminals, time watchers etc.) are typical	413	<p>All objects (such as terminals, time watchers etc.) are typical
540	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
541	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
542	<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
543	modified).</p>	417	modified).</p>
546	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
547	terminal is destroyed.</p>	421	terminal is destroyed.</p>
548	<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
549	hints on what they mean:</p>	423	hints on what they mean:</p>
550	<dl>	424	<dl>
551	<dt><strong><a name="item__text">$text</a></strong>	425	<dt>$text</dt>
552
553	<dd>	426	<dd>
554	<p>Rxvt-unicodes special way of encoding text, where one ``unicode'' character	427	<p>Rxvt-unicodes special way of encoding text, where one "unicode" character
555	always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.</p>	428	always represents one screen cell. See <cite>ROW_t</cite> for a discussion of this format.</p>
556	</dd>	429	</dd>
557	</li>	430	<dt>$string</dt>
558	<dt><strong><a name="item__string">$string</a></strong>
559
560	<dd>	431	<dd>
561	<p>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
562	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
563	encoding (often locale-specific) and binary data.</p>	434	encoding (often locale-specific) and binary data.</p>
564	</dd>	435	</dd>
565	</li>	436	<dt>$octets</dt>
566	<dt><strong><a name="item__octets">$octets</a></strong>
567
568	<dd>	437	<dd>
569	<p>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
570	locale-specific way.</p>	439	locale-specific way.</p>
571	</dd>	440	</dd>
572	</li>
573	</dl>	441	</dl>
574	<p>	442
575	</p>	443	</div>
576	<h2><a name="extension_objects">Extension Objects</a></h2>	444	<h2 id="Extension_Objects">Extension Objects</h2>
		445	<div id="Extension_Objects_CONTENT">
577	<p>Every 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
578	for each terminal, and each terminal has its own set of extenion objects,	447	for each terminal, and each terminal has its own set of extenion objects,
579	which are passed as the first parameter to hooks. So extensions can use	448	which are passed as the first parameter to hooks. So extensions can use
580	their <code>$self</code> object without having to think about clashes with other	449	their <code>$self</code> object without having to think about clashes with other
581	extensions or other terminals, with the exception of methods and members	450	extensions or other terminals, with the exception of methods and members
…		…
583	internal use.</p>	452	internal use.</p>
584	<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
585	<code>urxvt::term</code> class on this object.</p>	454	<code>urxvt::term</code> class on this object.</p>
586	<p>It has the following methods and data members:</p>	455	<p>It has the following methods and data members:</p>
587	<dl>	456	<dl>
588	<dt><strong><a name="item__urxvt_term">$urxvt_term = $self->{term}</a></strong>	457	<dt>$urxvt_term = $self->{term}</dt>
589
590	<dd>	458	<dd>
591	<p>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
592	extension. This member <em>must not</em> be changed in any way.</p>	460	extension. This member <i>must not</i> be changed in any way.</p>
593	</dd>	461	</dd>
594	</li>
595	<dt><strong><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a></strong>	462	<dt>$self->enable ($hook_name => $cb, [$hook_name => $cb..])</dt>
596
597	<dd>	463	<dd>
598	<p>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
599	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
600	to overwrite time-critical hooks only temporarily.</p>	466	to overwrite time-critical hooks only temporarily.</p>
601	</dd>	467	</dd>
602	</li>	468	<dt>$self->disable ($hook_name[, $hook_name..])</dt>
603	<dt><strong><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a></strong>
604
605	<dd>	469	<dd>
606	<p>Dynamically disable the given hooks.</p>	470	<p>Dynamically disable the given hooks.</p>
607	</dd>	471	</dd>
608	</li>
609	</dl>	472	</dl>
610	<p>	473
611	</p>	474	</div>
612	<h2><a name="hooks">Hooks</a></h2>	475	<h2 id="Hooks">Hooks</h2>
		476	<div id="Hooks_CONTENT">
613	<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
614	called whenever the relevant event happens.</p>	478	called whenever the relevant event happens.</p>
615	<p>The first argument passed to them is an extension object as described in	479	<p>The first argument passed to them is an extension object as described in
616	the in the <code>Extension Objects</code> section.</p>	480	the in the <code>Extension Objects</code> section.</p>
617	<p><strong>All</strong> of these hooks must return a boolean value. If any of the called	481	<p><strong>All</strong> of these hooks must return a boolean value. If any of the called
618	hooks returns true, then the event counts as being <em>consumed</em>, and the	482	hooks returns true, then the event counts as being <i>consumed</i>, and the
619	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>
620	<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>
621	<dl>	485	<dl>
622	<dt><strong><a name="item_on_init__24term">on_init $term</a></strong>	486	<dt>on_init $term</dt>
623
624	<dd>	487	<dd>
625	<p>Called after a new terminal object has been initialized, but before	488	<p>Called after a new terminal object has been initialized, but before
626	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
627	call or deliver senseless data, as terminal size and other characteristics	490	call or deliver senseless data, as terminal size and other characteristics
628	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
629	and options, though. For many purposes the <code>on_start</code> hook is a better	492	and options, though. For many purposes the <code>on_start</code> hook is a better
630	place.</p>	493	place.</p>
631	</dd>	494	</dd>
632	</li>	495	<dt>on_start $term</dt>
633	<dt><strong><a name="item_on_start__24term">on_start $term</a></strong>
634
635	<dd>	496	<dd>
636	<p>Called at the very end of initialisation of a new terminal, just before	497	<p>Called at the very end of initialisation of a new terminal, just before
637	trying to map (display) the toplevel and returning to the main loop.</p>	498	trying to map (display) the toplevel and returning to the main loop.</p>
638	</dd>	499	</dd>
639	</li>	500	<dt>on_destroy $term</dt>
640	<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong>
641
642	<dd>	501	<dd>
643	<p>Called whenever something tries to destroy terminal, when the terminal is	502	<p>Called whenever something tries to destroy terminal, when the terminal is
644	still fully functional (not for long, though).</p>	503	still fully functional (not for long, though).</p>
645	</dd>	504	</dd>
646	</li>	505	<dt>on_reset $term</dt>
647	<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong>
648
649	<dd>	506	<dd>
650	<p>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
651	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
652	variables.</p>	509	variables.</p>
653	</dd>	510	</dd>
654	</li>	511	<dt>on_child_start $term, $pid</dt>
655	<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong>
656
657	<dd>	512	<dd>
658	<p>Called just after the child process has been <code>fork</code>ed.</p>	513	<p>Called just after the child process has been <code>fork</code>ed.</p>
659	</dd>	514	</dd>
660	</li>	515	<dt>on_child_exit $term, $status</dt>
661	<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong>
662
663	<dd>	516	<dd>
664	<p>Called just after the child process has exited. <code>$status</code> is the status	517	<p>Called just after the child process has exited. <code>$status</code> is the status
665	from <code>waitpid</code>.</p>	518	from <code>waitpid</code>.</p>
666	</dd>	519	</dd>
667	</li>	520	<dt>on_sel_make $term, $eventtime</dt>
668	<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong>
669
670	<dd>	521	<dd>
671	<p>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
672	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
673	selection will be honored.</p>	524	selection will be honored.</p>
674	</dd>
675	<dd>
676	<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
677	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>
678	</dd>	527	</dd>
679	</li>	528	<dt>on_sel_grab $term, $eventtime</dt>
680	<dt><strong><a name="item_on_sel_grab__24term_2c__24eventtime">on_sel_grab $term, $eventtime</a></strong>
681
682	<dd>	529	<dd>
683	<p>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
684	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
685	by calling <a href="#item_selection"><code>$term->selection</code></a>.</p>	532	by calling <code>$term->selection</code>.</p>
686	</dd>
687	<dd>
688	<p>Returning a true value aborts selection grabbing. It will still be highlighted.</p>	533	<p>Returning a true value aborts selection grabbing. It will still be highlighted.</p>
689	</dd>	534	</dd>
690	</li>	535	<dt>on_sel_extend $term</dt>
691	<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong>
692
693	<dd>	536	<dd>
694	<p>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
695	click) and is either supposed to return false (normal operation), or	538	click) and is either supposed to return false (normal operation), or
696	should extend the selection itself and return true to suppress the built-in	539	should extend the selection itself and return true to suppress the built-in
697	processing. This can happen multiple times, as long as the callback	540	processing. This can happen multiple times, as long as the callback
698	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
699	supposed to enlarge the selection more and more, if possible.</p>	542	supposed to enlarge the selection more and more, if possible.</p>
700	</dd>
701	<dd>
702	<p>See the <em>selection</em> example extension.</p>	543	<p>See the <cite>selection</cite> example extension.</p>
703	</dd>	544	</dd>
704	</li>	545	<dt>on_view_change $term, $offset</dt>
705	<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong>
706
707	<dd>	546	<dd>
708	<p>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
709	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
710	show this many lines of scrollback.</p>	549	show this many lines of scrollback.</p>
711	</dd>	550	</dd>
712	</li>	551	<dt>on_scroll_back $term, $lines, $saved</dt>
713	<dt><strong><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a></strong>
714
715	<dd>	552	<dd>
716	<p>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
717	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
718	than the scroll back buffer or the terminal.</p>	555	than the scroll back buffer or the terminal.</p>
719	</dd>
720	<dd>
721	<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,
722	$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
723	number of lines that will be in the scrollback buffer.</p>	558	number of lines that will be in the scrollback buffer.</p>
724	</dd>	559	</dd>
725	</li>	560	<dt>on_osc_seq $term, $op, $args</dt>
726	<dt><strong><a name="item_on_osc_seq__24term_2c__24op_2c__24args">on_osc_seq $term, $op, $args</a></strong>
727
728	<dd>	561	<dd>
729	<p>Called on every OSC sequence and can be used to suppress it or modify its	562	<p>Called on every OSC sequence and can be used to suppress it or modify its
730	behaviour. The default should be to return an empty list. A true value	563	behaviour. The default should be to return an empty list. A true value
731	suppresses execution of the request completely. Make sure you don't get	564	suppresses execution of the request completely. Make sure you don't get
732	confused by recursive invocations when you output an osc sequence within	565	confused by recursive invocations when you output an osc sequence within
733	this callback.</p>	566	this callback.</p>
734	</dd>
735	<dd>
736	<p><code>on_osc_seq_perl</code> should be used for new behaviour.</p>	567	<p><code>on_osc_seq_perl</code> should be used for new behaviour.</p>
737	</dd>	568	</dd>
738	</li>	569	<dt>on_osc_seq_perl $term, $string</dt>
739	<dt><strong><a name="item_on_osc_seq_perl__24term_2c__24string">on_osc_seq_perl $term, $string</a></strong>
740
741	<dd>	570	<dd>
742	<p>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 =
743	operating system command) is processed. Cursor position and other state	572	operating system command) is processed. Cursor position and other state
744	information is up-to-date when this happens. For interoperability, the	573	information is up-to-date when this happens. For interoperability, the
745	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
746	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
747	future.</p>	576	future.</p>
748	</dd>
749	<dd>
750	<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,
751	as its source can not easily be controlled (e-mail content, messages from	578	as its source can not easily be controlled (e-mail content, messages from
752	other users on the same system etc.).</p>	579	other users on the same system etc.).</p>
753	</dd>	580	</dd>
754	</li>	581	<dt>on_add_lines $term, $string</dt>
755	<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong>
756
757	<dd>	582	<dd>
758	<p>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
759	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
760	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
761	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
762	output.</p>	587	output.</p>
763	</dd>	588	</dd>
764	</li>	589	<dt>on_tt_write $term, $octets</dt>
765	<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong>
766
767	<dd>	590	<dd>
768	<p>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
769	suppress or filter tty input.</p>	592	suppress or filter tty input.</p>
770	</dd>	593	</dd>
771	</li>	594	<dt>on_line_update $term, $row</dt>
772	<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong>
773
774	<dd>	595	<dd>
775	<p>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
776	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
777	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,
778	not always immediately.</p>	599	not always immediately.</p>
779	</dd>
780	<dd>
781	<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
782	multiple rows.</p>	601	multiple rows.</p>
783	</dd>
784	<dd>
785	<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
786	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
787	you cannot just toggle rendition bits, but only set them.</p>	604	you cannot just toggle rendition bits, but only set them.</p>
788	</dd>	605	</dd>
789	</li>	606	<dt>on_refresh_begin $term</dt>
790	<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong>
791
792	<dd>	607	<dd>
793	<p>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
794	or similar effects by modify terminal contents in refresh_begin, and	609	or similar effects by modify terminal contents in refresh_begin, and
795	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
796	code is run after this hook, and takes precedence.</p>	611	code is run after this hook, and takes precedence.</p>
797	</dd>	612	</dd>
798	</li>	613	<dt>on_refresh_end $term</dt>
799	<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong>
800
801	<dd>	614	<dd>
802	<p>Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.</p>	615	<p>Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.</p>
803	</dd>	616	</dd>
804	</li>	617	<dt>on_user_command $term, $string</dt>
805	<dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong>
806
807	<dd>	618	<dd>
808	<p>Called whenever a user-configured event is being activated (e.g. via	619	<p>Called whenever a user-configured event is being activated (e.g. via
809	a <code>perl:string</code> action bound to a key, 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>
810	resource in the <code>rxvt(1)</code> manpage).</p>	621	resource in the rxvt(1) manpage).</p>
811	</dd>
812	<dd>
813	<p>The event is simply the action string. This interface is assumed to change	622	<p>The event is simply the action string. This interface is assumed to change
814	slightly in the future.</p>	623	slightly in the future.</p>
815	</dd>	624	</dd>
816	</li>	625	<dt>on_resize_all_windows $tern, $new_width, $new_height</dt>
817	<dt><strong><a name="item_on_resize_all_windows__24tern_2c__24new_width_2c__">on_resize_all_windows $tern, $new_width, $new_height</a></strong>
818
819	<dd>	626	<dd>
820	<p>Called just after the new window size has been calculated, but before	627	<p>Called just after the new window size has been calculated, but before
821	windows are actually being resized or hints are being set. If this hook	628	windows are actually being resized or hints are being set. If this hook
822	returns TRUE, setting of the window hints is being skipped.</p>	629	returns TRUE, setting of the window hints is being skipped.</p>
823	</dd>	630	</dd>
824	</li>	631	<dt>on_x_event $term, $event</dt>
825	<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong>
826
827	<dd>	632	<dd>
828	<p>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
829	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
830	members are not passed.</p>	635	members are not passed.</p>
831	</dd>	636	</dd>
832	</li>	637	<dt>on_root_event $term, $event</dt>
833	<dt><strong><a name="item_on_root_event__24term_2c__24event">on_root_event $term, $event</a></strong>
834
835	<dd>	638	<dd>
836	<p>Like <code>on_x_event</code>, but is called for events on the root window.</p>	639	<p>Like <code>on_x_event</code>, but is called for events on the root window.</p>
837	</dd>	640	</dd>
838	</li>	641	<dt>on_focus_in $term</dt>
839	<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong>
840
841	<dd>	642	<dd>
842	<p>Called whenever the window gets the keyboard focus, before rxvt-unicode	643	<p>Called whenever the window gets the keyboard focus, before rxvt-unicode
843	does focus in processing.</p>	644	does focus in processing.</p>
844	</dd>	645	</dd>
845	</li>	646	<dt>on_focus_out $term</dt>
846	<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong>
847
848	<dd>	647	<dd>
849	<p>Called whenever the window loses keyboard focus, before rxvt-unicode does	648	<p>Called whenever the window loses keyboard focus, before rxvt-unicode does
850	focus out processing.</p>	649	focus out processing.</p>
851	</dd>	650	</dd>
852	</li>	651	<dt>on_configure_notify $term, $event</dt>
853	<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong>	652	<dt>on_property_notify $term, $event</dt>
854		653	<dt>on_key_press $term, $event, $keysym, $octets</dt>
855	<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong>	654	<dt>on_key_release $term, $event, $keysym</dt>
856		655	<dt>on_button_press $term, $event</dt>
857	<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong>	656	<dt>on_button_release $term, $event</dt>
858		657	<dt>on_motion_notify $term, $event</dt>
859	<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong>	658	<dt>on_map_notify $term, $event</dt>
860		659	<dt>on_unmap_notify $term, $event</dt>
861	<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong>
862
863	<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong>
864
865	<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong>
866
867	<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong>
868
869	<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong>
870
871	<dd>	660	<dd>
872	<p>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
873	the hook returns true, then the even will be ignored by rxvt-unicode.</p>	662	the hook returns true, then the even will be ignored by rxvt-unicode.</p>
874	</dd>
875	<dd>
876	<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
877	manpage), with the additional members <code>row</code> and <code>col</code>, which are the	664	manpage), with the additional members <code>row</code> and <code>col</code>, which are the
878	(real, not screen-based) row and column under the mouse cursor.</p>	665	(real, not screen-based) row and column under the mouse cursor.</p>
879	</dd>
880	<dd>
881	<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
882	output, if any, in locale-specific encoding.</p>	667	output, if any, in locale-specific encoding.</p>
883	</dd>
884	<dd>
885	<p>subwindow.</p>	668	<p>subwindow.</p>
886	</dd>	669	</dd>
887	</li>	670	<dt>on_client_message $term, $event</dt>
888	<dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong>	671	<dt>on_wm_protocols $term, $event</dt>
889		672	<dt>on_wm_delete_window $term, $event</dt>
890	<dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong>
891
892	<dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong>
893
894	<dd>	673	<dd>
895	<p>Called when various types of ClientMessage events are received (all with	674	<p>Called when various types of ClientMessage events are received (all with
896	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).</p>	675	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).</p>
897	</dd>	676	</dd>
898	</li>
899	</dl>	677	</dl>
900	<p>	678
901	</p>	679	</div>
902	<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">
903	<dl>	682	<dl>
904	<dt><strong><a name="item__urxvt__libdir">$urxvt::LIBDIR</a></strong>	683	<dt>$urxvt::LIBDIR</dt>
905
906	<dd>	684	<dd>
907	<p>The rxvt-unicode library directory, where, among other things, the perl	685	<p>The rxvt-unicode library directory, where, among other things, the perl
908	modules and scripts are stored.</p>	686	modules and scripts are stored.</p>
909	</dd>	687	</dd>
910	</li>	688	<dt>$urxvt::RESCLASS, $urxvt::RESCLASS</dt>
911	<dt><strong><a name="item__urxvt__resclass_">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong>
912
913	<dd>	689	<dd>
914	<p>The resource class and name rxvt-unicode uses to look up X resources.</p>	690	<p>The resource class and name rxvt-unicode uses to look up X resources.</p>
915	</dd>	691	</dd>
916	</li>	692	<dt>$urxvt::RXVTNAME</dt>
917	<dt><strong><a name="item__urxvt__rxvtname">$urxvt::RXVTNAME</a></strong>
918
919	<dd>	693	<dd>
920	<p>The basename of the installed binaries, usually <code>urxvt</code>.</p>	694	<p>The basename of the installed binaries, usually <code>urxvt</code>.</p>
921	</dd>	695	</dd>
922	</li>	696	<dt>$urxvt::TERM</dt>
923	<dt><strong><a name="item__urxvt__term">$urxvt::TERM</a></strong>
924
925	<dd>	697	<dd>
926	<p>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>
927	object, whenever a callback/hook is executing.</p>	699	object, whenever a callback/hook is executing.</p>
928	</dd>	700	</dd>
929	</li>	701	<dt>@urxvt::TERM_INIT</dt>
930	<dt><strong><a name="item__urxvt__term_init">@urxvt::TERM_INIT</a></strong>
931
932	<dd>	702	<dd>
933	<p>All code references in this array will be called as methods of the next newly	703	<p>All code references in this array will be called as methods of the next newly
934	created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array	704	created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
935	gets cleared before the code references that were in it are being executed,	705	gets cleared before the code references that were in it are being executed,
936	so references can push themselves onto it again if they so desire.</p>	706	so references can push themselves onto it again if they so desire.</p>
937	</dd>
938	<dd>
939	<p>This complements to the perl-eval command line option, but gets executed	707	<p>This complements to the perl-eval command line option, but gets executed
940	first.</p>	708	first.</p>
941	</dd>	709	</dd>
942	</li>	710	<dt>@urxvt::TERM_EXT</dt>
943	<dt><strong><a name="item__urxvt__term_ext">@urxvt::TERM_EXT</a></strong>
944
945	<dd>	711	<dd>
946	<p>Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which	712	<p>Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which
947	get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>	713	get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>
948	but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.</p>	714	but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.</p>
949	</dd>	715	</dd>
950	</li>
951	</dl>	716	</dl>
952	<p>	717
953	</p>	718	</div>
954	<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">
955	<dl>	721	<dl>
956	<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong>	722	<dt>urxvt::fatal $errormessage</dt>
957
958	<dd>	723	<dd>
959	<p>Fatally aborts execution with the given error message. Avoid at all	724	<p>Fatally aborts execution with the given error message. Avoid at all
960	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
961	starts up.</p>	726	starts up.</p>
962	</dd>	727	</dd>
963	</li>	728	<dt>urxvt::warn $string</dt>
964	<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong>
965
966	<dd>	729	<dd>
967	<p>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
968	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
969	that calls this function.</p>	732	that calls this function.</p>
970	</dd>
971	<dd>
972	<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
973	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>
974	</dd>
975	<dd>
976	<p>Messages have a size limit of 1023 bytes currently.</p>	735	<p>Messages have a size limit of 1023 bytes currently.</p>
977	</dd>	736	</dd>
978	</li>	737	<dt>@terms = urxvt::termlist</dt>
979	<dt><strong><a name="item__terms">@terms = urxvt::termlist</a></strong>
980
981	<dd>	738	<dd>
982	<p>Returns all urxvt::term objects that exist in this process, regardless of	739	<p>Returns all urxvt::term objects that exist in this process, regardless of
983	whether they are started, being destroyed etc., so be careful. Only term	740	whether they are started, being destroyed etc., so be careful. Only term
984	objects that have perl extensions attached will be returned (because there	741	objects that have perl extensions attached will be returned (because there
985	is no urxvt::term objet associated with others).</p>	742	is no urxvt::term objet associated with others).</p>
986	</dd>	743	</dd>
987	</li>	744	<dt>$time = urxvt::NOW</dt>
988	<dt><strong><a name="item__time">$time = urxvt::NOW</a></strong>
989
990	<dd>	745	<dd>
991	<p>Returns the ``current time'' (as per the event loop).</p>	746	<p>Returns the "current time" (as per the event loop).</p>
992	</dd>	747	</dd>
993	</li>	748	<dt>urxvt::CurrentTime</dt>
994	<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong>	749	<dt>urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
995
996	<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
997	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	750	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
998	Button4Mask, Button5Mask, AnyModifier</a></strong>	751	Button4Mask, Button5Mask, AnyModifier</dt>
999		752	<dt>urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
1000	<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
1001	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,	753	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
1002	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,	754	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
1003	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,	755	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
1004	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,	756	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
1005	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,	757	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
1006	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong>	758	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</dt>
1007		759	<dt>urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
1008	<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
1009	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,	760	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
1010	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,	761	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
1011	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,	762	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
1012	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,	763	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
1013	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	764	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
1014	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong>	765	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</dt>
1015
1016	<dd>	766	<dd>
1017	<p>Various constants for use in X calls and event processing.</p>	767	<p>Various constants for use in X calls and event processing.</p>
1018	</dd>	768	</dd>
1019	</li>
1020	</dl>	769	</dl>
1021	<p>	770
1022	</p>	771	</div>
1023	<h2><a name="rendition">RENDITION</a></h2>	772	<h2 id="RENDITION">RENDITION</h2>
		773	<div id="RENDITION_CONTENT">
1024	<p>Rendition bitsets contain information about colour, font, font styles and	774	<p>Rendition bitsets contain information about colour, font, font styles and
1025	similar information for each screen cell.</p>	775	similar information for each screen cell.</p>
1026	<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
1027	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,
1028	as they contain important information required for correct operation of	778	as they contain important information required for correct operation of
1029	rxvt-unicode.</p>	779	rxvt-unicode.</p>
1030	<dl>	780	<dl>
1031	<dt><strong><a name="item__rend">$rend = urxvt::DEFAULT_RSTYLE</a></strong>	781	<dt>$rend = urxvt::DEFAULT_RSTYLE</dt>
1032
1033	<dd>	782	<dd>
1034	<p>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
1035	being reset. Useful as a base to start when creating renditions.</p>	784	being reset. Useful as a base to start when creating renditions.</p>
1036	</dd>	785	</dd>
1037	</li>
1038	<dt><strong>$rend = urxvt::OVERLAY_RSTYLE</strong>	786	<dt>$rend = urxvt::OVERLAY_RSTYLE</dt>
1039
1040	<dd>	787	<dd>
1041	<p>Return the rendition mask used for overlays by default.</p>	788	<p>Return the rendition mask used for overlays by default.</p>
1042	</dd>	789	</dd>
1043	</li>
1044	<dt><strong><a name="item__rendbit">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong>	790	<dt>$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</dt>
1045
1046	<dd>	791	<dd>
1047	<p>Return the bit that enabled bold, italic, blink, reverse-video and	792	<p>Return the bit that enabled bold, italic, blink, reverse-video and
1048	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
1049	the bitset.</p>	794	the bitset.</p>
1050	</dd>	795	</dd>
1051	</li>	796	<dt>$foreground = urxvt::GET_BASEFG $rend</dt>
1052	<dt><strong><a name="item__foreground">$foreground = urxvt::GET_BASEFG $rend</a></strong>	797	<dt>$background = urxvt::GET_BASEBG $rend</dt>
1053
1054	<dt><strong><a name="item__background">$background = urxvt::GET_BASEBG $rend</a></strong>
1055
1056	<dd>	798	<dd>
1057	<p>Return the foreground/background colour index, respectively.</p>	799	<p>Return the foreground/background colour index, respectively.</p>
1058	</dd>	800	</dd>
1059	</li>
1060	<dt><strong>$rend = urxvt::SET_FGCOLOR $rend, $new_colour</strong>	801	<dt>$rend = urxvt::SET_FGCOLOR $rend, $new_colour</dt>
1061
1062	<dt><strong>$rend = urxvt::SET_BGCOLOR $rend, $new_colour</strong>	802	<dt>$rend = urxvt::SET_BGCOLOR $rend, $new_colour</dt>
1063
1064	<dt><strong>$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</strong>	803	<dt>$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</dt>
1065
1066	<dd>	804	<dd>
1067	<p>Replace the foreground/background colour in the rendition mask with the	805	<p>Replace the foreground/background colour in the rendition mask with the
1068	specified one.</p>	806	specified one.</p>
1069	</dd>	807	</dd>
1070	</li>	808	<dt>$value = urxvt::GET_CUSTOM $rend</dt>
1071	<dt><strong><a name="item__value">$value = urxvt::GET_CUSTOM $rend</a></strong>
1072
1073	<dd>	809	<dd>
1074	<p>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
1075	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
1076	zero.</p>	812	zero.</p>
1077	</dd>	813	</dd>
1078	</li>
1079	<dt><strong>$rend = urxvt::SET_CUSTOM $rend, $new_value</strong>	814	<dt>$rend = urxvt::SET_CUSTOM $rend, $new_value</dt>
1080
1081	<dd>	815	<dd>
1082	<p>Change the custom value.</p>	816	<p>Change the custom value.</p>
1083	</dd>	817	</dd>
1084	</li>
1085	</dl>	818	</dl>
1086	<p>	819
1087	</p>	820	</div>
1088	<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">
1089	<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
1090	<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
1091	further programming. The only exception is that you cannot wait on	825	further programming. The only exception is that you cannot wait on
1092	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
1093	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
1094	work.</p>	828	work.</p>
1095	<p>	829
1096	</p>	830	</div>
1097	<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">
1098	<dl>	833	<dl>
1099	<dt><strong><a name="item__term">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong>	834	<dt>$term = new urxvt::term $envhashref, $rxvtname, [arg...]</dt>
1100
1101	<dd>	835	<dd>
1102	<p>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
1103	<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
1104	hash which defines the environment of the new terminal.</p>	838	hash which defines the environment of the new terminal.</p>
1105	</dd>
1106	<dd>
1107	<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
1108	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
1109	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
1110	<a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to	842	<code>start</code> hooks will be called before this call returns, and are free to
1111	refer to global data (which is race free).</p>	843	refer to global data (which is race free).</p>
1112	</dd>	844	</dd>
1113	</li>	845	<dt>$term->destroy</dt>
1114	<dt><strong><a name="item_destroy">$term->destroy</a></strong>
1115
1116	<dd>	846	<dd>
1117	<p>Destroy the terminal object (close the window, free resources	847	<p>Destroy the terminal object (close the window, free resources
1118	etc.). Please note that rxvt will not exit as long as any event	848	etc.). Please note that rxvt will not exit as long as any event
1119	watchers (timers, io watchers) are still active.</p>	849	watchers (timers, io watchers) are still active.</p>
1120	</dd>	850	</dd>
1121	</li>	851	<dt>$term->exec_async ($cmd[, @args])</dt>
1122	<dt><strong><a name="item_exec_async">$term->exec_async ($cmd[, @args])</a></strong>
1123
1124	<dd>	852	<dd>
1125	<p>Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes	853	<p>Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
1126	(``starts'') programs in the background. This function takes care of setting	854	("starts") programs in the background. This function takes care of setting
1127	the user environment before exec'ing the command (e.g. <code>PATH</code>) and should	855	the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
1128	be preferred over explicit calls to <code>exec</code> or <code>system</code>.</p>	856	be preferred over explicit calls to <code>exec</code> or <code>system</code>.</p>
1129	</dd>
1130	<dd>
1131	<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>	857	<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
1132	</dd>	858	</dd>
1133	</li>	859	<dt>$isset = $term->option ($optval[, $set])</dt>
1134	<dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong>
1135
1136	<dd>	860	<dd>
1137	<p>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
1138	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
1139	<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.</p>	863	<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.</p>
1140	</dd>
1141	<dd>
1142	<p>Here is 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
1143	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>
1144	</dd>
1145	<dd>
1146	<pre>
1147	borderLess console cursorBlink cursorUnderline hold iconic insecure	866	<pre> borderLess console cursorBlink cursorUnderline hold iconic insecure
1148	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	867	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1149	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	868	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1150	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	869	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
1151	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	870	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
1152	transparent tripleclickwords utmpInhibit visualBell</pre>	871	transparent tripleclickwords utmpInhibit visualBell
		872
		873	</pre>
1153	</dd>	874	</dd>
1154	</li>	875	<dt>$value = $term->resource ($name[, $newval])</dt>
1155	<dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong>
1156
1157	<dd>	876	<dd>
1158	<p>Returns the current resource value associated with a given name and	877	<p>Returns the current resource value associated with a given name and
1159	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>
1160	hook. Unset resources are returned and accepted as <code>undef</code>.</p>	879	hook. Unset resources are returned and accepted as <code>undef</code>.</p>
1161	</dd>
1162	<dd>
1163	<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
1164	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
1165	to be converted from the used encoding to text.</p>	882	to be converted from the used encoding to text.</p>
1166	</dd>
1167	<dd>
1168	<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
1169	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
1170	likely change).</p>	885	likely change).</p>
1171	</dd>
1172	<dd>
1173	<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
1174	terminal is destroyed, so changing options frequently will eat memory.</p>	887	terminal is destroyed, so changing options frequently will eat memory.</p>
1175	</dd>
1176	<dd>
1177	<p>Here is 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
1178	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>
1179	to see the actual list:</p>	890	to see the actual list:</p>
1180	</dd>
1181	<dd>
1182	<pre>
1183	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	891	<pre> answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1184	borderLess color cursorBlink cursorUnderline cutchars delete_key	892	borderLess color cursorBlink cursorUnderline cutchars delete_key
1185	display_name embed ext_bwidth fade font geometry hold iconName	893	display_name embed ext_bwidth fade font geometry hold iconName
1186	imFont imLocale inputMethod insecure int_bwidth intensityStyles	894	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1187	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	895	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
1188	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	896	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
…		…
1190	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	898	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1191	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	899	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1192	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	900	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1193	secondaryScreen secondaryScroll selectstyle shade term_name title	901	secondaryScreen secondaryScroll selectstyle shade term_name title
1194	transient_for transparent transparent_all tripleclickwords utmpInhibit	902	transient_for transparent transparent_all tripleclickwords utmpInhibit
1195	visualBell</pre>	903	visualBell
		904
		905	</pre>
1196	</dd>	906	</dd>
1197	</li>	907	<dt>$value = $term->x_resource ($pattern)</dt>
1198	<dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong>
1199
1200	<dd>	908	<dd>
1201	<p>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
1202	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
1203	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
1204	resource with that pattern exists.</p>	912	resource with that pattern exists.</p>
1205	</dd>
1206	<dd>
1207	<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
1208	only one resource database per display, and later invocations might return	914	only one resource database per display, and later invocations might return
1209	the wrong resources.</p>	915	the wrong resources.</p>
1210	</dd>	916	</dd>
1211	</li>	917	<dt>$success = $term->parse_keysym ($keysym_spec, $command_string)</dt>
1212	<dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong>
1213
1214	<dd>	918	<dd>
1215	<p>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
1216	<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.</p>	920	<code>keysym</code> resource in the rxvt(1) manpage.</p>
1217	</dd>	921	</dd>
1218	</li>	922	<dt>$rend = $term->rstyle ([$new_rstyle])</dt>
1219	<dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong>
1220
1221	<dd>	923	<dd>
1222	<p>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
1223	the terminal application will use this style.</p>	925	the terminal application will use this style.</p>
1224	</dd>	926	</dd>
1225	</li>	927	<dt>($row, $col) = $term->screen_cur ([$row, $col])</dt>
1226	<dt><strong><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a></strong>
1227
1228	<dd>	928	<dd>
1229	<p>Return the current coordinates of the text cursor position and optionally	929	<p>Return the current coordinates of the text cursor position and optionally
1230	set it (which is usually bad as applications don't expect that).</p>	930	set it (which is usually bad as applications don't expect that).</p>
1231	</dd>	931	</dd>
1232	</li>	932	<dt>($row, $col) = $term->selection_mark ([$row, $col])</dt>
1233	<dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong>	933	<dt>($row, $col) = $term->selection_beg ([$row, $col])</dt>
1234		934	<dt>($row, $col) = $term->selection_end ([$row, $col])</dt>
1235	<dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong>
1236
1237	<dt><strong><a name="item_selection_end">($row, $col) = $term->selection_end ([$row, $col])</a></strong>
1238
1239	<dd>	935	<dd>
1240	<p>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,
1241	and optionally set them to new values.</p>	937	and optionally set them to new values.</p>
1242	</dd>	938	</dd>
1243	</li>	939	<dt>$term->selection_make ($eventtime[, $rectangular])</dt>
1244	<dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong>
1245
1246	<dd>	940	<dd>
1247	<p>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
1248	<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
1249	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
1250	a selection.</p>	944	a selection.</p>
1251	</dd>	945	</dd>
1252	</li>	946	<dt>$success = $term->selection_grab ($eventtime)</dt>
1253	<dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong>
1254
1255	<dd>	947	<dd>
1256	<p>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
1257	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
1258	is mostly useful from within <code>on_sel_grab</code> hooks.</p>	950	is mostly useful from within <code>on_sel_grab</code> hooks.</p>
1259	</dd>	951	</dd>
1260	</li>
1261	<dt><strong>$oldtext = $term->selection ([$newtext])</strong>	952	<dt>$oldtext = $term->selection ([$newtext])</dt>
1262
1263	<dd>	953	<dd>
1264	<p>Return the current selection text and optionally replace it by <code>$newtext</code>.</p>	954	<p>Return the current selection text and optionally replace it by <code>$newtext</code>.</p>
1265	</dd>	955	</dd>
1266	</li>	956	<dt>$term->overlay_simple ($x, $y, $text)</dt>
1267	<dt><strong><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a></strong>
1268
1269	<dd>	957	<dd>
1270	<p>Create a simple multi-line overlay box. See the next method for details.</p>	958	<p>Create a simple multi-line overlay box. See the next method for details.</p>
1271	</dd>	959	</dd>
1272	</li>
1273	<dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong>	960	<dt>$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</dt>
1274
1275	<dd>	961	<dd>
1276	<p>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
1277	width/height. <code>$rstyle</code> defines the initial rendition style	963	width/height. <code>$rstyle</code> defines the initial rendition style
1278	(default: <code>OVERLAY_RSTYLE</code>).</p>	964	(default: <code>OVERLAY_RSTYLE</code>).</p>
1279	</dd>
1280	<dd>
1281	<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
1282	around the box.</p>	966	around the box.</p>
1283	</dd>
1284	<dd>
1285	<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
1286	right/bottom side, respectively.</p>	968	right/bottom side, respectively.</p>
1287	</dd>
1288	<dd>
1289	<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
1290	as long as the perl object is referenced.</p>	970	as long as the perl object is referenced.</p>
1291	</dd>
1292	<dd>
1293	<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>
1294	</dd>	972	<p>
1295	<dl>	973	<dl>
1296	<dt><strong><a name="item_set">$overlay->set ($x, $y, $text, $rend)</a></strong>	974	<dt>$overlay->set ($x, $y, $text, $rend)</dt>
1297		975	<dd>
1298	<dd>
1299	<p>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	976	<p>Similar to <code>$term->ROW_t</code> and <code>$term->ROW_r</code> in that it puts
1300	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
1301	at a specific position inside the overlay.</p>	978	at a specific position inside the overlay.</p>
1302	</dd>	979	</dd>
1303	</li>	980	<dt>$overlay->hide</dt>
1304	<dt><strong><a name="item_hide">$overlay->hide</a></strong>	981	<dd>
1305
1306	<dd>
1307	<p>If visible, hide the overlay, but do not destroy it.</p>	982	<p>If visible, hide the overlay, but do not destroy it.</p>
1308	</dd>	983	</dd>
1309	</li>	984	<dt>$overlay->show</dt>
1310	<dt><strong><a name="item_show">$overlay->show</a></strong>	985	<dd>
1311
1312	<dd>
1313	<p>If hidden, display the overlay again.</p>	986	<p>If hidden, display the overlay again.</p>
		987	</dd>
		988	</dl>
		989	</p>
1314	</dd>	990	</dd>
1315	</li>
1316	</dl>
1317	<dt><strong>$popup = $term->popup ($event)</strong>	991	<dt>$popup = $term->popup ($event)</dt>
1318
1319	<dd>	992	<dd>
1320	<p>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
1321	<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,
1322	currently).</p>	995	currently).</p>
1323	</dd>	996	</dd>
1324	</li>	997	<dt>$cellwidth = $term->strwidth ($string)</dt>
1325	<dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a></strong>
1326
1327	<dd>	998	<dd>
1328	<p>Returns the number of screen-cells this string would need. Correctly	999	<p>Returns the number of screen-cells this string would need. Correctly
1329	accounts for wide and combining characters.</p>	1000	accounts for wide and combining characters.</p>
1330	</dd>	1001	</dd>
1331	</li>	1002	<dt>$octets = $term->locale_encode ($string)</dt>
1332	<dt><strong><a name="item_locale_encode">$octets = $term->locale_encode ($string)</a></strong>
1333
1334	<dd>	1003	<dd>
1335	<p>Convert the given text string into the corresponding locale encoding.</p>	1004	<p>Convert the given text string into the corresponding locale encoding.</p>
1336	</dd>	1005	</dd>
1337	</li>	1006	<dt>$string = $term->locale_decode ($octets)</dt>
1338	<dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong>
1339
1340	<dd>	1007	<dd>
1341	<p>Convert the given locale-encoded octets into a perl string.</p>	1008	<p>Convert the given locale-encoded octets into a perl string.</p>
1342	</dd>	1009	</dd>
1343	</li>
1344	<dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong>	1010	<dt>$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</dt>
1345
1346	<dd>	1011	<dd>
1347	<p>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
1348	(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
1349	refresh hooks to provide effects similar to the selection.</p>	1014	refresh hooks to provide effects similar to the selection.</p>
1350	</dd>	1015	</dd>
1351	</li>
1352	<dt><strong><a name="item_scr_xor_rect">$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong>	1016	<dt>$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</dt>
1353
1354	<dd>	1017	<dd>
1355	<p>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
1356	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
1357	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
1358	it instead. Both styles <em>MUST NOT</em> contain font styles.</p>	1021	it instead. Both styles <i>MUST NOT</i> contain font styles.</p>
1359	</dd>	1022	</dd>
1360	</li>	1023	<dt>$term->scr_bell</dt>
1361	<dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong>
1362
1363	<dd>	1024	<dd>
1364	<p>Ring the bell!</p>	1025	<p>Ring the bell!</p>
1365	</dd>	1026	</dd>
1366	</li>	1027	<dt>$term->scr_add_lines ($string)</dt>
1367	<dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong>
1368
1369	<dd>	1028	<dd>
1370	<p>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
1371	running inside the terminal. It may not contain command sequences (escape	1030	running inside the terminal. It may not contain command sequences (escape
1372	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
1373	string is a normal text string, not in locale-dependent encoding.</p>	1032	string is a normal text string, not in locale-dependent encoding.</p>
1374	</dd>
1375	<dd>
1376	<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
1377	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
1378	<code>on_add_lines</code> hook, though.</p>	1035	<code>on_add_lines</code> hook, though.</p>
1379	</dd>	1036	</dd>
1380	</li>	1037	<dt>$term->scr_change_screen ($screen)</dt>
1381	<dt><strong><a name="item_scr_change_screen">$term->scr_change_screen ($screen)</a></strong>
1382
1383	<dd>	1038	<dd>
1384	<p>Switch to given screen - 0 primary, 1 secondary.</p>	1039	<p>Switch to given screen - 0 primary, 1 secondary.</p>
1385	</dd>	1040	</dd>
1386	</li>	1041	<dt>$term->cmd_parse ($octets)</dt>
1387	<dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong>
1388
1389	<dd>	1042	<dd>
1390	<p>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
1391	locale-specific encoding of the terminal and can contain command sequences	1044	locale-specific encoding of the terminal and can contain command sequences
1392	(escape codes) that will be interpreted.</p>	1045	(escape codes) that will be interpreted.</p>
1393	</dd>	1046	</dd>
1394	</li>	1047	<dt>$term->tt_write ($octets)</dt>
1395	<dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong>
1396
1397	<dd>	1048	<dd>
1398	<p>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
1399	pass characters instead of octets, you should convert your strings first	1050	pass characters instead of octets, you should convert your strings first
1400	to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>.</p>	1051	to the locale-specific encoding using <code>$term->locale_encode</code>.</p>
1401	</dd>	1052	</dd>
1402	</li>	1053	<dt>$old_events = $term->pty_ev_events ([$new_events])</dt>
1403	<dt><strong><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a></strong>
1404
1405	<dd>	1054	<dd>
1406	<p>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
1407	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
1408	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
1409	the previous value.</p>	1058	the previous value.</p>
1410	</dd>	1059	</dd>
1411	</li>	1060	<dt>$fd = $term->pty_fd</dt>
1412	<dt><strong><a name="item_pty_fd">$fd = $term->pty_fd</a></strong>
1413
1414	<dd>	1061	<dd>
1415	<p>Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty	1062	<p>Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
1416	is used.</p>	1063	is used.</p>
1417	</dd>	1064	</dd>
1418	</li>	1065	<dt>$windowid = $term->parent</dt>
1419	<dt><strong><a name="item_parent">$windowid = $term->parent</a></strong>
1420
1421	<dd>	1066	<dd>
1422	<p>Return the window id of the toplevel window.</p>	1067	<p>Return the window id of the toplevel window.</p>
1423	</dd>	1068	</dd>
1424	</li>	1069	<dt>$windowid = $term->vt</dt>
1425	<dt><strong><a name="item_vt">$windowid = $term->vt</a></strong>
1426
1427	<dd>	1070	<dd>
1428	<p>Return the window id of the terminal window.</p>	1071	<p>Return the window id of the terminal window.</p>
1429	</dd>	1072	</dd>
1430	</li>	1073	<dt>$term->vt_emask_add ($x_event_mask)</dt>
1431	<dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong>
1432
1433	<dd>	1074	<dd>
1434	<p>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
1435	to receive pointer events all the times:</p>	1076	to receive pointer events all the times:</p>
1436	</dd>	1077	<pre> $term->vt_emask_add (urxvt::PointerMotionMask);
1437	<dd>	1078
1438	<pre>	1079	</pre>
1439	$term->vt_emask_add (urxvt::PointerMotionMask);</pre>
1440	</dd>	1080	</dd>
1441	</li>	1081	<dt>$term->focus_in</dt>
1442	<dt><strong><a name="item_focus_in">$term->focus_in</a></strong>	1082	<dt>$term->focus_out</dt>
1443		1083	<dt>$term->key_press ($state, $keycode[, $time])</dt>
1444	<dt><strong><a name="item_focus_out">$term->focus_out</a></strong>	1084	<dt>$term->key_release ($state, $keycode[, $time])</dt>
1445
1446	<dt><strong><a name="item_key_press">$term->key_press ($state, $keycode[, $time])</a></strong>
1447
1448	<dt><strong><a name="item_key_release">$term->key_release ($state, $keycode[, $time])</a></strong>
1449
1450	<dd>	1085	<dd>
1451	<p>Deliver various fake events to to terminal.</p>	1086	<p>Deliver various fake events to to terminal.</p>
1452	</dd>	1087	</dd>
1453	</li>	1088	<dt>$window_width = $term->width</dt>
1454	<dt><strong><a name="item_width">$window_width = $term->width</a></strong>	1089	<dt>$window_height = $term->height</dt>
1455		1090	<dt>$font_width = $term->fwidth</dt>
1456	<dt><strong><a name="item_height">$window_height = $term->height</a></strong>	1091	<dt>$font_height = $term->fheight</dt>
1457		1092	<dt>$font_ascent = $term->fbase</dt>
1458	<dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong>	1093	<dt>$terminal_rows = $term->nrow</dt>
1459		1094	<dt>$terminal_columns = $term->ncol</dt>
1460	<dt><strong><a name="item_fheight">$font_height = $term->fheight</a></strong>	1095	<dt>$has_focus = $term->focus</dt>
1461		1096	<dt>$is_mapped = $term->mapped</dt>
1462	<dt><strong><a name="item_fbase">$font_ascent = $term->fbase</a></strong>	1097	<dt>$max_scrollback = $term->saveLines</dt>
1463		1098	<dt>$nrow_plus_saveLines = $term->total_rows</dt>
1464	<dt><strong><a name="item_nrow">$terminal_rows = $term->nrow</a></strong>	1099	<dt>$topmost_scrollback_row = $term->top_row</dt>
1465
1466	<dt><strong><a name="item_ncol">$terminal_columns = $term->ncol</a></strong>
1467
1468	<dt><strong><a name="item_focus">$has_focus = $term->focus</a></strong>
1469
1470	<dt><strong><a name="item_mapped">$is_mapped = $term->mapped</a></strong>
1471
1472	<dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong>
1473
1474	<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong>
1475
1476	<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a></strong>
1477
1478	<dd>	1100	<dd>
1479	<p>Return various integers describing terminal characteristics.</p>	1101	<p>Return various integers describing terminal characteristics.</p>
1480	</dd>	1102	</dd>
1481	</li>	1103	<dt>$x_display = $term->display_id</dt>
1482	<dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong>
1483
1484	<dd>	1104	<dd>
1485	<p>Return the DISPLAY used by rxvt-unicode.</p>	1105	<p>Return the DISPLAY used by rxvt-unicode.</p>
1486	</dd>	1106	</dd>
1487	</li>	1107	<dt>$lc_ctype = $term->locale</dt>
1488	<dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong>
1489
1490	<dd>	1108	<dd>
1491	<p>Returns the LC_CTYPE category string used by this rxvt-unicode.</p>	1109	<p>Returns the LC_CTYPE category string used by this rxvt-unicode.</p>
1492	</dd>	1110	</dd>
1493	</li>	1111	<dt>$env = $term->env</dt>
1494	<dt><strong><a name="item_env">$env = $term->env</a></strong>
1495
1496	<dd>	1112	<dd>
1497	<p>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
1498	similar to <code>\%ENV</code>.</p>	1114	similar to <code>\%ENV</code>.</p>
1499	</dd>	1115	</dd>
1500	</li>	1116	<dt>@envv = $term->envv</dt>
1501	<dt><strong><a name="item_envv">@envv = $term->envv</a></strong>
1502
1503	<dd>	1117	<dd>
1504	<p>Returns the environment as array of strings of the form <code>VAR=VALUE</code>.</p>	1118	<p>Returns the environment as array of strings of the form <code>VAR=VALUE</code>.</p>
1505	</dd>	1119	</dd>
1506	</li>	1120	<dt>@argv = $term->argv</dt>
1507	<dt><strong><a name="item_argv">@argv = $term->argv</a></strong>
1508
1509	<dd>	1121	<dd>
1510	<p>Return the argument vector as this terminal, similar to @ARGV, but	1122	<p>Return the argument vector as this terminal, similar to @ARGV, but
1511	includes the program name as first element.</p>	1123	includes the program name as first element.</p>
1512	</dd>	1124	</dd>
1513	</li>	1125	<dt>$modifiermask = $term->ModLevel3Mask</dt>
1514	<dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong>	1126	<dt>$modifiermask = $term->ModMetaMask</dt>
1515		1127	<dt>$modifiermask = $term->ModNumLockMask</dt>
1516	<dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong>
1517
1518	<dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong>
1519
1520	<dd>	1128	<dd>
1521	<p>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
1522	AltGr), the meta key (often Alt) and the num lock key, if applicable.</p>	1130	AltGr), the meta key (often Alt) and the num lock key, if applicable.</p>
1523	</dd>	1131	</dd>
1524	</li>	1132	<dt>$screen = $term->current_screen</dt>
1525	<dt><strong><a name="item_current_screen">$screen = $term->current_screen</a></strong>
1526
1527	<dd>	1133	<dd>
1528	<p>Returns the currently displayed screen (0 primary, 1 secondary).</p>	1134	<p>Returns the currently displayed screen (0 primary, 1 secondary).</p>
1529	</dd>	1135	</dd>
1530	</li>	1136	<dt>$cursor_is_hidden = $term->hidden_cursor</dt>
1531	<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term->hidden_cursor</a></strong>
1532
1533	<dd>	1137	<dd>
1534	<p>Returns whether the cursor is currently hidden or not.</p>	1138	<p>Returns whether the cursor is currently hidden or not.</p>
1535	</dd>	1139	</dd>
1536	</li>	1140	<dt>$view_start = $term->view_start ([$newvalue])</dt>
1537	<dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong>
1538
1539	<dd>	1141	<dd>
1540	<p>Returns the row number of the topmost displayed line. Maximum value is	1142	<p>Returns the row number of the topmost displayed line. Maximum value is
1541	<code>0</code>, which displays the normal terminal contents. Lower values scroll	1143	<code>0</code>, which displays the normal terminal contents. Lower values scroll
1542	this many lines into the scrollback buffer.</p>	1144	this many lines into the scrollback buffer.</p>
1543	</dd>	1145	</dd>
1544	</li>	1146	<dt>$term->want_refresh</dt>
1545	<dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong>
1546
1547	<dd>	1147	<dd>
1548	<p>Requests a screen refresh. At the next opportunity, rxvt-unicode will	1148	<p>Requests a screen refresh. At the next opportunity, rxvt-unicode will
1549	compare the on-screen display with its stored representation. If they	1149	compare the on-screen display with its stored representation. If they
1550	differ, it redraws the differences.</p>	1150	differ, it redraws the differences.</p>
1551	</dd>
1552	<dd>
1553	<p>Used after changing terminal contents to display them.</p>	1151	<p>Used after changing terminal contents to display them.</p>
1554	</dd>	1152	</dd>
1555	</li>
1556	<dt><strong><a name="item_row_t">$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</a></strong>	1153	<dt>$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</dt>
1557
1558	<dd>	1154	<dd>
1559	<p>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>
1560	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
1561	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
1562	line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line	1158	line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line
1563	is requested.</p>	1159	is requested.</p>
1564	</dd>
1565	<dd>
1566	<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
1567	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
1568	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
1569	automatically be updated.</p>	1163	automatically be updated.</p>
1570	</dd>
1571	<dd>
1572	<p><a href="#item__text"><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
1573	than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)	1165	than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
1574	characters. Characters with combining characters and other characters that	1166	characters. Characters with combining characters and other characters that
1575	do not fit into the normal tetx encoding will be replaced with characters	1167	do not fit into the normal tetx encoding will be replaced with characters
1576	in the private use area.</p>	1168	in the private use area.</p>
1577	</dd>
1578	<dd>
1579	<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
1580	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
1581	characters.</p>	1171	characters.</p>
1582	</dd>	1172	<p>The methods <code>$term->special_encode</code> and <code>$term->special_decode</code>
1583	<dd>
1584	<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>
1585	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>
1586	</dd>	1174	</dd>
1587	</li>
1588	<dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong>	1175	<dt>$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</dt>
1589
1590	<dd>	1176	<dd>
1591	<p>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
1592	bitsets. Rendition bitsets contain information about colour, font, font	1178	bitsets. Rendition bitsets contain information about colour, font, font
1593	styles and similar information. See also <a href="#item_row_t"><code>$term->ROW_t</code></a>.</p>	1179	styles and similar information. See also <code>$term->ROW_t</code>.</p>
1594	</dd>
1595	<dd>
1596	<p>When setting rendition, the font mask will be ignored.</p>	1180	<p>When setting rendition, the font mask will be ignored.</p>
1597	</dd>
1598	<dd>
1599	<p>See the section on RENDITION, above.</p>	1181	<p>See the section on RENDITION, above.</p>
1600	</dd>	1182	</dd>
1601	</li>	1183	<dt>$length = $term->ROW_l ($row_number[, $new_length])</dt>
1602	<dt><strong><a name="item_row_l">$length = $term->ROW_l ($row_number[, $new_length])</a></strong>
1603
1604	<dd>	1184	<dd>
1605	<p>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
1606	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
1607	line is joined with the following one.</p>	1187	line is joined with the following one.</p>
1608	</dd>	1188	</dd>
1609	</li>	1189	<dt>$bool = $term->is_longer ($row_number)</dt>
1610	<dt><strong><a name="item_is_longer">$bool = $term->is_longer ($row_number)</a></strong>
1611
1612	<dd>	1190	<dd>
1613	<p>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.
1614	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
1615	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
1616	previous row(s)).</p>	1194	previous row(s)).</p>
1617	</dd>	1195	</dd>
1618	</li>	1196	<dt>$line = $term->line ($row_number)</dt>
1619	<dt><strong><a name="item_line">$line = $term->line ($row_number)</a></strong>
1620
1621	<dd>	1197	<dd>
1622	<p>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
1623	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
1624	following methods:</p>	1200	following methods:</p>
1625	</dd>	1201	<p>
1626	<dl>	1202	<dl>
1627	<dt><strong><a name="item_t">$text = $line->t ([$new_text])</a></strong>	1203	<dt>$text = $line->t ([$new_text])</dt>
1628		1204	<dd>
1629	<dd>
1630	<p>Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a></p>	1205	<p>Returns or replaces the full text of the line, similar to <code>ROW_t</code></p>
1631	</dd>	1206	</dd>
1632	</li>	1207	<dt>$rend = $line->r ([$new_rend])</dt>
1633	<dt><strong><a name="item_r">$rend = $line->r ([$new_rend])</a></strong>	1208	<dd>
1634
1635	<dd>
1636	<p>Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a></p>	1209	<p>Returns or replaces the full rendition array of the line, similar to <code>ROW_r</code></p>
1637	</dd>	1210	</dd>
1638	</li>	1211	<dt>$length = $line->l</dt>
1639	<dt><strong><a name="item_l">$length = $line->l</a></strong>	1212	<dd>
1640
1641	<dd>
1642	<p>Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.</p>	1213	<p>Returns the length of the line in cells, similar to <code>ROW_l</code>.</p>
1643	</dd>	1214	</dd>
1644	</li>	1215	<dt>$rownum = $line->beg</dt>
1645	<dt><strong><a name="item_beg">$rownum = $line->beg</a></strong>	1216	<dt>$rownum = $line->end</dt>
1646		1217	<dd>
1647	<dt><strong><a name="item_end">$rownum = $line->end</a></strong>
1648
1649	<dd>
1650	<p>Return the row number of the first/last row of the line, respectively.</p>	1218	<p>Return the row number of the first/last row of the line, respectively.</p>
1651	</dd>	1219	</dd>
1652	</li>	1220	<dt>$offset = $line->offset_of ($row, $col)</dt>
1653	<dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong>	1221	<dd>
1654
1655	<dd>
1656	<p>Returns the character offset of the given row\|col pair within the logical	1222	<p>Returns the character offset of the given row\|col pair within the logical
1657	line. Works for rows outside the line, too, and returns corresponding	1223	line. Works for rows outside the line, too, and returns corresponding
1658	offsets outside the string.</p>	1224	offsets outside the string.</p>
1659	</dd>	1225	</dd>
1660	</li>	1226	<dt>($row, $col) = $line->coord_of ($offset)</dt>
1661	<dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong>	1227	<dd>
1662
1663	<dd>
1664	<p>Translates a string offset into terminal coordinates again.</p>	1228	<p>Translates a string offset into terminal coordinates again.</p>
		1229	</dd>
		1230	</dl>
		1231	</p>
1665	</dd>	1232	</dd>
1666	</li>	1233	<dt>$text = $term->special_encode $string</dt>
1667	</dl>
1668	<dt><strong><a name="item_special_encode">$text = $term->special_encode $string</a></strong>
1669
1670	<dd>	1234	<dd>
1671	<p>Converts a perl string into the special encoding used by rxvt-unicode,	1235	<p>Converts a perl string into the special encoding used by rxvt-unicode,
1672	where one character corresponds to one screen cell. See	1236	where one character corresponds to one screen cell. See
1673	<a href="#item_row_t"><code>$term->ROW_t</code></a> for details.</p>	1237	<code>$term->ROW_t</code> for details.</p>
1674	</dd>	1238	</dd>
1675	</li>	1239	<dt>$string = $term->special_decode $text</dt>
1676	<dt><strong><a name="item_special_decode">$string = $term->special_decode $text</a></strong>
1677
1678	<dd>	1240	<dd>
1679	<p>Converts rxvt-unicodes text representation into a perl string. See	1241	<p>Converts rxvt-unicodes text representation into a perl string. See
1680	<a href="#item_row_t"><code>$term->ROW_t</code></a> for details.</p>	1242	<code>$term->ROW_t</code> for details.</p>
1681	</dd>	1243	</dd>
1682	</li>
1683	<dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])</a></strong>	1244	<dt>$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])</dt>
1684
1685	<dt><strong><a name="item_ungrab_button">$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])</a></strong>	1245	<dt>$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])</dt>
1686
1687	<dd>	1246	<dd>
1688	<p>Register/unregister a synchronous button grab. See the XGrabButton	1247	<p>Register/unregister a synchronous button grab. See the XGrabButton
1689	manpage.</p>	1248	manpage.</p>
1690	</dd>	1249	</dd>
1691	</li>	1250	<dt>$success = $term->grab ($eventtime[, $sync])</dt>
1692	<dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong>
1693
1694	<dd>	1251	<dd>
1695	<p>Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1252	<p>Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1696	synchronous (<code>$sync</code> is true). Also remembers the grab timestamp.</p>	1253	synchronous (<code>$sync</code> is true). Also remembers the grab timestamp.</p>
1697	</dd>	1254	</dd>
1698	</li>	1255	<dt>$term->allow_events_async</dt>
1699	<dt><strong><a name="item_allow_events_async">$term->allow_events_async</a></strong>
1700
1701	<dd>	1256	<dd>
1702	<p>Calls XAllowEvents with AsyncBoth for the most recent grab.</p>	1257	<p>Calls XAllowEvents with AsyncBoth for the most recent grab.</p>
1703	</dd>	1258	</dd>
1704	</li>	1259	<dt>$term->allow_events_sync</dt>
1705	<dt><strong><a name="item_allow_events_sync">$term->allow_events_sync</a></strong>
1706
1707	<dd>	1260	<dd>
1708	<p>Calls XAllowEvents with SyncBoth for the most recent grab.</p>	1261	<p>Calls XAllowEvents with SyncBoth for the most recent grab.</p>
1709	</dd>	1262	</dd>
1710	</li>	1263	<dt>$term->allow_events_replay</dt>
1711	<dt><strong><a name="item_allow_events_replay">$term->allow_events_replay</a></strong>
1712
1713	<dd>	1264	<dd>
1714	<p>Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1265	<p>Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1715	recent grab.</p>	1266	recent grab.</p>
1716	</dd>	1267	</dd>
1717	</li>	1268	<dt>$term->ungrab</dt>
1718	<dt><strong><a name="item_ungrab">$term->ungrab</a></strong>
1719
1720	<dd>	1269	<dd>
1721	<p>Calls XUngrab for the most recent grab. Is called automatically on	1270	<p>Calls XUngrab for the most recent grab. Is called automatically on
1722	evaluation errors, as it is better to lose the grab in the error case as	1271	evaluation errors, as it is better to lose the grab in the error case as
1723	the session.</p>	1272	the session.</p>
1724	</dd>	1273	</dd>
1725	</li>	1274	<dt>$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</dt>
1726	<dt><strong><a name="item_xinternatom">$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</a></strong>	1275	<dt>$atom_name = $term->XGetAtomName ($atom)</dt>
1727		1276	<dt>@atoms = $term->XListProperties ($window)</dt>
1728	<dt><strong><a name="item_xgetatomname">$atom_name = $term->XGetAtomName ($atom)</a></strong>	1277	<dt>($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</dt>
1729		1278	<dt>$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</dt>
1730	<dt><strong><a name="item_xlistproperties">@atoms = $term->XListProperties ($window)</a></strong>	1279	<dt>$term->XDeleteProperty ($window, $property)</dt>
1731		1280	<dt>$window = $term->DefaultRootWindow</dt>
1732	<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</a></strong>	1281	<dt>$term->XReparentWindow ($window, $parent, [$x, $y])</dt>
1733		1282	<dt>$term->XMapWindow ($window)</dt>
1734	<dt><strong><a name="item_xchangewindowproperty">$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong>	1283	<dt>$term->XUnmapWindow ($window)</dt>
1735		1284	<dt>$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</dt>
1736	<dt><strong><a name="item_xdeleteproperty">$term->XDeleteProperty ($window, $property)</a></strong>	1285	<dt>($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</dt>
1737		1286	<dt>$term->XChangeInput ($window, $add_events[, $del_events])</dt>
1738	<dt><strong><a name="item_defaultrootwindow">$window = $term->DefaultRootWindow</a></strong>
1739
1740	<dt><strong><a name="item_xreparentwindow">$term->XReparentWindow ($window, $parent, [$x, $y])</a></strong>
1741
1742	<dt><strong><a name="item_xmapwindow">$term->XMapWindow ($window)</a></strong>
1743
1744	<dt><strong><a name="item_xunmapwindow">$term->XUnmapWindow ($window)</a></strong>
1745
1746	<dt><strong><a name="item_xmoveresizewindow">$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong>
1747
1748	<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</a></strong>
1749
1750	<dt><strong><a name="item_xchangeinput">$term->XChangeInput ($window, $add_events[, $del_events])</a></strong>
1751
1752	<dd>	1287	<dd>
1753	<p>Various X or X-related functions. The <a href="#item__term"><code>$term</code></a> object only serves as	1288	<p>Various X or X-related functions. The <code>$term</code> object only serves as
1754	the source of the display, otherwise those functions map more-or-less	1289	the source of the display, otherwise those functions map more-or-less
1755	directory onto the X functions of the same name.</p>	1290	directory onto the X functions of the same name.</p>
1756	</dd>	1291	</dd>
1757	</li>
1758	</dl>	1292	</dl>
1759	<p>	1293
1760	</p>	1294	</div>
1761	<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>	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">
1762	<dl>	1297	<dl>
1763	<dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong>	1298	<dt>$popup->add_title ($title)</dt>
1764
1765	<dd>	1299	<dd>
1766	<p>Adds a non-clickable title to the popup.</p>	1300	<p>Adds a non-clickable title to the popup.</p>
1767	</dd>	1301	</dd>
1768	</li>	1302	<dt>$popup->add_separator ([$sepchr])</dt>
1769	<dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong>
1770
1771	<dd>	1303	<dd>
1772	<p>Creates a separator, optionally using the character given as <code>$sepchr</code>.</p>	1304	<p>Creates a separator, optionally using the character given as <code>$sepchr</code>.</p>
1773	</dd>	1305	</dd>
1774	</li>	1306	<dt>$popup->add_button ($text, $cb)</dt>
1775	<dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong>
1776
1777	<dd>	1307	<dd>
1778	<p>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
1779	selected.</p>	1309	selected.</p>
1780	</dd>	1310	</dd>
1781	</li>	1311	<dt>$popup->add_toggle ($text, $initial_value, $cb)</dt>
1782	<dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $initial_value, $cb)</a></strong>
1783
1784	<dd>	1312	<dd>
1785	<p>Adds a toggle/checkbox item to the popup. The callback gets called	1313	<p>Adds a toggle/checkbox item to the popup. The callback gets called
1786	whenever it gets toggled, with a boolean indicating its new value as its	1314	whenever it gets toggled, with a boolean indicating its new value as its
1787	first argument.</p>	1315	first argument.</p>
1788	</dd>	1316	</dd>
1789	</li>
1790	<dt><strong>$popup->show</strong>	1317	<dt>$popup->show</dt>
1791
1792	<dd>	1318	<dd>
1793	<p>Displays the popup (which is initially hidden).</p>	1319	<p>Displays the popup (which is initially hidden).</p>
1794	</dd>	1320	</dd>
1795	</li>
1796	</dl>	1321	</dl>
1797	<p>	1322
1798	</p>	1323	</div>
1799	<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">
1800	<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
1801	fractional number of seconds since the epoch. Example:</p>	1327	fractional number of seconds since the epoch. Example:</p>
1802	<pre>
1803	$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);
1804	$term->{timer} = urxvt::timer	1329	$term->{timer} = urxvt::timer
1805	->new	1330	->new
1806	->interval (1)	1331	->interval (1)
1807	->cb (sub {	1332	->cb (sub {
1808	$term->{overlay}->set (0, 0,	1333	$term->{overlay}->set (0, 0,
1809	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1334	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1810	});</pre>	1335	});
		1336
		1337	</pre>
1811	<dl>	1338	<dl>
1812	<dt><strong><a name="item__timer">$timer = new urxvt::timer</a></strong>	1339	<dt>$timer = new urxvt::timer</dt>
1813
1814	<dd>	1340	<dd>
1815	<p>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
1816	immediately.</p>	1342	immediately.</p>
1817	</dd>	1343	</dd>
1818	</li>
1819	<dt><strong><a name="item_cb">$timer = $timer->cb (sub { my ($timer) = @_; ... })</a></strong>	1344	<dt>$timer = $timer->cb (sub { my ($timer) = @_; ... })</dt>
1820
1821	<dd>	1345	<dd>
1822	<p>Set the callback to be called when the timer triggers.</p>	1346	<p>Set the callback to be called when the timer triggers.</p>
1823	</dd>	1347	</dd>
1824	</li>	1348	<dt>$tstamp = $timer->at</dt>
1825	<dt><strong><a name="item_at">$tstamp = $timer->at</a></strong>
1826
1827	<dd>	1349	<dd>
1828	<p>Return the time this watcher will fire next.</p>	1350	<p>Return the time this watcher will fire next.</p>
1829	</dd>	1351	</dd>
1830	</li>
1831	<dt><strong>$timer = $timer->set ($tstamp)</strong>	1352	<dt>$timer = $timer->set ($tstamp)</dt>
1832
1833	<dd>	1353	<dd>
1834	<p>Set the time the event is generated to $tstamp.</p>	1354	<p>Set the time the event is generated to $tstamp.</p>
1835	</dd>	1355	</dd>
1836	</li>	1356	<dt>$timer = $timer->interval ($interval)</dt>
1837	<dt><strong><a name="item_interval">$timer = $timer->interval ($interval)</a></strong>
1838
1839	<dd>	1357	<dd>
1840	<p>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
1841	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
1842	is automatically rescheduled at the given intervals.</p>	1360	is automatically rescheduled at the given intervals.</p>
1843	</dd>	1361	</dd>
1844	</li>	1362	<dt>$timer = $timer->start</dt>
1845	<dt><strong><a name="item_start">$timer = $timer->start</a></strong>
1846
1847	<dd>	1363	<dd>
1848	<p>Start the timer.</p>	1364	<p>Start the timer.</p>
1849	</dd>	1365	</dd>
1850	</li>
1851	<dt><strong>$timer = $timer->start ($tstamp)</strong>	1366	<dt>$timer = $timer->start ($tstamp)</dt>
1852
1853	<dd>	1367	<dd>
1854	<p>Set the event trigger time to <code>$tstamp</code> and start the timer.</p>	1368	<p>Set the event trigger time to <code>$tstamp</code> and start the timer.</p>
1855	</dd>	1369	</dd>
1856	</li>	1370	<dt>$timer = $timer->after ($delay)</dt>
1857	<dt><strong><a name="item_after">$timer = $timer->after ($delay)</a></strong>
1858
1859	<dd>	1371	<dd>
1860	<p>Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c<urxvt::NOW + $delay>.</p>	1372	<p>Like <code>start</code>, but sets the expiry timer to c<urxvt::NOW + $delay>.</p>
1861	</dd>	1373	</dd>
1862	</li>	1374	<dt>$timer = $timer->stop</dt>
1863	<dt><strong><a name="item_stop">$timer = $timer->stop</a></strong>
1864
1865	<dd>	1375	<dd>
1866	<p>Stop the timer.</p>	1376	<p>Stop the timer.</p>
1867	</dd>	1377	</dd>
1868	</li>
1869	</dl>	1378	</dl>
1870	<p>	1379
1871	</p>	1380	</div>
1872	<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">
1873	<p>This class implements io watchers/events. Example:</p>	1383	<p>This class implements io watchers/events. Example:</p>
1874	<pre>
1875	$term->{socket} = ...	1384	<pre> $term->{socket} = ...
1876	$term->{iow} = urxvt::iow	1385	$term->{iow} = urxvt::iow
1877	->new	1386	->new
1878	->fd (fileno $term->{socket})	1387	->fd (fileno $term->{socket})
1879	->events (urxvt::EVENT_READ)	1388	->events (urxvt::EVENT_READ)
1880	->start	1389	->start
1881	->cb (sub {	1390	->cb (sub {
1882	my ($iow, $revents) = @_;	1391	my ($iow, $revents) = @_;
1883	# $revents must be 1 here, no need to check	1392	# $revents must be 1 here, no need to check
1884	sysread $term->{socket}, my $buf, 8192	1393	sysread $term->{socket}, my $buf, 8192
1885	or end-of-file;	1394	or end-of-file;
1886	});</pre>	1395	});
		1396
		1397
		1398
		1399
		1400	</pre>
1887	<dl>	1401	<dl>
1888	<dt><strong><a name="item__iow">$iow = new urxvt::iow</a></strong>	1402	<dt>$iow = new urxvt::iow</dt>
1889
1890	<dd>	1403	<dd>
1891	<p>Create a new io watcher object in stopped state.</p>	1404	<p>Create a new io watcher object in stopped state.</p>
1892	</dd>	1405	</dd>
1893	</li>
1894	<dt><strong>$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })</strong>	1406	<dt>$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })</dt>
1895
1896	<dd>	1407	<dd>
1897	<p>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>
1898	is a bitset as described in the <a href="#item_events"><code>events</code></a> method.</p>	1409	is a bitset as described in the <code>events</code> method.</p>
1899	</dd>	1410	</dd>
1900	</li>	1411	<dt>$iow = $iow->fd ($fd)</dt>
1901	<dt><strong><a name="item_fd">$iow = $iow->fd ($fd)</a></strong>
1902
1903	<dd>	1412	<dd>
1904	<p>Set the file descriptor (not handle) to watch.</p>	1413	<p>Set the file descriptor (not handle) to watch.</p>
1905	</dd>	1414	</dd>
1906	</li>	1415	<dt>$iow = $iow->events ($eventmask)</dt>
1907	<dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong>
1908
1909	<dd>	1416	<dd>
1910	<p>Set the event mask to watch. The only allowed values are	1417	<p>Set the event mask to watch. The only allowed values are
1911	<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
1912	together, or <code>urxvt::EVENT_NONE</code>.</p>	1419	together, or <code>urxvt::EVENT_NONE</code>.</p>
1913	</dd>	1420	</dd>
1914	</li>
1915	<dt><strong>$iow = $iow->start</strong>	1421	<dt>$iow = $iow->start</dt>
1916
1917	<dd>	1422	<dd>
1918	<p>Start watching for requested events on the given handle.</p>	1423	<p>Start watching for requested events on the given handle.</p>
1919	</dd>	1424	</dd>
1920	</li>
1921	<dt><strong>$iow = $iow->stop</strong>	1425	<dt>$iow = $iow->stop</dt>
1922
1923	<dd>	1426	<dd>
1924	<p>Stop watching for events on the given file handle.</p>	1427	<p>Stop watching for events on the given file handle.</p>
1925	</dd>	1428	</dd>
1926	</li>
1927	</dl>	1429	</dl>
1928	<p>	1430
1929	</p>	1431	</div>
1930	<h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2>	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">
1931	<p>This class implements idle watchers, that get called automatically when	1434	<p>This class implements idle watchers, that get called automatically when
1932	the process is idle. They should return as fast as possible, after doing	1435	the process is idle. They should return as fast as possible, after doing
1933	some useful work.</p>	1436	some useful work.</p>
1934	<dl>	1437	<dl>
1935	<dt><strong><a name="item__iw">$iw = new urxvt::iw</a></strong>	1438	<dt>$iw = new urxvt::iw</dt>
1936
1937	<dd>	1439	<dd>
1938	<p>Create a new idle watcher object in stopped state.</p>	1440	<p>Create a new idle watcher object in stopped state.</p>
1939	</dd>	1441	</dd>
1940	</li>
1941	<dt><strong>$iw = $iw->cb (sub { my ($iw) = @_; ... })</strong>	1442	<dt>$iw = $iw->cb (sub { my ($iw) = @_; ... })</dt>
1942
1943	<dd>	1443	<dd>
1944	<p>Set the callback to be called when the watcher triggers.</p>	1444	<p>Set the callback to be called when the watcher triggers.</p>
1945	</dd>	1445	</dd>
1946	</li>
1947	<dt><strong>$timer = $timer->start</strong>	1446	<dt>$timer = $timer->start</dt>
1948
1949	<dd>	1447	<dd>
1950	<p>Start the watcher.</p>	1448	<p>Start the watcher.</p>
1951	</dd>	1449	</dd>
1952	</li>
1953	<dt><strong>$timer = $timer->stop</strong>	1450	<dt>$timer = $timer->stop</dt>
1954
1955	<dd>	1451	<dd>
1956	<p>Stop the watcher.</p>	1452	<p>Stop the watcher.</p>
1957	</dd>	1453	</dd>
1958	</li>
1959	</dl>	1454	</dl>
1960	<p>	1455
1961	</p>	1456	</div>
1962	<h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2>	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">
1963	<p>This class implements process watchers. They create an event whenever a	1459	<p>This class implements process watchers. They create an event whenever a
1964	process exits, after which they stop automatically.</p>	1460	process exits, after which they stop automatically.</p>
1965	<pre>
1966	my $pid = fork;	1461	<pre> my $pid = fork;
1967	...	1462	...
1968	$term->{pw} = urxvt::pw	1463	$term->{pw} = urxvt::pw
1969	->new	1464	->new
1970	->start ($pid)	1465	->start ($pid)
1971	->cb (sub {	1466	->cb (sub {
1972	my ($pw, $exit_status) = @_;	1467	my ($pw, $exit_status) = @_;
1973	...	1468	...
1974	});</pre>	1469	});
		1470
		1471	</pre>
1975	<dl>	1472	<dl>
1976	<dt><strong><a name="item__pw">$pw = new urxvt::pw</a></strong>	1473	<dt>$pw = new urxvt::pw</dt>
1977
1978	<dd>	1474	<dd>
1979	<p>Create a new process watcher in stopped state.</p>	1475	<p>Create a new process watcher in stopped state.</p>
1980	</dd>	1476	</dd>
1981	</li>
1982	<dt><strong>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</strong>	1477	<dt>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</dt>
1983
1984	<dd>	1478	<dd>
1985	<p>Set the callback to be called when the timer triggers.</p>	1479	<p>Set the callback to be called when the timer triggers.</p>
1986	</dd>	1480	</dd>
1987	</li>
1988	<dt><strong>$pw = $timer->start ($pid)</strong>	1481	<dt>$pw = $timer->start ($pid)</dt>
1989
1990	<dd>	1482	<dd>
1991	<p>Tells the watcher to start watching for process <code>$pid</code>.</p>	1483	<p>Tells the watcher to start watching for process <code>$pid</code>.</p>
1992	</dd>	1484	</dd>
1993	</li>
1994	<dt><strong>$pw = $pw->stop</strong>	1485	<dt>$pw = $pw->stop</dt>
1995
1996	<dd>	1486	<dd>
1997	<p>Stop the watcher.</p>	1487	<p>Stop the watcher.</p>
1998	</dd>	1488	</dd>
1999	</li>
2000	</dl>	1489	</dl>
2001	<p>	1490
2002	</p>	1491	</div>
2003	<hr />	1492	<h1 id="ENVIRONMENT">ENVIRONMENT</h1><p><a href="#TOP" class="toplink">Top</a></p>
2004	<h1><a name="environment">ENVIRONMENT</a></h1>	1493	<div id="ENVIRONMENT_CONTENT">
2005	<p>	1494
2006	</p>	1495	</div>
2007	<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>	1496	<h2 id="URXVT_PERL_VERBOSITY">URXVT_PERL_VERBOSITY</h2>
		1497	<div id="URXVT_PERL_VERBOSITY_CONTENT">
2008	<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
2009	numbers indicate more verbose output.</p>	1499	numbers indicate more verbose output.</p>
2010	<dl>	1500	<dl>
2011	<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong>	1501	<dt>== 0 - fatal messages</dt>
2012		1502	<dt>>= 3 - script loading and management</dt>
2013	<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong>	1503	<dt>>=10 - all called hooks</dt>
2014		1504	<dt>>=11 - hook return values</dt>
2015	<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong>
2016
2017	<dt><strong><a name="item__3e_3d11__2d_hook_return_values">>=11 - hook return values</a></strong>
2018
2019	</dl>	1505	</dl>
2020	<p>	1506
2021	</p>	1507	</div>
2022	<hr />	1508	<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
2023	<h1><a name="author">AUTHOR</a></h1>	1509	<div id="AUTHOR_CONTENT">
2024	<pre>
2025	Marc Lehmann <pcg@goof.com>	1510	<pre> Marc Lehmann <pcg@goof.com>
2026	<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
2027		1512
2028	</body>	1513	</pre>
2029		1514
		1515	</div>
		1516	</div></body>
2030	</html>	1517	</html>

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents): Revision 1.47 by root, Thu Nov 2 17:37:47 2006 UTC vs. Revision 1.54 by root, Wed Aug 1 18:38:16 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.47 by root, Thu Nov 2 17:37:47 2006 UTC vs.
Revision 1.54 by root, Wed Aug 1 18:38:16 2007 UTC