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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.137 by root, Sat Mar 4 20:17:52 2006 UTC vs.
Revision 1.213 by root, Wed Jun 6 15:09:49 2012 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
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
62	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
63	...	66	...
64		67
65	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
66	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
67	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
68	between two vertical bars:	71	between two vertical bars:
69		72
70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
71		74
72	Another example: Programs I use often output "absolute path: " at the	75	Another example: Programs I use often output "absolute path: " at the
…		…
98		101
99	Other extensions can extend this popup menu by pushing a code reference	102	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the	103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.	104	popup is being displayed.
102		105
103	It's sole argument is the popup menu, which can be modified. It should	106	Its sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code	107	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference	108	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as	109	will be called when the toggle changes, with the new boolean value as
107	first argument.	110	first argument.
108		111
109	The following will add an entry C<myoption> that changes	112	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:	113	C<< $self->{myoption} >>:
111		114
112	push @{ $self->{term}{option_popup_hook} }, sub {	115	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};	117	};
115		118
…		…
121		124
122	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.	127	popup is being displayed.
125		128
126	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
127	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.
128	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
129	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
130	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
131		134
132	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
133	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
134	C<a>s:	137	C<a>s:
135		138
136	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
138	: ()	141	: ()
139	};	142	};
140		143
141	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
142		145
…		…
149	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>
150	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
151	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
152	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
153	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
154	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.
155		164
156	=item readline (enabled by default)	165	=item readline (enabled by default)
157		166
158	A support package that tries to make editing with readline easier. At	167	A support package that tries to make editing with readline easier. At
159	the moment, it reacts to clicking shift-left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
160	move the text cursor to this position. It does so by generating as many	169	move the text cursor to this position. It does so by generating as many
161	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
162	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
163		172
164	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
165		174
166	=over 4	175	=over 4
…		…
214	the message into vi commands to load the file.	223	the message into vi commands to load the file.
215		224
216	=item tabbed	225	=item tabbed
217		226
218	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
219	is, it implements what is commonly refered to as "tabbed terminal". The topmost line	228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
220	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one	229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
221	button per tab.	230	button per tab.
222		231
223	Clicking a button will activate that tab. Pressing B<Shift-Left> and	232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
224	B<Shift-Right> will switch to the tab left or right of the current one,	233	B<Shift-Right> will switch to the tab left or right of the current one,
…		…
234	URxvt.tabbed.tab-bg: <colour-index, default 1>	243	URxvt.tabbed.tab-bg: <colour-index, default 1>
235		244
236	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid	245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
237	indices.	246	indices.
238		247
239	=item mark-urls	248	=item matcher
240		249
241	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
242	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
243	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
244	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 or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
		266	"perl:matcher:list" as seen in the example below.
		267
		268	Example configuration:
		269
		270	URxvt.perl-ext: default,matcher
		271	URxvt.urlLauncher: sensible-browser
		272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
		274	URxvt.matcher.button: 1
		275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		277	URxvt.matcher.launcher.2: gvim +$2 $1
245		278
246	=item xim-onthespot	279	=item xim-onthespot
247		280
248	This (experimental) perl extension implements OnTheSpot editing. It does	281	This (experimental) perl extension implements OnTheSpot editing. It does
249	not work perfectly, and some input methods don't seem to work well with	282	not work perfectly, and some input methods don't seem to work well with
250	OnTheSpot editing in general, but it seems to work at leats for SCIM and	283	OnTheSpot editing in general, but it seems to work at least for SCIM and
251	kinput2.	284	kinput2.
252		285
253	You enable it by specifying this extension and a preedit style of	286	You enable it by specifying this extension and a preedit style of
254	C<OnTheSpot>, i.e.:	287	C<OnTheSpot>, i.e.:
255		288
256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
257		290
258	=item automove-background	291	=item kuake<hotkey>
259		292
260	This is basically a one-line extension that dynamically changes the background pixmap offset	293	A very primitive quake-console-like extension. It was inspired by a
261	to the window position, in effect creating the same effect as pseudo transparency with	294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
262	a custom pixmap. No scaling is supported in this mode. Exmaple:	295	user presses a global accelerator key (by default C<F10>), the terminal
		296	will show or hide itself. Another press of the accelerator key will hide
		297	or show it again.
263		298
264	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	299	Initially, the window will not be shown when using this extension.
		300
		301	This is useful if you need a single terminal that is not using any desktop
		302	space most of the time but is quickly available at the press of a key.
		303
		304	The accelerator key is grabbed regardless of any modifiers, so this
		305	extension will actually grab a physical key just for this function.
		306
		307	If you want a quake-like animation, tell your window manager to do so
		308	(fvwm can do it).
		309
		310	=item overlay-osc
		311
		312	This extension implements some OSC commands to display timed popups on the
		313	screen - useful for status displays from within scripts. You have to read
		314	the sources for more info.
265		315
266	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
267		317
268	A not very useful example of filtering all text output to the terminal,	318	A not very useful example of filtering all text output to the terminal
269	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
270	similar-looking ascii character.	320	similar-looking ascii character.
271		321
272	=item digital-clock	322	=item digital-clock
273		323
274	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
275		325
276	=item remote-clipboard	326	=item remote-clipboard
277		327
278	Somewhat of a misnomer, this extension adds two menu entries to the	328	Somewhat of a misnomer, this extension adds two menu entries to the
279	selection popup that allows one ti run external commands to store the	329	selection popup that allows one to run external commands to store the
280	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
281		331
282	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
283	means that one command uploads the file to a remote server, and another	333	means that one command uploads the file to a remote server, and another
284	reads it.	334	reads it.
…		…
293	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
294	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
295		345
296	=item selection-pastebin	346	=item selection-pastebin
297		347
298	This is a little rarely useful extension that Uploads the selection as	348	This is a little rarely useful extension that uploads the selection as
299	textfile to a remote site (or does other things). (The implementation is	349	textfile to a remote site (or does other things). (The implementation is
300	not currently secure for use in a multiuser environment as it writes to	350	not currently secure for use in a multiuser environment as it writes to
301	F</tmp> directly.).	351	F</tmp> directly.).
302		352
303	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
320	in the C<selection-pastebin-url> resource (again, the % is the placeholder	370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
321	for the filename):	371	for the filename):
322		372
323	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
324		374
		375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		376	the double C</> characters as comment start. Use C<\057\057> instead,
		377	which works regardless of whether xrdb is used to parse the resource file
		378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
		393
325	=item example-refresh-hooks	394	=item example-refresh-hooks
326		395
327	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
328	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
329	overlays or changes.	398	overlays or changes.
		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
330		412
331	=back	413	=back
332		414
333	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
334		416
…		…
350		432
351	=over 4	433	=over 4
352		434
353	=item $text	435	=item $text
354		436
355	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
356	always represents one screen cell. See L<ROW_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
357		439
358	=item $string	440	=item $string
359		441
360	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
364	=item $octets	446	=item $octets
365		447
366	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
367	locale-specific way.	449	locale-specific way.
368		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
		456
369	=back	457	=back
370		458
371	=head2 Extension Objects	459	=head2 Extension Objects
372		460
373	Very perl extension is a perl class. A separate perl object is created	461	Every perl extension is a perl class. A separate perl object is created
374	for each terminal and each extension and passed as the first parameter to	462	for each terminal, and each terminal has its own set of extension objects,
375	hooks. So extensions can use their C<$self> object without having to think	463	which are passed as the first parameter to hooks. So extensions can use
376	about other extensions, with the exception of methods and members that	464	their C<$self> object without having to think about clashes with other
		465	extensions or other terminals, with the exception of methods and members
377	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
378	use.	467	internal use.
379		468
380	Although it isn't a C<urxvt::term> object, you can call all methods of the	469	Although it isn't a C<urxvt::term> object, you can call all methods of the
381	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
382		471
383	It has the following methods and data members:	472	It has the following methods and data members:
…		…
404	=head2 Hooks	493	=head2 Hooks
405		494
406	The following subroutines can be declared in extension files, and will be	495	The following subroutines can be declared in extension files, and will be
407	called whenever the relevant event happens.	496	called whenever the relevant event happens.
408		497
409	The first argument passed to them is an extension oject as described in	498	The first argument passed to them is an extension object as described in
410	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
411		500
412	B<All> of these hooks must return a boolean value. If any of the called	501	B<All> of these hooks must return a boolean value. If any of the called
413	hooks returns true, then the event counts as being I<consumed>, and the	502	hooks returns true, then the event counts as being I<consumed>, and the
414	relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
…		…
427	place.	516	place.
428		517
429	=item on_start $term	518	=item on_start $term
430		519
431	Called at the very end of initialisation of a new terminal, just before	520	Called at the very end of initialisation of a new terminal, just before
432	trying to map (display) the toplevel and returning to the mainloop.	521	trying to map (display) the toplevel and returning to the main loop.
433		522
434	=item on_destroy $term	523	=item on_destroy $term
435		524
436	Called whenever something tries to destroy terminal, when the terminal is	525	Called whenever something tries to destroy terminal, when the terminal is
437	still fully functional (not for long, though).	526	still fully functional (not for long, though).
…		…
464		553
465	Called whenever a selection has been copied, but before the selection is	554	Called whenever a selection has been copied, but before the selection is
466	requested from the server. The selection text can be queried and changed	555	requested from the server. The selection text can be queried and changed
467	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
468		557
469	Returning a true value aborts selection grabbing. It will still be hilighted.	558	Returning a true value aborts selection grabbing. It will still be highlighted.
470		559
471	=item on_sel_extend $term	560	=item on_sel_extend $term
472		561
473	Called whenever the user tries to extend the selection (e.g. with a double	562	Called whenever the user tries to extend the selection (e.g. with a double
474	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
475	should extend the selection itelf and return true to suppress the built-in	564	should extend the selection itself and return true to suppress the built-in
476	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
477	returns true, it will be called on every further click by the user and is	566	returns true, it will be called on every further click by the user and is
478	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
479		568
480	See the F<selection> example extension.	569	See the F<selection> example extension.
481		570
482	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
483		572
484	Called whenever the view offset changes, i..e the user or program	573	Called whenever the view offset changes, i.e. the user or program
485	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
486	show this many lines of scrollback.	575	show this many lines of scrollback.
487		576
488	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
489		578
…		…
493		582
494	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	583	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
495	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	584	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
496	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
497		586
498	=item on_osc_seq $term, $op, $args	587	=item on_osc_seq $term, $op, $args, $resp
499		588
500	Called on every OSC sequence and can be used to suppress it or modify its	589	Called on every OSC sequence and can be used to suppress it or modify its
501	behaviour. The default should be to return an empty list. A true value	590	behaviour. The default should be to return an empty list. A true value
502	suppresses execution of the request completely. Make sure you don't get	591	suppresses execution of the request completely. Make sure you don't get
503	confused by recursive invocations when you output an osc sequence within	592	confused by recursive invocations when you output an OSC sequence within
504	this callback.	593	this callback.
505		594
506	C<on_osc_seq_perl> should be used for new behaviour.	595	C<on_osc_seq_perl> should be used for new behaviour.
507		596
508	=item on_osc_seq_perl $term, $string	597	=item on_osc_seq_perl $term, $args, $resp
509		598
510	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
511	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
512	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
513	string should start with the extension name and a colon, to distinguish	602	string should start with the extension name (sans -osc) and a semicolon,
514	it from commands for other extensions, and this might be enforced in the	603	to distinguish it from commands for other extensions, and this might be
515	future.	604	enforced in the future.
		605
		606	For example, C<overlay-osc> uses this:
		607
		608	sub on_osc_seq_perl {
		609	my ($self, $osc, $resp) = @_;
		610
		611	return unless $osc =~ s/^overlay;//;
		612
		613	... process remaining $osc string
		614	}
516		615
517	Be careful not ever to trust (in a security sense) the data you receive,	616	Be careful not ever to trust (in a security sense) the data you receive,
518	as its source can not easily be controleld (e-mail content, messages from	617	as its source can not easily be controlled (e-mail content, messages from
519	other users on the same system etc.).	618	other users on the same system etc.).
		619
		620	For responses, C<$resp> contains the end-of-args separator used by the
		621	sender.
520		622
521	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
522		624
523	Called whenever text is about to be output, with the text as argument. You	625	Called whenever text is about to be output, with the text as argument. You
524	can filter/change and output the text yourself by returning a true value	626	can filter/change and output the text yourself by returning a true value
…		…
529	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
530		632
531	Called whenever some data is written to the tty/pty and can be used to	633	Called whenever some data is written to the tty/pty and can be used to
532	suppress or filter tty input.	634	suppress or filter tty input.
533		635
		636	=item on_tt_paste $term, $octets
		637
		638	Called whenever text is about to be pasted, with the text as argument. You
		639	can filter/change and paste the text yourself by returning a true value
		640	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		641	locale-encoded.
		642
534	=item on_line_update $term, $row	643	=item on_line_update $term, $row
535		644
536	Called whenever a line was updated or changed. Can be used to filter	645	Called whenever a line was updated or changed. Can be used to filter
537	screen output (e.g. underline urls or other useless stuff). Only lines	646	screen output (e.g. underline urls or other useless stuff). Only lines
538	that are being shown will be filtered, and, due to performance reasons,	647	that are being shown will be filtered, and, due to performance reasons,
…		…
545	later with the already-modified line (e.g. if unrelated parts change), so	654	later with the already-modified line (e.g. if unrelated parts change), so
546	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
547		656
548	=item on_refresh_begin $term	657	=item on_refresh_begin $term
549		658
550	Called just before the screen gets redrawn. Can be used for overlay	659	Called just before the screen gets redrawn. Can be used for overlay or
551	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
552	restoring them in refresh_end. The built-in overlay and selection display	661	restoring them in refresh_end. The built-in overlay and selection display
553	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
554		663
555	=item on_refresh_end $term	664	=item on_refresh_end $term
556		665
557	Called just after the screen gets redrawn. See C<on_refresh_begin>.	666	Called just after the screen gets redrawn. See C<on_refresh_begin>.
558		667
559	=item on_user_command $term, $string	668	=item on_user_command $term, $string
560		669
561	Called whenever the a user-configured event is being activated (e.g. via	670	Called whenever a user-configured event is being activated (e.g. via
562	a C<perl:string> action bound to a key, see description of the B<keysym>	671	a C<perl:string> action bound to a key, see description of the B<keysym>
563	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
564		673
565	The event is simply the action string. This interface is assumed to change	674	The event is simply the action string. This interface is assumed to change
566	slightly in the future.	675	slightly in the future.
567		676
		677	=item on_register_command $term, $keysym, $modifiermask, $string
		678
		679	Called after parsing a keysym resource but before registering the
		680	associated binding. If this hook returns TRUE the binding is not
		681	registered. It can be used to modify a binding by calling
		682	C<register_command>.
		683
568	=item on_resize_all_windows $tern, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
569		685
570	Called just after the new window size has been calculcated, but before	686	Called just after the new window size has been calculated, but before
571	windows are actually being resized or hints are being set. If this hook	687	windows are actually being resized or hints are being set. If this hook
572	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
573		689
574	=item on_x_event $term, $event	690	=item on_x_event $term, $event
575		691
576	Called on every X event received on the vt window (and possibly other	692	Called on every X event received on the vt window (and possibly other
577	windows). Should only be used as a last resort. Most event structure	693	windows). Should only be used as a last resort. Most event structure
578	members are not passed.	694	members are not passed.
579		695
		696	=item on_root_event $term, $event
		697
		698	Like C<on_x_event>, but is called for events on the root window.
		699
580	=item on_focus_in $term	700	=item on_focus_in $term
581		701
582	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
583	does focus in processing.	703	does focus in processing.
584		704
585	=item on_focus_out $term	705	=item on_focus_out $term
586		706
587	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
588	focus out processing.	708	focus out processing.
589		709
590	=item on_configure_notify $term, $event	710	=item on_configure_notify $term, $event
591		711
592	=item on_property_notify $term, $event	712	=item on_property_notify $term, $event
…		…
603		723
604	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
605		725
606	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
607		727
608	Called whenever the corresponding X event is received for the terminal If	728	Called whenever the corresponding X event is received for the terminal. If
609	the hook returns true, then the even will be ignored by rxvt-unicode.	729	the hook returns true, then the event will be ignored by rxvt-unicode.
610		730
611	The event is a hash with most values as named by Xlib (see the XEvent	731	The event is a hash with most values as named by Xlib (see the XEvent
612	manpage), with the additional members C<row> and C<col>, which are the	732	manpage), with the additional members C<row> and C<col>, which are the
613	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
614		734
…		…
623		743
624	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
625		745
626	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
627	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
628		752
629	=back	753	=back
630		754
631	=cut	755	=cut
632		756
…		…
638	use Scalar::Util ();	762	use Scalar::Util ();
639	use List::Util ();	763	use List::Util ();
640		764
641	our $VERSION = 1;	765	our $VERSION = 1;
642	our $TERM;	766	our $TERM;
643	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
644	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
645	our @HOOKNAME;	769	our @HOOKNAME;
646	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
647	our %OPTION;	771	our %OPTION;
648		772
649	our $LIBDIR;	773	our $LIBDIR;
…		…
675	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
676	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
677		801
678	=item @urxvt::TERM_INIT	802	=item @urxvt::TERM_INIT
679		803
680	All coderefs in this array will be called as methods of the next newly	804	All code references in this array will be called as methods of the next newly
681	created C<urxvt::term> object (during the C<on_init> phase). The array	805	created C<urxvt::term> object (during the C<on_init> phase). The array
682	gets cleared before the codereferences that were in it are being executed,	806	gets cleared before the code references that were in it are being executed,
683	so coderefs can push themselves onto it again if they so desire.	807	so references can push themselves onto it again if they so desire.
684		808
685	This complements to the perl-eval commandline option, but gets executed	809	This complements to the perl-eval command line option, but gets executed
686	first.	810	first.
687		811
688	=item @urxvt::TERM_EXT	812	=item @urxvt::TERM_EXT
689		813
690	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	814	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
697		821
698	=over 4	822	=over 4
699		823
700	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
701		825
702	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
703	costs! The only time this is acceptable is when the terminal process	827	include a trailing newline). Avoid at all costs! The only time this
704	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
705		830
706	=item urxvt::warn $string	831	=item urxvt::warn $string
707		832
708	Calls C<rxvt_warn> with the given string which should not include a	833	Calls C<rxvt_warn> with the given string which should include a trailing
709	newline. The module also overwrites the C<warn> builtin with a function	834	newline. The module also overwrites the C<warn> builtin with a function
710	that calls this function.	835	that calls this function.
711		836
712	Using this function has the advantage that its output ends up in the	837	Using this function has the advantage that its output ends up in the
713	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
715	Messages have a size limit of 1023 bytes currently.	840	Messages have a size limit of 1023 bytes currently.
716		841
717	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
718		843
719	Returns all urxvt::term objects that exist in this process, regardless of	844	Returns all urxvt::term objects that exist in this process, regardless of
720	wether they are started, being destroyed etc., so be careful. Only term	845	whether they are started, being destroyed etc., so be careful. Only term
721	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
722	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
723		848
724	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
725		850
726	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
727		852
…		…
770		895
771	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
772		897
773	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
774		899
775	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	900	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		901	urxvt::RS_RVid, urxvt::RS_Uline
776		902
777	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
778	underline, respectively. To enable such a style, just logically OR it into	904	underline, respectively. To enable such a style, just logically OR it into
779	the bitset.	905	the bitset.
780		906
…		…
817	};	943	};
818	}	944	}
819		945
820	no warnings 'utf8';	946	no warnings 'utf8';
821		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	my $r = $term->{meta}{resource};
		954	while (my ($pattern, $v) = each %$r) {
		955	$name =~ y/-/./ if $isarg;
		956
		957	if (
		958	$pattern =~ /\.$/
		959	? $pattern eq substr $name, 0, length $pattern
		960	: $pattern eq $name
		961	) {
		962	$name = "$urxvt::RESCLASS.$name";
		963
		964	push @TERM_EXT, $v->[0];
		965
		966	if ($v->[1] eq "boolean") {
		967	$term->put_option_db ($name, $flag ? "true" : "false");
		968	return 1;
		969	} else {
		970	$term->put_option_db ($name, $value);
		971	return 1 + 2;
		972	}
		973	}
		974	}
		975
		976	0
		977	}
		978
		979	sub usage {
		980	my ($term, $usage_type) = @_;
		981
		982	$term->scan_meta;
		983
		984	my $r = $term->{meta}{resource};
		985
		986	for my $pattern (sort keys %$r) {
		987	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		988
		989	$desc .= " (-pe $ext)";
		990
		991	if ($usage_type == 1) {
		992	$pattern =~ y/./-/;
		993	$pattern =~ s/-$/-.../g;
		994
		995	if ($type eq "boolean") {
		996	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		997	} else {
		998	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		999	}
		1000	} else {
		1001	$pattern =~ s/\.$/.*/g;
		1002	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1003	}
		1004	}
		1005	}
		1006
822	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1007	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
823		1008
824	sub verbose {	1009	sub verbose {
825	my ($level, $msg) = @_;	1010	my ($level, $msg) = @_;
826	warn "$msg\n" if $level <= $verbosity;	1011	warn "$msg\n" if $level <= $verbosity;
…		…
862	sub invoke {	1047	sub invoke {
863	local $TERM = shift;	1048	local $TERM = shift;
864	my $htype = shift;	1049	my $htype = shift;
865		1050
866	if ($htype == 0) { # INIT	1051	if ($htype == 0) { # INIT
867	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1052	my @dirs = $TERM->perl_libdirs;
868		1053
869	my %ext_arg;	1054	my %ext_arg;
870		1055
871	{	1056	{
872	my @init = @TERM_INIT;	1057	my @init = @TERM_INIT;
873	@TERM_INIT = ();	1058	@TERM_INIT = ();
…		…
907		1092
908	if (my $cb = $TERM->{_hook}[$htype]) {	1093	if (my $cb = $TERM->{_hook}[$htype]) {
909	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1094	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
910	if $verbosity >= 10;	1095	if $verbosity >= 10;
911		1096
912	keys %$cb;	1097	for my $pkg (keys %$cb) {
913
914	while (my ($pkg, $cb) = each %$cb) {
915	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1098	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
916	$retval \|\|= $retval_;	1099	$retval \|\|= $retval_;
917		1100
918	if ($@) {	1101	if ($@) {
919	$TERM->ungrab; # better to lose the grab than the session	1102	$TERM->ungrab; # better to lose the grab than the session
920	warn $@;	1103	warn $@;
…		…
936	$retval	1119	$retval
937	}	1120	}
938		1121
939	sub SET_COLOR($$$) {	1122	sub SET_COLOR($$$) {
940	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1123	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1124	}
		1125
		1126	sub rend2mask {
		1127	no strict 'refs';
		1128	my ($str, $mask) = (@_, 0);
		1129	my %color = ( fg => undef, bg => undef );
		1130	my @failed;
		1131	for my $spec ( split /\s+/, $str ) {
		1132	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1133	$color{lc($1)} = $2;
		1134	} else {
		1135	my $neg = $spec =~ s/^[-^]//;
		1136	unless ( exists &{"RS_$spec"} ) {
		1137	push @failed, $spec;
		1138	next;
		1139	}
		1140	my $cur = &{"RS_$spec"};
		1141	if ( $neg ) {
		1142	$mask &= ~$cur;
		1143	} else {
		1144	$mask \|= $cur;
		1145	}
		1146	}
		1147	}
		1148	($mask, @color{qw(fg bg)}, \@failed)
941	}	1149	}
942		1150
943	# urxvt::term::extension	1151	# urxvt::term::extension
944		1152
945	package urxvt::term::extension;	1153	package urxvt::term::extension;
…		…
1010	=head2 The C<urxvt::anyevent> Class	1218	=head2 The C<urxvt::anyevent> Class
1011		1219
1012	The sole purpose of this class is to deliver an interface to the	1220	The sole purpose of this class is to deliver an interface to the
1013	C<AnyEvent> module - any module using it will work inside urxvt without	1221	C<AnyEvent> module - any module using it will work inside urxvt without
1014	further programming. The only exception is that you cannot wait on	1222	further programming. The only exception is that you cannot wait on
1015	condition variables, but non-blocking condvar use is ok. What this means	1223	condition variables, but non-blocking condvar use is ok.
1016	is that you cannot use blocking APIs, but the non-blocking variant should	1224
1017	work.	1225	In practical terms this means is that you cannot use blocking APIs, but
		1226	the non-blocking variant should work.
1018		1227
1019	=cut	1228	=cut
1020		1229
1021	our $VERSION = 1;	1230	our $VERSION = '5.23';
1022		1231
1023	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1232	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1024	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1233	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1025		1234
1026	sub timer {	1235	sub timer {
…		…
1028		1237
1029	my $cb = $arg{cb};	1238	my $cb = $arg{cb};
1030		1239
1031	urxvt::timer	1240	urxvt::timer
1032	->new	1241	->new
1033	->start (urxvt::NOW + $arg{after})	1242	->after ($arg{after}, $arg{interval})
1034	->cb (sub {	1243	->cb ($arg{interval} ? $cb : sub {
1035	$_[0]->stop; # need to cancel manually	1244	$_[0]->stop; # need to cancel manually
1036	$cb->();	1245	$cb->();
1037	})	1246	})
1038	}	1247	}
1039		1248
1040	sub io {	1249	sub io {
1041	my ($class, %arg) = @_;	1250	my ($class, %arg) = @_;
1042		1251
1043	my $cb = $arg{cb};	1252	my $cb = $arg{cb};
		1253	my $fd = fileno $arg{fh};
		1254	defined $fd or $fd = $arg{fh};
1044		1255
1045	bless [$arg{fh}, urxvt::iow	1256	bless [$arg{fh}, urxvt::iow
1046	->new	1257	->new
1047	->fd (fileno $arg{fh})	1258	->fd ($fd)
1048	->events (($arg{poll} =~ /r/ ? 1 : 0)	1259	->events (($arg{poll} =~ /r/ ? 1 : 0)
1049	\| ($arg{poll} =~ /w/ ? 2 : 0))	1260	\| ($arg{poll} =~ /w/ ? 2 : 0))
1050	->start	1261	->start
1051	->cb (sub {	1262	->cb ($cb)
1052	$cb->(($_[1] & 1 ? 'r' : '')
1053	. ($_[1] & 2 ? 'w' : ''));
1054	})],
1055	urxvt::anyevent::	1263	], urxvt::anyevent::
		1264	}
		1265
		1266	sub idle {
		1267	my ($class, %arg) = @_;
		1268
		1269	my $cb = $arg{cb};
		1270
		1271	urxvt::iw
		1272	->new
		1273	->start
		1274	->cb ($cb)
		1275	}
		1276
		1277	sub child {
		1278	my ($class, %arg) = @_;
		1279
		1280	my $cb = $arg{cb};
		1281
		1282	urxvt::pw
		1283	->new
		1284	->start ($arg{pid})
		1285	->cb (sub {
		1286	$_[0]->stop; # need to cancel manually
		1287	$cb->($_[0]->rpid, $_[0]->rstatus);
		1288	})
1056	}	1289	}
1057		1290
1058	sub DESTROY {	1291	sub DESTROY {
1059	$_[0][1]->stop;	1292	$_[0][1]->stop;
1060	}	1293	}
1061		1294
1062	sub condvar {	1295	# only needed for AnyEvent < 6 compatibility
1063	bless \my $flag, urxvt::anyevent::condvar::	1296	sub one_event {
1064	}
1065
1066	sub urxvt::anyevent::condvar::broadcast {
1067	${$_[0]}++;
1068	}
1069
1070	sub urxvt::anyevent::condvar::wait {
1071	unless (${$_[0]}) {
1072	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1297	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1073	}
1074	}	1298	}
1075		1299
1076	package urxvt::term;	1300	package urxvt::term;
1077		1301
1078	=head2 The C<urxvt::term> Class	1302	=head2 The C<urxvt::term> Class
…		…
1105	$proxy->enable ($name => $ref);	1329	$proxy->enable ($name => $ref);
1106	}	1330	}
1107	}	1331	}
1108	}	1332	}
1109		1333
		1334	sub perl_libdirs {
		1335	map { split /:/ }
		1336	$_[0]->resource ("perl_lib"),
		1337	$ENV{URXVT_PERL_LIB},
		1338	"$ENV{HOME}/.urxvt/ext",
		1339	"$LIBDIR/perl"
		1340	}
		1341
		1342	sub scan_meta {
		1343	my ($self) = @_;
		1344	my @libdirs = perl_libdirs $self;
		1345
		1346	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1347
		1348	my %meta;
		1349
		1350	$self->{meta_libdirs} = join "\x00", @libdirs;
		1351	$self->{meta} = \%meta;
		1352
		1353	for my $dir (reverse @libdirs) {
		1354	opendir my $fh, $dir
		1355	or next;
		1356	for my $ext (readdir $fh) {
		1357	$ext ne "."
		1358	and $ext ne ".."
		1359	and open my $fh, "<", "$dir/$ext"
		1360	or next;
		1361
		1362	while (<$fh>) {
		1363	if (/^#:META:X_RESOURCE:(.*)/) {
		1364	my ($pattern, $type, $desc) = split /:/, $1;
		1365	$pattern =~ s/^%(?:\.\|$)/$ext./g; # % in pattern == extension name
		1366	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1367	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1368	} else {
		1369	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1370	}
		1371	} elsif (/^\s*(?:#\|$)/) {
		1372	# skip other comments and empty lines
		1373	} else {
		1374	last; # stop parsing on first non-empty non-comment line
		1375	}
		1376	}
		1377	}
		1378	}
		1379	}
		1380
1110	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1381	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1111		1382
1112	Creates a new terminal, very similar as if you had started it with system	1383	Creates a new terminal, very similar as if you had started it with system
1113	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1384	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1114	hash which defines the environment of the new terminal.	1385	hash which defines the environment of the new terminal.
…		…
1165		1436
1166	Returns true if the option specified by C<$optval> is enabled, and	1437	Returns true if the option specified by C<$optval> is enabled, and
1167	optionally change it. All option values are stored by name in the hash	1438	optionally change it. All option values are stored by name in the hash
1168	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1439	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1169		1440
1170	Here is a a likely non-exhaustive list of option names, please see the	1441	Here is a likely non-exhaustive list of option names, please see the
1171	source file F</src/optinc.h> to see the actual list:	1442	source file F</src/optinc.h> to see the actual list:
1172		1443
1173	borderLess console cursorBlink cursorUnderline hold iconic insecure	1444	borderLess buffered console cursorBlink cursorUnderline hold iconic
1174	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1445	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1175	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1446	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1176	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1447	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1177	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1448	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1178	transparent tripleclickwords utmpInhibit visualBell	1449	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1450	urgentOnBell utmpInhibit visualBell
1179		1451
1180	=item $value = $term->resource ($name[, $newval])	1452	=item $value = $term->resource ($name[, $newval])
1181		1453
1182	Returns the current resource value associated with a given name and	1454	Returns the current resource value associated with a given name and
1183	optionally sets a new value. Setting values is most useful in the C<init>	1455	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1192	likely change).	1464	likely change).
1193		1465
1194	Please note that resource strings will currently only be freed when the	1466	Please note that resource strings will currently only be freed when the
1195	terminal is destroyed, so changing options frequently will eat memory.	1467	terminal is destroyed, so changing options frequently will eat memory.
1196		1468
1197	Here is a a likely non-exhaustive list of resource names, not all of which	1469	Here is a likely non-exhaustive list of resource names, not all of which
1198	are supported in every build, please see the source file F</src/rsinc.h>	1470	are supported in every build, please see the source file F</src/rsinc.h>
1199	to see the actual list:	1471	to see the actual list:
1200		1472
1201	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1473	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1202	borderLess color cursorBlink cursorUnderline cutchars delete_key	1474	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1203	display_name embed ext_bwidth fade font geometry hold iconName	1475	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1204	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1476	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1477	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1205	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1478	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1206	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1479	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1207	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1480	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1208	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1481	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1209	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1482	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1210	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1483	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1211	secondaryScreen secondaryScroll selectstyle shade term_name title	1484	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1212	transient_for transparent transparent_all tripleclickwords utmpInhibit	1485	term_name title transient_for transparent tripleclickwords urgentOnBell
1213	visualBell	1486	utmpInhibit visualBell
1214		1487
1215	=cut	1488	=cut
1216		1489
1217	sub resource($$;$) {	1490	sub resource($$;$) {
1218	my ($self, $name) = (shift, shift);	1491	my ($self, $name) = (shift, shift);
1219	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1492	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1220	&urxvt::term::_resource	1493	goto &urxvt::term::_resource
1221	}	1494	}
1222		1495
1223	=item $value = $term->x_resource ($pattern)	1496	=item $value = $term->x_resource ($pattern)
1224		1497
1225	Returns the X-Resource for the given pattern, excluding the program or	1498	Returns the X-Resource for the given pattern, excluding the program or
…		…
1229		1502
1230	This method should only be called during the C<on_start> hook, as there is	1503	This method should only be called during the C<on_start> hook, as there is
1231	only one resource database per display, and later invocations might return	1504	only one resource database per display, and later invocations might return
1232	the wrong resources.	1505	the wrong resources.
1233		1506
1234	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1507	=item $value = $term->x_resource_boolean ($pattern)
1235		1508
		1509	Like C<x_resource>, above, but interprets the string value as a boolean
		1510	and returns C<1> for true values, C<0> for false values and C<undef> if
		1511	the resource or option isn't specified.
		1512
		1513	You should always use this method to parse boolean resources.
		1514
		1515	=cut
		1516
		1517	sub x_resource_boolean {
		1518	my $res = &x_resource;
		1519
		1520	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1521	}
		1522
		1523	=item $success = $term->parse_keysym ($key, $octets)
		1524
1236	Adds a keymap translation exactly as specified via a resource. See the	1525	Adds a key binding exactly as specified via a resource. See the
1237	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1526	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1527
		1528	=item $term->register_command ($keysym, $modifiermask, $string)
		1529
		1530	Adds a key binding. This is a lower level api compared to
		1531	C<parse_keysym>, as it expects a parsed key description, and can be
		1532	used only inside either the C<on_init> hook, to add a binding, or the
		1533	C<on_register_command> hook, to modify a parsed binding.
1238		1534
1239	=item $rend = $term->rstyle ([$new_rstyle])	1535	=item $rend = $term->rstyle ([$new_rstyle])
1240		1536
1241	Return and optionally change the current rendition. Text that is output by	1537	Return and optionally change the current rendition. Text that is output by
1242	the terminal application will use this style.	1538	the terminal application will use this style.
…		…
1250		1546
1251	=item ($row, $col) = $term->selection_beg ([$row, $col])	1547	=item ($row, $col) = $term->selection_beg ([$row, $col])
1252		1548
1253	=item ($row, $col) = $term->selection_end ([$row, $col])	1549	=item ($row, $col) = $term->selection_end ([$row, $col])
1254		1550
1255	Return the current values of the selection mark, begin or end positions,	1551	Return the current values of the selection mark, begin or end positions.
1256	and optionally set them to new values.	1552
		1553	When arguments are given, then the selection coordinates are set to
		1554	C<$row> and C<$col>, and the selection screen is set to the current
		1555	screen.
		1556
		1557	=item $screen = $term->selection_screen ([$screen])
		1558
		1559	Returns the current selection screen, and then optionally sets it.
1257		1560
1258	=item $term->selection_make ($eventtime[, $rectangular])	1561	=item $term->selection_make ($eventtime[, $rectangular])
1259		1562
1260	Tries to make a selection as set by C<selection_beg> and	1563	Tries to make a selection as set by C<selection_beg> and
1261	C<selection_end>. If C<$rectangular> is true (default: false), a	1564	C<selection_end>. If C<$rectangular> is true (default: false), a
1262	rectangular selection will be made. This is the prefered function to make	1565	rectangular selection will be made. This is the preferred function to make
1263	a selection.	1566	a selection.
1264		1567
1265	=item $success = $term->selection_grab ($eventtime)	1568	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1266		1569
1267	Try to request the primary selection text from the server (for example, as	1570	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1571	true) selection from the server. The corresponding text can be set
1268	set by the next method). No visual feedback will be given. This function	1572	with the next method. No visual feedback will be given. This function
1269	is mostly useful from within C<on_sel_grab> hooks.	1573	is mostly useful from within C<on_sel_grab> hooks.
1270		1574
1271	=item $oldtext = $term->selection ([$newtext])	1575	=item $oldtext = $term->selection ([$newtext, $clipboard])
1272		1576
1273	Return the current selection text and optionally replace it by C<$newtext>.	1577	Return the current selection (clipboard if C<$clipboard> is true) text
		1578	and optionally replace it by C<$newtext>.
		1579
		1580	=item $term->selection_clear ([$clipboard])
		1581
		1582	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1274		1583
1275	=item $term->overlay_simple ($x, $y, $text)	1584	=item $term->overlay_simple ($x, $y, $text)
1276		1585
1277	Create a simple multi-line overlay box. See the next method for details.	1586	Create a simple multi-line overlay box. See the next method for details.
1278		1587
…		…
1308		1617
1309	The methods currently supported on C<urxvt::overlay> objects are:	1618	The methods currently supported on C<urxvt::overlay> objects are:
1310		1619
1311	=over 4	1620	=over 4
1312		1621
1313	=item $overlay->set ($x, $y, $text, $rend)	1622	=item $overlay->set ($x, $y, $text[, $rend])
1314		1623
1315	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1624	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1316	text in rxvt-unicode's special encoding and an array of rendition values	1625	text in rxvt-unicode's special encoding and an array of rendition values
1317	at a specific position inside the overlay.	1626	at a specific position inside the overlay.
		1627
		1628	If C<$rend> is missing, then the rendition will not be changed.
1318		1629
1319	=item $overlay->hide	1630	=item $overlay->hide
1320		1631
1321	If visible, hide the overlay, but do not destroy it.	1632	If visible, hide the overlay, but do not destroy it.
1322		1633
…		…
1404	locale-specific encoding of the terminal and can contain command sequences	1715	locale-specific encoding of the terminal and can contain command sequences
1405	(escape codes) that will be interpreted.	1716	(escape codes) that will be interpreted.
1406		1717
1407	=item $term->tt_write ($octets)	1718	=item $term->tt_write ($octets)
1408		1719
1409	Write the octets given in C<$data> to the tty (i.e. as program input). To	1720	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1410	pass characters instead of octets, you should convert your strings first	1721	pass characters instead of octets, you should convert your strings first
1411	to the locale-specific encoding using C<< $term->locale_encode >>.	1722	to the locale-specific encoding using C<< $term->locale_encode >>.
		1723
		1724	=item $term->tt_paste ($octets)
		1725
		1726	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1727	CR and bracketing the data with control sequences if bracketed paste mode
		1728	is set.
1412		1729
1413	=item $old_events = $term->pty_ev_events ([$new_events])	1730	=item $old_events = $term->pty_ev_events ([$new_events])
1414		1731
1415	Replaces the event mask of the pty watcher by the given event mask. Can	1732	Replaces the event mask of the pty watcher by the given event mask. Can
1416	be used to suppress input and output handling to the pty/tty. See the	1733	be used to suppress input and output handling to the pty/tty. See the
…		…
1435	Adds the specified events to the vt event mask. Useful e.g. when you want	1752	Adds the specified events to the vt event mask. Useful e.g. when you want
1436	to receive pointer events all the times:	1753	to receive pointer events all the times:
1437		1754
1438	$term->vt_emask_add (urxvt::PointerMotionMask);	1755	$term->vt_emask_add (urxvt::PointerMotionMask);
1439		1756
		1757	=item $term->set_urgency ($set)
		1758
		1759	Enable/disable the urgency hint on the toplevel window.
		1760
1440	=item $term->focus_in	1761	=item $term->focus_in
1441		1762
1442	=item $term->focus_out	1763	=item $term->focus_out
1443		1764
1444	=item $term->key_press ($state, $keycode[, $time])	1765	=item $term->key_press ($state, $keycode[, $time])
…		…
1514		1835
1515	Returns the currently displayed screen (0 primary, 1 secondary).	1836	Returns the currently displayed screen (0 primary, 1 secondary).
1516		1837
1517	=item $cursor_is_hidden = $term->hidden_cursor	1838	=item $cursor_is_hidden = $term->hidden_cursor
1518		1839
1519	Returns wether the cursor is currently hidden or not.	1840	Returns whether the cursor is currently hidden or not.
1520		1841
1521	=item $view_start = $term->view_start ([$newvalue])	1842	=item $view_start = $term->view_start ([$newvalue])
1522		1843
1523	Returns the row number of the topmost displayed line. Maximum value is	1844	Returns the row number of the topmost displayed line. Maximum value is
1524	C<0>, which displays the normal terminal contents. Lower values scroll	1845	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1532		1853
1533	Used after changing terminal contents to display them.	1854	Used after changing terminal contents to display them.
1534		1855
1535	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1856	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1536		1857
1537	Returns the text of the entire row with number C<$row_number>. Row C<0>	1858	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1538	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1859	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1539	terminal line. The scrollback buffer starts at line C<-1> and extends to
1540	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1860	terminal line. Nothing will be returned if a nonexistent line
1541	is requested.	1861	is requested.
1542		1862
1543	If C<$new_text> is specified, it will replace characters in the current	1863	If C<$new_text> is specified, it will replace characters in the current
1544	line, starting at column C<$start_col> (default C<0>), which is useful	1864	line, starting at column C<$start_col> (default C<0>), which is useful
1545	to replace only parts of a line. The font index in the rendition will	1865	to replace only parts of a line. The font index in the rendition will
1546	automatically be updated.	1866	automatically be updated.
1547		1867
1548	C<$text> is in a special encoding: tabs and wide characters that use more	1868	C<$text> is in a special encoding: tabs and wide characters that use more
1549	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1869	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1550	characters. Characters with combining characters and other characters that	1870	characters. Characters with combining characters and other characters that
1551	do not fit into the normal tetx encoding will be replaced with characters	1871	do not fit into the normal text encoding will be replaced with characters
1552	in the private use area.	1872	in the private use area.
1553		1873
1554	You have to obey this encoding when changing text. The advantage is	1874	You have to obey this encoding when changing text. The advantage is
1555	that C<substr> and similar functions work on screen cells and not on	1875	that C<substr> and similar functions work on screen cells and not on
1556	characters.	1876	characters.
…		…
1701	where one character corresponds to one screen cell. See	2021	where one character corresponds to one screen cell. See
1702	C<< $term->ROW_t >> for details.	2022	C<< $term->ROW_t >> for details.
1703		2023
1704	=item $string = $term->special_decode $text	2024	=item $string = $term->special_decode $text
1705		2025
1706	Converts rxvt-unicodes text reprsentation into a perl string. See	2026	Converts rxvt-unicodes text representation into a perl string. See
1707	C<< $term->ROW_t >> for details.	2027	C<< $term->ROW_t >> for details.
1708		2028
1709	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2029	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1710		2030
1711	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2031	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1714	manpage.	2034	manpage.
1715		2035
1716	=item $success = $term->grab ($eventtime[, $sync])	2036	=item $success = $term->grab ($eventtime[, $sync])
1717		2037
1718	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2038	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1719	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2039	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1720		2040
1721	=item $term->allow_events_async	2041	=item $term->allow_events_async
1722		2042
1723	Calls XAllowEvents with AsyncBoth for the most recent grab.	2043	Calls XAllowEvents with AsyncBoth for the most recent grab.
1724		2044
…		…
1731	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2051	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1732	recent grab.	2052	recent grab.
1733		2053
1734	=item $term->ungrab	2054	=item $term->ungrab
1735		2055
1736	Calls XUngrab for the most recent grab. Is called automatically on	2056	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1737	evaluation errors, as it is better to lose the grab in the error case as	2057	evaluation errors, as it is better to lose the grab in the error case as
1738	the session.	2058	the session.
1739		2059
1740	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2060	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1741		2061
…		…
1743		2063
1744	=item @atoms = $term->XListProperties ($window)	2064	=item @atoms = $term->XListProperties ($window)
1745		2065
1746	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2066	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1747		2067
1748	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2068	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1749		2069
1750	=item $term->XDeleteProperty ($window, $property)	2070	=item $term->XDeleteProperty ($window, $property)
1751		2071
1752	=item $window = $term->DefaultRootWindow	2072	=item $window = $term->DefaultRootWindow
1753		2073
…		…
1760	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2080	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1761		2081
1762	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2082	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1763		2083
1764	=item $term->XChangeInput ($window, $add_events[, $del_events])	2084	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2085
		2086	=item $keysym = $term->XStringToKeysym ($string)
		2087
		2088	=item $string = $term->XKeysymToString ($keysym)
1765		2089
1766	Various X or X-related functions. The C<$term> object only serves as	2090	Various X or X-related functions. The C<$term> object only serves as
1767	the source of the display, otherwise those functions map more-or-less	2091	the source of the display, otherwise those functions map more-or-less
1768	directory onto the X functions of the same name.	2092	directly onto the X functions of the same name.
1769		2093
1770	=back	2094	=back
1771		2095
1772	=cut	2096	=cut
1773		2097
…		…
1875	my $env = $self->{term}->env;	2199	my $env = $self->{term}->env;
1876	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2200	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1877	delete $env->{LC_ALL};	2201	delete $env->{LC_ALL};
1878	$env->{LC_CTYPE} = $self->{term}->locale;	2202	$env->{LC_CTYPE} = $self->{term}->locale;
1879		2203
1880	urxvt::term->new ($env, "popup",	2204	my $term = urxvt::term->new (
		2205	$env, "popup",
1881	"--perl-lib" => "", "--perl-ext-common" => "",	2206	"--perl-lib" => "", "--perl-ext-common" => "",
1882	"-pty-fd" => -1, "-sl" => 0,	2207	"-pty-fd" => -1, "-sl" => 0,
1883	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2208	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1884	"--transient-for" => $self->{term}->parent,	2209	"--transient-for" => $self->{term}->parent,
1885	"-display" => $self->{term}->display_id,	2210	"-display" => $self->{term}->display_id,
1886	"-pe" => "urxvt-popup")	2211	"-pe" => "urxvt-popup",
1887	or die "unable to create popup window\n";	2212	) or die "unable to create popup window\n";
		2213
		2214	unless (delete $term->{urxvt_popup_init_done}) {
		2215	$term->ungrab;
		2216	$term->destroy;
		2217	die "unable to initialise popup window\n";
		2218	}
1888	}	2219	}
1889		2220
1890	sub DESTROY {	2221	sub DESTROY {
1891	my ($self) = @_;	2222	my ($self) = @_;
1892		2223
…		…
1897	=back	2228	=back
1898		2229
1899	=cut	2230	=cut
1900		2231
1901	package urxvt::watcher;	2232	package urxvt::watcher;
1902
1903	@urxvt::timer::ISA = __PACKAGE__;
1904	@urxvt::iow::ISA = __PACKAGE__;
1905	@urxvt::pw::ISA = __PACKAGE__;
1906	@urxvt::iw::ISA = __PACKAGE__;
1907		2233
1908	=head2 The C<urxvt::timer> Class	2234	=head2 The C<urxvt::timer> Class
1909		2235
1910	This class implements timer watchers/events. Time is represented as a	2236	This class implements timer watchers/events. Time is represented as a
1911	fractional number of seconds since the epoch. Example:	2237	fractional number of seconds since the epoch. Example:
…		…
1915	->new	2241	->new
1916	->interval (1)	2242	->interval (1)
1917	->cb (sub {	2243	->cb (sub {
1918	$term->{overlay}->set (0, 0,	2244	$term->{overlay}->set (0, 0,
1919	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2245	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1920	});	2246	});
1921		2247
1922	=over 4	2248	=over 4
1923		2249
1924	=item $timer = new urxvt::timer	2250	=item $timer = new urxvt::timer
1925		2251
…		…
1928		2254
1929	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2255	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1930		2256
1931	Set the callback to be called when the timer triggers.	2257	Set the callback to be called when the timer triggers.
1932		2258
1933	=item $tstamp = $timer->at
1934
1935	Return the time this watcher will fire next.
1936
1937	=item $timer = $timer->set ($tstamp)	2259	=item $timer = $timer->set ($tstamp[, $interval])
1938		2260
1939	Set the time the event is generated to $tstamp.	2261	Set the time the event is generated to $tstamp (and optionally specifies a
		2262	new $interval).
1940		2263
1941	=item $timer = $timer->interval ($interval)	2264	=item $timer = $timer->interval ($interval)
1942		2265
1943	Normally (and when C<$interval> is C<0>), the timer will automatically	2266	By default (and when C<$interval> is C<0>), the timer will automatically
1944	stop after it has fired once. If C<$interval> is non-zero, then the timer	2267	stop after it has fired once. If C<$interval> is non-zero, then the timer
1945	is automatically rescheduled at the given intervals.	2268	is automatically rescheduled at the given intervals.
1946		2269
1947	=item $timer = $timer->start	2270	=item $timer = $timer->start
1948		2271
1949	Start the timer.	2272	Start the timer.
1950		2273
1951	=item $timer = $timer->start ($tstamp)	2274	=item $timer = $timer->start ($tstamp[, $interval])
1952		2275
1953	Set the event trigger time to C<$tstamp> and start the timer.	2276	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2277	also replaces the interval.
1954		2278
1955	=item $timer = $timer->after ($delay)	2279	=item $timer = $timer->after ($delay[, $interval])
1956		2280
1957	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2281	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1958		2282
1959	=item $timer = $timer->stop	2283	=item $timer = $timer->stop
1960		2284
…		…
1968		2292
1969	$term->{socket} = ...	2293	$term->{socket} = ...
1970	$term->{iow} = urxvt::iow	2294	$term->{iow} = urxvt::iow
1971	->new	2295	->new
1972	->fd (fileno $term->{socket})	2296	->fd (fileno $term->{socket})
1973	->events (urxvt::EVENT_READ)	2297	->events (urxvt::EV_READ)
1974	->start	2298	->start
1975	->cb (sub {	2299	->cb (sub {
1976	my ($iow, $revents) = @_;	2300	my ($iow, $revents) = @_;
1977	# $revents must be 1 here, no need to check	2301	# $revents must be 1 here, no need to check
1978	sysread $term->{socket}, my $buf, 8192	2302	sysread $term->{socket}, my $buf, 8192
…		…
1991	Set the callback to be called when io events are triggered. C<$reventmask>	2315	Set the callback to be called when io events are triggered. C<$reventmask>
1992	is a bitset as described in the C<events> method.	2316	is a bitset as described in the C<events> method.
1993		2317
1994	=item $iow = $iow->fd ($fd)	2318	=item $iow = $iow->fd ($fd)
1995		2319
1996	Set the filedescriptor (not handle) to watch.	2320	Set the file descriptor (not handle) to watch.
1997		2321
1998	=item $iow = $iow->events ($eventmask)	2322	=item $iow = $iow->events ($eventmask)
1999		2323
2000	Set the event mask to watch. The only allowed values are	2324	Set the event mask to watch. The only allowed values are
2001	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2325	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2002	together, or C<urxvt::EVENT_NONE>.	2326	together, or C<urxvt::EV_NONE>.
2003		2327
2004	=item $iow = $iow->start	2328	=item $iow = $iow->start
2005		2329
2006	Start watching for requested events on the given handle.	2330	Start watching for requested events on the given handle.
2007		2331
2008	=item $iow = $iow->stop	2332	=item $iow = $iow->stop
2009		2333
2010	Stop watching for events on the given filehandle.	2334	Stop watching for events on the given file handle.
2011		2335
2012	=back	2336	=back
2013		2337
2014	=head2 The C<urxvt::iw> Class	2338	=head2 The C<urxvt::iw> Class
2015		2339
…		…
2048	->new	2372	->new
2049	->start ($pid)	2373	->start ($pid)
2050	->cb (sub {	2374	->cb (sub {
2051	my ($pw, $exit_status) = @_;	2375	my ($pw, $exit_status) = @_;
2052	...	2376	...
2053	});	2377	});
2054		2378
2055	=over 4	2379	=over 4
2056		2380
2057	=item $pw = new urxvt::pw	2381	=item $pw = new urxvt::pw
2058		2382
…		…
2062		2386
2063	Set the callback to be called when the timer triggers.	2387	Set the callback to be called when the timer triggers.
2064		2388
2065	=item $pw = $timer->start ($pid)	2389	=item $pw = $timer->start ($pid)
2066		2390
2067	Tells the wqtcher to start watching for process C<$pid>.	2391	Tells the watcher to start watching for process C<$pid>.
2068		2392
2069	=item $pw = $pw->stop	2393	=item $pw = $pw->stop
2070		2394
2071	Stop the watcher.	2395	Stop the watcher.
2072		2396
…		…
2085		2409
2086	=item >= 3 - script loading and management	2410	=item >= 3 - script loading and management
2087		2411
2088	=item >=10 - all called hooks	2412	=item >=10 - all called hooks
2089		2413
2090	=item >=11 - hook reutrn values	2414	=item >=11 - hook return values
2091		2415
2092	=back	2416	=back
2093		2417
2094	=head1 AUTHOR	2418	=head1 AUTHOR
2095		2419
2096	Marc Lehmann <pcg@goof.com>	2420	Marc Lehmann <schmorp@schmorp.de>
2097	http://software.schmorp.de/pkg/rxvt-unicode	2421	http://software.schmorp.de/pkg/rxvt-unicode
2098		2422
2099	=cut	2423	=cut
2100		2424
2101	1	2425	1
		2426
		2427	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.137 by root, Sat Mar 4 20:17:52 2006 UTC vs. Revision 1.213 by root, Wed Jun 6 15:09:49 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.137 by root, Sat Mar 4 20:17:52 2006 UTC vs.
Revision 1.213 by root, Wed Jun 6 15:09:49 2012 UTC