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