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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.141 by root, Mon Jul 3 19:11:41 2006 UTC vs.
Revision 1.193 by sf-exg, Wed Jun 29 15:30:28 2011 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
62	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
63	...	66	...
64		67
65	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
68	between two vertical bars:	71	between two vertical bars:
69		72
70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
71		74
72	Another example: Programs I use often output "absolute path: " at the	75	Another example: Programs I use often output "absolute path: " at the
…		…
98		101
99	Other extensions can extend this popup menu by pushing a code reference	102	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the	103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.	104	popup is being displayed.
102		105
103	It's sole argument is the popup menu, which can be modified. It should	106	Its sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code	107	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference	108	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as	109	will be called when the toggle changes, with the new boolean value as
107	first argument.	110	first argument.
108		111
109	The following will add an entry C<myoption> that changes	112	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:	113	C<< $self->{myoption} >>:
111		114
112	push @{ $self->{term}{option_popup_hook} }, sub {	115	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};	117	};
115		118
…		…
121		124
122	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.	127	popup is being displayed.
125		128
126	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide wether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
128	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
131		134
132	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:	137	C<a>s:
135		138
136	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
138	: ()	141	: ()
139	};	142	};
140		143
141	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
142		145
…		…
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
154	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
155		164
156	=item readline (enabled by default)	165	=item readline (enabled by default)
157		166
158	A support package that tries to make editing with readline easier. At	167	A support package that tries to make editing with readline easier. At
159	the moment, it reacts to clicking shift-left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
160	move the text cursor to this position. It does so by generating as many	169	move the text cursor to this position. It does so by generating as many
161	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
162	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
163		172
164	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
165		174
166	=over 4	175	=over 4
…		…
214	the message into vi commands to load the file.	223	the message into vi commands to load the file.
215		224
216	=item tabbed	225	=item tabbed
217		226
218	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
219	is, it implements what is commonly refered to as "tabbed terminal". The topmost line	228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
220	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one	229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
221	button per tab.	230	button per tab.
222		231
223	Clicking a button will activate that tab. Pressing B<Shift-Left> and	232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
224	B<Shift-Right> will switch to the tab left or right of the current one,	233	B<Shift-Right> will switch to the tab left or right of the current one,
…		…
234	URxvt.tabbed.tab-bg: <colour-index, default 1>	243	URxvt.tabbed.tab-bg: <colour-index, default 1>
235		244
236	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid	245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
237	indices.	246	indices.
238		247
239	=item mark-urls	248	=item matcher
240		249
241	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
242	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
243	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
244	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
		267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
245		276
246	=item xim-onthespot	277	=item xim-onthespot
247		278
248	This (experimental) perl extension implements OnTheSpot editing. It does	279	This (experimental) perl extension implements OnTheSpot editing. It does
249	not work perfectly, and some input methods don't seem to work well with	280	not work perfectly, and some input methods don't seem to work well with
250	OnTheSpot editing in general, but it seems to work at leats for SCIM and	281	OnTheSpot editing in general, but it seems to work at least for SCIM and
251	kinput2.	282	kinput2.
252		283
253	You enable it by specifying this extension and a preedit style of	284	You enable it by specifying this extension and a preedit style of
254	C<OnTheSpot>, i.e.:	285	C<OnTheSpot>, i.e.:
255		286
256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
257		288
258	=item automove-background	289	=item kuake<hotkey>
259		290
260	This is basically a very small extension that dynamically changes the	291	A very primitive quake-console-like extension. It was inspired by a
261	background pixmap offset to the window position, in effect creating the	292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
262	same effect as pseudo transparency with a custom pixmap. No scaling is	293	user presses a global accelerator key (by default C<F10>), the terminal
263	supported in this mode. Exmaple:	294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
264		296
265	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
		307
		308	=item overlay-osc
		309
		310	This extension implements some OSC commands to display timed popups on the
		311	screen - useful for status displays from within scripts. You have to read
		312	the sources for more info.
266		313
267	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
268		315
269	A not very useful example of filtering all text output to the terminal	316	A not very useful example of filtering all text output to the terminal
270	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
275	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
276		323
277	=item remote-clipboard	324	=item remote-clipboard
278		325
279	Somewhat of a misnomer, this extension adds two menu entries to the	326	Somewhat of a misnomer, this extension adds two menu entries to the
280	selection popup that allows one ti run external commands to store the	327	selection popup that allows one to run external commands to store the
281	selection somewhere and fetch it again.	328	selection somewhere and fetch it again.
282		329
283	We use it to implement a "distributed selection mechanism", which just	330	We use it to implement a "distributed selection mechanism", which just
284	means that one command uploads the file to a remote server, and another	331	means that one command uploads the file to a remote server, and another
285	reads it.	332	reads it.
…		…
294	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
295	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
296		343
297	=item selection-pastebin	344	=item selection-pastebin
298		345
299	This is a little rarely useful extension that Uploads the selection as	346	This is a little rarely useful extension that uploads the selection as
300	textfile to a remote site (or does other things). (The implementation is	347	textfile to a remote site (or does other things). (The implementation is
301	not currently secure for use in a multiuser environment as it writes to	348	not currently secure for use in a multiuser environment as it writes to
302	F</tmp> directly.).	349	F</tmp> directly.).
303		350
304	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
321	in the C<selection-pastebin-url> resource (again, the % is the placeholder	368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
322	for the filename):	369	for the filename):
323		370
324	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
325		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of whether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
		391
326	=item example-refresh-hooks	392	=item example-refresh-hooks
327		393
328	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
329	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
330	overlays or changes.	396	overlays or changes.
		397
		398	=item confirm-paste
		399
		400	Displays a confirmation dialog when a paste containing at least a full
		401	line is detected.
331		402
332	=back	403	=back
333		404
334	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
335		406
…		…
351		422
352	=over 4	423	=over 4
353		424
354	=item $text	425	=item $text
355		426
356	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
357	always represents one screen cell. See L<ROW_t> for a discussion of this format.	428	always represents one screen cell. See L<ROW_t> for a discussion of this format.
358		429
359	=item $string	430	=item $string
360		431
361	A perl text string, with an emphasis on I<text>. It can store all unicode	432	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
370	=back	441	=back
371		442
372	=head2 Extension Objects	443	=head2 Extension Objects
373		444
374	Every perl extension is a perl class. A separate perl object is created	445	Every perl extension is a perl class. A separate perl object is created
375	for each terminal and each extension and passed as the first parameter to	446	for each terminal, and each terminal has its own set of extension objects,
376	hooks. So extensions can use their C<$self> object without having to think	447	which are passed as the first parameter to hooks. So extensions can use
377	about other extensions, with the exception of methods and members that	448	their C<$self> object without having to think about clashes with other
		449	extensions or other terminals, with the exception of methods and members
378	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
379	use.	451	internal use.
380		452
381	Although it isn't a C<urxvt::term> object, you can call all methods of the	453	Although it isn't a C<urxvt::term> object, you can call all methods of the
382	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
383		455
384	It has the following methods and data members:	456	It has the following methods and data members:
…		…
405	=head2 Hooks	477	=head2 Hooks
406		478
407	The following subroutines can be declared in extension files, and will be	479	The following subroutines can be declared in extension files, and will be
408	called whenever the relevant event happens.	480	called whenever the relevant event happens.
409		481
410	The first argument passed to them is an extension oject as described in	482	The first argument passed to them is an extension object as described in
411	the in the C<Extension Objects> section.	483	the in the C<Extension Objects> section.
412		484
413	B<All> of these hooks must return a boolean value. If any of the called	485	B<All> of these hooks must return a boolean value. If any of the called
414	hooks returns true, then the event counts as being I<consumed>, and the	486	hooks returns true, then the event counts as being I<consumed>, and the
415	relevant action might not be carried out by the C++ code.	487	relevant action might not be carried out by the C++ code.
…		…
428	place.	500	place.
429		501
430	=item on_start $term	502	=item on_start $term
431		503
432	Called at the very end of initialisation of a new terminal, just before	504	Called at the very end of initialisation of a new terminal, just before
433	trying to map (display) the toplevel and returning to the mainloop.	505	trying to map (display) the toplevel and returning to the main loop.
434		506
435	=item on_destroy $term	507	=item on_destroy $term
436		508
437	Called whenever something tries to destroy terminal, when the terminal is	509	Called whenever something tries to destroy terminal, when the terminal is
438	still fully functional (not for long, though).	510	still fully functional (not for long, though).
…		…
465		537
466	Called whenever a selection has been copied, but before the selection is	538	Called whenever a selection has been copied, but before the selection is
467	requested from the server. The selection text can be queried and changed	539	requested from the server. The selection text can be queried and changed
468	by calling C<< $term->selection >>.	540	by calling C<< $term->selection >>.
469		541
470	Returning a true value aborts selection grabbing. It will still be hilighted.	542	Returning a true value aborts selection grabbing. It will still be highlighted.
471		543
472	=item on_sel_extend $term	544	=item on_sel_extend $term
473		545
474	Called whenever the user tries to extend the selection (e.g. with a double	546	Called whenever the user tries to extend the selection (e.g. with a double
475	click) and is either supposed to return false (normal operation), or	547	click) and is either supposed to return false (normal operation), or
476	should extend the selection itelf and return true to suppress the built-in	548	should extend the selection itself and return true to suppress the built-in
477	processing. This can happen multiple times, as long as the callback	549	processing. This can happen multiple times, as long as the callback
478	returns true, it will be called on every further click by the user and is	550	returns true, it will be called on every further click by the user and is
479	supposed to enlarge the selection more and more, if possible.	551	supposed to enlarge the selection more and more, if possible.
480		552
481	See the F<selection> example extension.	553	See the F<selection> example extension.
482		554
483	=item on_view_change $term, $offset	555	=item on_view_change $term, $offset
484		556
485	Called whenever the view offset changes, i..e the user or program	557	Called whenever the view offset changes, i.e. the user or program
486	scrolls. Offset C<0> means display the normal terminal, positive values	558	scrolls. Offset C<0> means display the normal terminal, positive values
487	show this many lines of scrollback.	559	show this many lines of scrollback.
488		560
489	=item on_scroll_back $term, $lines, $saved	561	=item on_scroll_back $term, $lines, $saved
490		562
…		…
494		566
495	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	567	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
496	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	568	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
497	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
498		570
499	=item on_osc_seq $term, $op, $args	571	=item on_osc_seq $term, $op, $args, $resp
500		572
501	Called on every OSC sequence and can be used to suppress it or modify its	573	Called on every OSC sequence and can be used to suppress it or modify its
502	behaviour. The default should be to return an empty list. A true value	574	behaviour. The default should be to return an empty list. A true value
503	suppresses execution of the request completely. Make sure you don't get	575	suppresses execution of the request completely. Make sure you don't get
504	confused by recursive invocations when you output an osc sequence within	576	confused by recursive invocations when you output an OSC sequence within
505	this callback.	577	this callback.
506		578
507	C<on_osc_seq_perl> should be used for new behaviour.	579	C<on_osc_seq_perl> should be used for new behaviour.
508		580
509	=item on_osc_seq_perl $term, $string	581	=item on_osc_seq_perl $term, $args, $resp
510		582
511	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
512	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
513	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
514	string should start with the extension name and a colon, to distinguish	586	string should start with the extension name (sans -osc) and a semicolon,
515	it from commands for other extensions, and this might be enforced in the	587	to distinguish it from commands for other extensions, and this might be
516	future.	588	enforced in the future.
		589
		590	For example, C<overlay-osc> uses this:
		591
		592	sub on_osc_seq_perl {
		593	my ($self, $osc, $resp) = @_;
		594
		595	return unless $osc =~ s/^overlay;//;
		596
		597	... process remaining $osc string
		598	}
517		599
518	Be careful not ever to trust (in a security sense) the data you receive,	600	Be careful not ever to trust (in a security sense) the data you receive,
519	as its source can not easily be controleld (e-mail content, messages from	601	as its source can not easily be controlled (e-mail content, messages from
520	other users on the same system etc.).	602	other users on the same system etc.).
		603
		604	For responses, C<$resp> contains the end-of-args separator used by the
		605	sender.
521		606
522	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
523		608
524	Called whenever text is about to be output, with the text as argument. You	609	Called whenever text is about to be output, with the text as argument. You
525	can filter/change and output the text yourself by returning a true value	610	can filter/change and output the text yourself by returning a true value
…		…
530	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
531		616
532	Called whenever some data is written to the tty/pty and can be used to	617	Called whenever some data is written to the tty/pty and can be used to
533	suppress or filter tty input.	618	suppress or filter tty input.
534		619
		620	=item on_tt_paste $term, $octets
		621
		622	Called whenever text is about to be pasted, with the text as argument. You
		623	can filter/change and paste the text yourself by returning a true value
		624	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		625	locale-encoded.
		626
535	=item on_line_update $term, $row	627	=item on_line_update $term, $row
536		628
537	Called whenever a line was updated or changed. Can be used to filter	629	Called whenever a line was updated or changed. Can be used to filter
538	screen output (e.g. underline urls or other useless stuff). Only lines	630	screen output (e.g. underline urls or other useless stuff). Only lines
539	that are being shown will be filtered, and, due to performance reasons,	631	that are being shown will be filtered, and, due to performance reasons,
…		…
546	later with the already-modified line (e.g. if unrelated parts change), so	638	later with the already-modified line (e.g. if unrelated parts change), so
547	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
548		640
549	=item on_refresh_begin $term	641	=item on_refresh_begin $term
550		642
551	Called just before the screen gets redrawn. Can be used for overlay	643	Called just before the screen gets redrawn. Can be used for overlay or
552	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
553	restoring them in refresh_end. The built-in overlay and selection display	645	restoring them in refresh_end. The built-in overlay and selection display
554	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
555		647
556	=item on_refresh_end $term	648	=item on_refresh_end $term
557		649
558	Called just after the screen gets redrawn. See C<on_refresh_begin>.	650	Called just after the screen gets redrawn. See C<on_refresh_begin>.
559		651
560	=item on_user_command $term, $string	652	=item on_user_command $term, $string
561		653
562	Called whenever the a user-configured event is being activated (e.g. via	654	Called whenever a user-configured event is being activated (e.g. via
563	a C<perl:string> action bound to a key, see description of the B<keysym>	655	a C<perl:string> action bound to a key, see description of the B<keysym>
564	resource in the @@RXVT_NAME@@(1) manpage).	656	resource in the @@RXVT_NAME@@(1) manpage).
565		657
566	The event is simply the action string. This interface is assumed to change	658	The event is simply the action string. This interface is assumed to change
567	slightly in the future.	659	slightly in the future.
568		660
569	=item on_resize_all_windows $tern, $new_width, $new_height	661	=item on_resize_all_windows $term, $new_width, $new_height
570		662
571	Called just after the new window size has been calculcated, but before	663	Called just after the new window size has been calculated, but before
572	windows are actually being resized or hints are being set. If this hook	664	windows are actually being resized or hints are being set. If this hook
573	returns TRUE, setting of the window hints is being skipped.	665	returns TRUE, setting of the window hints is being skipped.
574		666
575	=item on_x_event $term, $event	667	=item on_x_event $term, $event
576		668
577	Called on every X event received on the vt window (and possibly other	669	Called on every X event received on the vt window (and possibly other
578	windows). Should only be used as a last resort. Most event structure	670	windows). Should only be used as a last resort. Most event structure
579	members are not passed.	671	members are not passed.
580		672
		673	=item on_root_event $term, $event
		674
		675	Like C<on_x_event>, but is called for events on the root window.
		676
581	=item on_focus_in $term	677	=item on_focus_in $term
582		678
583	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
584	does focus in processing.	680	does focus in processing.
585		681
586	=item on_focus_out $term	682	=item on_focus_out $term
587		683
588	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
589	focus out processing.	685	focus out processing.
590		686
591	=item on_configure_notify $term, $event	687	=item on_configure_notify $term, $event
592		688
593	=item on_property_notify $term, $event	689	=item on_property_notify $term, $event
…		…
604		700
605	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
606		702
607	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
608		704
609	Called whenever the corresponding X event is received for the terminal If	705	Called whenever the corresponding X event is received for the terminal. If
610	the hook returns true, then the even will be ignored by rxvt-unicode.	706	the hook returns true, then the event will be ignored by rxvt-unicode.
611		707
612	The event is a hash with most values as named by Xlib (see the XEvent	708	The event is a hash with most values as named by Xlib (see the XEvent
613	manpage), with the additional members C<row> and C<col>, which are the	709	manpage), with the additional members C<row> and C<col>, which are the
614	(real, not screen-based) row and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
615		711
…		…
624		720
625	=item on_wm_delete_window $term, $event	721	=item on_wm_delete_window $term, $event
626		722
627	Called when various types of ClientMessage events are received (all with	723	Called when various types of ClientMessage events are received (all with
628	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	724	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		725
		726	=item on_bell $term
		727
		728	Called on receipt of a bell character.
629		729
630	=back	730	=back
631		731
632	=cut	732	=cut
633		733
…		…
676	The current terminal. This variable stores the current C<urxvt::term>	776	The current terminal. This variable stores the current C<urxvt::term>
677	object, whenever a callback/hook is executing.	777	object, whenever a callback/hook is executing.
678		778
679	=item @urxvt::TERM_INIT	779	=item @urxvt::TERM_INIT
680		780
681	All coderefs in this array will be called as methods of the next newly	781	All code references in this array will be called as methods of the next newly
682	created C<urxvt::term> object (during the C<on_init> phase). The array	782	created C<urxvt::term> object (during the C<on_init> phase). The array
683	gets cleared before the codereferences that were in it are being executed,	783	gets cleared before the code references that were in it are being executed,
684	so coderefs can push themselves onto it again if they so desire.	784	so references can push themselves onto it again if they so desire.
685		785
686	This complements to the perl-eval commandline option, but gets executed	786	This complements to the perl-eval command line option, but gets executed
687	first.	787	first.
688		788
689	=item @urxvt::TERM_EXT	789	=item @urxvt::TERM_EXT
690		790
691	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	791	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
698		798
699	=over 4	799	=over 4
700		800
701	=item urxvt::fatal $errormessage	801	=item urxvt::fatal $errormessage
702		802
703	Fatally aborts execution with the given error message. Avoid at all	803	Fatally aborts execution with the given error message (which should
704	costs! The only time this is acceptable is when the terminal process	804	include a trailing newline). Avoid at all costs! The only time this
705	starts up.	805	is acceptable (and useful) is in the init hook, where it prevents the
		806	terminal from starting up.
706		807
707	=item urxvt::warn $string	808	=item urxvt::warn $string
708		809
709	Calls C<rxvt_warn> with the given string which should not include a	810	Calls C<rxvt_warn> with the given string which should include a trailing
710	newline. The module also overwrites the C<warn> builtin with a function	811	newline. The module also overwrites the C<warn> builtin with a function
711	that calls this function.	812	that calls this function.
712		813
713	Using this function has the advantage that its output ends up in the	814	Using this function has the advantage that its output ends up in the
714	correct place, e.g. on stderr of the connecting urxvtc client.	815	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
716	Messages have a size limit of 1023 bytes currently.	817	Messages have a size limit of 1023 bytes currently.
717		818
718	=item @terms = urxvt::termlist	819	=item @terms = urxvt::termlist
719		820
720	Returns all urxvt::term objects that exist in this process, regardless of	821	Returns all urxvt::term objects that exist in this process, regardless of
721	wether they are started, being destroyed etc., so be careful. Only term	822	whether they are started, being destroyed etc., so be careful. Only term
722	objects that have perl extensions attached will be returned (because there	823	objects that have perl extensions attached will be returned (because there
723	is no urxvt::term objet associated with others).	824	is no urxvt::term object associated with others).
724		825
725	=item $time = urxvt::NOW	826	=item $time = urxvt::NOW
726		827
727	Returns the "current time" (as per the event loop).	828	Returns the "current time" (as per the event loop).
728		829
…		…
771		872
772	=item $rend = urxvt::OVERLAY_RSTYLE	873	=item $rend = urxvt::OVERLAY_RSTYLE
773		874
774	Return the rendition mask used for overlays by default.	875	Return the rendition mask used for overlays by default.
775		876
776	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	877	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		878	urxvt::RS_RVid, urxvt::RS_Uline
777		879
778	Return the bit that enabled bold, italic, blink, reverse-video and	880	Return the bit that enabled bold, italic, blink, reverse-video and
779	underline, respectively. To enable such a style, just logically OR it into	881	underline, respectively. To enable such a style, just logically OR it into
780	the bitset.	882	the bitset.
781		883
…		…
864	local $TERM = shift;	966	local $TERM = shift;
865	my $htype = shift;	967	my $htype = shift;
866		968
867	if ($htype == 0) { # INIT	969	if ($htype == 0) { # INIT
868	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	970	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
869		971
870	my %ext_arg;	972	my %ext_arg;
871		973
872	{	974	{
873	my @init = @TERM_INIT;	975	my @init = @TERM_INIT;
874	@TERM_INIT = ();	976	@TERM_INIT = ();
…		…
937		1039
938	sub SET_COLOR($$$) {	1040	sub SET_COLOR($$$) {
939	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1041	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
940	}	1042	}
941		1043
		1044	sub rend2mask {
		1045	no strict 'refs';
		1046	my ($str, $mask) = (@_, 0);
		1047	my %color = ( fg => undef, bg => undef );
		1048	my @failed;
		1049	for my $spec ( split /\s+/, $str ) {
		1050	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1051	$color{lc($1)} = $2;
		1052	} else {
		1053	my $neg = $spec =~ s/^[-^]//;
		1054	unless ( exists &{"RS_$spec"} ) {
		1055	push @failed, $spec;
		1056	next;
		1057	}
		1058	my $cur = &{"RS_$spec"};
		1059	if ( $neg ) {
		1060	$mask &= ~$cur;
		1061	} else {
		1062	$mask \|= $cur;
		1063	}
		1064	}
		1065	}
		1066	($mask, @color{qw(fg bg)}, \@failed)
		1067	}
		1068
942	# urxvt::term::extension	1069	# urxvt::term::extension
943		1070
944	package urxvt::term::extension;	1071	package urxvt::term::extension;
945		1072
946	sub enable {	1073	sub enable {
…		…
1015	is that you cannot use blocking APIs, but the non-blocking variant should	1142	is that you cannot use blocking APIs, but the non-blocking variant should
1016	work.	1143	work.
1017		1144
1018	=cut	1145	=cut
1019		1146
1020	our $VERSION = 1;	1147	our $VERSION = '5.23';
1021		1148
1022	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1149	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1023	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1150	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1024		1151
1025	sub timer {	1152	sub timer {
…		…
1027		1154
1028	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
1029		1156
1030	urxvt::timer	1157	urxvt::timer
1031	->new	1158	->new
1032	->start (urxvt::NOW + $arg{after})	1159	->after ($arg{after}, $arg{interval})
1033	->cb (sub {	1160	->cb ($arg{interval} ? $cb : sub {
1034	$_[0]->stop; # need to cancel manually	1161	$_[0]->stop; # need to cancel manually
1035	$cb->();	1162	$cb->();
1036	})	1163	})
1037	}	1164	}
1038		1165
1039	sub io {	1166	sub io {
1040	my ($class, %arg) = @_;	1167	my ($class, %arg) = @_;
1041		1168
1042	my $cb = $arg{cb};	1169	my $cb = $arg{cb};
		1170	my $fd = fileno $arg{fh};
		1171	defined $fd or $fd = $arg{fh};
1043		1172
1044	bless [$arg{fh}, urxvt::iow	1173	bless [$arg{fh}, urxvt::iow
1045	->new	1174	->new
1046	->fd (fileno $arg{fh})	1175	->fd ($fd)
1047	->events (($arg{poll} =~ /r/ ? 1 : 0)	1176	->events (($arg{poll} =~ /r/ ? 1 : 0)
1048	\| ($arg{poll} =~ /w/ ? 2 : 0))	1177	\| ($arg{poll} =~ /w/ ? 2 : 0))
1049	->start	1178	->start
1050	->cb (sub {	1179	->cb ($cb)
1051	$cb->(($_[1] & 1 ? 'r' : '')
1052	. ($_[1] & 2 ? 'w' : ''));
1053	})],
1054	urxvt::anyevent::	1180	], urxvt::anyevent::
		1181	}
		1182
		1183	sub idle {
		1184	my ($class, %arg) = @_;
		1185
		1186	my $cb = $arg{cb};
		1187
		1188	urxvt::iw
		1189	->new
		1190	->start
		1191	->cb ($cb)
		1192	}
		1193
		1194	sub child {
		1195	my ($class, %arg) = @_;
		1196
		1197	my $cb = $arg{cb};
		1198
		1199	urxvt::pw
		1200	->new
		1201	->start ($arg{pid})
		1202	->cb (sub {
		1203	$_[0]->stop; # need to cancel manually
		1204	$cb->($_[0]->rpid, $_[0]->rstatus);
		1205	})
1055	}	1206	}
1056		1207
1057	sub DESTROY {	1208	sub DESTROY {
1058	$_[0][1]->stop;	1209	$_[0][1]->stop;
1059	}	1210	}
1060		1211
1061	sub condvar {	1212	sub one_event {
1062	bless \my $flag, urxvt::anyevent::condvar::
1063	}
1064
1065	sub urxvt::anyevent::condvar::broadcast {
1066	${$_[0]}++;
1067	}
1068
1069	sub urxvt::anyevent::condvar::wait {
1070	unless (${$_[0]}) {
1071	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1213	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1072	}
1073	}	1214	}
1074		1215
1075	package urxvt::term;	1216	package urxvt::term;
1076		1217
1077	=head2 The C<urxvt::term> Class	1218	=head2 The C<urxvt::term> Class
…		…
1164		1305
1165	Returns true if the option specified by C<$optval> is enabled, and	1306	Returns true if the option specified by C<$optval> is enabled, and
1166	optionally change it. All option values are stored by name in the hash	1307	optionally change it. All option values are stored by name in the hash
1167	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1308	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1168		1309
1169	Here is a a likely non-exhaustive list of option names, please see the	1310	Here is a likely non-exhaustive list of option names, please see the
1170	source file F</src/optinc.h> to see the actual list:	1311	source file F</src/optinc.h> to see the actual list:
1171		1312
1172	borderLess console cursorBlink cursorUnderline hold iconic insecure	1313	borderLess console cursorBlink cursorUnderline hold iconic insecure
1173	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1314	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1174	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1315	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1191	likely change).	1332	likely change).
1192		1333
1193	Please note that resource strings will currently only be freed when the	1334	Please note that resource strings will currently only be freed when the
1194	terminal is destroyed, so changing options frequently will eat memory.	1335	terminal is destroyed, so changing options frequently will eat memory.
1195		1336
1196	Here is a a likely non-exhaustive list of resource names, not all of which	1337	Here is a likely non-exhaustive list of resource names, not all of which
1197	are supported in every build, please see the source file F</src/rsinc.h>	1338	are supported in every build, please see the source file F</src/rsinc.h>
1198	to see the actual list:	1339	to see the actual list:
1199		1340
1200	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1341	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1201	borderLess color cursorBlink cursorUnderline cutchars delete_key	1342	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1202	display_name embed ext_bwidth fade font geometry hold iconName	1343	display_name embed ext_bwidth fade font geometry hold iconName
1203	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1344	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1204	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1345	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1205	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1346	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1206	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1347	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1207	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1348	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1208	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1349	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1209	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1350	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1210	secondaryScreen secondaryScroll selectstyle shade term_name title	1351	secondaryScreen secondaryScroll shade term_name title
1211	transient_for transparent transparent_all tripleclickwords utmpInhibit	1352	transient_for transparent transparent_all tripleclickwords utmpInhibit
1212	visualBell	1353	visualBell
1213		1354
1214	=cut	1355	=cut
1215		1356
1216	sub resource($$;$) {	1357	sub resource($$;$) {
1217	my ($self, $name) = (shift, shift);	1358	my ($self, $name) = (shift, shift);
1218	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1359	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1219	&urxvt::term::_resource	1360	goto &urxvt::term::_resource
1220	}	1361	}
1221		1362
1222	=item $value = $term->x_resource ($pattern)	1363	=item $value = $term->x_resource ($pattern)
1223		1364
1224	Returns the X-Resource for the given pattern, excluding the program or	1365	Returns the X-Resource for the given pattern, excluding the program or
…		…
1249		1390
1250	=item ($row, $col) = $term->selection_beg ([$row, $col])	1391	=item ($row, $col) = $term->selection_beg ([$row, $col])
1251		1392
1252	=item ($row, $col) = $term->selection_end ([$row, $col])	1393	=item ($row, $col) = $term->selection_end ([$row, $col])
1253		1394
1254	Return the current values of the selection mark, begin or end positions,	1395	Return the current values of the selection mark, begin or end positions.
1255	and optionally set them to new values.	1396
		1397	When arguments are given, then the selection coordinates are set to
		1398	C<$row> and C<$col>, and the selection screen is set to the current
		1399	screen.
		1400
		1401	=item $screen = $term->selection_screen ([$screen])
		1402
		1403	Returns the current selection screen, and then optionally sets it.
1256		1404
1257	=item $term->selection_make ($eventtime[, $rectangular])	1405	=item $term->selection_make ($eventtime[, $rectangular])
1258		1406
1259	Tries to make a selection as set by C<selection_beg> and	1407	Tries to make a selection as set by C<selection_beg> and
1260	C<selection_end>. If C<$rectangular> is true (default: false), a	1408	C<selection_end>. If C<$rectangular> is true (default: false), a
1261	rectangular selection will be made. This is the prefered function to make	1409	rectangular selection will be made. This is the preferred function to make
1262	a selection.	1410	a selection.
1263		1411
1264	=item $success = $term->selection_grab ($eventtime)	1412	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1265		1413
1266	Try to request the primary selection text from the server (for example, as	1414	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1415	true) selection from the server. The corresponding text can be set
1267	set by the next method). No visual feedback will be given. This function	1416	with the next method. No visual feedback will be given. This function
1268	is mostly useful from within C<on_sel_grab> hooks.	1417	is mostly useful from within C<on_sel_grab> hooks.
1269		1418
1270	=item $oldtext = $term->selection ([$newtext])	1419	=item $oldtext = $term->selection ([$newtext, $clipboard])
1271		1420
1272	Return the current selection text and optionally replace it by C<$newtext>.	1421	Return the current selection (clipboard if C<$clipboard> is true) text
		1422	and optionally replace it by C<$newtext>.
		1423
		1424	=item $term->selection_clear ([$clipboard])
		1425
		1426	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1273		1427
1274	=item $term->overlay_simple ($x, $y, $text)	1428	=item $term->overlay_simple ($x, $y, $text)
1275		1429
1276	Create a simple multi-line overlay box. See the next method for details.	1430	Create a simple multi-line overlay box. See the next method for details.
1277		1431
…		…
1307		1461
1308	The methods currently supported on C<urxvt::overlay> objects are:	1462	The methods currently supported on C<urxvt::overlay> objects are:
1309		1463
1310	=over 4	1464	=over 4
1311		1465
1312	=item $overlay->set ($x, $y, $text, $rend)	1466	=item $overlay->set ($x, $y, $text[, $rend])
1313		1467
1314	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1468	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1315	text in rxvt-unicode's special encoding and an array of rendition values	1469	text in rxvt-unicode's special encoding and an array of rendition values
1316	at a specific position inside the overlay.	1470	at a specific position inside the overlay.
		1471
		1472	If C<$rend> is missing, then the rendition will not be changed.
1317		1473
1318	=item $overlay->hide	1474	=item $overlay->hide
1319		1475
1320	If visible, hide the overlay, but do not destroy it.	1476	If visible, hide the overlay, but do not destroy it.
1321		1477
…		…
1403	locale-specific encoding of the terminal and can contain command sequences	1559	locale-specific encoding of the terminal and can contain command sequences
1404	(escape codes) that will be interpreted.	1560	(escape codes) that will be interpreted.
1405		1561
1406	=item $term->tt_write ($octets)	1562	=item $term->tt_write ($octets)
1407		1563
1408	Write the octets given in C<$data> to the tty (i.e. as program input). To	1564	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1409	pass characters instead of octets, you should convert your strings first	1565	pass characters instead of octets, you should convert your strings first
1410	to the locale-specific encoding using C<< $term->locale_encode >>.	1566	to the locale-specific encoding using C<< $term->locale_encode >>.
		1567
		1568	=item $term->tt_paste ($octets)
		1569
		1570	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1571	CR and bracketing the data with control sequences if bracketed paste mode
		1572	is set.
1411		1573
1412	=item $old_events = $term->pty_ev_events ([$new_events])	1574	=item $old_events = $term->pty_ev_events ([$new_events])
1413		1575
1414	Replaces the event mask of the pty watcher by the given event mask. Can	1576	Replaces the event mask of the pty watcher by the given event mask. Can
1415	be used to suppress input and output handling to the pty/tty. See the	1577	be used to suppress input and output handling to the pty/tty. See the
…		…
1513		1675
1514	Returns the currently displayed screen (0 primary, 1 secondary).	1676	Returns the currently displayed screen (0 primary, 1 secondary).
1515		1677
1516	=item $cursor_is_hidden = $term->hidden_cursor	1678	=item $cursor_is_hidden = $term->hidden_cursor
1517		1679
1518	Returns wether the cursor is currently hidden or not.	1680	Returns whether the cursor is currently hidden or not.
1519		1681
1520	=item $view_start = $term->view_start ([$newvalue])	1682	=item $view_start = $term->view_start ([$newvalue])
1521		1683
1522	Returns the row number of the topmost displayed line. Maximum value is	1684	Returns the row number of the topmost displayed line. Maximum value is
1523	C<0>, which displays the normal terminal contents. Lower values scroll	1685	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1531		1693
1532	Used after changing terminal contents to display them.	1694	Used after changing terminal contents to display them.
1533		1695
1534	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1696	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1535		1697
1536	Returns the text of the entire row with number C<$row_number>. Row C<0>	1698	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1537	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1699	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1538	terminal line. The scrollback buffer starts at line C<-1> and extends to
1539	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1700	terminal line. Nothing will be returned if a nonexistent line
1540	is requested.	1701	is requested.
1541		1702
1542	If C<$new_text> is specified, it will replace characters in the current	1703	If C<$new_text> is specified, it will replace characters in the current
1543	line, starting at column C<$start_col> (default C<0>), which is useful	1704	line, starting at column C<$start_col> (default C<0>), which is useful
1544	to replace only parts of a line. The font index in the rendition will	1705	to replace only parts of a line. The font index in the rendition will
1545	automatically be updated.	1706	automatically be updated.
1546		1707
1547	C<$text> is in a special encoding: tabs and wide characters that use more	1708	C<$text> is in a special encoding: tabs and wide characters that use more
1548	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1709	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1549	characters. Characters with combining characters and other characters that	1710	characters. Characters with combining characters and other characters that
1550	do not fit into the normal tetx encoding will be replaced with characters	1711	do not fit into the normal text encoding will be replaced with characters
1551	in the private use area.	1712	in the private use area.
1552		1713
1553	You have to obey this encoding when changing text. The advantage is	1714	You have to obey this encoding when changing text. The advantage is
1554	that C<substr> and similar functions work on screen cells and not on	1715	that C<substr> and similar functions work on screen cells and not on
1555	characters.	1716	characters.
…		…
1700	where one character corresponds to one screen cell. See	1861	where one character corresponds to one screen cell. See
1701	C<< $term->ROW_t >> for details.	1862	C<< $term->ROW_t >> for details.
1702		1863
1703	=item $string = $term->special_decode $text	1864	=item $string = $term->special_decode $text
1704		1865
1705	Converts rxvt-unicodes text reprsentation into a perl string. See	1866	Converts rxvt-unicodes text representation into a perl string. See
1706	C<< $term->ROW_t >> for details.	1867	C<< $term->ROW_t >> for details.
1707		1868
1708	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1869	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1709		1870
1710	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1871	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1713	manpage.	1874	manpage.
1714		1875
1715	=item $success = $term->grab ($eventtime[, $sync])	1876	=item $success = $term->grab ($eventtime[, $sync])
1716		1877
1717	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1878	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1718	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1879	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1719		1880
1720	=item $term->allow_events_async	1881	=item $term->allow_events_async
1721		1882
1722	Calls XAllowEvents with AsyncBoth for the most recent grab.	1883	Calls XAllowEvents with AsyncBoth for the most recent grab.
1723		1884
…		…
1730	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1891	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1731	recent grab.	1892	recent grab.
1732		1893
1733	=item $term->ungrab	1894	=item $term->ungrab
1734		1895
1735	Calls XUngrab for the most recent grab. Is called automatically on	1896	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1736	evaluation errors, as it is better to lose the grab in the error case as	1897	evaluation errors, as it is better to lose the grab in the error case as
1737	the session.	1898	the session.
1738		1899
1739	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1900	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1740		1901
…		…
1742		1903
1743	=item @atoms = $term->XListProperties ($window)	1904	=item @atoms = $term->XListProperties ($window)
1744		1905
1745	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1906	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1746		1907
1747	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1908	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1748		1909
1749	=item $term->XDeleteProperty ($window, $property)	1910	=item $term->XDeleteProperty ($window, $property)
1750		1911
1751	=item $window = $term->DefaultRootWindow	1912	=item $window = $term->DefaultRootWindow
1752		1913
…		…
1762		1923
1763	=item $term->XChangeInput ($window, $add_events[, $del_events])	1924	=item $term->XChangeInput ($window, $add_events[, $del_events])
1764		1925
1765	Various X or X-related functions. The C<$term> object only serves as	1926	Various X or X-related functions. The C<$term> object only serves as
1766	the source of the display, otherwise those functions map more-or-less	1927	the source of the display, otherwise those functions map more-or-less
1767	directory onto the X functions of the same name.	1928	directly onto the X functions of the same name.
1768		1929
1769	=back	1930	=back
1770		1931
1771	=cut	1932	=cut
1772		1933
…		…
1874	my $env = $self->{term}->env;	2035	my $env = $self->{term}->env;
1875	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2036	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1876	delete $env->{LC_ALL};	2037	delete $env->{LC_ALL};
1877	$env->{LC_CTYPE} = $self->{term}->locale;	2038	$env->{LC_CTYPE} = $self->{term}->locale;
1878		2039
1879	urxvt::term->new ($env, "popup",	2040	my $term = urxvt::term->new (
		2041	$env, "popup",
1880	"--perl-lib" => "", "--perl-ext-common" => "",	2042	"--perl-lib" => "", "--perl-ext-common" => "",
1881	"-pty-fd" => -1, "-sl" => 0,	2043	"-pty-fd" => -1, "-sl" => 0,
1882	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2044	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1883	"--transient-for" => $self->{term}->parent,	2045	"--transient-for" => $self->{term}->parent,
1884	"-display" => $self->{term}->display_id,	2046	"-display" => $self->{term}->display_id,
1885	"-pe" => "urxvt-popup")	2047	"-pe" => "urxvt-popup",
1886	or die "unable to create popup window\n";	2048	) or die "unable to create popup window\n";
		2049
		2050	unless (delete $term->{urxvt_popup_init_done}) {
		2051	$term->ungrab;
		2052	$term->destroy;
		2053	die "unable to initialise popup window\n";
		2054	}
1887	}	2055	}
1888		2056
1889	sub DESTROY {	2057	sub DESTROY {
1890	my ($self) = @_;	2058	my ($self) = @_;
1891		2059
…		…
1896	=back	2064	=back
1897		2065
1898	=cut	2066	=cut
1899		2067
1900	package urxvt::watcher;	2068	package urxvt::watcher;
1901
1902	@urxvt::timer::ISA = __PACKAGE__;
1903	@urxvt::iow::ISA = __PACKAGE__;
1904	@urxvt::pw::ISA = __PACKAGE__;
1905	@urxvt::iw::ISA = __PACKAGE__;
1906		2069
1907	=head2 The C<urxvt::timer> Class	2070	=head2 The C<urxvt::timer> Class
1908		2071
1909	This class implements timer watchers/events. Time is represented as a	2072	This class implements timer watchers/events. Time is represented as a
1910	fractional number of seconds since the epoch. Example:	2073	fractional number of seconds since the epoch. Example:
…		…
1914	->new	2077	->new
1915	->interval (1)	2078	->interval (1)
1916	->cb (sub {	2079	->cb (sub {
1917	$term->{overlay}->set (0, 0,	2080	$term->{overlay}->set (0, 0,
1918	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2081	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1919	});	2082	});
1920		2083
1921	=over 4	2084	=over 4
1922		2085
1923	=item $timer = new urxvt::timer	2086	=item $timer = new urxvt::timer
1924		2087
…		…
1927		2090
1928	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2091	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1929		2092
1930	Set the callback to be called when the timer triggers.	2093	Set the callback to be called when the timer triggers.
1931		2094
1932	=item $tstamp = $timer->at
1933
1934	Return the time this watcher will fire next.
1935
1936	=item $timer = $timer->set ($tstamp)	2095	=item $timer = $timer->set ($tstamp[, $interval])
1937		2096
1938	Set the time the event is generated to $tstamp.	2097	Set the time the event is generated to $tstamp (and optionally specifies a
		2098	new $interval).
1939		2099
1940	=item $timer = $timer->interval ($interval)	2100	=item $timer = $timer->interval ($interval)
1941		2101
1942	Normally (and when C<$interval> is C<0>), the timer will automatically	2102	By default (and when C<$interval> is C<0>), the timer will automatically
1943	stop after it has fired once. If C<$interval> is non-zero, then the timer	2103	stop after it has fired once. If C<$interval> is non-zero, then the timer
1944	is automatically rescheduled at the given intervals.	2104	is automatically rescheduled at the given intervals.
1945		2105
1946	=item $timer = $timer->start	2106	=item $timer = $timer->start
1947		2107
1948	Start the timer.	2108	Start the timer.
1949		2109
1950	=item $timer = $timer->start ($tstamp)	2110	=item $timer = $timer->start ($tstamp[, $interval])
1951		2111
1952	Set the event trigger time to C<$tstamp> and start the timer.	2112	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2113	also replaces the interval.
1953		2114
1954	=item $timer = $timer->after ($delay)	2115	=item $timer = $timer->after ($delay[, $interval])
1955		2116
1956	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2117	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1957		2118
1958	=item $timer = $timer->stop	2119	=item $timer = $timer->stop
1959		2120
…		…
1967		2128
1968	$term->{socket} = ...	2129	$term->{socket} = ...
1969	$term->{iow} = urxvt::iow	2130	$term->{iow} = urxvt::iow
1970	->new	2131	->new
1971	->fd (fileno $term->{socket})	2132	->fd (fileno $term->{socket})
1972	->events (urxvt::EVENT_READ)	2133	->events (urxvt::EV_READ)
1973	->start	2134	->start
1974	->cb (sub {	2135	->cb (sub {
1975	my ($iow, $revents) = @_;	2136	my ($iow, $revents) = @_;
1976	# $revents must be 1 here, no need to check	2137	# $revents must be 1 here, no need to check
1977	sysread $term->{socket}, my $buf, 8192	2138	sysread $term->{socket}, my $buf, 8192
…		…
1990	Set the callback to be called when io events are triggered. C<$reventmask>	2151	Set the callback to be called when io events are triggered. C<$reventmask>
1991	is a bitset as described in the C<events> method.	2152	is a bitset as described in the C<events> method.
1992		2153
1993	=item $iow = $iow->fd ($fd)	2154	=item $iow = $iow->fd ($fd)
1994		2155
1995	Set the filedescriptor (not handle) to watch.	2156	Set the file descriptor (not handle) to watch.
1996		2157
1997	=item $iow = $iow->events ($eventmask)	2158	=item $iow = $iow->events ($eventmask)
1998		2159
1999	Set the event mask to watch. The only allowed values are	2160	Set the event mask to watch. The only allowed values are
2000	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2161	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2001	together, or C<urxvt::EVENT_NONE>.	2162	together, or C<urxvt::EV_NONE>.
2002		2163
2003	=item $iow = $iow->start	2164	=item $iow = $iow->start
2004		2165
2005	Start watching for requested events on the given handle.	2166	Start watching for requested events on the given handle.
2006		2167
2007	=item $iow = $iow->stop	2168	=item $iow = $iow->stop
2008		2169
2009	Stop watching for events on the given filehandle.	2170	Stop watching for events on the given file handle.
2010		2171
2011	=back	2172	=back
2012		2173
2013	=head2 The C<urxvt::iw> Class	2174	=head2 The C<urxvt::iw> Class
2014		2175
…		…
2047	->new	2208	->new
2048	->start ($pid)	2209	->start ($pid)
2049	->cb (sub {	2210	->cb (sub {
2050	my ($pw, $exit_status) = @_;	2211	my ($pw, $exit_status) = @_;
2051	...	2212	...
2052	});	2213	});
2053		2214
2054	=over 4	2215	=over 4
2055		2216
2056	=item $pw = new urxvt::pw	2217	=item $pw = new urxvt::pw
2057		2218
…		…
2061		2222
2062	Set the callback to be called when the timer triggers.	2223	Set the callback to be called when the timer triggers.
2063		2224
2064	=item $pw = $timer->start ($pid)	2225	=item $pw = $timer->start ($pid)
2065		2226
2066	Tells the wqtcher to start watching for process C<$pid>.	2227	Tells the watcher to start watching for process C<$pid>.
2067		2228
2068	=item $pw = $pw->stop	2229	=item $pw = $pw->stop
2069		2230
2070	Stop the watcher.	2231	Stop the watcher.
2071		2232
…		…
2084		2245
2085	=item >= 3 - script loading and management	2246	=item >= 3 - script loading and management
2086		2247
2087	=item >=10 - all called hooks	2248	=item >=10 - all called hooks
2088		2249
2089	=item >=11 - hook reutrn values	2250	=item >=11 - hook return values
2090		2251
2091	=back	2252	=back
2092		2253
2093	=head1 AUTHOR	2254	=head1 AUTHOR
2094		2255
2095	Marc Lehmann <pcg@goof.com>	2256	Marc Lehmann <schmorp@schmorp.de>
2096	http://software.schmorp.de/pkg/rxvt-unicode	2257	http://software.schmorp.de/pkg/rxvt-unicode
2097		2258
2098	=cut	2259	=cut
2099		2260
2100	1	2261	1
		2262
		2263	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.141 by root, Mon Jul 3 19:11:41 2006 UTC vs. Revision 1.193 by sf-exg, Wed Jun 29 15:30:28 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.141 by root, Mon Jul 3 19:11:41 2006 UTC vs.
Revision 1.193 by sf-exg, Wed Jun 29 15:30:28 2011 UTC