[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.194 by sf-exg, Wed Jun 29 21:59:36 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 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
251		276
252	=item xim-onthespot	277	=item xim-onthespot
253		278
254	This (experimental) perl extension implements OnTheSpot editing. It does	279	This (experimental) perl extension implements OnTheSpot editing. It does
255	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
256	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
257	kinput2.	282	kinput2.
258		283
259	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
260	C<OnTheSpot>, i.e.:	285	C<OnTheSpot>, i.e.:
261		286
262	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
263		288
264	=item automove-background	289	=item kuake<hotkey>
265		290
266	This is basically a very small extension that dynamically changes the	291	A very primitive quake-console-like extension. It was inspired by a
267	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
268	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
269	supported in this mode. Exmaple:	294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
270		296
271	@@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.
272		313
273	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
274		315
275	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
276	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
…		…
281	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
282		323
283	=item remote-clipboard	324	=item remote-clipboard
284		325
285	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
286	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
287	selection somewhere and fetch it again.	328	selection somewhere and fetch it again.
288		329
289	We use it to implement a "distributed selection mechanism", which just	330	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	331	means that one command uploads the file to a remote server, and another
291	reads it.	332	reads it.
…		…
300	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
301	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
302		343
303	=item selection-pastebin	344	=item selection-pastebin
304		345
305	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
306	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
307	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
308	F</tmp> directly.).	349	F</tmp> directly.).
309		350
310	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
327	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
328	for the filename):	369	for the filename):
329		370
330	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
331		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
332	=item example-refresh-hooks	392	=item example-refresh-hooks
333		393
334	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
335	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
336	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.
337		402
338	=back	403	=back
339		404
340	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
341		406
…		…
357		422
358	=over 4	423	=over 4
359		424
360	=item $text	425	=item $text
361		426
362	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	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.	428	always represents one screen cell. See L<ROW_t> for a discussion of this format.
364		429
365	=item $string	430	=item $string
366		431
367	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
…		…
376	=back	441	=back
377		442
378	=head2 Extension Objects	443	=head2 Extension Objects
379		444
380	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
381	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,
382	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
383	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
384	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
385	use.	451	internal use.
386		452
387	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
388	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
389		455
390	It has the following methods and data members:	456	It has the following methods and data members:
…		…
411	=head2 Hooks	477	=head2 Hooks
412		478
413	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
414	called whenever the relevant event happens.	480	called whenever the relevant event happens.
415		481
416	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
417	the in the C<Extension Objects> section.	483	the in the C<Extension Objects> section.
418		484
419	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
420	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
421	relevant action might not be carried out by the C++ code.	487	relevant action might not be carried out by the C++ code.
…		…
434	place.	500	place.
435		501
436	=item on_start $term	502	=item on_start $term
437		503
438	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
439	trying to map (display) the toplevel and returning to the mainloop.	505	trying to map (display) the toplevel and returning to the main loop.
440		506
441	=item on_destroy $term	507	=item on_destroy $term
442		508
443	Called whenever something tries to destroy terminal, when the terminal is	509	Called whenever something tries to destroy terminal, when the terminal is
444	still fully functional (not for long, though).	510	still fully functional (not for long, though).
…		…
471		537
472	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
473	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
474	by calling C<< $term->selection >>.	540	by calling C<< $term->selection >>.
475		541
476	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.
477		543
478	=item on_sel_extend $term	544	=item on_sel_extend $term
479		545
480	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
481	click) and is either supposed to return false (normal operation), or	547	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	548	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	549	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	550	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.	551	supposed to enlarge the selection more and more, if possible.
486		552
487	See the F<selection> example extension.	553	See the F<selection> example extension.
488		554
489	=item on_view_change $term, $offset	555	=item on_view_change $term, $offset
490		556
491	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
492	scrolls. Offset C<0> means display the normal terminal, positive values	558	scrolls. Offset C<0> means display the normal terminal, positive values
493	show this many lines of scrollback.	559	show this many lines of scrollback.
494		560
495	=item on_scroll_back $term, $lines, $saved	561	=item on_scroll_back $term, $lines, $saved
496		562
…		…
500		566
501	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,
502	$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
503	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
504		570
505	=item on_osc_seq $term, $op, $args	571	=item on_osc_seq $term, $op, $args, $resp
506		572
507	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
508	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
509	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
510	confused by recursive invocations when you output an osc sequence within	576	confused by recursive invocations when you output an OSC sequence within
511	this callback.	577	this callback.
512		578
513	C<on_osc_seq_perl> should be used for new behaviour.	579	C<on_osc_seq_perl> should be used for new behaviour.
514		580
515	=item on_osc_seq_perl $term, $string	581	=item on_osc_seq_perl $term, $args, $resp
516		582
517	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
518	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
519	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
520	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,
521	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
522	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	}
523		599
524	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,
525	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
526	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.
527		606
528	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
529		608
530	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
531	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
…		…
536	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
537		616
538	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
539	suppress or filter tty input.	618	suppress or filter tty input.
540		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
541	=item on_line_update $term, $row	627	=item on_line_update $term, $row
542		628
543	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
544	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
545	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,
…		…
552	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
553	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
554		640
555	=item on_refresh_begin $term	641	=item on_refresh_begin $term
556		642
557	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
558	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
559	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
560	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
561		647
562	=item on_refresh_end $term	648	=item on_refresh_end $term
563		649
564	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>.
565		651
566	=item on_user_command $term, $string	652	=item on_user_command $term, $string
567		653
568	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
569	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>
570	resource in the @@RXVT_NAME@@(1) manpage).	656	resource in the @@RXVT_NAME@@(1) manpage).
571		657
572	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
573	slightly in the future.	659	slightly in the future.
574		660
575	=item on_resize_all_windows $tern, $new_width, $new_height	661	=item on_resize_all_windows $term, $new_width, $new_height
576		662
577	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
578	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
579	returns TRUE, setting of the window hints is being skipped.	665	returns TRUE, setting of the window hints is being skipped.
580		666
581	=item on_x_event $term, $event	667	=item on_x_event $term, $event
582		668
583	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
584	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
585	members are not passed.	671	members are not passed.
586		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
587	=item on_focus_in $term	677	=item on_focus_in $term
588		678
589	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
590	does focus in processing.	680	does focus in processing.
591		681
592	=item on_focus_out $term	682	=item on_focus_out $term
593		683
594	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
595	focus out processing.	685	focus out processing.
596		686
597	=item on_configure_notify $term, $event	687	=item on_configure_notify $term, $event
598		688
599	=item on_property_notify $term, $event	689	=item on_property_notify $term, $event
…		…
610		700
611	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
612		702
613	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
614		704
615	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
616	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.
617		707
618	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
619	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
620	(real, not screen-based) row and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
621		711
…		…
630		720
631	=item on_wm_delete_window $term, $event	721	=item on_wm_delete_window $term, $event
632		722
633	Called when various types of ClientMessage events are received (all with	723	Called when various types of ClientMessage events are received (all with
634	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.
635		729
636	=back	730	=back
637		731
638	=cut	732	=cut
639		733
…		…
682	The current terminal. This variable stores the current C<urxvt::term>	776	The current terminal. This variable stores the current C<urxvt::term>
683	object, whenever a callback/hook is executing.	777	object, whenever a callback/hook is executing.
684		778
685	=item @urxvt::TERM_INIT	779	=item @urxvt::TERM_INIT
686		780
687	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
688	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
689	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,
690	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.
691		785
692	This complements to the perl-eval commandline option, but gets executed	786	This complements to the perl-eval command line option, but gets executed
693	first.	787	first.
694		788
695	=item @urxvt::TERM_EXT	789	=item @urxvt::TERM_EXT
696		790
697	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
…		…
704		798
705	=over 4	799	=over 4
706		800
707	=item urxvt::fatal $errormessage	801	=item urxvt::fatal $errormessage
708		802
709	Fatally aborts execution with the given error message. Avoid at all	803	Fatally aborts execution with the given error message (which should
710	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
711	starts up.	805	is acceptable (and useful) is in the init hook, where it prevents the
		806	terminal from starting up.
712		807
713	=item urxvt::warn $string	808	=item urxvt::warn $string
714		809
715	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
716	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
717	that calls this function.	812	that calls this function.
718		813
719	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
720	correct place, e.g. on stderr of the connecting urxvtc client.	815	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
722	Messages have a size limit of 1023 bytes currently.	817	Messages have a size limit of 1023 bytes currently.
723		818
724	=item @terms = urxvt::termlist	819	=item @terms = urxvt::termlist
725		820
726	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
727	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
728	objects that have perl extensions attached will be returned (because there	823	objects that have perl extensions attached will be returned (because there
729	is no urxvt::term objet associated with others).	824	is no urxvt::term object associated with others).
730		825
731	=item $time = urxvt::NOW	826	=item $time = urxvt::NOW
732		827
733	Returns the "current time" (as per the event loop).	828	Returns the "current time" (as per the event loop).
734		829
…		…
777		872
778	=item $rend = urxvt::OVERLAY_RSTYLE	873	=item $rend = urxvt::OVERLAY_RSTYLE
779		874
780	Return the rendition mask used for overlays by default.	875	Return the rendition mask used for overlays by default.
781		876
782	=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
783		879
784	Return the bit that enabled bold, italic, blink, reverse-video and	880	Return the bit that enabled bold, italic, blink, reverse-video and
785	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
786	the bitset.	882	the bitset.
787		883
…		…
870	local $TERM = shift;	966	local $TERM = shift;
871	my $htype = shift;	967	my $htype = shift;
872		968
873	if ($htype == 0) { # INIT	969	if ($htype == 0) { # INIT
874	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	970	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
875		971
876	my %ext_arg;	972	my %ext_arg;
877		973
878	{	974	{
879	my @init = @TERM_INIT;	975	my @init = @TERM_INIT;
880	@TERM_INIT = ();	976	@TERM_INIT = ();
…		…
943		1039
944	sub SET_COLOR($$$) {	1040	sub SET_COLOR($$$) {
945	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1041	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
946	}	1042	}
947		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
948	# urxvt::term::extension	1069	# urxvt::term::extension
949		1070
950	package urxvt::term::extension;	1071	package urxvt::term::extension;
951		1072
952	sub enable {	1073	sub enable {
…		…
1021	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
1022	work.	1143	work.
1023		1144
1024	=cut	1145	=cut
1025		1146
1026	our $VERSION = 1;	1147	our $VERSION = '5.23';
1027		1148
1028	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1149	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1029	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1150	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1030		1151
1031	sub timer {	1152	sub timer {
…		…
1033		1154
1034	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
1035		1156
1036	urxvt::timer	1157	urxvt::timer
1037	->new	1158	->new
1038	->start (urxvt::NOW + $arg{after})	1159	->after ($arg{after}, $arg{interval})
1039	->cb (sub {	1160	->cb ($arg{interval} ? $cb : sub {
1040	$_[0]->stop; # need to cancel manually	1161	$_[0]->stop; # need to cancel manually
1041	$cb->();	1162	$cb->();
1042	})	1163	})
1043	}	1164	}
1044		1165
1045	sub io {	1166	sub io {
1046	my ($class, %arg) = @_;	1167	my ($class, %arg) = @_;
1047		1168
1048	my $cb = $arg{cb};	1169	my $cb = $arg{cb};
		1170	my $fd = fileno $arg{fh};
		1171	defined $fd or $fd = $arg{fh};
1049		1172
1050	bless [$arg{fh}, urxvt::iow	1173	bless [$arg{fh}, urxvt::iow
1051	->new	1174	->new
1052	->fd (fileno $arg{fh})	1175	->fd ($fd)
1053	->events (($arg{poll} =~ /r/ ? 1 : 0)	1176	->events (($arg{poll} =~ /r/ ? 1 : 0)
1054	\| ($arg{poll} =~ /w/ ? 2 : 0))	1177	\| ($arg{poll} =~ /w/ ? 2 : 0))
1055	->start	1178	->start
1056	->cb (sub {	1179	->cb ($cb)
1057	$cb->(($_[1] & 1 ? 'r' : '')
1058	. ($_[1] & 2 ? 'w' : ''));
1059	})],
1060	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	})
1061	}	1206	}
1062		1207
1063	sub DESTROY {	1208	sub DESTROY {
1064	$_[0][1]->stop;	1209	$_[0][1]->stop;
1065	}	1210	}
1066		1211
1067	sub condvar {	1212	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";	1213	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1078	}
1079	}	1214	}
1080		1215
1081	package urxvt::term;	1216	package urxvt::term;
1082		1217
1083	=head2 The C<urxvt::term> Class	1218	=head2 The C<urxvt::term> Class
…		…
1170		1305
1171	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
1172	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
1173	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.
1174		1309
1175	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
1176	source file F</src/optinc.h> to see the actual list:	1311	source file F</src/optinc.h> to see the actual list:
1177		1312
1178	borderLess console cursorBlink cursorUnderline hold iconic insecure	1313	borderLess console cursorBlink cursorUnderline hold iconic insecure
1179	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1314	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1180	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1315	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1197	likely change).	1332	likely change).
1198		1333
1199	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
1200	terminal is destroyed, so changing options frequently will eat memory.	1335	terminal is destroyed, so changing options frequently will eat memory.
1201		1336
1202	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
1203	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>
1204	to see the actual list:	1339	to see the actual list:
1205		1340
1206	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1341	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1207	borderLess color cursorBlink cursorUnderline cutchars delete_key	1342	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1208	display_name embed ext_bwidth fade font geometry hold iconName	1343	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1209	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1344	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1345	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1210	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1346	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1211	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1347	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1212	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1348	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1213	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1349	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1214	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1350	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1215	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1351	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1216	secondaryScreen secondaryScroll selectstyle shade term_name title	1352	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1217	transient_for transparent transparent_all tripleclickwords utmpInhibit	1353	term_name title transient_for transparent tripleclickwords urgentOnBell
1218	visualBell	1354	utmpInhibit visualBell
1219		1355
1220	=cut	1356	=cut
1221		1357
1222	sub resource($$;$) {	1358	sub resource($$;$) {
1223	my ($self, $name) = (shift, shift);	1359	my ($self, $name) = (shift, shift);
1224	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1360	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1225	&urxvt::term::_resource	1361	goto &urxvt::term::_resource
1226	}	1362	}
1227		1363
1228	=item $value = $term->x_resource ($pattern)	1364	=item $value = $term->x_resource ($pattern)
1229		1365
1230	Returns the X-Resource for the given pattern, excluding the program or	1366	Returns the X-Resource for the given pattern, excluding the program or
…		…
1255		1391
1256	=item ($row, $col) = $term->selection_beg ([$row, $col])	1392	=item ($row, $col) = $term->selection_beg ([$row, $col])
1257		1393
1258	=item ($row, $col) = $term->selection_end ([$row, $col])	1394	=item ($row, $col) = $term->selection_end ([$row, $col])
1259		1395
1260	Return the current values of the selection mark, begin or end positions,	1396	Return the current values of the selection mark, begin or end positions.
1261	and optionally set them to new values.	1397
		1398	When arguments are given, then the selection coordinates are set to
		1399	C<$row> and C<$col>, and the selection screen is set to the current
		1400	screen.
		1401
		1402	=item $screen = $term->selection_screen ([$screen])
		1403
		1404	Returns the current selection screen, and then optionally sets it.
1262		1405
1263	=item $term->selection_make ($eventtime[, $rectangular])	1406	=item $term->selection_make ($eventtime[, $rectangular])
1264		1407
1265	Tries to make a selection as set by C<selection_beg> and	1408	Tries to make a selection as set by C<selection_beg> and
1266	C<selection_end>. If C<$rectangular> is true (default: false), a	1409	C<selection_end>. If C<$rectangular> is true (default: false), a
1267	rectangular selection will be made. This is the prefered function to make	1410	rectangular selection will be made. This is the preferred function to make
1268	a selection.	1411	a selection.
1269		1412
1270	=item $success = $term->selection_grab ($eventtime)	1413	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1271		1414
1272	Try to request the primary selection text from the server (for example, as	1415	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1416	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	1417	with the next method. No visual feedback will be given. This function
1274	is mostly useful from within C<on_sel_grab> hooks.	1418	is mostly useful from within C<on_sel_grab> hooks.
1275		1419
1276	=item $oldtext = $term->selection ([$newtext])	1420	=item $oldtext = $term->selection ([$newtext, $clipboard])
1277		1421
1278	Return the current selection text and optionally replace it by C<$newtext>.	1422	Return the current selection (clipboard if C<$clipboard> is true) text
		1423	and optionally replace it by C<$newtext>.
		1424
		1425	=item $term->selection_clear ([$clipboard])
		1426
		1427	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1279		1428
1280	=item $term->overlay_simple ($x, $y, $text)	1429	=item $term->overlay_simple ($x, $y, $text)
1281		1430
1282	Create a simple multi-line overlay box. See the next method for details.	1431	Create a simple multi-line overlay box. See the next method for details.
1283		1432
…		…
1313		1462
1314	The methods currently supported on C<urxvt::overlay> objects are:	1463	The methods currently supported on C<urxvt::overlay> objects are:
1315		1464
1316	=over 4	1465	=over 4
1317		1466
1318	=item $overlay->set ($x, $y, $text, $rend)	1467	=item $overlay->set ($x, $y, $text[, $rend])
1319		1468
1320	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1469	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	1470	text in rxvt-unicode's special encoding and an array of rendition values
1322	at a specific position inside the overlay.	1471	at a specific position inside the overlay.
		1472
		1473	If C<$rend> is missing, then the rendition will not be changed.
1323		1474
1324	=item $overlay->hide	1475	=item $overlay->hide
1325		1476
1326	If visible, hide the overlay, but do not destroy it.	1477	If visible, hide the overlay, but do not destroy it.
1327		1478
…		…
1409	locale-specific encoding of the terminal and can contain command sequences	1560	locale-specific encoding of the terminal and can contain command sequences
1410	(escape codes) that will be interpreted.	1561	(escape codes) that will be interpreted.
1411		1562
1412	=item $term->tt_write ($octets)	1563	=item $term->tt_write ($octets)
1413		1564
1414	Write the octets given in C<$data> to the tty (i.e. as program input). To	1565	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	1566	pass characters instead of octets, you should convert your strings first
1416	to the locale-specific encoding using C<< $term->locale_encode >>.	1567	to the locale-specific encoding using C<< $term->locale_encode >>.
		1568
		1569	=item $term->tt_paste ($octets)
		1570
		1571	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1572	CR and bracketing the data with control sequences if bracketed paste mode
		1573	is set.
1417		1574
1418	=item $old_events = $term->pty_ev_events ([$new_events])	1575	=item $old_events = $term->pty_ev_events ([$new_events])
1419		1576
1420	Replaces the event mask of the pty watcher by the given event mask. Can	1577	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	1578	be used to suppress input and output handling to the pty/tty. See the
…		…
1519		1676
1520	Returns the currently displayed screen (0 primary, 1 secondary).	1677	Returns the currently displayed screen (0 primary, 1 secondary).
1521		1678
1522	=item $cursor_is_hidden = $term->hidden_cursor	1679	=item $cursor_is_hidden = $term->hidden_cursor
1523		1680
1524	Returns wether the cursor is currently hidden or not.	1681	Returns whether the cursor is currently hidden or not.
1525		1682
1526	=item $view_start = $term->view_start ([$newvalue])	1683	=item $view_start = $term->view_start ([$newvalue])
1527		1684
1528	Returns the row number of the topmost displayed line. Maximum value is	1685	Returns the row number of the topmost displayed line. Maximum value is
1529	C<0>, which displays the normal terminal contents. Lower values scroll	1686	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1537		1694
1538	Used after changing terminal contents to display them.	1695	Used after changing terminal contents to display them.
1539		1696
1540	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1697	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1541		1698
1542	Returns the text of the entire row with number C<$row_number>. Row C<0>	1699	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	1700	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	1701	terminal line. Nothing will be returned if a nonexistent line
1546	is requested.	1702	is requested.
1547		1703
1548	If C<$new_text> is specified, it will replace characters in the current	1704	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	1705	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	1706	to replace only parts of a line. The font index in the rendition will
1551	automatically be updated.	1707	automatically be updated.
1552		1708
1553	C<$text> is in a special encoding: tabs and wide characters that use more	1709	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)	1710	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1555	characters. Characters with combining characters and other characters that	1711	characters. Characters with combining characters and other characters that
1556	do not fit into the normal tetx encoding will be replaced with characters	1712	do not fit into the normal text encoding will be replaced with characters
1557	in the private use area.	1713	in the private use area.
1558		1714
1559	You have to obey this encoding when changing text. The advantage is	1715	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	1716	that C<substr> and similar functions work on screen cells and not on
1561	characters.	1717	characters.
…		…
1706	where one character corresponds to one screen cell. See	1862	where one character corresponds to one screen cell. See
1707	C<< $term->ROW_t >> for details.	1863	C<< $term->ROW_t >> for details.
1708		1864
1709	=item $string = $term->special_decode $text	1865	=item $string = $term->special_decode $text
1710		1866
1711	Converts rxvt-unicodes text reprsentation into a perl string. See	1867	Converts rxvt-unicodes text representation into a perl string. See
1712	C<< $term->ROW_t >> for details.	1868	C<< $term->ROW_t >> for details.
1713		1869
1714	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1870	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1715		1871
1716	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1872	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1719	manpage.	1875	manpage.
1720		1876
1721	=item $success = $term->grab ($eventtime[, $sync])	1877	=item $success = $term->grab ($eventtime[, $sync])
1722		1878
1723	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1879	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1724	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1880	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1725		1881
1726	=item $term->allow_events_async	1882	=item $term->allow_events_async
1727		1883
1728	Calls XAllowEvents with AsyncBoth for the most recent grab.	1884	Calls XAllowEvents with AsyncBoth for the most recent grab.
1729		1885
…		…
1736	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1892	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1737	recent grab.	1893	recent grab.
1738		1894
1739	=item $term->ungrab	1895	=item $term->ungrab
1740		1896
1741	Calls XUngrab for the most recent grab. Is called automatically on	1897	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	1898	evaluation errors, as it is better to lose the grab in the error case as
1743	the session.	1899	the session.
1744		1900
1745	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1901	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1746		1902
…		…
1748		1904
1749	=item @atoms = $term->XListProperties ($window)	1905	=item @atoms = $term->XListProperties ($window)
1750		1906
1751	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1907	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1752		1908
1753	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1909	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1754		1910
1755	=item $term->XDeleteProperty ($window, $property)	1911	=item $term->XDeleteProperty ($window, $property)
1756		1912
1757	=item $window = $term->DefaultRootWindow	1913	=item $window = $term->DefaultRootWindow
1758		1914
…		…
1768		1924
1769	=item $term->XChangeInput ($window, $add_events[, $del_events])	1925	=item $term->XChangeInput ($window, $add_events[, $del_events])
1770		1926
1771	Various X or X-related functions. The C<$term> object only serves as	1927	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	1928	the source of the display, otherwise those functions map more-or-less
1773	directory onto the X functions of the same name.	1929	directly onto the X functions of the same name.
1774		1930
1775	=back	1931	=back
1776		1932
1777	=cut	1933	=cut
1778		1934
…		…
1880	my $env = $self->{term}->env;	2036	my $env = $self->{term}->env;
1881	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2037	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1882	delete $env->{LC_ALL};	2038	delete $env->{LC_ALL};
1883	$env->{LC_CTYPE} = $self->{term}->locale;	2039	$env->{LC_CTYPE} = $self->{term}->locale;
1884		2040
1885	urxvt::term->new ($env, "popup",	2041	my $term = urxvt::term->new (
		2042	$env, "popup",
1886	"--perl-lib" => "", "--perl-ext-common" => "",	2043	"--perl-lib" => "", "--perl-ext-common" => "",
1887	"-pty-fd" => -1, "-sl" => 0,	2044	"-pty-fd" => -1, "-sl" => 0,
1888	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2045	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1889	"--transient-for" => $self->{term}->parent,	2046	"--transient-for" => $self->{term}->parent,
1890	"-display" => $self->{term}->display_id,	2047	"-display" => $self->{term}->display_id,
1891	"-pe" => "urxvt-popup")	2048	"-pe" => "urxvt-popup",
1892	or die "unable to create popup window\n";	2049	) or die "unable to create popup window\n";
		2050
		2051	unless (delete $term->{urxvt_popup_init_done}) {
		2052	$term->ungrab;
		2053	$term->destroy;
		2054	die "unable to initialise popup window\n";
		2055	}
1893	}	2056	}
1894		2057
1895	sub DESTROY {	2058	sub DESTROY {
1896	my ($self) = @_;	2059	my ($self) = @_;
1897		2060
…		…
1902	=back	2065	=back
1903		2066
1904	=cut	2067	=cut
1905		2068
1906	package urxvt::watcher;	2069	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		2070
1913	=head2 The C<urxvt::timer> Class	2071	=head2 The C<urxvt::timer> Class
1914		2072
1915	This class implements timer watchers/events. Time is represented as a	2073	This class implements timer watchers/events. Time is represented as a
1916	fractional number of seconds since the epoch. Example:	2074	fractional number of seconds since the epoch. Example:
…		…
1920	->new	2078	->new
1921	->interval (1)	2079	->interval (1)
1922	->cb (sub {	2080	->cb (sub {
1923	$term->{overlay}->set (0, 0,	2081	$term->{overlay}->set (0, 0,
1924	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2082	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1925	});	2083	});
1926		2084
1927	=over 4	2085	=over 4
1928		2086
1929	=item $timer = new urxvt::timer	2087	=item $timer = new urxvt::timer
1930		2088
…		…
1933		2091
1934	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2092	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1935		2093
1936	Set the callback to be called when the timer triggers.	2094	Set the callback to be called when the timer triggers.
1937		2095
1938	=item $tstamp = $timer->at
1939
1940	Return the time this watcher will fire next.
1941
1942	=item $timer = $timer->set ($tstamp)	2096	=item $timer = $timer->set ($tstamp[, $interval])
1943		2097
1944	Set the time the event is generated to $tstamp.	2098	Set the time the event is generated to $tstamp (and optionally specifies a
		2099	new $interval).
1945		2100
1946	=item $timer = $timer->interval ($interval)	2101	=item $timer = $timer->interval ($interval)
1947		2102
1948	Normally (and when C<$interval> is C<0>), the timer will automatically	2103	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	2104	stop after it has fired once. If C<$interval> is non-zero, then the timer
1950	is automatically rescheduled at the given intervals.	2105	is automatically rescheduled at the given intervals.
1951		2106
1952	=item $timer = $timer->start	2107	=item $timer = $timer->start
1953		2108
1954	Start the timer.	2109	Start the timer.
1955		2110
1956	=item $timer = $timer->start ($tstamp)	2111	=item $timer = $timer->start ($tstamp[, $interval])
1957		2112
1958	Set the event trigger time to C<$tstamp> and start the timer.	2113	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2114	also replaces the interval.
1959		2115
1960	=item $timer = $timer->after ($delay)	2116	=item $timer = $timer->after ($delay[, $interval])
1961		2117
1962	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2118	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1963		2119
1964	=item $timer = $timer->stop	2120	=item $timer = $timer->stop
1965		2121
…		…
1973		2129
1974	$term->{socket} = ...	2130	$term->{socket} = ...
1975	$term->{iow} = urxvt::iow	2131	$term->{iow} = urxvt::iow
1976	->new	2132	->new
1977	->fd (fileno $term->{socket})	2133	->fd (fileno $term->{socket})
1978	->events (urxvt::EVENT_READ)	2134	->events (urxvt::EV_READ)
1979	->start	2135	->start
1980	->cb (sub {	2136	->cb (sub {
1981	my ($iow, $revents) = @_;	2137	my ($iow, $revents) = @_;
1982	# $revents must be 1 here, no need to check	2138	# $revents must be 1 here, no need to check
1983	sysread $term->{socket}, my $buf, 8192	2139	sysread $term->{socket}, my $buf, 8192
…		…
1996	Set the callback to be called when io events are triggered. C<$reventmask>	2152	Set the callback to be called when io events are triggered. C<$reventmask>
1997	is a bitset as described in the C<events> method.	2153	is a bitset as described in the C<events> method.
1998		2154
1999	=item $iow = $iow->fd ($fd)	2155	=item $iow = $iow->fd ($fd)
2000		2156
2001	Set the filedescriptor (not handle) to watch.	2157	Set the file descriptor (not handle) to watch.
2002		2158
2003	=item $iow = $iow->events ($eventmask)	2159	=item $iow = $iow->events ($eventmask)
2004		2160
2005	Set the event mask to watch. The only allowed values are	2161	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	2162	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2007	together, or C<urxvt::EVENT_NONE>.	2163	together, or C<urxvt::EV_NONE>.
2008		2164
2009	=item $iow = $iow->start	2165	=item $iow = $iow->start
2010		2166
2011	Start watching for requested events on the given handle.	2167	Start watching for requested events on the given handle.
2012		2168
2013	=item $iow = $iow->stop	2169	=item $iow = $iow->stop
2014		2170
2015	Stop watching for events on the given filehandle.	2171	Stop watching for events on the given file handle.
2016		2172
2017	=back	2173	=back
2018		2174
2019	=head2 The C<urxvt::iw> Class	2175	=head2 The C<urxvt::iw> Class
2020		2176
…		…
2053	->new	2209	->new
2054	->start ($pid)	2210	->start ($pid)
2055	->cb (sub {	2211	->cb (sub {
2056	my ($pw, $exit_status) = @_;	2212	my ($pw, $exit_status) = @_;
2057	...	2213	...
2058	});	2214	});
2059		2215
2060	=over 4	2216	=over 4
2061		2217
2062	=item $pw = new urxvt::pw	2218	=item $pw = new urxvt::pw
2063		2219
…		…
2067		2223
2068	Set the callback to be called when the timer triggers.	2224	Set the callback to be called when the timer triggers.
2069		2225
2070	=item $pw = $timer->start ($pid)	2226	=item $pw = $timer->start ($pid)
2071		2227
2072	Tells the wqtcher to start watching for process C<$pid>.	2228	Tells the watcher to start watching for process C<$pid>.
2073		2229
2074	=item $pw = $pw->stop	2230	=item $pw = $pw->stop
2075		2231
2076	Stop the watcher.	2232	Stop the watcher.
2077		2233
…		…
2090		2246
2091	=item >= 3 - script loading and management	2247	=item >= 3 - script loading and management
2092		2248
2093	=item >=10 - all called hooks	2249	=item >=10 - all called hooks
2094		2250
2095	=item >=11 - hook reutrn values	2251	=item >=11 - hook return values
2096		2252
2097	=back	2253	=back
2098		2254
2099	=head1 AUTHOR	2255	=head1 AUTHOR
2100		2256
2101	Marc Lehmann <pcg@goof.com>	2257	Marc Lehmann <schmorp@schmorp.de>
2102	http://software.schmorp.de/pkg/rxvt-unicode	2258	http://software.schmorp.de/pkg/rxvt-unicode
2103		2259
2104	=cut	2260	=cut
2105		2261
2106	1	2262	1
		2263
		2264	# 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.194 by sf-exg, Wed Jun 29 21:59:36 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.194 by sf-exg, Wed Jun 29 21:59:36 2011 UTC