[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.197 by sf-tpope, Fri Aug 19 23:08:35 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.
337		404
338	=back	405	=back
339		406
340	=head1 API DOCUMENTATION	407	=head1 API DOCUMENTATION
341		408
…		…
357		424
358	=over 4	425	=over 4
359		426
360	=item $text	427	=item $text
361		428
362	Rxvt-unicodes special way of encoding text, where one "unicode" character	429	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.	430	always represents one screen cell. See L<ROW_t> for a discussion of this format.
364		431
365	=item $string	432	=item $string
366		433
367	A perl text string, with an emphasis on I<text>. It can store all unicode	434	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
376	=back	443	=back
377		444
378	=head2 Extension Objects	445	=head2 Extension Objects
379		446
380	Every perl extension is a perl class. A separate perl object is created	447	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	448	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	449	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	450	their C<$self> object without having to think about clashes with other
		451	extensions or other terminals, with the exception of methods and members
384	begin with an underscore character C<_>: these are reserved for internal	452	that begin with an underscore character C<_>: these are reserved for
385	use.	453	internal use.
386		454
387	Although it isn't a C<urxvt::term> object, you can call all methods of the	455	Although it isn't a C<urxvt::term> object, you can call all methods of the
388	C<urxvt::term> class on this object.	456	C<urxvt::term> class on this object.
389		457
390	It has the following methods and data members:	458	It has the following methods and data members:
…		…
411	=head2 Hooks	479	=head2 Hooks
412		480
413	The following subroutines can be declared in extension files, and will be	481	The following subroutines can be declared in extension files, and will be
414	called whenever the relevant event happens.	482	called whenever the relevant event happens.
415		483
416	The first argument passed to them is an extension oject as described in	484	The first argument passed to them is an extension object as described in
417	the in the C<Extension Objects> section.	485	the in the C<Extension Objects> section.
418		486
419	B<All> of these hooks must return a boolean value. If any of the called	487	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	488	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.	489	relevant action might not be carried out by the C++ code.
…		…
434	place.	502	place.
435		503
436	=item on_start $term	504	=item on_start $term
437		505
438	Called at the very end of initialisation of a new terminal, just before	506	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.	507	trying to map (display) the toplevel and returning to the main loop.
440		508
441	=item on_destroy $term	509	=item on_destroy $term
442		510
443	Called whenever something tries to destroy terminal, when the terminal is	511	Called whenever something tries to destroy terminal, when the terminal is
444	still fully functional (not for long, though).	512	still fully functional (not for long, though).
…		…
471		539
472	Called whenever a selection has been copied, but before the selection is	540	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	541	requested from the server. The selection text can be queried and changed
474	by calling C<< $term->selection >>.	542	by calling C<< $term->selection >>.
475		543
476	Returning a true value aborts selection grabbing. It will still be hilighted.	544	Returning a true value aborts selection grabbing. It will still be highlighted.
477		545
478	=item on_sel_extend $term	546	=item on_sel_extend $term
479		547
480	Called whenever the user tries to extend the selection (e.g. with a double	548	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	549	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	550	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	551	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	552	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.	553	supposed to enlarge the selection more and more, if possible.
486		554
487	See the F<selection> example extension.	555	See the F<selection> example extension.
488		556
489	=item on_view_change $term, $offset	557	=item on_view_change $term, $offset
490		558
491	Called whenever the view offset changes, i..e the user or program	559	Called whenever the view offset changes, i.e. the user or program
492	scrolls. Offset C<0> means display the normal terminal, positive values	560	scrolls. Offset C<0> means display the normal terminal, positive values
493	show this many lines of scrollback.	561	show this many lines of scrollback.
494		562
495	=item on_scroll_back $term, $lines, $saved	563	=item on_scroll_back $term, $lines, $saved
496		564
…		…
500		568
501	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	569	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	570	$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.	571	number of lines that will be in the scrollback buffer.
504		572
505	=item on_osc_seq $term, $op, $args	573	=item on_osc_seq $term, $op, $args, $resp
506		574
507	Called on every OSC sequence and can be used to suppress it or modify its	575	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	576	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	577	suppresses execution of the request completely. Make sure you don't get
510	confused by recursive invocations when you output an osc sequence within	578	confused by recursive invocations when you output an OSC sequence within
511	this callback.	579	this callback.
512		580
513	C<on_osc_seq_perl> should be used for new behaviour.	581	C<on_osc_seq_perl> should be used for new behaviour.
514		582
515	=item on_osc_seq_perl $term, $string	583	=item on_osc_seq_perl $term, $args, $resp
516		584
517	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	585	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
518	operating system command) is processed. Cursor position and other state	586	operating system command) is processed. Cursor position and other state
519	information is up-to-date when this happens. For interoperability, the	587	information is up-to-date when this happens. For interoperability, the
520	string should start with the extension name and a colon, to distinguish	588	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	589	to distinguish it from commands for other extensions, and this might be
522	future.	590	enforced in the future.
		591
		592	For example, C<overlay-osc> uses this:
		593
		594	sub on_osc_seq_perl {
		595	my ($self, $osc, $resp) = @_;
		596
		597	return unless $osc =~ s/^overlay;//;
		598
		599	... process remaining $osc string
		600	}
523		601
524	Be careful not ever to trust (in a security sense) the data you receive,	602	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	603	as its source can not easily be controlled (e-mail content, messages from
526	other users on the same system etc.).	604	other users on the same system etc.).
		605
		606	For responses, C<$resp> contains the end-of-args separator used by the
		607	sender.
527		608
528	=item on_add_lines $term, $string	609	=item on_add_lines $term, $string
529		610
530	Called whenever text is about to be output, with the text as argument. You	611	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	612	can filter/change and output the text yourself by returning a true value
…		…
536	=item on_tt_write $term, $octets	617	=item on_tt_write $term, $octets
537		618
538	Called whenever some data is written to the tty/pty and can be used to	619	Called whenever some data is written to the tty/pty and can be used to
539	suppress or filter tty input.	620	suppress or filter tty input.
540		621
		622	=item on_tt_paste $term, $octets
		623
		624	Called whenever text is about to be pasted, with the text as argument. You
		625	can filter/change and paste the text yourself by returning a true value
		626	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		627	locale-encoded.
		628
541	=item on_line_update $term, $row	629	=item on_line_update $term, $row
542		630
543	Called whenever a line was updated or changed. Can be used to filter	631	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	632	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,	633	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	640	later with the already-modified line (e.g. if unrelated parts change), so
553	you cannot just toggle rendition bits, but only set them.	641	you cannot just toggle rendition bits, but only set them.
554		642
555	=item on_refresh_begin $term	643	=item on_refresh_begin $term
556		644
557	Called just before the screen gets redrawn. Can be used for overlay	645	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	646	similar effects by modifying the terminal contents in refresh_begin, and
559	restoring them in refresh_end. The built-in overlay and selection display	647	restoring them in refresh_end. The built-in overlay and selection display
560	code is run after this hook, and takes precedence.	648	code is run after this hook, and takes precedence.
561		649
562	=item on_refresh_end $term	650	=item on_refresh_end $term
563		651
564	Called just after the screen gets redrawn. See C<on_refresh_begin>.	652	Called just after the screen gets redrawn. See C<on_refresh_begin>.
565		653
566	=item on_user_command $term, $string	654	=item on_user_command $term, $string
567		655
568	Called whenever the a user-configured event is being activated (e.g. via	656	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>	657	a C<perl:string> action bound to a key, see description of the B<keysym>
570	resource in the @@RXVT_NAME@@(1) manpage).	658	resource in the @@RXVT_NAME@@(1) manpage).
571		659
572	The event is simply the action string. This interface is assumed to change	660	The event is simply the action string. This interface is assumed to change
573	slightly in the future.	661	slightly in the future.
574		662
575	=item on_resize_all_windows $tern, $new_width, $new_height	663	=item on_resize_all_windows $term, $new_width, $new_height
576		664
577	Called just after the new window size has been calculcated, but before	665	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	666	windows are actually being resized or hints are being set. If this hook
579	returns TRUE, setting of the window hints is being skipped.	667	returns TRUE, setting of the window hints is being skipped.
580		668
581	=item on_x_event $term, $event	669	=item on_x_event $term, $event
582		670
583	Called on every X event received on the vt window (and possibly other	671	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	672	windows). Should only be used as a last resort. Most event structure
585	members are not passed.	673	members are not passed.
586		674
		675	=item on_root_event $term, $event
		676
		677	Like C<on_x_event>, but is called for events on the root window.
		678
587	=item on_focus_in $term	679	=item on_focus_in $term
588		680
589	Called whenever the window gets the keyboard focus, before rxvt-unicode	681	Called whenever the window gets the keyboard focus, before rxvt-unicode
590	does focus in processing.	682	does focus in processing.
591		683
592	=item on_focus_out $term	684	=item on_focus_out $term
593		685
594	Called wheneever the window loses keyboard focus, before rxvt-unicode does	686	Called whenever the window loses keyboard focus, before rxvt-unicode does
595	focus out processing.	687	focus out processing.
596		688
597	=item on_configure_notify $term, $event	689	=item on_configure_notify $term, $event
598		690
599	=item on_property_notify $term, $event	691	=item on_property_notify $term, $event
…		…
610		702
611	=item on_map_notify $term, $event	703	=item on_map_notify $term, $event
612		704
613	=item on_unmap_notify $term, $event	705	=item on_unmap_notify $term, $event
614		706
615	Called whenever the corresponding X event is received for the terminal If	707	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.	708	the hook returns true, then the event will be ignored by rxvt-unicode.
617		709
618	The event is a hash with most values as named by Xlib (see the XEvent	710	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	711	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.	712	(real, not screen-based) row and column under the mouse cursor.
621		713
…		…
630		722
631	=item on_wm_delete_window $term, $event	723	=item on_wm_delete_window $term, $event
632		724
633	Called when various types of ClientMessage events are received (all with	725	Called when various types of ClientMessage events are received (all with
634	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	726	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		727
		728	=item on_bell $term
		729
		730	Called on receipt of a bell character.
635		731
636	=back	732	=back
637		733
638	=cut	734	=cut
639		735
…		…
682	The current terminal. This variable stores the current C<urxvt::term>	778	The current terminal. This variable stores the current C<urxvt::term>
683	object, whenever a callback/hook is executing.	779	object, whenever a callback/hook is executing.
684		780
685	=item @urxvt::TERM_INIT	781	=item @urxvt::TERM_INIT
686		782
687	All coderefs in this array will be called as methods of the next newly	783	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	784	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,	785	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.	786	so references can push themselves onto it again if they so desire.
691		787
692	This complements to the perl-eval commandline option, but gets executed	788	This complements to the perl-eval command line option, but gets executed
693	first.	789	first.
694		790
695	=item @urxvt::TERM_EXT	791	=item @urxvt::TERM_EXT
696		792
697	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	793	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
704		800
705	=over 4	801	=over 4
706		802
707	=item urxvt::fatal $errormessage	803	=item urxvt::fatal $errormessage
708		804
709	Fatally aborts execution with the given error message. Avoid at all	805	Fatally aborts execution with the given error message (which should
710	costs! The only time this is acceptable is when the terminal process	806	include a trailing newline). Avoid at all costs! The only time this
711	starts up.	807	is acceptable (and useful) is in the init hook, where it prevents the
		808	terminal from starting up.
712		809
713	=item urxvt::warn $string	810	=item urxvt::warn $string
714		811
715	Calls C<rxvt_warn> with the given string which should not include a	812	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	813	newline. The module also overwrites the C<warn> builtin with a function
717	that calls this function.	814	that calls this function.
718		815
719	Using this function has the advantage that its output ends up in the	816	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.	817	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
722	Messages have a size limit of 1023 bytes currently.	819	Messages have a size limit of 1023 bytes currently.
723		820
724	=item @terms = urxvt::termlist	821	=item @terms = urxvt::termlist
725		822
726	Returns all urxvt::term objects that exist in this process, regardless of	823	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	824	whether they are started, being destroyed etc., so be careful. Only term
728	objects that have perl extensions attached will be returned (because there	825	objects that have perl extensions attached will be returned (because there
729	is no urxvt::term objet associated with others).	826	is no urxvt::term object associated with others).
730		827
731	=item $time = urxvt::NOW	828	=item $time = urxvt::NOW
732		829
733	Returns the "current time" (as per the event loop).	830	Returns the "current time" (as per the event loop).
734		831
…		…
777		874
778	=item $rend = urxvt::OVERLAY_RSTYLE	875	=item $rend = urxvt::OVERLAY_RSTYLE
779		876
780	Return the rendition mask used for overlays by default.	877	Return the rendition mask used for overlays by default.
781		878
782	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	879	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		880	urxvt::RS_RVid, urxvt::RS_Uline
783		881
784	Return the bit that enabled bold, italic, blink, reverse-video and	882	Return the bit that enabled bold, italic, blink, reverse-video and
785	underline, respectively. To enable such a style, just logically OR it into	883	underline, respectively. To enable such a style, just logically OR it into
786	the bitset.	884	the bitset.
787		885
…		…
870	local $TERM = shift;	968	local $TERM = shift;
871	my $htype = shift;	969	my $htype = shift;
872		970
873	if ($htype == 0) { # INIT	971	if ($htype == 0) { # INIT
874	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	972	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
875		973
876	my %ext_arg;	974	my %ext_arg;
877		975
878	{	976	{
879	my @init = @TERM_INIT;	977	my @init = @TERM_INIT;
880	@TERM_INIT = ();	978	@TERM_INIT = ();
…		…
943		1041
944	sub SET_COLOR($$$) {	1042	sub SET_COLOR($$$) {
945	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1043	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
946	}	1044	}
947		1045
		1046	sub rend2mask {
		1047	no strict 'refs';
		1048	my ($str, $mask) = (@_, 0);
		1049	my %color = ( fg => undef, bg => undef );
		1050	my @failed;
		1051	for my $spec ( split /\s+/, $str ) {
		1052	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1053	$color{lc($1)} = $2;
		1054	} else {
		1055	my $neg = $spec =~ s/^[-^]//;
		1056	unless ( exists &{"RS_$spec"} ) {
		1057	push @failed, $spec;
		1058	next;
		1059	}
		1060	my $cur = &{"RS_$spec"};
		1061	if ( $neg ) {
		1062	$mask &= ~$cur;
		1063	} else {
		1064	$mask \|= $cur;
		1065	}
		1066	}
		1067	}
		1068	($mask, @color{qw(fg bg)}, \@failed)
		1069	}
		1070
948	# urxvt::term::extension	1071	# urxvt::term::extension
949		1072
950	package urxvt::term::extension;	1073	package urxvt::term::extension;
951		1074
952	sub enable {	1075	sub enable {
…		…
1021	is that you cannot use blocking APIs, but the non-blocking variant should	1144	is that you cannot use blocking APIs, but the non-blocking variant should
1022	work.	1145	work.
1023		1146
1024	=cut	1147	=cut
1025		1148
1026	our $VERSION = 1;	1149	our $VERSION = '5.23';
1027		1150
1028	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1151	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1029	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1152	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1030		1153
1031	sub timer {	1154	sub timer {
…		…
1033		1156
1034	my $cb = $arg{cb};	1157	my $cb = $arg{cb};
1035		1158
1036	urxvt::timer	1159	urxvt::timer
1037	->new	1160	->new
1038	->start (urxvt::NOW + $arg{after})	1161	->after ($arg{after}, $arg{interval})
1039	->cb (sub {	1162	->cb ($arg{interval} ? $cb : sub {
1040	$_[0]->stop; # need to cancel manually	1163	$_[0]->stop; # need to cancel manually
1041	$cb->();	1164	$cb->();
1042	})	1165	})
1043	}	1166	}
1044		1167
1045	sub io {	1168	sub io {
1046	my ($class, %arg) = @_;	1169	my ($class, %arg) = @_;
1047		1170
1048	my $cb = $arg{cb};	1171	my $cb = $arg{cb};
		1172	my $fd = fileno $arg{fh};
		1173	defined $fd or $fd = $arg{fh};
1049		1174
1050	bless [$arg{fh}, urxvt::iow	1175	bless [$arg{fh}, urxvt::iow
1051	->new	1176	->new
1052	->fd (fileno $arg{fh})	1177	->fd ($fd)
1053	->events (($arg{poll} =~ /r/ ? 1 : 0)	1178	->events (($arg{poll} =~ /r/ ? 1 : 0)
1054	\| ($arg{poll} =~ /w/ ? 2 : 0))	1179	\| ($arg{poll} =~ /w/ ? 2 : 0))
1055	->start	1180	->start
1056	->cb (sub {	1181	->cb ($cb)
1057	$cb->(($_[1] & 1 ? 'r' : '')
1058	. ($_[1] & 2 ? 'w' : ''));
1059	})],
1060	urxvt::anyevent::	1182	], urxvt::anyevent::
		1183	}
		1184
		1185	sub idle {
		1186	my ($class, %arg) = @_;
		1187
		1188	my $cb = $arg{cb};
		1189
		1190	urxvt::iw
		1191	->new
		1192	->start
		1193	->cb ($cb)
		1194	}
		1195
		1196	sub child {
		1197	my ($class, %arg) = @_;
		1198
		1199	my $cb = $arg{cb};
		1200
		1201	urxvt::pw
		1202	->new
		1203	->start ($arg{pid})
		1204	->cb (sub {
		1205	$_[0]->stop; # need to cancel manually
		1206	$cb->($_[0]->rpid, $_[0]->rstatus);
		1207	})
1061	}	1208	}
1062		1209
1063	sub DESTROY {	1210	sub DESTROY {
1064	$_[0][1]->stop;	1211	$_[0][1]->stop;
1065	}	1212	}
1066		1213
1067	sub condvar {	1214	sub one_event {
1068	bless \my $flag, urxvt::anyevent::condvar::
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";	1215	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1078	}
1079	}	1216	}
1080		1217
1081	package urxvt::term;	1218	package urxvt::term;
1082		1219
1083	=head2 The C<urxvt::term> Class	1220	=head2 The C<urxvt::term> Class
…		…
1170		1307
1171	Returns true if the option specified by C<$optval> is enabled, and	1308	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	1309	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.	1310	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1174		1311
1175	Here is a a likely non-exhaustive list of option names, please see the	1312	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:	1313	source file F</src/optinc.h> to see the actual list:
1177		1314
1178	borderLess console cursorBlink cursorUnderline hold iconic insecure	1315	borderLess buffered console cursorBlink cursorUnderline hold iconic
1179	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1316	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1180	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1317	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1181	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1318	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1182	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1319	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1183	transparent tripleclickwords utmpInhibit visualBell	1320	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1321	urgentOnBell utmpInhibit visualBell
1184		1322
1185	=item $value = $term->resource ($name[, $newval])	1323	=item $value = $term->resource ($name[, $newval])
1186		1324
1187	Returns the current resource value associated with a given name and	1325	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>	1326	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1197	likely change).	1335	likely change).
1198		1336
1199	Please note that resource strings will currently only be freed when the	1337	Please note that resource strings will currently only be freed when the
1200	terminal is destroyed, so changing options frequently will eat memory.	1338	terminal is destroyed, so changing options frequently will eat memory.
1201		1339
1202	Here is a a likely non-exhaustive list of resource names, not all of which	1340	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>	1341	are supported in every build, please see the source file F</src/rsinc.h>
1204	to see the actual list:	1342	to see the actual list:
1205		1343
1206	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1344	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1207	borderLess color cursorBlink cursorUnderline cutchars delete_key	1345	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1208	display_name embed ext_bwidth fade font geometry hold iconName	1346	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1209	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1347	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1348	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1210	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1349	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1211	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1350	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1212	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1351	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1213	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1352	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1214	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1353	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1215	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1354	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1216	secondaryScreen secondaryScroll selectstyle shade term_name title	1355	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1217	transient_for transparent transparent_all tripleclickwords utmpInhibit	1356	term_name title transient_for transparent tripleclickwords urgentOnBell
1218	visualBell	1357	utmpInhibit visualBell
1219		1358
1220	=cut	1359	=cut
1221		1360
1222	sub resource($$;$) {	1361	sub resource($$;$) {
1223	my ($self, $name) = (shift, shift);	1362	my ($self, $name) = (shift, shift);
1224	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1363	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1225	&urxvt::term::_resource	1364	goto &urxvt::term::_resource
1226	}	1365	}
1227		1366
1228	=item $value = $term->x_resource ($pattern)	1367	=item $value = $term->x_resource ($pattern)
1229		1368
1230	Returns the X-Resource for the given pattern, excluding the program or	1369	Returns the X-Resource for the given pattern, excluding the program or
…		…
1255		1394
1256	=item ($row, $col) = $term->selection_beg ([$row, $col])	1395	=item ($row, $col) = $term->selection_beg ([$row, $col])
1257		1396
1258	=item ($row, $col) = $term->selection_end ([$row, $col])	1397	=item ($row, $col) = $term->selection_end ([$row, $col])
1259		1398
1260	Return the current values of the selection mark, begin or end positions,	1399	Return the current values of the selection mark, begin or end positions.
1261	and optionally set them to new values.	1400
		1401	When arguments are given, then the selection coordinates are set to
		1402	C<$row> and C<$col>, and the selection screen is set to the current
		1403	screen.
		1404
		1405	=item $screen = $term->selection_screen ([$screen])
		1406
		1407	Returns the current selection screen, and then optionally sets it.
1262		1408
1263	=item $term->selection_make ($eventtime[, $rectangular])	1409	=item $term->selection_make ($eventtime[, $rectangular])
1264		1410
1265	Tries to make a selection as set by C<selection_beg> and	1411	Tries to make a selection as set by C<selection_beg> and
1266	C<selection_end>. If C<$rectangular> is true (default: false), a	1412	C<selection_end>. If C<$rectangular> is true (default: false), a
1267	rectangular selection will be made. This is the prefered function to make	1413	rectangular selection will be made. This is the preferred function to make
1268	a selection.	1414	a selection.
1269		1415
1270	=item $success = $term->selection_grab ($eventtime)	1416	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1271		1417
1272	Try to request the primary selection text from the server (for example, as	1418	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1419	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	1420	with the next method. No visual feedback will be given. This function
1274	is mostly useful from within C<on_sel_grab> hooks.	1421	is mostly useful from within C<on_sel_grab> hooks.
1275		1422
1276	=item $oldtext = $term->selection ([$newtext])	1423	=item $oldtext = $term->selection ([$newtext, $clipboard])
1277		1424
1278	Return the current selection text and optionally replace it by C<$newtext>.	1425	Return the current selection (clipboard if C<$clipboard> is true) text
		1426	and optionally replace it by C<$newtext>.
		1427
		1428	=item $term->selection_clear ([$clipboard])
		1429
		1430	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1279		1431
1280	=item $term->overlay_simple ($x, $y, $text)	1432	=item $term->overlay_simple ($x, $y, $text)
1281		1433
1282	Create a simple multi-line overlay box. See the next method for details.	1434	Create a simple multi-line overlay box. See the next method for details.
1283		1435
…		…
1313		1465
1314	The methods currently supported on C<urxvt::overlay> objects are:	1466	The methods currently supported on C<urxvt::overlay> objects are:
1315		1467
1316	=over 4	1468	=over 4
1317		1469
1318	=item $overlay->set ($x, $y, $text, $rend)	1470	=item $overlay->set ($x, $y, $text[, $rend])
1319		1471
1320	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1472	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	1473	text in rxvt-unicode's special encoding and an array of rendition values
1322	at a specific position inside the overlay.	1474	at a specific position inside the overlay.
		1475
		1476	If C<$rend> is missing, then the rendition will not be changed.
1323		1477
1324	=item $overlay->hide	1478	=item $overlay->hide
1325		1479
1326	If visible, hide the overlay, but do not destroy it.	1480	If visible, hide the overlay, but do not destroy it.
1327		1481
…		…
1409	locale-specific encoding of the terminal and can contain command sequences	1563	locale-specific encoding of the terminal and can contain command sequences
1410	(escape codes) that will be interpreted.	1564	(escape codes) that will be interpreted.
1411		1565
1412	=item $term->tt_write ($octets)	1566	=item $term->tt_write ($octets)
1413		1567
1414	Write the octets given in C<$data> to the tty (i.e. as program input). To	1568	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	1569	pass characters instead of octets, you should convert your strings first
1416	to the locale-specific encoding using C<< $term->locale_encode >>.	1570	to the locale-specific encoding using C<< $term->locale_encode >>.
		1571
		1572	=item $term->tt_paste ($octets)
		1573
		1574	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1575	CR and bracketing the data with control sequences if bracketed paste mode
		1576	is set.
1417		1577
1418	=item $old_events = $term->pty_ev_events ([$new_events])	1578	=item $old_events = $term->pty_ev_events ([$new_events])
1419		1579
1420	Replaces the event mask of the pty watcher by the given event mask. Can	1580	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	1581	be used to suppress input and output handling to the pty/tty. See the
…		…
1519		1679
1520	Returns the currently displayed screen (0 primary, 1 secondary).	1680	Returns the currently displayed screen (0 primary, 1 secondary).
1521		1681
1522	=item $cursor_is_hidden = $term->hidden_cursor	1682	=item $cursor_is_hidden = $term->hidden_cursor
1523		1683
1524	Returns wether the cursor is currently hidden or not.	1684	Returns whether the cursor is currently hidden or not.
1525		1685
1526	=item $view_start = $term->view_start ([$newvalue])	1686	=item $view_start = $term->view_start ([$newvalue])
1527		1687
1528	Returns the row number of the topmost displayed line. Maximum value is	1688	Returns the row number of the topmost displayed line. Maximum value is
1529	C<0>, which displays the normal terminal contents. Lower values scroll	1689	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1537		1697
1538	Used after changing terminal contents to display them.	1698	Used after changing terminal contents to display them.
1539		1699
1540	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1700	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1541		1701
1542	Returns the text of the entire row with number C<$row_number>. Row C<0>	1702	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	1703	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	1704	terminal line. Nothing will be returned if a nonexistent line
1546	is requested.	1705	is requested.
1547		1706
1548	If C<$new_text> is specified, it will replace characters in the current	1707	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	1708	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	1709	to replace only parts of a line. The font index in the rendition will
1551	automatically be updated.	1710	automatically be updated.
1552		1711
1553	C<$text> is in a special encoding: tabs and wide characters that use more	1712	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)	1713	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1555	characters. Characters with combining characters and other characters that	1714	characters. Characters with combining characters and other characters that
1556	do not fit into the normal tetx encoding will be replaced with characters	1715	do not fit into the normal text encoding will be replaced with characters
1557	in the private use area.	1716	in the private use area.
1558		1717
1559	You have to obey this encoding when changing text. The advantage is	1718	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	1719	that C<substr> and similar functions work on screen cells and not on
1561	characters.	1720	characters.
…		…
1706	where one character corresponds to one screen cell. See	1865	where one character corresponds to one screen cell. See
1707	C<< $term->ROW_t >> for details.	1866	C<< $term->ROW_t >> for details.
1708		1867
1709	=item $string = $term->special_decode $text	1868	=item $string = $term->special_decode $text
1710		1869
1711	Converts rxvt-unicodes text reprsentation into a perl string. See	1870	Converts rxvt-unicodes text representation into a perl string. See
1712	C<< $term->ROW_t >> for details.	1871	C<< $term->ROW_t >> for details.
1713		1872
1714	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1873	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1715		1874
1716	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1875	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1719	manpage.	1878	manpage.
1720		1879
1721	=item $success = $term->grab ($eventtime[, $sync])	1880	=item $success = $term->grab ($eventtime[, $sync])
1722		1881
1723	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1882	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1724	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1883	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1725		1884
1726	=item $term->allow_events_async	1885	=item $term->allow_events_async
1727		1886
1728	Calls XAllowEvents with AsyncBoth for the most recent grab.	1887	Calls XAllowEvents with AsyncBoth for the most recent grab.
1729		1888
…		…
1736	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1895	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1737	recent grab.	1896	recent grab.
1738		1897
1739	=item $term->ungrab	1898	=item $term->ungrab
1740		1899
1741	Calls XUngrab for the most recent grab. Is called automatically on	1900	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	1901	evaluation errors, as it is better to lose the grab in the error case as
1743	the session.	1902	the session.
1744		1903
1745	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1904	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1746		1905
…		…
1748		1907
1749	=item @atoms = $term->XListProperties ($window)	1908	=item @atoms = $term->XListProperties ($window)
1750		1909
1751	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1910	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1752		1911
1753	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1912	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1754		1913
1755	=item $term->XDeleteProperty ($window, $property)	1914	=item $term->XDeleteProperty ($window, $property)
1756		1915
1757	=item $window = $term->DefaultRootWindow	1916	=item $window = $term->DefaultRootWindow
1758		1917
…		…
1768		1927
1769	=item $term->XChangeInput ($window, $add_events[, $del_events])	1928	=item $term->XChangeInput ($window, $add_events[, $del_events])
1770		1929
1771	Various X or X-related functions. The C<$term> object only serves as	1930	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	1931	the source of the display, otherwise those functions map more-or-less
1773	directory onto the X functions of the same name.	1932	directly onto the X functions of the same name.
1774		1933
1775	=back	1934	=back
1776		1935
1777	=cut	1936	=cut
1778		1937
…		…
1880	my $env = $self->{term}->env;	2039	my $env = $self->{term}->env;
1881	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2040	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1882	delete $env->{LC_ALL};	2041	delete $env->{LC_ALL};
1883	$env->{LC_CTYPE} = $self->{term}->locale;	2042	$env->{LC_CTYPE} = $self->{term}->locale;
1884		2043
1885	urxvt::term->new ($env, "popup",	2044	my $term = urxvt::term->new (
		2045	$env, "popup",
1886	"--perl-lib" => "", "--perl-ext-common" => "",	2046	"--perl-lib" => "", "--perl-ext-common" => "",
1887	"-pty-fd" => -1, "-sl" => 0,	2047	"-pty-fd" => -1, "-sl" => 0,
1888	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2048	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1889	"--transient-for" => $self->{term}->parent,	2049	"--transient-for" => $self->{term}->parent,
1890	"-display" => $self->{term}->display_id,	2050	"-display" => $self->{term}->display_id,
1891	"-pe" => "urxvt-popup")	2051	"-pe" => "urxvt-popup",
1892	or die "unable to create popup window\n";	2052	) or die "unable to create popup window\n";
		2053
		2054	unless (delete $term->{urxvt_popup_init_done}) {
		2055	$term->ungrab;
		2056	$term->destroy;
		2057	die "unable to initialise popup window\n";
		2058	}
1893	}	2059	}
1894		2060
1895	sub DESTROY {	2061	sub DESTROY {
1896	my ($self) = @_;	2062	my ($self) = @_;
1897		2063
…		…
1902	=back	2068	=back
1903		2069
1904	=cut	2070	=cut
1905		2071
1906	package urxvt::watcher;	2072	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		2073
1913	=head2 The C<urxvt::timer> Class	2074	=head2 The C<urxvt::timer> Class
1914		2075
1915	This class implements timer watchers/events. Time is represented as a	2076	This class implements timer watchers/events. Time is represented as a
1916	fractional number of seconds since the epoch. Example:	2077	fractional number of seconds since the epoch. Example:
…		…
1920	->new	2081	->new
1921	->interval (1)	2082	->interval (1)
1922	->cb (sub {	2083	->cb (sub {
1923	$term->{overlay}->set (0, 0,	2084	$term->{overlay}->set (0, 0,
1924	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2085	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1925	});	2086	});
1926		2087
1927	=over 4	2088	=over 4
1928		2089
1929	=item $timer = new urxvt::timer	2090	=item $timer = new urxvt::timer
1930		2091
…		…
1933		2094
1934	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2095	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1935		2096
1936	Set the callback to be called when the timer triggers.	2097	Set the callback to be called when the timer triggers.
1937		2098
1938	=item $tstamp = $timer->at
1939
1940	Return the time this watcher will fire next.
1941
1942	=item $timer = $timer->set ($tstamp)	2099	=item $timer = $timer->set ($tstamp[, $interval])
1943		2100
1944	Set the time the event is generated to $tstamp.	2101	Set the time the event is generated to $tstamp (and optionally specifies a
		2102	new $interval).
1945		2103
1946	=item $timer = $timer->interval ($interval)	2104	=item $timer = $timer->interval ($interval)
1947		2105
1948	Normally (and when C<$interval> is C<0>), the timer will automatically	2106	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	2107	stop after it has fired once. If C<$interval> is non-zero, then the timer
1950	is automatically rescheduled at the given intervals.	2108	is automatically rescheduled at the given intervals.
1951		2109
1952	=item $timer = $timer->start	2110	=item $timer = $timer->start
1953		2111
1954	Start the timer.	2112	Start the timer.
1955		2113
1956	=item $timer = $timer->start ($tstamp)	2114	=item $timer = $timer->start ($tstamp[, $interval])
1957		2115
1958	Set the event trigger time to C<$tstamp> and start the timer.	2116	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2117	also replaces the interval.
1959		2118
1960	=item $timer = $timer->after ($delay)	2119	=item $timer = $timer->after ($delay[, $interval])
1961		2120
1962	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2121	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1963		2122
1964	=item $timer = $timer->stop	2123	=item $timer = $timer->stop
1965		2124
…		…
1973		2132
1974	$term->{socket} = ...	2133	$term->{socket} = ...
1975	$term->{iow} = urxvt::iow	2134	$term->{iow} = urxvt::iow
1976	->new	2135	->new
1977	->fd (fileno $term->{socket})	2136	->fd (fileno $term->{socket})
1978	->events (urxvt::EVENT_READ)	2137	->events (urxvt::EV_READ)
1979	->start	2138	->start
1980	->cb (sub {	2139	->cb (sub {
1981	my ($iow, $revents) = @_;	2140	my ($iow, $revents) = @_;
1982	# $revents must be 1 here, no need to check	2141	# $revents must be 1 here, no need to check
1983	sysread $term->{socket}, my $buf, 8192	2142	sysread $term->{socket}, my $buf, 8192
…		…
1996	Set the callback to be called when io events are triggered. C<$reventmask>	2155	Set the callback to be called when io events are triggered. C<$reventmask>
1997	is a bitset as described in the C<events> method.	2156	is a bitset as described in the C<events> method.
1998		2157
1999	=item $iow = $iow->fd ($fd)	2158	=item $iow = $iow->fd ($fd)
2000		2159
2001	Set the filedescriptor (not handle) to watch.	2160	Set the file descriptor (not handle) to watch.
2002		2161
2003	=item $iow = $iow->events ($eventmask)	2162	=item $iow = $iow->events ($eventmask)
2004		2163
2005	Set the event mask to watch. The only allowed values are	2164	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	2165	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2007	together, or C<urxvt::EVENT_NONE>.	2166	together, or C<urxvt::EV_NONE>.
2008		2167
2009	=item $iow = $iow->start	2168	=item $iow = $iow->start
2010		2169
2011	Start watching for requested events on the given handle.	2170	Start watching for requested events on the given handle.
2012		2171
2013	=item $iow = $iow->stop	2172	=item $iow = $iow->stop
2014		2173
2015	Stop watching for events on the given filehandle.	2174	Stop watching for events on the given file handle.
2016		2175
2017	=back	2176	=back
2018		2177
2019	=head2 The C<urxvt::iw> Class	2178	=head2 The C<urxvt::iw> Class
2020		2179
…		…
2053	->new	2212	->new
2054	->start ($pid)	2213	->start ($pid)
2055	->cb (sub {	2214	->cb (sub {
2056	my ($pw, $exit_status) = @_;	2215	my ($pw, $exit_status) = @_;
2057	...	2216	...
2058	});	2217	});
2059		2218
2060	=over 4	2219	=over 4
2061		2220
2062	=item $pw = new urxvt::pw	2221	=item $pw = new urxvt::pw
2063		2222
…		…
2067		2226
2068	Set the callback to be called when the timer triggers.	2227	Set the callback to be called when the timer triggers.
2069		2228
2070	=item $pw = $timer->start ($pid)	2229	=item $pw = $timer->start ($pid)
2071		2230
2072	Tells the wqtcher to start watching for process C<$pid>.	2231	Tells the watcher to start watching for process C<$pid>.
2073		2232
2074	=item $pw = $pw->stop	2233	=item $pw = $pw->stop
2075		2234
2076	Stop the watcher.	2235	Stop the watcher.
2077		2236
…		…
2090		2249
2091	=item >= 3 - script loading and management	2250	=item >= 3 - script loading and management
2092		2251
2093	=item >=10 - all called hooks	2252	=item >=10 - all called hooks
2094		2253
2095	=item >=11 - hook reutrn values	2254	=item >=11 - hook return values
2096		2255
2097	=back	2256	=back
2098		2257
2099	=head1 AUTHOR	2258	=head1 AUTHOR
2100		2259
2101	Marc Lehmann <pcg@goof.com>	2260	Marc Lehmann <schmorp@schmorp.de>
2102	http://software.schmorp.de/pkg/rxvt-unicode	2261	http://software.schmorp.de/pkg/rxvt-unicode
2103		2262
2104	=cut	2263	=cut
2105		2264
2106	1	2265	1
		2266
		2267	# 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.197 by sf-tpope, Fri Aug 19 23:08:35 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.197 by sf-tpope, Fri Aug 19 23:08:35 2011 UTC