ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.144 by root, Mon Aug 7 15:59:44 2006 UTC vs.
Revision 1.226 by root, Sat Sep 22 14:35:55 2012 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Every time a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
39		43
40	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	=over 4	48	Extensions that add command line parameters or resources on their own are
45		49	loaded automatically when used.
46	=item selection (enabled by default)
47
48	(More) intelligent selection. This extension tries to be more intelligent
49	when the user extends selections (double-click and further clicks). Right
50	now, it tries to select words, urls and complete shell-quoted
51	arguments, which is very convenient, too, if your F<ls> supports
52	C<--quoting-style=shell>.
53
54	A double-click usually selects the word under the cursor, further clicks
55	will enlarge the selection.
56
57	The selection works by trying to match a number of regexes and displaying
58	them in increasing order of length. You can add your own regexes by
59	specifying resources of the form:
60
61	URxvt.selection.pattern-0: perl-regex
62	URxvt.selection.pattern-1: perl-regex
63	...
64
65	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the following adds a regex that matches everything
68	between two vertical bars:
69
70	URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72	Another example: Programs I use often output "absolute path: " at the
73	beginning of a line when they process multiple files. The following
74	pattern matches the filename (note, there is a single space at the very
75	end):
76
77	URxvt.selection.pattern-0: ^(/[^:]+):\
78
79	You can look at the source of the selection extension to see more
80	interesting uses, such as parsing a line from beginning to end.
81
82	This extension also offers following bindable keyboard commands:
83
84	=over 4
85
86	=item rot13
87
88	Rot-13 the selection when activated. Used via keyboard trigger:
89
90	URxvt.keysym.C-M-r: perl:selection:rot13
91
92	=back
93
94	=item option-popup (enabled by default)
95
96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97	runtime.
98
99	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.
102
103	It's sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as
107	first argument.
108
109	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:
111
112	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};
115
116	=item selection-popup (enabled by default)
117
118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
119	text into various other formats/action (such as uri unescaping, perl
120	evaluation, web-browser starting etc.), depending on content.
121
122	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.
125
126	It's sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide whether to add something or not.
128	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.
131
132	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:
135
136	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }
138	: ()
139	};
140
141	=item searchable-scrollback<hotkey> (enabled by default)
142
143	Adds regex search functionality to the scrollback buffer, triggered
144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
145	input/output is suspended and a regex is displayed at the bottom of the
146	screen.
147
148	Inputting characters appends them to the regex and continues incremental
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary
154	selection.
155
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.
159
160	See L<perlre> for more info about perl regular expression syntax.
161
162	=item readline (enabled by default)
163
164	A support package that tries to make editing with readline easier. At
165	the moment, it reacts to clicking shift-left mouse button by trying to
166	move the text cursor to this position. It does so by generating as many
167	cursor-left or cursor-right keypresses as required (the this only works
168	for programs that correctly support wide characters).
169
170	To avoid too many false positives, this is only done when:
171
172	=over 4
173
174	=item - the tty is in ICANON state.
175
176	=item - the text cursor is visible.
177
178	=item - the primary screen is currently being displayed.
179
180	=item - the mouse is on the same (multi-row-) line as the text cursor.
181
182	=back
183
184	The normal selection mechanism isn't disabled, so quick successive clicks
185	might interfere with selection creation in harmless ways.
186
187	=item selection-autotransform
188
189	This selection allows you to do automatic transforms on a selection
190	whenever a selection is made.
191
192	It works by specifying perl snippets (most useful is a single C<s///>
193	operator) that modify C<$_> as resources:
194
195	URxvt.selection-autotransform.0: transform
196	URxvt.selection-autotransform.1: transform
197	...
198
199	For example, the following will transform selections of the form
200	C<filename:number>, often seen in compiler messages, into C<vi +$filename
201	$word>:
202
203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
204
205	And this example matches the same,but replaces it with vi-commands you can
206	paste directly into your (vi :) editor:
207
208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
209
210	Of course, this can be modified to suit your needs and your editor :)
211
212	To expand the example above to typical perl error messages ("XXX at
213	FILENAME line YYY."), you need a slightly more elaborate solution:
214
215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
217
218	The first line tells the selection code to treat the unchanging part of
219	every error message as a selection pattern, and the second line transforms
220	the message into vi commands to load the file.
221
222	=item tabbed
223
224	This transforms the terminal into a tabbar with additional terminals, that
225	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
227	button per tab.
228
229	Clicking a button will activate that tab. Pressing B<Shift-Left> and
230	B<Shift-Right> will switch to the tab left or right of the current one,
231	while B<Shift-Down> creates a new tab.
232
233	The tabbar itself can be configured similarly to a normal terminal, but
234	with a resource class of C<URxvt.tabbed>. In addition, it supports the
235	following four resources (shown with defaults):
236
237	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
238	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
239	URxvt.tabbed.tab-fg: <colour-index, default 0>
240	URxvt.tabbed.tab-bg: <colour-index, default 1>
241
242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243	indices.
244
245	=item mark-urls
246
247	Uses per-line display filtering (C<on_line_update>) to underline urls and
248	make them clickable. When middle-clicked, the program specified in the
249	resource C<urlLauncher> (default C<x-www-browser>) will be started with
250	the URL as first argument.
251
252	=item xim-onthespot
253
254	This (experimental) perl extension implements OnTheSpot editing. It does
255	not work perfectly, and some input methods don't seem to work well with
256	OnTheSpot editing in general, but it seems to work at leats for SCIM and
257	kinput2.
258
259	You enable it by specifying this extension and a preedit style of
260	C<OnTheSpot>, i.e.:
261
262	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
263
264	=item kuake<hotkey>
265
266	A very primitive quake-console-like extension. It was inspired by a
267	description of how the programs C<kuake> and C<yakuake> work: Whenever the
268	user presses a global accelerator key (by default C<F10>), the terminal
269	will show or hide itself. Another press of the accelerator key will hide
270	or show it again.
271
272	Initially, the window will not be shown when using this extension.
273
274	This is useful if you need a single terminal thats not using any desktop
275	space most of the time but is quickly available at the press of a key.
276
277	The accelerator key is grabbed regardless of any modifiers, so this
278	extension will actually grab a physical key just for this function.
279
280	If you want a quake-like animation, tell your window manager to do so
281	(fvwm can do it).
282
283	=item automove-background
284
285	This is basically a very small extension that dynamically changes the
286	background pixmap offset to the window position, in effect creating the
287	same effect as pseudo transparency with a custom pixmap. No scaling is
288	supported in this mode. Example:
289
290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291
292	=item block-graphics-to-ascii
293
294	A not very useful example of filtering all text output to the terminal
295	by replacing all line-drawing characters (U+2500 .. U+259F) by a
296	similar-looking ascii character.
297
298	=item digital-clock
299
300	Displays a digital clock using the built-in overlay.
301
302	=item remote-clipboard
303
304	Somewhat of a misnomer, this extension adds two menu entries to the
305	selection popup that allows one ti run external commands to store the
306	selection somewhere and fetch it again.
307
308	We use it to implement a "distributed selection mechanism", which just
309	means that one command uploads the file to a remote server, and another
310	reads it.
311
312	The commands can be set using the C<URxvt.remote-selection.store> and
313	C<URxvt.remote-selection.fetch> resources. The first should read the
314	selection to store from STDIN (always in UTF-8), the second should provide
315	the selection data on STDOUT (also in UTF-8).
316
317	The defaults (which are likely useless to you) use rsh and cat:
318
319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
321
322	=item selection-pastebin
323
324	This is a little rarely useful extension that Uploads the selection as
325	textfile to a remote site (or does other things). (The implementation is
326	not currently secure for use in a multiuser environment as it writes to
327	F</tmp> directly.).
328
329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
330	i.e.
331
332	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
333
334	Pressing this combination runs a command with C<%> replaced by the name of
335	the textfile. This command can be set via a resource:
336
337	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
338
339	And the default is likely not useful to anybody but the few people around
340	here :)
341
342	The name of the textfile is the hex encoded md5 sum of the selection, so
343	the same content should lead to the same filename.
344
345	After a successful upload the selection will be replaced by the text given
346	in the C<selection-pastebin-url> resource (again, the % is the placeholder
347	for the filename):
348
349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
350
351	=item example-refresh-hooks
352
353	Displays a very simple digital clock in the upper right corner of the
354	window. Illustrates overwriting the refresh callbacks to create your own
355	overlays or changes.
356
357	=back
358		50
359	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
360		52
361	=head2 General API Considerations	53	=head2 General API Considerations
362		54
…		…
376		68
377	=over 4	69	=over 4
378		70
379	=item $text	71	=item $text
380		72
381	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
382	always represents one screen cell. See L<ROW_t> for a discussion of this format.	74	always represents one screen cell. See L<ROW_t> for a discussion of this format.
383		75
384	=item $string	76	=item $string
385		77
386	A perl text string, with an emphasis on I<text>. It can store all unicode	78	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
390	=item $octets	82	=item $octets
391		83
392	Either binary data or - more common - a text string encoded in a	84	Either binary data or - more common - a text string encoded in a
393	locale-specific way.	85	locale-specific way.
394		86
		87	=item $keysym
		88
		89	an integer that is a valid X11 keysym code. You can convert a string
		90	into a keysym and viceversa by using C<XStringToKeysym> and
		91	C<XKeysymToString>.
		92
395	=back	93	=back
396		94
397	=head2 Extension Objects	95	=head2 Extension Objects
398		96
399	Every perl extension is a perl class. A separate perl object is created	97	Every perl extension is a perl class. A separate perl object is created
400	for each terminal and each extension and passed as the first parameter to	98	for each terminal, and each terminal has its own set of extension objects,
401	hooks. So extensions can use their C<$self> object without having to think	99	which are passed as the first parameter to hooks. So extensions can use
402	about other extensions, with the exception of methods and members that	100	their C<$self> object without having to think about clashes with other
		101	extensions or other terminals, with the exception of methods and members
403	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
404	use.	103	internal use.
405		104
406	Although it isn't a C<urxvt::term> object, you can call all methods of the	105	Although it isn't a C<urxvt::term> object, you can call all methods of the
407	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
408		107
409	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
410		109	the C<urxvt::extension> section below.
411	=over 4
412
413	=item $urxvt_term = $self->{term}
414
415	Returns the C<urxvt::term> object associated with this instance of the
416	extension. This member I<must not> be changed in any way.
417
418	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
419
420	Dynamically enable the given hooks (named without the C<on_> prefix) for
421	this extension, replacing any previous hook. This is useful when you want
422	to overwrite time-critical hooks only temporarily.
423
424	=item $self->disable ($hook_name[, $hook_name..])
425
426	Dynamically disable the given hooks.
427
428	=back
429		110
430	=head2 Hooks	111	=head2 Hooks
431		112
432	The following subroutines can be declared in extension files, and will be	113	The following subroutines can be declared in extension files, and will be
433	called whenever the relevant event happens.	114	called whenever the relevant event happens.
…		…
519		200
520	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
521	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
522	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
523		204
524	=item on_osc_seq $term, $op, $args	205	=item on_osc_seq $term, $op, $args, $resp
525		206
526	Called on every OSC sequence and can be used to suppress it or modify its	207	Called on every OSC sequence and can be used to suppress it or modify its
527	behaviour. The default should be to return an empty list. A true value	208	behaviour. The default should be to return an empty list. A true value
528	suppresses execution of the request completely. Make sure you don't get	209	suppresses execution of the request completely. Make sure you don't get
529	confused by recursive invocations when you output an osc sequence within	210	confused by recursive invocations when you output an OSC sequence within
530	this callback.	211	this callback.
531		212
532	C<on_osc_seq_perl> should be used for new behaviour.	213	C<on_osc_seq_perl> should be used for new behaviour.
533		214
534	=item on_osc_seq_perl $term, $string	215	=item on_osc_seq_perl $term, $args, $resp
535		216
536	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
537	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
538	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
539	string should start with the extension name and a colon, to distinguish	220	string should start with the extension name (sans -osc) and a semicolon,
540	it from commands for other extensions, and this might be enforced in the	221	to distinguish it from commands for other extensions, and this might be
541	future.	222	enforced in the future.
		223
		224	For example, C<overlay-osc> uses this:
		225
		226	sub on_osc_seq_perl {
		227	my ($self, $osc, $resp) = @_;
		228
		229	return unless $osc =~ s/^overlay;//;
		230
		231	... process remaining $osc string
		232	}
542		233
543	Be careful not ever to trust (in a security sense) the data you receive,	234	Be careful not ever to trust (in a security sense) the data you receive,
544	as its source can not easily be controlled (e-mail content, messages from	235	as its source can not easily be controlled (e-mail content, messages from
545	other users on the same system etc.).	236	other users on the same system etc.).
		237
		238	For responses, C<$resp> contains the end-of-args separator used by the
		239	sender.
546		240
547	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
548		242
549	Called whenever text is about to be output, with the text as argument. You	243	Called whenever text is about to be output, with the text as argument. You
550	can filter/change and output the text yourself by returning a true value	244	can filter/change and output the text yourself by returning a true value
…		…
555	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
556		250
557	Called whenever some data is written to the tty/pty and can be used to	251	Called whenever some data is written to the tty/pty and can be used to
558	suppress or filter tty input.	252	suppress or filter tty input.
559		253
		254	=item on_tt_paste $term, $octets
		255
		256	Called whenever text is about to be pasted, with the text as argument. You
		257	can filter/change and paste the text yourself by returning a true value
		258	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		259	locale-encoded.
		260
560	=item on_line_update $term, $row	261	=item on_line_update $term, $row
561		262
562	Called whenever a line was updated or changed. Can be used to filter	263	Called whenever a line was updated or changed. Can be used to filter
563	screen output (e.g. underline urls or other useless stuff). Only lines	264	screen output (e.g. underline urls or other useless stuff). Only lines
564	that are being shown will be filtered, and, due to performance reasons,	265	that are being shown will be filtered, and, due to performance reasons,
…		…
571	later with the already-modified line (e.g. if unrelated parts change), so	272	later with the already-modified line (e.g. if unrelated parts change), so
572	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
573		274
574	=item on_refresh_begin $term	275	=item on_refresh_begin $term
575		276
576	Called just before the screen gets redrawn. Can be used for overlay	277	Called just before the screen gets redrawn. Can be used for overlay or
577	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
578	restoring them in refresh_end. The built-in overlay and selection display	279	restoring them in refresh_end. The built-in overlay and selection display
579	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
580		281
581	=item on_refresh_end $term	282	=item on_refresh_end $term
582		283
…		…
584		285
585	=item on_user_command $term, $string	286	=item on_user_command $term, $string
586		287
587	Called whenever a user-configured event is being activated (e.g. via	288	Called whenever a user-configured event is being activated (e.g. via
588	a C<perl:string> action bound to a key, see description of the B<keysym>	289	a C<perl:string> action bound to a key, see description of the B<keysym>
589	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
590		291
591	The event is simply the action string. This interface is assumed to change	292	The event is simply the action string. This interface is assumed to change
592	slightly in the future.	293	slightly in the future.
593		294
		295	=item on_register_command $term, $keysym, $modifiermask, $string
		296
		297	Called after parsing a keysym resource but before registering the
		298	associated binding. If this hook returns TRUE the binding is not
		299	registered. It can be used to modify a binding by calling
		300	C<register_command>.
		301
594	=item on_resize_all_windows $tern, $new_width, $new_height	302	=item on_resize_all_windows $term, $new_width, $new_height
595		303
596	Called just after the new window size has been calculated, but before	304	Called just after the new window size has been calculated, but before
597	windows are actually being resized or hints are being set. If this hook	305	windows are actually being resized or hints are being set. If this hook
598	returns TRUE, setting of the window hints is being skipped.	306	returns TRUE, setting of the window hints is being skipped.
599		307
…		…
633		341
634	=item on_map_notify $term, $event	342	=item on_map_notify $term, $event
635		343
636	=item on_unmap_notify $term, $event	344	=item on_unmap_notify $term, $event
637		345
638	Called whenever the corresponding X event is received for the terminal If	346	Called whenever the corresponding X event is received for the terminal. If
639	the hook returns true, then the even will be ignored by rxvt-unicode.	347	the hook returns true, then the event will be ignored by rxvt-unicode.
640		348
641	The event is a hash with most values as named by Xlib (see the XEvent	349	The event is a hash with most values as named by Xlib (see the XEvent
642	manpage), with the additional members C<row> and C<col>, which are the	350	manpage), with the additional members C<row> and C<col>, which are the
643	(real, not screen-based) row and column under the mouse cursor.	351	(real, not screen-based) row and column under the mouse cursor.
644		352
…		…
654	=item on_wm_delete_window $term, $event	362	=item on_wm_delete_window $term, $event
655		363
656	Called when various types of ClientMessage events are received (all with	364	Called when various types of ClientMessage events are received (all with
657	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	365	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
658		366
		367	=item on_bell $term
		368
		369	Called on receipt of a bell character.
		370
659	=back	371	=back
660		372
661	=cut	373	=cut
662		374
663	package urxvt;	375	package urxvt;
664		376
665	use utf8;	377	use utf8;
666	use strict;	378	use strict 'vars';
667	use Carp ();	379	use Carp ();
668	use Scalar::Util ();	380	use Scalar::Util ();
669	use List::Util ();	381	use List::Util ();
670		382
671	our $VERSION = 1;	383	our $VERSION = 1;
672	our $TERM;	384	our $TERM;
673	our @TERM_INIT;	385	our @TERM_INIT; # should go, prevents async I/O etc.
674	our @TERM_EXT;	386	our @TERM_EXT; # should go, prevents async I/O etc.
675	our @HOOKNAME;	387	our @HOOKNAME;
676	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	388	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
677	our %OPTION;	389	our %OPTION;
678		390
679	our $LIBDIR;	391	our $LIBDIR;
…		…
727		439
728	=over 4	440	=over 4
729		441
730	=item urxvt::fatal $errormessage	442	=item urxvt::fatal $errormessage
731		443
732	Fatally aborts execution with the given error message. Avoid at all	444	Fatally aborts execution with the given error message (which should
733	costs! The only time this is acceptable is when the terminal process	445	include a trailing newline). Avoid at all costs! The only time this
734	starts up.	446	is acceptable (and useful) is in the init hook, where it prevents the
		447	terminal from starting up.
735		448
736	=item urxvt::warn $string	449	=item urxvt::warn $string
737		450
738	Calls C<rxvt_warn> with the given string which should not include a	451	Calls C<rxvt_warn> with the given string which should include a trailing
739	newline. The module also overwrites the C<warn> builtin with a function	452	newline. The module also overwrites the C<warn> builtin with a function
740	that calls this function.	453	that calls this function.
741		454
742	Using this function has the advantage that its output ends up in the	455	Using this function has the advantage that its output ends up in the
743	correct place, e.g. on stderr of the connecting urxvtc client.	456	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
747	=item @terms = urxvt::termlist	460	=item @terms = urxvt::termlist
748		461
749	Returns all urxvt::term objects that exist in this process, regardless of	462	Returns all urxvt::term objects that exist in this process, regardless of
750	whether they are started, being destroyed etc., so be careful. Only term	463	whether they are started, being destroyed etc., so be careful. Only term
751	objects that have perl extensions attached will be returned (because there	464	objects that have perl extensions attached will be returned (because there
752	is no urxvt::term objet associated with others).	465	is no urxvt::term object associated with others).
753		466
754	=item $time = urxvt::NOW	467	=item $time = urxvt::NOW
755		468
756	Returns the "current time" (as per the event loop).	469	Returns the "current time" (as per the event loop).
757		470
…		…
800		513
801	=item $rend = urxvt::OVERLAY_RSTYLE	514	=item $rend = urxvt::OVERLAY_RSTYLE
802		515
803	Return the rendition mask used for overlays by default.	516	Return the rendition mask used for overlays by default.
804		517
805	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	518	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		519	urxvt::RS_RVid, urxvt::RS_Uline
806		520
807	Return the bit that enabled bold, italic, blink, reverse-video and	521	Return the bit that enabled bold, italic, blink, reverse-video and
808	underline, respectively. To enable such a style, just logically OR it into	522	underline, respectively. To enable such a style, just logically OR it into
809	the bitset.	523	the bitset.
810		524
…		…
847	};	561	};
848	}	562	}
849		563
850	no warnings 'utf8';	564	no warnings 'utf8';
851		565
		566	sub parse_resource {
		567	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		568
		569	$name =~ y/-/./ if $isarg;
		570
		571	$term->scan_meta;
		572
		573	my $r = $term->{meta}{resource};
		574	keys %$r; # reste iterator
		575	while (my ($pattern, $v) = each %$r) {
		576	if (
		577	$pattern =~ /\.$/
		578	? $pattern eq substr $name, 0, length $pattern
		579	: $pattern eq $name
		580	) {
		581	$name = "$urxvt::RESCLASS.$name";
		582
		583	push @{ $term->{perl_ext_3} }, $v->[0];
		584
		585	if ($v->[1] eq "boolean") {
		586	$term->put_option_db ($name, $flag ? "true" : "false");
		587	return 1;
		588	} else {
		589	$term->put_option_db ($name, $value);
		590	return 1 + 2;
		591	}
		592	}
		593	}
		594
		595	0
		596	}
		597
		598	sub usage {
		599	my ($term, $usage_type) = @_;
		600
		601	$term->scan_meta;
		602
		603	my $r = $term->{meta}{resource};
		604
		605	for my $pattern (sort keys %$r) {
		606	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		607
		608	$desc .= " (-pe $ext)";
		609
		610	if ($usage_type == 1) {
		611	$pattern =~ y/./-/;
		612	$pattern =~ s/-$/-.../g;
		613
		614	if ($type eq "boolean") {
		615	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		616	} else {
		617	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		618	}
		619	} else {
		620	$pattern =~ s/\.$/.*/g;
		621	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		622	}
		623	}
		624	}
		625
852	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
853		627
854	sub verbose {	628	sub verbose {
855	my ($level, $msg) = @_;	629	my ($level, $msg) = @_;
856	warn "$msg\n" if $level <= $verbosity;	630	warn "$msg\n" if $level <= $verbosity;
…		…
868	$pkg =~ s/[^[:word:]]/_/g;	642	$pkg =~ s/[^[:word:]]/_/g;
869	$pkg = "urxvt::ext::$pkg";	643	$pkg = "urxvt::ext::$pkg";
870		644
871	verbose 3, "loading extension '$path' into package '$pkg'";	645	verbose 3, "loading extension '$path' into package '$pkg'";
872		646
		647	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		648
873	open my $fh, "<:raw", $path	649	open my $fh, "<:raw", $path
874	or die "$path: $!";	650	or die "$path: $!";
875		651
876	my $source =	652	my $source =
877	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	653	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
878	. "#line 1 \"$path\"\n{\n"	654	. "#line 1 \"$path\"\n{\n"
879	. (do { local $/; <$fh> })	655	. (do { local $/; <$fh> })
880	. "\n};\n1";	656	. "\n};\n1";
881		657
882	eval $source	658	eval $source
…		…
892	sub invoke {	668	sub invoke {
893	local $TERM = shift;	669	local $TERM = shift;
894	my $htype = shift;	670	my $htype = shift;
895		671
896	if ($htype == 0) { # INIT	672	if ($htype == 0) { # INIT
897	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	673	my @dirs = $TERM->perl_libdirs;
898		674
899	my %ext_arg;	675	my %ext_arg;
900		676
901	{	677	{
902	my @init = @TERM_INIT;	678	my @init = @TERM_INIT;
903	@TERM_INIT = ();	679	@TERM_INIT = ();
…		…
905	my @pkg = @TERM_EXT;	681	my @pkg = @TERM_EXT;
906	@TERM_EXT = ();	682	@TERM_EXT = ();
907	$TERM->register_package ($_) for @pkg;	683	$TERM->register_package ($_) for @pkg;
908	}	684	}
909		685
		686	for (
		687	@{ delete $TERM->{perl_ext_3} },
910	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		689	) {
911	if ($_ eq "default") {	690	if ($_ eq "default") {
912	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	691	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
913	} elsif (/^-(.*)$/) {	692	} elsif (/^-(.*)$/) {
914	delete $ext_arg{$1};	693	delete $ext_arg{$1};
915	} elsif (/^([^<]+)<(.*)>$/) {	694	} elsif (/^([^<]+)<(.*)>$/) {
…		…
938	if (my $cb = $TERM->{_hook}[$htype]) {	717	if (my $cb = $TERM->{_hook}[$htype]) {
939	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
940	if $verbosity >= 10;	719	if $verbosity >= 10;
941		720
942	for my $pkg (keys %$cb) {	721	for my $pkg (keys %$cb) {
943	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
944	$retval ||= $retval_;	723	$retval ||= $retval_;
945		724
946	if ($@) {	725	if ($@) {
947	$TERM->ungrab; # better to lose the grab than the session	726	$TERM->ungrab; # better to lose the grab than the session
948	warn $@;	727	warn $@;
…		…
966		745
967	sub SET_COLOR($$$) {	746	sub SET_COLOR($$$) {
968	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	747	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
969	}	748	}
970		749
971	# urxvt::term::extension	750	sub rend2mask {
		751	no strict 'refs';
		752	my ($str, $mask) = (@_, 0);
		753	my %color = ( fg => undef, bg => undef );
		754	my @failed;
		755	for my $spec ( split /\s+/, $str ) {
		756	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		757	$color{lc($1)} = $2;
		758	} else {
		759	my $neg = $spec =~ s/^[-^]//;
		760	unless ( exists &{"RS_$spec"} ) {
		761	push @failed, $spec;
		762	next;
		763	}
		764	my $cur = &{"RS_$spec"};
		765	if ( $neg ) {
		766	$mask &= ~$cur;
		767	} else {
		768	$mask |= $cur;
		769	}
		770	}
		771	}
		772	($mask, @color{qw(fg bg)}, \@failed)
		773	}
972		774
973	package urxvt::term::extension;	775	package urxvt::term::extension;
974		776
975	sub enable {	777	=head2 The C<urxvt::term::extension> class
976	my ($self, %hook) = @_;
977	my $pkg = $self->{_pkg};
978		778
979	while (my ($name, $cb) = each %hook) {	779	Each extension attached to a terminal object is represented by
980	my $htype = $HOOKTYPE{uc $name};	780	a C<urxvt::term::extension> object.
981	defined $htype
982	or Carp::croak "unsupported hook type '$name'";
983		781
984	$self->set_should_invoke ($htype, +1)	782	You can use these objects, which are passed to all callbacks to store any
985	unless exists $self->{term}{_hook}[$htype]{$pkg};	783	state related to the terminal and extension instance.
986		784
987	$self->{term}{_hook}[$htype]{$pkg} = $cb;	785	The methods (And data members) documented below can be called on extension
988	}	786	objects, in addition to call methods documented for the <urxvt::term>
989	}	787	class.
990		788
991	sub disable {	789	=over 4
992	my ($self, @hook) = @_;
993	my $pkg = $self->{_pkg};
994		790
995	for my $name (@hook) {	791	=item $urxvt_term = $self->{term}
996	my $htype = $HOOKTYPE{uc $name};
997	defined $htype
998	or Carp::croak "unsupported hook type '$name'";
999		792
1000	$self->set_should_invoke ($htype, -1)	793	Returns the C<urxvt::term> object associated with this instance of the
1001	if delete $self->{term}{_hook}[$htype]{$pkg};	794	extension. This member I<must not> be changed in any way.
1002	}	795
1003	}	796	=cut
1004		797
1005	our $AUTOLOAD;	798	our $AUTOLOAD;
1006		799
1007	sub AUTOLOAD {	800	sub AUTOLOAD {
1008	$AUTOLOAD =~ /:([^:]+)$/	801	$AUTOLOAD =~ /:([^:]+)$/
…		…
1021		814
1022	sub DESTROY {	815	sub DESTROY {
1023	# nop	816	# nop
1024	}	817	}
1025		818
1026	# urxvt::destroy_hook	819	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1027		820
1028	sub urxvt::destroy_hook::DESTROY {	821	sub urxvt::destroy_hook::DESTROY {
1029	${$_[0]}->();	822	${$_[0]}->();
1030	}	823	}
1031		824
1032	sub urxvt::destroy_hook(&) {	825	sub urxvt::destroy_hook(&) {
1033	bless \shift, urxvt::destroy_hook::	826	bless \shift, urxvt::destroy_hook::
1034	}	827	}
		828
		829	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		830
		831	Dynamically enable the given hooks (named without the C<on_> prefix) for
		832	this extension, replacing any previous hook. This is useful when you want
		833	to overwrite time-critical hooks only temporarily.
		834
		835	To install additional callbacks for the same hook, you can use the C<on>
		836	method of the C<urxvt::term> class.
		837
		838	=item $self->disable ($hook_name[, $hook_name..])
		839
		840	Dynamically disable the given hooks.
		841
		842	=cut
		843
		844	sub enable {
		845	my ($self, %hook) = @_;
		846	my $pkg = $self->{_pkg};
		847
		848	while (my ($name, $cb) = each %hook) {
		849	my $htype = $HOOKTYPE{uc $name};
		850	defined $htype
		851	or Carp::croak "unsupported hook type '$name'";
		852
		853	$self->set_should_invoke ($htype, +1)
		854	unless exists $self->{term}{_hook}[$htype]{$pkg};
		855
		856	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		857	}
		858	}
		859
		860	sub disable {
		861	my ($self, @hook) = @_;
		862	my $pkg = $self->{_pkg};
		863
		864	for my $name (@hook) {
		865	my $htype = $HOOKTYPE{uc $name};
		866	defined $htype
		867	or Carp::croak "unsupported hook type '$name'";
		868
		869	$self->set_should_invoke ($htype, -1)
		870	if delete $self->{term}{_hook}[$htype]{$pkg};
		871	}
		872	}
		873
		874	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		875
		876	Similar to the C<enable> enable, but installs additional callbacks for
		877	the given hook(s) (that is, it doesn't replace existing callbacks), and
		878	returns a guard object. When the guard object is destroyed the callbacks
		879	are disabled again.
		880
		881	=cut
		882
		883	sub urxvt::extension::on_disable::DESTROY {
		884	my $disable = shift;
		885
		886	my $term = delete $disable->{""};
		887
		888	while (my ($htype, $id) = each %$disable) {
		889	delete $term->{_hook}[$htype]{$id};
		890	$term->set_should_invoke ($htype, -1);
		891	}
		892	}
		893
		894	sub on {
		895	my ($self, %hook) = @_;
		896
		897	my $term = $self->{term};
		898
		899	my %disable = ( "" => $term );
		900
		901	while (my ($name, $cb) = each %hook) {
		902	my $htype = $HOOKTYPE{uc $name};
		903	defined $htype
		904	or Carp::croak "unsupported hook type '$name'";
		905
		906	$term->set_should_invoke ($htype, +1);
		907	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		908	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		909	}
		910
		911	bless \%disable, "urxvt::extension::on_disable"
		912	}
		913
		914	=item $self->x_resource ($pattern)
		915
		916	=item $self->x_resource_boolean ($pattern)
		917
		918	These methods support an additional C<%> prefix when called on an
		919	extension object - see the description of these methods in the
		920	C<urxvt::term> class for details.
		921
		922	=cut
		923
		924	sub x_resource {
		925	my ($self, $name) = @_;
		926	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		927	$self->{term}->x_resource ($name)
		928	}
		929
		930	sub x_resource_boolean {
		931	my ($self, $name) = @_;
		932	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		933	$self->{term}->x_resource_boolean ($name)
		934	}
		935
		936	=back
		937
		938	=cut
1035		939
1036	package urxvt::anyevent;	940	package urxvt::anyevent;
1037		941
1038	=head2 The C<urxvt::anyevent> Class	942	=head2 The C<urxvt::anyevent> Class
1039		943
1040	The sole purpose of this class is to deliver an interface to the	944	The sole purpose of this class is to deliver an interface to the
1041	C<AnyEvent> module - any module using it will work inside urxvt without	945	C<AnyEvent> module - any module using it will work inside urxvt without
1042	further programming. The only exception is that you cannot wait on	946	further programming. The only exception is that you cannot wait on
1043	condition variables, but non-blocking condvar use is ok. What this means	947	condition variables, but non-blocking condvar use is ok.
1044	is that you cannot use blocking APIs, but the non-blocking variant should
1045	work.
1046		948
1047	=cut	949	In practical terms this means is that you cannot use blocking APIs, but
		950	the non-blocking variant should work.
1048		951
		952	=cut
		953
1049	our $VERSION = 1;	954	our $VERSION = '5.23';
1050		955
1051	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	956	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1052	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	957	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1053		958
1054	sub timer {	959	sub timer {
…		…
1056		961
1057	my $cb = $arg{cb};	962	my $cb = $arg{cb};
1058		963
1059	urxvt::timer	964	urxvt::timer
1060	->new	965	->new
1061	->start (urxvt::NOW + $arg{after})	966	->after ($arg{after}, $arg{interval})
1062	->cb (sub {	967	->cb ($arg{interval} ? $cb : sub {
1063	$_[0]->stop; # need to cancel manually	968	$_[0]->stop; # need to cancel manually
1064	$cb->();	969	$cb->();
1065	})	970	})
1066	}	971	}
1067		972
1068	sub io {	973	sub io {
1069	my ($class, %arg) = @_;	974	my ($class, %arg) = @_;
1070		975
1071	my $cb = $arg{cb};	976	my $cb = $arg{cb};
		977	my $fd = fileno $arg{fh};
		978	defined $fd or $fd = $arg{fh};
1072		979
1073	bless [$arg{fh}, urxvt::iow	980	bless [$arg{fh}, urxvt::iow
1074	->new	981	->new
1075	->fd (fileno $arg{fh})	982	->fd ($fd)
1076	->events (($arg{poll} =~ /r/ ? 1 : 0)	983	->events (($arg{poll} =~ /r/ ? 1 : 0)
1077	| ($arg{poll} =~ /w/ ? 2 : 0))	984	| ($arg{poll} =~ /w/ ? 2 : 0))
1078	->start	985	->start
1079	->cb (sub {	986	->cb ($cb)
1080	$cb->(($_[1] & 1 ? 'r' : '')
1081	. ($_[1] & 2 ? 'w' : ''));
1082	})],
1083	urxvt::anyevent::	987	], urxvt::anyevent::
		988	}
		989
		990	sub idle {
		991	my ($class, %arg) = @_;
		992
		993	my $cb = $arg{cb};
		994
		995	urxvt::iw
		996	->new
		997	->start
		998	->cb ($cb)
		999	}
		1000
		1001	sub child {
		1002	my ($class, %arg) = @_;
		1003
		1004	my $cb = $arg{cb};
		1005
		1006	urxvt::pw
		1007	->new
		1008	->start ($arg{pid})
		1009	->cb (sub {
		1010	$_[0]->stop; # need to cancel manually
		1011	$cb->($_[0]->rpid, $_[0]->rstatus);
		1012	})
1084	}	1013	}
1085		1014
1086	sub DESTROY {	1015	sub DESTROY {
1087	$_[0][1]->stop;	1016	$_[0][1]->stop;
1088	}	1017	}
1089		1018
1090	sub condvar {	1019	# only needed for AnyEvent < 6 compatibility
1091	bless \my $flag, urxvt::anyevent::condvar::	1020	sub one_event {
1092	}
1093
1094	sub urxvt::anyevent::condvar::broadcast {
1095	${$_[0]}++;
1096	}
1097
1098	sub urxvt::anyevent::condvar::wait {
1099	unless (${$_[0]}) {
1100	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1021	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1101	}
1102	}	1022	}
1103		1023
1104	package urxvt::term;	1024	package urxvt::term;
1105		1025
1106	=head2 The C<urxvt::term> Class	1026	=head2 The C<urxvt::term> Class
…		…
1119	urxvt::verbose 6, "register package $pkg to $self";	1039	urxvt::verbose 6, "register package $pkg to $self";
1120		1040
1121	@{"$pkg\::ISA"} = urxvt::term::extension::;	1041	@{"$pkg\::ISA"} = urxvt::term::extension::;
1122		1042
1123	my $proxy = bless {	1043	my $proxy = bless {
1124	_pkg => $pkg,	1044	_pkg => $pkg,
		1045	_name => ${"$pkg\::_NAME"}, # hackish
1125	argv => $argv,	1046	argv => $argv,
1126	}, $pkg;	1047	}, $pkg;
1127	Scalar::Util::weaken ($proxy->{term} = $self);	1048	Scalar::Util::weaken ($proxy->{term} = $self);
1128		1049
1129	$self->{_pkg}{$pkg} = $proxy;	1050	$self->{_pkg}{$pkg} = $proxy;
1130		1051
…		…
1133	$proxy->enable ($name => $ref);	1054	$proxy->enable ($name => $ref);
1134	}	1055	}
1135	}	1056	}
1136	}	1057	}
1137		1058
		1059	sub perl_libdirs {
		1060	map { split /:/ }
		1061	$_[0]->resource ("perl_lib"),
		1062	$ENV{URXVT_PERL_LIB},
		1063	"$ENV{HOME}/.urxvt/ext",
		1064	"$LIBDIR/perl"
		1065	}
		1066
		1067	sub scan_meta {
		1068	my ($self) = @_;
		1069	my @libdirs = perl_libdirs $self;
		1070
		1071	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1072
		1073	my %meta;
		1074
		1075	$self->{meta_libdirs} = join "\x00", @libdirs;
		1076	$self->{meta} = \%meta;
		1077
		1078	for my $dir (reverse @libdirs) {
		1079	opendir my $fh, $dir
		1080	or next;
		1081	for my $ext (readdir $fh) {
		1082	$ext !~ /^\./
		1083	and open my $fh, "<", "$dir/$ext"
		1084	or next;
		1085
		1086	while (<$fh>) {
		1087	if (/^#:META:X_RESOURCE:(.*)/) {
		1088	my ($pattern, $type, $desc) = split /:/, $1;
		1089	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1090	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1091	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1092	} else {
		1093	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1094	}
		1095	} elsif (/^\s*(?:#|$)/) {
		1096	# skip other comments and empty lines
		1097	} else {
		1098	last; # stop parsing on first non-empty non-comment line
		1099	}
		1100	}
		1101	}
		1102	}
		1103	}
		1104
1138	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1105	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1139		1106
1140	Creates a new terminal, very similar as if you had started it with system	1107	Creates a new terminal, very similar as if you had started it with system
1141	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1108	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1142	hash which defines the environment of the new terminal.	1109	hash which defines the environment of the new terminal.
…		…
1159	}	1126	}
1160		1127
1161	=item $term->destroy	1128	=item $term->destroy
1162		1129
1163	Destroy the terminal object (close the window, free resources	1130	Destroy the terminal object (close the window, free resources
1164	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1131	etc.). Please note that urxvt will not exit as long as any event
1165	watchers (timers, io watchers) are still active.	1132	watchers (timers, io watchers) are still active.
1166		1133
1167	=item $term->exec_async ($cmd[, @args])	1134	=item $term->exec_async ($cmd[, @args])
1168		1135
1169	Works like the combination of the C<fork>/C<exec> builtins, which executes	1136	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1196	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1163	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1197		1164
1198	Here is a likely non-exhaustive list of option names, please see the	1165	Here is a likely non-exhaustive list of option names, please see the
1199	source file F</src/optinc.h> to see the actual list:	1166	source file F</src/optinc.h> to see the actual list:
1200		1167
1201	borderLess console cursorBlink cursorUnderline hold iconic insecure	1168	borderLess buffered console cursorBlink cursorUnderline hold iconic
1202	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1169	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1203	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1170	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1204	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1171	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1205	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1172	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1206	transparent tripleclickwords utmpInhibit visualBell	1173	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1174	urgentOnBell utmpInhibit visualBell
1207		1175
1208	=item $value = $term->resource ($name[, $newval])	1176	=item $value = $term->resource ($name[, $newval])
1209		1177
1210	Returns the current resource value associated with a given name and	1178	Returns the current resource value associated with a given name and
1211	optionally sets a new value. Setting values is most useful in the C<init>	1179	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1224		1192
1225	Here is a likely non-exhaustive list of resource names, not all of which	1193	Here is a likely non-exhaustive list of resource names, not all of which
1226	are supported in every build, please see the source file F</src/rsinc.h>	1194	are supported in every build, please see the source file F</src/rsinc.h>
1227	to see the actual list:	1195	to see the actual list:
1228		1196
1229	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1197	answerbackstring backgroundPixmap backspace_key blurradius
1230	borderLess color cursorBlink cursorUnderline cutchars delete_key	1198	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1231	display_name embed ext_bwidth fade font geometry hold iconName	1199	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1232	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1200	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1201	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1233	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1202	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1234	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1203	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1235	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1204	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1236	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1205	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1237	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1206	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1238	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1207	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1239	secondaryScreen secondaryScroll selectstyle shade term_name title	1208	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1240	transient_for transparent transparent_all tripleclickwords utmpInhibit	1209	term_name title transient_for transparent tripleclickwords urgentOnBell
1241	visualBell	1210	utmpInhibit visualBell
1242		1211
1243	=cut	1212	=cut
1244		1213
1245	sub resource($$;$) {	1214	sub resource($$;$) {
1246	my ($self, $name) = (shift, shift);	1215	my ($self, $name) = (shift, shift);
1247	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1216	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1248	&urxvt::term::_resource	1217	goto &urxvt::term::_resource
1249	}	1218	}
1250		1219
1251	=item $value = $term->x_resource ($pattern)	1220	=item $value = $term->x_resource ($pattern)
1252		1221
1253	Returns the X-Resource for the given pattern, excluding the program or	1222	Returns the X-Resource for the given pattern, excluding the program or
1254	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1223	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1255	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1224	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1256	resource with that pattern exists.	1225	resource with that pattern exists.
1257		1226
		1227	Extensions that define extra resource or command line arguments also need
		1228	to call this method to access their values.
		1229
		1230	If the method is called on an extension object (basically, from an
		1231	extension), then the special prefix C<%.> will be replaced by the name of
		1232	the extension and a dot, and the lone string C<%> will be replaced by the
		1233	extension name itself. This makes it possible to code extensions so you
		1234	can rename them and get a new set of commandline switches and resources
		1235	without having to change the actual code.
		1236
1258	This method should only be called during the C<on_start> hook, as there is	1237	This method should only be called during the C<on_start> hook, as there is
1259	only one resource database per display, and later invocations might return	1238	only one resource database per display, and later invocations might return
1260	the wrong resources.	1239	the wrong resources.
1261		1240
1262	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1241	=item $value = $term->x_resource_boolean ($pattern)
1263		1242
		1243	Like C<x_resource>, above, but interprets the string value as a boolean
		1244	and returns C<1> for true values, C<0> for false values and C<undef> if
		1245	the resource or option isn't specified.
		1246
		1247	You should always use this method to parse boolean resources.
		1248
		1249	=cut
		1250
		1251	sub x_resource_boolean {
		1252	my $res = &x_resource;
		1253
		1254	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1255	}
		1256
		1257	=item $success = $term->parse_keysym ($key, $octets)
		1258
1264	Adds a keymap translation exactly as specified via a resource. See the	1259	Adds a key binding exactly as specified via a resource. See the
1265	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1260	C<keysym> resource in the urxvt(1) manpage.
		1261
		1262	=item $term->register_command ($keysym, $modifiermask, $string)
		1263
		1264	Adds a key binding. This is a lower level api compared to
		1265	C<parse_keysym>, as it expects a parsed key description, and can be
		1266	used only inside either the C<on_init> hook, to add a binding, or the
		1267	C<on_register_command> hook, to modify a parsed binding.
1266		1268
1267	=item $rend = $term->rstyle ([$new_rstyle])	1269	=item $rend = $term->rstyle ([$new_rstyle])
1268		1270
1269	Return and optionally change the current rendition. Text that is output by	1271	Return and optionally change the current rendition. Text that is output by
1270	the terminal application will use this style.	1272	the terminal application will use this style.
…		…
1278		1280
1279	=item ($row, $col) = $term->selection_beg ([$row, $col])	1281	=item ($row, $col) = $term->selection_beg ([$row, $col])
1280		1282
1281	=item ($row, $col) = $term->selection_end ([$row, $col])	1283	=item ($row, $col) = $term->selection_end ([$row, $col])
1282		1284
1283	Return the current values of the selection mark, begin or end positions,	1285	Return the current values of the selection mark, begin or end positions.
1284	and optionally set them to new values.	1286
		1287	When arguments are given, then the selection coordinates are set to
		1288	C<$row> and C<$col>, and the selection screen is set to the current
		1289	screen.
		1290
		1291	=item $screen = $term->selection_screen ([$screen])
		1292
		1293	Returns the current selection screen, and then optionally sets it.
1285		1294
1286	=item $term->selection_make ($eventtime[, $rectangular])	1295	=item $term->selection_make ($eventtime[, $rectangular])
1287		1296
1288	Tries to make a selection as set by C<selection_beg> and	1297	Tries to make a selection as set by C<selection_beg> and
1289	C<selection_end>. If C<$rectangular> is true (default: false), a	1298	C<selection_end>. If C<$rectangular> is true (default: false), a
1290	rectangular selection will be made. This is the prefered function to make	1299	rectangular selection will be made. This is the preferred function to make
1291	a selection.	1300	a selection.
1292		1301
1293	=item $success = $term->selection_grab ($eventtime)	1302	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1294		1303
1295	Try to request the primary selection text from the server (for example, as	1304	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1305	true) selection from the server. The corresponding text can be set
1296	set by the next method). No visual feedback will be given. This function	1306	with the next method. No visual feedback will be given. This function
1297	is mostly useful from within C<on_sel_grab> hooks.	1307	is mostly useful from within C<on_sel_grab> hooks.
1298		1308
1299	=item $oldtext = $term->selection ([$newtext])	1309	=item $oldtext = $term->selection ([$newtext, $clipboard])
1300		1310
1301	Return the current selection text and optionally replace it by C<$newtext>.	1311	Return the current selection (clipboard if C<$clipboard> is true) text
		1312	and optionally replace it by C<$newtext>.
		1313
		1314	=item $term->selection_clear ([$clipboard])
		1315
		1316	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1302		1317
1303	=item $term->overlay_simple ($x, $y, $text)	1318	=item $term->overlay_simple ($x, $y, $text)
1304		1319
1305	Create a simple multi-line overlay box. See the next method for details.	1320	Create a simple multi-line overlay box. See the next method for details.
1306		1321
…		…
1336		1351
1337	The methods currently supported on C<urxvt::overlay> objects are:	1352	The methods currently supported on C<urxvt::overlay> objects are:
1338		1353
1339	=over 4	1354	=over 4
1340		1355
1341	=item $overlay->set ($x, $y, $text, $rend)	1356	=item $overlay->set ($x, $y, $text[, $rend])
1342		1357
1343	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1358	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1344	text in rxvt-unicode's special encoding and an array of rendition values	1359	text in rxvt-unicode's special encoding and an array of rendition values
1345	at a specific position inside the overlay.	1360	at a specific position inside the overlay.
		1361
		1362	If C<$rend> is missing, then the rendition will not be changed.
1346		1363
1347	=item $overlay->hide	1364	=item $overlay->hide
1348		1365
1349	If visible, hide the overlay, but do not destroy it.	1366	If visible, hide the overlay, but do not destroy it.
1350		1367
…		…
1432	locale-specific encoding of the terminal and can contain command sequences	1449	locale-specific encoding of the terminal and can contain command sequences
1433	(escape codes) that will be interpreted.	1450	(escape codes) that will be interpreted.
1434		1451
1435	=item $term->tt_write ($octets)	1452	=item $term->tt_write ($octets)
1436		1453
1437	Write the octets given in C<$data> to the tty (i.e. as program input). To	1454	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1438	pass characters instead of octets, you should convert your strings first	1455	pass characters instead of octets, you should convert your strings first
1439	to the locale-specific encoding using C<< $term->locale_encode >>.	1456	to the locale-specific encoding using C<< $term->locale_encode >>.
		1457
		1458	=item $term->tt_paste ($octets)
		1459
		1460	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1461	CR and bracketing the data with control sequences if bracketed paste mode
		1462	is set.
1440		1463
1441	=item $old_events = $term->pty_ev_events ([$new_events])	1464	=item $old_events = $term->pty_ev_events ([$new_events])
1442		1465
1443	Replaces the event mask of the pty watcher by the given event mask. Can	1466	Replaces the event mask of the pty watcher by the given event mask. Can
1444	be used to suppress input and output handling to the pty/tty. See the	1467	be used to suppress input and output handling to the pty/tty. See the
…		…
1463	Adds the specified events to the vt event mask. Useful e.g. when you want	1486	Adds the specified events to the vt event mask. Useful e.g. when you want
1464	to receive pointer events all the times:	1487	to receive pointer events all the times:
1465		1488
1466	$term->vt_emask_add (urxvt::PointerMotionMask);	1489	$term->vt_emask_add (urxvt::PointerMotionMask);
1467		1490
		1491	=item $term->set_urgency ($set)
		1492
		1493	Enable/disable the urgency hint on the toplevel window.
		1494
1468	=item $term->focus_in	1495	=item $term->focus_in
1469		1496
1470	=item $term->focus_out	1497	=item $term->focus_out
1471		1498
1472	=item $term->key_press ($state, $keycode[, $time])	1499	=item $term->key_press ($state, $keycode[, $time])
…		…
1560		1587
1561	Used after changing terminal contents to display them.	1588	Used after changing terminal contents to display them.
1562		1589
1563	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1590	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1564		1591
1565	Returns the text of the entire row with number C<$row_number>. Row C<0>	1592	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1566	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1593	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1567	terminal line. The scrollback buffer starts at line C<-1> and extends to
1568	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1594	terminal line. Nothing will be returned if a nonexistent line
1569	is requested.	1595	is requested.
1570		1596
1571	If C<$new_text> is specified, it will replace characters in the current	1597	If C<$new_text> is specified, it will replace characters in the current
1572	line, starting at column C<$start_col> (default C<0>), which is useful	1598	line, starting at column C<$start_col> (default C<0>), which is useful
1573	to replace only parts of a line. The font index in the rendition will	1599	to replace only parts of a line. The font index in the rendition will
1574	automatically be updated.	1600	automatically be updated.
1575		1601
1576	C<$text> is in a special encoding: tabs and wide characters that use more	1602	C<$text> is in a special encoding: tabs and wide characters that use more
1577	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1603	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1578	characters. Characters with combining characters and other characters that	1604	characters. Characters with combining characters and other characters that
1579	do not fit into the normal tetx encoding will be replaced with characters	1605	do not fit into the normal text encoding will be replaced with characters
1580	in the private use area.	1606	in the private use area.
1581		1607
1582	You have to obey this encoding when changing text. The advantage is	1608	You have to obey this encoding when changing text. The advantage is
1583	that C<substr> and similar functions work on screen cells and not on	1609	that C<substr> and similar functions work on screen cells and not on
1584	characters.	1610	characters.
…		…
1759	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1785	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1760	recent grab.	1786	recent grab.
1761		1787
1762	=item $term->ungrab	1788	=item $term->ungrab
1763		1789
1764	Calls XUngrab for the most recent grab. Is called automatically on	1790	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1765	evaluation errors, as it is better to lose the grab in the error case as	1791	evaluation errors, as it is better to lose the grab in the error case as
1766	the session.	1792	the session.
1767		1793
1768	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1794	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1769		1795
…		…
1771		1797
1772	=item @atoms = $term->XListProperties ($window)	1798	=item @atoms = $term->XListProperties ($window)
1773		1799
1774	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1800	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1775		1801
1776	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1802	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1777		1803
1778	=item $term->XDeleteProperty ($window, $property)	1804	=item $term->XDeleteProperty ($window, $property)
1779		1805
1780	=item $window = $term->DefaultRootWindow	1806	=item $window = $term->DefaultRootWindow
1781		1807
…		…
1788	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1814	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1789		1815
1790	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1816	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1791		1817
1792	=item $term->XChangeInput ($window, $add_events[, $del_events])	1818	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1819
		1820	=item $keysym = $term->XStringToKeysym ($string)
		1821
		1822	=item $string = $term->XKeysymToString ($keysym)
1793		1823
1794	Various X or X-related functions. The C<$term> object only serves as	1824	Various X or X-related functions. The C<$term> object only serves as
1795	the source of the display, otherwise those functions map more-or-less	1825	the source of the display, otherwise those functions map more-or-less
1796	directory onto the X functions of the same name.	1826	directly onto the X functions of the same name.
1797		1827
1798	=back	1828	=back
1799		1829
1800	=cut	1830	=cut
1801		1831
…		…
1903	my $env = $self->{term}->env;	1933	my $env = $self->{term}->env;
1904	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1934	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1905	delete $env->{LC_ALL};	1935	delete $env->{LC_ALL};
1906	$env->{LC_CTYPE} = $self->{term}->locale;	1936	$env->{LC_CTYPE} = $self->{term}->locale;
1907		1937
1908	urxvt::term->new ($env, "popup",	1938	my $term = urxvt::term->new (
		1939	$env, "popup",
1909	"--perl-lib" => "", "--perl-ext-common" => "",	1940	"--perl-lib" => "", "--perl-ext-common" => "",
1910	"-pty-fd" => -1, "-sl" => 0,	1941	"-pty-fd" => -1, "-sl" => 0,
1911	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1942	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1912	"--transient-for" => $self->{term}->parent,	1943	"--transient-for" => $self->{term}->parent,
1913	"-display" => $self->{term}->display_id,	1944	"-display" => $self->{term}->display_id,
1914	"-pe" => "urxvt-popup")	1945	"-pe" => "urxvt-popup",
1915	or die "unable to create popup window\n";	1946	) or die "unable to create popup window\n";
		1947
		1948	unless (delete $term->{urxvt_popup_init_done}) {
		1949	$term->ungrab;
		1950	$term->destroy;
		1951	die "unable to initialise popup window\n";
		1952	}
1916	}	1953	}
1917		1954
1918	sub DESTROY {	1955	sub DESTROY {
1919	my ($self) = @_;	1956	my ($self) = @_;
1920		1957
…		…
1925	=back	1962	=back
1926		1963
1927	=cut	1964	=cut
1928		1965
1929	package urxvt::watcher;	1966	package urxvt::watcher;
1930
1931	@urxvt::timer::ISA = __PACKAGE__;
1932	@urxvt::iow::ISA = __PACKAGE__;
1933	@urxvt::pw::ISA = __PACKAGE__;
1934	@urxvt::iw::ISA = __PACKAGE__;
1935		1967
1936	=head2 The C<urxvt::timer> Class	1968	=head2 The C<urxvt::timer> Class
1937		1969
1938	This class implements timer watchers/events. Time is represented as a	1970	This class implements timer watchers/events. Time is represented as a
1939	fractional number of seconds since the epoch. Example:	1971	fractional number of seconds since the epoch. Example:
…		…
1943	->new	1975	->new
1944	->interval (1)	1976	->interval (1)
1945	->cb (sub {	1977	->cb (sub {
1946	$term->{overlay}->set (0, 0,	1978	$term->{overlay}->set (0, 0,
1947	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1979	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1948	});	1980	});
1949		1981
1950	=over 4	1982	=over 4
1951		1983
1952	=item $timer = new urxvt::timer	1984	=item $timer = new urxvt::timer
1953		1985
…		…
1956		1988
1957	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1989	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1958		1990
1959	Set the callback to be called when the timer triggers.	1991	Set the callback to be called when the timer triggers.
1960		1992
1961	=item $tstamp = $timer->at
1962
1963	Return the time this watcher will fire next.
1964
1965	=item $timer = $timer->set ($tstamp)	1993	=item $timer = $timer->set ($tstamp[, $interval])
1966		1994
1967	Set the time the event is generated to $tstamp.	1995	Set the time the event is generated to $tstamp (and optionally specifies a
		1996	new $interval).
1968		1997
1969	=item $timer = $timer->interval ($interval)	1998	=item $timer = $timer->interval ($interval)
1970		1999
1971	Normally (and when C<$interval> is C<0>), the timer will automatically	2000	By default (and when C<$interval> is C<0>), the timer will automatically
1972	stop after it has fired once. If C<$interval> is non-zero, then the timer	2001	stop after it has fired once. If C<$interval> is non-zero, then the timer
1973	is automatically rescheduled at the given intervals.	2002	is automatically rescheduled at the given intervals.
1974		2003
1975	=item $timer = $timer->start	2004	=item $timer = $timer->start
1976		2005
1977	Start the timer.	2006	Start the timer.
1978		2007
1979	=item $timer = $timer->start ($tstamp)	2008	=item $timer = $timer->start ($tstamp[, $interval])
1980		2009
1981	Set the event trigger time to C<$tstamp> and start the timer.	2010	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2011	also replaces the interval.
1982		2012
1983	=item $timer = $timer->after ($delay)	2013	=item $timer = $timer->after ($delay[, $interval])
1984		2014
1985	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2015	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1986		2016
1987	=item $timer = $timer->stop	2017	=item $timer = $timer->stop
1988		2018
…		…
1996		2026
1997	$term->{socket} = ...	2027	$term->{socket} = ...
1998	$term->{iow} = urxvt::iow	2028	$term->{iow} = urxvt::iow
1999	->new	2029	->new
2000	->fd (fileno $term->{socket})	2030	->fd (fileno $term->{socket})
2001	->events (urxvt::EVENT_READ)	2031	->events (urxvt::EV_READ)
2002	->start	2032	->start
2003	->cb (sub {	2033	->cb (sub {
2004	my ($iow, $revents) = @_;	2034	my ($iow, $revents) = @_;
2005	# $revents must be 1 here, no need to check	2035	# $revents must be 1 here, no need to check
2006	sysread $term->{socket}, my $buf, 8192	2036	sysread $term->{socket}, my $buf, 8192
…		…
2024	Set the file descriptor (not handle) to watch.	2054	Set the file descriptor (not handle) to watch.
2025		2055
2026	=item $iow = $iow->events ($eventmask)	2056	=item $iow = $iow->events ($eventmask)
2027		2057
2028	Set the event mask to watch. The only allowed values are	2058	Set the event mask to watch. The only allowed values are
2029	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2059	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2030	together, or C<urxvt::EVENT_NONE>.	2060	together, or C<urxvt::EV_NONE>.
2031		2061
2032	=item $iow = $iow->start	2062	=item $iow = $iow->start
2033		2063
2034	Start watching for requested events on the given handle.	2064	Start watching for requested events on the given handle.
2035		2065
…		…
2076	->new	2106	->new
2077	->start ($pid)	2107	->start ($pid)
2078	->cb (sub {	2108	->cb (sub {
2079	my ($pw, $exit_status) = @_;	2109	my ($pw, $exit_status) = @_;
2080	...	2110	...
2081	});	2111	});
2082		2112
2083	=over 4	2113	=over 4
2084		2114
2085	=item $pw = new urxvt::pw	2115	=item $pw = new urxvt::pw
2086		2116
…		…
2119		2149
2120	=back	2150	=back
2121		2151
2122	=head1 AUTHOR	2152	=head1 AUTHOR
2123		2153
2124	Marc Lehmann <pcg@goof.com>	2154	Marc Lehmann <schmorp@schmorp.de>
2125	http://software.schmorp.de/pkg/rxvt-unicode	2155	http://software.schmorp.de/pkg/rxvt-unicode
2126		2156
2127	=cut	2157	=cut
2128		2158
2129	1	2159	1
		2160
		2161	# vim: sw=3:

Diff Legend

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