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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.142 by root, Thu Jul 6 18:56:10 2006 UTC vs.
Revision 1.204 by sf-exg, Mon Dec 5 12:52:57 2011 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
62	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
63	...	66	...
64		67
65	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
68	between two vertical bars:	71	between two vertical bars:
69		72
70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
71		74
72	Another example: Programs I use often output "absolute path: " at the	75	Another example: Programs I use often output "absolute path: " at the
…		…
98		101
99	Other extensions can extend this popup menu by pushing a code reference	102	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the	103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.	104	popup is being displayed.
102		105
103	It's sole argument is the popup menu, which can be modified. It should	106	Its sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code	107	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference	108	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as	109	will be called when the toggle changes, with the new boolean value as
107	first argument.	110	first argument.
108		111
109	The following will add an entry C<myoption> that changes	112	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:	113	C<< $self->{myoption} >>:
111		114
112	push @{ $self->{term}{option_popup_hook} }, sub {	115	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};	117	};
115		118
…		…
121		124
122	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.	127	popup is being displayed.
125		128
126	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide wether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
128	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
131		134
132	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:	137	C<a>s:
135		138
136	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
138	: ()	141	: ()
139	};	142	};
140		143
141	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
142		145
…		…
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
154	selection.	157	selection if the C<Shift> modifier is active.
155		158
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To	159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>	160	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.	161	or simply use an uppercase character which removes the "(?i)" prefix.
159		162
…		…
162	=item readline (enabled by default)	165	=item readline (enabled by default)
163		166
164	A support package that tries to make editing with readline easier. At	167	A support package that tries to make editing with readline easier. At
165	the moment, it reacts to clicking shift-left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
166	move the text cursor to this position. It does so by generating as many	169	move the text cursor to this position. It does so by generating as many
167	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
168	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
169		172
170	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
171		174
172	=over 4	175	=over 4
…		…
220	the message into vi commands to load the file.	223	the message into vi commands to load the file.
221		224
222	=item tabbed	225	=item tabbed
223		226
224	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
225	is, it implements what is commonly refered to as "tabbed terminal". The topmost line	228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one	229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
227	button per tab.	230	button per tab.
228		231
229	Clicking a button will activate that tab. Pressing B<Shift-Left> and	232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
230	B<Shift-Right> will switch to the tab left or right of the current one,	233	B<Shift-Right> will switch to the tab left or right of the current one,
…		…
240	URxvt.tabbed.tab-bg: <colour-index, default 1>	243	URxvt.tabbed.tab-bg: <colour-index, default 1>
241		244
242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid	245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243	indices.	246	indices.
244		247
245	=item mark-urls	248	=item matcher
246		249
247	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
248	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
249	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
250	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
		266	"perl:matcher:list" as seen in the example below.
		267
		268	Example configuration:
		269
		270	URxvt.perl-ext: default,matcher
		271	URxvt.urlLauncher: sensible-browser
		272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
		274	URxvt.matcher.button: 1
		275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		277	URxvt.matcher.launcher.2: gvim +$2 $1
251		278
252	=item xim-onthespot	279	=item xim-onthespot
253		280
254	This (experimental) perl extension implements OnTheSpot editing. It does	281	This (experimental) perl extension implements OnTheSpot editing. It does
255	not work perfectly, and some input methods don't seem to work well with	282	not work perfectly, and some input methods don't seem to work well with
256	OnTheSpot editing in general, but it seems to work at leats for SCIM and	283	OnTheSpot editing in general, but it seems to work at least for SCIM and
257	kinput2.	284	kinput2.
258		285
259	You enable it by specifying this extension and a preedit style of	286	You enable it by specifying this extension and a preedit style of
260	C<OnTheSpot>, i.e.:	287	C<OnTheSpot>, i.e.:
261		288
262	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
263		290
264	=item automove-background	291	=item kuake<hotkey>
265		292
266	This is basically a very small extension that dynamically changes the	293	A very primitive quake-console-like extension. It was inspired by a
267	background pixmap offset to the window position, in effect creating the	294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
268	same effect as pseudo transparency with a custom pixmap. No scaling is	295	user presses a global accelerator key (by default C<F10>), the terminal
269	supported in this mode. Exmaple:	296	will show or hide itself. Another press of the accelerator key will hide
		297	or show it again.
270		298
271	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	299	Initially, the window will not be shown when using this extension.
		300
		301	This is useful if you need a single terminal that is not using any desktop
		302	space most of the time but is quickly available at the press of a key.
		303
		304	The accelerator key is grabbed regardless of any modifiers, so this
		305	extension will actually grab a physical key just for this function.
		306
		307	If you want a quake-like animation, tell your window manager to do so
		308	(fvwm can do it).
		309
		310	=item overlay-osc
		311
		312	This extension implements some OSC commands to display timed popups on the
		313	screen - useful for status displays from within scripts. You have to read
		314	the sources for more info.
272		315
273	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
274		317
275	A not very useful example of filtering all text output to the terminal	318	A not very useful example of filtering all text output to the terminal
276	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
281	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
282		325
283	=item remote-clipboard	326	=item remote-clipboard
284		327
285	Somewhat of a misnomer, this extension adds two menu entries to the	328	Somewhat of a misnomer, this extension adds two menu entries to the
286	selection popup that allows one ti run external commands to store the	329	selection popup that allows one to run external commands to store the
287	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
288		331
289	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
290	means that one command uploads the file to a remote server, and another	333	means that one command uploads the file to a remote server, and another
291	reads it.	334	reads it.
…		…
300	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
301	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
302		345
303	=item selection-pastebin	346	=item selection-pastebin
304		347
305	This is a little rarely useful extension that Uploads the selection as	348	This is a little rarely useful extension that uploads the selection as
306	textfile to a remote site (or does other things). (The implementation is	349	textfile to a remote site (or does other things). (The implementation is
307	not currently secure for use in a multiuser environment as it writes to	350	not currently secure for use in a multiuser environment as it writes to
308	F</tmp> directly.).	351	F</tmp> directly.).
309		352
310	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
327	in the C<selection-pastebin-url> resource (again, the % is the placeholder	370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
328	for the filename):	371	for the filename):
329		372
330	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
331		374
		375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		376	the double C</> characters as comment start. Use C<\057\057> instead,
		377	which works regardless of whether xrdb is used to parse the resource file
		378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
		393
332	=item example-refresh-hooks	394	=item example-refresh-hooks
333		395
334	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
335	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
336	overlays or changes.	398	overlays or changes.
		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
337		412
338	=back	413	=back
339		414
340	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
341		416
…		…
357		432
358	=over 4	433	=over 4
359		434
360	=item $text	435	=item $text
361		436
362	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
363	always represents one screen cell. See L<ROW_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
364		439
365	=item $string	440	=item $string
366		441
367	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
371	=item $octets	446	=item $octets
372		447
373	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
374	locale-specific way.	449	locale-specific way.
375		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
376	=back	457	=back
377		458
378	=head2 Extension Objects	459	=head2 Extension Objects
379		460
380	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
381	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,
382	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
383	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
384	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
385	use.	467	internal use.
386		468
387	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
388	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
389		471
390	It has the following methods and data members:	472	It has the following methods and data members:
…		…
411	=head2 Hooks	493	=head2 Hooks
412		494
413	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
414	called whenever the relevant event happens.	496	called whenever the relevant event happens.
415		497
416	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
417	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
418		500
419	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
420	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
421	relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
…		…
434	place.	516	place.
435		517
436	=item on_start $term	518	=item on_start $term
437		519
438	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
439	trying to map (display) the toplevel and returning to the mainloop.	521	trying to map (display) the toplevel and returning to the main loop.
440		522
441	=item on_destroy $term	523	=item on_destroy $term
442		524
443	Called whenever something tries to destroy terminal, when the terminal is	525	Called whenever something tries to destroy terminal, when the terminal is
444	still fully functional (not for long, though).	526	still fully functional (not for long, though).
…		…
471		553
472	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
473	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
474	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
475		557
476	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.
477		559
478	=item on_sel_extend $term	560	=item on_sel_extend $term
479		561
480	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
481	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
482	should extend the selection itelf and return true to suppress the built-in	564	should extend the selection itself and return true to suppress the built-in
483	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
484	returns true, it will be called on every further click by the user and is	566	returns true, it will be called on every further click by the user and is
485	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
486		568
487	See the F<selection> example extension.	569	See the F<selection> example extension.
488		570
489	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
490		572
491	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
492	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
493	show this many lines of scrollback.	575	show this many lines of scrollback.
494		576
495	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
496		578
…		…
500		582
501	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,
502	$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
503	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
504		586
505	=item on_osc_seq $term, $op, $args	587	=item on_osc_seq $term, $op, $args, $resp
506		588
507	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
508	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
509	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
510	confused by recursive invocations when you output an osc sequence within	592	confused by recursive invocations when you output an OSC sequence within
511	this callback.	593	this callback.
512		594
513	C<on_osc_seq_perl> should be used for new behaviour.	595	C<on_osc_seq_perl> should be used for new behaviour.
514		596
515	=item on_osc_seq_perl $term, $string	597	=item on_osc_seq_perl $term, $args, $resp
516		598
517	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
518	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
519	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
520	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,
521	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
522	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	}
523		615
524	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,
525	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
526	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.
527		622
528	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
529		624
530	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
531	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
…		…
536	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
537		632
538	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
539	suppress or filter tty input.	634	suppress or filter tty input.
540		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
541	=item on_line_update $term, $row	643	=item on_line_update $term, $row
542		644
543	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
544	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
545	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,
…		…
552	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
553	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
554		656
555	=item on_refresh_begin $term	657	=item on_refresh_begin $term
556		658
557	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
558	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
559	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
560	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
561		663
562	=item on_refresh_end $term	664	=item on_refresh_end $term
563		665
564	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>.
565		667
566	=item on_user_command $term, $string	668	=item on_user_command $term, $string
567		669
568	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
569	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>
570	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
571		673
572	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
573	slightly in the future.	675	slightly in the future.
574		676
		677	=item on_register_command $term, $keysym, $modifiermask, $string
		678
		679	Called after parsing a keysym resource but before registering the
		680	associated binding. If this hook returns TRUE the binding is not
		681	registered. It can be used to modify a binding by calling
		682	C<register_command>.
		683
575	=item on_resize_all_windows $tern, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
576		685
577	Called just after the new window size has been calculcated, but before	686	Called just after the new window size has been calculated, but before
578	windows are actually being resized or hints are being set. If this hook	687	windows are actually being resized or hints are being set. If this hook
579	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
580		689
581	=item on_x_event $term, $event	690	=item on_x_event $term, $event
582		691
583	Called on every X event received on the vt window (and possibly other	692	Called on every X event received on the vt window (and possibly other
584	windows). Should only be used as a last resort. Most event structure	693	windows). Should only be used as a last resort. Most event structure
585	members are not passed.	694	members are not passed.
586		695
		696	=item on_root_event $term, $event
		697
		698	Like C<on_x_event>, but is called for events on the root window.
		699
587	=item on_focus_in $term	700	=item on_focus_in $term
588		701
589	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
590	does focus in processing.	703	does focus in processing.
591		704
592	=item on_focus_out $term	705	=item on_focus_out $term
593		706
594	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
595	focus out processing.	708	focus out processing.
596		709
597	=item on_configure_notify $term, $event	710	=item on_configure_notify $term, $event
598		711
599	=item on_property_notify $term, $event	712	=item on_property_notify $term, $event
…		…
610		723
611	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
612		725
613	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
614		727
615	Called whenever the corresponding X event is received for the terminal If	728	Called whenever the corresponding X event is received for the terminal. If
616	the hook returns true, then the even will be ignored by rxvt-unicode.	729	the hook returns true, then the event will be ignored by rxvt-unicode.
617		730
618	The event is a hash with most values as named by Xlib (see the XEvent	731	The event is a hash with most values as named by Xlib (see the XEvent
619	manpage), with the additional members C<row> and C<col>, which are the	732	manpage), with the additional members C<row> and C<col>, which are the
620	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
621		734
…		…
630		743
631	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
632		745
633	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
634	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
635		752
636	=back	753	=back
637		754
638	=cut	755	=cut
639		756
…		…
682	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
683	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
684		801
685	=item @urxvt::TERM_INIT	802	=item @urxvt::TERM_INIT
686		803
687	All coderefs in this array will be called as methods of the next newly	804	All code references in this array will be called as methods of the next newly
688	created C<urxvt::term> object (during the C<on_init> phase). The array	805	created C<urxvt::term> object (during the C<on_init> phase). The array
689	gets cleared before the codereferences that were in it are being executed,	806	gets cleared before the code references that were in it are being executed,
690	so coderefs can push themselves onto it again if they so desire.	807	so references can push themselves onto it again if they so desire.
691		808
692	This complements to the perl-eval commandline option, but gets executed	809	This complements to the perl-eval command line option, but gets executed
693	first.	810	first.
694		811
695	=item @urxvt::TERM_EXT	812	=item @urxvt::TERM_EXT
696		813
697	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	814	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
704		821
705	=over 4	822	=over 4
706		823
707	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
708		825
709	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
710	costs! The only time this is acceptable is when the terminal process	827	include a trailing newline). Avoid at all costs! The only time this
711	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
712		830
713	=item urxvt::warn $string	831	=item urxvt::warn $string
714		832
715	Calls C<rxvt_warn> with the given string which should not include a	833	Calls C<rxvt_warn> with the given string which should include a trailing
716	newline. The module also overwrites the C<warn> builtin with a function	834	newline. The module also overwrites the C<warn> builtin with a function
717	that calls this function.	835	that calls this function.
718		836
719	Using this function has the advantage that its output ends up in the	837	Using this function has the advantage that its output ends up in the
720	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
722	Messages have a size limit of 1023 bytes currently.	840	Messages have a size limit of 1023 bytes currently.
723		841
724	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
725		843
726	Returns all urxvt::term objects that exist in this process, regardless of	844	Returns all urxvt::term objects that exist in this process, regardless of
727	wether they are started, being destroyed etc., so be careful. Only term	845	whether they are started, being destroyed etc., so be careful. Only term
728	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
729	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
730		848
731	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
732		850
733	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
734		852
…		…
777		895
778	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
779		897
780	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
781		899
782	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	900	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		901	urxvt::RS_RVid, urxvt::RS_Uline
783		902
784	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
785	underline, respectively. To enable such a style, just logically OR it into	904	underline, respectively. To enable such a style, just logically OR it into
786	the bitset.	905	the bitset.
787		906
…		…
869	sub invoke {	988	sub invoke {
870	local $TERM = shift;	989	local $TERM = shift;
871	my $htype = shift;	990	my $htype = shift;
872		991
873	if ($htype == 0) { # INIT	992	if ($htype == 0) { # INIT
874	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	993	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
875		994
876	my %ext_arg;	995	my %ext_arg;
877		996
878	{	997	{
879	my @init = @TERM_INIT;	998	my @init = @TERM_INIT;
880	@TERM_INIT = ();	999	@TERM_INIT = ();
…		…
943		1062
944	sub SET_COLOR($$$) {	1063	sub SET_COLOR($$$) {
945	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1064	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
946	}	1065	}
947		1066
		1067	sub rend2mask {
		1068	no strict 'refs';
		1069	my ($str, $mask) = (@_, 0);
		1070	my %color = ( fg => undef, bg => undef );
		1071	my @failed;
		1072	for my $spec ( split /\s+/, $str ) {
		1073	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1074	$color{lc($1)} = $2;
		1075	} else {
		1076	my $neg = $spec =~ s/^[-^]//;
		1077	unless ( exists &{"RS_$spec"} ) {
		1078	push @failed, $spec;
		1079	next;
		1080	}
		1081	my $cur = &{"RS_$spec"};
		1082	if ( $neg ) {
		1083	$mask &= ~$cur;
		1084	} else {
		1085	$mask \|= $cur;
		1086	}
		1087	}
		1088	}
		1089	($mask, @color{qw(fg bg)}, \@failed)
		1090	}
		1091
948	# urxvt::term::extension	1092	# urxvt::term::extension
949		1093
950	package urxvt::term::extension;	1094	package urxvt::term::extension;
951		1095
952	sub enable {	1096	sub enable {
…		…
1021	is that you cannot use blocking APIs, but the non-blocking variant should	1165	is that you cannot use blocking APIs, but the non-blocking variant should
1022	work.	1166	work.
1023		1167
1024	=cut	1168	=cut
1025		1169
1026	our $VERSION = 1;	1170	our $VERSION = '5.23';
1027		1171
1028	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1172	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1029	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1173	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1030		1174
1031	sub timer {	1175	sub timer {
…		…
1033		1177
1034	my $cb = $arg{cb};	1178	my $cb = $arg{cb};
1035		1179
1036	urxvt::timer	1180	urxvt::timer
1037	->new	1181	->new
1038	->start (urxvt::NOW + $arg{after})	1182	->after ($arg{after}, $arg{interval})
1039	->cb (sub {	1183	->cb ($arg{interval} ? $cb : sub {
1040	$_[0]->stop; # need to cancel manually	1184	$_[0]->stop; # need to cancel manually
1041	$cb->();	1185	$cb->();
1042	})	1186	})
1043	}	1187	}
1044		1188
1045	sub io {	1189	sub io {
1046	my ($class, %arg) = @_;	1190	my ($class, %arg) = @_;
1047		1191
1048	my $cb = $arg{cb};	1192	my $cb = $arg{cb};
		1193	my $fd = fileno $arg{fh};
		1194	defined $fd or $fd = $arg{fh};
1049		1195
1050	bless [$arg{fh}, urxvt::iow	1196	bless [$arg{fh}, urxvt::iow
1051	->new	1197	->new
1052	->fd (fileno $arg{fh})	1198	->fd ($fd)
1053	->events (($arg{poll} =~ /r/ ? 1 : 0)	1199	->events (($arg{poll} =~ /r/ ? 1 : 0)
1054	\| ($arg{poll} =~ /w/ ? 2 : 0))	1200	\| ($arg{poll} =~ /w/ ? 2 : 0))
1055	->start	1201	->start
1056	->cb (sub {	1202	->cb ($cb)
1057	$cb->(($_[1] & 1 ? 'r' : '')
1058	. ($_[1] & 2 ? 'w' : ''));
1059	})],
1060	urxvt::anyevent::	1203	], urxvt::anyevent::
		1204	}
		1205
		1206	sub idle {
		1207	my ($class, %arg) = @_;
		1208
		1209	my $cb = $arg{cb};
		1210
		1211	urxvt::iw
		1212	->new
		1213	->start
		1214	->cb ($cb)
		1215	}
		1216
		1217	sub child {
		1218	my ($class, %arg) = @_;
		1219
		1220	my $cb = $arg{cb};
		1221
		1222	urxvt::pw
		1223	->new
		1224	->start ($arg{pid})
		1225	->cb (sub {
		1226	$_[0]->stop; # need to cancel manually
		1227	$cb->($_[0]->rpid, $_[0]->rstatus);
		1228	})
1061	}	1229	}
1062		1230
1063	sub DESTROY {	1231	sub DESTROY {
1064	$_[0][1]->stop;	1232	$_[0][1]->stop;
1065	}	1233	}
1066		1234
1067	sub condvar {	1235	# only needed for AnyEvent < 6 compatibility
1068	bless \my $flag, urxvt::anyevent::condvar::	1236	sub one_event {
1069	}
1070
1071	sub urxvt::anyevent::condvar::broadcast {
1072	${$_[0]}++;
1073	}
1074
1075	sub urxvt::anyevent::condvar::wait {
1076	unless (${$_[0]}) {
1077	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1237	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1078	}
1079	}	1238	}
1080		1239
1081	package urxvt::term;	1240	package urxvt::term;
1082		1241
1083	=head2 The C<urxvt::term> Class	1242	=head2 The C<urxvt::term> Class
…		…
1170		1329
1171	Returns true if the option specified by C<$optval> is enabled, and	1330	Returns true if the option specified by C<$optval> is enabled, and
1172	optionally change it. All option values are stored by name in the hash	1331	optionally change it. All option values are stored by name in the hash
1173	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1332	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1174		1333
1175	Here is a a likely non-exhaustive list of option names, please see the	1334	Here is a likely non-exhaustive list of option names, please see the
1176	source file F</src/optinc.h> to see the actual list:	1335	source file F</src/optinc.h> to see the actual list:
1177		1336
1178	borderLess console cursorBlink cursorUnderline hold iconic insecure	1337	borderLess buffered console cursorBlink cursorUnderline hold iconic
1179	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1338	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1180	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1339	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1181	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1340	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1182	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1341	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1183	transparent tripleclickwords utmpInhibit visualBell	1342	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1343	urgentOnBell utmpInhibit visualBell
1184		1344
1185	=item $value = $term->resource ($name[, $newval])	1345	=item $value = $term->resource ($name[, $newval])
1186		1346
1187	Returns the current resource value associated with a given name and	1347	Returns the current resource value associated with a given name and
1188	optionally sets a new value. Setting values is most useful in the C<init>	1348	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1197	likely change).	1357	likely change).
1198		1358
1199	Please note that resource strings will currently only be freed when the	1359	Please note that resource strings will currently only be freed when the
1200	terminal is destroyed, so changing options frequently will eat memory.	1360	terminal is destroyed, so changing options frequently will eat memory.
1201		1361
1202	Here is a a likely non-exhaustive list of resource names, not all of which	1362	Here is a likely non-exhaustive list of resource names, not all of which
1203	are supported in every build, please see the source file F</src/rsinc.h>	1363	are supported in every build, please see the source file F</src/rsinc.h>
1204	to see the actual list:	1364	to see the actual list:
1205		1365
1206	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1366	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1207	borderLess color cursorBlink cursorUnderline cutchars delete_key	1367	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1208	display_name embed ext_bwidth fade font geometry hold iconName	1368	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1209	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1369	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1370	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1210	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1371	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1211	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1372	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1212	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1373	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1213	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1374	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1214	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1375	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1215	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1376	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1216	secondaryScreen secondaryScroll selectstyle shade term_name title	1377	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1217	transient_for transparent transparent_all tripleclickwords utmpInhibit	1378	term_name title transient_for transparent tripleclickwords urgentOnBell
1218	visualBell	1379	utmpInhibit visualBell
1219		1380
1220	=cut	1381	=cut
1221		1382
1222	sub resource($$;$) {	1383	sub resource($$;$) {
1223	my ($self, $name) = (shift, shift);	1384	my ($self, $name) = (shift, shift);
1224	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1385	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1225	&urxvt::term::_resource	1386	goto &urxvt::term::_resource
1226	}	1387	}
1227		1388
1228	=item $value = $term->x_resource ($pattern)	1389	=item $value = $term->x_resource ($pattern)
1229		1390
1230	Returns the X-Resource for the given pattern, excluding the program or	1391	Returns the X-Resource for the given pattern, excluding the program or
…		…
1234		1395
1235	This method should only be called during the C<on_start> hook, as there is	1396	This method should only be called during the C<on_start> hook, as there is
1236	only one resource database per display, and later invocations might return	1397	only one resource database per display, and later invocations might return
1237	the wrong resources.	1398	the wrong resources.
1238		1399
1239	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1400	=item $success = $term->parse_keysym ($key, $octets)
1240		1401
1241	Adds a keymap translation exactly as specified via a resource. See the	1402	Adds a key binding exactly as specified via a resource. See the
1242	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1403	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1404
		1405	=item $term->register_command ($keysym, $modifiermask, $string)
		1406
		1407	Adds a key binding. This is a lower level api compared to
		1408	C<parse_keysym>, as it expects a parsed key description, and can be
		1409	used only inside either the C<on_init> hook, to add a binding, or the
		1410	C<on_register_command> hook, to modify a parsed binding.
1243		1411
1244	=item $rend = $term->rstyle ([$new_rstyle])	1412	=item $rend = $term->rstyle ([$new_rstyle])
1245		1413
1246	Return and optionally change the current rendition. Text that is output by	1414	Return and optionally change the current rendition. Text that is output by
1247	the terminal application will use this style.	1415	the terminal application will use this style.
…		…
1255		1423
1256	=item ($row, $col) = $term->selection_beg ([$row, $col])	1424	=item ($row, $col) = $term->selection_beg ([$row, $col])
1257		1425
1258	=item ($row, $col) = $term->selection_end ([$row, $col])	1426	=item ($row, $col) = $term->selection_end ([$row, $col])
1259		1427
1260	Return the current values of the selection mark, begin or end positions,	1428	Return the current values of the selection mark, begin or end positions.
1261	and optionally set them to new values.	1429
		1430	When arguments are given, then the selection coordinates are set to
		1431	C<$row> and C<$col>, and the selection screen is set to the current
		1432	screen.
		1433
		1434	=item $screen = $term->selection_screen ([$screen])
		1435
		1436	Returns the current selection screen, and then optionally sets it.
1262		1437
1263	=item $term->selection_make ($eventtime[, $rectangular])	1438	=item $term->selection_make ($eventtime[, $rectangular])
1264		1439
1265	Tries to make a selection as set by C<selection_beg> and	1440	Tries to make a selection as set by C<selection_beg> and
1266	C<selection_end>. If C<$rectangular> is true (default: false), a	1441	C<selection_end>. If C<$rectangular> is true (default: false), a
1267	rectangular selection will be made. This is the prefered function to make	1442	rectangular selection will be made. This is the preferred function to make
1268	a selection.	1443	a selection.
1269		1444
1270	=item $success = $term->selection_grab ($eventtime)	1445	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1271		1446
1272	Try to request the primary selection text from the server (for example, as	1447	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1448	true) selection from the server. The corresponding text can be set
1273	set by the next method). No visual feedback will be given. This function	1449	with the next method. No visual feedback will be given. This function
1274	is mostly useful from within C<on_sel_grab> hooks.	1450	is mostly useful from within C<on_sel_grab> hooks.
1275		1451
1276	=item $oldtext = $term->selection ([$newtext])	1452	=item $oldtext = $term->selection ([$newtext, $clipboard])
1277		1453
1278	Return the current selection text and optionally replace it by C<$newtext>.	1454	Return the current selection (clipboard if C<$clipboard> is true) text
		1455	and optionally replace it by C<$newtext>.
		1456
		1457	=item $term->selection_clear ([$clipboard])
		1458
		1459	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1279		1460
1280	=item $term->overlay_simple ($x, $y, $text)	1461	=item $term->overlay_simple ($x, $y, $text)
1281		1462
1282	Create a simple multi-line overlay box. See the next method for details.	1463	Create a simple multi-line overlay box. See the next method for details.
1283		1464
…		…
1313		1494
1314	The methods currently supported on C<urxvt::overlay> objects are:	1495	The methods currently supported on C<urxvt::overlay> objects are:
1315		1496
1316	=over 4	1497	=over 4
1317		1498
1318	=item $overlay->set ($x, $y, $text, $rend)	1499	=item $overlay->set ($x, $y, $text[, $rend])
1319		1500
1320	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1501	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1321	text in rxvt-unicode's special encoding and an array of rendition values	1502	text in rxvt-unicode's special encoding and an array of rendition values
1322	at a specific position inside the overlay.	1503	at a specific position inside the overlay.
		1504
		1505	If C<$rend> is missing, then the rendition will not be changed.
1323		1506
1324	=item $overlay->hide	1507	=item $overlay->hide
1325		1508
1326	If visible, hide the overlay, but do not destroy it.	1509	If visible, hide the overlay, but do not destroy it.
1327		1510
…		…
1409	locale-specific encoding of the terminal and can contain command sequences	1592	locale-specific encoding of the terminal and can contain command sequences
1410	(escape codes) that will be interpreted.	1593	(escape codes) that will be interpreted.
1411		1594
1412	=item $term->tt_write ($octets)	1595	=item $term->tt_write ($octets)
1413		1596
1414	Write the octets given in C<$data> to the tty (i.e. as program input). To	1597	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1415	pass characters instead of octets, you should convert your strings first	1598	pass characters instead of octets, you should convert your strings first
1416	to the locale-specific encoding using C<< $term->locale_encode >>.	1599	to the locale-specific encoding using C<< $term->locale_encode >>.
		1600
		1601	=item $term->tt_paste ($octets)
		1602
		1603	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1604	CR and bracketing the data with control sequences if bracketed paste mode
		1605	is set.
1417		1606
1418	=item $old_events = $term->pty_ev_events ([$new_events])	1607	=item $old_events = $term->pty_ev_events ([$new_events])
1419		1608
1420	Replaces the event mask of the pty watcher by the given event mask. Can	1609	Replaces the event mask of the pty watcher by the given event mask. Can
1421	be used to suppress input and output handling to the pty/tty. See the	1610	be used to suppress input and output handling to the pty/tty. See the
…		…
1440	Adds the specified events to the vt event mask. Useful e.g. when you want	1629	Adds the specified events to the vt event mask. Useful e.g. when you want
1441	to receive pointer events all the times:	1630	to receive pointer events all the times:
1442		1631
1443	$term->vt_emask_add (urxvt::PointerMotionMask);	1632	$term->vt_emask_add (urxvt::PointerMotionMask);
1444		1633
		1634	=item $term->set_urgency ($set)
		1635
		1636	Enable/disable the urgency hint on the toplevel window.
		1637
1445	=item $term->focus_in	1638	=item $term->focus_in
1446		1639
1447	=item $term->focus_out	1640	=item $term->focus_out
1448		1641
1449	=item $term->key_press ($state, $keycode[, $time])	1642	=item $term->key_press ($state, $keycode[, $time])
…		…
1519		1712
1520	Returns the currently displayed screen (0 primary, 1 secondary).	1713	Returns the currently displayed screen (0 primary, 1 secondary).
1521		1714
1522	=item $cursor_is_hidden = $term->hidden_cursor	1715	=item $cursor_is_hidden = $term->hidden_cursor
1523		1716
1524	Returns wether the cursor is currently hidden or not.	1717	Returns whether the cursor is currently hidden or not.
1525		1718
1526	=item $view_start = $term->view_start ([$newvalue])	1719	=item $view_start = $term->view_start ([$newvalue])
1527		1720
1528	Returns the row number of the topmost displayed line. Maximum value is	1721	Returns the row number of the topmost displayed line. Maximum value is
1529	C<0>, which displays the normal terminal contents. Lower values scroll	1722	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1537		1730
1538	Used after changing terminal contents to display them.	1731	Used after changing terminal contents to display them.
1539		1732
1540	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1733	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1541		1734
1542	Returns the text of the entire row with number C<$row_number>. Row C<0>	1735	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1543	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1736	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1544	terminal line. The scrollback buffer starts at line C<-1> and extends to
1545	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1737	terminal line. Nothing will be returned if a nonexistent line
1546	is requested.	1738	is requested.
1547		1739
1548	If C<$new_text> is specified, it will replace characters in the current	1740	If C<$new_text> is specified, it will replace characters in the current
1549	line, starting at column C<$start_col> (default C<0>), which is useful	1741	line, starting at column C<$start_col> (default C<0>), which is useful
1550	to replace only parts of a line. The font index in the rendition will	1742	to replace only parts of a line. The font index in the rendition will
1551	automatically be updated.	1743	automatically be updated.
1552		1744
1553	C<$text> is in a special encoding: tabs and wide characters that use more	1745	C<$text> is in a special encoding: tabs and wide characters that use more
1554	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1746	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1555	characters. Characters with combining characters and other characters that	1747	characters. Characters with combining characters and other characters that
1556	do not fit into the normal tetx encoding will be replaced with characters	1748	do not fit into the normal text encoding will be replaced with characters
1557	in the private use area.	1749	in the private use area.
1558		1750
1559	You have to obey this encoding when changing text. The advantage is	1751	You have to obey this encoding when changing text. The advantage is
1560	that C<substr> and similar functions work on screen cells and not on	1752	that C<substr> and similar functions work on screen cells and not on
1561	characters.	1753	characters.
…		…
1706	where one character corresponds to one screen cell. See	1898	where one character corresponds to one screen cell. See
1707	C<< $term->ROW_t >> for details.	1899	C<< $term->ROW_t >> for details.
1708		1900
1709	=item $string = $term->special_decode $text	1901	=item $string = $term->special_decode $text
1710		1902
1711	Converts rxvt-unicodes text reprsentation into a perl string. See	1903	Converts rxvt-unicodes text representation into a perl string. See
1712	C<< $term->ROW_t >> for details.	1904	C<< $term->ROW_t >> for details.
1713		1905
1714	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1906	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1715		1907
1716	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1908	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1719	manpage.	1911	manpage.
1720		1912
1721	=item $success = $term->grab ($eventtime[, $sync])	1913	=item $success = $term->grab ($eventtime[, $sync])
1722		1914
1723	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1915	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1724	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1916	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1725		1917
1726	=item $term->allow_events_async	1918	=item $term->allow_events_async
1727		1919
1728	Calls XAllowEvents with AsyncBoth for the most recent grab.	1920	Calls XAllowEvents with AsyncBoth for the most recent grab.
1729		1921
…		…
1736	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1928	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1737	recent grab.	1929	recent grab.
1738		1930
1739	=item $term->ungrab	1931	=item $term->ungrab
1740		1932
1741	Calls XUngrab for the most recent grab. Is called automatically on	1933	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1742	evaluation errors, as it is better to lose the grab in the error case as	1934	evaluation errors, as it is better to lose the grab in the error case as
1743	the session.	1935	the session.
1744		1936
1745	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1937	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1746		1938
…		…
1748		1940
1749	=item @atoms = $term->XListProperties ($window)	1941	=item @atoms = $term->XListProperties ($window)
1750		1942
1751	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1943	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1752		1944
1753	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1945	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1754		1946
1755	=item $term->XDeleteProperty ($window, $property)	1947	=item $term->XDeleteProperty ($window, $property)
1756		1948
1757	=item $window = $term->DefaultRootWindow	1949	=item $window = $term->DefaultRootWindow
1758		1950
…		…
1765	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1957	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1766		1958
1767	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1959	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1768		1960
1769	=item $term->XChangeInput ($window, $add_events[, $del_events])	1961	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1962
		1963	=item $keysym = $term->XStringToKeysym ($string)
		1964
		1965	=item $string = $term->XKeysymToString ($keysym)
1770		1966
1771	Various X or X-related functions. The C<$term> object only serves as	1967	Various X or X-related functions. The C<$term> object only serves as
1772	the source of the display, otherwise those functions map more-or-less	1968	the source of the display, otherwise those functions map more-or-less
1773	directory onto the X functions of the same name.	1969	directly onto the X functions of the same name.
1774		1970
1775	=back	1971	=back
1776		1972
1777	=cut	1973	=cut
1778		1974
…		…
1880	my $env = $self->{term}->env;	2076	my $env = $self->{term}->env;
1881	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2077	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1882	delete $env->{LC_ALL};	2078	delete $env->{LC_ALL};
1883	$env->{LC_CTYPE} = $self->{term}->locale;	2079	$env->{LC_CTYPE} = $self->{term}->locale;
1884		2080
1885	urxvt::term->new ($env, "popup",	2081	my $term = urxvt::term->new (
		2082	$env, "popup",
1886	"--perl-lib" => "", "--perl-ext-common" => "",	2083	"--perl-lib" => "", "--perl-ext-common" => "",
1887	"-pty-fd" => -1, "-sl" => 0,	2084	"-pty-fd" => -1, "-sl" => 0,
1888	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2085	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1889	"--transient-for" => $self->{term}->parent,	2086	"--transient-for" => $self->{term}->parent,
1890	"-display" => $self->{term}->display_id,	2087	"-display" => $self->{term}->display_id,
1891	"-pe" => "urxvt-popup")	2088	"-pe" => "urxvt-popup",
1892	or die "unable to create popup window\n";	2089	) or die "unable to create popup window\n";
		2090
		2091	unless (delete $term->{urxvt_popup_init_done}) {
		2092	$term->ungrab;
		2093	$term->destroy;
		2094	die "unable to initialise popup window\n";
		2095	}
1893	}	2096	}
1894		2097
1895	sub DESTROY {	2098	sub DESTROY {
1896	my ($self) = @_;	2099	my ($self) = @_;
1897		2100
…		…
1902	=back	2105	=back
1903		2106
1904	=cut	2107	=cut
1905		2108
1906	package urxvt::watcher;	2109	package urxvt::watcher;
1907
1908	@urxvt::timer::ISA = __PACKAGE__;
1909	@urxvt::iow::ISA = __PACKAGE__;
1910	@urxvt::pw::ISA = __PACKAGE__;
1911	@urxvt::iw::ISA = __PACKAGE__;
1912		2110
1913	=head2 The C<urxvt::timer> Class	2111	=head2 The C<urxvt::timer> Class
1914		2112
1915	This class implements timer watchers/events. Time is represented as a	2113	This class implements timer watchers/events. Time is represented as a
1916	fractional number of seconds since the epoch. Example:	2114	fractional number of seconds since the epoch. Example:
…		…
1920	->new	2118	->new
1921	->interval (1)	2119	->interval (1)
1922	->cb (sub {	2120	->cb (sub {
1923	$term->{overlay}->set (0, 0,	2121	$term->{overlay}->set (0, 0,
1924	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2122	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1925	});	2123	});
1926		2124
1927	=over 4	2125	=over 4
1928		2126
1929	=item $timer = new urxvt::timer	2127	=item $timer = new urxvt::timer
1930		2128
…		…
1933		2131
1934	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2132	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1935		2133
1936	Set the callback to be called when the timer triggers.	2134	Set the callback to be called when the timer triggers.
1937		2135
1938	=item $tstamp = $timer->at
1939
1940	Return the time this watcher will fire next.
1941
1942	=item $timer = $timer->set ($tstamp)	2136	=item $timer = $timer->set ($tstamp[, $interval])
1943		2137
1944	Set the time the event is generated to $tstamp.	2138	Set the time the event is generated to $tstamp (and optionally specifies a
		2139	new $interval).
1945		2140
1946	=item $timer = $timer->interval ($interval)	2141	=item $timer = $timer->interval ($interval)
1947		2142
1948	Normally (and when C<$interval> is C<0>), the timer will automatically	2143	By default (and when C<$interval> is C<0>), the timer will automatically
1949	stop after it has fired once. If C<$interval> is non-zero, then the timer	2144	stop after it has fired once. If C<$interval> is non-zero, then the timer
1950	is automatically rescheduled at the given intervals.	2145	is automatically rescheduled at the given intervals.
1951		2146
1952	=item $timer = $timer->start	2147	=item $timer = $timer->start
1953		2148
1954	Start the timer.	2149	Start the timer.
1955		2150
1956	=item $timer = $timer->start ($tstamp)	2151	=item $timer = $timer->start ($tstamp[, $interval])
1957		2152
1958	Set the event trigger time to C<$tstamp> and start the timer.	2153	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2154	also replaces the interval.
1959		2155
1960	=item $timer = $timer->after ($delay)	2156	=item $timer = $timer->after ($delay[, $interval])
1961		2157
1962	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2158	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1963		2159
1964	=item $timer = $timer->stop	2160	=item $timer = $timer->stop
1965		2161
…		…
1973		2169
1974	$term->{socket} = ...	2170	$term->{socket} = ...
1975	$term->{iow} = urxvt::iow	2171	$term->{iow} = urxvt::iow
1976	->new	2172	->new
1977	->fd (fileno $term->{socket})	2173	->fd (fileno $term->{socket})
1978	->events (urxvt::EVENT_READ)	2174	->events (urxvt::EV_READ)
1979	->start	2175	->start
1980	->cb (sub {	2176	->cb (sub {
1981	my ($iow, $revents) = @_;	2177	my ($iow, $revents) = @_;
1982	# $revents must be 1 here, no need to check	2178	# $revents must be 1 here, no need to check
1983	sysread $term->{socket}, my $buf, 8192	2179	sysread $term->{socket}, my $buf, 8192
…		…
1996	Set the callback to be called when io events are triggered. C<$reventmask>	2192	Set the callback to be called when io events are triggered. C<$reventmask>
1997	is a bitset as described in the C<events> method.	2193	is a bitset as described in the C<events> method.
1998		2194
1999	=item $iow = $iow->fd ($fd)	2195	=item $iow = $iow->fd ($fd)
2000		2196
2001	Set the filedescriptor (not handle) to watch.	2197	Set the file descriptor (not handle) to watch.
2002		2198
2003	=item $iow = $iow->events ($eventmask)	2199	=item $iow = $iow->events ($eventmask)
2004		2200
2005	Set the event mask to watch. The only allowed values are	2201	Set the event mask to watch. The only allowed values are
2006	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2202	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2007	together, or C<urxvt::EVENT_NONE>.	2203	together, or C<urxvt::EV_NONE>.
2008		2204
2009	=item $iow = $iow->start	2205	=item $iow = $iow->start
2010		2206
2011	Start watching for requested events on the given handle.	2207	Start watching for requested events on the given handle.
2012		2208
2013	=item $iow = $iow->stop	2209	=item $iow = $iow->stop
2014		2210
2015	Stop watching for events on the given filehandle.	2211	Stop watching for events on the given file handle.
2016		2212
2017	=back	2213	=back
2018		2214
2019	=head2 The C<urxvt::iw> Class	2215	=head2 The C<urxvt::iw> Class
2020		2216
…		…
2053	->new	2249	->new
2054	->start ($pid)	2250	->start ($pid)
2055	->cb (sub {	2251	->cb (sub {
2056	my ($pw, $exit_status) = @_;	2252	my ($pw, $exit_status) = @_;
2057	...	2253	...
2058	});	2254	});
2059		2255
2060	=over 4	2256	=over 4
2061		2257
2062	=item $pw = new urxvt::pw	2258	=item $pw = new urxvt::pw
2063		2259
…		…
2067		2263
2068	Set the callback to be called when the timer triggers.	2264	Set the callback to be called when the timer triggers.
2069		2265
2070	=item $pw = $timer->start ($pid)	2266	=item $pw = $timer->start ($pid)
2071		2267
2072	Tells the wqtcher to start watching for process C<$pid>.	2268	Tells the watcher to start watching for process C<$pid>.
2073		2269
2074	=item $pw = $pw->stop	2270	=item $pw = $pw->stop
2075		2271
2076	Stop the watcher.	2272	Stop the watcher.
2077		2273
…		…
2090		2286
2091	=item >= 3 - script loading and management	2287	=item >= 3 - script loading and management
2092		2288
2093	=item >=10 - all called hooks	2289	=item >=10 - all called hooks
2094		2290
2095	=item >=11 - hook reutrn values	2291	=item >=11 - hook return values
2096		2292
2097	=back	2293	=back
2098		2294
2099	=head1 AUTHOR	2295	=head1 AUTHOR
2100		2296
2101	Marc Lehmann <pcg@goof.com>	2297	Marc Lehmann <schmorp@schmorp.de>
2102	http://software.schmorp.de/pkg/rxvt-unicode	2298	http://software.schmorp.de/pkg/rxvt-unicode
2103		2299
2104	=cut	2300	=cut
2105		2301
2106	1	2302	1
		2303
		2304	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.142 by root, Thu Jul 6 18:56:10 2006 UTC vs. Revision 1.204 by sf-exg, Mon Dec 5 12:52:57 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.142 by root, Thu Jul 6 18:56:10 2006 UTC vs.
Revision 1.204 by sf-exg, Mon Dec 5 12:52:57 2011 UTC