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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.139 by root, Sat Jul 1 19:04:43 2006 UTC vs.
Revision 1.200 by sf-exg, Sun Nov 20 10:58:58 2011 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
…		…
369	=back	451	=back
370		452
371	=head2 Extension Objects	453	=head2 Extension Objects
372		454
373	Every perl extension is a perl class. A separate perl object is created	455	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	456	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	457	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	458	their C<$self> object without having to think about clashes with other
		459	extensions or other terminals, with the exception of methods and members
377	begin with an underscore character C<_>: these are reserved for internal	460	that begin with an underscore character C<_>: these are reserved for
378	use.	461	internal use.
379		462
380	Although it isn't a C<urxvt::term> object, you can call all methods of the	463	Although it isn't a C<urxvt::term> object, you can call all methods of the
381	C<urxvt::term> class on this object.	464	C<urxvt::term> class on this object.
382		465
383	It has the following methods and data members:	466	It has the following methods and data members:
…		…
404	=head2 Hooks	487	=head2 Hooks
405		488
406	The following subroutines can be declared in extension files, and will be	489	The following subroutines can be declared in extension files, and will be
407	called whenever the relevant event happens.	490	called whenever the relevant event happens.
408		491
409	The first argument passed to them is an extension oject as described in	492	The first argument passed to them is an extension object as described in
410	the in the C<Extension Objects> section.	493	the in the C<Extension Objects> section.
411		494
412	B<All> of these hooks must return a boolean value. If any of the called	495	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	496	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.	497	relevant action might not be carried out by the C++ code.
…		…
427	place.	510	place.
428		511
429	=item on_start $term	512	=item on_start $term
430		513
431	Called at the very end of initialisation of a new terminal, just before	514	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.	515	trying to map (display) the toplevel and returning to the main loop.
433		516
434	=item on_destroy $term	517	=item on_destroy $term
435		518
436	Called whenever something tries to destroy terminal, when the terminal is	519	Called whenever something tries to destroy terminal, when the terminal is
437	still fully functional (not for long, though).	520	still fully functional (not for long, though).
…		…
464		547
465	Called whenever a selection has been copied, but before the selection is	548	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	549	requested from the server. The selection text can be queried and changed
467	by calling C<< $term->selection >>.	550	by calling C<< $term->selection >>.
468		551
469	Returning a true value aborts selection grabbing. It will still be hilighted.	552	Returning a true value aborts selection grabbing. It will still be highlighted.
470		553
471	=item on_sel_extend $term	554	=item on_sel_extend $term
472		555
473	Called whenever the user tries to extend the selection (e.g. with a double	556	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	557	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	558	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	559	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	560	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.	561	supposed to enlarge the selection more and more, if possible.
479		562
480	See the F<selection> example extension.	563	See the F<selection> example extension.
481		564
482	=item on_view_change $term, $offset	565	=item on_view_change $term, $offset
483		566
484	Called whenever the view offset changes, i..e the user or program	567	Called whenever the view offset changes, i.e. the user or program
485	scrolls. Offset C<0> means display the normal terminal, positive values	568	scrolls. Offset C<0> means display the normal terminal, positive values
486	show this many lines of scrollback.	569	show this many lines of scrollback.
487		570
488	=item on_scroll_back $term, $lines, $saved	571	=item on_scroll_back $term, $lines, $saved
489		572
…		…
493		576
494	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	577	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	578	$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.	579	number of lines that will be in the scrollback buffer.
497		580
498	=item on_osc_seq $term, $op, $args	581	=item on_osc_seq $term, $op, $args, $resp
499		582
500	Called on every OSC sequence and can be used to suppress it or modify its	583	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	584	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	585	suppresses execution of the request completely. Make sure you don't get
503	confused by recursive invocations when you output an osc sequence within	586	confused by recursive invocations when you output an OSC sequence within
504	this callback.	587	this callback.
505		588
506	C<on_osc_seq_perl> should be used for new behaviour.	589	C<on_osc_seq_perl> should be used for new behaviour.
507		590
508	=item on_osc_seq_perl $term, $string	591	=item on_osc_seq_perl $term, $args, $resp
509		592
510	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	593	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
511	operating system command) is processed. Cursor position and other state	594	operating system command) is processed. Cursor position and other state
512	information is up-to-date when this happens. For interoperability, the	595	information is up-to-date when this happens. For interoperability, the
513	string should start with the extension name and a colon, to distinguish	596	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	597	to distinguish it from commands for other extensions, and this might be
515	future.	598	enforced in the future.
		599
		600	For example, C<overlay-osc> uses this:
		601
		602	sub on_osc_seq_perl {
		603	my ($self, $osc, $resp) = @_;
		604
		605	return unless $osc =~ s/^overlay;//;
		606
		607	... process remaining $osc string
		608	}
516		609
517	Be careful not ever to trust (in a security sense) the data you receive,	610	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	611	as its source can not easily be controlled (e-mail content, messages from
519	other users on the same system etc.).	612	other users on the same system etc.).
		613
		614	For responses, C<$resp> contains the end-of-args separator used by the
		615	sender.
520		616
521	=item on_add_lines $term, $string	617	=item on_add_lines $term, $string
522		618
523	Called whenever text is about to be output, with the text as argument. You	619	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	620	can filter/change and output the text yourself by returning a true value
…		…
529	=item on_tt_write $term, $octets	625	=item on_tt_write $term, $octets
530		626
531	Called whenever some data is written to the tty/pty and can be used to	627	Called whenever some data is written to the tty/pty and can be used to
532	suppress or filter tty input.	628	suppress or filter tty input.
533		629
		630	=item on_tt_paste $term, $octets
		631
		632	Called whenever text is about to be pasted, with the text as argument. You
		633	can filter/change and paste the text yourself by returning a true value
		634	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		635	locale-encoded.
		636
534	=item on_line_update $term, $row	637	=item on_line_update $term, $row
535		638
536	Called whenever a line was updated or changed. Can be used to filter	639	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	640	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,	641	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	648	later with the already-modified line (e.g. if unrelated parts change), so
546	you cannot just toggle rendition bits, but only set them.	649	you cannot just toggle rendition bits, but only set them.
547		650
548	=item on_refresh_begin $term	651	=item on_refresh_begin $term
549		652
550	Called just before the screen gets redrawn. Can be used for overlay	653	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	654	similar effects by modifying the terminal contents in refresh_begin, and
552	restoring them in refresh_end. The built-in overlay and selection display	655	restoring them in refresh_end. The built-in overlay and selection display
553	code is run after this hook, and takes precedence.	656	code is run after this hook, and takes precedence.
554		657
555	=item on_refresh_end $term	658	=item on_refresh_end $term
556		659
557	Called just after the screen gets redrawn. See C<on_refresh_begin>.	660	Called just after the screen gets redrawn. See C<on_refresh_begin>.
558		661
559	=item on_user_command $term, $string	662	=item on_user_command $term, $string
560		663
561	Called whenever the a user-configured event is being activated (e.g. via	664	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>	665	a C<perl:string> action bound to a key, see description of the B<keysym>
563	resource in the @@RXVT_NAME@@(1) manpage).	666	resource in the @@RXVT_NAME@@(1) manpage).
564		667
565	The event is simply the action string. This interface is assumed to change	668	The event is simply the action string. This interface is assumed to change
566	slightly in the future.	669	slightly in the future.
567		670
568	=item on_resize_all_windows $tern, $new_width, $new_height	671	=item on_resize_all_windows $term, $new_width, $new_height
569		672
570	Called just after the new window size has been calculcated, but before	673	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	674	windows are actually being resized or hints are being set. If this hook
572	returns TRUE, setting of the window hints is being skipped.	675	returns TRUE, setting of the window hints is being skipped.
573		676
574	=item on_x_event $term, $event	677	=item on_x_event $term, $event
575		678
576	Called on every X event received on the vt window (and possibly other	679	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	680	windows). Should only be used as a last resort. Most event structure
578	members are not passed.	681	members are not passed.
579		682
		683	=item on_root_event $term, $event
		684
		685	Like C<on_x_event>, but is called for events on the root window.
		686
580	=item on_focus_in $term	687	=item on_focus_in $term
581		688
582	Called whenever the window gets the keyboard focus, before rxvt-unicode	689	Called whenever the window gets the keyboard focus, before rxvt-unicode
583	does focus in processing.	690	does focus in processing.
584		691
585	=item on_focus_out $term	692	=item on_focus_out $term
586		693
587	Called wheneever the window loses keyboard focus, before rxvt-unicode does	694	Called whenever the window loses keyboard focus, before rxvt-unicode does
588	focus out processing.	695	focus out processing.
589		696
590	=item on_configure_notify $term, $event	697	=item on_configure_notify $term, $event
591		698
592	=item on_property_notify $term, $event	699	=item on_property_notify $term, $event
…		…
603		710
604	=item on_map_notify $term, $event	711	=item on_map_notify $term, $event
605		712
606	=item on_unmap_notify $term, $event	713	=item on_unmap_notify $term, $event
607		714
608	Called whenever the corresponding X event is received for the terminal If	715	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.	716	the hook returns true, then the event will be ignored by rxvt-unicode.
610		717
611	The event is a hash with most values as named by Xlib (see the XEvent	718	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	719	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.	720	(real, not screen-based) row and column under the mouse cursor.
614		721
…		…
623		730
624	=item on_wm_delete_window $term, $event	731	=item on_wm_delete_window $term, $event
625		732
626	Called when various types of ClientMessage events are received (all with	733	Called when various types of ClientMessage events are received (all with
627	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	734	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		735
		736	=item on_bell $term
		737
		738	Called on receipt of a bell character.
628		739
629	=back	740	=back
630		741
631	=cut	742	=cut
632		743
…		…
675	The current terminal. This variable stores the current C<urxvt::term>	786	The current terminal. This variable stores the current C<urxvt::term>
676	object, whenever a callback/hook is executing.	787	object, whenever a callback/hook is executing.
677		788
678	=item @urxvt::TERM_INIT	789	=item @urxvt::TERM_INIT
679		790
680	All coderefs in this array will be called as methods of the next newly	791	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	792	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,	793	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.	794	so references can push themselves onto it again if they so desire.
684		795
685	This complements to the perl-eval commandline option, but gets executed	796	This complements to the perl-eval command line option, but gets executed
686	first.	797	first.
687		798
688	=item @urxvt::TERM_EXT	799	=item @urxvt::TERM_EXT
689		800
690	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	801	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
697		808
698	=over 4	809	=over 4
699		810
700	=item urxvt::fatal $errormessage	811	=item urxvt::fatal $errormessage
701		812
702	Fatally aborts execution with the given error message. Avoid at all	813	Fatally aborts execution with the given error message (which should
703	costs! The only time this is acceptable is when the terminal process	814	include a trailing newline). Avoid at all costs! The only time this
704	starts up.	815	is acceptable (and useful) is in the init hook, where it prevents the
		816	terminal from starting up.
705		817
706	=item urxvt::warn $string	818	=item urxvt::warn $string
707		819
708	Calls C<rxvt_warn> with the given string which should not include a	820	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	821	newline. The module also overwrites the C<warn> builtin with a function
710	that calls this function.	822	that calls this function.
711		823
712	Using this function has the advantage that its output ends up in the	824	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.	825	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
715	Messages have a size limit of 1023 bytes currently.	827	Messages have a size limit of 1023 bytes currently.
716		828
717	=item @terms = urxvt::termlist	829	=item @terms = urxvt::termlist
718		830
719	Returns all urxvt::term objects that exist in this process, regardless of	831	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	832	whether they are started, being destroyed etc., so be careful. Only term
721	objects that have perl extensions attached will be returned (because there	833	objects that have perl extensions attached will be returned (because there
722	is no urxvt::term objet associated with others).	834	is no urxvt::term object associated with others).
723		835
724	=item $time = urxvt::NOW	836	=item $time = urxvt::NOW
725		837
726	Returns the "current time" (as per the event loop).	838	Returns the "current time" (as per the event loop).
727		839
…		…
770		882
771	=item $rend = urxvt::OVERLAY_RSTYLE	883	=item $rend = urxvt::OVERLAY_RSTYLE
772		884
773	Return the rendition mask used for overlays by default.	885	Return the rendition mask used for overlays by default.
774		886
775	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	887	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		888	urxvt::RS_RVid, urxvt::RS_Uline
776		889
777	Return the bit that enabled bold, italic, blink, reverse-video and	890	Return the bit that enabled bold, italic, blink, reverse-video and
778	underline, respectively. To enable such a style, just logically OR it into	891	underline, respectively. To enable such a style, just logically OR it into
779	the bitset.	892	the bitset.
780		893
…		…
862	sub invoke {	975	sub invoke {
863	local $TERM = shift;	976	local $TERM = shift;
864	my $htype = shift;	977	my $htype = shift;
865		978
866	if ($htype == 0) { # INIT	979	if ($htype == 0) { # INIT
867	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	980	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
868		981
869	my %ext_arg;	982	my %ext_arg;
870		983
871	{	984	{
872	my @init = @TERM_INIT;	985	my @init = @TERM_INIT;
873	@TERM_INIT = ();	986	@TERM_INIT = ();
…		…
936		1049
937	sub SET_COLOR($$$) {	1050	sub SET_COLOR($$$) {
938	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1051	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
939	}	1052	}
940		1053
		1054	sub rend2mask {
		1055	no strict 'refs';
		1056	my ($str, $mask) = (@_, 0);
		1057	my %color = ( fg => undef, bg => undef );
		1058	my @failed;
		1059	for my $spec ( split /\s+/, $str ) {
		1060	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1061	$color{lc($1)} = $2;
		1062	} else {
		1063	my $neg = $spec =~ s/^[-^]//;
		1064	unless ( exists &{"RS_$spec"} ) {
		1065	push @failed, $spec;
		1066	next;
		1067	}
		1068	my $cur = &{"RS_$spec"};
		1069	if ( $neg ) {
		1070	$mask &= ~$cur;
		1071	} else {
		1072	$mask \|= $cur;
		1073	}
		1074	}
		1075	}
		1076	($mask, @color{qw(fg bg)}, \@failed)
		1077	}
		1078
941	# urxvt::term::extension	1079	# urxvt::term::extension
942		1080
943	package urxvt::term::extension;	1081	package urxvt::term::extension;
944		1082
945	sub enable {	1083	sub enable {
…		…
1014	is that you cannot use blocking APIs, but the non-blocking variant should	1152	is that you cannot use blocking APIs, but the non-blocking variant should
1015	work.	1153	work.
1016		1154
1017	=cut	1155	=cut
1018		1156
1019	our $VERSION = 1;	1157	our $VERSION = '5.23';
1020		1158
1021	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1159	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1022	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1160	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1023		1161
1024	sub timer {	1162	sub timer {
…		…
1026		1164
1027	my $cb = $arg{cb};	1165	my $cb = $arg{cb};
1028		1166
1029	urxvt::timer	1167	urxvt::timer
1030	->new	1168	->new
1031	->start (urxvt::NOW + $arg{after})	1169	->after ($arg{after}, $arg{interval})
1032	->cb (sub {	1170	->cb ($arg{interval} ? $cb : sub {
1033	$_[0]->stop; # need to cancel manually	1171	$_[0]->stop; # need to cancel manually
1034	$cb->();	1172	$cb->();
1035	})	1173	})
1036	}	1174	}
1037		1175
1038	sub io {	1176	sub io {
1039	my ($class, %arg) = @_;	1177	my ($class, %arg) = @_;
1040		1178
1041	my $cb = $arg{cb};	1179	my $cb = $arg{cb};
		1180	my $fd = fileno $arg{fh};
		1181	defined $fd or $fd = $arg{fh};
1042		1182
1043	bless [$arg{fh}, urxvt::iow	1183	bless [$arg{fh}, urxvt::iow
1044	->new	1184	->new
1045	->fd (fileno $arg{fh})	1185	->fd ($fd)
1046	->events (($arg{poll} =~ /r/ ? 1 : 0)	1186	->events (($arg{poll} =~ /r/ ? 1 : 0)
1047	\| ($arg{poll} =~ /w/ ? 2 : 0))	1187	\| ($arg{poll} =~ /w/ ? 2 : 0))
1048	->start	1188	->start
1049	->cb (sub {	1189	->cb ($cb)
1050	$cb->(($_[1] & 1 ? 'r' : '')
1051	. ($_[1] & 2 ? 'w' : ''));
1052	})],
1053	urxvt::anyevent::	1190	], urxvt::anyevent::
		1191	}
		1192
		1193	sub idle {
		1194	my ($class, %arg) = @_;
		1195
		1196	my $cb = $arg{cb};
		1197
		1198	urxvt::iw
		1199	->new
		1200	->start
		1201	->cb ($cb)
		1202	}
		1203
		1204	sub child {
		1205	my ($class, %arg) = @_;
		1206
		1207	my $cb = $arg{cb};
		1208
		1209	urxvt::pw
		1210	->new
		1211	->start ($arg{pid})
		1212	->cb (sub {
		1213	$_[0]->stop; # need to cancel manually
		1214	$cb->($_[0]->rpid, $_[0]->rstatus);
		1215	})
1054	}	1216	}
1055		1217
1056	sub DESTROY {	1218	sub DESTROY {
1057	$_[0][1]->stop;	1219	$_[0][1]->stop;
1058	}	1220	}
1059		1221
1060	sub condvar {	1222	# only needed for AnyEvent < 6 compatibility
1061	bless \my $flag, urxvt::anyevent::condvar::	1223	sub one_event {
1062	}
1063
1064	sub urxvt::anyevent::condvar::broadcast {
1065	${$_[0]}++;
1066	}
1067
1068	sub urxvt::anyevent::condvar::wait {
1069	unless (${$_[0]}) {
1070	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1224	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1071	}
1072	}	1225	}
1073		1226
1074	package urxvt::term;	1227	package urxvt::term;
1075		1228
1076	=head2 The C<urxvt::term> Class	1229	=head2 The C<urxvt::term> Class
…		…
1163		1316
1164	Returns true if the option specified by C<$optval> is enabled, and	1317	Returns true if the option specified by C<$optval> is enabled, and
1165	optionally change it. All option values are stored by name in the hash	1318	optionally change it. All option values are stored by name in the hash
1166	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1319	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1167		1320
1168	Here is a a likely non-exhaustive list of option names, please see the	1321	Here is a likely non-exhaustive list of option names, please see the
1169	source file F</src/optinc.h> to see the actual list:	1322	source file F</src/optinc.h> to see the actual list:
1170		1323
1171	borderLess console cursorBlink cursorUnderline hold iconic insecure	1324	borderLess buffered console cursorBlink cursorUnderline hold iconic
1172	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1325	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1173	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1326	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1174	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1327	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1175	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1328	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1176	transparent tripleclickwords utmpInhibit visualBell	1329	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1330	urgentOnBell utmpInhibit visualBell
1177		1331
1178	=item $value = $term->resource ($name[, $newval])	1332	=item $value = $term->resource ($name[, $newval])
1179		1333
1180	Returns the current resource value associated with a given name and	1334	Returns the current resource value associated with a given name and
1181	optionally sets a new value. Setting values is most useful in the C<init>	1335	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1190	likely change).	1344	likely change).
1191		1345
1192	Please note that resource strings will currently only be freed when the	1346	Please note that resource strings will currently only be freed when the
1193	terminal is destroyed, so changing options frequently will eat memory.	1347	terminal is destroyed, so changing options frequently will eat memory.
1194		1348
1195	Here is a a likely non-exhaustive list of resource names, not all of which	1349	Here is a likely non-exhaustive list of resource names, not all of which
1196	are supported in every build, please see the source file F</src/rsinc.h>	1350	are supported in every build, please see the source file F</src/rsinc.h>
1197	to see the actual list:	1351	to see the actual list:
1198		1352
1199	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1353	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1200	borderLess color cursorBlink cursorUnderline cutchars delete_key	1354	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1201	display_name embed ext_bwidth fade font geometry hold iconName	1355	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1202	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1356	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1357	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1203	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1358	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1204	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1359	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1205	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1360	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1206	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1361	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1207	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1362	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1208	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1363	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1209	secondaryScreen secondaryScroll selectstyle shade term_name title	1364	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1210	transient_for transparent transparent_all tripleclickwords utmpInhibit	1365	term_name title transient_for transparent tripleclickwords urgentOnBell
1211	visualBell	1366	utmpInhibit visualBell
1212		1367
1213	=cut	1368	=cut
1214		1369
1215	sub resource($$;$) {	1370	sub resource($$;$) {
1216	my ($self, $name) = (shift, shift);	1371	my ($self, $name) = (shift, shift);
1217	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1372	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1218	&urxvt::term::_resource	1373	goto &urxvt::term::_resource
1219	}	1374	}
1220		1375
1221	=item $value = $term->x_resource ($pattern)	1376	=item $value = $term->x_resource ($pattern)
1222		1377
1223	Returns the X-Resource for the given pattern, excluding the program or	1378	Returns the X-Resource for the given pattern, excluding the program or
…		…
1248		1403
1249	=item ($row, $col) = $term->selection_beg ([$row, $col])	1404	=item ($row, $col) = $term->selection_beg ([$row, $col])
1250		1405
1251	=item ($row, $col) = $term->selection_end ([$row, $col])	1406	=item ($row, $col) = $term->selection_end ([$row, $col])
1252		1407
1253	Return the current values of the selection mark, begin or end positions,	1408	Return the current values of the selection mark, begin or end positions.
1254	and optionally set them to new values.	1409
		1410	When arguments are given, then the selection coordinates are set to
		1411	C<$row> and C<$col>, and the selection screen is set to the current
		1412	screen.
		1413
		1414	=item $screen = $term->selection_screen ([$screen])
		1415
		1416	Returns the current selection screen, and then optionally sets it.
1255		1417
1256	=item $term->selection_make ($eventtime[, $rectangular])	1418	=item $term->selection_make ($eventtime[, $rectangular])
1257		1419
1258	Tries to make a selection as set by C<selection_beg> and	1420	Tries to make a selection as set by C<selection_beg> and
1259	C<selection_end>. If C<$rectangular> is true (default: false), a	1421	C<selection_end>. If C<$rectangular> is true (default: false), a
1260	rectangular selection will be made. This is the prefered function to make	1422	rectangular selection will be made. This is the preferred function to make
1261	a selection.	1423	a selection.
1262		1424
1263	=item $success = $term->selection_grab ($eventtime)	1425	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1264		1426
1265	Try to request the primary selection text from the server (for example, as	1427	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1428	true) selection from the server. The corresponding text can be set
1266	set by the next method). No visual feedback will be given. This function	1429	with the next method. No visual feedback will be given. This function
1267	is mostly useful from within C<on_sel_grab> hooks.	1430	is mostly useful from within C<on_sel_grab> hooks.
1268		1431
1269	=item $oldtext = $term->selection ([$newtext])	1432	=item $oldtext = $term->selection ([$newtext, $clipboard])
1270		1433
1271	Return the current selection text and optionally replace it by C<$newtext>.	1434	Return the current selection (clipboard if C<$clipboard> is true) text
		1435	and optionally replace it by C<$newtext>.
		1436
		1437	=item $term->selection_clear ([$clipboard])
		1438
		1439	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1272		1440
1273	=item $term->overlay_simple ($x, $y, $text)	1441	=item $term->overlay_simple ($x, $y, $text)
1274		1442
1275	Create a simple multi-line overlay box. See the next method for details.	1443	Create a simple multi-line overlay box. See the next method for details.
1276		1444
…		…
1306		1474
1307	The methods currently supported on C<urxvt::overlay> objects are:	1475	The methods currently supported on C<urxvt::overlay> objects are:
1308		1476
1309	=over 4	1477	=over 4
1310		1478
1311	=item $overlay->set ($x, $y, $text, $rend)	1479	=item $overlay->set ($x, $y, $text[, $rend])
1312		1480
1313	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1481	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1314	text in rxvt-unicode's special encoding and an array of rendition values	1482	text in rxvt-unicode's special encoding and an array of rendition values
1315	at a specific position inside the overlay.	1483	at a specific position inside the overlay.
		1484
		1485	If C<$rend> is missing, then the rendition will not be changed.
1316		1486
1317	=item $overlay->hide	1487	=item $overlay->hide
1318		1488
1319	If visible, hide the overlay, but do not destroy it.	1489	If visible, hide the overlay, but do not destroy it.
1320		1490
…		…
1402	locale-specific encoding of the terminal and can contain command sequences	1572	locale-specific encoding of the terminal and can contain command sequences
1403	(escape codes) that will be interpreted.	1573	(escape codes) that will be interpreted.
1404		1574
1405	=item $term->tt_write ($octets)	1575	=item $term->tt_write ($octets)
1406		1576
1407	Write the octets given in C<$data> to the tty (i.e. as program input). To	1577	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1408	pass characters instead of octets, you should convert your strings first	1578	pass characters instead of octets, you should convert your strings first
1409	to the locale-specific encoding using C<< $term->locale_encode >>.	1579	to the locale-specific encoding using C<< $term->locale_encode >>.
		1580
		1581	=item $term->tt_paste ($octets)
		1582
		1583	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1584	CR and bracketing the data with control sequences if bracketed paste mode
		1585	is set.
1410		1586
1411	=item $old_events = $term->pty_ev_events ([$new_events])	1587	=item $old_events = $term->pty_ev_events ([$new_events])
1412		1588
1413	Replaces the event mask of the pty watcher by the given event mask. Can	1589	Replaces the event mask of the pty watcher by the given event mask. Can
1414	be used to suppress input and output handling to the pty/tty. See the	1590	be used to suppress input and output handling to the pty/tty. See the
…		…
1512		1688
1513	Returns the currently displayed screen (0 primary, 1 secondary).	1689	Returns the currently displayed screen (0 primary, 1 secondary).
1514		1690
1515	=item $cursor_is_hidden = $term->hidden_cursor	1691	=item $cursor_is_hidden = $term->hidden_cursor
1516		1692
1517	Returns wether the cursor is currently hidden or not.	1693	Returns whether the cursor is currently hidden or not.
1518		1694
1519	=item $view_start = $term->view_start ([$newvalue])	1695	=item $view_start = $term->view_start ([$newvalue])
1520		1696
1521	Returns the row number of the topmost displayed line. Maximum value is	1697	Returns the row number of the topmost displayed line. Maximum value is
1522	C<0>, which displays the normal terminal contents. Lower values scroll	1698	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1530		1706
1531	Used after changing terminal contents to display them.	1707	Used after changing terminal contents to display them.
1532		1708
1533	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1709	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1534		1710
1535	Returns the text of the entire row with number C<$row_number>. Row C<0>	1711	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1536	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1712	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1537	terminal line. The scrollback buffer starts at line C<-1> and extends to
1538	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1713	terminal line. Nothing will be returned if a nonexistent line
1539	is requested.	1714	is requested.
1540		1715
1541	If C<$new_text> is specified, it will replace characters in the current	1716	If C<$new_text> is specified, it will replace characters in the current
1542	line, starting at column C<$start_col> (default C<0>), which is useful	1717	line, starting at column C<$start_col> (default C<0>), which is useful
1543	to replace only parts of a line. The font index in the rendition will	1718	to replace only parts of a line. The font index in the rendition will
1544	automatically be updated.	1719	automatically be updated.
1545		1720
1546	C<$text> is in a special encoding: tabs and wide characters that use more	1721	C<$text> is in a special encoding: tabs and wide characters that use more
1547	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1722	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1548	characters. Characters with combining characters and other characters that	1723	characters. Characters with combining characters and other characters that
1549	do not fit into the normal tetx encoding will be replaced with characters	1724	do not fit into the normal text encoding will be replaced with characters
1550	in the private use area.	1725	in the private use area.
1551		1726
1552	You have to obey this encoding when changing text. The advantage is	1727	You have to obey this encoding when changing text. The advantage is
1553	that C<substr> and similar functions work on screen cells and not on	1728	that C<substr> and similar functions work on screen cells and not on
1554	characters.	1729	characters.
…		…
1699	where one character corresponds to one screen cell. See	1874	where one character corresponds to one screen cell. See
1700	C<< $term->ROW_t >> for details.	1875	C<< $term->ROW_t >> for details.
1701		1876
1702	=item $string = $term->special_decode $text	1877	=item $string = $term->special_decode $text
1703		1878
1704	Converts rxvt-unicodes text reprsentation into a perl string. See	1879	Converts rxvt-unicodes text representation into a perl string. See
1705	C<< $term->ROW_t >> for details.	1880	C<< $term->ROW_t >> for details.
1706		1881
1707	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1882	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1708		1883
1709	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1884	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1712	manpage.	1887	manpage.
1713		1888
1714	=item $success = $term->grab ($eventtime[, $sync])	1889	=item $success = $term->grab ($eventtime[, $sync])
1715		1890
1716	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1891	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1717	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1892	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1718		1893
1719	=item $term->allow_events_async	1894	=item $term->allow_events_async
1720		1895
1721	Calls XAllowEvents with AsyncBoth for the most recent grab.	1896	Calls XAllowEvents with AsyncBoth for the most recent grab.
1722		1897
…		…
1729	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1904	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1730	recent grab.	1905	recent grab.
1731		1906
1732	=item $term->ungrab	1907	=item $term->ungrab
1733		1908
1734	Calls XUngrab for the most recent grab. Is called automatically on	1909	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1735	evaluation errors, as it is better to lose the grab in the error case as	1910	evaluation errors, as it is better to lose the grab in the error case as
1736	the session.	1911	the session.
1737		1912
1738	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1913	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1739		1914
…		…
1741		1916
1742	=item @atoms = $term->XListProperties ($window)	1917	=item @atoms = $term->XListProperties ($window)
1743		1918
1744	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1919	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1745		1920
1746	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1921	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1747		1922
1748	=item $term->XDeleteProperty ($window, $property)	1923	=item $term->XDeleteProperty ($window, $property)
1749		1924
1750	=item $window = $term->DefaultRootWindow	1925	=item $window = $term->DefaultRootWindow
1751		1926
…		…
1761		1936
1762	=item $term->XChangeInput ($window, $add_events[, $del_events])	1937	=item $term->XChangeInput ($window, $add_events[, $del_events])
1763		1938
1764	Various X or X-related functions. The C<$term> object only serves as	1939	Various X or X-related functions. The C<$term> object only serves as
1765	the source of the display, otherwise those functions map more-or-less	1940	the source of the display, otherwise those functions map more-or-less
1766	directory onto the X functions of the same name.	1941	directly onto the X functions of the same name.
1767		1942
1768	=back	1943	=back
1769		1944
1770	=cut	1945	=cut
1771		1946
…		…
1873	my $env = $self->{term}->env;	2048	my $env = $self->{term}->env;
1874	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2049	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1875	delete $env->{LC_ALL};	2050	delete $env->{LC_ALL};
1876	$env->{LC_CTYPE} = $self->{term}->locale;	2051	$env->{LC_CTYPE} = $self->{term}->locale;
1877		2052
1878	urxvt::term->new ($env, "popup",	2053	my $term = urxvt::term->new (
		2054	$env, "popup",
1879	"--perl-lib" => "", "--perl-ext-common" => "",	2055	"--perl-lib" => "", "--perl-ext-common" => "",
1880	"-pty-fd" => -1, "-sl" => 0,	2056	"-pty-fd" => -1, "-sl" => 0,
1881	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2057	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1882	"--transient-for" => $self->{term}->parent,	2058	"--transient-for" => $self->{term}->parent,
1883	"-display" => $self->{term}->display_id,	2059	"-display" => $self->{term}->display_id,
1884	"-pe" => "urxvt-popup")	2060	"-pe" => "urxvt-popup",
1885	or die "unable to create popup window\n";	2061	) or die "unable to create popup window\n";
		2062
		2063	unless (delete $term->{urxvt_popup_init_done}) {
		2064	$term->ungrab;
		2065	$term->destroy;
		2066	die "unable to initialise popup window\n";
		2067	}
1886	}	2068	}
1887		2069
1888	sub DESTROY {	2070	sub DESTROY {
1889	my ($self) = @_;	2071	my ($self) = @_;
1890		2072
…		…
1895	=back	2077	=back
1896		2078
1897	=cut	2079	=cut
1898		2080
1899	package urxvt::watcher;	2081	package urxvt::watcher;
1900
1901	@urxvt::timer::ISA = __PACKAGE__;
1902	@urxvt::iow::ISA = __PACKAGE__;
1903	@urxvt::pw::ISA = __PACKAGE__;
1904	@urxvt::iw::ISA = __PACKAGE__;
1905		2082
1906	=head2 The C<urxvt::timer> Class	2083	=head2 The C<urxvt::timer> Class
1907		2084
1908	This class implements timer watchers/events. Time is represented as a	2085	This class implements timer watchers/events. Time is represented as a
1909	fractional number of seconds since the epoch. Example:	2086	fractional number of seconds since the epoch. Example:
…		…
1913	->new	2090	->new
1914	->interval (1)	2091	->interval (1)
1915	->cb (sub {	2092	->cb (sub {
1916	$term->{overlay}->set (0, 0,	2093	$term->{overlay}->set (0, 0,
1917	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2094	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1918	});	2095	});
1919		2096
1920	=over 4	2097	=over 4
1921		2098
1922	=item $timer = new urxvt::timer	2099	=item $timer = new urxvt::timer
1923		2100
…		…
1926		2103
1927	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2104	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1928		2105
1929	Set the callback to be called when the timer triggers.	2106	Set the callback to be called when the timer triggers.
1930		2107
1931	=item $tstamp = $timer->at
1932
1933	Return the time this watcher will fire next.
1934
1935	=item $timer = $timer->set ($tstamp)	2108	=item $timer = $timer->set ($tstamp[, $interval])
1936		2109
1937	Set the time the event is generated to $tstamp.	2110	Set the time the event is generated to $tstamp (and optionally specifies a
		2111	new $interval).
1938		2112
1939	=item $timer = $timer->interval ($interval)	2113	=item $timer = $timer->interval ($interval)
1940		2114
1941	Normally (and when C<$interval> is C<0>), the timer will automatically	2115	By default (and when C<$interval> is C<0>), the timer will automatically
1942	stop after it has fired once. If C<$interval> is non-zero, then the timer	2116	stop after it has fired once. If C<$interval> is non-zero, then the timer
1943	is automatically rescheduled at the given intervals.	2117	is automatically rescheduled at the given intervals.
1944		2118
1945	=item $timer = $timer->start	2119	=item $timer = $timer->start
1946		2120
1947	Start the timer.	2121	Start the timer.
1948		2122
1949	=item $timer = $timer->start ($tstamp)	2123	=item $timer = $timer->start ($tstamp[, $interval])
1950		2124
1951	Set the event trigger time to C<$tstamp> and start the timer.	2125	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2126	also replaces the interval.
1952		2127
1953	=item $timer = $timer->after ($delay)	2128	=item $timer = $timer->after ($delay[, $interval])
1954		2129
1955	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2130	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1956		2131
1957	=item $timer = $timer->stop	2132	=item $timer = $timer->stop
1958		2133
…		…
1966		2141
1967	$term->{socket} = ...	2142	$term->{socket} = ...
1968	$term->{iow} = urxvt::iow	2143	$term->{iow} = urxvt::iow
1969	->new	2144	->new
1970	->fd (fileno $term->{socket})	2145	->fd (fileno $term->{socket})
1971	->events (urxvt::EVENT_READ)	2146	->events (urxvt::EV_READ)
1972	->start	2147	->start
1973	->cb (sub {	2148	->cb (sub {
1974	my ($iow, $revents) = @_;	2149	my ($iow, $revents) = @_;
1975	# $revents must be 1 here, no need to check	2150	# $revents must be 1 here, no need to check
1976	sysread $term->{socket}, my $buf, 8192	2151	sysread $term->{socket}, my $buf, 8192
…		…
1989	Set the callback to be called when io events are triggered. C<$reventmask>	2164	Set the callback to be called when io events are triggered. C<$reventmask>
1990	is a bitset as described in the C<events> method.	2165	is a bitset as described in the C<events> method.
1991		2166
1992	=item $iow = $iow->fd ($fd)	2167	=item $iow = $iow->fd ($fd)
1993		2168
1994	Set the filedescriptor (not handle) to watch.	2169	Set the file descriptor (not handle) to watch.
1995		2170
1996	=item $iow = $iow->events ($eventmask)	2171	=item $iow = $iow->events ($eventmask)
1997		2172
1998	Set the event mask to watch. The only allowed values are	2173	Set the event mask to watch. The only allowed values are
1999	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2174	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2000	together, or C<urxvt::EVENT_NONE>.	2175	together, or C<urxvt::EV_NONE>.
2001		2176
2002	=item $iow = $iow->start	2177	=item $iow = $iow->start
2003		2178
2004	Start watching for requested events on the given handle.	2179	Start watching for requested events on the given handle.
2005		2180
2006	=item $iow = $iow->stop	2181	=item $iow = $iow->stop
2007		2182
2008	Stop watching for events on the given filehandle.	2183	Stop watching for events on the given file handle.
2009		2184
2010	=back	2185	=back
2011		2186
2012	=head2 The C<urxvt::iw> Class	2187	=head2 The C<urxvt::iw> Class
2013		2188
…		…
2046	->new	2221	->new
2047	->start ($pid)	2222	->start ($pid)
2048	->cb (sub {	2223	->cb (sub {
2049	my ($pw, $exit_status) = @_;	2224	my ($pw, $exit_status) = @_;
2050	...	2225	...
2051	});	2226	});
2052		2227
2053	=over 4	2228	=over 4
2054		2229
2055	=item $pw = new urxvt::pw	2230	=item $pw = new urxvt::pw
2056		2231
…		…
2060		2235
2061	Set the callback to be called when the timer triggers.	2236	Set the callback to be called when the timer triggers.
2062		2237
2063	=item $pw = $timer->start ($pid)	2238	=item $pw = $timer->start ($pid)
2064		2239
2065	Tells the wqtcher to start watching for process C<$pid>.	2240	Tells the watcher to start watching for process C<$pid>.
2066		2241
2067	=item $pw = $pw->stop	2242	=item $pw = $pw->stop
2068		2243
2069	Stop the watcher.	2244	Stop the watcher.
2070		2245
…		…
2083		2258
2084	=item >= 3 - script loading and management	2259	=item >= 3 - script loading and management
2085		2260
2086	=item >=10 - all called hooks	2261	=item >=10 - all called hooks
2087		2262
2088	=item >=11 - hook reutrn values	2263	=item >=11 - hook return values
2089		2264
2090	=back	2265	=back
2091		2266
2092	=head1 AUTHOR	2267	=head1 AUTHOR
2093		2268
2094	Marc Lehmann <pcg@goof.com>	2269	Marc Lehmann <schmorp@schmorp.de>
2095	http://software.schmorp.de/pkg/rxvt-unicode	2270	http://software.schmorp.de/pkg/rxvt-unicode
2096		2271
2097	=cut	2272	=cut
2098		2273
2099	1	2274	1
		2275
		2276	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.139 by root, Sat Jul 1 19:04:43 2006 UTC vs. Revision 1.200 by sf-exg, Sun Nov 20 10:58:58 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.139 by root, Sat Jul 1 19:04:43 2006 UTC vs.
Revision 1.200 by sf-exg, Sun Nov 20 10:58:58 2011 UTC