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

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.9 by root, Tue Jan 3 21:15:22 2006 UTC vs.
Revision 1.56 by root, Mon Nov 19 12:02:36 2007 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents): Revision 1.9 by root, Tue Jan 3 21:15:22 2006 UTC vs. Revision 1.56 by root, Mon Nov 19 12:02:36 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.9 by root, Tue Jan 3 21:15:22 2006 UTC vs.
Revision 1.56 by root, Mon Nov 19 12:02:36 2007 UTC