[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.199 by sf-exg, Sun Nov 20 10:49:56 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: \\\|([^\|]+)\\\|
		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 or a list of matches
211	to the window position, in effect creating the same effect as pseudo transparency with	265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
212	a custom pixmap. No scaling is supported in this mode. Exmaple:	266	"perl:matcher:list" as seen in the example below.
213		267
214	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	268	Example configuration:
		269
		270	URxvt.perl-ext: default,matcher
		271	URxvt.urlLauncher: sensible-browser
		272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
		274	URxvt.matcher.button: 1
		275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		277	URxvt.matcher.launcher.2: gvim +$2 $1
		278
		279	=item xim-onthespot
		280
		281	This (experimental) perl extension implements OnTheSpot editing. It does
		282	not work perfectly, and some input methods don't seem to work well with
		283	OnTheSpot editing in general, but it seems to work at least for SCIM and
		284	kinput2.
		285
		286	You enable it by specifying this extension and a preedit style of
		287	C<OnTheSpot>, i.e.:
		288
		289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		290
		291	=item kuake<hotkey>
		292
		293	A very primitive quake-console-like extension. It was inspired by a
		294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		295	user presses a global accelerator key (by default C<F10>), the terminal
		296	will show or hide itself. Another press of the accelerator key will hide
		297	or show it again.
		298
		299	Initially, the window will not be shown when using this extension.
		300
		301	This is useful if you need a single terminal that is not using any desktop
		302	space most of the time but is quickly available at the press of a key.
		303
		304	The accelerator key is grabbed regardless of any modifiers, so this
		305	extension will actually grab a physical key just for this function.
		306
		307	If you want a quake-like animation, tell your window manager to do so
		308	(fvwm can do it).
		309
		310	=item overlay-osc
		311
		312	This extension implements some OSC commands to display timed popups on the
		313	screen - useful for status displays from within scripts. You have to read
		314	the sources for more info.
215		315
216	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
217		317
218	A not very useful example of filtering all text output to the terminal,	318	A not very useful example of filtering all text output to the terminal
219	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
220	similar-looking ascii character.	320	similar-looking ascii character.
221		321
222	=item digital-clock	322	=item digital-clock
223		323
224	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
		325
		326	=item remote-clipboard
		327
		328	Somewhat of a misnomer, this extension adds two menu entries to the
		329	selection popup that allows one to run external commands to store the
		330	selection somewhere and fetch it again.
		331
		332	We use it to implement a "distributed selection mechanism", which just
		333	means that one command uploads the file to a remote server, and another
		334	reads it.
		335
		336	The commands can be set using the C<URxvt.remote-selection.store> and
		337	C<URxvt.remote-selection.fetch> resources. The first should read the
		338	selection to store from STDIN (always in UTF-8), the second should provide
		339	the selection data on STDOUT (also in UTF-8).
		340
		341	The defaults (which are likely useless to you) use rsh and cat:
		342
		343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		345
		346	=item selection-pastebin
		347
		348	This is a little rarely useful extension that uploads the selection as
		349	textfile to a remote site (or does other things). (The implementation is
		350	not currently secure for use in a multiuser environment as it writes to
		351	F</tmp> directly.).
		352
		353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		354	i.e.
		355
		356	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		357
		358	Pressing this combination runs a command with C<%> replaced by the name of
		359	the textfile. This command can be set via a resource:
		360
		361	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		362
		363	And the default is likely not useful to anybody but the few people around
		364	here :)
		365
		366	The name of the textfile is the hex encoded md5 sum of the selection, so
		367	the same content should lead to the same filename.
		368
		369	After a successful upload the selection will be replaced by the text given
		370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		371	for the filename):
		372
		373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		374
		375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		376	the double C</> characters as comment start. Use C<\057\057> instead,
		377	which works regardless of whether xrdb is used to parse the resource file
		378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
225		393
226	=item example-refresh-hooks	394	=item example-refresh-hooks
227		395
228	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
229	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
230	overlays or changes.	398	overlays or changes.
231		399
232	=item selection-pastebin	400	=item confirm-paste
233		401
234	This is a little rarely useful extension that Uploads the selection as	402	Displays a confirmation dialog when a paste containing at least a full
235	textfile to a remote site (or does other things). (The implementation is	403	line is detected.
236	not currently secure for use in a multiuser environment as it writes to
237	F</tmp> directly.).
238		404
239	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	405	=item bell-command
240	i.e.
241		406
242	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin	407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
243		410
244	Pressing this combination runs a command with C<%> replaced by the name of	411	URxvt.bell-command: notify-send "Beep, Beep"
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		412
261	=back	413	=back
262		414
263	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
264		416
…		…
280		432
281	=over 4	433	=over 4
282		434
283	=item $text	435	=item $text
284		436
285	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	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.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
287		439
288	=item $string	440	=item $string
289		441
290	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
298		450
299	=back	451	=back
300		452
301	=head2 Extension Objects	453	=head2 Extension Objects
302		454
303	Very perl extension is a perl class. A separate perl object is created	455	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	456	for each terminal, and each terminal has its own set of extension objects,
305	hooks. So extensions can use their C<$self> object without having to think	457	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	458	their C<$self> object without having to think about clashes with other
		459	extensions or other terminals, with the exception of methods and members
307	begin with an underscore character C<_>: these are reserved for internal	460	that begin with an underscore character C<_>: these are reserved for
308	use.	461	internal use.
309		462
310	Although it isn't a C<urxvt::term> object, you can call all methods of the	463	Although it isn't a C<urxvt::term> object, you can call all methods of the
311	C<urxvt::term> class on this object.	464	C<urxvt::term> class on this object.
312		465
313	It has the following methods and data members:	466	It has the following methods and data members:
…		…
334	=head2 Hooks	487	=head2 Hooks
335		488
336	The following subroutines can be declared in extension files, and will be	489	The following subroutines can be declared in extension files, and will be
337	called whenever the relevant event happens.	490	called whenever the relevant event happens.
338		491
339	The first argument passed to them is an extension oject as described in	492	The first argument passed to them is an extension object as described in
340	the in the C<Extension Objects> section.	493	the in the C<Extension Objects> section.
341		494
342	B<All> of these hooks must return a boolean value. If any of the called	495	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	496	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.	497	relevant action might not be carried out by the C++ code.
…		…
357	place.	510	place.
358		511
359	=item on_start $term	512	=item on_start $term
360		513
361	Called at the very end of initialisation of a new terminal, just before	514	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.	515	trying to map (display) the toplevel and returning to the main loop.
363		516
364	=item on_destroy $term	517	=item on_destroy $term
365		518
366	Called whenever something tries to destroy terminal, before doing anything	519	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	520	still fully functional (not for long, though).
368	rarely a good idea.
369		521
370	=item on_reset $term	522	=item on_reset $term
371		523
372	Called after the screen is "reset" for any reason, such as resizing or	524	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	525	control sequences. Here is where you can react on changes to size-related
…		…
395		547
396	Called whenever a selection has been copied, but before the selection is	548	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	549	requested from the server. The selection text can be queried and changed
398	by calling C<< $term->selection >>.	550	by calling C<< $term->selection >>.
399		551
400	Returning a true value aborts selection grabbing. It will still be hilighted.	552	Returning a true value aborts selection grabbing. It will still be highlighted.
401		553
402	=item on_sel_extend $term	554	=item on_sel_extend $term
403		555
404	Called whenever the user tries to extend the selection (e.g. with a double	556	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	557	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	558	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	559	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	560	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.	561	supposed to enlarge the selection more and more, if possible.
410		562
411	See the F<selection> example extension.	563	See the F<selection> example extension.
412		564
413	=item on_view_change $term, $offset	565	=item on_view_change $term, $offset
414		566
415	Called whenever the view offset changes, i..e the user or program	567	Called whenever the view offset changes, i.e. the user or program
416	scrolls. Offset C<0> means display the normal terminal, positive values	568	scrolls. Offset C<0> means display the normal terminal, positive values
417	show this many lines of scrollback.	569	show this many lines of scrollback.
418		570
419	=item on_scroll_back $term, $lines, $saved	571	=item on_scroll_back $term, $lines, $saved
420		572
…		…
424		576
425	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	577	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	578	$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.	579	number of lines that will be in the scrollback buffer.
428		580
429	=item on_osc_seq $term, $string	581	=item on_osc_seq $term, $op, $args, $resp
		582
		583	Called on every OSC sequence and can be used to suppress it or modify its
		584	behaviour. The default should be to return an empty list. A true value
		585	suppresses execution of the request completely. Make sure you don't get
		586	confused by recursive invocations when you output an OSC sequence within
		587	this callback.
		588
		589	C<on_osc_seq_perl> should be used for new behaviour.
		590
		591	=item on_osc_seq_perl $term, $args, $resp
430		592
431	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	593	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
432	operating system command) is processed. Cursor position and other state	594	operating system command) is processed. Cursor position and other state
433	information is up-to-date when this happens. For interoperability, the	595	information is up-to-date when this happens. For interoperability, the
434	string should start with the extension name and a colon, to distinguish	596	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	597	to distinguish it from commands for other extensions, and this might be
436	future.	598	enforced in the future.
		599
		600	For example, C<overlay-osc> uses this:
		601
		602	sub on_osc_seq_perl {
		603	my ($self, $osc, $resp) = @_;
		604
		605	return unless $osc =~ s/^overlay;//;
		606
		607	... process remaining $osc string
		608	}
437		609
438	Be careful not ever to trust (in a security sense) the data you receive,	610	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	611	as its source can not easily be controlled (e-mail content, messages from
440	other users on the same system etc.).	612	other users on the same system etc.).
		613
		614	For responses, C<$resp> contains the end-of-args separator used by the
		615	sender.
441		616
442	=item on_add_lines $term, $string	617	=item on_add_lines $term, $string
443		618
444	Called whenever text is about to be output, with the text as argument. You	619	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	620	can filter/change and output the text yourself by returning a true value
…		…
450	=item on_tt_write $term, $octets	625	=item on_tt_write $term, $octets
451		626
452	Called whenever some data is written to the tty/pty and can be used to	627	Called whenever some data is written to the tty/pty and can be used to
453	suppress or filter tty input.	628	suppress or filter tty input.
454		629
		630	=item on_tt_paste $term, $octets
		631
		632	Called whenever text is about to be pasted, with the text as argument. You
		633	can filter/change and paste the text yourself by returning a true value
		634	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		635	locale-encoded.
		636
455	=item on_line_update $term, $row	637	=item on_line_update $term, $row
456		638
457	Called whenever a line was updated or changed. Can be used to filter	639	Called whenever a line was updated or changed. Can be used to filter
458	screen output (e.g. underline urls or other useless stuff). Only lines	640	screen output (e.g. underline urls or other useless stuff). Only lines
459	that are being shown will be filtered, and, due to performance reasons,	641	that are being shown will be filtered, and, due to performance reasons,
…		…
466	later with the already-modified line (e.g. if unrelated parts change), so	648	later with the already-modified line (e.g. if unrelated parts change), so
467	you cannot just toggle rendition bits, but only set them.	649	you cannot just toggle rendition bits, but only set them.
468		650
469	=item on_refresh_begin $term	651	=item on_refresh_begin $term
470		652
471	Called just before the screen gets redrawn. Can be used for overlay	653	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	654	similar effects by modifying the terminal contents in refresh_begin, and
473	restoring them in refresh_end. The built-in overlay and selection display	655	restoring them in refresh_end. The built-in overlay and selection display
474	code is run after this hook, and takes precedence.	656	code is run after this hook, and takes precedence.
475		657
476	=item on_refresh_end $term	658	=item on_refresh_end $term
477		659
478	Called just after the screen gets redrawn. See C<on_refresh_begin>.	660	Called just after the screen gets redrawn. See C<on_refresh_begin>.
479		661
480	=item on_keyboard_command $term, $string	662	=item on_user_command $term, $string
481		663
482	Called whenever the user presses a key combination that has a	664	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>	665	a C<perl:string> action bound to a key, see description of the B<keysym>
484	resource in the @@RXVT_NAME@@(1) manpage).	666	resource in the @@RXVT_NAME@@(1) manpage).
		667
		668	The event is simply the action string. This interface is assumed to change
		669	slightly in the future.
		670
		671	=item on_resize_all_windows $term, $new_width, $new_height
		672
		673	Called just after the new window size has been calculated, but before
		674	windows are actually being resized or hints are being set. If this hook
		675	returns TRUE, setting of the window hints is being skipped.
485		676
486	=item on_x_event $term, $event	677	=item on_x_event $term, $event
487		678
488	Called on every X event received on the vt window (and possibly other	679	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	680	windows). Should only be used as a last resort. Most event structure
490	members are not passed.	681	members are not passed.
491		682
		683	=item on_root_event $term, $event
		684
		685	Like C<on_x_event>, but is called for events on the root window.
		686
492	=item on_focus_in $term	687	=item on_focus_in $term
493		688
494	Called whenever the window gets the keyboard focus, before rxvt-unicode	689	Called whenever the window gets the keyboard focus, before rxvt-unicode
495	does focus in processing.	690	does focus in processing.
496		691
497	=item on_focus_out $term	692	=item on_focus_out $term
498		693
499	Called wheneever the window loses keyboard focus, before rxvt-unicode does	694	Called whenever the window loses keyboard focus, before rxvt-unicode does
500	focus out processing.	695	focus out processing.
501		696
502	=item on_configure_notify $term, $event	697	=item on_configure_notify $term, $event
503		698
504	=item on_property_notify $term, $event	699	=item on_property_notify $term, $event
…		…
515		710
516	=item on_map_notify $term, $event	711	=item on_map_notify $term, $event
517		712
518	=item on_unmap_notify $term, $event	713	=item on_unmap_notify $term, $event
519		714
520	Called whenever the corresponding X event is received for the terminal If	715	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.	716	the hook returns true, then the event will be ignored by rxvt-unicode.
522		717
523	The event is a hash with most values as named by Xlib (see the XEvent	718	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	719	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.	720	(real, not screen-based) row and column under the mouse cursor.
526		721
…		…
535		730
536	=item on_wm_delete_window $term, $event	731	=item on_wm_delete_window $term, $event
537		732
538	Called when various types of ClientMessage events are received (all with	733	Called when various types of ClientMessage events are received (all with
539	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	734	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		735
		736	=item on_bell $term
		737
		738	Called on receipt of a bell character.
540		739
541	=back	740	=back
542		741
543	=cut	742	=cut
544		743
…		…
587	The current terminal. This variable stores the current C<urxvt::term>	786	The current terminal. This variable stores the current C<urxvt::term>
588	object, whenever a callback/hook is executing.	787	object, whenever a callback/hook is executing.
589		788
590	=item @urxvt::TERM_INIT	789	=item @urxvt::TERM_INIT
591		790
592	All coderefs in this array will be called as methods of the next newly	791	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	792	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,	793	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.	794	so references can push themselves onto it again if they so desire.
596		795
597	This complements to the perl-eval commandline option, but gets executed	796	This complements to the perl-eval command line option, but gets executed
598	first.	797	first.
599		798
600	=item @urxvt::TERM_EXT	799	=item @urxvt::TERM_EXT
601		800
602	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	801	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
609		808
610	=over 4	809	=over 4
611		810
612	=item urxvt::fatal $errormessage	811	=item urxvt::fatal $errormessage
613		812
614	Fatally aborts execution with the given error message. Avoid at all	813	Fatally aborts execution with the given error message (which should
615	costs! The only time this is acceptable is when the terminal process	814	include a trailing newline). Avoid at all costs! The only time this
616	starts up.	815	is acceptable (and useful) is in the init hook, where it prevents the
		816	terminal from starting up.
617		817
618	=item urxvt::warn $string	818	=item urxvt::warn $string
619		819
620	Calls C<rxvt_warn> with the given string which should not include a	820	Calls C<rxvt_warn> with the given string which should include a trailing
621	newline. The module also overwrites the C<warn> builtin with a function	821	newline. The module also overwrites the C<warn> builtin with a function
622	that calls this function.	822	that calls this function.
623		823
624	Using this function has the advantage that its output ends up in the	824	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.	825	correct place, e.g. on stderr of the connecting urxvtc client.
626		826
627	Messages have a size limit of 1023 bytes currently.	827	Messages have a size limit of 1023 bytes currently.
		828
		829	=item @terms = urxvt::termlist
		830
		831	Returns all urxvt::term objects that exist in this process, regardless of
		832	whether they are started, being destroyed etc., so be careful. Only term
		833	objects that have perl extensions attached will be returned (because there
		834	is no urxvt::term object associated with others).
628		835
629	=item $time = urxvt::NOW	836	=item $time = urxvt::NOW
630		837
631	Returns the "current time" (as per the event loop).	838	Returns the "current time" (as per the event loop).
632		839
…		…
675		882
676	=item $rend = urxvt::OVERLAY_RSTYLE	883	=item $rend = urxvt::OVERLAY_RSTYLE
677		884
678	Return the rendition mask used for overlays by default.	885	Return the rendition mask used for overlays by default.
679		886
680	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	887	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		888	urxvt::RS_RVid, urxvt::RS_Uline
681		889
682	Return the bit that enabled bold, italic, blink, reverse-video and	890	Return the bit that enabled bold, italic, blink, reverse-video and
683	underline, respectively. To enable such a style, just logically OR it into	891	underline, respectively. To enable such a style, just logically OR it into
684	the bitset.	892	the bitset.
685		893
…		…
690	Return the foreground/background colour index, respectively.	898	Return the foreground/background colour index, respectively.
691		899
692	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	900	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
693		901
694	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	902	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		903
		904	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
695		905
696	Replace the foreground/background colour in the rendition mask with the	906	Replace the foreground/background colour in the rendition mask with the
697	specified one.	907	specified one.
698		908
699	=item $value = urxvt::GET_CUSTOM $rend	909	=item $value = urxvt::GET_CUSTOM $rend
…		…
766	local $TERM = shift;	976	local $TERM = shift;
767	my $htype = shift;	977	my $htype = shift;
768		978
769	if ($htype == 0) { # INIT	979	if ($htype == 0) { # INIT
770	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	980	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
771		981
772	my %ext_arg;	982	my %ext_arg;
773		983
774	{	984	{
775	my @init = @TERM_INIT;	985	my @init = @TERM_INIT;
776	@TERM_INIT = ();	986	@TERM_INIT = ();
…		…
790	} else {	1000	} else {
791	$ext_arg{$_} \|\|= [];	1001	$ext_arg{$_} \|\|= [];
792	}	1002	}
793	}	1003	}
794		1004
795	while (my ($ext, $argv) = each %ext_arg) {	1005	for my $ext (sort keys %ext_arg) {
796	my @files = grep -f $_, map "$_/$ext", @dirs;	1006	my @files = grep -f $_, map "$_/$ext", @dirs;
797		1007
798	if (@files) {	1008	if (@files) {
799	$TERM->register_package (extension_package $files[0], $argv);	1009	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
800	} else {	1010	} else {
801	warn "perl extension '$ext' not found in perl library search path\n";	1011	warn "perl extension '$ext' not found in perl library search path\n";
802	}	1012	}
803	}	1013	}
804		1014
…		…
810		1020
811	if (my $cb = $TERM->{_hook}[$htype]) {	1021	if (my $cb = $TERM->{_hook}[$htype]) {
812	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1022	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
813	if $verbosity >= 10;	1023	if $verbosity >= 10;
814		1024
815	keys %$cb;	1025	for my $pkg (keys %$cb) {
816
817	while (my ($pkg, $cb) = each %$cb) {
818	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1026	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
819	$retval \|\|= $retval_;	1027	$retval \|\|= $retval_;
820		1028
821	if ($@) {	1029	if ($@) {
822	$TERM->ungrab; # better to lose the grab than the session	1030	$TERM->ungrab; # better to lose the grab than the session
823	warn $@;	1031	warn $@;
…		…
835	# clear package	1043	# clear package
836	%$TERM = ();	1044	%$TERM = ();
837	}	1045	}
838		1046
839	$retval	1047	$retval
		1048	}
		1049
		1050	sub SET_COLOR($$$) {
		1051	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1052	}
		1053
		1054	sub rend2mask {
		1055	no strict 'refs';
		1056	my ($str, $mask) = (@_, 0);
		1057	my %color = ( fg => undef, bg => undef );
		1058	my @failed;
		1059	for my $spec ( split /\s+/, $str ) {
		1060	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1061	$color{lc($1)} = $2;
		1062	} else {
		1063	my $neg = $spec =~ s/^[-^]//;
		1064	unless ( exists &{"RS_$spec"} ) {
		1065	push @failed, $spec;
		1066	next;
		1067	}
		1068	my $cur = &{"RS_$spec"};
		1069	if ( $neg ) {
		1070	$mask &= ~$cur;
		1071	} else {
		1072	$mask \|= $cur;
		1073	}
		1074	}
		1075	}
		1076	($mask, @color{qw(fg bg)}, \@failed)
840	}	1077	}
841		1078
842	# urxvt::term::extension	1079	# urxvt::term::extension
843		1080
844	package urxvt::term::extension;	1081	package urxvt::term::extension;
…		…
915	is that you cannot use blocking APIs, but the non-blocking variant should	1152	is that you cannot use blocking APIs, but the non-blocking variant should
916	work.	1153	work.
917		1154
918	=cut	1155	=cut
919		1156
920	our $VERSION = 1;	1157	our $VERSION = '5.23';
921		1158
922	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1159	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
923	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1160	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
924		1161
925	sub timer {	1162	sub timer {
…		…
927		1164
928	my $cb = $arg{cb};	1165	my $cb = $arg{cb};
929		1166
930	urxvt::timer	1167	urxvt::timer
931	->new	1168	->new
932	->start (urxvt::NOW + $arg{after})	1169	->after ($arg{after}, $arg{interval})
933	->cb (sub {	1170	->cb ($arg{interval} ? $cb : sub {
934	$_[0]->stop; # need to cancel manually	1171	$_[0]->stop; # need to cancel manually
935	$cb->();	1172	$cb->();
936	})	1173	})
937	}	1174	}
938		1175
939	sub io {	1176	sub io {
940	my ($class, %arg) = @_;	1177	my ($class, %arg) = @_;
941		1178
942	my $cb = $arg{cb};	1179	my $cb = $arg{cb};
		1180	my $fd = fileno $arg{fh};
		1181	defined $fd or $fd = $arg{fh};
943		1182
944	bless [$arg{fh}, urxvt::iow	1183	bless [$arg{fh}, urxvt::iow
945	->new	1184	->new
946	->fd (fileno $arg{fh})	1185	->fd ($fd)
947	->events (($arg{poll} =~ /r/ ? 1 : 0)	1186	->events (($arg{poll} =~ /r/ ? 1 : 0)
948	\| ($arg{poll} =~ /w/ ? 2 : 0))	1187	\| ($arg{poll} =~ /w/ ? 2 : 0))
949	->start	1188	->start
950	->cb (sub {	1189	->cb ($cb)
951	$cb->(($_[1] & 1 ? 'r' : '')
952	. ($_[1] & 2 ? 'w' : ''));
953	})],
954	urxvt::anyevent::	1190	], urxvt::anyevent::
		1191	}
		1192
		1193	sub idle {
		1194	my ($class, %arg) = @_;
		1195
		1196	my $cb = $arg{cb};
		1197
		1198	urxvt::iw
		1199	->new
		1200	->start
		1201	->cb ($cb)
		1202	}
		1203
		1204	sub child {
		1205	my ($class, %arg) = @_;
		1206
		1207	my $cb = $arg{cb};
		1208
		1209	urxvt::pw
		1210	->new
		1211	->start ($arg{pid})
		1212	->cb (sub {
		1213	$_[0]->stop; # need to cancel manually
		1214	$cb->($_[0]->rpid, $_[0]->rstatus);
		1215	})
955	}	1216	}
956		1217
957	sub DESTROY {	1218	sub DESTROY {
958	$_[0][1]->stop;	1219	$_[0][1]->stop;
959	}	1220	}
960		1221
961	sub condvar {	1222	# only needed for AnyEvent < 6 compatibility
962	bless \my $flag, urxvt::anyevent::condvar::	1223	sub one_event {
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";	1224	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
972	}
973	}	1225	}
974		1226
975	package urxvt::term;	1227	package urxvt::term;
976		1228
977	=head2 The C<urxvt::term> Class	1229	=head2 The C<urxvt::term> Class
…		…
1013	hash which defines the environment of the new terminal.	1265	hash which defines the environment of the new terminal.
1014		1266
1015	Croaks (and probably outputs an error message) if the new instance	1267	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	1268	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	1269	initialise perl, and the terminal object otherwise. The C<init> and
1018	C<start> hooks will be called during this call.	1270	C<start> hooks will be called before this call returns, and are free to
		1271	refer to global data (which is race free).
1019		1272
1020	=cut	1273	=cut
1021		1274
1022	sub new {	1275	sub new {
1023	my ($class, $env, @args) = @_;	1276	my ($class, $env, @args) = @_;
1024		1277
		1278	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1279	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1280
1025	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1281	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1026	}	1282	}
1027		1283
1028	=item $term->destroy	1284	=item $term->destroy
1029		1285
1030	Destroy the terminal object (close the window, free resources	1286	Destroy the terminal object (close the window, free resources
…		…
1060		1316
1061	Returns true if the option specified by C<$optval> is enabled, and	1317	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	1318	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.	1319	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1064		1320
1065	Here is a a likely non-exhaustive list of option names, please see the	1321	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:	1322	source file F</src/optinc.h> to see the actual list:
1067		1323
1068	borderLess console cursorBlink cursorUnderline hold iconic insecure	1324	borderLess buffered console cursorBlink cursorUnderline hold iconic
1069	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1325	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1070	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1326	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1071	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1327	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1072	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1328	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1073	transparent tripleclickwords utmpInhibit visualBell	1329	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1330	urgentOnBell utmpInhibit visualBell
1074		1331
1075	=item $value = $term->resource ($name[, $newval])	1332	=item $value = $term->resource ($name[, $newval])
1076		1333
1077	Returns the current resource value associated with a given name and	1334	Returns the current resource value associated with a given name and
1078	optionally sets a new value. Setting values is most useful in the C<init>	1335	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1087	likely change).	1344	likely change).
1088		1345
1089	Please note that resource strings will currently only be freed when the	1346	Please note that resource strings will currently only be freed when the
1090	terminal is destroyed, so changing options frequently will eat memory.	1347	terminal is destroyed, so changing options frequently will eat memory.
1091		1348
1092	Here is a a likely non-exhaustive list of resource names, not all of which	1349	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>	1350	are supported in every build, please see the source file F</src/rsinc.h>
1094	to see the actual list:	1351	to see the actual list:
1095		1352
1096	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1353	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1097	borderLess color cursorBlink cursorUnderline cutchars delete_key	1354	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1098	display_name embed ext_bwidth fade font geometry hold iconName	1355	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1099	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1356	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1357	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1100	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1358	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1101	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1359	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1102	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1360	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1103	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1361	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1104	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1362	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1105	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1363	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1106	secondaryScreen secondaryScroll selectstyle shade term_name title	1364	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1107	transient_for transparent transparent_all tripleclickwords utmpInhibit	1365	term_name title transient_for transparent tripleclickwords urgentOnBell
1108	visualBell	1366	utmpInhibit visualBell
1109		1367
1110	=cut	1368	=cut
1111		1369
1112	sub resource($$;$) {	1370	sub resource($$;$) {
1113	my ($self, $name) = (shift, shift);	1371	my ($self, $name) = (shift, shift);
1114	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1372	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1115	&urxvt::term::_resource	1373	goto &urxvt::term::_resource
1116	}	1374	}
1117		1375
1118	=item $value = $term->x_resource ($pattern)	1376	=item $value = $term->x_resource ($pattern)
1119		1377
1120	Returns the X-Resource for the given pattern, excluding the program or	1378	Returns the X-Resource for the given pattern, excluding the program or
…		…
1145		1403
1146	=item ($row, $col) = $term->selection_beg ([$row, $col])	1404	=item ($row, $col) = $term->selection_beg ([$row, $col])
1147		1405
1148	=item ($row, $col) = $term->selection_end ([$row, $col])	1406	=item ($row, $col) = $term->selection_end ([$row, $col])
1149		1407
1150	Return the current values of the selection mark, begin or end positions,	1408	Return the current values of the selection mark, begin or end positions.
1151	and optionally set them to new values.	1409
		1410	When arguments are given, then the selection coordinates are set to
		1411	C<$row> and C<$col>, and the selection screen is set to the current
		1412	screen.
		1413
		1414	=item $screen = $term->selection_screen ([$screen])
		1415
		1416	Returns the current selection screen, and then optionally sets it.
1152		1417
1153	=item $term->selection_make ($eventtime[, $rectangular])	1418	=item $term->selection_make ($eventtime[, $rectangular])
1154		1419
1155	Tries to make a selection as set by C<selection_beg> and	1420	Tries to make a selection as set by C<selection_beg> and
1156	C<selection_end>. If C<$rectangular> is true (default: false), a	1421	C<selection_end>. If C<$rectangular> is true (default: false), a
1157	rectangular selection will be made. This is the prefered function to make	1422	rectangular selection will be made. This is the preferred function to make
1158	a selection.	1423	a selection.
1159		1424
1160	=item $success = $term->selection_grab ($eventtime)	1425	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1161		1426
1162	Try to request the primary selection text from the server (for example, as	1427	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1428	true) selection from the server. The corresponding text can be set
1163	set by the next method). No visual feedback will be given. This function	1429	with the next method. No visual feedback will be given. This function
1164	is mostly useful from within C<on_sel_grab> hooks.	1430	is mostly useful from within C<on_sel_grab> hooks.
1165		1431
1166	=item $oldtext = $term->selection ([$newtext])	1432	=item $oldtext = $term->selection ([$newtext, $clipboard])
1167		1433
1168	Return the current selection text and optionally replace it by C<$newtext>.	1434	Return the current selection (clipboard if C<$clipboard> is true) text
		1435	and optionally replace it by C<$newtext>.
		1436
		1437	=item $term->selection_clear ([$clipboard])
		1438
		1439	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1169		1440
1170	=item $term->overlay_simple ($x, $y, $text)	1441	=item $term->overlay_simple ($x, $y, $text)
1171		1442
1172	Create a simple multi-line overlay box. See the next method for details.	1443	Create a simple multi-line overlay box. See the next method for details.
1173		1444
…		…
1203		1474
1204	The methods currently supported on C<urxvt::overlay> objects are:	1475	The methods currently supported on C<urxvt::overlay> objects are:
1205		1476
1206	=over 4	1477	=over 4
1207		1478
1208	=item $overlay->set ($x, $y, $text, $rend)	1479	=item $overlay->set ($x, $y, $text[, $rend])
1209		1480
1210	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1481	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	1482	text in rxvt-unicode's special encoding and an array of rendition values
1212	at a specific position inside the overlay.	1483	at a specific position inside the overlay.
		1484
		1485	If C<$rend> is missing, then the rendition will not be changed.
1213		1486
1214	=item $overlay->hide	1487	=item $overlay->hide
1215		1488
1216	If visible, hide the overlay, but do not destroy it.	1489	If visible, hide the overlay, but do not destroy it.
1217		1490
…		…
1299	locale-specific encoding of the terminal and can contain command sequences	1572	locale-specific encoding of the terminal and can contain command sequences
1300	(escape codes) that will be interpreted.	1573	(escape codes) that will be interpreted.
1301		1574
1302	=item $term->tt_write ($octets)	1575	=item $term->tt_write ($octets)
1303		1576
1304	Write the octets given in C<$data> to the tty (i.e. as program input). To	1577	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1305	pass characters instead of octets, you should convert your strings first	1578	pass characters instead of octets, you should convert your strings first
1306	to the locale-specific encoding using C<< $term->locale_encode >>.	1579	to the locale-specific encoding using C<< $term->locale_encode >>.
		1580
		1581	=item $term->tt_paste ($octets)
		1582
		1583	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1584	CR and bracketing the data with control sequences if bracketed paste mode
		1585	is set.
1307		1586
1308	=item $old_events = $term->pty_ev_events ([$new_events])	1587	=item $old_events = $term->pty_ev_events ([$new_events])
1309		1588
1310	Replaces the event mask of the pty watcher by the given event mask. Can	1589	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	1590	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	1591	description of C<< urxvt::timer->events >>. Make sure to always restore
1313	the previous value.	1592	the previous value.
1314		1593
		1594	=item $fd = $term->pty_fd
		1595
		1596	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1597	is used.
		1598
1315	=item $windowid = $term->parent	1599	=item $windowid = $term->parent
1316		1600
1317	Return the window id of the toplevel window.	1601	Return the window id of the toplevel window.
1318		1602
1319	=item $windowid = $term->vt	1603	=item $windowid = $term->vt
…		…
1325	Adds the specified events to the vt event mask. Useful e.g. when you want	1609	Adds the specified events to the vt event mask. Useful e.g. when you want
1326	to receive pointer events all the times:	1610	to receive pointer events all the times:
1327		1611
1328	$term->vt_emask_add (urxvt::PointerMotionMask);	1612	$term->vt_emask_add (urxvt::PointerMotionMask);
1329		1613
		1614	=item $term->focus_in
		1615
		1616	=item $term->focus_out
		1617
		1618	=item $term->key_press ($state, $keycode[, $time])
		1619
		1620	=item $term->key_release ($state, $keycode[, $time])
		1621
		1622	Deliver various fake events to to terminal.
		1623
1330	=item $window_width = $term->width	1624	=item $window_width = $term->width
1331		1625
1332	=item $window_height = $term->height	1626	=item $window_height = $term->height
1333		1627
1334	=item $font_width = $term->fwidth	1628	=item $font_width = $term->fwidth
…		…
1364	=item $env = $term->env	1658	=item $env = $term->env
1365		1659
1366	Returns a copy of the environment in effect for the terminal as a hashref	1660	Returns a copy of the environment in effect for the terminal as a hashref
1367	similar to C<\%ENV>.	1661	similar to C<\%ENV>.
1368		1662
		1663	=item @envv = $term->envv
		1664
		1665	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1666
		1667	=item @argv = $term->argv
		1668
		1669	Return the argument vector as this terminal, similar to @ARGV, but
		1670	includes the program name as first element.
		1671
1369	=cut	1672	=cut
1370		1673
1371	sub env {	1674	sub env {
1372	if (my $env = $_[0]->_env) {
1373	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1675	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1374	} else {
1375	+{ %ENV }
1376	}
1377	}	1676	}
1378		1677
1379	=item $modifiermask = $term->ModLevel3Mask	1678	=item $modifiermask = $term->ModLevel3Mask
1380		1679
1381	=item $modifiermask = $term->ModMetaMask	1680	=item $modifiermask = $term->ModMetaMask
…		…
1389		1688
1390	Returns the currently displayed screen (0 primary, 1 secondary).	1689	Returns the currently displayed screen (0 primary, 1 secondary).
1391		1690
1392	=item $cursor_is_hidden = $term->hidden_cursor	1691	=item $cursor_is_hidden = $term->hidden_cursor
1393		1692
1394	Returns wether the cursor is currently hidden or not.	1693	Returns whether the cursor is currently hidden or not.
1395		1694
1396	=item $view_start = $term->view_start ([$newvalue])	1695	=item $view_start = $term->view_start ([$newvalue])
1397		1696
1398	Returns the row number of the topmost displayed line. Maximum value is	1697	Returns the row number of the topmost displayed line. Maximum value is
1399	C<0>, which displays the normal terminal contents. Lower values scroll	1698	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1407		1706
1408	Used after changing terminal contents to display them.	1707	Used after changing terminal contents to display them.
1409		1708
1410	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1709	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1411		1710
1412	Returns the text of the entire row with number C<$row_number>. Row C<0>	1711	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	1712	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	1713	terminal line. Nothing will be returned if a nonexistent line
1416	is requested.	1714	is requested.
1417		1715
1418	If C<$new_text> is specified, it will replace characters in the current	1716	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	1717	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	1718	to replace only parts of a line. The font index in the rendition will
1421	automatically be updated.	1719	automatically be updated.
1422		1720
1423	C<$text> is in a special encoding: tabs and wide characters that use more	1721	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)	1722	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1425	characters. Characters with combining characters and other characters that	1723	characters. Characters with combining characters and other characters that
1426	do not fit into the normal tetx encoding will be replaced with characters	1724	do not fit into the normal text encoding will be replaced with characters
1427	in the private use area.	1725	in the private use area.
1428		1726
1429	You have to obey this encoding when changing text. The advantage is	1727	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	1728	that C<substr> and similar functions work on screen cells and not on
1431	characters.	1729	characters.
…		…
1576	where one character corresponds to one screen cell. See	1874	where one character corresponds to one screen cell. See
1577	C<< $term->ROW_t >> for details.	1875	C<< $term->ROW_t >> for details.
1578		1876
1579	=item $string = $term->special_decode $text	1877	=item $string = $term->special_decode $text
1580		1878
1581	Converts rxvt-unicodes text reprsentation into a perl string. See	1879	Converts rxvt-unicodes text representation into a perl string. See
1582	C<< $term->ROW_t >> for details.	1880	C<< $term->ROW_t >> for details.
1583		1881
1584	=item $success = $term->grab_button ($button, $modifiermask)	1882	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1585		1883
		1884	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1885
1586	Registers a synchronous button grab. See the XGrabButton manpage.	1886	Register/unregister a synchronous button grab. See the XGrabButton
		1887	manpage.
1587		1888
1588	=item $success = $term->grab ($eventtime[, $sync])	1889	=item $success = $term->grab ($eventtime[, $sync])
1589		1890
1590	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1891	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1591	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1892	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1592		1893
1593	=item $term->allow_events_async	1894	=item $term->allow_events_async
1594		1895
1595	Calls XAllowEvents with AsyncBoth for the most recent grab.	1896	Calls XAllowEvents with AsyncBoth for the most recent grab.
1596		1897
…		…
1603	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1904	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1604	recent grab.	1905	recent grab.
1605		1906
1606	=item $term->ungrab	1907	=item $term->ungrab
1607		1908
1608	Calls XUngrab for the most recent grab. Is called automatically on	1909	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	1910	evaluation errors, as it is better to lose the grab in the error case as
1610	the session.	1911	the session.
1611		1912
1612	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1913	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1613		1914
…		…
1615		1916
1616	=item @atoms = $term->XListProperties ($window)	1917	=item @atoms = $term->XListProperties ($window)
1617		1918
1618	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1919	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1619		1920
1620	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1921	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1621		1922
1622	=item $term->XDeleteProperty ($window, $property)	1923	=item $term->XDeleteProperty ($window, $property)
1623		1924
1624	=item $window = $term->DefaultRootWindow	1925	=item $window = $term->DefaultRootWindow
1625		1926
…		…
1635		1936
1636	=item $term->XChangeInput ($window, $add_events[, $del_events])	1937	=item $term->XChangeInput ($window, $add_events[, $del_events])
1637		1938
1638	Various X or X-related functions. The C<$term> object only serves as	1939	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	1940	the source of the display, otherwise those functions map more-or-less
1640	directory onto the X functions of the same name.	1941	directly onto the X functions of the same name.
1641		1942
1642	=back	1943	=back
1643		1944
1644	=cut	1945	=cut
1645		1946
…		…
1709	my ($self, $text, $cb) = @_;	2010	my ($self, $text, $cb) = @_;
1710		2011
1711	$self->add_item ({ type => "button", text => $text, activate => $cb});	2012	$self->add_item ({ type => "button", text => $text, activate => $cb});
1712	}	2013	}
1713		2014
1714	=item $popup->add_toggle ($text, $cb, $initial_value)	2015	=item $popup->add_toggle ($text, $initial_value, $cb)
1715		2016
1716	Adds a toggle/checkbox item to the popup. Teh callback gets called	2017	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	2018	whenever it gets toggled, with a boolean indicating its new value as its
1718	argument.	2019	first argument.
1719		2020
1720	=cut	2021	=cut
1721		2022
1722	sub add_toggle {	2023	sub add_toggle {
1723	my ($self, $text, $cb, $value) = @_;	2024	my ($self, $text, $value, $cb) = @_;
1724		2025
1725	my $item; $item = {	2026	my $item; $item = {
1726	type => "button",	2027	type => "button",
1727	text => " $text",	2028	text => " $text",
1728	value => $value,	2029	value => $value,
…		…
1747	my $env = $self->{term}->env;	2048	my $env = $self->{term}->env;
1748	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2049	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1749	delete $env->{LC_ALL};	2050	delete $env->{LC_ALL};
1750	$env->{LC_CTYPE} = $self->{term}->locale;	2051	$env->{LC_CTYPE} = $self->{term}->locale;
1751		2052
1752	urxvt::term->new ($env, "popup",	2053	my $term = urxvt::term->new (
		2054	$env, "popup",
1753	"--perl-lib" => "", "--perl-ext-common" => "",	2055	"--perl-lib" => "", "--perl-ext-common" => "",
1754	"-pty-fd" => -1, "-sl" => 0,	2056	"-pty-fd" => -1, "-sl" => 0,
1755	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2057	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1756	"--transient-for" => $self->{term}->parent,	2058	"--transient-for" => $self->{term}->parent,
1757	"-display" => $self->{term}->display_id,	2059	"-display" => $self->{term}->display_id,
1758	"-pe" => "urxvt-popup")	2060	"-pe" => "urxvt-popup",
1759	or die "unable to create popup window\n";	2061	) or die "unable to create popup window\n";
		2062
		2063	unless (delete $term->{urxvt_popup_init_done}) {
		2064	$term->ungrab;
		2065	$term->destroy;
		2066	die "unable to initialise popup window\n";
		2067	}
1760	}	2068	}
1761		2069
1762	sub DESTROY {	2070	sub DESTROY {
1763	my ($self) = @_;	2071	my ($self) = @_;
1764		2072
…		…
1769	=back	2077	=back
1770		2078
1771	=cut	2079	=cut
1772		2080
1773	package urxvt::watcher;	2081	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		2082
1780	=head2 The C<urxvt::timer> Class	2083	=head2 The C<urxvt::timer> Class
1781		2084
1782	This class implements timer watchers/events. Time is represented as a	2085	This class implements timer watchers/events. Time is represented as a
1783	fractional number of seconds since the epoch. Example:	2086	fractional number of seconds since the epoch. Example:
…		…
1787	->new	2090	->new
1788	->interval (1)	2091	->interval (1)
1789	->cb (sub {	2092	->cb (sub {
1790	$term->{overlay}->set (0, 0,	2093	$term->{overlay}->set (0, 0,
1791	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2094	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1792	});	2095	});
1793		2096
1794	=over 4	2097	=over 4
1795		2098
1796	=item $timer = new urxvt::timer	2099	=item $timer = new urxvt::timer
1797		2100
…		…
1800		2103
1801	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2104	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1802		2105
1803	Set the callback to be called when the timer triggers.	2106	Set the callback to be called when the timer triggers.
1804		2107
1805	=item $tstamp = $timer->at
1806
1807	Return the time this watcher will fire next.
1808
1809	=item $timer = $timer->set ($tstamp)	2108	=item $timer = $timer->set ($tstamp[, $interval])
1810		2109
1811	Set the time the event is generated to $tstamp.	2110	Set the time the event is generated to $tstamp (and optionally specifies a
		2111	new $interval).
1812		2112
1813	=item $timer = $timer->interval ($interval)	2113	=item $timer = $timer->interval ($interval)
1814		2114
1815	Normally (and when C<$interval> is C<0>), the timer will automatically	2115	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	2116	stop after it has fired once. If C<$interval> is non-zero, then the timer
1817	is automatically rescheduled at the given intervals.	2117	is automatically rescheduled at the given intervals.
1818		2118
1819	=item $timer = $timer->start	2119	=item $timer = $timer->start
1820		2120
1821	Start the timer.	2121	Start the timer.
1822		2122
1823	=item $timer = $timer->start ($tstamp)	2123	=item $timer = $timer->start ($tstamp[, $interval])
1824		2124
1825	Set the event trigger time to C<$tstamp> and start the timer.	2125	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2126	also replaces the interval.
1826		2127
1827	=item $timer = $timer->after ($delay)	2128	=item $timer = $timer->after ($delay[, $interval])
1828		2129
1829	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2130	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1830		2131
1831	=item $timer = $timer->stop	2132	=item $timer = $timer->stop
1832		2133
…		…
1840		2141
1841	$term->{socket} = ...	2142	$term->{socket} = ...
1842	$term->{iow} = urxvt::iow	2143	$term->{iow} = urxvt::iow
1843	->new	2144	->new
1844	->fd (fileno $term->{socket})	2145	->fd (fileno $term->{socket})
1845	->events (urxvt::EVENT_READ)	2146	->events (urxvt::EV_READ)
1846	->start	2147	->start
1847	->cb (sub {	2148	->cb (sub {
1848	my ($iow, $revents) = @_;	2149	my ($iow, $revents) = @_;
1849	# $revents must be 1 here, no need to check	2150	# $revents must be 1 here, no need to check
1850	sysread $term->{socket}, my $buf, 8192	2151	sysread $term->{socket}, my $buf, 8192
…		…
1863	Set the callback to be called when io events are triggered. C<$reventmask>	2164	Set the callback to be called when io events are triggered. C<$reventmask>
1864	is a bitset as described in the C<events> method.	2165	is a bitset as described in the C<events> method.
1865		2166
1866	=item $iow = $iow->fd ($fd)	2167	=item $iow = $iow->fd ($fd)
1867		2168
1868	Set the filedescriptor (not handle) to watch.	2169	Set the file descriptor (not handle) to watch.
1869		2170
1870	=item $iow = $iow->events ($eventmask)	2171	=item $iow = $iow->events ($eventmask)
1871		2172
1872	Set the event mask to watch. The only allowed values are	2173	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	2174	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1874	together, or C<urxvt::EVENT_NONE>.	2175	together, or C<urxvt::EV_NONE>.
1875		2176
1876	=item $iow = $iow->start	2177	=item $iow = $iow->start
1877		2178
1878	Start watching for requested events on the given handle.	2179	Start watching for requested events on the given handle.
1879		2180
1880	=item $iow = $iow->stop	2181	=item $iow = $iow->stop
1881		2182
1882	Stop watching for events on the given filehandle.	2183	Stop watching for events on the given file handle.
1883		2184
1884	=back	2185	=back
1885		2186
1886	=head2 The C<urxvt::iw> Class	2187	=head2 The C<urxvt::iw> Class
1887		2188
…		…
1920	->new	2221	->new
1921	->start ($pid)	2222	->start ($pid)
1922	->cb (sub {	2223	->cb (sub {
1923	my ($pw, $exit_status) = @_;	2224	my ($pw, $exit_status) = @_;
1924	...	2225	...
1925	});	2226	});
1926		2227
1927	=over 4	2228	=over 4
1928		2229
1929	=item $pw = new urxvt::pw	2230	=item $pw = new urxvt::pw
1930		2231
…		…
1934		2235
1935	Set the callback to be called when the timer triggers.	2236	Set the callback to be called when the timer triggers.
1936		2237
1937	=item $pw = $timer->start ($pid)	2238	=item $pw = $timer->start ($pid)
1938		2239
1939	Tells the wqtcher to start watching for process C<$pid>.	2240	Tells the watcher to start watching for process C<$pid>.
1940		2241
1941	=item $pw = $pw->stop	2242	=item $pw = $pw->stop
1942		2243
1943	Stop the watcher.	2244	Stop the watcher.
1944		2245
…		…
1957		2258
1958	=item >= 3 - script loading and management	2259	=item >= 3 - script loading and management
1959		2260
1960	=item >=10 - all called hooks	2261	=item >=10 - all called hooks
1961		2262
1962	=item >=11 - hook reutrn values	2263	=item >=11 - hook return values
1963		2264
1964	=back	2265	=back
1965		2266
1966	=head1 AUTHOR	2267	=head1 AUTHOR
1967		2268
1968	Marc Lehmann <pcg@goof.com>	2269	Marc Lehmann <schmorp@schmorp.de>
1969	http://software.schmorp.de/pkg/rxvt-unicode	2270	http://software.schmorp.de/pkg/rxvt-unicode
1970		2271
1971	=cut	2272	=cut
1972		2273
1973	1	2274	1
		2275
		2276	# 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.199 by sf-exg, Sun Nov 20 10:49:56 2011 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.199 by sf-exg, Sun Nov 20 10:49:56 2011 UTC