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.101 by root, Wed Jan 18 10:11:03 2006 UTC vs.
Revision 1.246 by root, Fri Dec 26 18:58:19 2014 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	Everytime 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	=over 4	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	=item selection (enabled by default)	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	Extensions may add additional resources and C<actions>, i.e., methods
45	when the user extends selections (double-click and further clicks). Right	49	which can be bound to a key and invoked by the user. An extension can
46	now, it tries to select words, urls and complete shell-quoted	50	define the resources it support and also default bindings for one or
47	arguments, which is very convenient, too, if your F<ls> supports	51	more actions it provides using so called META comments, described
48	C<--quoting-style=shell>.	52	below. Similarly to builtin resources, extension resources can also be
49		53	specified on the command line as long options (with C<.> replaced by
50	A double-click usually selects the word under the cursor, further clicks	54	C<->), in which case the corresponding extension is loaded
51	will enlarge the selection.	55	automatically. For this to work the extension B<must> define META
52		56	comments for its resources.
53	The selection works by trying to match a number of regexes and displaying
54	them in increasing order of length. You can add your own regexes by
55	specifying resources of the form:
56
57	URxvt.selection.pattern-0: perl-regex
58	URxvt.selection.pattern-1: perl-regex
59	...
60
61	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything
64	between two vertical bars:
65
66	URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.
70
71	This extension also offers following bindable keyboard commands:
72
73	=over 4
74
75	=item rot13
76
77	Rot-13 the selection when activated. Used via keyboard trigger:
78
79	URxvt.keysym.C-M-r: perl:selection:rot13
80
81	=back
82
83	=item option-popup (enabled by default)
84
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.
87
88	=item selection-popup (enabled by default)
89
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.
93
94	Other extensions can extend this popup menu by pushing a code reference onto
95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.
96
97	It's sole argument is the popup menu, which can be modified. The selection
98	is in C<$_>, which can be used to decide wether to add something or not.
99	It should either return nothing or a string and a code reference. The
100	string will be used as button text and the code reference will be called
101	when the button gets activated and should transform C<$_>.
102
103	The following will add an entry C<a to b> that transforms all C<a>s in
104	the selection to C<b>s, but only if the selection currently contains any
105	C<a>s:
106
107	push urxvt::ext::selection_popup::hook, sub {
108	/a/ ? ("a to be" => sub { s/a/b/g }
109	: ()
110	};
111
112	=item searchable-scrollback<hotkey> (enabled by default)
113
114	Adds regex search functionality to the scrollback buffer, triggered
115	by a hotkey (default: C<M-s>). While in search mode, normal terminal
116	input/output is suspended and a regex is displayed at the bottom of the
117	screen.
118
119	Inputting characters appends them to the regex and continues incremental
120	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
121	search upwards/downwards in the scrollback buffer, C<End> jumps to the
122	bottom. C<Escape> leaves search mode and returns to the point where search
123	was started, while C<Enter> or C<Return> stay at the current position and
124	additionally stores the first match in the current line into the primary
125	selection.
126
127	=item selection-autotransform
128
129	This selection allows you to do automatic transforms on a selection
130	whenever a selection is made.
131
132	It works by specifying perl snippets (most useful is a single C<s///>
133	operator) that modify C<$_> as resources:
134
135	URxvt.selection-autotransform.0: transform
136	URxvt.selection-autotransform.1: transform
137	...
138
139	For example, the following will transform selections of the form
140	C<filename:number>, often seen in compiler messages, into C<vi +$filename
141	$word>:
142
143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144
145	And this example matches the same,but replaces it with vi-commands you can
146	paste directly into your (vi :) editor:
147
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
149
150	Of course, this can be modified to suit your needs and your editor :)
151
152	To expand the example above to typical perl error messages ("XXX at
153	FILENAME line YYY."), you need a slightly more elaborate solution:
154
155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
157
158	The first line tells the selection code to treat the unchanging part of
159	every error message as a selection pattern, and the second line transforms
160	the message into vi commands to load the file.
161
162	=item mark-urls
163
164	Uses per-line display filtering (C<on_line_update>) to underline urls and
165	make them clickable. When middle-clicked, the program specified in the
166	resource C<urlLauncher> (default C<x-www-browser>) will be started with
167	the URL as first argument.
168
169	=item block-graphics-to-ascii
170
171	A not very useful example of filtering all text output to the terminal,
172	by replacing all line-drawing characters (U+2500 .. U+259F) by a
173	similar-looking ascii character.
174
175	=item digital-clock
176
177	Displays a digital clock using the built-in overlay.
178
179	=item example-refresh-hooks
180
181	Displays a very simple digital clock in the upper right corner of the
182	window. Illustrates overwriting the refresh callbacks to create your own
183	overlays or changes.
184
185	=item selection-pastebin
186
187	This is a little rarely useful extension that Uploads the selection as
188	textfile to a remote site (or does other things). (The implementation is
189	not currently secure for use in a multiuser environment as it writes to
190	F</tmp> directly.).
191
192	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
193	i.e.
194
195	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
196
197	Pressing this combination runs a command with C<%> replaced by the name of
198	the textfile. This command can be set via a resource:
199
200	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
201
202	And the default is likely not useful to anybody but the few people around
203	here :)
204
205	The name of the textfile is the hex encoded md5 sum of the selection, so
206	the same content should lead to the same filename.
207
208	After a successful upload the selection will be replaced by the text given
209	in the C<selection-pastebin-url> resource (again, the % is the placeholder
210	for the filename):
211
212	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
213
214	=back
215		57
216	=head1 API DOCUMENTATION	58	=head1 API DOCUMENTATION
217		59
218	=head2 General API Considerations	60	=head2 General API Considerations
219		61
…		…
233		75
234	=over 4	76	=over 4
235		77
236	=item $text	78	=item $text
237		79
238	Rxvt-unicodes special way of encoding text, where one "unicode" character	80	Rxvt-unicode's special way of encoding text, where one "unicode" character
239	always represents one screen cell. See L<ROW_t> for a discussion of this format.	81	always represents one screen cell. See L<ROW_t> for a discussion of this format.
240		82
241	=item $string	83	=item $string
242		84
243	A perl text string, with an emphasis on I<text>. It can store all unicode	85	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
247	=item $octets	89	=item $octets
248		90
249	Either binary data or - more common - a text string encoded in a	91	Either binary data or - more common - a text string encoded in a
250	locale-specific way.	92	locale-specific way.
251		93
		94	=item $keysym
		95
		96	an integer that is a valid X11 keysym code. You can convert a string
		97	into a keysym and viceversa by using C<XStringToKeysym> and
		98	C<XKeysymToString>.
		99
252	=back	100	=back
253		101
254	=head2 Extension Objects	102	=head2 Extension Objects
255		103
256	Very perl extension is a perl class. A separate perl object is created	104	Every perl extension is a perl class. A separate perl object is created
257	for each terminal and each extension and passed as the first parameter to	105	for each terminal, and each terminal has its own set of extension objects,
258	hooks. So extensions can use their C<$self> object without having to think	106	which are passed as the first parameter to hooks. So extensions can use
259	about other extensions, with the exception of methods and members that	107	their C<$self> object without having to think about clashes with other
		108	extensions or other terminals, with the exception of methods and members
260	begin with an underscore character C<_>: these are reserved for internal	109	that begin with an underscore character C<_>: these are reserved for
261	use.	110	internal use.
262		111
263	Although it isn't a C<urxvt::term> object, you can call all methods of the	112	Although it isn't a C<urxvt::term> object, you can call all methods of the
264	C<urxvt::term> class on this object.	113	C<urxvt::term> class on this object.
265		114
266	It has the following methods and data members:	115	Additional methods only supported for extension objects are described in
		116	the C<urxvt::extension> section below.
		117
		118	=head2 META comments
		119
		120	rxvt-unicode recognizes special comments in extensions that define
		121	different types of metadata:
267		122
268	=over 4	123	=over 4
269		124
270	=item $urxvt_term = $self->{term}	125	=item #:META:RESOURCE:name:type:desc
271		126
272	Returns the C<urxvt::term> object associated with this instance of the	127	The RESOURCE comment defines a resource used by the extension, where
273	extension. This member I<must not> be changed in any way.	128	C<name> is the resource name, C<type> is the resource type, C<boolean>
		129	or C<string>, and C<desc> is the resource description.
274		130
275	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	131	=item #:META:BINDING:sym:action
276		132
277	Dynamically enable the given hooks (named without the C<on_> prefix) for	133	The BINDING comment defines a default binding for an action provided
278	this extension, replacing any previous hook. This is useful when you want	134	by the extension, where C<sym> is the key combination that triggers
279	to overwrite time-critical hooks only temporarily.	135	the action, whose format is defined in the description of the
280		136	B<keysym> resource in the urxvt(1) manpage, and C<action> is the name
281	=item $self->disable ($hook_name[, $hook_name..])	137	of the action method.
282
283	Dynamically disable the given hooks.
284		138
285	=back	139	=back
286		140
287	=head2 Hooks	141	=head2 Hooks
288		142
289	The following subroutines can be declared in extension files, and will be	143	The following subroutines can be declared in extension files, and will be
290	called whenever the relevant event happens.	144	called whenever the relevant event happens.
291		145
292	The first argument passed to them is an extension oject as described in	146	The first argument passed to them is an extension object as described in
293	the in the C<Extension Objects> section.	147	the in the C<Extension Objects> section.
294		148
295	B<All> of these hooks must return a boolean value. If it is true, then the	149	B<All> of these hooks must return a boolean value. If any of the called
296	event counts as being I<consumed>, and the invocation of other hooks is	150	hooks returns true, then the event counts as being I<consumed>, and the
297	skipped, and the relevant action might not be carried out by the C++ code.	151	relevant action might not be carried out by the C++ code.
298		152
299	I<< When in doubt, return a false value (preferably C<()>). >>	153	I<< When in doubt, return a false value (preferably C<()>). >>
300		154
301	=over 4	155	=over 4
302		156
303	=item on_init $term	157	=item on_init $term
304		158
305	Called after a new terminal object has been initialized, but before	159	Called after a new terminal object has been initialized, but before
306	windows are created or the command gets run. Most methods are unsafe to	160	windows are created or the command gets run. Most methods are unsafe to
307	call or deliver senseless data, as terminal size and other characteristics	161	call or deliver senseless data, as terminal size and other characteristics
308	have not yet been determined. You can safely query and change resources,	162	have not yet been determined. You can safely query and change resources
309	though.	163	and options, though. For many purposes the C<on_start> hook is a better
		164	place.
		165
		166	=item on_start $term
		167
		168	Called at the very end of initialisation of a new terminal, just before
		169	trying to map (display) the toplevel and returning to the main loop.
		170
		171	=item on_destroy $term
		172
		173	Called whenever something tries to destroy terminal, when the terminal is
		174	still fully functional (not for long, though).
310		175
311	=item on_reset $term	176	=item on_reset $term
312		177
313	Called after the screen is "reset" for any reason, such as resizing or	178	Called after the screen is "reset" for any reason, such as resizing or
314	control sequences. Here is where you can react on changes to size-related	179	control sequences. Here is where you can react on changes to size-related
315	variables.	180	variables.
316		181
317	=item on_start $term	182	=item on_child_start $term, $pid
318		183
319	Called at the very end of initialisation of a new terminal, just before	184	Called just after the child process has been C<fork>ed.
320	returning to the mainloop.	185
		186	=item on_child_exit $term, $status
		187
		188	Called just after the child process has exited. C<$status> is the status
		189	from C<waitpid>.
321		190
322	=item on_sel_make $term, $eventtime	191	=item on_sel_make $term, $eventtime
323		192
324	Called whenever a selection has been made by the user, but before the	193	Called whenever a selection has been made by the user, but before the
325	selection text is copied, so changes to the beginning, end or type of the	194	selection text is copied, so changes to the beginning, end or type of the
…		…
332		201
333	Called whenever a selection has been copied, but before the selection is	202	Called whenever a selection has been copied, but before the selection is
334	requested from the server. The selection text can be queried and changed	203	requested from the server. The selection text can be queried and changed
335	by calling C<< $term->selection >>.	204	by calling C<< $term->selection >>.
336		205
337	Returning a true value aborts selection grabbing. It will still be hilighted.	206	Returning a true value aborts selection grabbing. It will still be highlighted.
338		207
339	=item on_sel_extend $term	208	=item on_sel_extend $term
340		209
341	Called whenever the user tries to extend the selection (e.g. with a double	210	Called whenever the user tries to extend the selection (e.g. with a double
342	click) and is either supposed to return false (normal operation), or	211	click) and is either supposed to return false (normal operation), or
343	should extend the selection itelf and return true to suppress the built-in	212	should extend the selection itself and return true to suppress the built-in
344	processing. This can happen multiple times, as long as the callback	213	processing. This can happen multiple times, as long as the callback
345	returns true, it will be called on every further click by the user and is	214	returns true, it will be called on every further click by the user and is
346	supposed to enlarge the selection more and more, if possible.	215	supposed to enlarge the selection more and more, if possible.
347		216
348	See the F<selection> example extension.	217	See the F<selection> example extension.
349		218
350	=item on_view_change $term, $offset	219	=item on_view_change $term, $offset
351		220
352	Called whenever the view offset changes, i..e the user or program	221	Called whenever the view offset changes, i.e. the user or program
353	scrolls. Offset C<0> means display the normal terminal, positive values	222	scrolls. Offset C<0> means display the normal terminal, positive values
354	show this many lines of scrollback.	223	show this many lines of scrollback.
355		224
356	=item on_scroll_back $term, $lines, $saved	225	=item on_scroll_back $term, $lines, $saved
357		226
…		…
361		230
362	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	231	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
363	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	232	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
364	number of lines that will be in the scrollback buffer.	233	number of lines that will be in the scrollback buffer.
365		234
366	=item on_osc_seq $term, $string	235	=item on_osc_seq $term, $op, $args, $resp
		236
		237	Called on every OSC sequence and can be used to suppress it or modify its
		238	behaviour. The default should be to return an empty list. A true value
		239	suppresses execution of the request completely. Make sure you don't get
		240	confused by recursive invocations when you output an OSC sequence within
		241	this callback.
		242
		243	C<on_osc_seq_perl> should be used for new behaviour.
		244
		245	=item on_osc_seq_perl $term, $args, $resp
367		246
368	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	247	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
369	operating system command) is processed. Cursor position and other state	248	operating system command) is processed. Cursor position and other state
370	information is up-to-date when this happens. For interoperability, the	249	information is up-to-date when this happens. For interoperability, the
371	string should start with the extension name and a colon, to distinguish	250	string should start with the extension name (sans -osc) and a semicolon,
372	it from commands for other extensions, and this might be enforced in the	251	to distinguish it from commands for other extensions, and this might be
373	future.	252	enforced in the future.
		253
		254	For example, C<overlay-osc> uses this:
		255
		256	sub on_osc_seq_perl {
		257	my ($self, $osc, $resp) = @_;
		258
		259	return unless $osc =~ s/^overlay;//;
		260
		261	... process remaining $osc string
		262	}
374		263
375	Be careful not ever to trust (in a security sense) the data you receive,	264	Be careful not ever to trust (in a security sense) the data you receive,
376	as its source can not easily be controleld (e-mail content, messages from	265	as its source can not easily be controlled (e-mail content, messages from
377	other users on the same system etc.).	266	other users on the same system etc.).
		267
		268	For responses, C<$resp> contains the end-of-args separator used by the
		269	sender.
378		270
379	=item on_add_lines $term, $string	271	=item on_add_lines $term, $string
380		272
381	Called whenever text is about to be output, with the text as argument. You	273	Called whenever text is about to be output, with the text as argument. You
382	can filter/change and output the text yourself by returning a true value	274	can filter/change and output the text yourself by returning a true value
…		…
387	=item on_tt_write $term, $octets	279	=item on_tt_write $term, $octets
388		280
389	Called whenever some data is written to the tty/pty and can be used to	281	Called whenever some data is written to the tty/pty and can be used to
390	suppress or filter tty input.	282	suppress or filter tty input.
391		283
		284	=item on_tt_paste $term, $octets
		285
		286	Called whenever text is about to be pasted, with the text as argument. You
		287	can filter/change and paste the text yourself by returning a true value
		288	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		289	locale-encoded.
		290
392	=item on_line_update $term, $row	291	=item on_line_update $term, $row
393		292
394	Called whenever a line was updated or changed. Can be used to filter	293	Called whenever a line was updated or changed. Can be used to filter
395	screen output (e.g. underline urls or other useless stuff). Only lines	294	screen output (e.g. underline urls or other useless stuff). Only lines
396	that are being shown will be filtered, and, due to performance reasons,	295	that are being shown will be filtered, and, due to performance reasons,
…		…
403	later with the already-modified line (e.g. if unrelated parts change), so	302	later with the already-modified line (e.g. if unrelated parts change), so
404	you cannot just toggle rendition bits, but only set them.	303	you cannot just toggle rendition bits, but only set them.
405		304
406	=item on_refresh_begin $term	305	=item on_refresh_begin $term
407		306
408	Called just before the screen gets redrawn. Can be used for overlay	307	Called just before the screen gets redrawn. Can be used for overlay or
409	or similar effects by modify terminal contents in refresh_begin, and	308	similar effects by modifying the terminal contents in refresh_begin, and
410	restoring them in refresh_end. The built-in overlay and selection display	309	restoring them in refresh_end. The built-in overlay and selection display
411	code is run after this hook, and takes precedence.	310	code is run after this hook, and takes precedence.
412		311
413	=item on_refresh_end $term	312	=item on_refresh_end $term
414		313
415	Called just after the screen gets redrawn. See C<on_refresh_begin>.	314	Called just after the screen gets redrawn. See C<on_refresh_begin>.
416		315
		316	=item on_action $term, $string
		317
		318	Called whenever an action is invoked for the corresponding extension
		319	(e.g. via a C<extension:string> builtin action bound to a key, see
		320	description of the B<keysym> resource in the urxvt(1) manpage). The
		321	event is simply the action string. Note that an action event is always
		322	associated to a single extension.
		323
417	=item on_keyboard_command $term, $string	324	=item on_user_command $term, $string *DEPRECATED*
418		325
419	Called whenever the user presses a key combination that has a	326	Called whenever a user-configured event is being activated (e.g. via
420	C<perl:string> action bound to it (see description of the B<keysym>	327	a C<perl:string> action bound to a key, see description of the B<keysym>
421	resource in the @@RXVT_NAME@@(1) manpage).	328	resource in the urxvt(1) manpage).
		329
		330	The event is simply the action string. This interface is going away in
		331	preference to the C<on_action> hook.
		332
		333	=item on_resize_all_windows $term, $new_width, $new_height
		334
		335	Called just after the new window size has been calculated, but before
		336	windows are actually being resized or hints are being set. If this hook
		337	returns a true value, setting of the window hints is being skipped.
422		338
423	=item on_x_event $term, $event	339	=item on_x_event $term, $event
424		340
425	Called on every X event received on the vt window (and possibly other	341	Called on every X event received on the vt window (and possibly other
426	windows). Should only be used as a last resort. Most event structure	342	windows). Should only be used as a last resort. Most event structure
427	members are not passed.	343	members are not passed.
428		344
		345	=item on_root_event $term, $event
		346
		347	Like C<on_x_event>, but is called for events on the root window.
		348
429	=item on_focus_in $term	349	=item on_focus_in $term
430		350
431	Called whenever the window gets the keyboard focus, before rxvt-unicode	351	Called whenever the window gets the keyboard focus, before rxvt-unicode
432	does focus in processing.	352	does focus in processing.
433		353
434	=item on_focus_out $term	354	=item on_focus_out $term
435		355
436	Called wheneever the window loses keyboard focus, before rxvt-unicode does	356	Called whenever the window loses keyboard focus, before rxvt-unicode does
437	focus out processing.	357	focus out processing.
438		358
		359	=item on_configure_notify $term, $event
		360
		361	=item on_property_notify $term, $event
		362
439	=item on_key_press $term, $event, $keysym, $octets	363	=item on_key_press $term, $event, $keysym, $octets
440		364
441	=item on_key_release $term, $event, $keysym	365	=item on_key_release $term, $event, $keysym
442		366
443	=item on_button_press $term, $event	367	=item on_button_press $term, $event
…		…
448		372
449	=item on_map_notify $term, $event	373	=item on_map_notify $term, $event
450		374
451	=item on_unmap_notify $term, $event	375	=item on_unmap_notify $term, $event
452		376
453	Called whenever the corresponding X event is received for the terminal If	377	Called whenever the corresponding X event is received for the terminal. If
454	the hook returns true, then the even will be ignored by rxvt-unicode.	378	the hook returns true, then the event will be ignored by rxvt-unicode.
455		379
456	The event is a hash with most values as named by Xlib (see the XEvent	380	The event is a hash with most values as named by Xlib (see the XEvent
457	manpage), with the additional members C<row> and C<col>, which are the row	381	manpage), with the additional members C<row> and C<col>, which are the
458	and column under the mouse cursor.	382	(real, not screen-based) row and column under the mouse cursor.
459		383
460	C<on_key_press> additionally receives the string rxvt-unicode would	384	C<on_key_press> additionally receives the string rxvt-unicode would
461	output, if any, in locale-specific encoding.	385	output, if any, in locale-specific encoding.
462		386
463	subwindow.	387	=item on_client_message $term, $event
		388
		389	=item on_wm_protocols $term, $event
		390
		391	=item on_wm_delete_window $term, $event
		392
		393	Called when various types of ClientMessage events are received (all with
		394	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		395
		396	=item on_bell $term
		397
		398	Called on receipt of a bell character.
464		399
465	=back	400	=back
466		401
467	=cut	402	=cut
468		403
469	package urxvt;	404	package urxvt;
470		405
471	use utf8;	406	use utf8;
472	use strict;	407	use strict 'vars';
473	use Carp ();	408	use Carp ();
474	use Scalar::Util ();	409	use Scalar::Util ();
475	use List::Util ();	410	use List::Util ();
476		411
477	our $VERSION = 1;	412	our $VERSION = 1;
478	our $TERM;	413	our $TERM;
		414	our @TERM_INIT; # should go, prevents async I/O etc.
		415	our @TERM_EXT; # should go, prevents async I/O etc.
479	our @HOOKNAME;	416	our @HOOKNAME;
480	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
481	our %OPTION;	418	our %OPTION;
482		419
483	our $LIBDIR;	420	our $LIBDIR;
484	our $RESNAME;	421	our $RESNAME;
485	our $RESCLASS;	422	our $RESCLASS;
486	our $RXVTNAME;	423	our $RXVTNAME;
487		424
		425	our $NOCHAR = chr 0xffff;
		426
488	=head2 Variables in the C<urxvt> Package	427	=head2 Variables in the C<urxvt> Package
489		428
490	=over 4	429	=over 4
491		430
492	=item $urxvt::LIBDIR	431	=item $urxvt::LIBDIR
…		…
505	=item $urxvt::TERM	444	=item $urxvt::TERM
506		445
507	The current terminal. This variable stores the current C<urxvt::term>	446	The current terminal. This variable stores the current C<urxvt::term>
508	object, whenever a callback/hook is executing.	447	object, whenever a callback/hook is executing.
509		448
		449	=item @urxvt::TERM_INIT
		450
		451	All code references in this array will be called as methods of the next newly
		452	created C<urxvt::term> object (during the C<on_init> phase). The array
		453	gets cleared before the code references that were in it are being executed,
		454	so references can push themselves onto it again if they so desire.
		455
		456	This complements to the perl-eval command line option, but gets executed
		457	first.
		458
		459	=item @urxvt::TERM_EXT
		460
		461	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		462	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		463	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		464
510	=back	465	=back
511		466
512	=head2 Functions in the C<urxvt> Package	467	=head2 Functions in the C<urxvt> Package
513		468
514	=over 4	469	=over 4
515		470
516	=item urxvt::fatal $errormessage	471	=item urxvt::fatal $errormessage
517		472
518	Fatally aborts execution with the given error message. Avoid at all	473	Fatally aborts execution with the given error message (which should
519	costs! The only time this is acceptable is when the terminal process	474	include a trailing newline). Avoid at all costs! The only time this
520	starts up.	475	is acceptable (and useful) is in the init hook, where it prevents the
		476	terminal from starting up.
521		477
522	=item urxvt::warn $string	478	=item urxvt::warn $string
523		479
524	Calls C<rxvt_warn> with the given string which should not include a	480	Calls C<rxvt_warn> with the given string which should include a trailing
525	newline. The module also overwrites the C<warn> builtin with a function	481	newline. The module also overwrites the C<warn> builtin with a function
526	that calls this function.	482	that calls this function.
527		483
528	Using this function has the advantage that its output ends up in the	484	Using this function has the advantage that its output ends up in the
529	correct place, e.g. on stderr of the connecting urxvtc client.	485	correct place, e.g. on stderr of the connecting urxvtc client.
530		486
531	Messages have a size limit of 1023 bytes currently.	487	Messages have a size limit of 1023 bytes currently.
		488
		489	=item @terms = urxvt::termlist
		490
		491	Returns all urxvt::term objects that exist in this process, regardless of
		492	whether they are started, being destroyed etc., so be careful. Only term
		493	objects that have perl extensions attached will be returned (because there
		494	is no urxvt::term object associated with others).
532		495
533	=item $time = urxvt::NOW	496	=item $time = urxvt::NOW
534		497
535	Returns the "current time" (as per the event loop).	498	Returns the "current time" (as per the event loop).
536		499
…		…
579		542
580	=item $rend = urxvt::OVERLAY_RSTYLE	543	=item $rend = urxvt::OVERLAY_RSTYLE
581		544
582	Return the rendition mask used for overlays by default.	545	Return the rendition mask used for overlays by default.
583		546
584	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	547	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		548	urxvt::RS_RVid, urxvt::RS_Uline
585		549
586	Return the bit that enabled bold, italic, blink, reverse-video and	550	Return the bit that enabled bold, italic, blink, reverse-video and
587	underline, respectively. To enable such a style, just logically OR it into	551	underline, respectively. To enable such a style, just logically OR it into
588	the bitset.	552	the bitset.
589		553
…		…
594	Return the foreground/background colour index, respectively.	558	Return the foreground/background colour index, respectively.
595		559
596	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	560	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
597		561
598	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	562	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		563
		564	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
599		565
600	Replace the foreground/background colour in the rendition mask with the	566	Replace the foreground/background colour in the rendition mask with the
601	specified one.	567	specified one.
602		568
603	=item $value = urxvt::GET_CUSTOM $rend	569	=item $value = urxvt::GET_CUSTOM $rend
…		…
620	my $msg = join "", @_;	586	my $msg = join "", @_;
621	$msg .= "\n"	587	$msg .= "\n"
622	unless $msg =~ /\n$/;	588	unless $msg =~ /\n$/;
623	urxvt::warn ($msg);	589	urxvt::warn ($msg);
624	};	590	};
		591	}
625		592
626	# %ENV is the original startup environment	593	no warnings 'utf8';
627	delete $ENV{IFS};	594
628	delete $ENV{CDPATH};	595	sub parse_resource {
629	delete $ENV{BASH_ENV};	596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
630	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	597
		598	$term->scan_extensions;
		599
		600	my $r = $term->{meta}{resource};
		601	keys %$r; # reset iterator
		602	while (my ($k, $v) = each %$r) {
		603	my $pattern = $k;
		604	$pattern =~ y/./-/ if $isarg;
		605	my $prefix = $name;
		606	my $suffix;
		607	if ($pattern =~ /\-$/) {
		608	$prefix = substr $name, 0, length $pattern;
		609	$suffix = substr $name, length $pattern;
		610	}
		611	if ($pattern eq $prefix) {
		612	$name = "$urxvt::RESCLASS.$k$suffix";
		613
		614	push @{ $term->{perl_ext_3} }, $v->[0];
		615
		616	if ($v->[1] eq "boolean") {
		617	$term->put_option_db ($name, $flag ? "true" : "false");
		618	return 1;
		619	} else {
		620	$term->put_option_db ($name, $value);
		621	return 1 + 2;
		622	}
		623	}
		624	}
		625
		626	0
		627	}
		628
		629	sub usage {
		630	my ($term, $usage_type) = @_;
		631
		632	$term->scan_extensions;
		633
		634	my $r = $term->{meta}{resource};
		635
		636	for my $pattern (sort keys %$r) {
		637	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		638
		639	$desc .= " (-pe $ext)";
		640
		641	if ($usage_type == 1) {
		642	$pattern =~ y/./-/;
		643	$pattern =~ s/-$/-.../g;
		644
		645	if ($type eq "boolean") {
		646	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		647	} else {
		648	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		649	}
		650	} else {
		651	$pattern =~ s/\.$/.*/g;
		652	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		653	}
		654	}
631	}	655	}
632		656
633	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	657	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
634		658
635	sub verbose {	659	sub verbose {
…		…
640	my %extension_pkg;	664	my %extension_pkg;
641		665
642	# load a single script into its own package, once only	666	# load a single script into its own package, once only
643	sub extension_package($) {	667	sub extension_package($) {
644	my ($path) = @_;	668	my ($path) = @_;
645
646	no strict 'refs';
647		669
648	$extension_pkg{$path} ||= do {	670	$extension_pkg{$path} ||= do {
649	$path =~ /([^\/\\]+)$/;	671	$path =~ /([^\/\\]+)$/;
650	my $pkg = $1;	672	my $pkg = $1;
651	$pkg =~ s/[^[:word:]]/_/g;	673	$pkg =~ s/[^[:word:]]/_/g;
652	$pkg = "urxvt::ext::$pkg";	674	$pkg = "urxvt::ext::$pkg";
653		675
654	verbose 3, "loading extension '$path' into package '$pkg'";	676	verbose 3, "loading extension '$path' into package '$pkg'";
655		677
		678	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		679
656	open my $fh, "<:raw", $path	680	open my $fh, "<:raw", $path
657	or die "$path: $!";	681	or die "$path: $!";
658		682
659	@{"$pkg\::ISA"} = urxvt::term::extension::;
660
661	my $source =	683	my $source =
662	"package $pkg; use strict; use utf8;\n"	684	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
663	. "#line 1 \"$path\"\n{\n"	685	. "#line 1 \"$path\"\n{\n"
664	. (do { local $/; <$fh> })	686	. (do { local $/; <$fh> })
665	. "\n};\n1";	687	. "\n};\n1";
666		688
667	eval $source	689	eval $source
…		…
676	# called by the rxvt core	698	# called by the rxvt core
677	sub invoke {	699	sub invoke {
678	local $TERM = shift;	700	local $TERM = shift;
679	my $htype = shift;	701	my $htype = shift;
680		702
681	if ($htype == 0) { # INIT	703	if ($htype == HOOK_INIT) {
682	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	704	my @dirs = $TERM->perl_libdirs;
683		705
		706	$TERM->scan_extensions;
		707
684	my %ext_arg;	708	my %ext_arg;
685		709
		710	{
		711	my @init = @TERM_INIT;
		712	@TERM_INIT = ();
		713	$_->($TERM) for @init;
		714	my @pkg = @TERM_EXT;
		715	@TERM_EXT = ();
		716	$TERM->register_package ($_) for @pkg;
		717	}
		718
		719	for (
686	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	720	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		721	@{ delete $TERM->{perl_ext_3} }
		722	) {
687	if ($_ eq "default") {	723	if ($_ eq "default") {
		724
		725	$ext_arg{$_} = []
		726	for
688	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	727	qw(selection option-popup selection-popup readline searchable-scrollback),
		728	map $_->[0], values %{ $TERM->{meta}{binding} };
		729
		730	for ($TERM->_keysym_resources) {
		731	next if /^(?:string|command|builtin|builtin-string|perl)/;
		732	next unless /^([A-Za-z0-9_\-]+):/;
		733
		734	my $ext = $1;
		735
		736	$ext_arg{$ext} = [];
		737	}
		738
689	} elsif (/^-(.*)$/) {	739	} elsif (/^-(.*)$/) {
690	delete $ext_arg{$1};	740	delete $ext_arg{$1};
		741
691	} elsif (/^([^<]+)<(.*)>$/) {	742	} elsif (/^([^<]+)<(.*)>$/) {
692	push @{ $ext_arg{$1} }, $2;	743	push @{ $ext_arg{$1} }, $2;
		744
693	} else {	745	} else {
694	$ext_arg{$_} ||= [];	746	$ext_arg{$_} ||= [];
695	}	747	}
696	}	748	}
697		749
698	while (my ($ext, $argv) = each %ext_arg) {	750	# now register default key bindings
		751	for my $ext (sort keys %ext_arg) {
		752	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		753	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
		754	}
		755	}
		756
		757	for my $ext (sort keys %ext_arg) {
699	my @files = grep -f $_, map "$_/$ext", @dirs;	758	my @files = grep -f $_, map "$_/$ext", @dirs;
700		759
701	if (@files) {	760	if (@files) {
702	$TERM->register_package (extension_package $files[0], $argv);	761	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
703	} else {	762	} else {
704	warn "perl extension '$ext' not found in perl library search path\n";	763	warn "perl extension '$ext' not found in perl library search path\n";
705	}	764	}
706	}	765	}
707		766
…		…
713		772
714	if (my $cb = $TERM->{_hook}[$htype]) {	773	if (my $cb = $TERM->{_hook}[$htype]) {
715	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	774	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
716	if $verbosity >= 10;	775	if $verbosity >= 10;
717		776
718	keys %$cb;	777	if ($htype == HOOK_ACTION) {
		778	# this hook is only sent to the extension with the name
		779	# matching the first arg
		780	my $pkg = shift;
		781	$pkg =~ y/-/_/;
		782	$pkg = "urxvt::ext::$pkg";
719		783
720	while (my ($pkg, $cb) = each %$cb) {	784	$cb = $cb->{$pkg}
		785	or return undef; #TODO: maybe warn user?
		786
		787	$cb = { $pkg => $cb };
		788	}
		789
		790	for my $pkg (keys %$cb) {
721	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	791	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
722	and last;	792	$retval ||= $retval_;
723		793
724	if ($@) {	794	if ($@) {
725	$TERM->ungrab; # better to lose the grab than the session	795	$TERM->ungrab; # better to lose the grab than the session
726	warn $@;	796	warn $@;
727	}	797	}
…		…
729		799
730	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	800	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
731	if $verbosity >= 11;	801	if $verbosity >= 11;
732	}	802	}
733		803
734	if ($htype == 1) { # DESTROY	804	if ($htype == HOOK_DESTROY) {
735	# clear package objects	805	# clear package objects
736	%$_ = () for values %{ $TERM->{_pkg} };	806	%$_ = () for values %{ $TERM->{_pkg} };
737		807
738	# clear package	808	# clear package
739	%$TERM = ();	809	%$TERM = ();
740	}	810	}
741		811
742	$retval	812	$retval
743	}	813	}
744		814
745	sub exec_async(@) {	815	sub SET_COLOR($$$) {
746	my $pid = fork;	816	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
747
748	return
749	if !defined $pid or $pid;
750
751	%ENV = %{ $TERM->env };
752
753	exec @_;
754	_exit 255;
755	}	817	}
756		818
757	# urxvt::term::extension	819	sub rend2mask {
		820	no strict 'refs';
		821	my ($str, $mask) = (@_, 0);
		822	my %color = ( fg => undef, bg => undef );
		823	my @failed;
		824	for my $spec ( split /\s+/, $str ) {
		825	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		826	$color{lc($1)} = $2;
		827	} else {
		828	my $neg = $spec =~ s/^[-^]//;
		829	unless ( exists &{"RS_$spec"} ) {
		830	push @failed, $spec;
		831	next;
		832	}
		833	my $cur = &{"RS_$spec"};
		834	if ( $neg ) {
		835	$mask &= ~$cur;
		836	} else {
		837	$mask |= $cur;
		838	}
		839	}
		840	}
		841	($mask, @color{qw(fg bg)}, \@failed)
		842	}
758		843
759	package urxvt::term::extension;	844	package urxvt::term::extension;
760		845
761	sub enable {	846	=head2 The C<urxvt::term::extension> class
762	my ($self, %hook) = @_;
763	my $pkg = $self->{_pkg};
764		847
765	while (my ($name, $cb) = each %hook) {	848	Each extension attached to a terminal object is represented by
766	my $htype = $HOOKTYPE{uc $name};	849	a C<urxvt::term::extension> object.
767	defined $htype
768	or Carp::croak "unsupported hook type '$name'";
769		850
770	$self->set_should_invoke ($htype, +1)	851	You can use these objects, which are passed to all callbacks to store any
771	unless exists $self->{term}{_hook}[$htype]{$pkg};	852	state related to the terminal and extension instance.
772		853
773	$self->{term}{_hook}[$htype]{$pkg} = $cb;	854	The methods (And data members) documented below can be called on extension
774	}	855	objects, in addition to call methods documented for the <urxvt::term>
775	}	856	class.
776		857
777	sub disable {	858	=over 4
778	my ($self, @hook) = @_;
779	my $pkg = $self->{_pkg};
780		859
781	for my $name (@hook) {	860	=item $urxvt_term = $self->{term}
782	my $htype = $HOOKTYPE{uc $name};
783	defined $htype
784	or Carp::croak "unsupported hook type '$name'";
785		861
786	$self->set_should_invoke ($htype, -1)	862	Returns the C<urxvt::term> object associated with this instance of the
787	if delete $self->{term}{_hook}[$htype]{$pkg};	863	extension. This member I<must not> be changed in any way.
788	}	864
789	}	865	=cut
790		866
791	our $AUTOLOAD;	867	our $AUTOLOAD;
792		868
793	sub AUTOLOAD {	869	sub AUTOLOAD {
794	$AUTOLOAD =~ /:([^:]+)$/	870	$AUTOLOAD =~ /:([^:]+)$/
…		…
807		883
808	sub DESTROY {	884	sub DESTROY {
809	# nop	885	# nop
810	}	886	}
811		887
812	# urxvt::destroy_hook	888	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
813		889
814	sub urxvt::destroy_hook::DESTROY {	890	sub urxvt::destroy_hook::DESTROY {
815	${$_[0]}->();	891	${$_[0]}->();
816	}	892	}
817		893
818	sub urxvt::destroy_hook(&) {	894	sub urxvt::destroy_hook(&) {
819	bless \shift, urxvt::destroy_hook::	895	bless \shift, urxvt::destroy_hook::
820	}	896	}
		897
		898	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		899
		900	Dynamically enable the given hooks (named without the C<on_> prefix) for
		901	this extension, replacing any hook previously installed via C<enable> in
		902	this extension.
		903
		904	This is useful when you want to overwrite time-critical hooks only
		905	temporarily.
		906
		907	To install additional callbacks for the same hook, you can use the C<on>
		908	method of the C<urxvt::term> class.
		909
		910	=item $self->disable ($hook_name[, $hook_name..])
		911
		912	Dynamically disable the given hooks.
		913
		914	=cut
		915
		916	sub enable {
		917	my ($self, %hook) = @_;
		918	my $pkg = $self->{_pkg};
		919
		920	while (my ($name, $cb) = each %hook) {
		921	my $htype = $HOOKTYPE{uc $name};
		922	defined $htype
		923	or Carp::croak "unsupported hook type '$name'";
		924
		925	$self->set_should_invoke ($htype, +1)
		926	unless exists $self->{term}{_hook}[$htype]{$pkg};
		927
		928	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		929	}
		930	}
		931
		932	sub disable {
		933	my ($self, @hook) = @_;
		934	my $pkg = $self->{_pkg};
		935
		936	for my $name (@hook) {
		937	my $htype = $HOOKTYPE{uc $name};
		938	defined $htype
		939	or Carp::croak "unsupported hook type '$name'";
		940
		941	$self->set_should_invoke ($htype, -1)
		942	if delete $self->{term}{_hook}[$htype]{$pkg};
		943	}
		944	}
		945
		946	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		947
		948	Similar to the C<enable> enable, but installs additional callbacks for
		949	the given hook(s) (that is, it doesn't replace existing callbacks), and
		950	returns a guard object. When the guard object is destroyed the callbacks
		951	are disabled again.
		952
		953	=cut
		954
		955	sub urxvt::extension::on_disable::DESTROY {
		956	my $disable = shift;
		957
		958	my $term = delete $disable->{""};
		959
		960	while (my ($htype, $id) = each %$disable) {
		961	delete $term->{_hook}[$htype]{$id};
		962	$term->set_should_invoke ($htype, -1);
		963	}
		964	}
		965
		966	sub on {
		967	my ($self, %hook) = @_;
		968
		969	my $term = $self->{term};
		970
		971	my %disable = ( "" => $term );
		972
		973	while (my ($name, $cb) = each %hook) {
		974	my $htype = $HOOKTYPE{uc $name};
		975	defined $htype
		976	or Carp::croak "unsupported hook type '$name'";
		977
		978	$term->set_should_invoke ($htype, +1);
		979	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		980	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		981	}
		982
		983	bless \%disable, "urxvt::extension::on_disable"
		984	}
		985
		986	=item $self->x_resource ($pattern)
		987
		988	=item $self->x_resource_boolean ($pattern)
		989
		990	These methods support an additional C<%> prefix when called on an
		991	extension object - see the description of these methods in the
		992	C<urxvt::term> class for details.
		993
		994	=cut
		995
		996	sub x_resource {
		997	my ($self, $name) = @_;
		998	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		999	$self->{term}->x_resource ($name)
		1000	}
		1001
		1002	sub x_resource_boolean {
		1003	my ($self, $name) = @_;
		1004	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1005	$self->{term}->x_resource_boolean ($name)
		1006	}
		1007
		1008	=back
		1009
		1010	=cut
821		1011
822	package urxvt::anyevent;	1012	package urxvt::anyevent;
823		1013
824	=head2 The C<urxvt::anyevent> Class	1014	=head2 The C<urxvt::anyevent> Class
825		1015
826	The sole purpose of this class is to deliver an interface to the	1016	The sole purpose of this class is to deliver an interface to the
827	C<AnyEvent> module - any module using it will work inside urxvt without	1017	C<AnyEvent> module - any module using it will work inside urxvt without
828	further programming. The only exception is that you cannot wait on	1018	further programming. The only exception is that you cannot wait on
829	condition variables, but non-blocking condvar use is ok. What this means	1019	condition variables, but non-blocking condvar use is ok.
830	is that you cannot use blocking APIs, but the non-blocking variant should
831	work.
832		1020
833	=cut	1021	In practical terms this means is that you cannot use blocking APIs, but
		1022	the non-blocking variant should work.
834		1023
		1024	=cut
		1025
835	our $VERSION = 1;	1026	our $VERSION = '5.23';
836		1027
837	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1028	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
838	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1029	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
839		1030
840	sub timer {	1031	sub timer {
…		…
842		1033
843	my $cb = $arg{cb};	1034	my $cb = $arg{cb};
844		1035
845	urxvt::timer	1036	urxvt::timer
846	->new	1037	->new
847	->start (urxvt::NOW + $arg{after})	1038	->after ($arg{after}, $arg{interval})
848	->cb (sub {	1039	->cb ($arg{interval} ? $cb : sub {
849	$_[0]->stop; # need to cancel manually	1040	$_[0]->stop; # need to cancel manually
850	$cb->();	1041	$cb->();
851	})	1042	})
852	}	1043	}
853		1044
854	sub io {	1045	sub io {
855	my ($class, %arg) = @_;	1046	my ($class, %arg) = @_;
856		1047
857	my $cb = $arg{cb};	1048	my $cb = $arg{cb};
		1049	my $fd = fileno $arg{fh};
		1050	defined $fd or $fd = $arg{fh};
858		1051
859	bless [$arg{fh}, urxvt::iow	1052	bless [$arg{fh}, urxvt::iow
860	->new	1053	->new
861	->fd (fileno $arg{fh})	1054	->fd ($fd)
862	->events (($arg{poll} =~ /r/ ? 1 : 0)	1055	->events (($arg{poll} =~ /r/ ? 1 : 0)
863	| ($arg{poll} =~ /w/ ? 2 : 0))	1056	| ($arg{poll} =~ /w/ ? 2 : 0))
864	->start	1057	->start
865	->cb (sub {	1058	->cb ($cb)
866	$cb->(($_[1] & 1 ? 'r' : '')
867	. ($_[1] & 2 ? 'w' : ''));
868	})],
869	urxvt::anyevent::	1059	], urxvt::anyevent::
		1060	}
		1061
		1062	sub idle {
		1063	my ($class, %arg) = @_;
		1064
		1065	my $cb = $arg{cb};
		1066
		1067	urxvt::iw
		1068	->new
		1069	->start
		1070	->cb ($cb)
		1071	}
		1072
		1073	sub child {
		1074	my ($class, %arg) = @_;
		1075
		1076	my $cb = $arg{cb};
		1077
		1078	urxvt::pw
		1079	->new
		1080	->start ($arg{pid})
		1081	->cb (sub {
		1082	$_[0]->stop; # need to cancel manually
		1083	$cb->($_[0]->rpid, $_[0]->rstatus);
		1084	})
870	}	1085	}
871		1086
872	sub DESTROY {	1087	sub DESTROY {
873	$_[0][1]->stop;	1088	$_[0][1]->stop;
874	}	1089	}
875		1090
876	sub condvar {	1091	# only needed for AnyEvent < 6 compatibility
877	bless \my $flag, urxvt::anyevent::condvar::	1092	sub one_event {
878	}
879
880	sub urxvt::anyevent::condvar::broadcast {
881	${$_[0]}++;
882	}
883
884	sub urxvt::anyevent::condvar::wait {
885	unless (${$_[0]}) {
886	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1093	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
887	}
888	}	1094	}
889		1095
890	package urxvt::term;	1096	package urxvt::term;
891		1097
892	=head2 The C<urxvt::term> Class	1098	=head2 The C<urxvt::term> Class
…		…
898	# find on_xxx subs in the package and register them	1104	# find on_xxx subs in the package and register them
899	# as hooks	1105	# as hooks
900	sub register_package {	1106	sub register_package {
901	my ($self, $pkg, $argv) = @_;	1107	my ($self, $pkg, $argv) = @_;
902		1108
		1109	no strict 'refs';
		1110
		1111	urxvt::verbose 6, "register package $pkg to $self";
		1112
		1113	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1114
903	my $proxy = bless {	1115	my $proxy = bless {
904	_pkg => $pkg,	1116	_pkg => $pkg,
		1117	_name => ${"$pkg\::_NAME"}, # hackish
905	argv => $argv,	1118	argv => $argv,
906	}, $pkg;	1119	}, $pkg;
907	Scalar::Util::weaken ($proxy->{term} = $self);	1120	Scalar::Util::weaken ($proxy->{term} = $self);
908		1121
909	$self->{_pkg}{$pkg} = $proxy;	1122	$self->{_pkg}{$pkg} = $proxy;
910		1123
…		…
913	$proxy->enable ($name => $ref);	1126	$proxy->enable ($name => $ref);
914	}	1127	}
915	}	1128	}
916	}	1129	}
917		1130
		1131	sub perl_libdirs {
		1132	map { split /:/ }
		1133	$_[0]->resource ("perl_lib"),
		1134	$ENV{URXVT_PERL_LIB},
		1135	"$ENV{HOME}/.urxvt/ext",
		1136	"$LIBDIR/perl"
		1137	}
		1138
		1139	# scan for available extensions and collect their metadata
		1140	sub scan_extensions {
		1141	my ($self) = @_;
		1142
		1143	return if exists $self->{meta};
		1144
		1145	my @libdirs = perl_libdirs $self;
		1146
		1147	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1148
		1149	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1150	$self->{meta} = \my %meta;
		1151
		1152	# first gather extensions
		1153	for my $dir (reverse @libdirs) {
		1154	opendir my $fh, $dir
		1155	or next;
		1156	for my $ext (readdir $fh) {
		1157	$ext !~ /^\./
		1158	and open my $fh, "<", "$dir/$ext"
		1159	or next;
		1160
		1161	my %ext = (dir => $dir);
		1162
		1163	while (<$fh>) {
		1164	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1165	my ($pattern, $type, $desc) = split /:/, $1;
		1166	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1167	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1168	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1169	} else {
		1170	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1171	}
		1172	} elsif (/^#:META:BINDING:(.*)/) {
		1173	my ($keysym, $action) = split /:/, $1;
		1174	$ext{binding}{$keysym} = [$ext, $action];
		1175	} elsif (/^\s*(?:#|$)/) {
		1176	# skip other comments and empty lines
		1177	} else {
		1178	last; # stop parsing on first non-empty non-comment line
		1179	}
		1180	}
		1181
		1182	$meta{ext}{$ext} = \%ext;
		1183	}
		1184	}
		1185
		1186	# and now merge resources and bindings
		1187	while (my ($k, $v) = each %{ $meta{ext} }) {
		1188	#TODO: should check for extensions overriding each other
		1189	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1190	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1191	}
		1192	}
		1193
918	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1194	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
919		1195
920	Creates a new terminal, very similar as if you had started it with system	1196	Creates a new terminal, very similar as if you had started it with system
921	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1197	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
922	hash which defines the environment of the new terminal.	1198	hash which defines the environment of the new terminal.
923		1199
924	Croaks (and probably outputs an error message) if the new instance	1200	Croaks (and probably outputs an error message) if the new instance
925	couldn't be created. Returns C<undef> if the new instance didn't	1201	couldn't be created. Returns C<undef> if the new instance didn't
926	initialise perl, and the terminal object otherwise. The C<init> and	1202	initialise perl, and the terminal object otherwise. The C<init> and
927	C<start> hooks will be called during this call.	1203	C<start> hooks will be called before this call returns, and are free to
		1204	refer to global data (which is race free).
928		1205
929	=cut	1206	=cut
930		1207
931	sub new {	1208	sub new {
932	my ($class, $env, @args) = @_;	1209	my ($class, $env, @args) = @_;
933		1210
		1211	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1212	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1213
934	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1214	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
935	}	1215	}
936		1216
937	=item $term->destroy	1217	=item $term->destroy
938		1218
939	Destroy the terminal object (close the window, free resources	1219	Destroy the terminal object (close the window, free resources
940	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1220	etc.). Please note that urxvt will not exit as long as any event
941	watchers (timers, io watchers) are still active.	1221	watchers (timers, io watchers) are still active.
		1222
		1223	=item $term->exec_async ($cmd[, @args])
		1224
		1225	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1226	("starts") programs in the background. This function takes care of setting
		1227	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1228	be preferred over explicit calls to C<exec> or C<system>.
		1229
		1230	Returns the pid of the subprocess or C<undef> on error.
		1231
		1232	=cut
		1233
		1234	sub exec_async {
		1235	my $self = shift;
		1236
		1237	my $pid = fork;
		1238
		1239	return $pid
		1240	if !defined $pid or $pid;
		1241
		1242	%ENV = %{ $self->env };
		1243
		1244	exec @_;
		1245	urxvt::_exit 255;
		1246	}
942		1247
943	=item $isset = $term->option ($optval[, $set])	1248	=item $isset = $term->option ($optval[, $set])
944		1249
945	Returns true if the option specified by C<$optval> is enabled, and	1250	Returns true if the option specified by C<$optval> is enabled, and
946	optionally change it. All option values are stored by name in the hash	1251	optionally change it. All option values are stored by name in the hash
947	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1252	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
948		1253
949	Here is a a likely non-exhaustive list of option names, please see the	1254	Here is a likely non-exhaustive list of option names, please see the
950	source file F</src/optinc.h> to see the actual list:	1255	source file F</src/optinc.h> to see the actual list:
951		1256
952	borderLess console cursorBlink cursorUnderline hold iconic insecure	1257	borderLess buffered console cursorBlink cursorUnderline hold iconic
953	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1258	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1259	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
954	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1260	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
955	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1261	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
956	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1262	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
957	tripleclickwords utmpInhibit visualBell	1263	urgentOnBell utmpInhibit visualBell
958		1264
959	=item $value = $term->resource ($name[, $newval])	1265	=item $value = $term->resource ($name[, $newval])
960		1266
961	Returns the current resource value associated with a given name and	1267	Returns the current resource value associated with a given name and
962	optionally sets a new value. Setting values is most useful in the C<init>	1268	optionally sets a new value. Setting values is most useful in the C<init>
…		…
971	likely change).	1277	likely change).
972		1278
973	Please note that resource strings will currently only be freed when the	1279	Please note that resource strings will currently only be freed when the
974	terminal is destroyed, so changing options frequently will eat memory.	1280	terminal is destroyed, so changing options frequently will eat memory.
975		1281
976	Here is a a likely non-exhaustive list of resource names, not all of which	1282	Here is a likely non-exhaustive list of resource names, not all of which
977	are supported in every build, please see the source file F</src/rsinc.h>	1283	are supported in every build, please see the source file F</src/rsinc.h>
978	to see the actual list:	1284	to see the actual list:
979		1285
980	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1286	answerbackstring backgroundPixmap backspace_key blurradius
981	borderLess color cursorBlink cursorUnderline cutchars delete_key	1287	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
982	display_name embed ext_bwidth fade font geometry hold iconName	1288	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
983	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1289	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1290	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
984	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1291	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
985	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1292	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
986	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1293	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
987	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1294	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
988	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1295	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
989	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1296	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
990	shade term_name title transparent transparent_all tripleclickwords	1297	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1298	term_name title transient_for transparent tripleclickwords urgentOnBell
991	utmpInhibit visualBell	1299	utmpInhibit visualBell
992		1300
993	=cut	1301	=cut
994		1302
995	sub resource($$;$) {	1303	sub resource($$;$) {
996	my ($self, $name) = (shift, shift);	1304	my ($self, $name) = (shift, shift);
997	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1305	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
998	&urxvt::term::_resource	1306	goto &urxvt::term::_resource
999	}	1307	}
1000		1308
1001	=item $value = $term->x_resource ($pattern)	1309	=item $value = $term->x_resource ($pattern)
1002		1310
1003	Returns the X-Resource for the given pattern, excluding the program or	1311	Returns the X-Resource for the given pattern, excluding the program or
1004	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1312	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1005	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1313	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1006	resource with that pattern exists.	1314	resource with that pattern exists.
1007		1315
		1316	Extensions that define extra resources also need to call this method
		1317	to access their values.
		1318
		1319	If the method is called on an extension object (basically, from an
		1320	extension), then the special prefix C<%.> will be replaced by the name of
		1321	the extension and a dot, and the lone string C<%> will be replaced by the
		1322	extension name itself. This makes it possible to code extensions so you
		1323	can rename them and get a new set of resources without having to change
		1324	the actual code.
		1325
1008	This method should only be called during the C<on_start> hook, as there is	1326	This method should only be called during the C<on_start> hook, as there is
1009	only one resource database per display, and later invocations might return	1327	only one resource database per display, and later invocations might return
1010	the wrong resources.	1328	the wrong resources.
1011		1329
1012	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1330	=item $value = $term->x_resource_boolean ($pattern)
1013		1331
		1332	Like C<x_resource>, above, but interprets the string value as a boolean
		1333	and returns C<1> for true values, C<0> for false values and C<undef> if
		1334	the resource or option isn't specified.
		1335
		1336	You should always use this method to parse boolean resources.
		1337
		1338	=cut
		1339
		1340	sub x_resource_boolean {
		1341	my $res = &x_resource;
		1342
		1343	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1344	}
		1345
		1346	=item $success = $term->bind_action ($key, $octets)
		1347
1014	Adds a keymap translation exactly as specified via a resource. See the	1348	Adds a key binding exactly as specified via a C<keysym> resource. See the
1015	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1349	C<keysym> resource in the urxvt(1) manpage.
1016		1350
1017	=item $rend = $term->rstyle ([$new_rstyle])	1351	=item $rend = $term->rstyle ([$new_rstyle])
1018		1352
1019	Return and optionally change the current rendition. Text that is output by	1353	Return and optionally change the current rendition. Text that is output by
1020	the terminal application will use this style.	1354	the terminal application will use this style.
…		…
1028		1362
1029	=item ($row, $col) = $term->selection_beg ([$row, $col])	1363	=item ($row, $col) = $term->selection_beg ([$row, $col])
1030		1364
1031	=item ($row, $col) = $term->selection_end ([$row, $col])	1365	=item ($row, $col) = $term->selection_end ([$row, $col])
1032		1366
1033	Return the current values of the selection mark, begin or end positions,	1367	Return the current values of the selection mark, begin or end positions.
1034	and optionally set them to new values.	1368
		1369	When arguments are given, then the selection coordinates are set to
		1370	C<$row> and C<$col>, and the selection screen is set to the current
		1371	screen.
		1372
		1373	=item $screen = $term->selection_screen ([$screen])
		1374
		1375	Returns the current selection screen, and then optionally sets it.
1035		1376
1036	=item $term->selection_make ($eventtime[, $rectangular])	1377	=item $term->selection_make ($eventtime[, $rectangular])
1037		1378
1038	Tries to make a selection as set by C<selection_beg> and	1379	Tries to make a selection as set by C<selection_beg> and
1039	C<selection_end>. If C<$rectangular> is true (default: false), a	1380	C<selection_end>. If C<$rectangular> is true (default: false), a
1040	rectangular selection will be made. This is the prefered function to make	1381	rectangular selection will be made. This is the preferred function to make
1041	a selection.	1382	a selection.
1042		1383
1043	=item $success = $term->selection_grab ($eventtime)	1384	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1044		1385
1045	Try to request the primary selection text from the server (for example, as	1386	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1387	true) selection from the server. The corresponding text can be set
1046	set by the next method). No visual feedback will be given. This function	1388	with the next method. No visual feedback will be given. This function
1047	is mostly useful from within C<on_sel_grab> hooks.	1389	is mostly useful from within C<on_sel_grab> hooks.
1048		1390
1049	=item $oldtext = $term->selection ([$newtext])	1391	=item $oldtext = $term->selection ([$newtext, $clipboard])
1050		1392
1051	Return the current selection text and optionally replace it by C<$newtext>.	1393	Return the current selection (clipboard if C<$clipboard> is true) text
		1394	and optionally replace it by C<$newtext>.
		1395
		1396	=item $term->selection_clear ([$clipboard])
		1397
		1398	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1052		1399
1053	=item $term->overlay_simple ($x, $y, $text)	1400	=item $term->overlay_simple ($x, $y, $text)
1054		1401
1055	Create a simple multi-line overlay box. See the next method for details.	1402	Create a simple multi-line overlay box. See the next method for details.
1056		1403
…		…
1086		1433
1087	The methods currently supported on C<urxvt::overlay> objects are:	1434	The methods currently supported on C<urxvt::overlay> objects are:
1088		1435
1089	=over 4	1436	=over 4
1090		1437
1091	=item $overlay->set ($x, $y, $text, $rend)	1438	=item $overlay->set ($x, $y, $text[, $rend])
1092		1439
1093	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1440	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1094	text in rxvt-unicode's special encoding and an array of rendition values	1441	text in rxvt-unicode's special encoding and an array of rendition values
1095	at a specific position inside the overlay.	1442	at a specific position inside the overlay.
		1443
		1444	If C<$rend> is missing, then the rendition will not be changed.
1096		1445
1097	=item $overlay->hide	1446	=item $overlay->hide
1098		1447
1099	If visible, hide the overlay, but do not destroy it.	1448	If visible, hide the overlay, but do not destroy it.
1100		1449
…		…
1163		1512
1164	=item $term->scr_add_lines ($string)	1513	=item $term->scr_add_lines ($string)
1165		1514
1166	Write the given text string to the screen, as if output by the application	1515	Write the given text string to the screen, as if output by the application
1167	running inside the terminal. It may not contain command sequences (escape	1516	running inside the terminal. It may not contain command sequences (escape
1168	codes), but is free to use line feeds, carriage returns and tabs. The	1517	codes - see C<cmd_parse> for that), but is free to use line feeds,
1169	string is a normal text string, not in locale-dependent encoding.	1518	carriage returns and tabs. The string is a normal text string, not in
		1519	locale-dependent encoding.
1170		1520
1171	Normally its not a good idea to use this function, as programs might be	1521	Normally its not a good idea to use this function, as programs might be
1172	confused by changes in cursor position or scrolling. Its useful inside a	1522	confused by changes in cursor position or scrolling. Its useful inside a
1173	C<on_add_lines> hook, though.	1523	C<on_add_lines> hook, though.
1174		1524
		1525	=item $term->scr_change_screen ($screen)
		1526
		1527	Switch to given screen - 0 primary, 1 secondary.
		1528
1175	=item $term->cmd_parse ($octets)	1529	=item $term->cmd_parse ($octets)
1176		1530
1177	Similar to C<scr_add_lines>, but the argument must be in the	1531	Similar to C<scr_add_lines>, but the argument must be in the
1178	locale-specific encoding of the terminal and can contain command sequences	1532	locale-specific encoding of the terminal and can contain command sequences
1179	(escape codes) that will be interpreted.	1533	(escape codes) that will be interpreted.
1180		1534
1181	=item $term->tt_write ($octets)	1535	=item $term->tt_write ($octets)
1182		1536
1183	Write the octets given in C<$data> to the tty (i.e. as program input). To	1537	Write the octets given in C<$octets> to the tty (i.e. as user input
		1538	to the program, see C<cmd_parse> for the opposite direction). To pass
1184	pass characters instead of octets, you should convert your strings first	1539	characters instead of octets, you should convert your strings first to the
1185	to the locale-specific encoding using C<< $term->locale_encode >>.	1540	locale-specific encoding using C<< $term->locale_encode >>.
		1541
		1542	=item $term->tt_write_user_input ($octets)
		1543
		1544	Like C<tt_write>, but should be used when writing strings in response to
		1545	the user pressing a key, to invoke the additional actions requested by
		1546	the user for that case (C<tt_write> doesn't do that).
		1547
		1548	The typical use case would be inside C<on_action> hooks.
		1549
		1550	=item $term->tt_paste ($octets)
		1551
		1552	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1553	CR and bracketing the data with control sequences if bracketed paste mode
		1554	is set.
1186		1555
1187	=item $old_events = $term->pty_ev_events ([$new_events])	1556	=item $old_events = $term->pty_ev_events ([$new_events])
1188		1557
1189	Replaces the event mask of the pty watcher by the given event mask. Can	1558	Replaces the event mask of the pty watcher by the given event mask. Can
1190	be used to suppress input and output handling to the pty/tty. See the	1559	be used to suppress input and output handling to the pty/tty. See the
1191	description of C<< urxvt::timer->events >>. Make sure to always restore	1560	description of C<< urxvt::timer->events >>. Make sure to always restore
1192	the previous value.	1561	the previous value.
1193		1562
		1563	=item $fd = $term->pty_fd
		1564
		1565	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1566	is used.
		1567
1194	=item $windowid = $term->parent	1568	=item $windowid = $term->parent
1195		1569
1196	Return the window id of the toplevel window.	1570	Return the window id of the toplevel window.
1197		1571
1198	=item $windowid = $term->vt	1572	=item $windowid = $term->vt
…		…
1204	Adds the specified events to the vt event mask. Useful e.g. when you want	1578	Adds the specified events to the vt event mask. Useful e.g. when you want
1205	to receive pointer events all the times:	1579	to receive pointer events all the times:
1206		1580
1207	$term->vt_emask_add (urxvt::PointerMotionMask);	1581	$term->vt_emask_add (urxvt::PointerMotionMask);
1208		1582
		1583	=item $term->set_urgency ($set)
		1584
		1585	Enable/disable the urgency hint on the toplevel window.
		1586
		1587	=item $term->focus_in
		1588
		1589	=item $term->focus_out
		1590
		1591	=item $term->key_press ($state, $keycode[, $time])
		1592
		1593	=item $term->key_release ($state, $keycode[, $time])
		1594
		1595	Deliver various fake events to to terminal.
		1596
1209	=item $window_width = $term->width	1597	=item $window_width = $term->width
1210		1598
1211	=item $window_height = $term->height	1599	=item $window_height = $term->height
1212		1600
1213	=item $font_width = $term->fwidth	1601	=item $font_width = $term->fwidth
…		…
1243	=item $env = $term->env	1631	=item $env = $term->env
1244		1632
1245	Returns a copy of the environment in effect for the terminal as a hashref	1633	Returns a copy of the environment in effect for the terminal as a hashref
1246	similar to C<\%ENV>.	1634	similar to C<\%ENV>.
1247		1635
		1636	=item @envv = $term->envv
		1637
		1638	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1639
		1640	=item @argv = $term->argv
		1641
		1642	Return the argument vector as this terminal, similar to @ARGV, but
		1643	includes the program name as first element.
		1644
1248	=cut	1645	=cut
1249		1646
1250	sub env {	1647	sub env {
1251	if (my $env = $_[0]->_env) {
1252	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1648	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1253	} else {
1254	+{ %ENV }
1255	}
1256	}	1649	}
1257		1650
1258	=item $modifiermask = $term->ModLevel3Mask	1651	=item $modifiermask = $term->ModLevel3Mask
1259		1652
1260	=item $modifiermask = $term->ModMetaMask	1653	=item $modifiermask = $term->ModMetaMask
1261		1654
1262	=item $modifiermask = $term->ModNumLockMask	1655	=item $modifiermask = $term->ModNumLockMask
1263		1656
1264	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1657	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1265	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1658	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1659
		1660	=item $screen = $term->current_screen
		1661
		1662	Returns the currently displayed screen (0 primary, 1 secondary).
		1663
		1664	=item $cursor_is_hidden = $term->hidden_cursor
		1665
		1666	Returns whether the cursor is currently hidden or not.
1266		1667
1267	=item $view_start = $term->view_start ([$newvalue])	1668	=item $view_start = $term->view_start ([$newvalue])
1268		1669
1269	Returns the row number of the topmost displayed line. Maximum value is	1670	Returns the row number of the topmost displayed line. Maximum value is
1270	C<0>, which displays the normal terminal contents. Lower values scroll	1671	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1278		1679
1279	Used after changing terminal contents to display them.	1680	Used after changing terminal contents to display them.
1280		1681
1281	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1682	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1282		1683
1283	Returns the text of the entire row with number C<$row_number>. Row C<0>	1684	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1284	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1685	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1285	terminal line. The scrollback buffer starts at line C<-1> and extends to
1286	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1686	terminal line. Nothing will be returned if a nonexistent line
1287	is requested.	1687	is requested.
1288		1688
1289	If C<$new_text> is specified, it will replace characters in the current	1689	If C<$new_text> is specified, it will replace characters in the current
1290	line, starting at column C<$start_col> (default C<0>), which is useful	1690	line, starting at column C<$start_col> (default C<0>), which is useful
1291	to replace only parts of a line. The font index in the rendition will	1691	to replace only parts of a line. The font index in the rendition will
1292	automatically be updated.	1692	automatically be updated.
1293		1693
1294	C<$text> is in a special encoding: tabs and wide characters that use more	1694	C<$text> is in a special encoding: tabs and wide characters that use more
1295	than one cell when displayed are padded with urxvt::NOCHAR characters	1695	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1296	(C<chr 65535>). Characters with combining characters and other characters	1696	characters. Characters with combining characters and other characters that
1297	that do not fit into the normal tetx encoding will be replaced with	1697	do not fit into the normal text encoding will be replaced with characters
1298	characters in the private use area.	1698	in the private use area.
1299		1699
1300	You have to obey this encoding when changing text. The advantage is	1700	You have to obey this encoding when changing text. The advantage is
1301	that C<substr> and similar functions work on screen cells and not on	1701	that C<substr> and similar functions work on screen cells and not on
1302	characters.	1702	characters.
1303		1703
…		…
1387	}	1787	}
1388		1788
1389	sub urxvt::line::t {	1789	sub urxvt::line::t {
1390	my ($self) = @_;	1790	my ($self) = @_;
1391		1791
1392	if (@_ > 1)	1792	if (@_ > 1) {
1393	{
1394	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1793	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1395	for $self->{beg} .. $self->{end};	1794	for $self->{beg} .. $self->{end};
1396	}	1795	}
1397		1796
1398	defined wantarray &&	1797	defined wantarray &&
1399	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1798	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1400	0, $self->{len}	1799	0, $self->{len}
1401	}	1800	}
1402		1801
1403	sub urxvt::line::r {	1802	sub urxvt::line::r {
1404	my ($self) = @_;	1803	my ($self) = @_;
1405		1804
1406	if (@_ > 1)	1805	if (@_ > 1) {
1407	{
1408	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1806	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1409	for $self->{beg} .. $self->{end};	1807	for $self->{beg} .. $self->{end};
1410	}	1808	}
1411		1809
1412	if (defined wantarray) {	1810	if (defined wantarray) {
1413	my $rend = [	1811	my $rend = [
1414	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1812	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1415	];	1813	];
…		…
1447	where one character corresponds to one screen cell. See	1845	where one character corresponds to one screen cell. See
1448	C<< $term->ROW_t >> for details.	1846	C<< $term->ROW_t >> for details.
1449		1847
1450	=item $string = $term->special_decode $text	1848	=item $string = $term->special_decode $text
1451		1849
1452	Converts rxvt-unicodes text reprsentation into a perl string. See	1850	Converts rxvt-unicodes text representation into a perl string. See
1453	C<< $term->ROW_t >> for details.	1851	C<< $term->ROW_t >> for details.
1454		1852
1455	=item $success = $term->grab_button ($button, $modifiermask)	1853	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1456		1854
		1855	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1856
1457	Registers a synchronous button grab. See the XGrabButton manpage.	1857	Register/unregister a synchronous button grab. See the XGrabButton
		1858	manpage.
1458		1859
1459	=item $success = $term->grab ($eventtime[, $sync])	1860	=item $success = $term->grab ($eventtime[, $sync])
1460		1861
1461	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1862	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1462	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1863	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1463		1864
1464	=item $term->allow_events_async	1865	=item $term->allow_events_async
1465		1866
1466	Calls XAllowEvents with AsyncBoth for the most recent grab.	1867	Calls XAllowEvents with AsyncBoth for the most recent grab.
1467		1868
…		…
1474	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1875	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1475	recent grab.	1876	recent grab.
1476		1877
1477	=item $term->ungrab	1878	=item $term->ungrab
1478		1879
1479	Calls XUngrab for the most recent grab. Is called automatically on	1880	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1480	evaluation errors, as it is better to lose the grab in the error case as	1881	evaluation errors, as it is better to lose the grab in the error case as
1481	the session.	1882	the session.
		1883
		1884	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1885
		1886	=item $atom_name = $term->XGetAtomName ($atom)
		1887
		1888	=item @atoms = $term->XListProperties ($window)
		1889
		1890	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1891
		1892	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1893
		1894	=item $term->XDeleteProperty ($window, $property)
		1895
		1896	=item $window = $term->DefaultRootWindow
		1897
		1898	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1899
		1900	=item $term->XMapWindow ($window)
		1901
		1902	=item $term->XUnmapWindow ($window)
		1903
		1904	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1905
		1906	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1907
		1908	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1909
		1910	=item $keysym = $term->XStringToKeysym ($string)
		1911
		1912	=item $string = $term->XKeysymToString ($keysym)
		1913
		1914	Various X or X-related functions. The C<$term> object only serves as
		1915	the source of the display, otherwise those functions map more-or-less
		1916	directly onto the X functions of the same name.
1482		1917
1483	=back	1918	=back
1484		1919
1485	=cut	1920	=cut
1486		1921
…		…
1550	my ($self, $text, $cb) = @_;	1985	my ($self, $text, $cb) = @_;
1551		1986
1552	$self->add_item ({ type => "button", text => $text, activate => $cb});	1987	$self->add_item ({ type => "button", text => $text, activate => $cb});
1553	}	1988	}
1554		1989
1555	=item $popup->add_toggle ($text, $cb, $initial_value)	1990	=item $popup->add_toggle ($text, $initial_value, $cb)
1556		1991
1557	Adds a toggle/checkbox item to the popup. Teh callback gets called	1992	Adds a toggle/checkbox item to the popup. The callback gets called
1558	whenever it gets toggled, with a boolean indicating its value as its first	1993	whenever it gets toggled, with a boolean indicating its new value as its
1559	argument.	1994	first argument.
1560		1995
1561	=cut	1996	=cut
1562		1997
1563	sub add_toggle {	1998	sub add_toggle {
1564	my ($self, $text, $cb, $value) = @_;	1999	my ($self, $text, $value, $cb) = @_;
1565		2000
1566	my $item; $item = {	2001	my $item; $item = {
1567	type => "button",	2002	type => "button",
1568	text => " $text",	2003	text => " $text",
1569	value => $value,	2004	value => $value,
…		…
1588	my $env = $self->{term}->env;	2023	my $env = $self->{term}->env;
1589	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2024	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1590	delete $env->{LC_ALL};	2025	delete $env->{LC_ALL};
1591	$env->{LC_CTYPE} = $self->{term}->locale;	2026	$env->{LC_CTYPE} = $self->{term}->locale;
1592		2027
1593	urxvt::term->new ($env, $self->{term}->resource ("name"),	2028	my $term = urxvt::term->new (
1594	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2029	$env, "popup",
		2030	"--perl-lib" => "", "--perl-ext-common" => "",
		2031	"-pty-fd" => -1, "-sl" => 0,
		2032	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1595	"--transient-for" => $self->{term}->parent,	2033	"--transient-for" => $self->{term}->parent,
1596	"-display" => $self->{term}->display_id,	2034	"-display" => $self->{term}->display_id,
1597	"-pe" => "urxvt-popup")	2035	"-pe" => "urxvt-popup",
1598	or die "unable to create popup window\n";	2036	) or die "unable to create popup window\n";
		2037
		2038	unless (delete $term->{urxvt_popup_init_done}) {
		2039	$term->ungrab;
		2040	$term->destroy;
		2041	die "unable to initialise popup window\n";
		2042	}
1599	}	2043	}
1600		2044
1601	sub DESTROY {	2045	sub DESTROY {
1602	my ($self) = @_;	2046	my ($self) = @_;
1603		2047
1604	delete $self->{term}{_destroy}{$self};	2048	delete $self->{term}{_destroy}{$self};
1605	$self->{term}->ungrab;	2049	$self->{term}->ungrab;
1606	}	2050	}
1607		2051
1608	=back	2052	=back
		2053
		2054	=cut
		2055
		2056	package urxvt::watcher;
1609		2057
1610	=head2 The C<urxvt::timer> Class	2058	=head2 The C<urxvt::timer> Class
1611		2059
1612	This class implements timer watchers/events. Time is represented as a	2060	This class implements timer watchers/events. Time is represented as a
1613	fractional number of seconds since the epoch. Example:	2061	fractional number of seconds since the epoch. Example:
…		…
1617	->new	2065	->new
1618	->interval (1)	2066	->interval (1)
1619	->cb (sub {	2067	->cb (sub {
1620	$term->{overlay}->set (0, 0,	2068	$term->{overlay}->set (0, 0,
1621	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2069	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1622	});	2070	});
1623		2071
1624	=over 4	2072	=over 4
1625		2073
1626	=item $timer = new urxvt::timer	2074	=item $timer = new urxvt::timer
1627		2075
…		…
1630		2078
1631	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2079	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1632		2080
1633	Set the callback to be called when the timer triggers.	2081	Set the callback to be called when the timer triggers.
1634		2082
1635	=item $tstamp = $timer->at
1636
1637	Return the time this watcher will fire next.
1638
1639	=item $timer = $timer->set ($tstamp)	2083	=item $timer = $timer->set ($tstamp[, $interval])
1640		2084
1641	Set the time the event is generated to $tstamp.	2085	Set the time the event is generated to $tstamp (and optionally specifies a
		2086	new $interval).
1642		2087
1643	=item $timer = $timer->interval ($interval)	2088	=item $timer = $timer->interval ($interval)
1644		2089
1645	Normally (and when C<$interval> is C<0>), the timer will automatically	2090	By default (and when C<$interval> is C<0>), the timer will automatically
1646	stop after it has fired once. If C<$interval> is non-zero, then the timer	2091	stop after it has fired once. If C<$interval> is non-zero, then the timer
1647	is automatically rescheduled at the given intervals.	2092	is automatically rescheduled at the given intervals.
1648		2093
1649	=item $timer = $timer->start	2094	=item $timer = $timer->start
1650		2095
1651	Start the timer.	2096	Start the timer.
1652		2097
1653	=item $timer = $timer->start ($tstamp)	2098	=item $timer = $timer->start ($tstamp[, $interval])
1654		2099
1655	Set the event trigger time to C<$tstamp> and start the timer.	2100	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2101	also replaces the interval.
		2102
		2103	=item $timer = $timer->after ($delay[, $interval])
		2104
		2105	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1656		2106
1657	=item $timer = $timer->stop	2107	=item $timer = $timer->stop
1658		2108
1659	Stop the timer.	2109	Stop the timer.
1660		2110
…		…
1666		2116
1667	$term->{socket} = ...	2117	$term->{socket} = ...
1668	$term->{iow} = urxvt::iow	2118	$term->{iow} = urxvt::iow
1669	->new	2119	->new
1670	->fd (fileno $term->{socket})	2120	->fd (fileno $term->{socket})
1671	->events (urxvt::EVENT_READ)	2121	->events (urxvt::EV_READ)
1672	->start	2122	->start
1673	->cb (sub {	2123	->cb (sub {
1674	my ($iow, $revents) = @_;	2124	my ($iow, $revents) = @_;
1675	# $revents must be 1 here, no need to check	2125	# $revents must be 1 here, no need to check
1676	sysread $term->{socket}, my $buf, 8192	2126	sysread $term->{socket}, my $buf, 8192
…		…
1689	Set the callback to be called when io events are triggered. C<$reventmask>	2139	Set the callback to be called when io events are triggered. C<$reventmask>
1690	is a bitset as described in the C<events> method.	2140	is a bitset as described in the C<events> method.
1691		2141
1692	=item $iow = $iow->fd ($fd)	2142	=item $iow = $iow->fd ($fd)
1693		2143
1694	Set the filedescriptor (not handle) to watch.	2144	Set the file descriptor (not handle) to watch.
1695		2145
1696	=item $iow = $iow->events ($eventmask)	2146	=item $iow = $iow->events ($eventmask)
1697		2147
1698	Set the event mask to watch. The only allowed values are	2148	Set the event mask to watch. The only allowed values are
1699	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2149	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1700	together, or C<urxvt::EVENT_NONE>.	2150	together, or C<urxvt::EV_NONE>.
1701		2151
1702	=item $iow = $iow->start	2152	=item $iow = $iow->start
1703		2153
1704	Start watching for requested events on the given handle.	2154	Start watching for requested events on the given handle.
1705		2155
1706	=item $iow = $iow->stop	2156	=item $iow = $iow->stop
1707		2157
1708	Stop watching for events on the given filehandle.	2158	Stop watching for events on the given file handle.
		2159
		2160	=back
		2161
		2162	=head2 The C<urxvt::iw> Class
		2163
		2164	This class implements idle watchers, that get called automatically when
		2165	the process is idle. They should return as fast as possible, after doing
		2166	some useful work.
		2167
		2168	=over 4
		2169
		2170	=item $iw = new urxvt::iw
		2171
		2172	Create a new idle watcher object in stopped state.
		2173
		2174	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2175
		2176	Set the callback to be called when the watcher triggers.
		2177
		2178	=item $timer = $timer->start
		2179
		2180	Start the watcher.
		2181
		2182	=item $timer = $timer->stop
		2183
		2184	Stop the watcher.
		2185
		2186	=back
		2187
		2188	=head2 The C<urxvt::pw> Class
		2189
		2190	This class implements process watchers. They create an event whenever a
		2191	process exits, after which they stop automatically.
		2192
		2193	my $pid = fork;
		2194	...
		2195	$term->{pw} = urxvt::pw
		2196	->new
		2197	->start ($pid)
		2198	->cb (sub {
		2199	my ($pw, $exit_status) = @_;
		2200	...
		2201	});
		2202
		2203	=over 4
		2204
		2205	=item $pw = new urxvt::pw
		2206
		2207	Create a new process watcher in stopped state.
		2208
		2209	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2210
		2211	Set the callback to be called when the timer triggers.
		2212
		2213	=item $pw = $timer->start ($pid)
		2214
		2215	Tells the watcher to start watching for process C<$pid>.
		2216
		2217	=item $pw = $pw->stop
		2218
		2219	Stop the watcher.
1709		2220
1710	=back	2221	=back
1711		2222
1712	=head1 ENVIRONMENT	2223	=head1 ENVIRONMENT
1713		2224
…		…
1722		2233
1723	=item >= 3 - script loading and management	2234	=item >= 3 - script loading and management
1724		2235
1725	=item >=10 - all called hooks	2236	=item >=10 - all called hooks
1726		2237
1727	=item >=11 - hook reutrn values	2238	=item >=11 - hook return values
1728		2239
1729	=back	2240	=back
1730		2241
1731	=head1 AUTHOR	2242	=head1 AUTHOR
1732		2243
1733	Marc Lehmann <pcg@goof.com>	2244	Marc Lehmann <schmorp@schmorp.de>
1734	http://software.schmorp.de/pkg/rxvt-unicode	2245	http://software.schmorp.de/pkg/rxvt-unicode
1735		2246
1736	=cut	2247	=cut
1737		2248
1738	1	2249	1
		2250
		2251	# vim: sw=3:

Diff Legend

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