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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.124 by root, Sun Jan 22 11:57:06 2006 UTC vs.
Revision 1.182 by sf-exg, Wed Feb 17 08:27:56 2010 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: \\\|([^\|]+)\\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
71		81
72	You can look at the source of the selection extension to see more	82	You can look at the source of the selection extension to see more
73	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
74		84
75	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
86		96
87	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
88		98
89	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90	runtime.	100	runtime.
		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
91		118
92	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
93		120
94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
96	evaluation, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
97		124
98	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
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
100	popup is displayed.	127	popup is being displayed.
101		128
102	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
103	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.
104	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
105	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
106	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
107		134
108	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
109	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
110	C<a>s:	137	C<a>s:
111		138
112	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
113	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
114	: ()	141	: ()
115	};	142	};
116		143
117	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
118		145
…		…
125	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>
126	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
127	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
128	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
129	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
130	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.
131		164
132	=item readline (enabled by default)	165	=item readline (enabled by default)
133		166
134	A support package that tries to make editing with readline easier. At the	167	A support package that tries to make editing with readline easier. At
135	moment, it reacts to clicking with the left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
136	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
137	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
138	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
139		172
140	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
141		174
142	=over 4	175	=over 4
143		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
144	=item - the mouse is on the same (multi-row-) line as the text cursor.	183	=item - the mouse is on the same (multi-row-) line as the text cursor.
145
146	=item - the primary screen is currently being displayed.
147
148	=item - the text cursor is visible.
149		184
150	=back	185	=back
151		186
152	The normal selection mechanism isn't disabled, so quick successive clicks	187	The normal selection mechanism isn't disabled, so quick successive clicks
153	might interfere with selection creation in harmless ways.	188	might interfere with selection creation in harmless ways.
…		…
188	the message into vi commands to load the file.	223	the message into vi commands to load the file.
189		224
190	=item tabbed	225	=item tabbed
191		226
192	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
193	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
194	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
195	button per tab.	230	button per tab.
196		231
197	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
198	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,
199	while B<Shift-Down> creates a new tab.	234	while B<Shift-Down> creates a new tab.
200		235
201	=item mark-urls	236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
202		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
203	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
204	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
205	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
206	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.
207		258
208	=item automove-background	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.
209		263
210	This is basically a one-line extension that dynamically changes the background pixmap offset	264	It is possible to activate the most recently seen match from the keyboard.
211	to the window position, in effect creating the same effect as pseudo transparency with	265	Simply bind a keysym to "perl:matcher" as seen in the example below.
212	a custom pixmap. No scaling is supported in this mode. Exmaple:
213		266
214	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	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
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
		296
		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.
215		313
216	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
217		315
218	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
219	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
220	similar-looking ascii character.	318	similar-looking ascii character.
221		319
222	=item digital-clock	320	=item digital-clock
223		321
224	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
		323
		324	=item remote-clipboard
		325
		326	Somewhat of a misnomer, this extension adds two menu entries to the
		327	selection popup that allows one to run external commands to store the
		328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		343
		344	=item selection-pastebin
		345
		346	This is a little rarely useful extension that uploads the selection as
		347	textfile to a remote site (or does other things). (The implementation is
		348	not currently secure for use in a multiuser environment as it writes to
		349	F</tmp> directly.).
		350
		351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		352	i.e.
		353
		354	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		355
		356	Pressing this combination runs a command with C<%> replaced by the name of
		357	the textfile. This command can be set via a resource:
		358
		359	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		360
		361	And the default is likely not useful to anybody but the few people around
		362	here :)
		363
		364	The name of the textfile is the hex encoded md5 sum of the selection, so
		365	the same content should lead to the same filename.
		366
		367	After a successful upload the selection will be replaced by the text given
		368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		369	for the filename):
		370
		371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		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 wether 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.
225		391
226	=item example-refresh-hooks	392	=item example-refresh-hooks
227		393
228	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
229	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
230	overlays or changes.	396	overlays or changes.
231
232	=item selection-pastebin
233
234	This is a little rarely useful extension that Uploads the selection as
235	textfile to a remote site (or does other things). (The implementation is
236	not currently secure for use in a multiuser environment as it writes to
237	F</tmp> directly.).
238
239	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
240	i.e.
241
242	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
243
244	Pressing this combination runs a command with C<%> replaced by the name of
245	the textfile. This command can be set via a resource:
246
247	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
248
249	And the default is likely not useful to anybody but the few people around
250	here :)
251
252	The name of the textfile is the hex encoded md5 sum of the selection, so
253	the same content should lead to the same filename.
254
255	After a successful upload the selection will be replaced by the text given
256	in the C<selection-pastebin-url> resource (again, the % is the placeholder
257	for the filename):
258
259	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
260		397
261	=back	398	=back
262		399
263	=head1 API DOCUMENTATION	400	=head1 API DOCUMENTATION
264		401
…		…
280		417
281	=over 4	418	=over 4
282		419
283	=item $text	420	=item $text
284		421
285	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicode's special way of encoding text, where one "unicode" character
286	always represents one screen cell. See L<ROW_t> for a discussion of this format.	423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
287		424
288	=item $string	425	=item $string
289		426
290	A perl text string, with an emphasis on I<text>. It can store all unicode	427	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
298		435
299	=back	436	=back
300		437
301	=head2 Extension Objects	438	=head2 Extension Objects
302		439
303	Very perl extension is a perl class. A separate perl object is created	440	Every perl extension is a perl class. A separate perl object is created
304	for each terminal and each extension and passed as the first parameter to	441	for each terminal, and each terminal has its own set of extenion objects,
305	hooks. So extensions can use their C<$self> object without having to think	442	which are passed as the first parameter to hooks. So extensions can use
306	about other extensions, with the exception of methods and members that	443	their C<$self> object without having to think about clashes with other
		444	extensions or other terminals, with the exception of methods and members
307	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
308	use.	446	internal use.
309		447
310	Although it isn't a C<urxvt::term> object, you can call all methods of the	448	Although it isn't a C<urxvt::term> object, you can call all methods of the
311	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
312		450
313	It has the following methods and data members:	451	It has the following methods and data members:
…		…
334	=head2 Hooks	472	=head2 Hooks
335		473
336	The following subroutines can be declared in extension files, and will be	474	The following subroutines can be declared in extension files, and will be
337	called whenever the relevant event happens.	475	called whenever the relevant event happens.
338		476
339	The first argument passed to them is an extension oject as described in	477	The first argument passed to them is an extension object as described in
340	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
341		479
342	B<All> of these hooks must return a boolean value. If any of the called	480	B<All> of these hooks must return a boolean value. If any of the called
343	hooks returns true, then the event counts as being I<consumed>, and the	481	hooks returns true, then the event counts as being I<consumed>, and the
344	relevant action might not be carried out by the C++ code.	482	relevant action might not be carried out by the C++ code.
…		…
357	place.	495	place.
358		496
359	=item on_start $term	497	=item on_start $term
360		498
361	Called at the very end of initialisation of a new terminal, just before	499	Called at the very end of initialisation of a new terminal, just before
362	trying to map (display) the toplevel and returning to the mainloop.	500	trying to map (display) the toplevel and returning to the main loop.
363		501
364	=item on_destroy $term	502	=item on_destroy $term
365		503
366	Called whenever something tries to destroy terminal, before doing anything	504	Called whenever something tries to destroy terminal, when the terminal is
367	yet. If this hook returns true, then destruction is skipped, but this is	505	still fully functional (not for long, though).
368	rarely a good idea.
369		506
370	=item on_reset $term	507	=item on_reset $term
371		508
372	Called after the screen is "reset" for any reason, such as resizing or	509	Called after the screen is "reset" for any reason, such as resizing or
373	control sequences. Here is where you can react on changes to size-related	510	control sequences. Here is where you can react on changes to size-related
…		…
395		532
396	Called whenever a selection has been copied, but before the selection is	533	Called whenever a selection has been copied, but before the selection is
397	requested from the server. The selection text can be queried and changed	534	requested from the server. The selection text can be queried and changed
398	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
399		536
400	Returning a true value aborts selection grabbing. It will still be hilighted.	537	Returning a true value aborts selection grabbing. It will still be highlighted.
401		538
402	=item on_sel_extend $term	539	=item on_sel_extend $term
403		540
404	Called whenever the user tries to extend the selection (e.g. with a double	541	Called whenever the user tries to extend the selection (e.g. with a double
405	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
406	should extend the selection itelf and return true to suppress the built-in	543	should extend the selection itself and return true to suppress the built-in
407	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
408	returns true, it will be called on every further click by the user and is	545	returns true, it will be called on every further click by the user and is
409	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
410		547
411	See the F<selection> example extension.	548	See the F<selection> example extension.
412		549
413	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
414		551
415	Called whenever the view offset changes, i..e the user or program	552	Called whenever the view offset changes, i.e. the user or program
416	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
417	show this many lines of scrollback.	554	show this many lines of scrollback.
418		555
419	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
420		557
…		…
424		561
425	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	562	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
426	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	563	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
427	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
428		565
429	=item on_osc_seq $term, $string	566	=item on_osc_seq $term, $op, $args, $resp
		567
		568	Called on every OSC sequence and can be used to suppress it or modify its
		569	behaviour. The default should be to return an empty list. A true value
		570	suppresses execution of the request completely. Make sure you don't get
		571	confused by recursive invocations when you output an OSC sequence within
		572	this callback.
		573
		574	C<on_osc_seq_perl> should be used for new behaviour.
		575
		576	=item on_osc_seq_perl $term, $args, $resp
430		577
431	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
432	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
433	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
434	string should start with the extension name and a colon, to distinguish	581	string should start with the extension name (sans -osc) and a semicolon,
435	it from commands for other extensions, and this might be enforced in the	582	to distinguish it from commands for other extensions, and this might be
436	future.	583	enforced in the future.
		584
		585	For example, C<overlay-osc> uses this:
		586
		587	sub on_osc_seq_perl {
		588	my ($self, $osc, $resp) = @_;
		589
		590	return unless $osc =~ s/^overlay;//;
		591
		592	... process remaining $osc string
		593	}
437		594
438	Be careful not ever to trust (in a security sense) the data you receive,	595	Be careful not ever to trust (in a security sense) the data you receive,
439	as its source can not easily be controleld (e-mail content, messages from	596	as its source can not easily be controlled (e-mail content, messages from
440	other users on the same system etc.).	597	other users on the same system etc.).
		598
		599	For responses, C<$resp> contains the end-of-args separator used by the
		600	sender.
441		601
442	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
443		603
444	Called whenever text is about to be output, with the text as argument. You	604	Called whenever text is about to be output, with the text as argument. You
445	can filter/change and output the text yourself by returning a true value	605	can filter/change and output the text yourself by returning a true value
…		…
466	later with the already-modified line (e.g. if unrelated parts change), so	626	later with the already-modified line (e.g. if unrelated parts change), so
467	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
468		628
469	=item on_refresh_begin $term	629	=item on_refresh_begin $term
470		630
471	Called just before the screen gets redrawn. Can be used for overlay	631	Called just before the screen gets redrawn. Can be used for overlay or
472	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
473	restoring them in refresh_end. The built-in overlay and selection display	633	restoring them in refresh_end. The built-in overlay and selection display
474	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
475		635
476	=item on_refresh_end $term	636	=item on_refresh_end $term
477		637
478	Called just after the screen gets redrawn. See C<on_refresh_begin>.	638	Called just after the screen gets redrawn. See C<on_refresh_begin>.
479		639
480	=item on_keyboard_command $term, $string	640	=item on_user_command $term, $string
481		641
482	Called whenever the user presses a key combination that has a	642	Called whenever a user-configured event is being activated (e.g. via
483	C<perl:string> action bound to it (see description of the B<keysym>	643	a C<perl:string> action bound to a key, see description of the B<keysym>
484	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
		645
		646	The event is simply the action string. This interface is assumed to change
		647	slightly in the future.
		648
		649	=item on_resize_all_windows $tern, $new_width, $new_height
		650
		651	Called just after the new window size has been calculated, but before
		652	windows are actually being resized or hints are being set. If this hook
		653	returns TRUE, setting of the window hints is being skipped.
485		654
486	=item on_x_event $term, $event	655	=item on_x_event $term, $event
487		656
488	Called on every X event received on the vt window (and possibly other	657	Called on every X event received on the vt window (and possibly other
489	windows). Should only be used as a last resort. Most event structure	658	windows). Should only be used as a last resort. Most event structure
490	members are not passed.	659	members are not passed.
491		660
		661	=item on_root_event $term, $event
		662
		663	Like C<on_x_event>, but is called for events on the root window.
		664
492	=item on_focus_in $term	665	=item on_focus_in $term
493		666
494	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
495	does focus in processing.	668	does focus in processing.
496		669
497	=item on_focus_out $term	670	=item on_focus_out $term
498		671
499	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
500	focus out processing.	673	focus out processing.
501		674
502	=item on_configure_notify $term, $event	675	=item on_configure_notify $term, $event
503		676
504	=item on_property_notify $term, $event	677	=item on_property_notify $term, $event
…		…
515		688
516	=item on_map_notify $term, $event	689	=item on_map_notify $term, $event
517		690
518	=item on_unmap_notify $term, $event	691	=item on_unmap_notify $term, $event
519		692
520	Called whenever the corresponding X event is received for the terminal If	693	Called whenever the corresponding X event is received for the terminal. If
521	the hook returns true, then the even will be ignored by rxvt-unicode.	694	the hook returns true, then the event will be ignored by rxvt-unicode.
522		695
523	The event is a hash with most values as named by Xlib (see the XEvent	696	The event is a hash with most values as named by Xlib (see the XEvent
524	manpage), with the additional members C<row> and C<col>, which are the	697	manpage), with the additional members C<row> and C<col>, which are the
525	(real, not screen-based) row and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
526		699
…		…
535		708
536	=item on_wm_delete_window $term, $event	709	=item on_wm_delete_window $term, $event
537		710
538	Called when various types of ClientMessage events are received (all with	711	Called when various types of ClientMessage events are received (all with
539	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		713
		714	=item on_bell $term
		715
		716	Called on receipt of a bell character.
540		717
541	=back	718	=back
542		719
543	=cut	720	=cut
544		721
…		…
587	The current terminal. This variable stores the current C<urxvt::term>	764	The current terminal. This variable stores the current C<urxvt::term>
588	object, whenever a callback/hook is executing.	765	object, whenever a callback/hook is executing.
589		766
590	=item @urxvt::TERM_INIT	767	=item @urxvt::TERM_INIT
591		768
592	All coderefs in this array will be called as methods of the next newly	769	All code references in this array will be called as methods of the next newly
593	created C<urxvt::term> object (during the C<on_init> phase). The array	770	created C<urxvt::term> object (during the C<on_init> phase). The array
594	gets cleared before the codereferences that were in it are being executed,	771	gets cleared before the code references that were in it are being executed,
595	so coderefs can push themselves onto it again if they so desire.	772	so references can push themselves onto it again if they so desire.
596		773
597	This complements to the perl-eval commandline option, but gets executed	774	This complements to the perl-eval command line option, but gets executed
598	first.	775	first.
599		776
600	=item @urxvt::TERM_EXT	777	=item @urxvt::TERM_EXT
601		778
602	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	779	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
623		800
624	Using this function has the advantage that its output ends up in the	801	Using this function has the advantage that its output ends up in the
625	correct place, e.g. on stderr of the connecting urxvtc client.	802	correct place, e.g. on stderr of the connecting urxvtc client.
626		803
627	Messages have a size limit of 1023 bytes currently.	804	Messages have a size limit of 1023 bytes currently.
		805
		806	=item @terms = urxvt::termlist
		807
		808	Returns all urxvt::term objects that exist in this process, regardless of
		809	whether they are started, being destroyed etc., so be careful. Only term
		810	objects that have perl extensions attached will be returned (because there
		811	is no urxvt::term objet associated with others).
628		812
629	=item $time = urxvt::NOW	813	=item $time = urxvt::NOW
630		814
631	Returns the "current time" (as per the event loop).	815	Returns the "current time" (as per the event loop).
632		816
…		…
690	Return the foreground/background colour index, respectively.	874	Return the foreground/background colour index, respectively.
691		875
692	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	876	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
693		877
694	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	878	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		879
		880	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
695		881
696	Replace the foreground/background colour in the rendition mask with the	882	Replace the foreground/background colour in the rendition mask with the
697	specified one.	883	specified one.
698		884
699	=item $value = urxvt::GET_CUSTOM $rend	885	=item $value = urxvt::GET_CUSTOM $rend
…		…
766	local $TERM = shift;	952	local $TERM = shift;
767	my $htype = shift;	953	my $htype = shift;
768		954
769	if ($htype == 0) { # INIT	955	if ($htype == 0) { # INIT
770	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	956	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
771		957
772	my %ext_arg;	958	my %ext_arg;
773		959
774	{	960	{
775	my @init = @TERM_INIT;	961	my @init = @TERM_INIT;
776	@TERM_INIT = ();	962	@TERM_INIT = ();
…		…
790	} else {	976	} else {
791	$ext_arg{$_} \|\|= [];	977	$ext_arg{$_} \|\|= [];
792	}	978	}
793	}	979	}
794		980
795	while (my ($ext, $argv) = each %ext_arg) {	981	for my $ext (sort keys %ext_arg) {
796	my @files = grep -f $_, map "$_/$ext", @dirs;	982	my @files = grep -f $_, map "$_/$ext", @dirs;
797		983
798	if (@files) {	984	if (@files) {
799	$TERM->register_package (extension_package $files[0], $argv);	985	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
800	} else {	986	} else {
801	warn "perl extension '$ext' not found in perl library search path\n";	987	warn "perl extension '$ext' not found in perl library search path\n";
802	}	988	}
803	}	989	}
804		990
…		…
810		996
811	if (my $cb = $TERM->{_hook}[$htype]) {	997	if (my $cb = $TERM->{_hook}[$htype]) {
812	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	998	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
813	if $verbosity >= 10;	999	if $verbosity >= 10;
814		1000
815	keys %$cb;	1001	for my $pkg (keys %$cb) {
816
817	while (my ($pkg, $cb) = each %$cb) {
818	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1002	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
819	$retval \|\|= $retval_;	1003	$retval \|\|= $retval_;
820		1004
821	if ($@) {	1005	if ($@) {
822	$TERM->ungrab; # better to lose the grab than the session	1006	$TERM->ungrab; # better to lose the grab than the session
823	warn $@;	1007	warn $@;
…		…
835	# clear package	1019	# clear package
836	%$TERM = ();	1020	%$TERM = ();
837	}	1021	}
838		1022
839	$retval	1023	$retval
		1024	}
		1025
		1026	sub SET_COLOR($$$) {
		1027	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1028	}
		1029
		1030	sub rend2mask {
		1031	no strict 'refs';
		1032	my ($str, $mask) = (@_, 0);
		1033	my %color = ( fg => undef, bg => undef );
		1034	my @failed;
		1035	for my $spec ( split /\s+/, $str ) {
		1036	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1037	$color{lc($1)} = $2;
		1038	} else {
		1039	my $neg = $spec =~ s/^[-^]//;
		1040	unless ( exists &{"RS_$spec"} ) {
		1041	push @failed, $spec;
		1042	next;
		1043	}
		1044	my $cur = &{"RS_$spec"};
		1045	if ( $neg ) {
		1046	$mask &= ~$cur;
		1047	} else {
		1048	$mask \|= $cur;
		1049	}
		1050	}
		1051	}
		1052	($mask, @color{qw(fg bg)}, \@failed)
840	}	1053	}
841		1054
842	# urxvt::term::extension	1055	# urxvt::term::extension
843		1056
844	package urxvt::term::extension;	1057	package urxvt::term::extension;
…		…
915	is that you cannot use blocking APIs, but the non-blocking variant should	1128	is that you cannot use blocking APIs, but the non-blocking variant should
916	work.	1129	work.
917		1130
918	=cut	1131	=cut
919		1132
920	our $VERSION = 1;	1133	our $VERSION = '5.23';
921		1134
922	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1135	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
923	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1136	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
924		1137
925	sub timer {	1138	sub timer {
…		…
927		1140
928	my $cb = $arg{cb};	1141	my $cb = $arg{cb};
929		1142
930	urxvt::timer	1143	urxvt::timer
931	->new	1144	->new
932	->start (urxvt::NOW + $arg{after})	1145	->after ($arg{after}, $arg{interval})
933	->cb (sub {	1146	->cb ($arg{interval} ? $cb : sub {
934	$_[0]->stop; # need to cancel manually	1147	$_[0]->stop; # need to cancel manually
935	$cb->();	1148	$cb->();
936	})	1149	})
937	}	1150	}
938		1151
939	sub io {	1152	sub io {
940	my ($class, %arg) = @_;	1153	my ($class, %arg) = @_;
941		1154
942	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
		1156	my $fd = fileno $arg{fh};
		1157	defined $fd or $fd = $arg{fh};
943		1158
944	bless [$arg{fh}, urxvt::iow	1159	bless [$arg{fh}, urxvt::iow
945	->new	1160	->new
946	->fd (fileno $arg{fh})	1161	->fd ($fd)
947	->events (($arg{poll} =~ /r/ ? 1 : 0)	1162	->events (($arg{poll} =~ /r/ ? 1 : 0)
948	\| ($arg{poll} =~ /w/ ? 2 : 0))	1163	\| ($arg{poll} =~ /w/ ? 2 : 0))
949	->start	1164	->start
950	->cb (sub {	1165	->cb ($cb)
951	$cb->(($_[1] & 1 ? 'r' : '')
952	. ($_[1] & 2 ? 'w' : ''));
953	})],
954	urxvt::anyevent::	1166	], urxvt::anyevent::
		1167	}
		1168
		1169	sub idle {
		1170	my ($class, %arg) = @_;
		1171
		1172	my $cb = $arg{cb};
		1173
		1174	urxvt::iw
		1175	->new
		1176	->start
		1177	->cb ($cb)
		1178	}
		1179
		1180	sub child {
		1181	my ($class, %arg) = @_;
		1182
		1183	my $cb = $arg{cb};
		1184
		1185	urxvt::pw
		1186	->new
		1187	->start ($arg{pid})
		1188	->cb (sub {
		1189	$_[0]->stop; # need to cancel manually
		1190	$cb->($_[0]->rpid, $_[0]->rstatus);
		1191	})
955	}	1192	}
956		1193
957	sub DESTROY {	1194	sub DESTROY {
958	$_[0][1]->stop;	1195	$_[0][1]->stop;
959	}	1196	}
960		1197
961	sub condvar {	1198	sub one_event {
962	bless \my $flag, urxvt::anyevent::condvar::
963	}
964
965	sub urxvt::anyevent::condvar::broadcast {
966	${$_[0]}++;
967	}
968
969	sub urxvt::anyevent::condvar::wait {
970	unless (${$_[0]}) {
971	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1199	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
972	}
973	}	1200	}
974		1201
975	package urxvt::term;	1202	package urxvt::term;
976		1203
977	=head2 The C<urxvt::term> Class	1204	=head2 The C<urxvt::term> Class
…		…
1013	hash which defines the environment of the new terminal.	1240	hash which defines the environment of the new terminal.
1014		1241
1015	Croaks (and probably outputs an error message) if the new instance	1242	Croaks (and probably outputs an error message) if the new instance
1016	couldn't be created. Returns C<undef> if the new instance didn't	1243	couldn't be created. Returns C<undef> if the new instance didn't
1017	initialise perl, and the terminal object otherwise. The C<init> and	1244	initialise perl, and the terminal object otherwise. The C<init> and
1018	C<start> hooks will be called during this call.	1245	C<start> hooks will be called before this call returns, and are free to
		1246	refer to global data (which is race free).
1019		1247
1020	=cut	1248	=cut
1021		1249
1022	sub new {	1250	sub new {
1023	my ($class, $env, @args) = @_;	1251	my ($class, $env, @args) = @_;
1024		1252
		1253	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1254	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1255
1025	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1256	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1026	}	1257	}
1027		1258
1028	=item $term->destroy	1259	=item $term->destroy
1029		1260
1030	Destroy the terminal object (close the window, free resources	1261	Destroy the terminal object (close the window, free resources
…		…
1060		1291
1061	Returns true if the option specified by C<$optval> is enabled, and	1292	Returns true if the option specified by C<$optval> is enabled, and
1062	optionally change it. All option values are stored by name in the hash	1293	optionally change it. All option values are stored by name in the hash
1063	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1294	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1064		1295
1065	Here is a a likely non-exhaustive list of option names, please see the	1296	Here is a likely non-exhaustive list of option names, please see the
1066	source file F</src/optinc.h> to see the actual list:	1297	source file F</src/optinc.h> to see the actual list:
1067		1298
1068	borderLess console cursorBlink cursorUnderline hold iconic insecure	1299	borderLess console cursorBlink cursorUnderline hold iconic insecure
1069	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1300	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1070	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1301	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1087	likely change).	1318	likely change).
1088		1319
1089	Please note that resource strings will currently only be freed when the	1320	Please note that resource strings will currently only be freed when the
1090	terminal is destroyed, so changing options frequently will eat memory.	1321	terminal is destroyed, so changing options frequently will eat memory.
1091		1322
1092	Here is a a likely non-exhaustive list of resource names, not all of which	1323	Here is a likely non-exhaustive list of resource names, not all of which
1093	are supported in every build, please see the source file F</src/rsinc.h>	1324	are supported in every build, please see the source file F</src/rsinc.h>
1094	to see the actual list:	1325	to see the actual list:
1095		1326
1096	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1327	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1097	borderLess color cursorBlink cursorUnderline cutchars delete_key	1328	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1098	display_name embed ext_bwidth fade font geometry hold iconName	1329	display_name embed ext_bwidth fade font geometry hold iconName
1099	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1330	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1100	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1331	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1101	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1332	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1102	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1333	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1103	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1334	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1104	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1335	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1105	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1336	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1106	secondaryScreen secondaryScroll selectstyle shade term_name title	1337	secondaryScreen secondaryScroll shade term_name title
1107	transient_for transparent transparent_all tripleclickwords utmpInhibit	1338	transient_for transparent transparent_all tripleclickwords utmpInhibit
1108	visualBell	1339	visualBell
1109		1340
1110	=cut	1341	=cut
1111		1342
1112	sub resource($$;$) {	1343	sub resource($$;$) {
1113	my ($self, $name) = (shift, shift);	1344	my ($self, $name) = (shift, shift);
1114	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1345	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1115	&urxvt::term::_resource	1346	goto &urxvt::term::_resource
1116	}	1347	}
1117		1348
1118	=item $value = $term->x_resource ($pattern)	1349	=item $value = $term->x_resource ($pattern)
1119		1350
1120	Returns the X-Resource for the given pattern, excluding the program or	1351	Returns the X-Resource for the given pattern, excluding the program or
…		…
1145		1376
1146	=item ($row, $col) = $term->selection_beg ([$row, $col])	1377	=item ($row, $col) = $term->selection_beg ([$row, $col])
1147		1378
1148	=item ($row, $col) = $term->selection_end ([$row, $col])	1379	=item ($row, $col) = $term->selection_end ([$row, $col])
1149		1380
1150	Return the current values of the selection mark, begin or end positions,	1381	Return the current values of the selection mark, begin or end positions.
1151	and optionally set them to new values.	1382
		1383	When arguments are given, then the selection coordinates are set to
		1384	C<$row> and C<$col>, and the selection screen is set to the current
		1385	screen.
		1386
		1387	=item $screen = $term->selection_screen ([$screen])
		1388
		1389	Returns the current selection screen, and then optionally sets it.
1152		1390
1153	=item $term->selection_make ($eventtime[, $rectangular])	1391	=item $term->selection_make ($eventtime[, $rectangular])
1154		1392
1155	Tries to make a selection as set by C<selection_beg> and	1393	Tries to make a selection as set by C<selection_beg> and
1156	C<selection_end>. If C<$rectangular> is true (default: false), a	1394	C<selection_end>. If C<$rectangular> is true (default: false), a
…		…
1203		1441
1204	The methods currently supported on C<urxvt::overlay> objects are:	1442	The methods currently supported on C<urxvt::overlay> objects are:
1205		1443
1206	=over 4	1444	=over 4
1207		1445
1208	=item $overlay->set ($x, $y, $text, $rend)	1446	=item $overlay->set ($x, $y, $text[, $rend])
1209		1447
1210	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1448	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1211	text in rxvt-unicode's special encoding and an array of rendition values	1449	text in rxvt-unicode's special encoding and an array of rendition values
1212	at a specific position inside the overlay.	1450	at a specific position inside the overlay.
		1451
		1452	If C<$rend> is missing, then the rendition will not be changed.
1213		1453
1214	=item $overlay->hide	1454	=item $overlay->hide
1215		1455
1216	If visible, hide the overlay, but do not destroy it.	1456	If visible, hide the overlay, but do not destroy it.
1217		1457
…		…
1310	Replaces the event mask of the pty watcher by the given event mask. Can	1550	Replaces the event mask of the pty watcher by the given event mask. Can
1311	be used to suppress input and output handling to the pty/tty. See the	1551	be used to suppress input and output handling to the pty/tty. See the
1312	description of C<< urxvt::timer->events >>. Make sure to always restore	1552	description of C<< urxvt::timer->events >>. Make sure to always restore
1313	the previous value.	1553	the previous value.
1314		1554
		1555	=item $fd = $term->pty_fd
		1556
		1557	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1558	is used.
		1559
1315	=item $windowid = $term->parent	1560	=item $windowid = $term->parent
1316		1561
1317	Return the window id of the toplevel window.	1562	Return the window id of the toplevel window.
1318		1563
1319	=item $windowid = $term->vt	1564	=item $windowid = $term->vt
…		…
1325	Adds the specified events to the vt event mask. Useful e.g. when you want	1570	Adds the specified events to the vt event mask. Useful e.g. when you want
1326	to receive pointer events all the times:	1571	to receive pointer events all the times:
1327		1572
1328	$term->vt_emask_add (urxvt::PointerMotionMask);	1573	$term->vt_emask_add (urxvt::PointerMotionMask);
1329		1574
		1575	=item $term->focus_in
		1576
		1577	=item $term->focus_out
		1578
		1579	=item $term->key_press ($state, $keycode[, $time])
		1580
		1581	=item $term->key_release ($state, $keycode[, $time])
		1582
		1583	Deliver various fake events to to terminal.
		1584
1330	=item $window_width = $term->width	1585	=item $window_width = $term->width
1331		1586
1332	=item $window_height = $term->height	1587	=item $window_height = $term->height
1333		1588
1334	=item $font_width = $term->fwidth	1589	=item $font_width = $term->fwidth
…		…
1364	=item $env = $term->env	1619	=item $env = $term->env
1365		1620
1366	Returns a copy of the environment in effect for the terminal as a hashref	1621	Returns a copy of the environment in effect for the terminal as a hashref
1367	similar to C<\%ENV>.	1622	similar to C<\%ENV>.
1368		1623
		1624	=item @envv = $term->envv
		1625
		1626	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1627
		1628	=item @argv = $term->argv
		1629
		1630	Return the argument vector as this terminal, similar to @ARGV, but
		1631	includes the program name as first element.
		1632
1369	=cut	1633	=cut
1370		1634
1371	sub env {	1635	sub env {
1372	if (my $env = $_[0]->_env) {
1373	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1636	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1374	} else {
1375	+{ %ENV }
1376	}
1377	}	1637	}
1378		1638
1379	=item $modifiermask = $term->ModLevel3Mask	1639	=item $modifiermask = $term->ModLevel3Mask
1380		1640
1381	=item $modifiermask = $term->ModMetaMask	1641	=item $modifiermask = $term->ModMetaMask
…		…
1389		1649
1390	Returns the currently displayed screen (0 primary, 1 secondary).	1650	Returns the currently displayed screen (0 primary, 1 secondary).
1391		1651
1392	=item $cursor_is_hidden = $term->hidden_cursor	1652	=item $cursor_is_hidden = $term->hidden_cursor
1393		1653
1394	Returns wether the cursor is currently hidden or not.	1654	Returns whether the cursor is currently hidden or not.
1395		1655
1396	=item $view_start = $term->view_start ([$newvalue])	1656	=item $view_start = $term->view_start ([$newvalue])
1397		1657
1398	Returns the row number of the topmost displayed line. Maximum value is	1658	Returns the row number of the topmost displayed line. Maximum value is
1399	C<0>, which displays the normal terminal contents. Lower values scroll	1659	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1407		1667
1408	Used after changing terminal contents to display them.	1668	Used after changing terminal contents to display them.
1409		1669
1410	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1670	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1411		1671
1412	Returns the text of the entire row with number C<$row_number>. Row C<0>	1672	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1413	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1673	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1414	terminal line. The scrollback buffer starts at line C<-1> and extends to
1415	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1674	terminal line. Nothing will be returned if a nonexistent line
1416	is requested.	1675	is requested.
1417		1676
1418	If C<$new_text> is specified, it will replace characters in the current	1677	If C<$new_text> is specified, it will replace characters in the current
1419	line, starting at column C<$start_col> (default C<0>), which is useful	1678	line, starting at column C<$start_col> (default C<0>), which is useful
1420	to replace only parts of a line. The font index in the rendition will	1679	to replace only parts of a line. The font index in the rendition will
1421	automatically be updated.	1680	automatically be updated.
1422		1681
1423	C<$text> is in a special encoding: tabs and wide characters that use more	1682	C<$text> is in a special encoding: tabs and wide characters that use more
1424	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1683	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1425	characters. Characters with combining characters and other characters that	1684	characters. Characters with combining characters and other characters that
1426	do not fit into the normal tetx encoding will be replaced with characters	1685	do not fit into the normal text encoding will be replaced with characters
1427	in the private use area.	1686	in the private use area.
1428		1687
1429	You have to obey this encoding when changing text. The advantage is	1688	You have to obey this encoding when changing text. The advantage is
1430	that C<substr> and similar functions work on screen cells and not on	1689	that C<substr> and similar functions work on screen cells and not on
1431	characters.	1690	characters.
…		…
1576	where one character corresponds to one screen cell. See	1835	where one character corresponds to one screen cell. See
1577	C<< $term->ROW_t >> for details.	1836	C<< $term->ROW_t >> for details.
1578		1837
1579	=item $string = $term->special_decode $text	1838	=item $string = $term->special_decode $text
1580		1839
1581	Converts rxvt-unicodes text reprsentation into a perl string. See	1840	Converts rxvt-unicodes text representation into a perl string. See
1582	C<< $term->ROW_t >> for details.	1841	C<< $term->ROW_t >> for details.
1583		1842
1584	=item $success = $term->grab_button ($button, $modifiermask)	1843	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1585		1844
		1845	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1846
1586	Registers a synchronous button grab. See the XGrabButton manpage.	1847	Register/unregister a synchronous button grab. See the XGrabButton
		1848	manpage.
1587		1849
1588	=item $success = $term->grab ($eventtime[, $sync])	1850	=item $success = $term->grab ($eventtime[, $sync])
1589		1851
1590	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1852	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1591	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1853	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1592		1854
1593	=item $term->allow_events_async	1855	=item $term->allow_events_async
1594		1856
1595	Calls XAllowEvents with AsyncBoth for the most recent grab.	1857	Calls XAllowEvents with AsyncBoth for the most recent grab.
1596		1858
…		…
1603	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1865	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1604	recent grab.	1866	recent grab.
1605		1867
1606	=item $term->ungrab	1868	=item $term->ungrab
1607		1869
1608	Calls XUngrab for the most recent grab. Is called automatically on	1870	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1609	evaluation errors, as it is better to lose the grab in the error case as	1871	evaluation errors, as it is better to lose the grab in the error case as
1610	the session.	1872	the session.
1611		1873
1612	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1874	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1613		1875
…		…
1615		1877
1616	=item @atoms = $term->XListProperties ($window)	1878	=item @atoms = $term->XListProperties ($window)
1617		1879
1618	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1880	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1619		1881
1620	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1882	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1621		1883
1622	=item $term->XDeleteProperty ($window, $property)	1884	=item $term->XDeleteProperty ($window, $property)
1623		1885
1624	=item $window = $term->DefaultRootWindow	1886	=item $window = $term->DefaultRootWindow
1625		1887
…		…
1635		1897
1636	=item $term->XChangeInput ($window, $add_events[, $del_events])	1898	=item $term->XChangeInput ($window, $add_events[, $del_events])
1637		1899
1638	Various X or X-related functions. The C<$term> object only serves as	1900	Various X or X-related functions. The C<$term> object only serves as
1639	the source of the display, otherwise those functions map more-or-less	1901	the source of the display, otherwise those functions map more-or-less
1640	directory onto the X functions of the same name.	1902	directly onto the X functions of the same name.
1641		1903
1642	=back	1904	=back
1643		1905
1644	=cut	1906	=cut
1645		1907
…		…
1709	my ($self, $text, $cb) = @_;	1971	my ($self, $text, $cb) = @_;
1710		1972
1711	$self->add_item ({ type => "button", text => $text, activate => $cb});	1973	$self->add_item ({ type => "button", text => $text, activate => $cb});
1712	}	1974	}
1713		1975
1714	=item $popup->add_toggle ($text, $cb, $initial_value)	1976	=item $popup->add_toggle ($text, $initial_value, $cb)
1715		1977
1716	Adds a toggle/checkbox item to the popup. Teh callback gets called	1978	Adds a toggle/checkbox item to the popup. The callback gets called
1717	whenever it gets toggled, with a boolean indicating its value as its first	1979	whenever it gets toggled, with a boolean indicating its new value as its
1718	argument.	1980	first argument.
1719		1981
1720	=cut	1982	=cut
1721		1983
1722	sub add_toggle {	1984	sub add_toggle {
1723	my ($self, $text, $cb, $value) = @_;	1985	my ($self, $text, $value, $cb) = @_;
1724		1986
1725	my $item; $item = {	1987	my $item; $item = {
1726	type => "button",	1988	type => "button",
1727	text => " $text",	1989	text => " $text",
1728	value => $value,	1990	value => $value,
…		…
1747	my $env = $self->{term}->env;	2009	my $env = $self->{term}->env;
1748	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2010	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1749	delete $env->{LC_ALL};	2011	delete $env->{LC_ALL};
1750	$env->{LC_CTYPE} = $self->{term}->locale;	2012	$env->{LC_CTYPE} = $self->{term}->locale;
1751		2013
1752	urxvt::term->new ($env, "popup",	2014	my $term = urxvt::term->new (
		2015	$env, "popup",
1753	"--perl-lib" => "", "--perl-ext-common" => "",	2016	"--perl-lib" => "", "--perl-ext-common" => "",
1754	"-pty-fd" => -1, "-sl" => 0,	2017	"-pty-fd" => -1, "-sl" => 0,
1755	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2018	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1756	"--transient-for" => $self->{term}->parent,	2019	"--transient-for" => $self->{term}->parent,
1757	"-display" => $self->{term}->display_id,	2020	"-display" => $self->{term}->display_id,
1758	"-pe" => "urxvt-popup")	2021	"-pe" => "urxvt-popup",
1759	or die "unable to create popup window\n";	2022	) or die "unable to create popup window\n";
		2023
		2024	unless (delete $term->{urxvt_popup_init_done}) {
		2025	$term->ungrab;
		2026	$term->destroy;
		2027	die "unable to initialise popup window\n";
		2028	}
1760	}	2029	}
1761		2030
1762	sub DESTROY {	2031	sub DESTROY {
1763	my ($self) = @_;	2032	my ($self) = @_;
1764		2033
…		…
1769	=back	2038	=back
1770		2039
1771	=cut	2040	=cut
1772		2041
1773	package urxvt::watcher;	2042	package urxvt::watcher;
1774
1775	@urxvt::timer::ISA = __PACKAGE__;
1776	@urxvt::iow::ISA = __PACKAGE__;
1777	@urxvt::pw::ISA = __PACKAGE__;
1778	@urxvt::iw::ISA = __PACKAGE__;
1779		2043
1780	=head2 The C<urxvt::timer> Class	2044	=head2 The C<urxvt::timer> Class
1781		2045
1782	This class implements timer watchers/events. Time is represented as a	2046	This class implements timer watchers/events. Time is represented as a
1783	fractional number of seconds since the epoch. Example:	2047	fractional number of seconds since the epoch. Example:
…		…
1787	->new	2051	->new
1788	->interval (1)	2052	->interval (1)
1789	->cb (sub {	2053	->cb (sub {
1790	$term->{overlay}->set (0, 0,	2054	$term->{overlay}->set (0, 0,
1791	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2055	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1792	});	2056	});
1793		2057
1794	=over 4	2058	=over 4
1795		2059
1796	=item $timer = new urxvt::timer	2060	=item $timer = new urxvt::timer
1797		2061
…		…
1800		2064
1801	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2065	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1802		2066
1803	Set the callback to be called when the timer triggers.	2067	Set the callback to be called when the timer triggers.
1804		2068
1805	=item $tstamp = $timer->at
1806
1807	Return the time this watcher will fire next.
1808
1809	=item $timer = $timer->set ($tstamp)	2069	=item $timer = $timer->set ($tstamp[, $interval])
1810		2070
1811	Set the time the event is generated to $tstamp.	2071	Set the time the event is generated to $tstamp (and optionally specifies a
		2072	new $interval).
1812		2073
1813	=item $timer = $timer->interval ($interval)	2074	=item $timer = $timer->interval ($interval)
1814		2075
1815	Normally (and when C<$interval> is C<0>), the timer will automatically	2076	By default (and when C<$interval> is C<0>), the timer will automatically
1816	stop after it has fired once. If C<$interval> is non-zero, then the timer	2077	stop after it has fired once. If C<$interval> is non-zero, then the timer
1817	is automatically rescheduled at the given intervals.	2078	is automatically rescheduled at the given intervals.
1818		2079
1819	=item $timer = $timer->start	2080	=item $timer = $timer->start
1820		2081
1821	Start the timer.	2082	Start the timer.
1822		2083
1823	=item $timer = $timer->start ($tstamp)	2084	=item $timer = $timer->start ($tstamp[, $interval])
1824		2085
1825	Set the event trigger time to C<$tstamp> and start the timer.	2086	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2087	also replaces the interval.
1826		2088
1827	=item $timer = $timer->after ($delay)	2089	=item $timer = $timer->after ($delay[, $interval])
1828		2090
1829	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2091	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1830		2092
1831	=item $timer = $timer->stop	2093	=item $timer = $timer->stop
1832		2094
…		…
1840		2102
1841	$term->{socket} = ...	2103	$term->{socket} = ...
1842	$term->{iow} = urxvt::iow	2104	$term->{iow} = urxvt::iow
1843	->new	2105	->new
1844	->fd (fileno $term->{socket})	2106	->fd (fileno $term->{socket})
1845	->events (urxvt::EVENT_READ)	2107	->events (urxvt::EV_READ)
1846	->start	2108	->start
1847	->cb (sub {	2109	->cb (sub {
1848	my ($iow, $revents) = @_;	2110	my ($iow, $revents) = @_;
1849	# $revents must be 1 here, no need to check	2111	# $revents must be 1 here, no need to check
1850	sysread $term->{socket}, my $buf, 8192	2112	sysread $term->{socket}, my $buf, 8192
…		…
1863	Set the callback to be called when io events are triggered. C<$reventmask>	2125	Set the callback to be called when io events are triggered. C<$reventmask>
1864	is a bitset as described in the C<events> method.	2126	is a bitset as described in the C<events> method.
1865		2127
1866	=item $iow = $iow->fd ($fd)	2128	=item $iow = $iow->fd ($fd)
1867		2129
1868	Set the filedescriptor (not handle) to watch.	2130	Set the file descriptor (not handle) to watch.
1869		2131
1870	=item $iow = $iow->events ($eventmask)	2132	=item $iow = $iow->events ($eventmask)
1871		2133
1872	Set the event mask to watch. The only allowed values are	2134	Set the event mask to watch. The only allowed values are
1873	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2135	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1874	together, or C<urxvt::EVENT_NONE>.	2136	together, or C<urxvt::EV_NONE>.
1875		2137
1876	=item $iow = $iow->start	2138	=item $iow = $iow->start
1877		2139
1878	Start watching for requested events on the given handle.	2140	Start watching for requested events on the given handle.
1879		2141
1880	=item $iow = $iow->stop	2142	=item $iow = $iow->stop
1881		2143
1882	Stop watching for events on the given filehandle.	2144	Stop watching for events on the given file handle.
1883		2145
1884	=back	2146	=back
1885		2147
1886	=head2 The C<urxvt::iw> Class	2148	=head2 The C<urxvt::iw> Class
1887		2149
…		…
1920	->new	2182	->new
1921	->start ($pid)	2183	->start ($pid)
1922	->cb (sub {	2184	->cb (sub {
1923	my ($pw, $exit_status) = @_;	2185	my ($pw, $exit_status) = @_;
1924	...	2186	...
1925	});	2187	});
1926		2188
1927	=over 4	2189	=over 4
1928		2190
1929	=item $pw = new urxvt::pw	2191	=item $pw = new urxvt::pw
1930		2192
…		…
1934		2196
1935	Set the callback to be called when the timer triggers.	2197	Set the callback to be called when the timer triggers.
1936		2198
1937	=item $pw = $timer->start ($pid)	2199	=item $pw = $timer->start ($pid)
1938		2200
1939	Tells the wqtcher to start watching for process C<$pid>.	2201	Tells the watcher to start watching for process C<$pid>.
1940		2202
1941	=item $pw = $pw->stop	2203	=item $pw = $pw->stop
1942		2204
1943	Stop the watcher.	2205	Stop the watcher.
1944		2206
…		…
1957		2219
1958	=item >= 3 - script loading and management	2220	=item >= 3 - script loading and management
1959		2221
1960	=item >=10 - all called hooks	2222	=item >=10 - all called hooks
1961		2223
1962	=item >=11 - hook reutrn values	2224	=item >=11 - hook return values
1963		2225
1964	=back	2226	=back
1965		2227
1966	=head1 AUTHOR	2228	=head1 AUTHOR
1967		2229
…		…
1969	http://software.schmorp.de/pkg/rxvt-unicode	2231	http://software.schmorp.de/pkg/rxvt-unicode
1970		2232
1971	=cut	2233	=cut
1972		2234
1973	1	2235	1
		2236
		2237	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.124 by root, Sun Jan 22 11:57:06 2006 UTC vs. Revision 1.182 by sf-exg, Wed Feb 17 08:27:56 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.124 by root, Sun Jan 22 11:57:06 2006 UTC vs.
Revision 1.182 by sf-exg, Wed Feb 17 08:27:56 2010 UTC