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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.140 by root, Mon Jul 3 19:10:09 2006 UTC vs.
Revision 1.199 by sf-exg, Sun Nov 20 10:49:56 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 very small extension that dynamically changes the	293	A very primitive quake-console-like extension. It was inspired by a
261	background pixmap offset to the window position, in effect creating the	294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
262	same effect as pseudo transparency with a custom pixmap. No scaling is	295	user presses a global accelerator key (by default C<F10>), the terminal
263	supported in this mode. Exmaple:	296	will show or hide itself. Another press of the accelerator key will hide
		297	or show it again.
264		298
265	@@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.
266		315
267	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
268		317
269	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
270	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
271	similar-looking ascii character.	320	similar-looking ascii character.
272		321
273	=item digital-clock	322	=item digital-clock
274		323
275	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
276		325
277	=item remote-clipboard	326	=item remote-clipboard
278		327
279	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
280	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
281	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
282		331
283	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
284	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
285	reads it.	334	reads it.
…		…
294	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
295	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
296		345
297	=item selection-pastebin	346	=item selection-pastebin
298		347
299	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
300	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
301	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
302	F</tmp> directly.).	351	F</tmp> directly.).
303		352
304	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
321	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
322	for the filename):	371	for the filename):
323		372
324	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
325		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
326	=item example-refresh-hooks	394	=item example-refresh-hooks
327		395
328	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
329	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
330	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"
331		412
332	=back	413	=back
333		414
334	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
335		416
…		…
351		432
352	=over 4	433	=over 4
353		434
354	=item $text	435	=item $text
355		436
356	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
357	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.
358		439
359	=item $string	440	=item $string
360		441
361	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
…		…
370	=back	451	=back
371		452
372	=head2 Extension Objects	453	=head2 Extension Objects
373		454
374	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
375	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,
376	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
377	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
378	begin with an underscore character C<_>: these are reserved for internal	460	that begin with an underscore character C<_>: these are reserved for
379	use.	461	internal use.
380		462
381	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
382	C<urxvt::term> class on this object.	464	C<urxvt::term> class on this object.
383		465
384	It has the following methods and data members:	466	It has the following methods and data members:
…		…
405	=head2 Hooks	487	=head2 Hooks
406		488
407	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
408	called whenever the relevant event happens.	490	called whenever the relevant event happens.
409		491
410	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
411	the in the C<Extension Objects> section.	493	the in the C<Extension Objects> section.
412		494
413	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
414	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
415	relevant action might not be carried out by the C++ code.	497	relevant action might not be carried out by the C++ code.
…		…
428	place.	510	place.
429		511
430	=item on_start $term	512	=item on_start $term
431		513
432	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
433	trying to map (display) the toplevel and returning to the mainloop.	515	trying to map (display) the toplevel and returning to the main loop.
434		516
435	=item on_destroy $term	517	=item on_destroy $term
436		518
437	Called whenever something tries to destroy terminal, when the terminal is	519	Called whenever something tries to destroy terminal, when the terminal is
438	still fully functional (not for long, though).	520	still fully functional (not for long, though).
…		…
465		547
466	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
467	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
468	by calling C<< $term->selection >>.	550	by calling C<< $term->selection >>.
469		551
470	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.
471		553
472	=item on_sel_extend $term	554	=item on_sel_extend $term
473		555
474	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
475	click) and is either supposed to return false (normal operation), or	557	click) and is either supposed to return false (normal operation), or
476	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
477	processing. This can happen multiple times, as long as the callback	559	processing. This can happen multiple times, as long as the callback
478	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
479	supposed to enlarge the selection more and more, if possible.	561	supposed to enlarge the selection more and more, if possible.
480		562
481	See the F<selection> example extension.	563	See the F<selection> example extension.
482		564
483	=item on_view_change $term, $offset	565	=item on_view_change $term, $offset
484		566
485	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
486	scrolls. Offset C<0> means display the normal terminal, positive values	568	scrolls. Offset C<0> means display the normal terminal, positive values
487	show this many lines of scrollback.	569	show this many lines of scrollback.
488		570
489	=item on_scroll_back $term, $lines, $saved	571	=item on_scroll_back $term, $lines, $saved
490		572
…		…
494		576
495	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,
496	$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
497	number of lines that will be in the scrollback buffer.	579	number of lines that will be in the scrollback buffer.
498		580
499	=item on_osc_seq $term, $op, $args	581	=item on_osc_seq $term, $op, $args, $resp
500		582
501	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
502	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
503	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
504	confused by recursive invocations when you output an osc sequence within	586	confused by recursive invocations when you output an OSC sequence within
505	this callback.	587	this callback.
506		588
507	C<on_osc_seq_perl> should be used for new behaviour.	589	C<on_osc_seq_perl> should be used for new behaviour.
508		590
509	=item on_osc_seq_perl $term, $string	591	=item on_osc_seq_perl $term, $args, $resp
510		592
511	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	593	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
512	operating system command) is processed. Cursor position and other state	594	operating system command) is processed. Cursor position and other state
513	information is up-to-date when this happens. For interoperability, the	595	information is up-to-date when this happens. For interoperability, the
514	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,
515	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
516	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	}
517		609
518	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,
519	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
520	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.
521		616
522	=item on_add_lines $term, $string	617	=item on_add_lines $term, $string
523		618
524	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
525	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
…		…
530	=item on_tt_write $term, $octets	625	=item on_tt_write $term, $octets
531		626
532	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
533	suppress or filter tty input.	628	suppress or filter tty input.
534		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
535	=item on_line_update $term, $row	637	=item on_line_update $term, $row
536		638
537	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
538	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
539	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,
…		…
546	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
547	you cannot just toggle rendition bits, but only set them.	649	you cannot just toggle rendition bits, but only set them.
548		650
549	=item on_refresh_begin $term	651	=item on_refresh_begin $term
550		652
551	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
552	or similar effects by modify terminal contents in refresh_begin, and	654	similar effects by modifying the terminal contents in refresh_begin, and
553	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
554	code is run after this hook, and takes precedence.	656	code is run after this hook, and takes precedence.
555		657
556	=item on_refresh_end $term	658	=item on_refresh_end $term
557		659
558	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>.
559		661
560	=item on_user_command $term, $string	662	=item on_user_command $term, $string
561		663
562	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
563	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>
564	resource in the @@RXVT_NAME@@(1) manpage).	666	resource in the @@RXVT_NAME@@(1) manpage).
565		667
566	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
567	slightly in the future.	669	slightly in the future.
568		670
569	=item on_resize_all_windows $tern, $new_width, $new_height	671	=item on_resize_all_windows $term, $new_width, $new_height
570		672
571	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
572	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
573	returns TRUE, setting of the window hints is being skipped.	675	returns TRUE, setting of the window hints is being skipped.
574		676
575	=item on_x_event $term, $event	677	=item on_x_event $term, $event
576		678
577	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
578	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
579	members are not passed.	681	members are not passed.
580		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
581	=item on_focus_in $term	687	=item on_focus_in $term
582		688
583	Called whenever the window gets the keyboard focus, before rxvt-unicode	689	Called whenever the window gets the keyboard focus, before rxvt-unicode
584	does focus in processing.	690	does focus in processing.
585		691
586	=item on_focus_out $term	692	=item on_focus_out $term
587		693
588	Called wheneever the window loses keyboard focus, before rxvt-unicode does	694	Called whenever the window loses keyboard focus, before rxvt-unicode does
589	focus out processing.	695	focus out processing.
590		696
591	=item on_configure_notify $term, $event	697	=item on_configure_notify $term, $event
592		698
593	=item on_property_notify $term, $event	699	=item on_property_notify $term, $event
…		…
604		710
605	=item on_map_notify $term, $event	711	=item on_map_notify $term, $event
606		712
607	=item on_unmap_notify $term, $event	713	=item on_unmap_notify $term, $event
608		714
609	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
610	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.
611		717
612	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
613	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
614	(real, not screen-based) row and column under the mouse cursor.	720	(real, not screen-based) row and column under the mouse cursor.
615		721
…		…
624		730
625	=item on_wm_delete_window $term, $event	731	=item on_wm_delete_window $term, $event
626		732
627	Called when various types of ClientMessage events are received (all with	733	Called when various types of ClientMessage events are received (all with
628	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.
629		739
630	=back	740	=back
631		741
632	=cut	742	=cut
633		743
…		…
676	The current terminal. This variable stores the current C<urxvt::term>	786	The current terminal. This variable stores the current C<urxvt::term>
677	object, whenever a callback/hook is executing.	787	object, whenever a callback/hook is executing.
678		788
679	=item @urxvt::TERM_INIT	789	=item @urxvt::TERM_INIT
680		790
681	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
682	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
683	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,
684	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.
685		795
686	This complements to the perl-eval commandline option, but gets executed	796	This complements to the perl-eval command line option, but gets executed
687	first.	797	first.
688		798
689	=item @urxvt::TERM_EXT	799	=item @urxvt::TERM_EXT
690		800
691	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
…		…
698		808
699	=over 4	809	=over 4
700		810
701	=item urxvt::fatal $errormessage	811	=item urxvt::fatal $errormessage
702		812
703	Fatally aborts execution with the given error message. Avoid at all	813	Fatally aborts execution with the given error message (which should
704	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
705	starts up.	815	is acceptable (and useful) is in the init hook, where it prevents the
		816	terminal from starting up.
706		817
707	=item urxvt::warn $string	818	=item urxvt::warn $string
708		819
709	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
710	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
711	that calls this function.	822	that calls this function.
712		823
713	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
714	correct place, e.g. on stderr of the connecting urxvtc client.	825	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
716	Messages have a size limit of 1023 bytes currently.	827	Messages have a size limit of 1023 bytes currently.
717		828
718	=item @terms = urxvt::termlist	829	=item @terms = urxvt::termlist
719		830
720	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
721	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
722	objects that have perl extensions attached will be returned (because there	833	objects that have perl extensions attached will be returned (because there
723	is no urxvt::term objet associated with others).	834	is no urxvt::term object associated with others).
724		835
725	=item $time = urxvt::NOW	836	=item $time = urxvt::NOW
726		837
727	Returns the "current time" (as per the event loop).	838	Returns the "current time" (as per the event loop).
728		839
…		…
771		882
772	=item $rend = urxvt::OVERLAY_RSTYLE	883	=item $rend = urxvt::OVERLAY_RSTYLE
773		884
774	Return the rendition mask used for overlays by default.	885	Return the rendition mask used for overlays by default.
775		886
776	=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
777		889
778	Return the bit that enabled bold, italic, blink, reverse-video and	890	Return the bit that enabled bold, italic, blink, reverse-video and
779	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
780	the bitset.	892	the bitset.
781		893
…		…
864	local $TERM = shift;	976	local $TERM = shift;
865	my $htype = shift;	977	my $htype = shift;
866		978
867	if ($htype == 0) { # INIT	979	if ($htype == 0) { # INIT
868	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	980	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
869		981
870	my %ext_arg;	982	my %ext_arg;
871		983
872	{	984	{
873	my @init = @TERM_INIT;	985	my @init = @TERM_INIT;
874	@TERM_INIT = ();	986	@TERM_INIT = ();
…		…
937		1049
938	sub SET_COLOR($$$) {	1050	sub SET_COLOR($$$) {
939	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1051	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
940	}	1052	}
941		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
942	# urxvt::term::extension	1079	# urxvt::term::extension
943		1080
944	package urxvt::term::extension;	1081	package urxvt::term::extension;
945		1082
946	sub enable {	1083	sub enable {
…		…
1015	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
1016	work.	1153	work.
1017		1154
1018	=cut	1155	=cut
1019		1156
1020	our $VERSION = 1;	1157	our $VERSION = '5.23';
1021		1158
1022	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1159	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1023	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1160	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1024		1161
1025	sub timer {	1162	sub timer {
…		…
1027		1164
1028	my $cb = $arg{cb};	1165	my $cb = $arg{cb};
1029		1166
1030	urxvt::timer	1167	urxvt::timer
1031	->new	1168	->new
1032	->start (urxvt::NOW + $arg{after})	1169	->after ($arg{after}, $arg{interval})
1033	->cb (sub {	1170	->cb ($arg{interval} ? $cb : sub {
1034	$_[0]->stop; # need to cancel manually	1171	$_[0]->stop; # need to cancel manually
1035	$cb->();	1172	$cb->();
1036	})	1173	})
1037	}	1174	}
1038		1175
1039	sub io {	1176	sub io {
1040	my ($class, %arg) = @_;	1177	my ($class, %arg) = @_;
1041		1178
1042	my $cb = $arg{cb};	1179	my $cb = $arg{cb};
		1180	my $fd = fileno $arg{fh};
		1181	defined $fd or $fd = $arg{fh};
1043		1182
1044	bless [$arg{fh}, urxvt::iow	1183	bless [$arg{fh}, urxvt::iow
1045	->new	1184	->new
1046	->fd (fileno $arg{fh})	1185	->fd ($fd)
1047	->events (($arg{poll} =~ /r/ ? 1 : 0)	1186	->events (($arg{poll} =~ /r/ ? 1 : 0)
1048	\| ($arg{poll} =~ /w/ ? 2 : 0))	1187	\| ($arg{poll} =~ /w/ ? 2 : 0))
1049	->start	1188	->start
1050	->cb (sub {	1189	->cb ($cb)
1051	$cb->(($_[1] & 1 ? 'r' : '')
1052	. ($_[1] & 2 ? 'w' : ''));
1053	})],
1054	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	})
1055	}	1216	}
1056		1217
1057	sub DESTROY {	1218	sub DESTROY {
1058	$_[0][1]->stop;	1219	$_[0][1]->stop;
1059	}	1220	}
1060		1221
1061	sub condvar {	1222	# only needed for AnyEvent < 6 compatibility
1062	bless \my $flag, urxvt::anyevent::condvar::	1223	sub one_event {
1063	}
1064
1065	sub urxvt::anyevent::condvar::broadcast {
1066	${$_[0]}++;
1067	}
1068
1069	sub urxvt::anyevent::condvar::wait {
1070	unless (${$_[0]}) {
1071	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";
1072	}
1073	}	1225	}
1074		1226
1075	package urxvt::term;	1227	package urxvt::term;
1076		1228
1077	=head2 The C<urxvt::term> Class	1229	=head2 The C<urxvt::term> Class
…		…
1164		1316
1165	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
1166	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
1167	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.
1168		1320
1169	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
1170	source file F</src/optinc.h> to see the actual list:	1322	source file F</src/optinc.h> to see the actual list:
1171		1323
1172	borderLess console cursorBlink cursorUnderline hold iconic insecure	1324	borderLess buffered console cursorBlink cursorUnderline hold iconic
1173	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1325	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1174	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1326	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1175	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1327	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1176	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1328	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1177	transparent tripleclickwords utmpInhibit visualBell	1329	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1330	urgentOnBell utmpInhibit visualBell
1178		1331
1179	=item $value = $term->resource ($name[, $newval])	1332	=item $value = $term->resource ($name[, $newval])
1180		1333
1181	Returns the current resource value associated with a given name and	1334	Returns the current resource value associated with a given name and
1182	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>
…		…
1191	likely change).	1344	likely change).
1192		1345
1193	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
1194	terminal is destroyed, so changing options frequently will eat memory.	1347	terminal is destroyed, so changing options frequently will eat memory.
1195		1348
1196	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
1197	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>
1198	to see the actual list:	1351	to see the actual list:
1199		1352
1200	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1353	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1201	borderLess color cursorBlink cursorUnderline cutchars delete_key	1354	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1202	display_name embed ext_bwidth fade font geometry hold iconName	1355	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1203	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
1204	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1358	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1205	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1359	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1206	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1360	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1207	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1361	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1208	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1362	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1209	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1363	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1210	secondaryScreen secondaryScroll selectstyle shade term_name title	1364	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1211	transient_for transparent transparent_all tripleclickwords utmpInhibit	1365	term_name title transient_for transparent tripleclickwords urgentOnBell
1212	visualBell	1366	utmpInhibit visualBell
1213		1367
1214	=cut	1368	=cut
1215		1369
1216	sub resource($$;$) {	1370	sub resource($$;$) {
1217	my ($self, $name) = (shift, shift);	1371	my ($self, $name) = (shift, shift);
1218	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1372	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1219	&urxvt::term::_resource	1373	goto &urxvt::term::_resource
1220	}	1374	}
1221		1375
1222	=item $value = $term->x_resource ($pattern)	1376	=item $value = $term->x_resource ($pattern)
1223		1377
1224	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
…		…
1249		1403
1250	=item ($row, $col) = $term->selection_beg ([$row, $col])	1404	=item ($row, $col) = $term->selection_beg ([$row, $col])
1251		1405
1252	=item ($row, $col) = $term->selection_end ([$row, $col])	1406	=item ($row, $col) = $term->selection_end ([$row, $col])
1253		1407
1254	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.
1255	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.
1256		1417
1257	=item $term->selection_make ($eventtime[, $rectangular])	1418	=item $term->selection_make ($eventtime[, $rectangular])
1258		1419
1259	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
1260	C<selection_end>. If C<$rectangular> is true (default: false), a	1421	C<selection_end>. If C<$rectangular> is true (default: false), a
1261	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
1262	a selection.	1423	a selection.
1263		1424
1264	=item $success = $term->selection_grab ($eventtime)	1425	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1265		1426
1266	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
1267	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
1268	is mostly useful from within C<on_sel_grab> hooks.	1430	is mostly useful from within C<on_sel_grab> hooks.
1269		1431
1270	=item $oldtext = $term->selection ([$newtext])	1432	=item $oldtext = $term->selection ([$newtext, $clipboard])
1271		1433
1272	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.
1273		1440
1274	=item $term->overlay_simple ($x, $y, $text)	1441	=item $term->overlay_simple ($x, $y, $text)
1275		1442
1276	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.
1277		1444
…		…
1307		1474
1308	The methods currently supported on C<urxvt::overlay> objects are:	1475	The methods currently supported on C<urxvt::overlay> objects are:
1309		1476
1310	=over 4	1477	=over 4
1311		1478
1312	=item $overlay->set ($x, $y, $text, $rend)	1479	=item $overlay->set ($x, $y, $text[, $rend])
1313		1480
1314	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
1315	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
1316	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.
1317		1486
1318	=item $overlay->hide	1487	=item $overlay->hide
1319		1488
1320	If visible, hide the overlay, but do not destroy it.	1489	If visible, hide the overlay, but do not destroy it.
1321		1490
…		…
1403	locale-specific encoding of the terminal and can contain command sequences	1572	locale-specific encoding of the terminal and can contain command sequences
1404	(escape codes) that will be interpreted.	1573	(escape codes) that will be interpreted.
1405		1574
1406	=item $term->tt_write ($octets)	1575	=item $term->tt_write ($octets)
1407		1576
1408	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
1409	pass characters instead of octets, you should convert your strings first	1578	pass characters instead of octets, you should convert your strings first
1410	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.
1411		1586
1412	=item $old_events = $term->pty_ev_events ([$new_events])	1587	=item $old_events = $term->pty_ev_events ([$new_events])
1413		1588
1414	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
1415	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
…		…
1513		1688
1514	Returns the currently displayed screen (0 primary, 1 secondary).	1689	Returns the currently displayed screen (0 primary, 1 secondary).
1515		1690
1516	=item $cursor_is_hidden = $term->hidden_cursor	1691	=item $cursor_is_hidden = $term->hidden_cursor
1517		1692
1518	Returns wether the cursor is currently hidden or not.	1693	Returns whether the cursor is currently hidden or not.
1519		1694
1520	=item $view_start = $term->view_start ([$newvalue])	1695	=item $view_start = $term->view_start ([$newvalue])
1521		1696
1522	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
1523	C<0>, which displays the normal terminal contents. Lower values scroll	1698	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1531		1706
1532	Used after changing terminal contents to display them.	1707	Used after changing terminal contents to display them.
1533		1708
1534	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1709	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1535		1710
1536	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 >>
1537	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
1538	terminal line. The scrollback buffer starts at line C<-1> and extends to
1539	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1713	terminal line. Nothing will be returned if a nonexistent line
1540	is requested.	1714	is requested.
1541		1715
1542	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
1543	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
1544	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
1545	automatically be updated.	1719	automatically be updated.
1546		1720
1547	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
1548	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)
1549	characters. Characters with combining characters and other characters that	1723	characters. Characters with combining characters and other characters that
1550	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
1551	in the private use area.	1725	in the private use area.
1552		1726
1553	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
1554	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
1555	characters.	1729	characters.
…		…
1700	where one character corresponds to one screen cell. See	1874	where one character corresponds to one screen cell. See
1701	C<< $term->ROW_t >> for details.	1875	C<< $term->ROW_t >> for details.
1702		1876
1703	=item $string = $term->special_decode $text	1877	=item $string = $term->special_decode $text
1704		1878
1705	Converts rxvt-unicodes text reprsentation into a perl string. See	1879	Converts rxvt-unicodes text representation into a perl string. See
1706	C<< $term->ROW_t >> for details.	1880	C<< $term->ROW_t >> for details.
1707		1881
1708	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1882	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1709		1883
1710	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1884	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1713	manpage.	1887	manpage.
1714		1888
1715	=item $success = $term->grab ($eventtime[, $sync])	1889	=item $success = $term->grab ($eventtime[, $sync])
1716		1890
1717	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1891	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1718	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1892	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1719		1893
1720	=item $term->allow_events_async	1894	=item $term->allow_events_async
1721		1895
1722	Calls XAllowEvents with AsyncBoth for the most recent grab.	1896	Calls XAllowEvents with AsyncBoth for the most recent grab.
1723		1897
…		…
1730	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1904	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1731	recent grab.	1905	recent grab.
1732		1906
1733	=item $term->ungrab	1907	=item $term->ungrab
1734		1908
1735	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
1736	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
1737	the session.	1911	the session.
1738		1912
1739	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1913	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1740		1914
…		…
1742		1916
1743	=item @atoms = $term->XListProperties ($window)	1917	=item @atoms = $term->XListProperties ($window)
1744		1918
1745	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1919	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1746		1920
1747	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1921	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1748		1922
1749	=item $term->XDeleteProperty ($window, $property)	1923	=item $term->XDeleteProperty ($window, $property)
1750		1924
1751	=item $window = $term->DefaultRootWindow	1925	=item $window = $term->DefaultRootWindow
1752		1926
…		…
1762		1936
1763	=item $term->XChangeInput ($window, $add_events[, $del_events])	1937	=item $term->XChangeInput ($window, $add_events[, $del_events])
1764		1938
1765	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
1766	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
1767	directory onto the X functions of the same name.	1941	directly onto the X functions of the same name.
1768		1942
1769	=back	1943	=back
1770		1944
1771	=cut	1945	=cut
1772		1946
…		…
1874	my $env = $self->{term}->env;	2048	my $env = $self->{term}->env;
1875	# 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.
1876	delete $env->{LC_ALL};	2050	delete $env->{LC_ALL};
1877	$env->{LC_CTYPE} = $self->{term}->locale;	2051	$env->{LC_CTYPE} = $self->{term}->locale;
1878		2052
1879	urxvt::term->new ($env, "popup",	2053	my $term = urxvt::term->new (
		2054	$env, "popup",
1880	"--perl-lib" => "", "--perl-ext-common" => "",	2055	"--perl-lib" => "", "--perl-ext-common" => "",
1881	"-pty-fd" => -1, "-sl" => 0,	2056	"-pty-fd" => -1, "-sl" => 0,
1882	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2057	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1883	"--transient-for" => $self->{term}->parent,	2058	"--transient-for" => $self->{term}->parent,
1884	"-display" => $self->{term}->display_id,	2059	"-display" => $self->{term}->display_id,
1885	"-pe" => "urxvt-popup")	2060	"-pe" => "urxvt-popup",
1886	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	}
1887	}	2068	}
1888		2069
1889	sub DESTROY {	2070	sub DESTROY {
1890	my ($self) = @_;	2071	my ($self) = @_;
1891		2072
…		…
1896	=back	2077	=back
1897		2078
1898	=cut	2079	=cut
1899		2080
1900	package urxvt::watcher;	2081	package urxvt::watcher;
1901
1902	@urxvt::timer::ISA = __PACKAGE__;
1903	@urxvt::iow::ISA = __PACKAGE__;
1904	@urxvt::pw::ISA = __PACKAGE__;
1905	@urxvt::iw::ISA = __PACKAGE__;
1906		2082
1907	=head2 The C<urxvt::timer> Class	2083	=head2 The C<urxvt::timer> Class
1908		2084
1909	This class implements timer watchers/events. Time is represented as a	2085	This class implements timer watchers/events. Time is represented as a
1910	fractional number of seconds since the epoch. Example:	2086	fractional number of seconds since the epoch. Example:
…		…
1914	->new	2090	->new
1915	->interval (1)	2091	->interval (1)
1916	->cb (sub {	2092	->cb (sub {
1917	$term->{overlay}->set (0, 0,	2093	$term->{overlay}->set (0, 0,
1918	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2094	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1919	});	2095	});
1920		2096
1921	=over 4	2097	=over 4
1922		2098
1923	=item $timer = new urxvt::timer	2099	=item $timer = new urxvt::timer
1924		2100
…		…
1927		2103
1928	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2104	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1929		2105
1930	Set the callback to be called when the timer triggers.	2106	Set the callback to be called when the timer triggers.
1931		2107
1932	=item $tstamp = $timer->at
1933
1934	Return the time this watcher will fire next.
1935
1936	=item $timer = $timer->set ($tstamp)	2108	=item $timer = $timer->set ($tstamp[, $interval])
1937		2109
1938	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).
1939		2112
1940	=item $timer = $timer->interval ($interval)	2113	=item $timer = $timer->interval ($interval)
1941		2114
1942	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
1943	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
1944	is automatically rescheduled at the given intervals.	2117	is automatically rescheduled at the given intervals.
1945		2118
1946	=item $timer = $timer->start	2119	=item $timer = $timer->start
1947		2120
1948	Start the timer.	2121	Start the timer.
1949		2122
1950	=item $timer = $timer->start ($tstamp)	2123	=item $timer = $timer->start ($tstamp[, $interval])
1951		2124
1952	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.
1953		2127
1954	=item $timer = $timer->after ($delay)	2128	=item $timer = $timer->after ($delay[, $interval])
1955		2129
1956	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>.
1957		2131
1958	=item $timer = $timer->stop	2132	=item $timer = $timer->stop
1959		2133
…		…
1967		2141
1968	$term->{socket} = ...	2142	$term->{socket} = ...
1969	$term->{iow} = urxvt::iow	2143	$term->{iow} = urxvt::iow
1970	->new	2144	->new
1971	->fd (fileno $term->{socket})	2145	->fd (fileno $term->{socket})
1972	->events (urxvt::EVENT_READ)	2146	->events (urxvt::EV_READ)
1973	->start	2147	->start
1974	->cb (sub {	2148	->cb (sub {
1975	my ($iow, $revents) = @_;	2149	my ($iow, $revents) = @_;
1976	# $revents must be 1 here, no need to check	2150	# $revents must be 1 here, no need to check
1977	sysread $term->{socket}, my $buf, 8192	2151	sysread $term->{socket}, my $buf, 8192
…		…
1990	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>
1991	is a bitset as described in the C<events> method.	2165	is a bitset as described in the C<events> method.
1992		2166
1993	=item $iow = $iow->fd ($fd)	2167	=item $iow = $iow->fd ($fd)
1994		2168
1995	Set the filedescriptor (not handle) to watch.	2169	Set the file descriptor (not handle) to watch.
1996		2170
1997	=item $iow = $iow->events ($eventmask)	2171	=item $iow = $iow->events ($eventmask)
1998		2172
1999	Set the event mask to watch. The only allowed values are	2173	Set the event mask to watch. The only allowed values are
2000	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
2001	together, or C<urxvt::EVENT_NONE>.	2175	together, or C<urxvt::EV_NONE>.
2002		2176
2003	=item $iow = $iow->start	2177	=item $iow = $iow->start
2004		2178
2005	Start watching for requested events on the given handle.	2179	Start watching for requested events on the given handle.
2006		2180
2007	=item $iow = $iow->stop	2181	=item $iow = $iow->stop
2008		2182
2009	Stop watching for events on the given filehandle.	2183	Stop watching for events on the given file handle.
2010		2184
2011	=back	2185	=back
2012		2186
2013	=head2 The C<urxvt::iw> Class	2187	=head2 The C<urxvt::iw> Class
2014		2188
…		…
2047	->new	2221	->new
2048	->start ($pid)	2222	->start ($pid)
2049	->cb (sub {	2223	->cb (sub {
2050	my ($pw, $exit_status) = @_;	2224	my ($pw, $exit_status) = @_;
2051	...	2225	...
2052	});	2226	});
2053		2227
2054	=over 4	2228	=over 4
2055		2229
2056	=item $pw = new urxvt::pw	2230	=item $pw = new urxvt::pw
2057		2231
…		…
2061		2235
2062	Set the callback to be called when the timer triggers.	2236	Set the callback to be called when the timer triggers.
2063		2237
2064	=item $pw = $timer->start ($pid)	2238	=item $pw = $timer->start ($pid)
2065		2239
2066	Tells the wqtcher to start watching for process C<$pid>.	2240	Tells the watcher to start watching for process C<$pid>.
2067		2241
2068	=item $pw = $pw->stop	2242	=item $pw = $pw->stop
2069		2243
2070	Stop the watcher.	2244	Stop the watcher.
2071		2245
…		…
2084		2258
2085	=item >= 3 - script loading and management	2259	=item >= 3 - script loading and management
2086		2260
2087	=item >=10 - all called hooks	2261	=item >=10 - all called hooks
2088		2262
2089	=item >=11 - hook reutrn values	2263	=item >=11 - hook return values
2090		2264
2091	=back	2265	=back
2092		2266
2093	=head1 AUTHOR	2267	=head1 AUTHOR
2094		2268
2095	Marc Lehmann <pcg@goof.com>	2269	Marc Lehmann <schmorp@schmorp.de>
2096	http://software.schmorp.de/pkg/rxvt-unicode	2270	http://software.schmorp.de/pkg/rxvt-unicode
2097		2271
2098	=cut	2272	=cut
2099		2273
2100	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.140 by root, Mon Jul 3 19:10:09 2006 UTC vs. Revision 1.199 by sf-exg, Sun Nov 20 10:49:56 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.140 by root, Mon Jul 3 19:10:09 2006 UTC vs.
Revision 1.199 by sf-exg, Sun Nov 20 10:49:56 2011 UTC