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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.143 by root, Thu Jul 6 23:48:11 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.
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
…		…
269	will show or hide itself. Another press of the accelerator key will hide	296	will show or hide itself. Another press of the accelerator key will hide
270	or show it again.	297	or show it again.
271		298
272	Initially, the window will not be shown when using this extension.	299	Initially, the window will not be shown when using this extension.
273		300
274	This is useful if you need a single terminal thats not using any desktop	301	This is useful if you need a single terminal that is not using any desktop
275	space most of the time but is quickly available at the press of a key.	302	space most of the time but is quickly available at the press of a key.
276		303
277	The accelerator key is grabbed regardless of any modifers, so this	304	The accelerator key is grabbed regardless of any modifiers, so this
278	extension will actually grab a physical key just for this function.	305	extension will actually grab a physical key just for this function.
279		306
280	If you want a quake-like animation, tell your window manager to do so	307	If you want a quake-like animation, tell your window manager to do so
281	(fvwm can do it).	308	(fvwm can do it).
282		309
283	=item automove-background	310	=item overlay-osc
284		311
285	This is basically a very small extension that dynamically changes the	312	This extension implements some OSC commands to display timed popups on the
286	background pixmap offset to the window position, in effect creating the	313	screen - useful for status displays from within scripts. You have to read
287	same effect as pseudo transparency with a custom pixmap. No scaling is	314	the sources for more info.
288	supported in this mode. Exmaple:
289
290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291		315
292	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
293		317
294	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
295	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
…		…
300	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
301		325
302	=item remote-clipboard	326	=item remote-clipboard
303		327
304	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
305	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
306	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
307		331
308	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
309	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
310	reads it.	334	reads it.
…		…
319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
321		345
322	=item selection-pastebin	346	=item selection-pastebin
323		347
324	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
325	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
326	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
327	F</tmp> directly.).	351	F</tmp> directly.).
328		352
329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
346	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
347	for the filename):	371	for the filename):
348		372
349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
350		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
351	=item example-refresh-hooks	394	=item example-refresh-hooks
352		395
353	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
354	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
355	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"
356		412
357	=back	413	=back
358		414
359	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
360		416
…		…
376		432
377	=over 4	433	=over 4
378		434
379	=item $text	435	=item $text
380		436
381	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
382	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.
383		439
384	=item $string	440	=item $string
385		441
386	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
…		…
390	=item $octets	446	=item $octets
391		447
392	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
393	locale-specific way.	449	locale-specific way.
394		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
395	=back	457	=back
396		458
397	=head2 Extension Objects	459	=head2 Extension Objects
398		460
399	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
400	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,
401	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
402	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
403	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
404	use.	467	internal use.
405		468
406	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
407	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
408		471
409	It has the following methods and data members:	472	It has the following methods and data members:
…		…
430	=head2 Hooks	493	=head2 Hooks
431		494
432	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
433	called whenever the relevant event happens.	496	called whenever the relevant event happens.
434		497
435	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
436	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
437		500
438	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
439	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
440	relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
…		…
453	place.	516	place.
454		517
455	=item on_start $term	518	=item on_start $term
456		519
457	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
458	trying to map (display) the toplevel and returning to the mainloop.	521	trying to map (display) the toplevel and returning to the main loop.
459		522
460	=item on_destroy $term	523	=item on_destroy $term
461		524
462	Called whenever something tries to destroy terminal, when the terminal is	525	Called whenever something tries to destroy terminal, when the terminal is
463	still fully functional (not for long, though).	526	still fully functional (not for long, though).
…		…
490		553
491	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
492	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
493	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
494		557
495	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.
496		559
497	=item on_sel_extend $term	560	=item on_sel_extend $term
498		561
499	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
500	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
501	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
502	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
503	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
504	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
505		568
506	See the F<selection> example extension.	569	See the F<selection> example extension.
507		570
508	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
509		572
510	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
511	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
512	show this many lines of scrollback.	575	show this many lines of scrollback.
513		576
514	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
515		578
…		…
519		582
520	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,
521	$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
522	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
523		586
524	=item on_osc_seq $term, $op, $args	587	=item on_osc_seq $term, $op, $args, $resp
525		588
526	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
527	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
528	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
529	confused by recursive invocations when you output an osc sequence within	592	confused by recursive invocations when you output an OSC sequence within
530	this callback.	593	this callback.
531		594
532	C<on_osc_seq_perl> should be used for new behaviour.	595	C<on_osc_seq_perl> should be used for new behaviour.
533		596
534	=item on_osc_seq_perl $term, $string	597	=item on_osc_seq_perl $term, $args, $resp
535		598
536	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
537	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
538	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
539	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,
540	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
541	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	}
542		615
543	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,
544	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
545	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.
546		622
547	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
548		624
549	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
550	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
…		…
555	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
556		632
557	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
558	suppress or filter tty input.	634	suppress or filter tty input.
559		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
560	=item on_line_update $term, $row	643	=item on_line_update $term, $row
561		644
562	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
563	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
564	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,
…		…
571	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
572	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
573		656
574	=item on_refresh_begin $term	657	=item on_refresh_begin $term
575		658
576	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
577	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
578	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
579	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
580		663
581	=item on_refresh_end $term	664	=item on_refresh_end $term
582		665
583	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>.
584		667
585	=item on_user_command $term, $string	668	=item on_user_command $term, $string
586		669
587	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
588	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>
589	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
590		673
591	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
592	slightly in the future.	675	slightly in the future.
593		676
594	=item on_resize_all_windows $tern, $new_width, $new_height	677	=item on_resize_all_windows $term, $new_width, $new_height
595		678
596	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
597	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
598	returns TRUE, setting of the window hints is being skipped.	681	returns TRUE, setting of the window hints is being skipped.
599		682
600	=item on_x_event $term, $event	683	=item on_x_event $term, $event
601		684
…		…
612	Called whenever the window gets the keyboard focus, before rxvt-unicode	695	Called whenever the window gets the keyboard focus, before rxvt-unicode
613	does focus in processing.	696	does focus in processing.
614		697
615	=item on_focus_out $term	698	=item on_focus_out $term
616		699
617	Called wheneever the window loses keyboard focus, before rxvt-unicode does	700	Called whenever the window loses keyboard focus, before rxvt-unicode does
618	focus out processing.	701	focus out processing.
619		702
620	=item on_configure_notify $term, $event	703	=item on_configure_notify $term, $event
621		704
622	=item on_property_notify $term, $event	705	=item on_property_notify $term, $event
…		…
633		716
634	=item on_map_notify $term, $event	717	=item on_map_notify $term, $event
635		718
636	=item on_unmap_notify $term, $event	719	=item on_unmap_notify $term, $event
637		720
638	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
639	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.
640		723
641	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
642	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
643	(real, not screen-based) row and column under the mouse cursor.	726	(real, not screen-based) row and column under the mouse cursor.
644		727
…		…
653		736
654	=item on_wm_delete_window $term, $event	737	=item on_wm_delete_window $term, $event
655		738
656	Called when various types of ClientMessage events are received (all with	739	Called when various types of ClientMessage events are received (all with
657	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.
658		745
659	=back	746	=back
660		747
661	=cut	748	=cut
662		749
…		…
705	The current terminal. This variable stores the current C<urxvt::term>	792	The current terminal. This variable stores the current C<urxvt::term>
706	object, whenever a callback/hook is executing.	793	object, whenever a callback/hook is executing.
707		794
708	=item @urxvt::TERM_INIT	795	=item @urxvt::TERM_INIT
709		796
710	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
711	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
712	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,
713	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.
714		801
715	This complements to the perl-eval commandline option, but gets executed	802	This complements to the perl-eval command line option, but gets executed
716	first.	803	first.
717		804
718	=item @urxvt::TERM_EXT	805	=item @urxvt::TERM_EXT
719		806
720	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
…		…
727		814
728	=over 4	815	=over 4
729		816
730	=item urxvt::fatal $errormessage	817	=item urxvt::fatal $errormessage
731		818
732	Fatally aborts execution with the given error message. Avoid at all	819	Fatally aborts execution with the given error message (which should
733	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
734	starts up.	821	is acceptable (and useful) is in the init hook, where it prevents the
		822	terminal from starting up.
735		823
736	=item urxvt::warn $string	824	=item urxvt::warn $string
737		825
738	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
739	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
740	that calls this function.	828	that calls this function.
741		829
742	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
743	correct place, e.g. on stderr of the connecting urxvtc client.	831	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
745	Messages have a size limit of 1023 bytes currently.	833	Messages have a size limit of 1023 bytes currently.
746		834
747	=item @terms = urxvt::termlist	835	=item @terms = urxvt::termlist
748		836
749	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
750	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
751	objects that have perl extensions attached will be returned (because there	839	objects that have perl extensions attached will be returned (because there
752	is no urxvt::term objet associated with others).	840	is no urxvt::term object associated with others).
753		841
754	=item $time = urxvt::NOW	842	=item $time = urxvt::NOW
755		843
756	Returns the "current time" (as per the event loop).	844	Returns the "current time" (as per the event loop).
757		845
…		…
800		888
801	=item $rend = urxvt::OVERLAY_RSTYLE	889	=item $rend = urxvt::OVERLAY_RSTYLE
802		890
803	Return the rendition mask used for overlays by default.	891	Return the rendition mask used for overlays by default.
804		892
805	=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
806		895
807	Return the bit that enabled bold, italic, blink, reverse-video and	896	Return the bit that enabled bold, italic, blink, reverse-video and
808	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
809	the bitset.	898	the bitset.
810		899
…		…
892	sub invoke {	981	sub invoke {
893	local $TERM = shift;	982	local $TERM = shift;
894	my $htype = shift;	983	my $htype = shift;
895		984
896	if ($htype == 0) { # INIT	985	if ($htype == 0) { # INIT
897	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	986	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
898		987
899	my %ext_arg;	988	my %ext_arg;
900		989
901	{	990	{
902	my @init = @TERM_INIT;	991	my @init = @TERM_INIT;
903	@TERM_INIT = ();	992	@TERM_INIT = ();
…		…
966		1055
967	sub SET_COLOR($$$) {	1056	sub SET_COLOR($$$) {
968	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1057	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
969	}	1058	}
970		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
971	# urxvt::term::extension	1085	# urxvt::term::extension
972		1086
973	package urxvt::term::extension;	1087	package urxvt::term::extension;
974		1088
975	sub enable {	1089	sub enable {
…		…
1044	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
1045	work.	1159	work.
1046		1160
1047	=cut	1161	=cut
1048		1162
1049	our $VERSION = 1;	1163	our $VERSION = '5.23';
1050		1164
1051	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1165	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1052	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1166	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1053		1167
1054	sub timer {	1168	sub timer {
…		…
1056		1170
1057	my $cb = $arg{cb};	1171	my $cb = $arg{cb};
1058		1172
1059	urxvt::timer	1173	urxvt::timer
1060	->new	1174	->new
1061	->start (urxvt::NOW + $arg{after})	1175	->after ($arg{after}, $arg{interval})
1062	->cb (sub {	1176	->cb ($arg{interval} ? $cb : sub {
1063	$_[0]->stop; # need to cancel manually	1177	$_[0]->stop; # need to cancel manually
1064	$cb->();	1178	$cb->();
1065	})	1179	})
1066	}	1180	}
1067		1181
1068	sub io {	1182	sub io {
1069	my ($class, %arg) = @_;	1183	my ($class, %arg) = @_;
1070		1184
1071	my $cb = $arg{cb};	1185	my $cb = $arg{cb};
		1186	my $fd = fileno $arg{fh};
		1187	defined $fd or $fd = $arg{fh};
1072		1188
1073	bless [$arg{fh}, urxvt::iow	1189	bless [$arg{fh}, urxvt::iow
1074	->new	1190	->new
1075	->fd (fileno $arg{fh})	1191	->fd ($fd)
1076	->events (($arg{poll} =~ /r/ ? 1 : 0)	1192	->events (($arg{poll} =~ /r/ ? 1 : 0)
1077	\| ($arg{poll} =~ /w/ ? 2 : 0))	1193	\| ($arg{poll} =~ /w/ ? 2 : 0))
1078	->start	1194	->start
1079	->cb (sub {	1195	->cb ($cb)
1080	$cb->(($_[1] & 1 ? 'r' : '')
1081	. ($_[1] & 2 ? 'w' : ''));
1082	})],
1083	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	})
1084	}	1222	}
1085		1223
1086	sub DESTROY {	1224	sub DESTROY {
1087	$_[0][1]->stop;	1225	$_[0][1]->stop;
1088	}	1226	}
1089		1227
1090	sub condvar {	1228	# only needed for AnyEvent < 6 compatibility
1091	bless \my $flag, urxvt::anyevent::condvar::	1229	sub one_event {
1092	}
1093
1094	sub urxvt::anyevent::condvar::broadcast {
1095	${$_[0]}++;
1096	}
1097
1098	sub urxvt::anyevent::condvar::wait {
1099	unless (${$_[0]}) {
1100	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";
1101	}
1102	}	1231	}
1103		1232
1104	package urxvt::term;	1233	package urxvt::term;
1105		1234
1106	=head2 The C<urxvt::term> Class	1235	=head2 The C<urxvt::term> Class
…		…
1193		1322
1194	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
1195	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
1196	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.
1197		1326
1198	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
1199	source file F</src/optinc.h> to see the actual list:	1328	source file F</src/optinc.h> to see the actual list:
1200		1329
1201	borderLess console cursorBlink cursorUnderline hold iconic insecure	1330	borderLess buffered console cursorBlink cursorUnderline hold iconic
1202	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1331	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1203	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1332	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1204	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1333	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1205	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1334	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1206	transparent tripleclickwords utmpInhibit visualBell	1335	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1336	urgentOnBell utmpInhibit visualBell
1207		1337
1208	=item $value = $term->resource ($name[, $newval])	1338	=item $value = $term->resource ($name[, $newval])
1209		1339
1210	Returns the current resource value associated with a given name and	1340	Returns the current resource value associated with a given name and
1211	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>
…		…
1220	likely change).	1350	likely change).
1221		1351
1222	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
1223	terminal is destroyed, so changing options frequently will eat memory.	1353	terminal is destroyed, so changing options frequently will eat memory.
1224		1354
1225	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
1226	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>
1227	to see the actual list:	1357	to see the actual list:
1228		1358
1229	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1359	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1230	borderLess color cursorBlink cursorUnderline cutchars delete_key	1360	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1231	display_name embed ext_bwidth fade font geometry hold iconName	1361	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1232	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
1233	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1364	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1234	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1365	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1235	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1366	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1236	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1367	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1237	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1368	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1238	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1369	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1239	secondaryScreen secondaryScroll selectstyle shade term_name title	1370	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1240	transient_for transparent transparent_all tripleclickwords utmpInhibit	1371	term_name title transient_for transparent tripleclickwords urgentOnBell
1241	visualBell	1372	utmpInhibit visualBell
1242		1373
1243	=cut	1374	=cut
1244		1375
1245	sub resource($$;$) {	1376	sub resource($$;$) {
1246	my ($self, $name) = (shift, shift);	1377	my ($self, $name) = (shift, shift);
1247	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1378	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1248	&urxvt::term::_resource	1379	goto &urxvt::term::_resource
1249	}	1380	}
1250		1381
1251	=item $value = $term->x_resource ($pattern)	1382	=item $value = $term->x_resource ($pattern)
1252		1383
1253	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
…		…
1257		1388
1258	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
1259	only one resource database per display, and later invocations might return	1390	only one resource database per display, and later invocations might return
1260	the wrong resources.	1391	the wrong resources.
1261		1392
1262	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1393	=item $success = $term->parse_keysym ($key, $octets)
1263		1394
1264	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
1265	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1396	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1266		1397
1267	=item $rend = $term->rstyle ([$new_rstyle])	1398	=item $rend = $term->rstyle ([$new_rstyle])
1268		1399
1269	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
…		…
1278		1409
1279	=item ($row, $col) = $term->selection_beg ([$row, $col])	1410	=item ($row, $col) = $term->selection_beg ([$row, $col])
1280		1411
1281	=item ($row, $col) = $term->selection_end ([$row, $col])	1412	=item ($row, $col) = $term->selection_end ([$row, $col])
1282		1413
1283	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.
1284	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.
1285		1423
1286	=item $term->selection_make ($eventtime[, $rectangular])	1424	=item $term->selection_make ($eventtime[, $rectangular])
1287		1425
1288	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
1289	C<selection_end>. If C<$rectangular> is true (default: false), a	1427	C<selection_end>. If C<$rectangular> is true (default: false), a
1290	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
1291	a selection.	1429	a selection.
1292		1430
1293	=item $success = $term->selection_grab ($eventtime)	1431	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1294		1432
1295	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
1296	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
1297	is mostly useful from within C<on_sel_grab> hooks.	1436	is mostly useful from within C<on_sel_grab> hooks.
1298		1437
1299	=item $oldtext = $term->selection ([$newtext])	1438	=item $oldtext = $term->selection ([$newtext, $clipboard])
1300		1439
1301	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.
1302		1446
1303	=item $term->overlay_simple ($x, $y, $text)	1447	=item $term->overlay_simple ($x, $y, $text)
1304		1448
1305	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.
1306		1450
…		…
1336		1480
1337	The methods currently supported on C<urxvt::overlay> objects are:	1481	The methods currently supported on C<urxvt::overlay> objects are:
1338		1482
1339	=over 4	1483	=over 4
1340		1484
1341	=item $overlay->set ($x, $y, $text, $rend)	1485	=item $overlay->set ($x, $y, $text[, $rend])
1342		1486
1343	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
1344	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
1345	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.
1346		1492
1347	=item $overlay->hide	1493	=item $overlay->hide
1348		1494
1349	If visible, hide the overlay, but do not destroy it.	1495	If visible, hide the overlay, but do not destroy it.
1350		1496
…		…
1432	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1433	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1434		1580
1435	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1436		1582
1437	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
1438	pass characters instead of octets, you should convert your strings first	1584	pass characters instead of octets, you should convert your strings first
1439	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.
1440		1592
1441	=item $old_events = $term->pty_ev_events ([$new_events])	1593	=item $old_events = $term->pty_ev_events ([$new_events])
1442		1594
1443	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
1444	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
…		…
1542		1694
1543	Returns the currently displayed screen (0 primary, 1 secondary).	1695	Returns the currently displayed screen (0 primary, 1 secondary).
1544		1696
1545	=item $cursor_is_hidden = $term->hidden_cursor	1697	=item $cursor_is_hidden = $term->hidden_cursor
1546		1698
1547	Returns wether the cursor is currently hidden or not.	1699	Returns whether the cursor is currently hidden or not.
1548		1700
1549	=item $view_start = $term->view_start ([$newvalue])	1701	=item $view_start = $term->view_start ([$newvalue])
1550		1702
1551	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
1552	C<0>, which displays the normal terminal contents. Lower values scroll	1704	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1560		1712
1561	Used after changing terminal contents to display them.	1713	Used after changing terminal contents to display them.
1562		1714
1563	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1715	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1564		1716
1565	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 >>
1566	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
1567	terminal line. The scrollback buffer starts at line C<-1> and extends to
1568	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1719	terminal line. Nothing will be returned if a nonexistent line
1569	is requested.	1720	is requested.
1570		1721
1571	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
1572	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
1573	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
1574	automatically be updated.	1725	automatically be updated.
1575		1726
1576	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
1577	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)
1578	characters. Characters with combining characters and other characters that	1729	characters. Characters with combining characters and other characters that
1579	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
1580	in the private use area.	1731	in the private use area.
1581		1732
1582	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
1583	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
1584	characters.	1735	characters.
…		…
1729	where one character corresponds to one screen cell. See	1880	where one character corresponds to one screen cell. See
1730	C<< $term->ROW_t >> for details.	1881	C<< $term->ROW_t >> for details.
1731		1882
1732	=item $string = $term->special_decode $text	1883	=item $string = $term->special_decode $text
1733		1884
1734	Converts rxvt-unicodes text reprsentation into a perl string. See	1885	Converts rxvt-unicodes text representation into a perl string. See
1735	C<< $term->ROW_t >> for details.	1886	C<< $term->ROW_t >> for details.
1736		1887
1737	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1888	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1738		1889
1739	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1890	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1742	manpage.	1893	manpage.
1743		1894
1744	=item $success = $term->grab ($eventtime[, $sync])	1895	=item $success = $term->grab ($eventtime[, $sync])
1745		1896
1746	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1897	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1747	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1898	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1748		1899
1749	=item $term->allow_events_async	1900	=item $term->allow_events_async
1750		1901
1751	Calls XAllowEvents with AsyncBoth for the most recent grab.	1902	Calls XAllowEvents with AsyncBoth for the most recent grab.
1752		1903
…		…
1759	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1910	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1760	recent grab.	1911	recent grab.
1761		1912
1762	=item $term->ungrab	1913	=item $term->ungrab
1763		1914
1764	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
1765	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
1766	the session.	1917	the session.
1767		1918
1768	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1919	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1769		1920
…		…
1771		1922
1772	=item @atoms = $term->XListProperties ($window)	1923	=item @atoms = $term->XListProperties ($window)
1773		1924
1774	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1925	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1775		1926
1776	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1927	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1777		1928
1778	=item $term->XDeleteProperty ($window, $property)	1929	=item $term->XDeleteProperty ($window, $property)
1779		1930
1780	=item $window = $term->DefaultRootWindow	1931	=item $window = $term->DefaultRootWindow
1781		1932
…		…
1788	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1939	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1789		1940
1790	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1941	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1791		1942
1792	=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)
1793		1948
1794	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
1795	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
1796	directory onto the X functions of the same name.	1951	directly onto the X functions of the same name.
1797		1952
1798	=back	1953	=back
1799		1954
1800	=cut	1955	=cut
1801		1956
…		…
1903	my $env = $self->{term}->env;	2058	my $env = $self->{term}->env;
1904	# 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.
1905	delete $env->{LC_ALL};	2060	delete $env->{LC_ALL};
1906	$env->{LC_CTYPE} = $self->{term}->locale;	2061	$env->{LC_CTYPE} = $self->{term}->locale;
1907		2062
1908	urxvt::term->new ($env, "popup",	2063	my $term = urxvt::term->new (
		2064	$env, "popup",
1909	"--perl-lib" => "", "--perl-ext-common" => "",	2065	"--perl-lib" => "", "--perl-ext-common" => "",
1910	"-pty-fd" => -1, "-sl" => 0,	2066	"-pty-fd" => -1, "-sl" => 0,
1911	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2067	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1912	"--transient-for" => $self->{term}->parent,	2068	"--transient-for" => $self->{term}->parent,
1913	"-display" => $self->{term}->display_id,	2069	"-display" => $self->{term}->display_id,
1914	"-pe" => "urxvt-popup")	2070	"-pe" => "urxvt-popup",
1915	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	}
1916	}	2078	}
1917		2079
1918	sub DESTROY {	2080	sub DESTROY {
1919	my ($self) = @_;	2081	my ($self) = @_;
1920		2082
…		…
1925	=back	2087	=back
1926		2088
1927	=cut	2089	=cut
1928		2090
1929	package urxvt::watcher;	2091	package urxvt::watcher;
1930
1931	@urxvt::timer::ISA = __PACKAGE__;
1932	@urxvt::iow::ISA = __PACKAGE__;
1933	@urxvt::pw::ISA = __PACKAGE__;
1934	@urxvt::iw::ISA = __PACKAGE__;
1935		2092
1936	=head2 The C<urxvt::timer> Class	2093	=head2 The C<urxvt::timer> Class
1937		2094
1938	This class implements timer watchers/events. Time is represented as a	2095	This class implements timer watchers/events. Time is represented as a
1939	fractional number of seconds since the epoch. Example:	2096	fractional number of seconds since the epoch. Example:
…		…
1943	->new	2100	->new
1944	->interval (1)	2101	->interval (1)
1945	->cb (sub {	2102	->cb (sub {
1946	$term->{overlay}->set (0, 0,	2103	$term->{overlay}->set (0, 0,
1947	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2104	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1948	});	2105	});
1949		2106
1950	=over 4	2107	=over 4
1951		2108
1952	=item $timer = new urxvt::timer	2109	=item $timer = new urxvt::timer
1953		2110
…		…
1956		2113
1957	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2114	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1958		2115
1959	Set the callback to be called when the timer triggers.	2116	Set the callback to be called when the timer triggers.
1960		2117
1961	=item $tstamp = $timer->at
1962
1963	Return the time this watcher will fire next.
1964
1965	=item $timer = $timer->set ($tstamp)	2118	=item $timer = $timer->set ($tstamp[, $interval])
1966		2119
1967	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).
1968		2122
1969	=item $timer = $timer->interval ($interval)	2123	=item $timer = $timer->interval ($interval)
1970		2124
1971	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
1972	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
1973	is automatically rescheduled at the given intervals.	2127	is automatically rescheduled at the given intervals.
1974		2128
1975	=item $timer = $timer->start	2129	=item $timer = $timer->start
1976		2130
1977	Start the timer.	2131	Start the timer.
1978		2132
1979	=item $timer = $timer->start ($tstamp)	2133	=item $timer = $timer->start ($tstamp[, $interval])
1980		2134
1981	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.
1982		2137
1983	=item $timer = $timer->after ($delay)	2138	=item $timer = $timer->after ($delay[, $interval])
1984		2139
1985	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>.
1986		2141
1987	=item $timer = $timer->stop	2142	=item $timer = $timer->stop
1988		2143
…		…
1996		2151
1997	$term->{socket} = ...	2152	$term->{socket} = ...
1998	$term->{iow} = urxvt::iow	2153	$term->{iow} = urxvt::iow
1999	->new	2154	->new
2000	->fd (fileno $term->{socket})	2155	->fd (fileno $term->{socket})
2001	->events (urxvt::EVENT_READ)	2156	->events (urxvt::EV_READ)
2002	->start	2157	->start
2003	->cb (sub {	2158	->cb (sub {
2004	my ($iow, $revents) = @_;	2159	my ($iow, $revents) = @_;
2005	# $revents must be 1 here, no need to check	2160	# $revents must be 1 here, no need to check
2006	sysread $term->{socket}, my $buf, 8192	2161	sysread $term->{socket}, my $buf, 8192
…		…
2019	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>
2020	is a bitset as described in the C<events> method.	2175	is a bitset as described in the C<events> method.
2021		2176
2022	=item $iow = $iow->fd ($fd)	2177	=item $iow = $iow->fd ($fd)
2023		2178
2024	Set the filedescriptor (not handle) to watch.	2179	Set the file descriptor (not handle) to watch.
2025		2180
2026	=item $iow = $iow->events ($eventmask)	2181	=item $iow = $iow->events ($eventmask)
2027		2182
2028	Set the event mask to watch. The only allowed values are	2183	Set the event mask to watch. The only allowed values are
2029	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
2030	together, or C<urxvt::EVENT_NONE>.	2185	together, or C<urxvt::EV_NONE>.
2031		2186
2032	=item $iow = $iow->start	2187	=item $iow = $iow->start
2033		2188
2034	Start watching for requested events on the given handle.	2189	Start watching for requested events on the given handle.
2035		2190
2036	=item $iow = $iow->stop	2191	=item $iow = $iow->stop
2037		2192
2038	Stop watching for events on the given filehandle.	2193	Stop watching for events on the given file handle.
2039		2194
2040	=back	2195	=back
2041		2196
2042	=head2 The C<urxvt::iw> Class	2197	=head2 The C<urxvt::iw> Class
2043		2198
…		…
2076	->new	2231	->new
2077	->start ($pid)	2232	->start ($pid)
2078	->cb (sub {	2233	->cb (sub {
2079	my ($pw, $exit_status) = @_;	2234	my ($pw, $exit_status) = @_;
2080	...	2235	...
2081	});	2236	});
2082		2237
2083	=over 4	2238	=over 4
2084		2239
2085	=item $pw = new urxvt::pw	2240	=item $pw = new urxvt::pw
2086		2241
…		…
2090		2245
2091	Set the callback to be called when the timer triggers.	2246	Set the callback to be called when the timer triggers.
2092		2247
2093	=item $pw = $timer->start ($pid)	2248	=item $pw = $timer->start ($pid)
2094		2249
2095	Tells the wqtcher to start watching for process C<$pid>.	2250	Tells the watcher to start watching for process C<$pid>.
2096		2251
2097	=item $pw = $pw->stop	2252	=item $pw = $pw->stop
2098		2253
2099	Stop the watcher.	2254	Stop the watcher.
2100		2255
…		…
2113		2268
2114	=item >= 3 - script loading and management	2269	=item >= 3 - script loading and management
2115		2270
2116	=item >=10 - all called hooks	2271	=item >=10 - all called hooks
2117		2272
2118	=item >=11 - hook reutrn values	2273	=item >=11 - hook return values
2119		2274
2120	=back	2275	=back
2121		2276
2122	=head1 AUTHOR	2277	=head1 AUTHOR
2123		2278
2124	Marc Lehmann <pcg@goof.com>	2279	Marc Lehmann <schmorp@schmorp.de>
2125	http://software.schmorp.de/pkg/rxvt-unicode	2280	http://software.schmorp.de/pkg/rxvt-unicode
2126		2281
2127	=cut	2282	=cut
2128		2283
2129	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.143 by root, Thu Jul 6 23:48:11 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.143 by root, Thu Jul 6 23:48:11 2006 UTC vs.
Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 2011 UTC