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.88 by root, Thu Jan 12 12:05:28 2006 UTC vs.
Revision 1.170 by root, Tue Sep 23 07:03:13 2008 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 the following bindable keyboard command:	85	This extension also offers following bindable keyboard commands:
72		86
73	=over 4	87	=over 4
74		88
75	=item rot13	89	=item rot13
76		90
…		…
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.
		124
		125	Other extensions can extend this popup menu by pushing a code reference
		126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
		128
		129	Its sole argument is the popup menu, which can be modified. The selection
		130	is in C<$_>, which can be used to decide whether to add something or not.
		131	It should either return nothing or a string and a code reference. The
		132	string will be used as button text and the code reference will be called
		133	when the button gets activated and should transform C<$_>.
		134
		135	The following will add an entry C<a to b> that transforms all C<a>s in
		136	the selection to C<b>s, but only if the selection currently contains any
		137	C<a>s:
		138
		139	push @{ $self->{term}{selection_popup_hook} }, sub {
		140	/a/ ? ("a to b" => sub { s/a/b/g }
		141	: ()
		142	};
93		143
94	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
95		145
96	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
102	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>
103	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
104	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
105	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
106	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
107	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.
108		189
109	=item selection-autotransform	190	=item selection-autotransform
110		191
111	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	193	whenever a selection is made.
…		…
117	URxvt.selection-autotransform.0: transform	198	URxvt.selection-autotransform.0: transform
118	URxvt.selection-autotransform.1: transform	199	URxvt.selection-autotransform.1: transform
119	...	200	...
120		201
121	For example, the following will transform selections of the form	202	For example, the following will transform selections of the form
122	C<word:number> into C<vi +$number $word>:	203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		204	$word>:
123		205
124	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/	206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
125		207
126	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
127	paste directory into your (vi :) editor:	209	paste directly into your (vi :) editor:
128		210
129	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\x0d:$2\\x0d/	211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
130		212
131	=item mark-urls	213	Of course, this can be modified to suit your needs and your editor :)
132		214
		215	To expand the example above to typical perl error messages ("XXX at
		216	FILENAME line YYY."), you need a slightly more elaborate solution:
		217
		218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		220
		221	The first line tells the selection code to treat the unchanging part of
		222	every error message as a selection pattern, and the second line transforms
		223	the message into vi commands to load the file.
		224
		225	=item tabbed
		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
133	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
134	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
135	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
136	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.
		258
		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.
		263
		264	It is possible to activate the most recently seen match from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
		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).
137		307
138	=item block-graphics-to-ascii	308	=item block-graphics-to-ascii
139		309
140	A not very useful example of filtering all text output to the terminal,	310	A not very useful example of filtering all text output to the terminal
141	by replacing all line-drawing characters (U+2500 .. U+259F) by a	311	by replacing all line-drawing characters (U+2500 .. U+259F) by a
142	similar-looking ascii character.	312	similar-looking ascii character.
143		313
144	=item digital-clock	314	=item digital-clock
145		315
146	Displays a digital clock using the built-in overlay.	316	Displays a digital clock using the built-in overlay.
		317
		318	=item remote-clipboard
		319
		320	Somewhat of a misnomer, this extension adds two menu entries to the
		321	selection popup that allows one to run external commands to store the
		322	selection somewhere and fetch it again.
		323
		324	We use it to implement a "distributed selection mechanism", which just
		325	means that one command uploads the file to a remote server, and another
		326	reads it.
		327
		328	The commands can be set using the C<URxvt.remote-selection.store> and
		329	C<URxvt.remote-selection.fetch> resources. The first should read the
		330	selection to store from STDIN (always in UTF-8), the second should provide
		331	the selection data on STDOUT (also in UTF-8).
		332
		333	The defaults (which are likely useless to you) use rsh and cat:
		334
		335	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		336	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		337
		338	=item selection-pastebin
		339
		340	This is a little rarely useful extension that Uploads the selection as
		341	textfile to a remote site (or does other things). (The implementation is
		342	not currently secure for use in a multiuser environment as it writes to
		343	F</tmp> directly.).
		344
		345	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		346	i.e.
		347
		348	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		349
		350	Pressing this combination runs a command with C<%> replaced by the name of
		351	the textfile. This command can be set via a resource:
		352
		353	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		354
		355	And the default is likely not useful to anybody but the few people around
		356	here :)
		357
		358	The name of the textfile is the hex encoded md5 sum of the selection, so
		359	the same content should lead to the same filename.
		360
		361	After a successful upload the selection will be replaced by the text given
		362	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		363	for the filename):
		364
		365	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		366
		367	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		368	the double C</> characters as comment start. Use C<\057\057> instead,
		369	which works regardless of wether xrdb is used to parse the resource file
		370	or not.
147		371
148	=item example-refresh-hooks	372	=item example-refresh-hooks
149		373
150	Displays a very simple digital clock in the upper right corner of the	374	Displays a very simple digital clock in the upper right corner of the
151	window. Illustrates overwriting the refresh callbacks to create your own	375	window. Illustrates overwriting the refresh callbacks to create your own
…		…
191		415
192	=back	416	=back
193		417
194	=head2 Extension Objects	418	=head2 Extension Objects
195		419
196	Very perl extension is a perl class. A separate perl object is created	420	Every perl extension is a perl class. A separate perl object is created
197	for each terminal and each extension and passed as the first parameter to	421	for each terminal, and each terminal has its own set of extenion objects,
198	hooks. So extensions can use their C<$self> object without having to think	422	which are passed as the first parameter to hooks. So extensions can use
199	about other extensions, with the exception of methods and members that	423	their C<$self> object without having to think about clashes with other
		424	extensions or other terminals, with the exception of methods and members
200	begin with an underscore character C<_>: these are reserved for internal	425	that begin with an underscore character C<_>: these are reserved for
201	use.	426	internal use.
202		427
203	Although it isn't a C<urxvt::term> object, you can call all methods of the	428	Although it isn't a C<urxvt::term> object, you can call all methods of the
204	C<urxvt::term> class on this object.	429	C<urxvt::term> class on this object.
205		430
206	It has the following methods and data members:	431	It has the following methods and data members:
…		…
227	=head2 Hooks	452	=head2 Hooks
228		453
229	The following subroutines can be declared in extension files, and will be	454	The following subroutines can be declared in extension files, and will be
230	called whenever the relevant event happens.	455	called whenever the relevant event happens.
231		456
232	The first argument passed to them is an extension oject as described in	457	The first argument passed to them is an extension object as described in
233	the in the C<Extension Objects> section.	458	the in the C<Extension Objects> section.
234		459
235	B<All> of these hooks must return a boolean value. If it is true, then the	460	B<All> of these hooks must return a boolean value. If any of the called
236	event counts as being I<consumed>, and the invocation of other hooks is	461	hooks returns true, then the event counts as being I<consumed>, and the
237	skipped, and the relevant action might not be carried out by the C++ code.	462	relevant action might not be carried out by the C++ code.
238		463
239	I<< When in doubt, return a false value (preferably C<()>). >>	464	I<< When in doubt, return a false value (preferably C<()>). >>
240		465
241	=over 4	466	=over 4
242		467
243	=item on_init $term	468	=item on_init $term
244		469
245	Called after a new terminal object has been initialized, but before	470	Called after a new terminal object has been initialized, but before
246	windows are created or the command gets run. Most methods are unsafe to	471	windows are created or the command gets run. Most methods are unsafe to
247	call or deliver senseless data, as terminal size and other characteristics	472	call or deliver senseless data, as terminal size and other characteristics
248	have not yet been determined. You can safely query and change resources,	473	have not yet been determined. You can safely query and change resources
249	though.	474	and options, though. For many purposes the C<on_start> hook is a better
		475	place.
		476
		477	=item on_start $term
		478
		479	Called at the very end of initialisation of a new terminal, just before
		480	trying to map (display) the toplevel and returning to the main loop.
		481
		482	=item on_destroy $term
		483
		484	Called whenever something tries to destroy terminal, when the terminal is
		485	still fully functional (not for long, though).
250		486
251	=item on_reset $term	487	=item on_reset $term
252		488
253	Called after the screen is "reset" for any reason, such as resizing or	489	Called after the screen is "reset" for any reason, such as resizing or
254	control sequences. Here is where you can react on changes to size-related	490	control sequences. Here is where you can react on changes to size-related
255	variables.	491	variables.
256		492
257	=item on_start $term	493	=item on_child_start $term, $pid
258		494
259	Called at the very end of initialisation of a new terminal, just before	495	Called just after the child process has been C<fork>ed.
260	returning to the mainloop.	496
		497	=item on_child_exit $term, $status
		498
		499	Called just after the child process has exited. C<$status> is the status
		500	from C<waitpid>.
261		501
262	=item on_sel_make $term, $eventtime	502	=item on_sel_make $term, $eventtime
263		503
264	Called whenever a selection has been made by the user, but before the	504	Called whenever a selection has been made by the user, but before the
265	selection text is copied, so changes to the beginning, end or type of the	505	selection text is copied, so changes to the beginning, end or type of the
…		…
272		512
273	Called whenever a selection has been copied, but before the selection is	513	Called whenever a selection has been copied, but before the selection is
274	requested from the server. The selection text can be queried and changed	514	requested from the server. The selection text can be queried and changed
275	by calling C<< $term->selection >>.	515	by calling C<< $term->selection >>.
276		516
277	Returning a true value aborts selection grabbing. It will still be hilighted.	517	Returning a true value aborts selection grabbing. It will still be highlighted.
278		518
279	=item on_sel_extend $term	519	=item on_sel_extend $term
280		520
281	Called whenever the user tries to extend the selection (e.g. with a double	521	Called whenever the user tries to extend the selection (e.g. with a double
282	click) and is either supposed to return false (normal operation), or	522	click) and is either supposed to return false (normal operation), or
283	should extend the selection itelf and return true to suppress the built-in	523	should extend the selection itself and return true to suppress the built-in
284	processing. This can happen multiple times, as long as the callback	524	processing. This can happen multiple times, as long as the callback
285	returns true, it will be called on every further click by the user and is	525	returns true, it will be called on every further click by the user and is
286	supposed to enlarge the selection more and more, if possible.	526	supposed to enlarge the selection more and more, if possible.
287		527
288	See the F<selection> example extension.	528	See the F<selection> example extension.
289		529
290	=item on_view_change $term, $offset	530	=item on_view_change $term, $offset
291		531
292	Called whenever the view offset changes, i..e the user or program	532	Called whenever the view offset changes, i.e. the user or program
293	scrolls. Offset C<0> means display the normal terminal, positive values	533	scrolls. Offset C<0> means display the normal terminal, positive values
294	show this many lines of scrollback.	534	show this many lines of scrollback.
295		535
296	=item on_scroll_back $term, $lines, $saved	536	=item on_scroll_back $term, $lines, $saved
297		537
…		…
301		541
302	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	542	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
303	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	543	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
304	number of lines that will be in the scrollback buffer.	544	number of lines that will be in the scrollback buffer.
305		545
		546	=item on_osc_seq $term, $op, $args
		547
		548	Called on every OSC sequence and can be used to suppress it or modify its
		549	behaviour. The default should be to return an empty list. A true value
		550	suppresses execution of the request completely. Make sure you don't get
		551	confused by recursive invocations when you output an osc sequence within
		552	this callback.
		553
		554	C<on_osc_seq_perl> should be used for new behaviour.
		555
306	=item on_osc_seq $term, $string	556	=item on_osc_seq_perl $term, $string
307		557
308	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
309	operating system command) is processed. Cursor position and other state	559	operating system command) is processed. Cursor position and other state
310	information is up-to-date when this happens. For interoperability, the	560	information is up-to-date when this happens. For interoperability, the
311	string should start with the extension name and a colon, to distinguish	561	string should start with the extension name and a colon, to distinguish
312	it from commands for other extensions, and this might be enforced in the	562	it from commands for other extensions, and this might be enforced in the
313	future.	563	future.
314		564
315	Be careful not ever to trust (in a security sense) the data you receive,	565	Be careful not ever to trust (in a security sense) the data you receive,
316	as its source can not easily be controleld (e-mail content, messages from	566	as its source can not easily be controlled (e-mail content, messages from
317	other users on the same system etc.).	567	other users on the same system etc.).
318		568
319	=item on_add_lines $term, $string	569	=item on_add_lines $term, $string
320		570
321	Called whenever text is about to be output, with the text as argument. You	571	Called whenever text is about to be output, with the text as argument. You
…		…
352		602
353	=item on_refresh_end $term	603	=item on_refresh_end $term
354		604
355	Called just after the screen gets redrawn. See C<on_refresh_begin>.	605	Called just after the screen gets redrawn. See C<on_refresh_begin>.
356		606
357	=item on_keyboard_command $term, $string	607	=item on_user_command $term, $string
358		608
359	Called whenever the user presses a key combination that has a	609	Called whenever a user-configured event is being activated (e.g. via
360	C<perl:string> action bound to it (see description of the B<keysym>	610	a C<perl:string> action bound to a key, see description of the B<keysym>
361	resource in the @@RXVT_NAME@@(1) manpage).	611	resource in the @@RXVT_NAME@@(1) manpage).
		612
		613	The event is simply the action string. This interface is assumed to change
		614	slightly in the future.
		615
		616	=item on_resize_all_windows $tern, $new_width, $new_height
		617
		618	Called just after the new window size has been calculated, but before
		619	windows are actually being resized or hints are being set. If this hook
		620	returns TRUE, setting of the window hints is being skipped.
		621
		622	=item on_x_event $term, $event
		623
		624	Called on every X event received on the vt window (and possibly other
		625	windows). Should only be used as a last resort. Most event structure
		626	members are not passed.
		627
		628	=item on_root_event $term, $event
		629
		630	Like C<on_x_event>, but is called for events on the root window.
362		631
363	=item on_focus_in $term	632	=item on_focus_in $term
364		633
365	Called whenever the window gets the keyboard focus, before rxvt-unicode	634	Called whenever the window gets the keyboard focus, before rxvt-unicode
366	does focus in processing.	635	does focus in processing.
367		636
368	=item on_focus_out $term	637	=item on_focus_out $term
369		638
370	Called wheneever the window loses keyboard focus, before rxvt-unicode does	639	Called whenever the window loses keyboard focus, before rxvt-unicode does
371	focus out processing.	640	focus out processing.
		641
		642	=item on_configure_notify $term, $event
		643
		644	=item on_property_notify $term, $event
372		645
373	=item on_key_press $term, $event, $keysym, $octets	646	=item on_key_press $term, $event, $keysym, $octets
374		647
375	=item on_key_release $term, $event, $keysym	648	=item on_key_release $term, $event, $keysym
376		649
…		…
386		659
387	Called whenever the corresponding X event is received for the terminal If	660	Called whenever the corresponding X event is received for the terminal If
388	the hook returns true, then the even will be ignored by rxvt-unicode.	661	the hook returns true, then the even will be ignored by rxvt-unicode.
389		662
390	The event is a hash with most values as named by Xlib (see the XEvent	663	The event is a hash with most values as named by Xlib (see the XEvent
391	manpage), with the additional members C<row> and C<col>, which are the row	664	manpage), with the additional members C<row> and C<col>, which are the
392	and column under the mouse cursor.	665	(real, not screen-based) row and column under the mouse cursor.
393		666
394	C<on_key_press> additionally receives the string rxvt-unicode would	667	C<on_key_press> additionally receives the string rxvt-unicode would
395	output, if any, in locale-specific encoding.	668	output, if any, in locale-specific encoding.
396		669
397	subwindow.	670	subwindow.
		671
		672	=item on_client_message $term, $event
		673
		674	=item on_wm_protocols $term, $event
		675
		676	=item on_wm_delete_window $term, $event
		677
		678	Called when various types of ClientMessage events are received (all with
		679	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
398		680
399	=back	681	=back
400		682
401	=cut	683	=cut
402		684
…		…
408	use Scalar::Util ();	690	use Scalar::Util ();
409	use List::Util ();	691	use List::Util ();
410		692
411	our $VERSION = 1;	693	our $VERSION = 1;
412	our $TERM;	694	our $TERM;
		695	our @TERM_INIT;
		696	our @TERM_EXT;
413	our @HOOKNAME;	697	our @HOOKNAME;
414	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	698	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
415	our %OPTION;	699	our %OPTION;
416		700
417	our $LIBDIR;	701	our $LIBDIR;
418	our $RESNAME;	702	our $RESNAME;
419	our $RESCLASS;	703	our $RESCLASS;
420	our $RXVTNAME;	704	our $RXVTNAME;
421		705
		706	our $NOCHAR = chr 0xffff;
		707
422	=head2 Variables in the C<urxvt> Package	708	=head2 Variables in the C<urxvt> Package
423		709
424	=over 4	710	=over 4
425		711
426	=item $urxvt::LIBDIR	712	=item $urxvt::LIBDIR
…		…
438		724
439	=item $urxvt::TERM	725	=item $urxvt::TERM
440		726
441	The current terminal. This variable stores the current C<urxvt::term>	727	The current terminal. This variable stores the current C<urxvt::term>
442	object, whenever a callback/hook is executing.	728	object, whenever a callback/hook is executing.
		729
		730	=item @urxvt::TERM_INIT
		731
		732	All code references in this array will be called as methods of the next newly
		733	created C<urxvt::term> object (during the C<on_init> phase). The array
		734	gets cleared before the code references that were in it are being executed,
		735	so references can push themselves onto it again if they so desire.
		736
		737	This complements to the perl-eval command line option, but gets executed
		738	first.
		739
		740	=item @urxvt::TERM_EXT
		741
		742	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		743	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		744	but before other extensions. Gets cleared just like C<@TERM_INIT>.
443		745
444	=back	746	=back
445		747
446	=head2 Functions in the C<urxvt> Package	748	=head2 Functions in the C<urxvt> Package
447		749
…		…
462	Using this function has the advantage that its output ends up in the	764	Using this function has the advantage that its output ends up in the
463	correct place, e.g. on stderr of the connecting urxvtc client.	765	correct place, e.g. on stderr of the connecting urxvtc client.
464		766
465	Messages have a size limit of 1023 bytes currently.	767	Messages have a size limit of 1023 bytes currently.
466		768
467	=item $is_safe = urxvt::safe	769	=item @terms = urxvt::termlist
468		770
469	Returns true when it is safe to do potentially unsafe things, such as	771	Returns all urxvt::term objects that exist in this process, regardless of
470	evaluating perl code specified by the user. This is true when urxvt was	772	whether they are started, being destroyed etc., so be careful. Only term
471	started setuid or setgid.	773	objects that have perl extensions attached will be returned (because there
		774	is no urxvt::term objet associated with others).
472		775
473	=item $time = urxvt::NOW	776	=item $time = urxvt::NOW
474		777
475	Returns the "current time" (as per the event loop).	778	Returns the "current time" (as per the event loop).
476		779
477	=item urxvt::CurrentTime	780	=item urxvt::CurrentTime
478		781
479	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	782	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
480	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	783	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
481	Button4Mask, Button5Mask, AnyModifier	784	Button4Mask, Button5Mask, AnyModifier
		785
		786	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		787	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		788	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		789	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		790	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		791	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		792	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		793
		794	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		795	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		796	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		797	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		798	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		799	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		800	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
482		801
483	Various constants for use in X calls and event processing.	802	Various constants for use in X calls and event processing.
484		803
485	=back	804	=back
486		805
…		…
519		838
520	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	839	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
521		840
522	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	841	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
523		842
		843	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		844
524	Replace the foreground/background colour in the rendition mask with the	845	Replace the foreground/background colour in the rendition mask with the
525	specified one.	846	specified one.
526		847
527	=item $value = urxvt::GET_CUSTOM $rend	848	=item $value = urxvt::GET_CUSTOM $rend
528		849
…		…
537	=back	858	=back
538		859
539	=cut	860	=cut
540		861
541	BEGIN {	862	BEGIN {
542	urxvt->bootstrap;
543
544	# overwrite perl's warn	863	# overwrite perl's warn
545	*CORE::GLOBAL::warn = sub {	864	*CORE::GLOBAL::warn = sub {
546	my $msg = join "", @_;	865	my $msg = join "", @_;
547	$msg .= "\n"	866	$msg .= "\n"
548	unless $msg =~ /\n$/;	867	unless $msg =~ /\n$/;
549	urxvt::warn ($msg);	868	urxvt::warn ($msg);
550	};	869	};
551
552	# %ENV is the original startup environment
553	delete $ENV{IFS};
554	delete $ENV{CDPATH};
555	delete $ENV{BASH_ENV};
556	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
557	}	870	}
558		871
559	my @hook_count;	872	no warnings 'utf8';
		873
560	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	874	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
561		875
562	sub verbose {	876	sub verbose {
563	my ($level, $msg) = @_;	877	my ($level, $msg) = @_;
564	warn "$msg\n" if $level <= $verbosity;	878	warn "$msg\n" if $level <= $verbosity;
565	}	879	}
566		880
567	my $extension_pkg = "extension0000";
568	my %extension_pkg;	881	my %extension_pkg;
569		882
570	# load a single script into its own package, once only	883	# load a single script into its own package, once only
571	sub extension_package($) {	884	sub extension_package($) {
572	my ($path) = @_;	885	my ($path) = @_;
573		886
574	$extension_pkg{$path} ||= do {	887	$extension_pkg{$path} ||= do {
575	my $pkg = "urxvt::" . ($extension_pkg++);	888	$path =~ /([^\/\\]+)$/;
		889	my $pkg = $1;
		890	$pkg =~ s/[^[:word:]]/_/g;
		891	$pkg = "urxvt::ext::$pkg";
576		892
577	verbose 3, "loading extension '$path' into package '$pkg'";	893	verbose 3, "loading extension '$path' into package '$pkg'";
578		894
579	open my $fh, "<:raw", $path	895	open my $fh, "<:raw", $path
580	or die "$path: $!";	896	or die "$path: $!";
581		897
582	my $source = untaint	898	my $source =
583	"package $pkg; use strict; use utf8;\n"	899	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
584	. "use base urxvt::term::extension::;\n"
585	. "#line 1 \"$path\"\n{\n"	900	. "#line 1 \"$path\"\n{\n"
586	. (do { local $/; <$fh> })	901	. (do { local $/; <$fh> })
587	. "\n};\n1";	902	. "\n};\n1";
588		903
589	eval $source	904	eval $source
…		…
600	local $TERM = shift;	915	local $TERM = shift;
601	my $htype = shift;	916	my $htype = shift;
602		917
603	if ($htype == 0) { # INIT	918	if ($htype == 0) { # INIT
604	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	919	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
605		920
606	my %ext_arg;	921	my %ext_arg;
607		922
		923	{
		924	my @init = @TERM_INIT;
		925	@TERM_INIT = ();
		926	$_->($TERM) for @init;
		927	my @pkg = @TERM_EXT;
		928	@TERM_EXT = ();
		929	$TERM->register_package ($_) for @pkg;
		930	}
		931
608	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	932	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
609	if ($_ eq "default") {	933	if ($_ eq "default") {
610	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	934	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
611	} elsif (/^-(.*)$/) {	935	} elsif (/^-(.*)$/) {
612	delete $ext_arg{$1};	936	delete $ext_arg{$1};
613	} elsif (/^([^<]+)<(.*)>$/) {	937	} elsif (/^([^<]+)<(.*)>$/) {
614	push @{ $ext_arg{$1} }, $2;	938	push @{ $ext_arg{$1} }, $2;
615	} else {	939	} else {
616	$ext_arg{$_} ||= [];	940	$ext_arg{$_} ||= [];
617	}	941	}
618	}	942	}
619		943
620	while (my ($ext, $argv) = each %ext_arg) {	944	for my $ext (sort keys %ext_arg) {
621	my @files = grep -f $_, map "$_/$ext", @dirs;	945	my @files = grep -f $_, map "$_/$ext", @dirs;
622		946
623	if (@files) {	947	if (@files) {
624	$TERM->register_package (extension_package $files[0], $argv);	948	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
625	} else {	949	} else {
626	warn "perl extension '$ext' not found in perl library search path\n";	950	warn "perl extension '$ext' not found in perl library search path\n";
627	}	951	}
628	}	952	}
629		953
…		…
635		959
636	if (my $cb = $TERM->{_hook}[$htype]) {	960	if (my $cb = $TERM->{_hook}[$htype]) {
637	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	961	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
638	if $verbosity >= 10;	962	if $verbosity >= 10;
639		963
640	keys %$cb;	964	for my $pkg (keys %$cb) {
641
642	while (my ($pkg, $cb) = each %$cb) {
643	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	965	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
644	and last;	966	$retval ||= $retval_;
645		967
646	if ($@) {	968	if ($@) {
647	$TERM->ungrab; # better to lose the grab than the session	969	$TERM->ungrab; # better to lose the grab than the session
648	warn $@;	970	warn $@;
649	}	971	}
…		…
652	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	974	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
653	if $verbosity >= 11;	975	if $verbosity >= 11;
654	}	976	}
655		977
656	if ($htype == 1) { # DESTROY	978	if ($htype == 1) { # DESTROY
657	if (my $hook = delete $TERM->{_hook}) {
658	for my $htype (0..$#$hook) {
659	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
660	or set_should_invoke $htype, 0;
661	}
662	}
663
664	# clear package objects	979	# clear package objects
665	%$_ = () for values %{ $TERM->{_pkg} };	980	%$_ = () for values %{ $TERM->{_pkg} };
666		981
667	# clear package	982	# clear package
668	%$TERM = ();	983	%$TERM = ();
669	}	984	}
670		985
671	$retval	986	$retval
672	}	987	}
673		988
674	sub exec_async(@) {	989	sub SET_COLOR($$$) {
675	my $pid = fork;	990	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		991	}
676		992
677	return	993	sub rend2mask {
678	if !defined $pid or $pid;	994	no strict 'refs';
679		995	my ($str, $mask) = (@_, 0);
680	%ENV = %{ $TERM->env };	996	my %color = ( fg => undef, bg => undef );
681		997	my @failed;
682	exec @_;	998	for my $spec ( split /\s+/, $str ) {
683	_exit 255;	999	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1000	$color{lc($1)} = $2;
		1001	} else {
		1002	my $neg = $spec =~ s/^[-^]//;
		1003	unless ( exists &{"RS_$spec"} ) {
		1004	push @failed, $spec;
		1005	next;
		1006	}
		1007	my $cur = &{"RS_$spec"};
		1008	if ( $neg ) {
		1009	$mask &= ~$cur;
		1010	} else {
		1011	$mask |= $cur;
		1012	}
		1013	}
		1014	}
		1015	($mask, @color{qw(fg bg)}, \@failed)
684	}	1016	}
685		1017
686	# urxvt::term::extension	1018	# urxvt::term::extension
687		1019
688	package urxvt::term::extension;	1020	package urxvt::term::extension;
…		…
694	while (my ($name, $cb) = each %hook) {	1026	while (my ($name, $cb) = each %hook) {
695	my $htype = $HOOKTYPE{uc $name};	1027	my $htype = $HOOKTYPE{uc $name};
696	defined $htype	1028	defined $htype
697	or Carp::croak "unsupported hook type '$name'";	1029	or Carp::croak "unsupported hook type '$name'";
698		1030
		1031	$self->set_should_invoke ($htype, +1)
699	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1032	unless exists $self->{term}{_hook}[$htype]{$pkg};
700	$hook_count[$htype]++
701	or urxvt::set_should_invoke $htype, 1;
702	}
703		1033
704	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1034	$self->{term}{_hook}[$htype]{$pkg} = $cb;
705	}	1035	}
706	}	1036	}
707		1037
…		…
712	for my $name (@hook) {	1042	for my $name (@hook) {
713	my $htype = $HOOKTYPE{uc $name};	1043	my $htype = $HOOKTYPE{uc $name};
714	defined $htype	1044	defined $htype
715	or Carp::croak "unsupported hook type '$name'";	1045	or Carp::croak "unsupported hook type '$name'";
716		1046
		1047	$self->set_should_invoke ($htype, -1)
717	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1048	if delete $self->{term}{_hook}[$htype]{$pkg};
718	--$hook_count[$htype]
719	or urxvt::set_should_invoke $htype, 0;
720	}
721	}	1049	}
722	}	1050	}
723		1051
724	our $AUTOLOAD;	1052	our $AUTOLOAD;
725		1053
…		…
763	is that you cannot use blocking APIs, but the non-blocking variant should	1091	is that you cannot use blocking APIs, but the non-blocking variant should
764	work.	1092	work.
765		1093
766	=cut	1094	=cut
767		1095
768	our $VERSION = 1;	1096	our $VERSION = '3.4';
769		1097
770	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1098	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
771	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1099	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
772		1100
773	sub timer {	1101	sub timer {
…		…
804		1132
805	sub DESTROY {	1133	sub DESTROY {
806	$_[0][1]->stop;	1134	$_[0][1]->stop;
807	}	1135	}
808		1136
809	sub condvar {	1137	sub one_event {
810	bless \my $flag, urxvt::anyevent::condvar::
811	}
812
813	sub urxvt::anyevent::condvar::broadcast {
814	${$_[0]}++;
815	}
816
817	sub urxvt::anyevent::condvar::wait {
818	unless (${$_[0]}) {
819	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1138	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
820	}
821	}	1139	}
822		1140
823	package urxvt::term;	1141	package urxvt::term;
824		1142
825	=head2 The C<urxvt::term> Class	1143	=head2 The C<urxvt::term> Class
…		…
830		1148
831	# find on_xxx subs in the package and register them	1149	# find on_xxx subs in the package and register them
832	# as hooks	1150	# as hooks
833	sub register_package {	1151	sub register_package {
834	my ($self, $pkg, $argv) = @_;	1152	my ($self, $pkg, $argv) = @_;
		1153
		1154	no strict 'refs';
		1155
		1156	urxvt::verbose 6, "register package $pkg to $self";
		1157
		1158	@{"$pkg\::ISA"} = urxvt::term::extension::;
835		1159
836	my $proxy = bless {	1160	my $proxy = bless {
837	_pkg => $pkg,	1161	_pkg => $pkg,
838	argv => $argv,	1162	argv => $argv,
839	}, $pkg;	1163	}, $pkg;
…		…
855	hash which defines the environment of the new terminal.	1179	hash which defines the environment of the new terminal.
856		1180
857	Croaks (and probably outputs an error message) if the new instance	1181	Croaks (and probably outputs an error message) if the new instance
858	couldn't be created. Returns C<undef> if the new instance didn't	1182	couldn't be created. Returns C<undef> if the new instance didn't
859	initialise perl, and the terminal object otherwise. The C<init> and	1183	initialise perl, and the terminal object otherwise. The C<init> and
860	C<start> hooks will be called during this call.	1184	C<start> hooks will be called before this call returns, and are free to
		1185	refer to global data (which is race free).
861		1186
862	=cut	1187	=cut
863		1188
864	sub new {	1189	sub new {
865	my ($class, $env, @args) = @_;	1190	my ($class, $env, @args) = @_;
866		1191
		1192	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1193	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1194
867	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1195	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
868	}	1196	}
869		1197
870	=item $term->destroy	1198	=item $term->destroy
871		1199
872	Destroy the terminal object (close the window, free resources	1200	Destroy the terminal object (close the window, free resources
873	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1201	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
874	watchers (timers, io watchers) are still active.	1202	watchers (timers, io watchers) are still active.
875		1203
		1204	=item $term->exec_async ($cmd[, @args])
		1205
		1206	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1207	("starts") programs in the background. This function takes care of setting
		1208	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1209	be preferred over explicit calls to C<exec> or C<system>.
		1210
		1211	Returns the pid of the subprocess or C<undef> on error.
		1212
		1213	=cut
		1214
		1215	sub exec_async {
		1216	my $self = shift;
		1217
		1218	my $pid = fork;
		1219
		1220	return $pid
		1221	if !defined $pid or $pid;
		1222
		1223	%ENV = %{ $self->env };
		1224
		1225	exec @_;
		1226	urxvt::_exit 255;
		1227	}
		1228
876	=item $isset = $term->option ($optval[, $set])	1229	=item $isset = $term->option ($optval[, $set])
877		1230
878	Returns true if the option specified by C<$optval> is enabled, and	1231	Returns true if the option specified by C<$optval> is enabled, and
879	optionally change it. All option values are stored by name in the hash	1232	optionally change it. All option values are stored by name in the hash
880	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1233	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
881		1234
882	Here is a a likely non-exhaustive list of option names, please see the	1235	Here is a likely non-exhaustive list of option names, please see the
883	source file F</src/optinc.h> to see the actual list:	1236	source file F</src/optinc.h> to see the actual list:
884		1237
885	borderLess console cursorBlink cursorUnderline hold iconic insecure	1238	borderLess console cursorBlink cursorUnderline hold iconic insecure
886	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1239	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
887	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1240	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
888	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1241	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
889	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1242	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
890	tripleclickwords utmpInhibit visualBell	1243	transparent tripleclickwords utmpInhibit visualBell
891		1244
892	=item $value = $term->resource ($name[, $newval])	1245	=item $value = $term->resource ($name[, $newval])
893		1246
894	Returns the current resource value associated with a given name and	1247	Returns the current resource value associated with a given name and
895	optionally sets a new value. Setting values is most useful in the C<init>	1248	optionally sets a new value. Setting values is most useful in the C<init>
…		…
904	likely change).	1257	likely change).
905		1258
906	Please note that resource strings will currently only be freed when the	1259	Please note that resource strings will currently only be freed when the
907	terminal is destroyed, so changing options frequently will eat memory.	1260	terminal is destroyed, so changing options frequently will eat memory.
908		1261
909	Here is a a likely non-exhaustive list of resource names, not all of which	1262	Here is a likely non-exhaustive list of resource names, not all of which
910	are supported in every build, please see the source file F</src/rsinc.h>	1263	are supported in every build, please see the source file F</src/rsinc.h>
911	to see the actual list:	1264	to see the actual list:
912		1265
913	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1266	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
914	borderLess color cursorBlink cursorUnderline cutchars delete_key	1267	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
915	display_name embed ext_bwidth fade font geometry hold iconName	1268	display_name embed ext_bwidth fade font geometry hold iconName
916	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1269	imFont imLocale inputMethod insecure int_bwidth intensityStyles
917	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1270	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
918	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1271	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
919	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1272	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
920	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1273	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
921	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1274	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
922	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1275	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
923	shade term_name title transparent transparent_all tripleclickwords	1276	secondaryScreen secondaryScroll shade term_name title
924	utmpInhibit visualBell	1277	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1278	visualBell
925		1279
926	=cut	1280	=cut
927		1281
928	sub resource($$;$) {	1282	sub resource($$;$) {
929	my ($self, $name) = (shift, shift);	1283	my ($self, $name) = (shift, shift);
930	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1284	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
931	&urxvt::term::_resource	1285	goto &urxvt::term::_resource
932	}	1286	}
933		1287
934	=item $value = $term->x_resource ($pattern)	1288	=item $value = $term->x_resource ($pattern)
935		1289
936	Returns the X-Resource for the given pattern, excluding the program or	1290	Returns the X-Resource for the given pattern, excluding the program or
…		…
1103		1457
1104	Normally its not a good idea to use this function, as programs might be	1458	Normally its not a good idea to use this function, as programs might be
1105	confused by changes in cursor position or scrolling. Its useful inside a	1459	confused by changes in cursor position or scrolling. Its useful inside a
1106	C<on_add_lines> hook, though.	1460	C<on_add_lines> hook, though.
1107		1461
		1462	=item $term->scr_change_screen ($screen)
		1463
		1464	Switch to given screen - 0 primary, 1 secondary.
		1465
1108	=item $term->cmd_parse ($octets)	1466	=item $term->cmd_parse ($octets)
1109		1467
1110	Similar to C<scr_add_lines>, but the argument must be in the	1468	Similar to C<scr_add_lines>, but the argument must be in the
1111	locale-specific encoding of the terminal and can contain command sequences	1469	locale-specific encoding of the terminal and can contain command sequences
1112	(escape codes) that will be interpreted.	1470	(escape codes) that will be interpreted.
…		…
1122	Replaces the event mask of the pty watcher by the given event mask. Can	1480	Replaces the event mask of the pty watcher by the given event mask. Can
1123	be used to suppress input and output handling to the pty/tty. See the	1481	be used to suppress input and output handling to the pty/tty. See the
1124	description of C<< urxvt::timer->events >>. Make sure to always restore	1482	description of C<< urxvt::timer->events >>. Make sure to always restore
1125	the previous value.	1483	the previous value.
1126		1484
		1485	=item $fd = $term->pty_fd
		1486
		1487	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1488	is used.
		1489
1127	=item $windowid = $term->parent	1490	=item $windowid = $term->parent
1128		1491
1129	Return the window id of the toplevel window.	1492	Return the window id of the toplevel window.
1130		1493
1131	=item $windowid = $term->vt	1494	=item $windowid = $term->vt
1132		1495
1133	Return the window id of the terminal window.	1496	Return the window id of the terminal window.
1134		1497
		1498	=item $term->vt_emask_add ($x_event_mask)
		1499
		1500	Adds the specified events to the vt event mask. Useful e.g. when you want
		1501	to receive pointer events all the times:
		1502
		1503	$term->vt_emask_add (urxvt::PointerMotionMask);
		1504
		1505	=item $term->focus_in
		1506
		1507	=item $term->focus_out
		1508
		1509	=item $term->key_press ($state, $keycode[, $time])
		1510
		1511	=item $term->key_release ($state, $keycode[, $time])
		1512
		1513	Deliver various fake events to to terminal.
		1514
1135	=item $window_width = $term->width	1515	=item $window_width = $term->width
1136		1516
1137	=item $window_height = $term->height	1517	=item $window_height = $term->height
1138		1518
1139	=item $font_width = $term->fwidth	1519	=item $font_width = $term->fwidth
…		…
1152		1532
1153	=item $max_scrollback = $term->saveLines	1533	=item $max_scrollback = $term->saveLines
1154		1534
1155	=item $nrow_plus_saveLines = $term->total_rows	1535	=item $nrow_plus_saveLines = $term->total_rows
1156		1536
1157	=item $lines_in_scrollback = $term->nsaved	1537	=item $topmost_scrollback_row = $term->top_row
1158		1538
1159	Return various integers describing terminal characteristics.	1539	Return various integers describing terminal characteristics.
1160		1540
1161	=item $x_display = $term->display_id	1541	=item $x_display = $term->display_id
1162		1542
…		…
1169	=item $env = $term->env	1549	=item $env = $term->env
1170		1550
1171	Returns a copy of the environment in effect for the terminal as a hashref	1551	Returns a copy of the environment in effect for the terminal as a hashref
1172	similar to C<\%ENV>.	1552	similar to C<\%ENV>.
1173		1553
		1554	=item @envv = $term->envv
		1555
		1556	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1557
		1558	=item @argv = $term->argv
		1559
		1560	Return the argument vector as this terminal, similar to @ARGV, but
		1561	includes the program name as first element.
		1562
1174	=cut	1563	=cut
1175		1564
1176	sub env {	1565	sub env {
1177	if (my $env = $_[0]->_env) {
1178	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1566	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1179	} else {
1180	+{ %ENV }
1181	}
1182	}	1567	}
1183		1568
1184	=item $modifiermask = $term->ModLevel3Mask	1569	=item $modifiermask = $term->ModLevel3Mask
1185		1570
1186	=item $modifiermask = $term->ModMetaMask	1571	=item $modifiermask = $term->ModMetaMask
…		…
1188	=item $modifiermask = $term->ModNumLockMask	1573	=item $modifiermask = $term->ModNumLockMask
1189		1574
1190	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1575	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1191	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1576	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1192		1577
		1578	=item $screen = $term->current_screen
		1579
		1580	Returns the currently displayed screen (0 primary, 1 secondary).
		1581
		1582	=item $cursor_is_hidden = $term->hidden_cursor
		1583
		1584	Returns whether the cursor is currently hidden or not.
		1585
1193	=item $view_start = $term->view_start ([$newvalue])	1586	=item $view_start = $term->view_start ([$newvalue])
1194		1587
1195	Returns the negative row number of the topmost line. Minimum value is	1588	Returns the row number of the topmost displayed line. Maximum value is
1196	C<0>, which displays the normal terminal contents. Larger values scroll	1589	C<0>, which displays the normal terminal contents. Lower values scroll
1197	this many lines into the scrollback buffer.	1590	this many lines into the scrollback buffer.
1198		1591
1199	=item $term->want_refresh	1592	=item $term->want_refresh
1200		1593
1201	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1594	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1204		1597
1205	Used after changing terminal contents to display them.	1598	Used after changing terminal contents to display them.
1206		1599
1207	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1600	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1208		1601
1209	Returns the text of the entire row with number C<$row_number>. Row C<0>	1602	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1210	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1603	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1211	terminal line. The scrollback buffer starts at line C<-1> and extends to
1212	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1604	terminal line. Nothing will be returned if a nonexistent line
1213	is requested.	1605	is requested.
1214		1606
1215	If C<$new_text> is specified, it will replace characters in the current	1607	If C<$new_text> is specified, it will replace characters in the current
1216	line, starting at column C<$start_col> (default C<0>), which is useful	1608	line, starting at column C<$start_col> (default C<0>), which is useful
1217	to replace only parts of a line. The font index in the rendition will	1609	to replace only parts of a line. The font index in the rendition will
1218	automatically be updated.	1610	automatically be updated.
1219		1611
1220	C<$text> is in a special encoding: tabs and wide characters that use more	1612	C<$text> is in a special encoding: tabs and wide characters that use more
1221	than one cell when displayed are padded with urxvt::NOCHAR characters	1613	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1222	(C<chr 65535>). Characters with combining characters and other characters	1614	characters. Characters with combining characters and other characters that
1223	that do not fit into the normal tetx encoding will be replaced with	1615	do not fit into the normal text encoding will be replaced with characters
1224	characters in the private use area.	1616	in the private use area.
1225		1617
1226	You have to obey this encoding when changing text. The advantage is	1618	You have to obey this encoding when changing text. The advantage is
1227	that C<substr> and similar functions work on screen cells and not on	1619	that C<substr> and similar functions work on screen cells and not on
1228	characters.	1620	characters.
1229		1621
…		…
1373	where one character corresponds to one screen cell. See	1765	where one character corresponds to one screen cell. See
1374	C<< $term->ROW_t >> for details.	1766	C<< $term->ROW_t >> for details.
1375		1767
1376	=item $string = $term->special_decode $text	1768	=item $string = $term->special_decode $text
1377		1769
1378	Converts rxvt-unicodes text reprsentation into a perl string. See	1770	Converts rxvt-unicodes text representation into a perl string. See
1379	C<< $term->ROW_t >> for details.	1771	C<< $term->ROW_t >> for details.
1380		1772
1381	=item $success = $term->grab_button ($button, $modifiermask)	1773	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1382		1774
		1775	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1776
1383	Registers a synchronous button grab. See the XGrabButton manpage.	1777	Register/unregister a synchronous button grab. See the XGrabButton
		1778	manpage.
1384		1779
1385	=item $success = $term->grab ($eventtime[, $sync])	1780	=item $success = $term->grab ($eventtime[, $sync])
1386		1781
1387	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1782	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1388	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1783	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1389		1784
1390	=item $term->allow_events_async	1785	=item $term->allow_events_async
1391		1786
1392	Calls XAllowEvents with AsyncBoth for the most recent grab.	1787	Calls XAllowEvents with AsyncBoth for the most recent grab.
1393		1788
…		…
1403	=item $term->ungrab	1798	=item $term->ungrab
1404		1799
1405	Calls XUngrab for the most recent grab. Is called automatically on	1800	Calls XUngrab for the most recent grab. Is called automatically on
1406	evaluation errors, as it is better to lose the grab in the error case as	1801	evaluation errors, as it is better to lose the grab in the error case as
1407	the session.	1802	the session.
		1803
		1804	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1805
		1806	=item $atom_name = $term->XGetAtomName ($atom)
		1807
		1808	=item @atoms = $term->XListProperties ($window)
		1809
		1810	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1811
		1812	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1813
		1814	=item $term->XDeleteProperty ($window, $property)
		1815
		1816	=item $window = $term->DefaultRootWindow
		1817
		1818	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1819
		1820	=item $term->XMapWindow ($window)
		1821
		1822	=item $term->XUnmapWindow ($window)
		1823
		1824	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1825
		1826	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1827
		1828	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1829
		1830	Various X or X-related functions. The C<$term> object only serves as
		1831	the source of the display, otherwise those functions map more-or-less
		1832	directory onto the X functions of the same name.
1408		1833
1409	=back	1834	=back
1410		1835
1411	=cut	1836	=cut
1412		1837
…		…
1476	my ($self, $text, $cb) = @_;	1901	my ($self, $text, $cb) = @_;
1477		1902
1478	$self->add_item ({ type => "button", text => $text, activate => $cb});	1903	$self->add_item ({ type => "button", text => $text, activate => $cb});
1479	}	1904	}
1480		1905
1481	=item $popup->add_toggle ($text, $cb, $initial_value)	1906	=item $popup->add_toggle ($text, $initial_value, $cb)
1482		1907
1483	Adds a toggle/checkbox item to the popup. Teh callback gets called	1908	Adds a toggle/checkbox item to the popup. The callback gets called
1484	whenever it gets toggled, with a boolean indicating its value as its first	1909	whenever it gets toggled, with a boolean indicating its new value as its
1485	argument.	1910	first argument.
1486		1911
1487	=cut	1912	=cut
1488		1913
1489	sub add_toggle {	1914	sub add_toggle {
1490	my ($self, $text, $cb, $value) = @_;	1915	my ($self, $text, $value, $cb) = @_;
1491		1916
1492	my $item; $item = {	1917	my $item; $item = {
1493	type => "button",	1918	type => "button",
1494	text => " $text",	1919	text => " $text",
1495	value => $value,	1920	value => $value,
…		…
1514	my $env = $self->{term}->env;	1939	my $env = $self->{term}->env;
1515	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1940	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1516	delete $env->{LC_ALL};	1941	delete $env->{LC_ALL};
1517	$env->{LC_CTYPE} = $self->{term}->locale;	1942	$env->{LC_CTYPE} = $self->{term}->locale;
1518		1943
1519	urxvt::term->new ($env, $self->{term}->resource ("name"),	1944	my $term = urxvt::term->new (
1520	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1945	$env, "popup",
		1946	"--perl-lib" => "", "--perl-ext-common" => "",
		1947	"-pty-fd" => -1, "-sl" => 0,
		1948	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1521	"--transient-for" => $self->{term}->parent,	1949	"--transient-for" => $self->{term}->parent,
1522	"-display" => $self->{term}->display_id,	1950	"-display" => $self->{term}->display_id,
1523	"-pe" => "urxvt-popup")	1951	"-pe" => "urxvt-popup",
1524	or die "unable to create popup window\n";	1952	) or die "unable to create popup window\n";
		1953
		1954	unless (delete $term->{urxvt_popup_init_done}) {
		1955	$term->ungrab;
		1956	$term->destroy;
		1957	die "unable to initialise popup window\n";
		1958	}
1525	}	1959	}
1526		1960
1527	sub DESTROY {	1961	sub DESTROY {
1528	my ($self) = @_;	1962	my ($self) = @_;
1529		1963
1530	delete $self->{term}{_destroy}{$self};	1964	delete $self->{term}{_destroy}{$self};
1531	$self->{term}->ungrab;	1965	$self->{term}->ungrab;
1532	}	1966	}
1533		1967
1534	=back	1968	=back
		1969
		1970	=cut
		1971
		1972	package urxvt::watcher;
1535		1973
1536	=head2 The C<urxvt::timer> Class	1974	=head2 The C<urxvt::timer> Class
1537		1975
1538	This class implements timer watchers/events. Time is represented as a	1976	This class implements timer watchers/events. Time is represented as a
1539	fractional number of seconds since the epoch. Example:	1977	fractional number of seconds since the epoch. Example:
…		…
1543	->new	1981	->new
1544	->interval (1)	1982	->interval (1)
1545	->cb (sub {	1983	->cb (sub {
1546	$term->{overlay}->set (0, 0,	1984	$term->{overlay}->set (0, 0,
1547	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1985	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1548	});	1986	});
1549		1987
1550	=over 4	1988	=over 4
1551		1989
1552	=item $timer = new urxvt::timer	1990	=item $timer = new urxvt::timer
1553		1991
…		…
1577	Start the timer.	2015	Start the timer.
1578		2016
1579	=item $timer = $timer->start ($tstamp)	2017	=item $timer = $timer->start ($tstamp)
1580		2018
1581	Set the event trigger time to C<$tstamp> and start the timer.	2019	Set the event trigger time to C<$tstamp> and start the timer.
		2020
		2021	=item $timer = $timer->after ($delay)
		2022
		2023	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1582		2024
1583	=item $timer = $timer->stop	2025	=item $timer = $timer->stop
1584		2026
1585	Stop the timer.	2027	Stop the timer.
1586		2028
…		…
1592		2034
1593	$term->{socket} = ...	2035	$term->{socket} = ...
1594	$term->{iow} = urxvt::iow	2036	$term->{iow} = urxvt::iow
1595	->new	2037	->new
1596	->fd (fileno $term->{socket})	2038	->fd (fileno $term->{socket})
1597	->events (urxvt::EVENT_READ)	2039	->events (urxvt::EV_READ)
1598	->start	2040	->start
1599	->cb (sub {	2041	->cb (sub {
1600	my ($iow, $revents) = @_;	2042	my ($iow, $revents) = @_;
1601	# $revents must be 1 here, no need to check	2043	# $revents must be 1 here, no need to check
1602	sysread $term->{socket}, my $buf, 8192	2044	sysread $term->{socket}, my $buf, 8192
…		…
1615	Set the callback to be called when io events are triggered. C<$reventmask>	2057	Set the callback to be called when io events are triggered. C<$reventmask>
1616	is a bitset as described in the C<events> method.	2058	is a bitset as described in the C<events> method.
1617		2059
1618	=item $iow = $iow->fd ($fd)	2060	=item $iow = $iow->fd ($fd)
1619		2061
1620	Set the filedescriptor (not handle) to watch.	2062	Set the file descriptor (not handle) to watch.
1621		2063
1622	=item $iow = $iow->events ($eventmask)	2064	=item $iow = $iow->events ($eventmask)
1623		2065
1624	Set the event mask to watch. The only allowed values are	2066	Set the event mask to watch. The only allowed values are
1625	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2067	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1626	together, or C<urxvt::EVENT_NONE>.	2068	together, or C<urxvt::EV_NONE>.
1627		2069
1628	=item $iow = $iow->start	2070	=item $iow = $iow->start
1629		2071
1630	Start watching for requested events on the given handle.	2072	Start watching for requested events on the given handle.
1631		2073
1632	=item $iow = $iow->stop	2074	=item $iow = $iow->stop
1633		2075
1634	Stop watching for events on the given filehandle.	2076	Stop watching for events on the given file handle.
		2077
		2078	=back
		2079
		2080	=head2 The C<urxvt::iw> Class
		2081
		2082	This class implements idle watchers, that get called automatically when
		2083	the process is idle. They should return as fast as possible, after doing
		2084	some useful work.
		2085
		2086	=over 4
		2087
		2088	=item $iw = new urxvt::iw
		2089
		2090	Create a new idle watcher object in stopped state.
		2091
		2092	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2093
		2094	Set the callback to be called when the watcher triggers.
		2095
		2096	=item $timer = $timer->start
		2097
		2098	Start the watcher.
		2099
		2100	=item $timer = $timer->stop
		2101
		2102	Stop the watcher.
		2103
		2104	=back
		2105
		2106	=head2 The C<urxvt::pw> Class
		2107
		2108	This class implements process watchers. They create an event whenever a
		2109	process exits, after which they stop automatically.
		2110
		2111	my $pid = fork;
		2112	...
		2113	$term->{pw} = urxvt::pw
		2114	->new
		2115	->start ($pid)
		2116	->cb (sub {
		2117	my ($pw, $exit_status) = @_;
		2118	...
		2119	});
		2120
		2121	=over 4
		2122
		2123	=item $pw = new urxvt::pw
		2124
		2125	Create a new process watcher in stopped state.
		2126
		2127	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2128
		2129	Set the callback to be called when the timer triggers.
		2130
		2131	=item $pw = $timer->start ($pid)
		2132
		2133	Tells the watcher to start watching for process C<$pid>.
		2134
		2135	=item $pw = $pw->stop
		2136
		2137	Stop the watcher.
1635		2138
1636	=back	2139	=back
1637		2140
1638	=head1 ENVIRONMENT	2141	=head1 ENVIRONMENT
1639		2142
…		…
1648		2151
1649	=item >= 3 - script loading and management	2152	=item >= 3 - script loading and management
1650		2153
1651	=item >=10 - all called hooks	2154	=item >=10 - all called hooks
1652		2155
1653	=item >=11 - hook reutrn values	2156	=item >=11 - hook return values
1654		2157
1655	=back	2158	=back
1656		2159
1657	=head1 AUTHOR	2160	=head1 AUTHOR
1658		2161
…		…
1660	http://software.schmorp.de/pkg/rxvt-unicode	2163	http://software.schmorp.de/pkg/rxvt-unicode
1661		2164
1662	=cut	2165	=cut
1663		2166
1664	1	2167	1
		2168
		2169	# vim: sw=3:

Diff Legend

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