[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.104 by root, Wed Jan 18 17:49:47 2006 UTC vs.
Revision 1.177 by root, Sat Jul 18 06:11:57 2009 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --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' 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 @@RXVT_NAME@@d, 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	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
39		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
…		…
58	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
59	...	66	...
60		67
61	The index number (0, 1...) must not have any holes, and each regex must	68	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	69	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	70	the match. For example, the following adds a regex that matches everything
64	between two vertical bars:	71	between two vertical bars:
65		72
66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
67		81
68	You can look at the source of the selection extension to see more	82	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.	83	interesting uses, such as parsing a line from beginning to end.
70		84
71	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
83	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
84		98
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.	100	runtime.
87		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
88	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
89		120
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	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	122	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
93		124
94	Other extensions can extend this popup menu by pushing a code reference onto	125	Other extensions can extend this popup menu by pushing a code reference
95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
96		128
97	It's sole argument is the popup menu, which can be modified. The selection	129	Its 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.	130	is in C<$_>, which can be used to decide whether to add something or not.
99	It should either return nothing or a string and a code reference. The	131	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	132	string will be used as button text and the code reference will be called
101	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
102		134
103	The following will add an entry C<a to b> that transforms all C<a>s in	135	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	136	the selection to C<b>s, but only if the selection currently contains any
105	C<a>s:	137	C<a>s:
106		138
107	push urxvt::ext::selection_popup::hook, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
108	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
109	: ()	141	: ()
110	};	142	};
111		143
112	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
113		145
…		…
120	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	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	153	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	154	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	155	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	156	additionally stores the first match in the current line into the primary
125	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
126		189
127	=item selection-autotransform	190	=item selection-autotransform
128		191
129	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
130	whenever a selection is made.	193	whenever a selection is made.
…		…
143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144		207
145	And this example matches the same,but replaces it with vi-commands you can	208	And this example matches the same,but replaces it with vi-commands you can
146	paste directly into your (vi :) editor:	209	paste directly into your (vi :) editor:
147		210
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149		212
150	Of course, this can be modified to suit your needs and your editor :)	213	Of course, this can be modified to suit your needs and your editor :)
151		214
152	To expand the example above to typical perl error messages ("XXX at	215	To expand the example above to typical perl error messages ("XXX at
153	FILENAME line YYY."), you need a slightly more elaborate solution:	216	FILENAME line YYY."), you need a slightly more elaborate solution:
154		217
155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157		220
158	The first line tells the selection code to treat the unchanging part of	221	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	222	every error message as a selection pattern, and the second line transforms
160	the message into vi commands to load the file.	223	the message into vi commands to load the file.
161		224
162	=item mark-urls	225	=item tabbed
163		226
		227	This transforms the terminal into a tabbar with additional terminals, that
		228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		230	button per tab.
		231
		232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		233	B<Shift-Right> will switch to the tab left or right of the current one,
		234	while B<Shift-Down> creates a new tab.
		235
		236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
164	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
165	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
166	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
167	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
168		258
169	=item automove-background	259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
170		263
171	This is basically a one-line extension that dynamically changes the background pixmap offset	264	It is possible to activate the most recently seen match from the keyboard.
172	to the window position, in effect creating the same effect as pseudo transparency with	265	Simply bind a keysym to "perl:matcher" as seen in the example below.
173	a custom pixmap. No scaling is supported in this mode. Exmaple:
174		266
175	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
		296
		297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
		307
		308	=item overlay-osc
		309
		310	This extension implements some OSC commands to display timed popups on the
		311	screen - useful for status displays from within scripts. You have to read
		312	the sources for more info.
176		313
177	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
178		315
179	A not very useful example of filtering all text output to the terminal,	316	A not very useful example of filtering all text output to the terminal
180	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
181	similar-looking ascii character.	318	similar-looking ascii character.
182		319
183	=item digital-clock	320	=item digital-clock
184		321
185	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
186		323
187	=item example-refresh-hooks	324	=item remote-clipboard
188		325
189	Displays a very simple digital clock in the upper right corner of the	326	Somewhat of a misnomer, this extension adds two menu entries to the
190	window. Illustrates overwriting the refresh callbacks to create your own	327	selection popup that allows one to run external commands to store the
191	overlays or changes.	328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
192		343
193	=item selection-pastebin	344	=item selection-pastebin
194		345
195	This is a little rarely useful extension that Uploads the selection as	346	This is a little rarely useful extension that Uploads the selection as
196	textfile to a remote site (or does other things). (The implementation is	347	textfile to a remote site (or does other things). (The implementation is
…		…
216	After a successful upload the selection will be replaced by the text given	367	After a successful upload the selection will be replaced by the text given
217	in the C<selection-pastebin-url> resource (again, the % is the placeholder	368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
218	for the filename):	369	for the filename):
219		370
220	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of wether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-pastebin and macosx-pastebin-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<maxosx-pastebin> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
		391
		392	=item example-refresh-hooks
		393
		394	Displays a very simple digital clock in the upper right corner of the
		395	window. Illustrates overwriting the refresh callbacks to create your own
		396	overlays or changes.
221		397
222	=back	398	=back
223		399
224	=head1 API DOCUMENTATION	400	=head1 API DOCUMENTATION
225		401
…		…
259		435
260	=back	436	=back
261		437
262	=head2 Extension Objects	438	=head2 Extension Objects
263		439
264	Very perl extension is a perl class. A separate perl object is created	440	Every perl extension is a perl class. A separate perl object is created
265	for each terminal and each extension and passed as the first parameter to	441	for each terminal, and each terminal has its own set of extenion objects,
266	hooks. So extensions can use their C<$self> object without having to think	442	which are passed as the first parameter to hooks. So extensions can use
267	about other extensions, with the exception of methods and members that	443	their C<$self> object without having to think about clashes with other
		444	extensions or other terminals, with the exception of methods and members
268	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
269	use.	446	internal use.
270		447
271	Although it isn't a C<urxvt::term> object, you can call all methods of the	448	Although it isn't a C<urxvt::term> object, you can call all methods of the
272	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
273		450
274	It has the following methods and data members:	451	It has the following methods and data members:
…		…
295	=head2 Hooks	472	=head2 Hooks
296		473
297	The following subroutines can be declared in extension files, and will be	474	The following subroutines can be declared in extension files, and will be
298	called whenever the relevant event happens.	475	called whenever the relevant event happens.
299		476
300	The first argument passed to them is an extension oject as described in	477	The first argument passed to them is an extension object as described in
301	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
302		479
303	B<All> of these hooks must return a boolean value. If it is true, then the	480	B<All> of these hooks must return a boolean value. If any of the called
304	event counts as being I<consumed>, and the invocation of other hooks is	481	hooks returns true, then the event counts as being I<consumed>, and the
305	skipped, and the relevant action might not be carried out by the C++ code.	482	relevant action might not be carried out by the C++ code.
306		483
307	I<< When in doubt, return a false value (preferably C<()>). >>	484	I<< When in doubt, return a false value (preferably C<()>). >>
308		485
309	=over 4	486	=over 4
310		487
311	=item on_init $term	488	=item on_init $term
312		489
313	Called after a new terminal object has been initialized, but before	490	Called after a new terminal object has been initialized, but before
314	windows are created or the command gets run. Most methods are unsafe to	491	windows are created or the command gets run. Most methods are unsafe to
315	call or deliver senseless data, as terminal size and other characteristics	492	call or deliver senseless data, as terminal size and other characteristics
316	have not yet been determined. You can safely query and change resources,	493	have not yet been determined. You can safely query and change resources
317	though.	494	and options, though. For many purposes the C<on_start> hook is a better
		495	place.
		496
		497	=item on_start $term
		498
		499	Called at the very end of initialisation of a new terminal, just before
		500	trying to map (display) the toplevel and returning to the main loop.
		501
		502	=item on_destroy $term
		503
		504	Called whenever something tries to destroy terminal, when the terminal is
		505	still fully functional (not for long, though).
318		506
319	=item on_reset $term	507	=item on_reset $term
320		508
321	Called after the screen is "reset" for any reason, such as resizing or	509	Called after the screen is "reset" for any reason, such as resizing or
322	control sequences. Here is where you can react on changes to size-related	510	control sequences. Here is where you can react on changes to size-related
323	variables.	511	variables.
324		512
325	=item on_start $term	513	=item on_child_start $term, $pid
326		514
327	Called at the very end of initialisation of a new terminal, just before	515	Called just after the child process has been C<fork>ed.
328	returning to the mainloop.	516
		517	=item on_child_exit $term, $status
		518
		519	Called just after the child process has exited. C<$status> is the status
		520	from C<waitpid>.
329		521
330	=item on_sel_make $term, $eventtime	522	=item on_sel_make $term, $eventtime
331		523
332	Called whenever a selection has been made by the user, but before the	524	Called whenever a selection has been made by the user, but before the
333	selection text is copied, so changes to the beginning, end or type of the	525	selection text is copied, so changes to the beginning, end or type of the
…		…
340		532
341	Called whenever a selection has been copied, but before the selection is	533	Called whenever a selection has been copied, but before the selection is
342	requested from the server. The selection text can be queried and changed	534	requested from the server. The selection text can be queried and changed
343	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
344		536
345	Returning a true value aborts selection grabbing. It will still be hilighted.	537	Returning a true value aborts selection grabbing. It will still be highlighted.
346		538
347	=item on_sel_extend $term	539	=item on_sel_extend $term
348		540
349	Called whenever the user tries to extend the selection (e.g. with a double	541	Called whenever the user tries to extend the selection (e.g. with a double
350	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
351	should extend the selection itelf and return true to suppress the built-in	543	should extend the selection itself and return true to suppress the built-in
352	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
353	returns true, it will be called on every further click by the user and is	545	returns true, it will be called on every further click by the user and is
354	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
355		547
356	See the F<selection> example extension.	548	See the F<selection> example extension.
357		549
358	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
359		551
360	Called whenever the view offset changes, i..e the user or program	552	Called whenever the view offset changes, i.e. the user or program
361	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
362	show this many lines of scrollback.	554	show this many lines of scrollback.
363		555
364	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
365		557
…		…
369		561
370	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	562	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
371	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	563	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
372	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
373		565
374	=item on_osc_seq $term, $string	566	=item on_osc_seq $term, $op, $args, $resp
		567
		568	Called on every OSC sequence and can be used to suppress it or modify its
		569	behaviour. The default should be to return an empty list. A true value
		570	suppresses execution of the request completely. Make sure you don't get
		571	confused by recursive invocations when you output an OSC sequence within
		572	this callback.
		573
		574	C<on_osc_seq_perl> should be used for new behaviour.
		575
		576	=item on_osc_seq_perl $term, $args, $resp
375		577
376	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
377	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
378	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
379	string should start with the extension name and a colon, to distinguish	581	string should start with the extension name (sans -osc) and a semicolon,
380	it from commands for other extensions, and this might be enforced in the	582	to distinguish it from commands for other extensions, and this might be
381	future.	583	enforced in the future.
		584
		585	For example, C<overlay-osc> uses this:
		586
		587	sub on_osc_seq_perl {
		588	my ($self, $osc, $resp) = @_;
		589
		590	return unless $osc =~ s/^overlay;//;
		591
		592	... process remaining $osc string
		593	}
382		594
383	Be careful not ever to trust (in a security sense) the data you receive,	595	Be careful not ever to trust (in a security sense) the data you receive,
384	as its source can not easily be controleld (e-mail content, messages from	596	as its source can not easily be controlled (e-mail content, messages from
385	other users on the same system etc.).	597	other users on the same system etc.).
		598
		599	For responses, C<$resp> contains the end-of-args separator used by the
		600	sender.
386		601
387	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
388		603
389	Called whenever text is about to be output, with the text as argument. You	604	Called whenever text is about to be output, with the text as argument. You
390	can filter/change and output the text yourself by returning a true value	605	can filter/change and output the text yourself by returning a true value
…		…
411	later with the already-modified line (e.g. if unrelated parts change), so	626	later with the already-modified line (e.g. if unrelated parts change), so
412	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
413		628
414	=item on_refresh_begin $term	629	=item on_refresh_begin $term
415		630
416	Called just before the screen gets redrawn. Can be used for overlay	631	Called just before the screen gets redrawn. Can be used for overlay or
417	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
418	restoring them in refresh_end. The built-in overlay and selection display	633	restoring them in refresh_end. The built-in overlay and selection display
419	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
420		635
421	=item on_refresh_end $term	636	=item on_refresh_end $term
422		637
423	Called just after the screen gets redrawn. See C<on_refresh_begin>.	638	Called just after the screen gets redrawn. See C<on_refresh_begin>.
424		639
425	=item on_keyboard_command $term, $string	640	=item on_user_command $term, $string
426		641
427	Called whenever the user presses a key combination that has a	642	Called whenever a user-configured event is being activated (e.g. via
428	C<perl:string> action bound to it (see description of the B<keysym>	643	a C<perl:string> action bound to a key, see description of the B<keysym>
429	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
		645
		646	The event is simply the action string. This interface is assumed to change
		647	slightly in the future.
		648
		649	=item on_resize_all_windows $tern, $new_width, $new_height
		650
		651	Called just after the new window size has been calculated, but before
		652	windows are actually being resized or hints are being set. If this hook
		653	returns TRUE, setting of the window hints is being skipped.
430		654
431	=item on_x_event $term, $event	655	=item on_x_event $term, $event
432		656
433	Called on every X event received on the vt window (and possibly other	657	Called on every X event received on the vt window (and possibly other
434	windows). Should only be used as a last resort. Most event structure	658	windows). Should only be used as a last resort. Most event structure
435	members are not passed.	659	members are not passed.
436		660
		661	=item on_root_event $term, $event
		662
		663	Like C<on_x_event>, but is called for events on the root window.
		664
437	=item on_focus_in $term	665	=item on_focus_in $term
438		666
439	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
440	does focus in processing.	668	does focus in processing.
441		669
442	=item on_focus_out $term	670	=item on_focus_out $term
443		671
444	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
445	focus out processing.	673	focus out processing.
446		674
447	=item on_configure_notify $term, $event	675	=item on_configure_notify $term, $event
		676
		677	=item on_property_notify $term, $event
448		678
449	=item on_key_press $term, $event, $keysym, $octets	679	=item on_key_press $term, $event, $keysym, $octets
450		680
451	=item on_key_release $term, $event, $keysym	681	=item on_key_release $term, $event, $keysym
452		682
…		…
462		692
463	Called whenever the corresponding X event is received for the terminal If	693	Called whenever the corresponding X event is received for the terminal If
464	the hook returns true, then the even will be ignored by rxvt-unicode.	694	the hook returns true, then the even will be ignored by rxvt-unicode.
465		695
466	The event is a hash with most values as named by Xlib (see the XEvent	696	The event is a hash with most values as named by Xlib (see the XEvent
467	manpage), with the additional members C<row> and C<col>, which are the row	697	manpage), with the additional members C<row> and C<col>, which are the
468	and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
469		699
470	C<on_key_press> additionally receives the string rxvt-unicode would	700	C<on_key_press> additionally receives the string rxvt-unicode would
471	output, if any, in locale-specific encoding.	701	output, if any, in locale-specific encoding.
472		702
473	subwindow.	703	subwindow.
		704
		705	=item on_client_message $term, $event
		706
		707	=item on_wm_protocols $term, $event
		708
		709	=item on_wm_delete_window $term, $event
		710
		711	Called when various types of ClientMessage events are received (all with
		712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
474		713
475	=back	714	=back
476		715
477	=cut	716	=cut
478		717
…		…
484	use Scalar::Util ();	723	use Scalar::Util ();
485	use List::Util ();	724	use List::Util ();
486		725
487	our $VERSION = 1;	726	our $VERSION = 1;
488	our $TERM;	727	our $TERM;
		728	our @TERM_INIT;
		729	our @TERM_EXT;
489	our @HOOKNAME;	730	our @HOOKNAME;
490	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	731	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
491	our %OPTION;	732	our %OPTION;
492		733
493	our $LIBDIR;	734	our $LIBDIR;
494	our $RESNAME;	735	our $RESNAME;
495	our $RESCLASS;	736	our $RESCLASS;
496	our $RXVTNAME;	737	our $RXVTNAME;
497		738
		739	our $NOCHAR = chr 0xffff;
		740
498	=head2 Variables in the C<urxvt> Package	741	=head2 Variables in the C<urxvt> Package
499		742
500	=over 4	743	=over 4
501		744
502	=item $urxvt::LIBDIR	745	=item $urxvt::LIBDIR
…		…
514		757
515	=item $urxvt::TERM	758	=item $urxvt::TERM
516		759
517	The current terminal. This variable stores the current C<urxvt::term>	760	The current terminal. This variable stores the current C<urxvt::term>
518	object, whenever a callback/hook is executing.	761	object, whenever a callback/hook is executing.
		762
		763	=item @urxvt::TERM_INIT
		764
		765	All code references in this array will be called as methods of the next newly
		766	created C<urxvt::term> object (during the C<on_init> phase). The array
		767	gets cleared before the code references that were in it are being executed,
		768	so references can push themselves onto it again if they so desire.
		769
		770	This complements to the perl-eval command line option, but gets executed
		771	first.
		772
		773	=item @urxvt::TERM_EXT
		774
		775	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		776	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		777	but before other extensions. Gets cleared just like C<@TERM_INIT>.
519		778
520	=back	779	=back
521		780
522	=head2 Functions in the C<urxvt> Package	781	=head2 Functions in the C<urxvt> Package
523		782
…		…
537		796
538	Using this function has the advantage that its output ends up in the	797	Using this function has the advantage that its output ends up in the
539	correct place, e.g. on stderr of the connecting urxvtc client.	798	correct place, e.g. on stderr of the connecting urxvtc client.
540		799
541	Messages have a size limit of 1023 bytes currently.	800	Messages have a size limit of 1023 bytes currently.
		801
		802	=item @terms = urxvt::termlist
		803
		804	Returns all urxvt::term objects that exist in this process, regardless of
		805	whether they are started, being destroyed etc., so be careful. Only term
		806	objects that have perl extensions attached will be returned (because there
		807	is no urxvt::term objet associated with others).
542		808
543	=item $time = urxvt::NOW	809	=item $time = urxvt::NOW
544		810
545	Returns the "current time" (as per the event loop).	811	Returns the "current time" (as per the event loop).
546		812
…		…
604	Return the foreground/background colour index, respectively.	870	Return the foreground/background colour index, respectively.
605		871
606	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	872	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
607		873
608	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	874	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		875
		876	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
609		877
610	Replace the foreground/background colour in the rendition mask with the	878	Replace the foreground/background colour in the rendition mask with the
611	specified one.	879	specified one.
612		880
613	=item $value = urxvt::GET_CUSTOM $rend	881	=item $value = urxvt::GET_CUSTOM $rend
…		…
630	my $msg = join "", @_;	898	my $msg = join "", @_;
631	$msg .= "\n"	899	$msg .= "\n"
632	unless $msg =~ /\n$/;	900	unless $msg =~ /\n$/;
633	urxvt::warn ($msg);	901	urxvt::warn ($msg);
634	};	902	};
635
636	# %ENV is the original startup environment
637	delete $ENV{IFS};
638	delete $ENV{CDPATH};
639	delete $ENV{BASH_ENV};
640	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
641	}	903	}
		904
		905	no warnings 'utf8';
642		906
643	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	907	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
644		908
645	sub verbose {	909	sub verbose {
646	my ($level, $msg) = @_;	910	my ($level, $msg) = @_;
…		…
650	my %extension_pkg;	914	my %extension_pkg;
651		915
652	# load a single script into its own package, once only	916	# load a single script into its own package, once only
653	sub extension_package($) {	917	sub extension_package($) {
654	my ($path) = @_;	918	my ($path) = @_;
655
656	no strict 'refs';
657		919
658	$extension_pkg{$path} \|\|= do {	920	$extension_pkg{$path} \|\|= do {
659	$path =~ /([^\/\\]+)$/;	921	$path =~ /([^\/\\]+)$/;
660	my $pkg = $1;	922	my $pkg = $1;
661	$pkg =~ s/[^[:word:]]/_/g;	923	$pkg =~ s/[^[:word:]]/_/g;
…		…
664	verbose 3, "loading extension '$path' into package '$pkg'";	926	verbose 3, "loading extension '$path' into package '$pkg'";
665		927
666	open my $fh, "<:raw", $path	928	open my $fh, "<:raw", $path
667	or die "$path: $!";	929	or die "$path: $!";
668		930
669	@{"$pkg\::ISA"} = urxvt::term::extension::;
670
671	my $source =	931	my $source =
672	"package $pkg; use strict; use utf8;\n"	932	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
673	. "#line 1 \"$path\"\n{\n"	933	. "#line 1 \"$path\"\n{\n"
674	. (do { local $/; <$fh> })	934	. (do { local $/; <$fh> })
675	. "\n};\n1";	935	. "\n};\n1";
676		936
677	eval $source	937	eval $source
…		…
688	local $TERM = shift;	948	local $TERM = shift;
689	my $htype = shift;	949	my $htype = shift;
690		950
691	if ($htype == 0) { # INIT	951	if ($htype == 0) { # INIT
692	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
693		953
694	my %ext_arg;	954	my %ext_arg;
695		955
		956	{
		957	my @init = @TERM_INIT;
		958	@TERM_INIT = ();
		959	$_->($TERM) for @init;
		960	my @pkg = @TERM_EXT;
		961	@TERM_EXT = ();
		962	$TERM->register_package ($_) for @pkg;
		963	}
		964
696	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	965	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
697	if ($_ eq "default") {	966	if ($_ eq "default") {
698	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	967	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
699	} elsif (/^-(.*)$/) {	968	} elsif (/^-(.*)$/) {
700	delete $ext_arg{$1};	969	delete $ext_arg{$1};
701	} elsif (/^([^<]+)<(.*)>$/) {	970	} elsif (/^([^<]+)<(.*)>$/) {
702	push @{ $ext_arg{$1} }, $2;	971	push @{ $ext_arg{$1} }, $2;
703	} else {	972	} else {
704	$ext_arg{$_} \|\|= [];	973	$ext_arg{$_} \|\|= [];
705	}	974	}
706	}	975	}
707		976
708	while (my ($ext, $argv) = each %ext_arg) {	977	for my $ext (sort keys %ext_arg) {
709	my @files = grep -f $_, map "$_/$ext", @dirs;	978	my @files = grep -f $_, map "$_/$ext", @dirs;
710		979
711	if (@files) {	980	if (@files) {
712	$TERM->register_package (extension_package $files[0], $argv);	981	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
713	} else {	982	} else {
714	warn "perl extension '$ext' not found in perl library search path\n";	983	warn "perl extension '$ext' not found in perl library search path\n";
715	}	984	}
716	}	985	}
717		986
…		…
723		992
724	if (my $cb = $TERM->{_hook}[$htype]) {	993	if (my $cb = $TERM->{_hook}[$htype]) {
725	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	994	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
726	if $verbosity >= 10;	995	if $verbosity >= 10;
727		996
728	keys %$cb;	997	for my $pkg (keys %$cb) {
729
730	while (my ($pkg, $cb) = each %$cb) {
731	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	998	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
732	and last;	999	$retval \|\|= $retval_;
733		1000
734	if ($@) {	1001	if ($@) {
735	$TERM->ungrab; # better to lose the grab than the session	1002	$TERM->ungrab; # better to lose the grab than the session
736	warn $@;	1003	warn $@;
737	}	1004	}
…		…
750	}	1017	}
751		1018
752	$retval	1019	$retval
753	}	1020	}
754		1021
755	sub exec_async(@) {	1022	sub SET_COLOR($$$) {
756	my $pid = fork;	1023	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1024	}
757		1025
758	return	1026	sub rend2mask {
759	if !defined $pid or $pid;	1027	no strict 'refs';
760		1028	my ($str, $mask) = (@_, 0);
761	%ENV = %{ $TERM->env };	1029	my %color = ( fg => undef, bg => undef );
762		1030	my @failed;
763	exec @_;	1031	for my $spec ( split /\s+/, $str ) {
764	_exit 255;	1032	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1033	$color{lc($1)} = $2;
		1034	} else {
		1035	my $neg = $spec =~ s/^[-^]//;
		1036	unless ( exists &{"RS_$spec"} ) {
		1037	push @failed, $spec;
		1038	next;
		1039	}
		1040	my $cur = &{"RS_$spec"};
		1041	if ( $neg ) {
		1042	$mask &= ~$cur;
		1043	} else {
		1044	$mask \|= $cur;
		1045	}
		1046	}
		1047	}
		1048	($mask, @color{qw(fg bg)}, \@failed)
765	}	1049	}
766		1050
767	# urxvt::term::extension	1051	# urxvt::term::extension
768		1052
769	package urxvt::term::extension;	1053	package urxvt::term::extension;
…		…
840	is that you cannot use blocking APIs, but the non-blocking variant should	1124	is that you cannot use blocking APIs, but the non-blocking variant should
841	work.	1125	work.
842		1126
843	=cut	1127	=cut
844		1128
845	our $VERSION = 1;	1129	our $VERSION = '3.4';
846		1130
847	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1131	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
848	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1132	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
849		1133
850	sub timer {	1134	sub timer {
…		…
852		1136
853	my $cb = $arg{cb};	1137	my $cb = $arg{cb};
854		1138
855	urxvt::timer	1139	urxvt::timer
856	->new	1140	->new
857	->start (urxvt::NOW + $arg{after})	1141	->after ($arg{after})
		1142	->interval ($arg{interval})
		1143	->start
858	->cb (sub {	1144	->cb (sub {
		1145	#TODO interval?
859	$_[0]->stop; # need to cancel manually	1146	$_[0]->stop; # need to cancel manually
860	$cb->();	1147	$cb->();
861	})	1148	})
862	}	1149	}
863		1150
864	sub io {	1151	sub io {
865	my ($class, %arg) = @_;	1152	my ($class, %arg) = @_;
866		1153
867	my $cb = $arg{cb};	1154	my $cb = $arg{cb};
		1155	my $fd = fileno $arg{fh};
		1156	defined $fd or $fd = $arg{fh};
868		1157
869	bless [$arg{fh}, urxvt::iow	1158	bless [$arg{fh}, urxvt::iow
870	->new	1159	->new
871	->fd (fileno $arg{fh})	1160	->fd ($fd)
872	->events (($arg{poll} =~ /r/ ? 1 : 0)	1161	->events (($arg{poll} =~ /r/ ? 1 : 0)
873	\| ($arg{poll} =~ /w/ ? 2 : 0))	1162	\| ($arg{poll} =~ /w/ ? 2 : 0))
874	->start	1163	->start
875	->cb (sub {	1164	->cb ($cb)
876	$cb->(($_[1] & 1 ? 'r' : '')
877	. ($_[1] & 2 ? 'w' : ''));
878	})],
879	urxvt::anyevent::	1165	], urxvt::anyevent::
		1166	}
		1167
		1168	sub idle {
		1169	my ($class, %arg) = @_;
		1170
		1171	my $cb = $arg{cb};
		1172
		1173	urxvt::iw
		1174	->new
		1175	->start
		1176	->cb (sub {
		1177	#TODO really cancel?
		1178	$_[0]->stop; # need to cancel manually
		1179	$cb->();
		1180	})
		1181	}
		1182
		1183	sub child {
		1184	my ($class, %arg) = @_;
		1185
		1186	my $cb = $arg{cb};
		1187
		1188	urxvt::pw
		1189	->new
		1190	->start ($arg{pid})
		1191	->cb (sub {
		1192	#TODO really cancel?
		1193	$_[0]->stop; # need to cancel manually
		1194	$cb->($_[0]->rpid, $_[0]->rstatus);
		1195	})
880	}	1196	}
881		1197
882	sub DESTROY {	1198	sub DESTROY {
883	$_[0][1]->stop;	1199	$_[0][1]->stop;
884	}	1200	}
885		1201
886	sub condvar {	1202	sub one_event {
887	bless \my $flag, urxvt::anyevent::condvar::
888	}
889
890	sub urxvt::anyevent::condvar::broadcast {
891	${$_[0]}++;
892	}
893
894	sub urxvt::anyevent::condvar::wait {
895	unless (${$_[0]}) {
896	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1203	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
897	}
898	}	1204	}
899		1205
900	package urxvt::term;	1206	package urxvt::term;
901		1207
902	=head2 The C<urxvt::term> Class	1208	=head2 The C<urxvt::term> Class
…		…
907		1213
908	# find on_xxx subs in the package and register them	1214	# find on_xxx subs in the package and register them
909	# as hooks	1215	# as hooks
910	sub register_package {	1216	sub register_package {
911	my ($self, $pkg, $argv) = @_;	1217	my ($self, $pkg, $argv) = @_;
		1218
		1219	no strict 'refs';
		1220
		1221	urxvt::verbose 6, "register package $pkg to $self";
		1222
		1223	@{"$pkg\::ISA"} = urxvt::term::extension::;
912		1224
913	my $proxy = bless {	1225	my $proxy = bless {
914	_pkg => $pkg,	1226	_pkg => $pkg,
915	argv => $argv,	1227	argv => $argv,
916	}, $pkg;	1228	}, $pkg;
…		…
932	hash which defines the environment of the new terminal.	1244	hash which defines the environment of the new terminal.
933		1245
934	Croaks (and probably outputs an error message) if the new instance	1246	Croaks (and probably outputs an error message) if the new instance
935	couldn't be created. Returns C<undef> if the new instance didn't	1247	couldn't be created. Returns C<undef> if the new instance didn't
936	initialise perl, and the terminal object otherwise. The C<init> and	1248	initialise perl, and the terminal object otherwise. The C<init> and
937	C<start> hooks will be called during this call.	1249	C<start> hooks will be called before this call returns, and are free to
		1250	refer to global data (which is race free).
938		1251
939	=cut	1252	=cut
940		1253
941	sub new {	1254	sub new {
942	my ($class, $env, @args) = @_;	1255	my ($class, $env, @args) = @_;
943		1256
		1257	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1258	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1259
944	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1260	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
945	}	1261	}
946		1262
947	=item $term->destroy	1263	=item $term->destroy
948		1264
949	Destroy the terminal object (close the window, free resources	1265	Destroy the terminal object (close the window, free resources
950	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1266	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
951	watchers (timers, io watchers) are still active.	1267	watchers (timers, io watchers) are still active.
952		1268
		1269	=item $term->exec_async ($cmd[, @args])
		1270
		1271	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1272	("starts") programs in the background. This function takes care of setting
		1273	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1274	be preferred over explicit calls to C<exec> or C<system>.
		1275
		1276	Returns the pid of the subprocess or C<undef> on error.
		1277
		1278	=cut
		1279
		1280	sub exec_async {
		1281	my $self = shift;
		1282
		1283	my $pid = fork;
		1284
		1285	return $pid
		1286	if !defined $pid or $pid;
		1287
		1288	%ENV = %{ $self->env };
		1289
		1290	exec @_;
		1291	urxvt::_exit 255;
		1292	}
		1293
953	=item $isset = $term->option ($optval[, $set])	1294	=item $isset = $term->option ($optval[, $set])
954		1295
955	Returns true if the option specified by C<$optval> is enabled, and	1296	Returns true if the option specified by C<$optval> is enabled, and
956	optionally change it. All option values are stored by name in the hash	1297	optionally change it. All option values are stored by name in the hash
957	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1298	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
958		1299
959	Here is a a likely non-exhaustive list of option names, please see the	1300	Here is a likely non-exhaustive list of option names, please see the
960	source file F</src/optinc.h> to see the actual list:	1301	source file F</src/optinc.h> to see the actual list:
961		1302
962	borderLess console cursorBlink cursorUnderline hold iconic insecure	1303	borderLess console cursorBlink cursorUnderline hold iconic insecure
963	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1304	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
964	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1305	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
965	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1306	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
966	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1307	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
967	tripleclickwords utmpInhibit visualBell	1308	transparent tripleclickwords utmpInhibit visualBell
968		1309
969	=item $value = $term->resource ($name[, $newval])	1310	=item $value = $term->resource ($name[, $newval])
970		1311
971	Returns the current resource value associated with a given name and	1312	Returns the current resource value associated with a given name and
972	optionally sets a new value. Setting values is most useful in the C<init>	1313	optionally sets a new value. Setting values is most useful in the C<init>
…		…
981	likely change).	1322	likely change).
982		1323
983	Please note that resource strings will currently only be freed when the	1324	Please note that resource strings will currently only be freed when the
984	terminal is destroyed, so changing options frequently will eat memory.	1325	terminal is destroyed, so changing options frequently will eat memory.
985		1326
986	Here is a a likely non-exhaustive list of resource names, not all of which	1327	Here is a likely non-exhaustive list of resource names, not all of which
987	are supported in every build, please see the source file F</src/rsinc.h>	1328	are supported in every build, please see the source file F</src/rsinc.h>
988	to see the actual list:	1329	to see the actual list:
989		1330
990	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1331	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
991	borderLess color cursorBlink cursorUnderline cutchars delete_key	1332	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
992	display_name embed ext_bwidth fade font geometry hold iconName	1333	display_name embed ext_bwidth fade font geometry hold iconName
993	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1334	imFont imLocale inputMethod insecure int_bwidth intensityStyles
994	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1335	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
995	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1336	modifier mouseWheelScrollPage name override_redirect pastableTabs path
996	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1337	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
997	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1338	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
998	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1339	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
999	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1340	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1000	shade term_name title transparent transparent_all tripleclickwords	1341	secondaryScreen secondaryScroll shade term_name title
1001	utmpInhibit visualBell	1342	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1343	visualBell
1002		1344
1003	=cut	1345	=cut
1004		1346
1005	sub resource($$;$) {	1347	sub resource($$;$) {
1006	my ($self, $name) = (shift, shift);	1348	my ($self, $name) = (shift, shift);
1007	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1349	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1008	&urxvt::term::_resource	1350	goto &urxvt::term::_resource
1009	}	1351	}
1010		1352
1011	=item $value = $term->x_resource ($pattern)	1353	=item $value = $term->x_resource ($pattern)
1012		1354
1013	Returns the X-Resource for the given pattern, excluding the program or	1355	Returns the X-Resource for the given pattern, excluding the program or
…		…
1096		1438
1097	The methods currently supported on C<urxvt::overlay> objects are:	1439	The methods currently supported on C<urxvt::overlay> objects are:
1098		1440
1099	=over 4	1441	=over 4
1100		1442
1101	=item $overlay->set ($x, $y, $text, $rend)	1443	=item $overlay->set ($x, $y, $text[, $rend])
1102		1444
1103	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1445	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1104	text in rxvt-unicode's special encoding and an array of rendition values	1446	text in rxvt-unicode's special encoding and an array of rendition values
1105	at a specific position inside the overlay.	1447	at a specific position inside the overlay.
		1448
		1449	If C<$rend> is missing, then the rendition will not be changed.
1106		1450
1107	=item $overlay->hide	1451	=item $overlay->hide
1108		1452
1109	If visible, hide the overlay, but do not destroy it.	1453	If visible, hide the overlay, but do not destroy it.
1110		1454
…		…
1180		1524
1181	Normally its not a good idea to use this function, as programs might be	1525	Normally its not a good idea to use this function, as programs might be
1182	confused by changes in cursor position or scrolling. Its useful inside a	1526	confused by changes in cursor position or scrolling. Its useful inside a
1183	C<on_add_lines> hook, though.	1527	C<on_add_lines> hook, though.
1184		1528
		1529	=item $term->scr_change_screen ($screen)
		1530
		1531	Switch to given screen - 0 primary, 1 secondary.
		1532
1185	=item $term->cmd_parse ($octets)	1533	=item $term->cmd_parse ($octets)
1186		1534
1187	Similar to C<scr_add_lines>, but the argument must be in the	1535	Similar to C<scr_add_lines>, but the argument must be in the
1188	locale-specific encoding of the terminal and can contain command sequences	1536	locale-specific encoding of the terminal and can contain command sequences
1189	(escape codes) that will be interpreted.	1537	(escape codes) that will be interpreted.
…		…
1199	Replaces the event mask of the pty watcher by the given event mask. Can	1547	Replaces the event mask of the pty watcher by the given event mask. Can
1200	be used to suppress input and output handling to the pty/tty. See the	1548	be used to suppress input and output handling to the pty/tty. See the
1201	description of C<< urxvt::timer->events >>. Make sure to always restore	1549	description of C<< urxvt::timer->events >>. Make sure to always restore
1202	the previous value.	1550	the previous value.
1203		1551
		1552	=item $fd = $term->pty_fd
		1553
		1554	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1555	is used.
		1556
1204	=item $windowid = $term->parent	1557	=item $windowid = $term->parent
1205		1558
1206	Return the window id of the toplevel window.	1559	Return the window id of the toplevel window.
1207		1560
1208	=item $windowid = $term->vt	1561	=item $windowid = $term->vt
…		…
1214	Adds the specified events to the vt event mask. Useful e.g. when you want	1567	Adds the specified events to the vt event mask. Useful e.g. when you want
1215	to receive pointer events all the times:	1568	to receive pointer events all the times:
1216		1569
1217	$term->vt_emask_add (urxvt::PointerMotionMask);	1570	$term->vt_emask_add (urxvt::PointerMotionMask);
1218		1571
		1572	=item $term->focus_in
		1573
		1574	=item $term->focus_out
		1575
		1576	=item $term->key_press ($state, $keycode[, $time])
		1577
		1578	=item $term->key_release ($state, $keycode[, $time])
		1579
		1580	Deliver various fake events to to terminal.
		1581
1219	=item $window_width = $term->width	1582	=item $window_width = $term->width
1220		1583
1221	=item $window_height = $term->height	1584	=item $window_height = $term->height
1222		1585
1223	=item $font_width = $term->fwidth	1586	=item $font_width = $term->fwidth
…		…
1253	=item $env = $term->env	1616	=item $env = $term->env
1254		1617
1255	Returns a copy of the environment in effect for the terminal as a hashref	1618	Returns a copy of the environment in effect for the terminal as a hashref
1256	similar to C<\%ENV>.	1619	similar to C<\%ENV>.
1257		1620
		1621	=item @envv = $term->envv
		1622
		1623	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1624
		1625	=item @argv = $term->argv
		1626
		1627	Return the argument vector as this terminal, similar to @ARGV, but
		1628	includes the program name as first element.
		1629
1258	=cut	1630	=cut
1259		1631
1260	sub env {	1632	sub env {
1261	if (my $env = $_[0]->_env) {
1262	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1633	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1263	} else {
1264	+{ %ENV }
1265	}
1266	}	1634	}
1267		1635
1268	=item $modifiermask = $term->ModLevel3Mask	1636	=item $modifiermask = $term->ModLevel3Mask
1269		1637
1270	=item $modifiermask = $term->ModMetaMask	1638	=item $modifiermask = $term->ModMetaMask
1271		1639
1272	=item $modifiermask = $term->ModNumLockMask	1640	=item $modifiermask = $term->ModNumLockMask
1273		1641
1274	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1642	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1275	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1643	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1644
		1645	=item $screen = $term->current_screen
		1646
		1647	Returns the currently displayed screen (0 primary, 1 secondary).
		1648
		1649	=item $cursor_is_hidden = $term->hidden_cursor
		1650
		1651	Returns whether the cursor is currently hidden or not.
1276		1652
1277	=item $view_start = $term->view_start ([$newvalue])	1653	=item $view_start = $term->view_start ([$newvalue])
1278		1654
1279	Returns the row number of the topmost displayed line. Maximum value is	1655	Returns the row number of the topmost displayed line. Maximum value is
1280	C<0>, which displays the normal terminal contents. Lower values scroll	1656	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1288		1664
1289	Used after changing terminal contents to display them.	1665	Used after changing terminal contents to display them.
1290		1666
1291	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1667	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1292		1668
1293	Returns the text of the entire row with number C<$row_number>. Row C<0>	1669	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1294	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1670	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1295	terminal line. The scrollback buffer starts at line C<-1> and extends to
1296	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1671	terminal line. Nothing will be returned if a nonexistent line
1297	is requested.	1672	is requested.
1298		1673
1299	If C<$new_text> is specified, it will replace characters in the current	1674	If C<$new_text> is specified, it will replace characters in the current
1300	line, starting at column C<$start_col> (default C<0>), which is useful	1675	line, starting at column C<$start_col> (default C<0>), which is useful
1301	to replace only parts of a line. The font index in the rendition will	1676	to replace only parts of a line. The font index in the rendition will
1302	automatically be updated.	1677	automatically be updated.
1303		1678
1304	C<$text> is in a special encoding: tabs and wide characters that use more	1679	C<$text> is in a special encoding: tabs and wide characters that use more
1305	than one cell when displayed are padded with urxvt::NOCHAR characters	1680	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1306	(C<chr 65535>). Characters with combining characters and other characters	1681	characters. Characters with combining characters and other characters that
1307	that do not fit into the normal tetx encoding will be replaced with	1682	do not fit into the normal text encoding will be replaced with characters
1308	characters in the private use area.	1683	in the private use area.
1309		1684
1310	You have to obey this encoding when changing text. The advantage is	1685	You have to obey this encoding when changing text. The advantage is
1311	that C<substr> and similar functions work on screen cells and not on	1686	that C<substr> and similar functions work on screen cells and not on
1312	characters.	1687	characters.
1313		1688
…		…
1457	where one character corresponds to one screen cell. See	1832	where one character corresponds to one screen cell. See
1458	C<< $term->ROW_t >> for details.	1833	C<< $term->ROW_t >> for details.
1459		1834
1460	=item $string = $term->special_decode $text	1835	=item $string = $term->special_decode $text
1461		1836
1462	Converts rxvt-unicodes text reprsentation into a perl string. See	1837	Converts rxvt-unicodes text representation into a perl string. See
1463	C<< $term->ROW_t >> for details.	1838	C<< $term->ROW_t >> for details.
1464		1839
1465	=item $success = $term->grab_button ($button, $modifiermask)	1840	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1466		1841
		1842	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1843
1467	Registers a synchronous button grab. See the XGrabButton manpage.	1844	Register/unregister a synchronous button grab. See the XGrabButton
		1845	manpage.
1468		1846
1469	=item $success = $term->grab ($eventtime[, $sync])	1847	=item $success = $term->grab ($eventtime[, $sync])
1470		1848
1471	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1849	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1472	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1850	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1473		1851
1474	=item $term->allow_events_async	1852	=item $term->allow_events_async
1475		1853
1476	Calls XAllowEvents with AsyncBoth for the most recent grab.	1854	Calls XAllowEvents with AsyncBoth for the most recent grab.
1477		1855
…		…
1487	=item $term->ungrab	1865	=item $term->ungrab
1488		1866
1489	Calls XUngrab for the most recent grab. Is called automatically on	1867	Calls XUngrab for the most recent grab. Is called automatically on
1490	evaluation errors, as it is better to lose the grab in the error case as	1868	evaluation errors, as it is better to lose the grab in the error case as
1491	the session.	1869	the session.
		1870
		1871	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1872
		1873	=item $atom_name = $term->XGetAtomName ($atom)
		1874
		1875	=item @atoms = $term->XListProperties ($window)
		1876
		1877	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1878
		1879	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1880
		1881	=item $term->XDeleteProperty ($window, $property)
		1882
		1883	=item $window = $term->DefaultRootWindow
		1884
		1885	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1886
		1887	=item $term->XMapWindow ($window)
		1888
		1889	=item $term->XUnmapWindow ($window)
		1890
		1891	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1892
		1893	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1894
		1895	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1896
		1897	Various X or X-related functions. The C<$term> object only serves as
		1898	the source of the display, otherwise those functions map more-or-less
		1899	directory onto the X functions of the same name.
1492		1900
1493	=back	1901	=back
1494		1902
1495	=cut	1903	=cut
1496		1904
…		…
1560	my ($self, $text, $cb) = @_;	1968	my ($self, $text, $cb) = @_;
1561		1969
1562	$self->add_item ({ type => "button", text => $text, activate => $cb});	1970	$self->add_item ({ type => "button", text => $text, activate => $cb});
1563	}	1971	}
1564		1972
1565	=item $popup->add_toggle ($text, $cb, $initial_value)	1973	=item $popup->add_toggle ($text, $initial_value, $cb)
1566		1974
1567	Adds a toggle/checkbox item to the popup. Teh callback gets called	1975	Adds a toggle/checkbox item to the popup. The callback gets called
1568	whenever it gets toggled, with a boolean indicating its value as its first	1976	whenever it gets toggled, with a boolean indicating its new value as its
1569	argument.	1977	first argument.
1570		1978
1571	=cut	1979	=cut
1572		1980
1573	sub add_toggle {	1981	sub add_toggle {
1574	my ($self, $text, $cb, $value) = @_;	1982	my ($self, $text, $value, $cb) = @_;
1575		1983
1576	my $item; $item = {	1984	my $item; $item = {
1577	type => "button",	1985	type => "button",
1578	text => " $text",	1986	text => " $text",
1579	value => $value,	1987	value => $value,
…		…
1598	my $env = $self->{term}->env;	2006	my $env = $self->{term}->env;
1599	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2007	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1600	delete $env->{LC_ALL};	2008	delete $env->{LC_ALL};
1601	$env->{LC_CTYPE} = $self->{term}->locale;	2009	$env->{LC_CTYPE} = $self->{term}->locale;
1602		2010
1603	urxvt::term->new ($env, "popup",	2011	my $term = urxvt::term->new (
1604	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2012	$env, "popup",
		2013	"--perl-lib" => "", "--perl-ext-common" => "",
		2014	"-pty-fd" => -1, "-sl" => 0,
		2015	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1605	"--transient-for" => $self->{term}->parent,	2016	"--transient-for" => $self->{term}->parent,
1606	"-display" => $self->{term}->display_id,	2017	"-display" => $self->{term}->display_id,
1607	"-pe" => "urxvt-popup")	2018	"-pe" => "urxvt-popup",
1608	or die "unable to create popup window\n";	2019	) or die "unable to create popup window\n";
		2020
		2021	unless (delete $term->{urxvt_popup_init_done}) {
		2022	$term->ungrab;
		2023	$term->destroy;
		2024	die "unable to initialise popup window\n";
		2025	}
1609	}	2026	}
1610		2027
1611	sub DESTROY {	2028	sub DESTROY {
1612	my ($self) = @_;	2029	my ($self) = @_;
1613		2030
1614	delete $self->{term}{_destroy}{$self};	2031	delete $self->{term}{_destroy}{$self};
1615	$self->{term}->ungrab;	2032	$self->{term}->ungrab;
1616	}	2033	}
1617		2034
1618	=back	2035	=back
		2036
		2037	=cut
		2038
		2039	package urxvt::watcher;
1619		2040
1620	=head2 The C<urxvt::timer> Class	2041	=head2 The C<urxvt::timer> Class
1621		2042
1622	This class implements timer watchers/events. Time is represented as a	2043	This class implements timer watchers/events. Time is represented as a
1623	fractional number of seconds since the epoch. Example:	2044	fractional number of seconds since the epoch. Example:
…		…
1627	->new	2048	->new
1628	->interval (1)	2049	->interval (1)
1629	->cb (sub {	2050	->cb (sub {
1630	$term->{overlay}->set (0, 0,	2051	$term->{overlay}->set (0, 0,
1631	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2052	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1632	});	2053	});
1633		2054
1634	=over 4	2055	=over 4
1635		2056
1636	=item $timer = new urxvt::timer	2057	=item $timer = new urxvt::timer
1637		2058
…		…
1680		2101
1681	$term->{socket} = ...	2102	$term->{socket} = ...
1682	$term->{iow} = urxvt::iow	2103	$term->{iow} = urxvt::iow
1683	->new	2104	->new
1684	->fd (fileno $term->{socket})	2105	->fd (fileno $term->{socket})
1685	->events (urxvt::EVENT_READ)	2106	->events (urxvt::EV_READ)
1686	->start	2107	->start
1687	->cb (sub {	2108	->cb (sub {
1688	my ($iow, $revents) = @_;	2109	my ($iow, $revents) = @_;
1689	# $revents must be 1 here, no need to check	2110	# $revents must be 1 here, no need to check
1690	sysread $term->{socket}, my $buf, 8192	2111	sysread $term->{socket}, my $buf, 8192
…		…
1703	Set the callback to be called when io events are triggered. C<$reventmask>	2124	Set the callback to be called when io events are triggered. C<$reventmask>
1704	is a bitset as described in the C<events> method.	2125	is a bitset as described in the C<events> method.
1705		2126
1706	=item $iow = $iow->fd ($fd)	2127	=item $iow = $iow->fd ($fd)
1707		2128
1708	Set the filedescriptor (not handle) to watch.	2129	Set the file descriptor (not handle) to watch.
1709		2130
1710	=item $iow = $iow->events ($eventmask)	2131	=item $iow = $iow->events ($eventmask)
1711		2132
1712	Set the event mask to watch. The only allowed values are	2133	Set the event mask to watch. The only allowed values are
1713	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2134	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1714	together, or C<urxvt::EVENT_NONE>.	2135	together, or C<urxvt::EV_NONE>.
1715		2136
1716	=item $iow = $iow->start	2137	=item $iow = $iow->start
1717		2138
1718	Start watching for requested events on the given handle.	2139	Start watching for requested events on the given handle.
1719		2140
1720	=item $iow = $iow->stop	2141	=item $iow = $iow->stop
1721		2142
1722	Stop watching for events on the given filehandle.	2143	Stop watching for events on the given file handle.
		2144
		2145	=back
		2146
		2147	=head2 The C<urxvt::iw> Class
		2148
		2149	This class implements idle watchers, that get called automatically when
		2150	the process is idle. They should return as fast as possible, after doing
		2151	some useful work.
		2152
		2153	=over 4
		2154
		2155	=item $iw = new urxvt::iw
		2156
		2157	Create a new idle watcher object in stopped state.
		2158
		2159	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2160
		2161	Set the callback to be called when the watcher triggers.
		2162
		2163	=item $timer = $timer->start
		2164
		2165	Start the watcher.
		2166
		2167	=item $timer = $timer->stop
		2168
		2169	Stop the watcher.
		2170
		2171	=back
		2172
		2173	=head2 The C<urxvt::pw> Class
		2174
		2175	This class implements process watchers. They create an event whenever a
		2176	process exits, after which they stop automatically.
		2177
		2178	my $pid = fork;
		2179	...
		2180	$term->{pw} = urxvt::pw
		2181	->new
		2182	->start ($pid)
		2183	->cb (sub {
		2184	my ($pw, $exit_status) = @_;
		2185	...
		2186	});
		2187
		2188	=over 4
		2189
		2190	=item $pw = new urxvt::pw
		2191
		2192	Create a new process watcher in stopped state.
		2193
		2194	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2195
		2196	Set the callback to be called when the timer triggers.
		2197
		2198	=item $pw = $timer->start ($pid)
		2199
		2200	Tells the watcher to start watching for process C<$pid>.
		2201
		2202	=item $pw = $pw->stop
		2203
		2204	Stop the watcher.
1723		2205
1724	=back	2206	=back
1725		2207
1726	=head1 ENVIRONMENT	2208	=head1 ENVIRONMENT
1727		2209
…		…
1736		2218
1737	=item >= 3 - script loading and management	2219	=item >= 3 - script loading and management
1738		2220
1739	=item >=10 - all called hooks	2221	=item >=10 - all called hooks
1740		2222
1741	=item >=11 - hook reutrn values	2223	=item >=11 - hook return values
1742		2224
1743	=back	2225	=back
1744		2226
1745	=head1 AUTHOR	2227	=head1 AUTHOR
1746		2228
…		…
1748	http://software.schmorp.de/pkg/rxvt-unicode	2230	http://software.schmorp.de/pkg/rxvt-unicode
1749		2231
1750	=cut	2232	=cut
1751		2233
1752	1	2234	1
		2235
		2236	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.104 by root, Wed Jan 18 17:49:47 2006 UTC vs. Revision 1.177 by root, Sat Jul 18 06:11:57 2009 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.104 by root, Wed Jan 18 17:49:47 2006 UTC vs.
Revision 1.177 by root, Sat Jul 18 06:11:57 2009 UTC