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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.142 by root, Thu Jul 6 18:56:10 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.
155		158
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To	159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>	160	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.	161	or simply use an uppercase character which removes the "(?i)" prefix.
159		162
…		…
162	=item readline (enabled by default)	165	=item readline (enabled by default)
163		166
164	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
165	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
166	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
167	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
168	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
169		172
170	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
171		174
172	=over 4	175	=over 4
…		…
220	the message into vi commands to load the file.	223	the message into vi commands to load the file.
221		224
222	=item tabbed	225	=item tabbed
223		226
224	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
225	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
226	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
227	button per tab.	230	button per tab.
228		231
229	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
230	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,
…		…
240	URxvt.tabbed.tab-bg: <colour-index, default 1>	243	URxvt.tabbed.tab-bg: <colour-index, default 1>
241		244
242	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
243	indices.	246	indices.
244		247
245	=item mark-urls	248	=item matcher
246		249
247	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
248	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
249	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
250	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
251		278
252	=item xim-onthespot	279	=item xim-onthespot
253		280
254	This (experimental) perl extension implements OnTheSpot editing. It does	281	This (experimental) perl extension implements OnTheSpot editing. It does
255	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
256	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
257	kinput2.	284	kinput2.
258		285
259	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
260	C<OnTheSpot>, i.e.:	287	C<OnTheSpot>, i.e.:
261		288
262	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
263		290
264	=item automove-background	291	=item kuake<hotkey>
265		292
266	This is basically a very small extension that dynamically changes the	293	A very primitive quake-console-like extension. It was inspired by a
267	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
268	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
269	supported in this mode. Exmaple:	296	will show or hide itself. Another press of the accelerator key will hide
		297	or show it again.
270		298
271	@@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.
272		315
273	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
274		317
275	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
276	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
…		…
281	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
282		325
283	=item remote-clipboard	326	=item remote-clipboard
284		327
285	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
286	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
287	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
288		331
289	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
290	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
291	reads it.	334	reads it.
…		…
300	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
301	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
302		345
303	=item selection-pastebin	346	=item selection-pastebin
304		347
305	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
306	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
307	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
308	F</tmp> directly.).	351	F</tmp> directly.).
309		352
310	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
327	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
328	for the filename):	371	for the filename):
329		372
330	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
331		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
332	=item example-refresh-hooks	394	=item example-refresh-hooks
333		395
334	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
335	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
336	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"
337		412
338	=back	413	=back
339		414
340	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
341		416
…		…
357		432
358	=over 4	433	=over 4
359		434
360	=item $text	435	=item $text
361		436
362	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
363	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.
364		439
365	=item $string	440	=item $string
366		441
367	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
…		…
376	=back	451	=back
377		452
378	=head2 Extension Objects	453	=head2 Extension Objects
379		454
380	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
381	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,
382	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
383	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
384	begin with an underscore character C<_>: these are reserved for internal	460	that begin with an underscore character C<_>: these are reserved for
385	use.	461	internal use.
386		462
387	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
388	C<urxvt::term> class on this object.	464	C<urxvt::term> class on this object.
389		465
390	It has the following methods and data members:	466	It has the following methods and data members:
…		…
411	=head2 Hooks	487	=head2 Hooks
412		488
413	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
414	called whenever the relevant event happens.	490	called whenever the relevant event happens.
415		491
416	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
417	the in the C<Extension Objects> section.	493	the in the C<Extension Objects> section.
418		494
419	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
420	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
421	relevant action might not be carried out by the C++ code.	497	relevant action might not be carried out by the C++ code.
…		…
434	place.	510	place.
435		511
436	=item on_start $term	512	=item on_start $term
437		513
438	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
439	trying to map (display) the toplevel and returning to the mainloop.	515	trying to map (display) the toplevel and returning to the main loop.
440		516
441	=item on_destroy $term	517	=item on_destroy $term
442		518
443	Called whenever something tries to destroy terminal, when the terminal is	519	Called whenever something tries to destroy terminal, when the terminal is
444	still fully functional (not for long, though).	520	still fully functional (not for long, though).
…		…
471		547
472	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
473	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
474	by calling C<< $term->selection >>.	550	by calling C<< $term->selection >>.
475		551
476	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.
477		553
478	=item on_sel_extend $term	554	=item on_sel_extend $term
479		555
480	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
481	click) and is either supposed to return false (normal operation), or	557	click) and is either supposed to return false (normal operation), or
482	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
483	processing. This can happen multiple times, as long as the callback	559	processing. This can happen multiple times, as long as the callback
484	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
485	supposed to enlarge the selection more and more, if possible.	561	supposed to enlarge the selection more and more, if possible.
486		562
487	See the F<selection> example extension.	563	See the F<selection> example extension.
488		564
489	=item on_view_change $term, $offset	565	=item on_view_change $term, $offset
490		566
491	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
492	scrolls. Offset C<0> means display the normal terminal, positive values	568	scrolls. Offset C<0> means display the normal terminal, positive values
493	show this many lines of scrollback.	569	show this many lines of scrollback.
494		570
495	=item on_scroll_back $term, $lines, $saved	571	=item on_scroll_back $term, $lines, $saved
496		572
…		…
500		576
501	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,
502	$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
503	number of lines that will be in the scrollback buffer.	579	number of lines that will be in the scrollback buffer.
504		580
505	=item on_osc_seq $term, $op, $args	581	=item on_osc_seq $term, $op, $args, $resp
506		582
507	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
508	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
509	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
510	confused by recursive invocations when you output an osc sequence within	586	confused by recursive invocations when you output an OSC sequence within
511	this callback.	587	this callback.
512		588
513	C<on_osc_seq_perl> should be used for new behaviour.	589	C<on_osc_seq_perl> should be used for new behaviour.
514		590
515	=item on_osc_seq_perl $term, $string	591	=item on_osc_seq_perl $term, $args, $resp
516		592
517	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	593	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
518	operating system command) is processed. Cursor position and other state	594	operating system command) is processed. Cursor position and other state
519	information is up-to-date when this happens. For interoperability, the	595	information is up-to-date when this happens. For interoperability, the
520	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,
521	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
522	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	}
523		609
524	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,
525	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
526	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.
527		616
528	=item on_add_lines $term, $string	617	=item on_add_lines $term, $string
529		618
530	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
531	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
…		…
536	=item on_tt_write $term, $octets	625	=item on_tt_write $term, $octets
537		626
538	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
539	suppress or filter tty input.	628	suppress or filter tty input.
540		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
541	=item on_line_update $term, $row	637	=item on_line_update $term, $row
542		638
543	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
544	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
545	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,
…		…
552	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
553	you cannot just toggle rendition bits, but only set them.	649	you cannot just toggle rendition bits, but only set them.
554		650
555	=item on_refresh_begin $term	651	=item on_refresh_begin $term
556		652
557	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
558	or similar effects by modify terminal contents in refresh_begin, and	654	similar effects by modifying the terminal contents in refresh_begin, and
559	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
560	code is run after this hook, and takes precedence.	656	code is run after this hook, and takes precedence.
561		657
562	=item on_refresh_end $term	658	=item on_refresh_end $term
563		659
564	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>.
565		661
566	=item on_user_command $term, $string	662	=item on_user_command $term, $string
567		663
568	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
569	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>
570	resource in the @@RXVT_NAME@@(1) manpage).	666	resource in the @@RXVT_NAME@@(1) manpage).
571		667
572	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
573	slightly in the future.	669	slightly in the future.
574		670
575	=item on_resize_all_windows $tern, $new_width, $new_height	671	=item on_resize_all_windows $term, $new_width, $new_height
576		672
577	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
578	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
579	returns TRUE, setting of the window hints is being skipped.	675	returns TRUE, setting of the window hints is being skipped.
580		676
581	=item on_x_event $term, $event	677	=item on_x_event $term, $event
582		678
583	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
584	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
585	members are not passed.	681	members are not passed.
586		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
587	=item on_focus_in $term	687	=item on_focus_in $term
588		688
589	Called whenever the window gets the keyboard focus, before rxvt-unicode	689	Called whenever the window gets the keyboard focus, before rxvt-unicode
590	does focus in processing.	690	does focus in processing.
591		691
592	=item on_focus_out $term	692	=item on_focus_out $term
593		693
594	Called wheneever the window loses keyboard focus, before rxvt-unicode does	694	Called whenever the window loses keyboard focus, before rxvt-unicode does
595	focus out processing.	695	focus out processing.
596		696
597	=item on_configure_notify $term, $event	697	=item on_configure_notify $term, $event
598		698
599	=item on_property_notify $term, $event	699	=item on_property_notify $term, $event
…		…
610		710
611	=item on_map_notify $term, $event	711	=item on_map_notify $term, $event
612		712
613	=item on_unmap_notify $term, $event	713	=item on_unmap_notify $term, $event
614		714
615	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
616	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.
617		717
618	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
619	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
620	(real, not screen-based) row and column under the mouse cursor.	720	(real, not screen-based) row and column under the mouse cursor.
621		721
…		…
630		730
631	=item on_wm_delete_window $term, $event	731	=item on_wm_delete_window $term, $event
632		732
633	Called when various types of ClientMessage events are received (all with	733	Called when various types of ClientMessage events are received (all with
634	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.
635		739
636	=back	740	=back
637		741
638	=cut	742	=cut
639		743
…		…
682	The current terminal. This variable stores the current C<urxvt::term>	786	The current terminal. This variable stores the current C<urxvt::term>
683	object, whenever a callback/hook is executing.	787	object, whenever a callback/hook is executing.
684		788
685	=item @urxvt::TERM_INIT	789	=item @urxvt::TERM_INIT
686		790
687	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
688	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
689	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,
690	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.
691		795
692	This complements to the perl-eval commandline option, but gets executed	796	This complements to the perl-eval command line option, but gets executed
693	first.	797	first.
694		798
695	=item @urxvt::TERM_EXT	799	=item @urxvt::TERM_EXT
696		800
697	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
…		…
704		808
705	=over 4	809	=over 4
706		810
707	=item urxvt::fatal $errormessage	811	=item urxvt::fatal $errormessage
708		812
709	Fatally aborts execution with the given error message. Avoid at all	813	Fatally aborts execution with the given error message (which should
710	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
711	starts up.	815	is acceptable (and useful) is in the init hook, where it prevents the
		816	terminal from starting up.
712		817
713	=item urxvt::warn $string	818	=item urxvt::warn $string
714		819
715	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
716	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
717	that calls this function.	822	that calls this function.
718		823
719	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
720	correct place, e.g. on stderr of the connecting urxvtc client.	825	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
722	Messages have a size limit of 1023 bytes currently.	827	Messages have a size limit of 1023 bytes currently.
723		828
724	=item @terms = urxvt::termlist	829	=item @terms = urxvt::termlist
725		830
726	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
727	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
728	objects that have perl extensions attached will be returned (because there	833	objects that have perl extensions attached will be returned (because there
729	is no urxvt::term objet associated with others).	834	is no urxvt::term object associated with others).
730		835
731	=item $time = urxvt::NOW	836	=item $time = urxvt::NOW
732		837
733	Returns the "current time" (as per the event loop).	838	Returns the "current time" (as per the event loop).
734		839
…		…
777		882
778	=item $rend = urxvt::OVERLAY_RSTYLE	883	=item $rend = urxvt::OVERLAY_RSTYLE
779		884
780	Return the rendition mask used for overlays by default.	885	Return the rendition mask used for overlays by default.
781		886
782	=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
783		889
784	Return the bit that enabled bold, italic, blink, reverse-video and	890	Return the bit that enabled bold, italic, blink, reverse-video and
785	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
786	the bitset.	892	the bitset.
787		893
…		…
870	local $TERM = shift;	976	local $TERM = shift;
871	my $htype = shift;	977	my $htype = shift;
872		978
873	if ($htype == 0) { # INIT	979	if ($htype == 0) { # INIT
874	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	980	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
875		981
876	my %ext_arg;	982	my %ext_arg;
877		983
878	{	984	{
879	my @init = @TERM_INIT;	985	my @init = @TERM_INIT;
880	@TERM_INIT = ();	986	@TERM_INIT = ();
…		…
943		1049
944	sub SET_COLOR($$$) {	1050	sub SET_COLOR($$$) {
945	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1051	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
946	}	1052	}
947		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
948	# urxvt::term::extension	1079	# urxvt::term::extension
949		1080
950	package urxvt::term::extension;	1081	package urxvt::term::extension;
951		1082
952	sub enable {	1083	sub enable {
…		…
1021	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
1022	work.	1153	work.
1023		1154
1024	=cut	1155	=cut
1025		1156
1026	our $VERSION = 1;	1157	our $VERSION = '5.23';
1027		1158
1028	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1159	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1029	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1160	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1030		1161
1031	sub timer {	1162	sub timer {
…		…
1033		1164
1034	my $cb = $arg{cb};	1165	my $cb = $arg{cb};
1035		1166
1036	urxvt::timer	1167	urxvt::timer
1037	->new	1168	->new
1038	->start (urxvt::NOW + $arg{after})	1169	->after ($arg{after}, $arg{interval})
1039	->cb (sub {	1170	->cb ($arg{interval} ? $cb : sub {
1040	$_[0]->stop; # need to cancel manually	1171	$_[0]->stop; # need to cancel manually
1041	$cb->();	1172	$cb->();
1042	})	1173	})
1043	}	1174	}
1044		1175
1045	sub io {	1176	sub io {
1046	my ($class, %arg) = @_;	1177	my ($class, %arg) = @_;
1047		1178
1048	my $cb = $arg{cb};	1179	my $cb = $arg{cb};
		1180	my $fd = fileno $arg{fh};
		1181	defined $fd or $fd = $arg{fh};
1049		1182
1050	bless [$arg{fh}, urxvt::iow	1183	bless [$arg{fh}, urxvt::iow
1051	->new	1184	->new
1052	->fd (fileno $arg{fh})	1185	->fd ($fd)
1053	->events (($arg{poll} =~ /r/ ? 1 : 0)	1186	->events (($arg{poll} =~ /r/ ? 1 : 0)
1054	\| ($arg{poll} =~ /w/ ? 2 : 0))	1187	\| ($arg{poll} =~ /w/ ? 2 : 0))
1055	->start	1188	->start
1056	->cb (sub {	1189	->cb ($cb)
1057	$cb->(($_[1] & 1 ? 'r' : '')
1058	. ($_[1] & 2 ? 'w' : ''));
1059	})],
1060	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	})
1061	}	1216	}
1062		1217
1063	sub DESTROY {	1218	sub DESTROY {
1064	$_[0][1]->stop;	1219	$_[0][1]->stop;
1065	}	1220	}
1066		1221
1067	sub condvar {	1222	# only needed for AnyEvent < 6 compatibility
1068	bless \my $flag, urxvt::anyevent::condvar::	1223	sub one_event {
1069	}
1070
1071	sub urxvt::anyevent::condvar::broadcast {
1072	${$_[0]}++;
1073	}
1074
1075	sub urxvt::anyevent::condvar::wait {
1076	unless (${$_[0]}) {
1077	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";
1078	}
1079	}	1225	}
1080		1226
1081	package urxvt::term;	1227	package urxvt::term;
1082		1228
1083	=head2 The C<urxvt::term> Class	1229	=head2 The C<urxvt::term> Class
…		…
1170		1316
1171	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
1172	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
1173	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.
1174		1320
1175	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
1176	source file F</src/optinc.h> to see the actual list:	1322	source file F</src/optinc.h> to see the actual list:
1177		1323
1178	borderLess console cursorBlink cursorUnderline hold iconic insecure	1324	borderLess buffered console cursorBlink cursorUnderline hold iconic
1179	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1325	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1180	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1326	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1181	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1327	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1182	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1328	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1183	transparent tripleclickwords utmpInhibit visualBell	1329	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1330	urgentOnBell utmpInhibit visualBell
1184		1331
1185	=item $value = $term->resource ($name[, $newval])	1332	=item $value = $term->resource ($name[, $newval])
1186		1333
1187	Returns the current resource value associated with a given name and	1334	Returns the current resource value associated with a given name and
1188	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>
…		…
1197	likely change).	1344	likely change).
1198		1345
1199	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
1200	terminal is destroyed, so changing options frequently will eat memory.	1347	terminal is destroyed, so changing options frequently will eat memory.
1201		1348
1202	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
1203	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>
1204	to see the actual list:	1351	to see the actual list:
1205		1352
1206	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1353	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1207	borderLess color cursorBlink cursorUnderline cutchars delete_key	1354	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1208	display_name embed ext_bwidth fade font geometry hold iconName	1355	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1209	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
1210	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1358	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1211	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1359	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1212	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1360	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1213	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1361	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1214	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1362	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1215	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1363	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1216	secondaryScreen secondaryScroll selectstyle shade term_name title	1364	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1217	transient_for transparent transparent_all tripleclickwords utmpInhibit	1365	term_name title transient_for transparent tripleclickwords urgentOnBell
1218	visualBell	1366	utmpInhibit visualBell
1219		1367
1220	=cut	1368	=cut
1221		1369
1222	sub resource($$;$) {	1370	sub resource($$;$) {
1223	my ($self, $name) = (shift, shift);	1371	my ($self, $name) = (shift, shift);
1224	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1372	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1225	&urxvt::term::_resource	1373	goto &urxvt::term::_resource
1226	}	1374	}
1227		1375
1228	=item $value = $term->x_resource ($pattern)	1376	=item $value = $term->x_resource ($pattern)
1229		1377
1230	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
…		…
1255		1403
1256	=item ($row, $col) = $term->selection_beg ([$row, $col])	1404	=item ($row, $col) = $term->selection_beg ([$row, $col])
1257		1405
1258	=item ($row, $col) = $term->selection_end ([$row, $col])	1406	=item ($row, $col) = $term->selection_end ([$row, $col])
1259		1407
1260	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.
1261	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.
1262		1417
1263	=item $term->selection_make ($eventtime[, $rectangular])	1418	=item $term->selection_make ($eventtime[, $rectangular])
1264		1419
1265	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
1266	C<selection_end>. If C<$rectangular> is true (default: false), a	1421	C<selection_end>. If C<$rectangular> is true (default: false), a
1267	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
1268	a selection.	1423	a selection.
1269		1424
1270	=item $success = $term->selection_grab ($eventtime)	1425	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1271		1426
1272	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
1273	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
1274	is mostly useful from within C<on_sel_grab> hooks.	1430	is mostly useful from within C<on_sel_grab> hooks.
1275		1431
1276	=item $oldtext = $term->selection ([$newtext])	1432	=item $oldtext = $term->selection ([$newtext, $clipboard])
1277		1433
1278	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.
1279		1440
1280	=item $term->overlay_simple ($x, $y, $text)	1441	=item $term->overlay_simple ($x, $y, $text)
1281		1442
1282	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.
1283		1444
…		…
1313		1474
1314	The methods currently supported on C<urxvt::overlay> objects are:	1475	The methods currently supported on C<urxvt::overlay> objects are:
1315		1476
1316	=over 4	1477	=over 4
1317		1478
1318	=item $overlay->set ($x, $y, $text, $rend)	1479	=item $overlay->set ($x, $y, $text[, $rend])
1319		1480
1320	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
1321	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
1322	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.
1323		1486
1324	=item $overlay->hide	1487	=item $overlay->hide
1325		1488
1326	If visible, hide the overlay, but do not destroy it.	1489	If visible, hide the overlay, but do not destroy it.
1327		1490
…		…
1409	locale-specific encoding of the terminal and can contain command sequences	1572	locale-specific encoding of the terminal and can contain command sequences
1410	(escape codes) that will be interpreted.	1573	(escape codes) that will be interpreted.
1411		1574
1412	=item $term->tt_write ($octets)	1575	=item $term->tt_write ($octets)
1413		1576
1414	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
1415	pass characters instead of octets, you should convert your strings first	1578	pass characters instead of octets, you should convert your strings first
1416	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.
1417		1586
1418	=item $old_events = $term->pty_ev_events ([$new_events])	1587	=item $old_events = $term->pty_ev_events ([$new_events])
1419		1588
1420	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
1421	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
…		…
1519		1688
1520	Returns the currently displayed screen (0 primary, 1 secondary).	1689	Returns the currently displayed screen (0 primary, 1 secondary).
1521		1690
1522	=item $cursor_is_hidden = $term->hidden_cursor	1691	=item $cursor_is_hidden = $term->hidden_cursor
1523		1692
1524	Returns wether the cursor is currently hidden or not.	1693	Returns whether the cursor is currently hidden or not.
1525		1694
1526	=item $view_start = $term->view_start ([$newvalue])	1695	=item $view_start = $term->view_start ([$newvalue])
1527		1696
1528	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
1529	C<0>, which displays the normal terminal contents. Lower values scroll	1698	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1537		1706
1538	Used after changing terminal contents to display them.	1707	Used after changing terminal contents to display them.
1539		1708
1540	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1709	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1541		1710
1542	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 >>
1543	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
1544	terminal line. The scrollback buffer starts at line C<-1> and extends to
1545	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1713	terminal line. Nothing will be returned if a nonexistent line
1546	is requested.	1714	is requested.
1547		1715
1548	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
1549	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
1550	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
1551	automatically be updated.	1719	automatically be updated.
1552		1720
1553	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
1554	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)
1555	characters. Characters with combining characters and other characters that	1723	characters. Characters with combining characters and other characters that
1556	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
1557	in the private use area.	1725	in the private use area.
1558		1726
1559	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
1560	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
1561	characters.	1729	characters.
…		…
1706	where one character corresponds to one screen cell. See	1874	where one character corresponds to one screen cell. See
1707	C<< $term->ROW_t >> for details.	1875	C<< $term->ROW_t >> for details.
1708		1876
1709	=item $string = $term->special_decode $text	1877	=item $string = $term->special_decode $text
1710		1878
1711	Converts rxvt-unicodes text reprsentation into a perl string. See	1879	Converts rxvt-unicodes text representation into a perl string. See
1712	C<< $term->ROW_t >> for details.	1880	C<< $term->ROW_t >> for details.
1713		1881
1714	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1882	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1715		1883
1716	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1884	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1719	manpage.	1887	manpage.
1720		1888
1721	=item $success = $term->grab ($eventtime[, $sync])	1889	=item $success = $term->grab ($eventtime[, $sync])
1722		1890
1723	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1891	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1724	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1892	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1725		1893
1726	=item $term->allow_events_async	1894	=item $term->allow_events_async
1727		1895
1728	Calls XAllowEvents with AsyncBoth for the most recent grab.	1896	Calls XAllowEvents with AsyncBoth for the most recent grab.
1729		1897
…		…
1736	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1904	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1737	recent grab.	1905	recent grab.
1738		1906
1739	=item $term->ungrab	1907	=item $term->ungrab
1740		1908
1741	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
1742	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
1743	the session.	1911	the session.
1744		1912
1745	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1913	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1746		1914
…		…
1748		1916
1749	=item @atoms = $term->XListProperties ($window)	1917	=item @atoms = $term->XListProperties ($window)
1750		1918
1751	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1919	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1752		1920
1753	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1921	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1754		1922
1755	=item $term->XDeleteProperty ($window, $property)	1923	=item $term->XDeleteProperty ($window, $property)
1756		1924
1757	=item $window = $term->DefaultRootWindow	1925	=item $window = $term->DefaultRootWindow
1758		1926
…		…
1768		1936
1769	=item $term->XChangeInput ($window, $add_events[, $del_events])	1937	=item $term->XChangeInput ($window, $add_events[, $del_events])
1770		1938
1771	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
1772	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
1773	directory onto the X functions of the same name.	1941	directly onto the X functions of the same name.
1774		1942
1775	=back	1943	=back
1776		1944
1777	=cut	1945	=cut
1778		1946
…		…
1880	my $env = $self->{term}->env;	2048	my $env = $self->{term}->env;
1881	# 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.
1882	delete $env->{LC_ALL};	2050	delete $env->{LC_ALL};
1883	$env->{LC_CTYPE} = $self->{term}->locale;	2051	$env->{LC_CTYPE} = $self->{term}->locale;
1884		2052
1885	urxvt::term->new ($env, "popup",	2053	my $term = urxvt::term->new (
		2054	$env, "popup",
1886	"--perl-lib" => "", "--perl-ext-common" => "",	2055	"--perl-lib" => "", "--perl-ext-common" => "",
1887	"-pty-fd" => -1, "-sl" => 0,	2056	"-pty-fd" => -1, "-sl" => 0,
1888	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2057	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1889	"--transient-for" => $self->{term}->parent,	2058	"--transient-for" => $self->{term}->parent,
1890	"-display" => $self->{term}->display_id,	2059	"-display" => $self->{term}->display_id,
1891	"-pe" => "urxvt-popup")	2060	"-pe" => "urxvt-popup",
1892	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	}
1893	}	2068	}
1894		2069
1895	sub DESTROY {	2070	sub DESTROY {
1896	my ($self) = @_;	2071	my ($self) = @_;
1897		2072
…		…
1902	=back	2077	=back
1903		2078
1904	=cut	2079	=cut
1905		2080
1906	package urxvt::watcher;	2081	package urxvt::watcher;
1907
1908	@urxvt::timer::ISA = __PACKAGE__;
1909	@urxvt::iow::ISA = __PACKAGE__;
1910	@urxvt::pw::ISA = __PACKAGE__;
1911	@urxvt::iw::ISA = __PACKAGE__;
1912		2082
1913	=head2 The C<urxvt::timer> Class	2083	=head2 The C<urxvt::timer> Class
1914		2084
1915	This class implements timer watchers/events. Time is represented as a	2085	This class implements timer watchers/events. Time is represented as a
1916	fractional number of seconds since the epoch. Example:	2086	fractional number of seconds since the epoch. Example:
…		…
1920	->new	2090	->new
1921	->interval (1)	2091	->interval (1)
1922	->cb (sub {	2092	->cb (sub {
1923	$term->{overlay}->set (0, 0,	2093	$term->{overlay}->set (0, 0,
1924	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2094	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1925	});	2095	});
1926		2096
1927	=over 4	2097	=over 4
1928		2098
1929	=item $timer = new urxvt::timer	2099	=item $timer = new urxvt::timer
1930		2100
…		…
1933		2103
1934	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2104	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1935		2105
1936	Set the callback to be called when the timer triggers.	2106	Set the callback to be called when the timer triggers.
1937		2107
1938	=item $tstamp = $timer->at
1939
1940	Return the time this watcher will fire next.
1941
1942	=item $timer = $timer->set ($tstamp)	2108	=item $timer = $timer->set ($tstamp[, $interval])
1943		2109
1944	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).
1945		2112
1946	=item $timer = $timer->interval ($interval)	2113	=item $timer = $timer->interval ($interval)
1947		2114
1948	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
1949	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
1950	is automatically rescheduled at the given intervals.	2117	is automatically rescheduled at the given intervals.
1951		2118
1952	=item $timer = $timer->start	2119	=item $timer = $timer->start
1953		2120
1954	Start the timer.	2121	Start the timer.
1955		2122
1956	=item $timer = $timer->start ($tstamp)	2123	=item $timer = $timer->start ($tstamp[, $interval])
1957		2124
1958	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.
1959		2127
1960	=item $timer = $timer->after ($delay)	2128	=item $timer = $timer->after ($delay[, $interval])
1961		2129
1962	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>.
1963		2131
1964	=item $timer = $timer->stop	2132	=item $timer = $timer->stop
1965		2133
…		…
1973		2141
1974	$term->{socket} = ...	2142	$term->{socket} = ...
1975	$term->{iow} = urxvt::iow	2143	$term->{iow} = urxvt::iow
1976	->new	2144	->new
1977	->fd (fileno $term->{socket})	2145	->fd (fileno $term->{socket})
1978	->events (urxvt::EVENT_READ)	2146	->events (urxvt::EV_READ)
1979	->start	2147	->start
1980	->cb (sub {	2148	->cb (sub {
1981	my ($iow, $revents) = @_;	2149	my ($iow, $revents) = @_;
1982	# $revents must be 1 here, no need to check	2150	# $revents must be 1 here, no need to check
1983	sysread $term->{socket}, my $buf, 8192	2151	sysread $term->{socket}, my $buf, 8192
…		…
1996	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>
1997	is a bitset as described in the C<events> method.	2165	is a bitset as described in the C<events> method.
1998		2166
1999	=item $iow = $iow->fd ($fd)	2167	=item $iow = $iow->fd ($fd)
2000		2168
2001	Set the filedescriptor (not handle) to watch.	2169	Set the file descriptor (not handle) to watch.
2002		2170
2003	=item $iow = $iow->events ($eventmask)	2171	=item $iow = $iow->events ($eventmask)
2004		2172
2005	Set the event mask to watch. The only allowed values are	2173	Set the event mask to watch. The only allowed values are
2006	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
2007	together, or C<urxvt::EVENT_NONE>.	2175	together, or C<urxvt::EV_NONE>.
2008		2176
2009	=item $iow = $iow->start	2177	=item $iow = $iow->start
2010		2178
2011	Start watching for requested events on the given handle.	2179	Start watching for requested events on the given handle.
2012		2180
2013	=item $iow = $iow->stop	2181	=item $iow = $iow->stop
2014		2182
2015	Stop watching for events on the given filehandle.	2183	Stop watching for events on the given file handle.
2016		2184
2017	=back	2185	=back
2018		2186
2019	=head2 The C<urxvt::iw> Class	2187	=head2 The C<urxvt::iw> Class
2020		2188
…		…
2053	->new	2221	->new
2054	->start ($pid)	2222	->start ($pid)
2055	->cb (sub {	2223	->cb (sub {
2056	my ($pw, $exit_status) = @_;	2224	my ($pw, $exit_status) = @_;
2057	...	2225	...
2058	});	2226	});
2059		2227
2060	=over 4	2228	=over 4
2061		2229
2062	=item $pw = new urxvt::pw	2230	=item $pw = new urxvt::pw
2063		2231
…		…
2067		2235
2068	Set the callback to be called when the timer triggers.	2236	Set the callback to be called when the timer triggers.
2069		2237
2070	=item $pw = $timer->start ($pid)	2238	=item $pw = $timer->start ($pid)
2071		2239
2072	Tells the wqtcher to start watching for process C<$pid>.	2240	Tells the watcher to start watching for process C<$pid>.
2073		2241
2074	=item $pw = $pw->stop	2242	=item $pw = $pw->stop
2075		2243
2076	Stop the watcher.	2244	Stop the watcher.
2077		2245
…		…
2090		2258
2091	=item >= 3 - script loading and management	2259	=item >= 3 - script loading and management
2092		2260
2093	=item >=10 - all called hooks	2261	=item >=10 - all called hooks
2094		2262
2095	=item >=11 - hook reutrn values	2263	=item >=11 - hook return values
2096		2264
2097	=back	2265	=back
2098		2266
2099	=head1 AUTHOR	2267	=head1 AUTHOR
2100		2268
2101	Marc Lehmann <pcg@goof.com>	2269	Marc Lehmann <schmorp@schmorp.de>
2102	http://software.schmorp.de/pkg/rxvt-unicode	2270	http://software.schmorp.de/pkg/rxvt-unicode
2103		2271
2104	=cut	2272	=cut
2105		2273
2106	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.142 by root, Thu Jul 6 18:56:10 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.142 by root, Thu Jul 6 18:56:10 2006 UTC vs.
Revision 1.199 by sf-exg, Sun Nov 20 10:49:56 2011 UTC